miflora - Library for Xiaomi Mi plant sensor

This library lets you read sensor data from a Xiaomi Mi Flora plant sensor.

Latest release download: https://pypi.python.org/pypi/miflora
Build status: https://travis-ci.org/open-homeautomation/miflora
Test coverage: https://coveralls.io/github/open-homeautomation/miflora

Functionality

It supports reading the different measurements from the sensor

temperature
moisture
conductivity
brightness

To use this library you will need a Bluetooth Low Energy dongle attached to your computer. You will also need a Xiaomi Mi Flora plant sensor.

Backends

As there is unfortunately no universally working Bluetooth Low Energy library for Python, the project currently offers support for two Bluetooth implementations:

bluez tools (via a wrapper around gatttool)
bluepy library

bluez/gatttool wrapper

To use the bluez wrapper, you need to install the bluez tools on your machine. No additional python libraries are required. Some distrubutions moved the gatttool binary to a separate package. Make sure you have this binaray available on your machine.

Example to use the bluez/gatttool wrapper:

from miflora.miflora_poller import MiFloraPoller
from miflora.backends.gatttool import GatttoolBackend

poller = MiFloraPoller('some mac address', GatttoolBackend)

bluepy

To use the bluepy library you have to install it on your machine, in most cases this can be done via: pip3 install bluepy

Example to use the bluepy backend:

from miflora.miflora_poller import MiFloraPoller
from miflora.backends.bluepy import BluepyBackend

poller = MiFloraPoller('some mac address', BluepyBackend)

pygatt

If you have a Blue Giga based device that is supported by pygatt, you have to install the bluepy library on your machine. In most cases this can be done via: pip3 install pygatt

Example to use the pygatt backend:

from miflora.miflora_poller import MiFloraPoller
from miflora.backends.pygatt import PygattBackend

poller = MiFloraPoller('some mac address', PygattBackend)

Conttributing

please have a look at CONTRIBUTING.md

Projects Depending on `miflora`

The following shows a selected list of projects using this library:

https://github.com/ThomDietrich/miflora-mqtt-daemon - An MQTT Client/Daemon for Smart Home solution integration
https://home-assistant.io/components/sensor.miflora/ - Integration in Home Assistant

fasolens/miflora