home-assistant.github.io/components/sensor.miflora/index.html
2016-11-13 11:57:21 +00:00

228 lines
No EOL
9.5 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Mi Flora plant sensor - Home Assistant</title>
<meta name="author" content="Home Assistant">
<meta name="description" content="Instructions on how to integrate MiFlora BLE plant sensor with Home Assistant.">
<meta name="viewport" content="width=device-width">
<link rel="canonical" href="https://home-assistant.io/components/sensor.miflora/">
<meta property="fb:app_id" content="338291289691179">
<meta property="og:title" content="Mi Flora plant sensor">
<meta property="og:site_name" content="Home Assistant">
<meta property="og:url" content="https://home-assistant.io/components/sensor.miflora/">
<meta property="og:type" content="article">
<meta property="og:description" content="Instructions on how to integrate MiFlora BLE plant sensor with Home Assistant.">
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:site" content="@home_assistant">
<meta name="twitter:title" content="Mi Flora plant sensor">
<meta name="twitter:description" content="Instructions on how to integrate MiFlora BLE plant sensor with Home Assistant.">
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
<link href="/stylesheets/screen.css" media="screen, projection" rel="stylesheet">
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
<link rel='shortcut icon' href='/images/favicon.ico' />
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
</head>
<body >
<header>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
<a href="/" class="site-title">
<img width='40' src='/demo/favicon-192x192.png'>
<span>Home Assistant</span>
</a>
</div>
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
<nav>
<input type="checkbox" id="toggle">
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
<ul class="menu pull-right">
<li><a href="/getting-started/">Getting started</a></li>
<li><a href="/components/">Components</a></li>
<li><a href="/ecosystem/">Ecosystem</a></li>
<li><a href="/cookbook/">Examples</a></li>
<li><a href="/developers/">Developers</a></li>
<li><a href="/blog/">Blog</a></li>
<li><a href="/help/">Need help?</a></li>
</ul>
</nav>
</div>
</div>
</div>
</header>
<div class="grid-wrapper">
<div class="grid grid-center">
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
<article class="page">
<header>
<h1 class="title indent">
Mi Flora Plant Sensor
</h1>
</header>
<hr class="divider">
<p>The <a href="https://www.open-homeautomation.com/2016/08/23/reverse-engineering-the-mi-plant-sensor/">Mi Flora plant sensor</a> is a small Bluetooth Low Energy device that monitors not only the moisture, but also light, temperature and
conductivity. As only a single BLE device can be polled at the same time, the library implements locking to make sure this is the case.</p>
<p>To use your Mi Flora plant sensor in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
<span class="s">sensor</span>
<span class="s">platform</span><span class="pi">:</span> <span class="s">miflora</span>
<span class="s">mac</span><span class="pi">:</span> <span class="s">xx:xx:xx:xx:xx:xx</span>
<span class="s">name</span><span class="pi">:</span> <span class="s">Flower 1</span>
<span class="s">force_update</span><span class="pi">:</span> <span class="s">false</span>
<span class="s">median</span><span class="pi">:</span> <span class="s">3</span>
<span class="s">monitored_conditions</span><span class="pi">:</span>
<span class="pi">-</span> <span class="s">moisture</span>
<span class="pi">-</span> <span class="s">light</span>
<span class="pi">-</span> <span class="s">temperature</span>
<span class="pi">-</span> <span class="s">conductivity</span>
</code></pre>
</div>
<ul>
<li><strong>mac</strong> (<em>Required</em>): The MAC address of your sensor. You can find this be running <code class="highlighter-rouge">hcitool lescan</code> from command line.</li>
<li><strong>name</strong> (<em>Optional</em>): The name displayed in the frontend.</li>
<li><strong>force_update</strong> (<em>Optional</em>): Sends update events even if the value hasnt changed.</li>
<li><strong>median</strong> (<em>Optional</em>): Sometimes the sensor measurements show spikes. Using this parameter, the poller will report the median of the last
3 (you can also use larger values) measurements. This filters out single spikes. Median: 5 will also filter double spikes.
If you never have problems with spikes, median=1 will work fine.</li>
<li><strong>monitored_conditions</strong> (<em>Required</em>): The paramaters that should be monitored.</li>
<li><strong>timeout</strong> (<em>Optional</em>): Define the timeout value in seconds when polling (defaults to 10 if not defined)</li>
<li><strong>retries</strong> (<em>Optional</em>): Define the number of retries when polling (defaults to 2 if not defined)</li>
<li><strong>cache</strong> (<em>Optional</em>): Define cache expiration value in seconds (defaults to 1200 if not defined)</li>
</ul>
<p>Note that by default the sensor is only polled once every 15 minutes. This means with the median=3 setting, it will take as least 30 minutes before the sensor will report a value after a Home Assistant restart. As the values usually change very slowly, this isnt a big problem.
Reducing polling intervals will have a negative effect on the battery life.</p>
</article>
</div>
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
<div class="grid">
<section class="aside-module grid__item one-whole lap-one-half">
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/sensor.miflora.markdown'>Edit this page on GitHub</a></div>
<div class='brand-logo-container section'>
<img src='/images/supported_brands/miflora.png' />
</div>
<div class='section'>
IoT class<sup><a href='/blog/2016/02/12/classifying-the-internet-of-things/#classifiers'><i class="icon-info-sign"></i></a></sup>: Local Polling
</div>
<div class='section'>
Introduced in release: 0.29
</div>
<div class='section'>
<h1 class="title delta">Category DIY</h1>
<ul class='divided'>
<li>
<a href='/components/arduino/'>Arduino</a>
</li>
<li>
<a href='/components/sensor.arduino/'>Arduino Sensor</a>
</li>
<li>
<a href='/components/switch.arduino/'>Arduino Switch</a>
</li>
<li>
<a href='/components/sensor.dht/'>DHT Sensor</a>
</li>
<li>
<a href='/components/knx/'>KNX</a>
</li>
<li>
<a href='/components/sensor.knx/'>KNX Sensor</a>
</li>
<li>
<a href='/components/switch.knx/'>KNX Switch</a>
</li>
<li>
<a href='/components/climate.knx/'>KNX Thermostat</a>
</li>
<li>
Mi Flora plant sensor
</li>
<li>
<a href='/components/sensor.serial_pm/'>Particulate matter Sensor</a>
</li>
<li>
<a href='/components/rpi_gpio/'>Raspberry PI GPIO</a>
</li>
<li>
<a href='/components/zigbee/'>ZigBee</a>
</li>
</ul>
</div>
</section>
</div>
</aside>
</div>
</div>
<footer>
<div class="grid-wrapper">
<div class="grid">
<div class="grid__item">
<div class="copyright">
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
<div class="credit">
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a>.<br>
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
</div>
</div>
</div>
</div>
</div>
</footer>
<script>
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
s.parentNode.insertBefore(g,s)}(document,'script'));
</script>
</body>
</html>