Skip to main content

Library to read data from Xiaomi Aqara thermometer

Project description

mithermometer - Library for Xiaomi Aqara temperature and humidity sensor

PyPI PyPI PyPI GitHub license

This library lets you read sensor data from a Xiaomi Aqara temperature and humidity sensor.

the mithermometer library is based on the miflora library. Thanks for this great lib.

Functionality

It supports reading the different measurements from the sensor

  • temperature
  • humidity

To use this library you will need a Bluetooth Low Energy dongle attached to your computer. You will also need a Xiaomi Aqara thermometer.

Backends

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

  • bluepy library
  • bluez tools (via a wrapper around gatttool)
  • pygatt library

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 mithermometer.mithermometer_poller import MiThermometerPoller
from btlewrap.bluepy import BluepyBackend

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

This is the backend library to be used.

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 mithermometer.mithermometer_poller import MiThermometerPoller
from btlewrap.gatttool import GatttoolBackend

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

This backend should only be used, if your platform is not supported by bluepy. Note: gatttool is depracated in many Linux distributions.

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 mithermometer.mithermometer_poller import MiThermometerPoller
from btlewrap.pygatt import PygattBackend

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

Dependencies

mithermometer depends on the btlewrap library. If you install mithermometer via PIP btlewrap will automatically be installed. If not, you will have to install btlewrap manually:

pip3 install btlewrap

Conttributing

please have a look at CONTRIBUTING.md

Projects Depending on mithermometer

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mithermometer-0.1.4.tar.gz (10.3 kB view hashes)

Uploaded Source

Built Distribution

mithermometer-0.1.4-py3-none-any.whl (16.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page