Skip to main content

Python binding for FHEM to support Python modules

Project description

Download python Version LastCommit BuyCoffee


fhempy allows the usage of Python 3 (NOT 2!) language to write FHEM modules. Python 3.9 or higher is required, therefore I recommend using bullseye.

This repository includes following working modules:

Module Description
aktionsfinder Keep informed about product promotions
arp_presence ARP based presence detection, works also for iOS
ble_monitor Supports a lot of BLE devices
ble_presence Presence detection incl. RSSI for Bluetooth Low Energy
ble_reset Resets all Bluetooth interfaces every X hours
bt_presence Presence detection incl. RSSI for Bluetooth
blue_connect Blue Connect
ddnssde Dynamic DNS updater for free service
discover_mdns Discover mDNS (e.g. googlecast) devices
discover_ble Discover Bluetooth LE devices
discover_upnp Discover UPnP devices
dlna_dmr Control DLNA MediaRenderer devices
energie_gv_at Retrieve current Austrian energy status
eq3bt Control EQ3 Bluetooth thermostat
erelax_vaillant Control eRelax Vaillant
esphome Installs and starts the ESP Home dashboard for easy ESP Home device management
fusionsolar Retrieve values from FusionSolar Kiosk
geizhals Retrieve prices from geizhals
gfprobt Control GF Pro Bluetooth irrigation control
github_backup Backup FHEM config to github
goodwe Get data from GoodWe inverters
googlecast Control Cast devices and stream Spotify
google_weather Retrieve weather from Google
gree_climate Control gree HVAC devices
helloworld Hello World example for developers to start writing their own module
ikos Check prices for ikos resorts
kia_hyundai Control your Kia/Hyundai car
meross Control Meross devices
miscale Xiaomi Mi Scale V1/2 support
miflora Xiaomi BLE Plant Sensor
miio Control Xiaomi WiFi devices
mitemp Xiaomi BLE Temperature/Humidity Sensor
mqtt_ha_discovery Support HomeAssistant MQTT discovery
nefit Control nefit devices
nespresso_ble Nespresso Bluetooth coffee machine
object_detection TensorFlow Lite object detection
pyit600 Control Salus iT600 devices
rct_power RCT Power inverter
ring Ring doorbell/chime/cam
seatconnect Control your Seat/Cupra car
spotify Control Spotify Connect and use FHEM as Spotify Connect player
skodaconnect Control your skoda car
tuya Control tuya devices localy incl. real-time updates (only WiFi devices)
tuya_cloud Control tuya devices via cloud incl. real-time updates (WiFi & ZigBee)
warema Control Warema devices
websitetests Do some basic website checks
wienerlinien Wiener Linien departure times
wienernetze_smartmeter Retrieve data from Wiener Netze smartmeter
xiaomi_gateway3 Xiaomi Gateway V3 (only V3!)
xiaomi_tokens Retrieve all Xiaomi Tokens from Cloud
volvo Retrieve infos from your Volvo car (only new API)
volvo_software_update Get notified about Volvo software updates
zigbee2mqtt Install, update and run Zigbee2MQTT server


Python >=3.9 is required, Python 2 won't work!


Debian 11 (Bullseye)

Copy & paste this command if you are running Debian Bullseye.

sudo apt install python3 python3-pip python3-dev libffi-dev libssl-dev libjpeg-dev zlib1g-dev autoconf build-essential libglib2.0-dev libdbus-1-dev bluez libbluetooth-dev git libprotocol-websocket-perl


Use the following 2 commands if you run Debian 10 (Buster) or older (e.g. stretch, jessie, ...).

sudo apt install python3 python3-pip python3-dev libffi-dev libssl-dev libjpeg-dev zlib1g-dev autoconf build-essential libglib2.0-dev libdbus-1-dev bluez libbluetooth-dev git
sudo cpan Protocol::WebSocket


update add
shutdown restart
define fhempy_local BindingsIo fhempy

Wait a few minutes until fhempy is installed. This might take up to 15 minutes! fhempy_local will show up with a green circle when finished. All further requirements are installed automatically via pip as soon as the specific module is used the first time.

Usage in FHEM (examples)

This are just a few examples for some modules, please see the modules readme linked in the table above for more details

  • define castdevice fhempy googlecast "Living Room"
  • define eq3bt fhempy eq3bt 00:11:22:33:44:66:77
  • define upnp fhempy discover_upnp

fhempy peers (e.g. extend Bluetooth range)

fhempy allows to run modules locally (same device as FHEM runs on) or on remote peers. Those remote peers only make sense if you want to extend the range of bluetooth or want to distribute the load of some modules to other more powerfull devices (e.g. video object detection).

Peer setup (short version)

Only on remote peers, do not run this commands on the FHEM instance. Run this commands with user "pi".

pip3 install --upgrade fhempy
# systemd service installation
curl -sL | sudo -E bash -

Peer setup (long version)

Only needed if you didn't run Peer setup (short version). The following steps are only needed if you want to install fhempy on a remote peer, you should not run them on your FHEM installation.

  • Install fhempy with user pi: pip3 install --upgrade fhempy
  • Make sure your main fhempy instance (within FHEM) is running
  • Test fhempy by just running it with user pi, type fhempy and enter. Wait a few seconds until it gets discovered and you see the incoming FHEM connection.
  • Systemd configuration for autostart
    • curl -sL | sudo -E bash -
    • fhempy is run with user pi, you can change that in the fhempy.service file in /etc/systemd/system/
  • FHEM configuration
    • The remote peer is autodiscovered and will show up in FHEM as device e.g. fhempy_peer_192_168_1_50
    • You can move any device to the remote peer by changing the IODev of the device.
    • If autodiscovery doesn't work (it's based on zeroconf), you can define it with define fhempy_peer_IP BindingsIo IP:15733 fhempy

Log file

journalctl -u fhempy.service -f


Just do set remote_pybinding update and the remote peer will install the new package via pip and restart afterwads.



This module is a DevIo device which builds a language neutral communicaton bridge in JSON via websockets.


This module just starts the fhempy server instance


This module is used as the bridge to BindingsIo. It calls BindingsIo with IOWrite.


This is the Python server instance which handles JSON websocket messages from BindingsIo. Based on the message it executes the proper function and replies to BindingsIo via websocket.

Call flow

This example shows how Define function is called from the Python module.

  1. define castdevice fhempy googlecast "Living Room"
  2. fhempy sends IOWrite to BindingsIo
  3. BindingsIo sends a JSON websocket message to fhempy
  4. fhempy loads the corresponding module (e.g. googlecast), creates an instance of the object (e.g. googlecast) and calls the Define function on that instance
  5. Define function is executed within the Python context, as long as the function is executed, FHEM waits for the answer the same way as it does for Perl modules
  6. Python Define returns the result via JSON via websocket to BindingsIo

At any time within the functions FHEM functons like readingsSingleUpdate(...) can be called by using the module (fhem.readingsSingleUpdate(...)). There are just a few functions supported at the moment.

Flow Chart

Write your own module

Check helloworld example for writing an own module. Be aware that no function which is called from FHEM is allowed to run longer than 1s. In general no blocking code should be used with asyncio. If you want to call blocking code, use utils.run_blocking.

Project details

Release history Release notifications | RSS feed

Download files

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

Source Distribution

fhempy-0.1.651.tar.gz (4.5 MB view hashes)

Uploaded source

Built Distribution

fhempy-0.1.651-py3-none-any.whl (4.5 MB view hashes)

Uploaded py3

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