Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 3.75 KB

README.md

File metadata and controls

60 lines (41 loc) · 3.75 KB

Theengs Gateway is a multi-platform, multi devices Bluetooth Low Energy (BLE) to MQTT gateway that leverages the Theengs Decoder library. It retrieves data from a wide range of BLE sensors, including the LYWSD03MMC, CGD1, CGP1W, H5072, H5075, H5102, TH1, TH2, CGH1, CGDK2, CGPR1, RuuviTag, WS02, WS08, TPMS, MiScale, LYWSD02, LYWSDCGQ, and MiFlora, and translates this information into a readable JSON format and pushes those to an MQTT broker.

Enabling integration to Internet of Things (IoT) platforms or home automation controllers like NodeRED, AWS IoT, Home Assistant, OpenHAB, FHEM, ioBroker or Domoticz.

The gateway uses the Bluetooth Low Energy adapter of your Raspberry Pi, Windows, Apple desktop, laptop, or server by leveraging Python and multi-platform libraries.

Gateway

You can use Theengs Gateway as a standalone solution or as a complementary solution to OpenMQTTGateway as it uses the same MQTT topic structure and the same payload messages. Your OpenMQTTGateway home automation BLE sensors integration also works with Theengs Gateway.

The gateway retrieves data from BLE sensors from Govee, Xiaomi, Inkbird, Qingping, ThermoBeacon, Blue Maestro and many more.

You can find full documentation for installation and usage here

Install Theengs Gateway as a pip package

Prerequisites:

Command:

pip install TheengsGateway

You can access advanced configuration by typing:

python3 -m TheengsGateway -h

Install Theengs Gateway as an Add ON in Home Assistant

  1. Add the Add-on repository into the add-on store

Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.

Or by going to Settings -> Add-ons -> Add-on store -> ⁞ (Menu) -> Repositories -> Fill in the URL https://github.com/mihsu81/addon-theengsgw -> Add.

  1. You should now see TheengsGateway HA Add-on at the bottom list.
  2. Click on TheengsGateway, then click Install.
  3. Under the Configuration tab, change the settings appropriately (at least MQTT parameters), see Parameters.
  4. Start the Add-on.

Install Theengs Gateway as a snap

Theengs Gateway is also packaged as a snap in the Snap Store. If you have snapd running on your Linux distribution, which is the case by default on Ubuntu, you can install the Theengs Gateway snap as:

Get it from the Snap Store

snap install theengs-gateway

Have a look at the Theengs Gateway Snap documentation for more information about how to configure and start Theengs Gateway as a service.

Install Theengs Gateway as a docker

Theengs Gateway is also available from docker hub thanks to @maretodoric

Docker Image Size (latest by date)

docker pull theengs/gateway