Package: miflora
miflora - Library for Xiaomi Mi plant sensorThis repo used to live under theopen-homeautomation/mifloranamespace and was originally created by@open-homeautomation.This library lets you read sensor data from a Xiaomi Mi Flora plant sensor.Latest release download:https://pypi.python.org/pypi/mifloraBuild status:https://github.com/basnijholt/miflora/actionsTest coverage:https://coveralls.io/github/basnijholt/mifloraFunctionalityIt supports reading the different measurements from the sensortemperaturemoistureconductivitybrightnessTo 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.BackendsAs there is unfortunately no universally working Bluetooth Low Energy library for Python, the project currently
offers support for two Bluetooth implementations:bluepy librarybluez tools (deprecated, via a wrapper around gatttool)pygatt librarybluepy (recommended)To use thebluepylibrary you have to install it on your machine, in most cases this can be done via:pip3 install bluepyExample to use the bluepy backend:frommiflora.miflora_pollerimportMiFloraPollerfrombtlewrap.bluepyimportBluepyBackendpoller=MiFloraPoller("some mac address",BluepyBackend)This is the backend library to be used.bluez/gatttool wrapper (deprecated):warning: The bluez team marked gatttool as deprecated. This solution may still work on some Linux distributions, but it is not recommended any more.To use the bluez wrapper, you need to install the bluez tools on your machine. No additional python
libraries are required. Some distributions moved the gatttool binary to a separate package. Make sure you have this
binary available on your machine.Example to use the bluez/gatttool wrapper:frommiflora.miflora_pollerimportMiFloraPollerfrombtlewrap.gatttoolimportGatttoolBackendpoller=MiFloraPoller("some mac address",GatttoolBackend)This backend should only be used, if your platform is not supported by bluepy.pygattIf you have a Blue Giga based device that is supported bypygatt, you have to
install the bluepy library on your machine. In most cases this can be done via:pip3 install pygattExample to use the pygatt backend:frommiflora.miflora_pollerimportMiFloraPollerfrombtlewrap.pygattimportPygattBackendpoller=MiFloraPoller("some mac address",PygattBackend)Dependenciesmiflora depends on thebtlewraplibrary. If you install miflora via PIP btlewrap will automatically be installed. If not, you will have to install btlewrap manually:pip3 install btlewrapTroubleshootingUsers frequently have problems with the communication between their Bluetooth dongle and the sensors. Here are the usual things to try.Battery emptyWhile the battery usually lasts about a year indoor, it may also fail for unknown reasons before that. So the first thing to check if the battery is still good: take out the battery, wait 3 secs and put it back in. The light on the sensor should be flashing. If it is not: get a new battery.RangeThe distance between Bluetooth dongle and sensor should be less than 5 meters. Try moving the sensor and dongle closer together and see if that solves the problem. If range is an issue, there are a few proxies/relays via MQTT available:Linuxplantgatewaymiflora-mqtt-daemonESP32floraOutsideIf you're operating your sensors outside, make sure the sensor is protected against rain. The power of the battery is decreasing blow -10°C. Sou you might not get readings at that temperature. Also make sure that you have a Bluetooth dongle close by.Radio interferenceThe Bluetooth LE communication is not always reliable. There might be outages due to other radio interferences. The standard solution is to try again or poll your sensor more often that you really need it. It's also the hardest issue to analyse and debug.Raspberry PiIf you're using a Raspberry Pi, make sure, that you OS is up to date, including the latest kernel and firmware. There are sometimes useful Bluetooth fixes. Also make sure that you have a good power supply (3 A recommended) as this causes sporadic problems in many places.Conttributingplease have a look atCONTRIBUTING.mdProjects Depending onmifloraThe 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 integrationhttps://home-assistant.io/components/sensor.miflora/- Integration in Home Assistanthttps://github.com/zewelor/bt-mqtt-gateway- A BT to MQTT gateway which support MiFlora sensors + other deviceshttps://github.com/ChristianKuehnel/plantgateway- A MQTT Client to relay sensor data