# HomematicIP REST API
A **Python 3** wrapper for the homematicIP REST API (Access Point Based)
Since there is no official documentation about this API everything was
done via reverse engineering. Use at your own risk.
Any help from the community through e.g. pull requests would be highly appreciated.
[](https://pypi.python.org/pypi/homematicip/) [](https://pypi.python.org/pypi/homematicip/) [](https://discord.gg/mZG2myJ) [](https://circleci.com/gh/hahn-th/homematicip-rest-api) 
## :ghost: Lot's of changes in version 2.0.0
In version 2.0.0, there are many code and API changes. Almost all async devices have been removed. The corresponding functions are now in the formerly non-async classes.
## Get Help / Discord
If you want to get in contact with me or need help with the library, you can get in touch with me via discord. There is a **[discord server](https://discord.gg/mZG2myJ)** and my discord tag is **agonist#6159**
## :book: New Documentation
There is a new documentation site unter https://hahn-th.github.io/homematicip-rest-api which is still under construction.
## Support me
:heart: If you want to say thank you or want to support me, you can do that via PayPal.
[https://paypal.me/thomas08154711](https://paypal.me/thomas08154711?country.x=DE&locale.x=de_DE)
## Thanks
Kudos and a big thank you to @coreGreenberet, who created this library.
## Installation
To install the package, run:
```sh
pip install -U homematicip
```
### "Nightly" Builds
Each push on the master branch will trigger a build. That way you can test the latest version of the library with your systems.
```sh
pip install -U homematicip --pre
```
## New devices and config dump
If you missing a device which is not implemented yet, open an issue and append a dump of your configuration to it using https://gist.github.com.
To create a dump use the CLI:
```sh
hmip_cli --dump-configuration --anonymize
```
See [Usage](#usage) for more instructions.
## Usage
### Generate Token
If you are about to connect to a **HomematicIP HCU1** you have to press the button on top of the device, before running the script. From now, you have 5 Minutes to complete the registration process.
After that, run `hmip_generate_auth_token` (from the command line) to get an auth token for your access point. it will generate a “config.ini” in your current directory.
### Use the CLI
You can send commands to homematicIP using the `hmip_cli` script. To get an overview, use -h or --help param. To address devices, use the argument -d in combination with the 24-digit ID (301400000000000000000000) from --list-devices.
A few examples:
- `hmip_cli --help` to get help
- `hmip_cli --list-devices` to get a list of your devices.
- `hmip_cli -d <id-from-device-list> --toggle-garage-door` to toogle the garage door with HmIP-WGC.
- `hmip_cli --list-events` to listen to events and changes in your homematicIP system
- `hmip_cli -d <id> --set-lock-state LOCKED --pin 1234` to lock a door with HmIP-DLD
- `hmip_cli --dump-configuration --anonymize` to dump the current config and anonymize it.
## Implemented Stuff
- [x] Generate authentication token
- [x] Read current state of the Environment
- [x] Weather
- [x] Location
- [x] Basic Informations( apversion, pinAssigned, timeZone, … )
- [x] Devices (partly)
- [x] Client
- [x] Groups
## Homematic IP Devices:
- [x] ALPHA-IP-RBG (Alpha IP Wall Thermostat Display)
- [x] ALPHA-IP-RBGa (ALpha IP Wall Thermostat Display analog)
- [ ] ELV-SH-AI8 (Alarmline Interface 8x Inputs) \*powered by HmIP
- [ ] ELV-SH-BS2 (Switch Actuator for brand switches 2x channels) \*powered by HmIP
- [x] ELV-SH-CTV Tilt Vibration Sensor Compact
- [ ] ELV-SH-GVI (Garden valve interface) \*powered by HmIP
- [ ] ELV-SH-IRS8 (Infared Remote control - 8x channels) \*powered by HmIP
- [ ] ELV-SH-SW1-BAT (2x Actuator Switch for 30V/1A with 2xAA Batteries) \*powered by HmIP
- [ ] ELV-SH-WUA (Dimming Actuator, 0-10/1-10-V-Control inputs, 8A 230V) \*powered by HmIP
- [ ] ELV-SH-WSC (2x Servo Controls, 5v - 12V) \*powered by HmIP
- [x] HMIP-ASIR (Alarm Siren - indoor)
- [x] HMIP-ASIR-B1 (Alarm Siren - indoor) _Silvercrest Edition_
- [x] HMIP-ASIR-2 (Alarm Siren - indoor) New Version
- [x] HMIP-ASIR-O (Alarm Siren - outdoor)
- [x] HMIP-BBL (Blind Actuator for brand switches)
- [ ] HMIP-BBL-2 (Blind Actuator for brand switches) New Version
- [x] HMIP-BDT (Dimming Actuator for brand switches)
- [x] HMIP-BRC2 (Remote Control for brand switches – 2x channels)
- [x] HMIP-BROLL (Shutter Actuator - brand-mount)
- [ ] HMIP-BROLL-2 (Shutter Actuator - brand-mount) New Version
- [x] HMIP-BSL (Switch Actuator for brand switches – with signal lamp)
- [x] HMIP-BSM (Brand Switch and Meter Actuator)
- [ ] HMIP-BSM-I (Brand Switch and Meter Actuator, International)
- [x] HMIP-BWTH (Wall Thermostat Display with switching output – for brand switches, 230V)
- [ ] HMIP-BWTH24 (Wall Thermostat Display with switching output – for brand switches, 24V)
- [x] HMIP-DBB (Doorbell Push-Button)
- [x] HMIP-DLD (Door Lock Drive)
- [x] HMIP-DLS (Door Lock Sensor)
- [x] HmIP-DRG-DALI (Dali Gateway - readonly at the moment)
- [x] HMIP-DRBLI4 (Blind Actuator for DIN rail mount – 4 channels)
- [x] HMIP-DRSI1 (Switch Actuator for DIN rail mount – 1x channel)
- [x] HMIP-DRDI3 (Dimming Actuator Inbound 230V – 3x channels, 200W per channel) electrical DIN rail
- [x] HMIP-DRSI4 (Switch Actuator for DIN rail mount – 4x channels)
- [x] HMIP-DSD-PCB (Door Signal Dector PCB)
- [x] HMIP-eTRV (Heating-Thermostat with Display)
- [x] HMIP-eTRV-2 (Heating-Thermostat with Display) New Version
- [ ] HMIP-eTRV-2 I9F (Heating-Thermostat with Display) New Version
- [ ] HMIP-eTRV-2-UK (UK Version not tested, but it should work)
- [x] HMIP-eTRV-B (Heating-Thermostat basic with Display)
- [ ] HMIP-eTRV-B-2 (Heating-Thermostat basic with Display) New Version
- [ ] HMIP-eTRV-B-2 R4M (Heating-Thermostat basic with Display) New Version
- [ ] HMIP-eTRV-B-UK (UK Version not tested, but it should work)
- [x] HMIP-eTRV-B1 (Heating-Thermostat basic with Display) _Silvercrest Edition_
- [x] HMIP-eTRV-C (Heating-Thermostat compact without display)
- [x] HMIP-eTRV-C-2 (Heating-Thermostat compact without display) New Version
- [ ] HmIP-eTRV-CL (Heating-thermostat compact with dispay)
- [x] HMIP-eTRV-E (Heating-Thermostat Design Evo _New Generation_, white)
- [ ] HMIP-eTRV-E-A (Heating-Thermostat Design Evo _New Generation_, anthracite)
- [ ] HMIP-eTRV-E-S (Heating-Thermostat Design Evo _New Generation_, silver)
- [x] HMIP-eTRV-3 (Heating-Thermostat pure, white)
- [x] HMIP-eTRV-F (Heating-Thermostat flex, white)
- [x] HMIP-FAL230-C6 (Floor Heating Actuator – 6x channels, 230V)
- [x] HMIP-FAL230-C10 (Floor Heating Actuator – 10x channels, 230V)
- [x] HMIP-FAL24-C6 (Floor Heating Actuator – 6x channels, 24V)
- [x] HMIP-FAL24-C10 (Floor Heating Actuator – 10x channels, 24V)
- [x] HMIP-FALMOT-C12 (Floor Heating Actuator – 12x channels, motorised)
- [x] HMIP-FBL (Blind Actuator - flush-mount)
- [x] HMIP-FCI1 (Contact Interface flush-mount – 1x channel)
- [x] HMIP-FCI6 (Contact Interface flush-mount – 6x channels)
- [x] HMIP-FDT (Dimming Actuator - flush-mount)
- [x] HMIP-FROLL (Shutter Actuator - flush-mount)
- [x] HMIP-FSI16 (Switch Actuator with Push-button Input 230V, 16A)
- [x] HMIP-FSM (Switch Actuator and Meter 5A – flush-mount)
- [x] HMIP-FSM16 (Switch Actuator and Meter 16A – flush-mount)
- [ ] HMIP-FWI (Wiegand Interface)
- [x] HMIP-HAP (Cloud Access Point)
- [x] HMIP-HAP-B1 (Cloud Access Point) _Silvercrest Edition_
- [x] HMIP-HDM1 (Hunter Douglas & erfal window blinds
- [ ] HMIP-HDRC (Hunter Douglas & erfal window blinds remote control)
- [ ] HMIP-K-DRBLI4 (Blinds Actuator – 4x channels, 230V, 2,2A / 500W per channel) electrical DIN rail
- [ ] HMIP-K-DRSI1 (Actuator Inbound 230V – 1x channel) electrical DIN rail
- [ ] HMIP-K-DRDI3 (Dimming Actuator Inbound 230V – 3x channels, 200W per channel) electrical DIN rail
- [ ] HMIP-K-DRSI4 (Switch Actuator – 4x channels, 16A per channel) electrical DIN rail
- [x] HMIP-KRCA (Key Ring Remote Control & Alarm)
- [x] HMIP-KRC4 (Key Ring Remote Control - 4x buttons)
- [ ] HMIP-MIO16-PCB (Multi Analog/Digitial Interface - Switch Circuit Board)
- [x] HMIP-MIOB (Multi IO Box for floor heating & cooling)
- [x] HMIP-MOD-HO (Garage Door Module for Hörmann)
- [x] HMIP-MOD-OC8 (Open Collector Module Receiver - 8x)
- [x] HMIP-MOD-RC8 (Open Collector Module Sender - 8x)
- [x] HMIP-MOD-TM (Garage Door Module for Novoferm and Tormatic door operators)
- [ ] HMIP-MP3P (Combination Signalling Device MP3)
- [ ] HMIP-P-DRG-DALI (DALI Lights Gateway)
- [x] HMIP-PCBS (Switch Circuit Board - 1x channel)
- [x] HMIP-PCBS2 (Switch Circuit Board - 2x channels)
- [x] HMIP-PCBS-BAT (Switch Circuit Board with Battery - 1x channel)
- [x] HMIP-PDT (Plugable Dimmer)
- [ ] HMIP-PDT-UK (UK Version not tested, but it should work)
- [x] HMIP-PMFS (Plugable Power Supply Monitoring)
- [x] HMIP-PS (Plugable Switch)
- [ ] HMIP-PS-2 (Plugable Switch) New Version
- [x] HMIP-PSM (Plugable Switch Measuring, Type F - Standard for Homematic)
- [ ] HMIP-PSM-2 (Plugable Switch Measuring, Type F - Standard for Homematic) New Version
- [x] HMIP-PSM-CH (Plugable Switch Measuring, Type J)
- [ ] HMIP-PSM-IT (Type L not tested, but it should work)
- [ ] HMIP-PSM-PE (Type E not tested, but it should work)
- [ ] HMIP-PSM-UK (Type G not tested, but it should work)
- [x] HMIP-PSMCO (Schalt-Mess-Kabel – außen)
- [x] HMIP-RC8 (Remote Control - 8x buttons)
- [ ] HMIP-RCB1 (Remote Control - 1x button)
- [x] HMIP-RGBW (RGB Led Controller - Readonly at the moment)
- [x] HMIP-SAM (Acceleration Sensor)
- [x] HMIP-SCI (Contact Interface Sensor)
- [x] HMIP-SCTH230 (CO2, Temperature and Humidity Sensor 230V)
- [ ] HMIP-SFD (Fine Dust Sensor)
- [x] HMIP-SLO (Light Sensor - outdoor)
- [x] HMIP-SMI (Motion Detector with Brightness Sensor - indoor)
- [x] HMIP-SMI55 (Motion Detector with Brightness Sensor and Remote Control - 2x buttons)
- [ ] HMIP-SMI55-2 (Motion Detector with Brightness Sensor and Remote Control - 2x buttons) New Version
- [x] HMIP-SMO (Motion Detector with Brightness Sensor - outdoor)
- [ ] HMIP-SMO-2 (Motion Detector with Brightness Sensor - outdoor) New Version
- [x] HMIP-SMO-A (Motion Detector with Brightness Sensor - outdoor, anthracite)
- [ ] HMIP-SMO-A-2 (Motion Detector with Brightness Sensor - outdoor, anthracite) New Version
- [x] HmIP-SMO230-A
- [x] HMIP-SPDR (Passage Sensor with Direction Recognition)
- [x] HMIP-SPI (Presence Sensor - indoor)
- [x] HMIP-SRH (Window Rotary Handle Sensor)
- [x] HMIP-SRD (Rain Sensor)
- [x] HMIP-STE2-PCB (Temperature Difference Sensors - 2x sensors)
- [x] HMIP-STH (Temperature and Humidity Sensor without display - indoor)
- [x] HMIP-STHD (Temperature and Humidity Sensor with display - indoor)
- [x] HMIP-STHO (Temperature and Humidity Sensor - outdoor)
- [x] HMIP-STHO-A (Temperature and Humidity Sensor – outdoor, anthracite)
- [x] HMIP-STV (Inclination and vibration Sensor)
- [x] HMIP-SWD (Water Sensor)
- [x] HMIP-SWDM (Door / Window Contact - magnetic)
- [ ] HMIP-SWDM-2 (Door / Window Contact - magnetic) New Version
- [x] HMIP-SWDM-B2 (Door / Window Contact - magnetic) _Silvercrest Edition_
- [x] HMIP-SWDO (Shutter Contact Optical)
- [ ] HMIP-SWDO-2 (Shutter Contact Optical) New Version
- [x] HMIP-SWDO-I (Shutter Contact Optical Invisible)
- [x] HMIP-SWDO-PL (Shutter Contact Optical Plus)
- [ ] HMIP-SWDO-PL-2 (Shutter Contact Optical Plus) New Version
- [x] HMIP-SWO-B (Weather Sensor - Basic)
- [x] HMIP-SWO-PL (Weather Sensor – Plus)
- [x] HMIP-SWO-PR (Weather Sensor – Pro)
- [x] HMIP-SWSD (Smoke Detector)
- [ ] HMIP-USBSM (USB Switching Measurement Actuator)
- [x] HMIP-WGC (Garage Door Button)
- [x] HMIP-WHS2 (Switch Actuator for heating systems – 2x channels)
- [x] HMIP-WKP (Keypad)
- [x] HMIP-WLAN-HAP (WLAN Access Point)
- [x] HmIP-WLAN-HAP-B
- [x] HMIP-WRC2 (Wall-mount Remote Control - 2x buttons)
- [x] HMIP-WRC6 (Wall-mount Remote Control - 6x buttons)
- [x] HMIP-WRCC2 (Wall-mount Remote Control – flat)
- [ ] HMIP-WRCD (Wall-mount Remote Control - E-Paper-Status display)
- [ ] HMIP-WRCR (Wall-mount Remote Control - Rotary)
- [ ] HMIP-WT (Wall Mounted Thermostat without adjusting wheel) #probably only prototype for WTH-B and was not released
- [x] HMIP-WTH (Wall Mounted Thermostat Pro with Display)
- [ ] HMIP-WTH-1 (Wall Mounted Thermostat Pro with Display _Newest Version_ - successor of WTH-2 - really)
- [x] HMIP-WTH-2 (Wall Mounted Thermostat Pro with Display)
- [x] HMIP-WTH-B (Wall Mounted Thermostat basic without adjusting wheel)
- [ ] HMIP-WTH-B-2 (Wall Mounted Thermostat basic without adjusting wheel) New Version
- [ ] HMIP-WUA (Dimming Actuator, 0-10/1-10-V-Control inputs, 8A 230V)
## Homematic IP Wired Devices (no radio signal):
- [x] HMIPW-DRAP (Homematic IP Wired Access Point)
- [ ] HMIPW-BRC2 (Homematic IP Wired Remote Control for brand switches – 2x channels)
- [x] HMIPW-DRBL4 (Homematic IP Wired Blinds Actuator – 4x channels)
- [x] HMIPW-DRD3 (Homematic IP Wired Dimming Actuator – 3x channels)
- [x] HMIPW-DRS4 (Homematic IP Wired Switch Actuator – 4x channels)
- [ ] HMIPW-DRI16 (Homematic IP Wired Inbound module – 16x channels)
- [x] HMIPW-DRI32 (Homematic IP Wired Inbound module – 32x channels)
- [x] HMIPW-DRS8 (Homematic IP Wired Switch Actuator – 8x channels)
- [ ] HMIPW-FAL24-C6 (Homematic IP Wired Floor Heating Actuator – 6x channels, 24V)
- [ ] HMIPW-FAL24-C10 (Homematic IP Wired Floor Heating Actuator – 10x channels, 24V)
- [ ] HMIPW-FAL230-C6 (Homematic IP Wired Floor Heating Actuator – 6x channels, 230V)
- [ ] HMIPW-FAL230-C10 (Homematic IP Wired Floor Heating Actuator – 10x channels, 230V)
- [x] HMIPW-FALMOT-C12 (Homematic IP Wired Floor Heating Actuator – 12x channels, motorised)
- [x] HMIPW-FIO6 (Homematic IP Wired IO Module flush-mount – 6x channels)
- [x] HMIPW-SCTHD (Homematic IP Wired CO2, Temperature and Humidity Sensor with Display)
- [x] HMIPW-SMI55 (Homematic IP Wired Motion Detector with Brightness Sensor and Remote Control - 2x buttons)
- [ ] HMIPW-SPI (Homematic IP Wired Presence Sensor - indoor)
- [ ] HMIPW-STH (Homematic IP Wired Temperature and Humidity Sensor without display - indoor)
- [ ] HMIPW-STHD (Homematic IP Wired Temperature and Humidity Sensor with display - indoor)
- [ ] HMIPW-WGD (Homematic IP Wired Wall-mount Glas Display - black edition)
- [ ] HMIPW-WGD-PL (Homematic IP Wired Wall-mount Glas Display Play - black edition)
- [x] HMIPW-WRC2 (Homematic IP Wired Wall-mount Remote Control - 2x channels)
- [x] HMIPW-WRC6 (Homematic IP Wired Wall-mount Remote Control - 6x channels)
- [ ] HMIPW-WTH (Homematic IP Wired Wall Mounted Thermostat Pro with Display)
## Events
It’s also possible to use push notifications based on a websocket connection:
```python
# Example function to display incoming events.
def print_events(event_list):
for event in event_list:
print("EventType: {} Data: {}".format(event["eventType"], event["data"]))
# Initialise the API.
config = homematicip.find_and_load_config_file()
home = Home()
home.set_auth_token(config.auth_token)
home.init(config.access_point)
# Add function to handle events and start the connection.
home.onEvent += print_events
home.enable_events()
try:
while True:
time.sleep(1)
except KeyboardInterrupt:
print("Interrupt.")
```
## Pathes for config.ini
The scripts will look for a config.ini in 3
different locations depending on your OS. Copy the file to one of these
locations so that it will be accessible for the scripts.
- General
- current working directory
- Windows
- %APPDATA%\\homematicip-rest-api
- %PROGRAMDATA%\\homematicip-rest-api
- Linux
- ~/.homematicip-rest-api/
- /etc/homematicip-rest-api/
- MAC OS
- ~/Library/Preferences/homematicip-rest-api/
- /Library/Application Support/homematicip-rest-api/
Raw data
{
"_id": null,
"home_page": null,
"name": "homematicip",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "homematicip cloud, homematicip",
"author": null,
"author_email": "Thomas Hahn <homematicip-rest-api@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/37/15/6c0fec9dd3207bd03ea8cec37cc8c0e3282605185a788d8497133ba23314/homematicip-2.2.0.tar.gz",
"platform": null,
"description": "# HomematicIP REST API\n\nA **Python 3** wrapper for the homematicIP REST API (Access Point Based)\nSince there is no official documentation about this API everything was\ndone via reverse engineering. Use at your own risk.\n\nAny help from the community through e.g. pull requests would be highly appreciated.\n\n[](https://pypi.python.org/pypi/homematicip/) [](https://pypi.python.org/pypi/homematicip/) [](https://discord.gg/mZG2myJ) [](https://circleci.com/gh/hahn-th/homematicip-rest-api) \n\n## :ghost: Lot's of changes in version 2.0.0\n\nIn version 2.0.0, there are many code and API changes. Almost all async devices have been removed. The corresponding functions are now in the formerly non-async classes.\n\n## Get Help / Discord\n\nIf you want to get in contact with me or need help with the library, you can get in touch with me via discord. There is a **[discord server](https://discord.gg/mZG2myJ)** and my discord tag is **agonist#6159**\n\n## :book: New Documentation\n\nThere is a new documentation site unter https://hahn-th.github.io/homematicip-rest-api which is still under construction.\n\n## Support me\n\n:heart: If you want to say thank you or want to support me, you can do that via PayPal.\n[https://paypal.me/thomas08154711](https://paypal.me/thomas08154711?country.x=DE&locale.x=de_DE)\n\n## Thanks\n\nKudos and a big thank you to @coreGreenberet, who created this library.\n\n## Installation\n\nTo install the package, run:\n```sh\npip install -U homematicip\n```\n\n### \"Nightly\" Builds\n\nEach push on the master branch will trigger a build. That way you can test the latest version of the library with your systems.\n```sh\npip install -U homematicip --pre\n```\n\n## New devices and config dump\n\nIf you missing a device which is not implemented yet, open an issue and append a dump of your configuration to it using https://gist.github.com. \nTo create a dump use the CLI:\n```sh\nhmip_cli --dump-configuration --anonymize\n```\nSee [Usage](#usage) for more instructions.\n\n## Usage\n\n### Generate Token\n\nIf you are about to connect to a **HomematicIP HCU1** you have to press the button on top of the device, before running the script. From now, you have 5 Minutes to complete the registration process.\n\nAfter that, run `hmip_generate_auth_token` (from the command line) to get an auth token for your access point. it will generate a \u201cconfig.ini\u201d in your current directory.\n\n### Use the CLI\n\nYou can send commands to homematicIP using the `hmip_cli` script. To get an overview, use -h or --help param. To address devices, use the argument -d in combination with the 24-digit ID (301400000000000000000000) from --list-devices.\n\nA few examples:\n\n- `hmip_cli --help` to get help\n- `hmip_cli --list-devices` to get a list of your devices.\n- `hmip_cli -d <id-from-device-list> --toggle-garage-door` to toogle the garage door with HmIP-WGC.\n- `hmip_cli --list-events` to listen to events and changes in your homematicIP system\n- `hmip_cli -d <id> --set-lock-state LOCKED --pin 1234` to lock a door with HmIP-DLD\n- `hmip_cli --dump-configuration --anonymize` to dump the current config and anonymize it.\n\n## Implemented Stuff\n\n- [x] Generate authentication token\n- [x] Read current state of the Environment\n- [x] Weather\n- [x] Location\n- [x] Basic Informations( apversion, pinAssigned, timeZone, \u2026 )\n- [x] Devices (partly)\n- [x] Client\n- [x] Groups\n\n## Homematic IP Devices:\n\n- [x] ALPHA-IP-RBG (Alpha IP Wall Thermostat Display)\n- [x] ALPHA-IP-RBGa (ALpha IP Wall Thermostat Display analog)\n- [ ] ELV-SH-AI8 (Alarmline Interface 8x Inputs) \\*powered by HmIP\n- [ ] ELV-SH-BS2 (Switch Actuator for brand switches 2x channels) \\*powered by HmIP\n- [x] ELV-SH-CTV Tilt Vibration Sensor Compact\n- [ ] ELV-SH-GVI (Garden valve interface) \\*powered by HmIP\n- [ ] ELV-SH-IRS8 (Infared Remote control - 8x channels) \\*powered by HmIP\n- [ ] ELV-SH-SW1-BAT (2x Actuator Switch for 30V/1A with 2xAA Batteries) \\*powered by HmIP\n- [ ] ELV-SH-WUA (Dimming Actuator, 0-10/1-10-V-Control inputs, 8A 230V) \\*powered by HmIP\n- [ ] ELV-SH-WSC (2x Servo Controls, 5v - 12V) \\*powered by HmIP\n- [x] HMIP-ASIR (Alarm Siren - indoor)\n- [x] HMIP-ASIR-B1 (Alarm Siren - indoor) _Silvercrest Edition_\n- [x] HMIP-ASIR-2 (Alarm Siren - indoor) New Version\n- [x] HMIP-ASIR-O (Alarm Siren - outdoor)\n- [x] HMIP-BBL (Blind Actuator for brand switches)\n- [ ] HMIP-BBL-2 (Blind Actuator for brand switches) New Version\n- [x] HMIP-BDT (Dimming Actuator for brand switches)\n- [x] HMIP-BRC2 (Remote Control for brand switches \u2013 2x channels)\n- [x] HMIP-BROLL (Shutter Actuator - brand-mount)\n- [ ] HMIP-BROLL-2 (Shutter Actuator - brand-mount) New Version\n- [x] HMIP-BSL (Switch Actuator for brand switches \u2013 with signal lamp)\n- [x] HMIP-BSM (Brand Switch and Meter Actuator)\n- [ ] HMIP-BSM-I (Brand Switch and Meter Actuator, International)\n- [x] HMIP-BWTH (Wall Thermostat Display with switching output \u2013 for brand switches, 230V)\n- [ ] HMIP-BWTH24 (Wall Thermostat Display with switching output \u2013 for brand switches, 24V)\n- [x] HMIP-DBB (Doorbell Push-Button)\n- [x] HMIP-DLD (Door Lock Drive)\n- [x] HMIP-DLS (Door Lock Sensor)\n- [x] HmIP-DRG-DALI (Dali Gateway - readonly at the moment)\n- [x] HMIP-DRBLI4 (Blind Actuator for DIN rail mount \u2013 4 channels)\n- [x] HMIP-DRSI1 (Switch Actuator for DIN rail mount \u2013 1x channel)\n- [x] HMIP-DRDI3 (Dimming Actuator Inbound 230V \u2013 3x channels, 200W per channel) electrical DIN rail\n- [x] HMIP-DRSI4 (Switch Actuator for DIN rail mount \u2013 4x channels)\n- [x] HMIP-DSD-PCB (Door Signal Dector PCB)\n- [x] HMIP-eTRV (Heating-Thermostat with Display)\n- [x] HMIP-eTRV-2 (Heating-Thermostat with Display) New Version\n- [ ] HMIP-eTRV-2 I9F (Heating-Thermostat with Display) New Version\n- [ ] HMIP-eTRV-2-UK (UK Version not tested, but it should work)\n- [x] HMIP-eTRV-B (Heating-Thermostat basic with Display)\n- [ ] HMIP-eTRV-B-2 (Heating-Thermostat basic with Display) New Version\n- [ ] HMIP-eTRV-B-2 R4M (Heating-Thermostat basic with Display) New Version\n- [ ] HMIP-eTRV-B-UK (UK Version not tested, but it should work)\n- [x] HMIP-eTRV-B1 (Heating-Thermostat basic with Display) _Silvercrest Edition_\n- [x] HMIP-eTRV-C (Heating-Thermostat compact without display)\n- [x] HMIP-eTRV-C-2 (Heating-Thermostat compact without display) New Version\n- [ ] HmIP-eTRV-CL (Heating-thermostat compact with dispay)\n- [x] HMIP-eTRV-E (Heating-Thermostat Design Evo _New Generation_, white)\n- [ ] HMIP-eTRV-E-A (Heating-Thermostat Design Evo _New Generation_, anthracite)\n- [ ] HMIP-eTRV-E-S (Heating-Thermostat Design Evo _New Generation_, silver)\n- [x] HMIP-eTRV-3 (Heating-Thermostat pure, white)\n- [x] HMIP-eTRV-F (Heating-Thermostat flex, white)\n- [x] HMIP-FAL230-C6 (Floor Heating Actuator \u2013 6x channels, 230V)\n- [x] HMIP-FAL230-C10 (Floor Heating Actuator \u2013 10x channels, 230V)\n- [x] HMIP-FAL24-C6 (Floor Heating Actuator \u2013 6x channels, 24V)\n- [x] HMIP-FAL24-C10 (Floor Heating Actuator \u2013 10x channels, 24V)\n- [x] HMIP-FALMOT-C12 (Floor Heating Actuator \u2013 12x channels, motorised)\n- [x] HMIP-FBL (Blind Actuator - flush-mount)\n- [x] HMIP-FCI1 (Contact Interface flush-mount \u2013 1x channel)\n- [x] HMIP-FCI6 (Contact Interface flush-mount \u2013 6x channels)\n- [x] HMIP-FDT (Dimming Actuator - flush-mount)\n- [x] HMIP-FROLL (Shutter Actuator - flush-mount)\n- [x] HMIP-FSI16 (Switch Actuator with Push-button Input 230V, 16A)\n- [x] HMIP-FSM (Switch Actuator and Meter 5A \u2013 flush-mount)\n- [x] HMIP-FSM16 (Switch Actuator and Meter 16A \u2013 flush-mount)\n- [ ] HMIP-FWI (Wiegand Interface)\n- [x] HMIP-HAP (Cloud Access Point)\n- [x] HMIP-HAP-B1 (Cloud Access Point) _Silvercrest Edition_\n- [x] HMIP-HDM1 (Hunter Douglas & erfal window blinds\n- [ ] HMIP-HDRC (Hunter Douglas & erfal window blinds remote control)\n- [ ] HMIP-K-DRBLI4 (Blinds Actuator \u2013 4x channels, 230V, 2,2A / 500W per channel) electrical DIN rail\n- [ ] HMIP-K-DRSI1 (Actuator Inbound 230V \u2013 1x channel) electrical DIN rail\n- [ ] HMIP-K-DRDI3 (Dimming Actuator Inbound 230V \u2013 3x channels, 200W per channel) electrical DIN rail\n- [ ] HMIP-K-DRSI4 (Switch Actuator \u2013 4x channels, 16A per channel) electrical DIN rail\n- [x] HMIP-KRCA (Key Ring Remote Control & Alarm)\n- [x] HMIP-KRC4 (Key Ring Remote Control - 4x buttons)\n- [ ] HMIP-MIO16-PCB (Multi Analog/Digitial Interface - Switch Circuit Board)\n- [x] HMIP-MIOB (Multi IO Box for floor heating & cooling)\n- [x] HMIP-MOD-HO (Garage Door Module for H\u00f6rmann)\n- [x] HMIP-MOD-OC8 (Open Collector Module Receiver - 8x)\n- [x] HMIP-MOD-RC8 (Open Collector Module Sender - 8x)\n- [x] HMIP-MOD-TM (Garage Door Module for Novoferm and Tormatic door operators)\n- [ ] HMIP-MP3P (Combination Signalling Device MP3)\n- [ ] HMIP-P-DRG-DALI (DALI Lights Gateway)\n- [x] HMIP-PCBS (Switch Circuit Board - 1x channel)\n- [x] HMIP-PCBS2 (Switch Circuit Board - 2x channels)\n- [x] HMIP-PCBS-BAT (Switch Circuit Board with Battery - 1x channel)\n- [x] HMIP-PDT (Plugable Dimmer)\n- [ ] HMIP-PDT-UK (UK Version not tested, but it should work)\n- [x] HMIP-PMFS (Plugable Power Supply Monitoring)\n- [x] HMIP-PS (Plugable Switch)\n- [ ] HMIP-PS-2 (Plugable Switch) New Version\n- [x] HMIP-PSM (Plugable Switch Measuring, Type F - Standard for Homematic)\n- [ ] HMIP-PSM-2 (Plugable Switch Measuring, Type F - Standard for Homematic) New Version\n- [x] HMIP-PSM-CH (Plugable Switch Measuring, Type J)\n- [ ] HMIP-PSM-IT (Type L not tested, but it should work)\n- [ ] HMIP-PSM-PE (Type E not tested, but it should work)\n- [ ] HMIP-PSM-UK (Type G not tested, but it should work)\n- [x] HMIP-PSMCO (Schalt-Mess-Kabel \u2013 au\u00dfen)\n- [x] HMIP-RC8 (Remote Control - 8x buttons)\n- [ ] HMIP-RCB1 (Remote Control - 1x button)\n- [x] HMIP-RGBW (RGB Led Controller - Readonly at the moment)\n- [x] HMIP-SAM (Acceleration Sensor)\n- [x] HMIP-SCI (Contact Interface Sensor)\n- [x] HMIP-SCTH230 (CO2, Temperature and Humidity Sensor 230V)\n- [ ] HMIP-SFD (Fine Dust Sensor)\n- [x] HMIP-SLO (Light Sensor - outdoor)\n- [x] HMIP-SMI (Motion Detector with Brightness Sensor - indoor)\n- [x] HMIP-SMI55 (Motion Detector with Brightness Sensor and Remote Control - 2x buttons)\n- [ ] HMIP-SMI55-2 (Motion Detector with Brightness Sensor and Remote Control - 2x buttons) New Version\n- [x] HMIP-SMO (Motion Detector with Brightness Sensor - outdoor)\n- [ ] HMIP-SMO-2 (Motion Detector with Brightness Sensor - outdoor) New Version\n- [x] HMIP-SMO-A (Motion Detector with Brightness Sensor - outdoor, anthracite)\n- [ ] HMIP-SMO-A-2 (Motion Detector with Brightness Sensor - outdoor, anthracite) New Version\n- [x] HmIP-SMO230-A\n- [x] HMIP-SPDR (Passage Sensor with Direction Recognition)\n- [x] HMIP-SPI (Presence Sensor - indoor)\n- [x] HMIP-SRH (Window Rotary Handle Sensor)\n- [x] HMIP-SRD (Rain Sensor)\n- [x] HMIP-STE2-PCB (Temperature Difference Sensors - 2x sensors)\n- [x] HMIP-STH (Temperature and Humidity Sensor without display - indoor)\n- [x] HMIP-STHD (Temperature and Humidity Sensor with display - indoor)\n- [x] HMIP-STHO (Temperature and Humidity Sensor - outdoor)\n- [x] HMIP-STHO-A (Temperature and Humidity Sensor \u2013 outdoor, anthracite)\n- [x] HMIP-STV (Inclination and vibration Sensor)\n- [x] HMIP-SWD (Water Sensor)\n- [x] HMIP-SWDM (Door / Window Contact - magnetic)\n- [ ] HMIP-SWDM-2 (Door / Window Contact - magnetic) New Version\n- [x] HMIP-SWDM-B2 (Door / Window Contact - magnetic) _Silvercrest Edition_\n- [x] HMIP-SWDO (Shutter Contact Optical)\n- [ ] HMIP-SWDO-2 (Shutter Contact Optical) New Version\n- [x] HMIP-SWDO-I (Shutter Contact Optical Invisible)\n- [x] HMIP-SWDO-PL (Shutter Contact Optical Plus)\n- [ ] HMIP-SWDO-PL-2 (Shutter Contact Optical Plus) New Version\n- [x] HMIP-SWO-B (Weather Sensor - Basic)\n- [x] HMIP-SWO-PL (Weather Sensor \u2013 Plus)\n- [x] HMIP-SWO-PR (Weather Sensor \u2013 Pro)\n- [x] HMIP-SWSD (Smoke Detector)\n- [ ] HMIP-USBSM (USB Switching Measurement Actuator)\n- [x] HMIP-WGC (Garage Door Button)\n- [x] HMIP-WHS2 (Switch Actuator for heating systems \u2013 2x channels)\n- [x] HMIP-WKP (Keypad)\n- [x] HMIP-WLAN-HAP (WLAN Access Point)\n- [x] HmIP-WLAN-HAP-B\n- [x] HMIP-WRC2 (Wall-mount Remote Control - 2x buttons)\n- [x] HMIP-WRC6 (Wall-mount Remote Control - 6x buttons)\n- [x] HMIP-WRCC2 (Wall-mount Remote Control \u2013 flat)\n- [ ] HMIP-WRCD (Wall-mount Remote Control - E-Paper-Status display)\n- [ ] HMIP-WRCR (Wall-mount Remote Control - Rotary)\n- [ ] HMIP-WT (Wall Mounted Thermostat without adjusting wheel) #probably only prototype for WTH-B and was not released\n- [x] HMIP-WTH (Wall Mounted Thermostat Pro with Display)\n- [ ] HMIP-WTH-1 (Wall Mounted Thermostat Pro with Display _Newest Version_ - successor of WTH-2 - really)\n- [x] HMIP-WTH-2 (Wall Mounted Thermostat Pro with Display)\n- [x] HMIP-WTH-B (Wall Mounted Thermostat basic without adjusting wheel)\n- [ ] HMIP-WTH-B-2 (Wall Mounted Thermostat basic without adjusting wheel) New Version\n- [ ] HMIP-WUA (Dimming Actuator, 0-10/1-10-V-Control inputs, 8A 230V)\n\n## Homematic IP Wired Devices (no radio signal):\n\n- [x] HMIPW-DRAP (Homematic IP Wired Access Point)\n- [ ] HMIPW-BRC2 (Homematic IP Wired Remote Control for brand switches \u2013 2x channels)\n- [x] HMIPW-DRBL4 (Homematic IP Wired Blinds Actuator \u2013 4x channels)\n- [x] HMIPW-DRD3 (Homematic IP Wired Dimming Actuator \u2013 3x channels)\n- [x] HMIPW-DRS4 (Homematic IP Wired Switch Actuator \u2013 4x channels)\n- [ ] HMIPW-DRI16 (Homematic IP Wired Inbound module \u2013 16x channels)\n- [x] HMIPW-DRI32 (Homematic IP Wired Inbound module \u2013 32x channels)\n- [x] HMIPW-DRS8 (Homematic IP Wired Switch Actuator \u2013 8x channels)\n- [ ] HMIPW-FAL24-C6 (Homematic IP Wired Floor Heating Actuator \u2013 6x channels, 24V)\n- [ ] HMIPW-FAL24-C10 (Homematic IP Wired Floor Heating Actuator \u2013 10x channels, 24V)\n- [ ] HMIPW-FAL230-C6 (Homematic IP Wired Floor Heating Actuator \u2013 6x channels, 230V)\n- [ ] HMIPW-FAL230-C10 (Homematic IP Wired Floor Heating Actuator \u2013 10x channels, 230V)\n- [x] HMIPW-FALMOT-C12 (Homematic IP Wired Floor Heating Actuator \u2013 12x channels, motorised)\n- [x] HMIPW-FIO6 (Homematic IP Wired IO Module flush-mount \u2013 6x channels)\n- [x] HMIPW-SCTHD (Homematic IP Wired CO2, Temperature and Humidity Sensor with Display)\n- [x] HMIPW-SMI55 (Homematic IP Wired Motion Detector with Brightness Sensor and Remote Control - 2x buttons)\n- [ ] HMIPW-SPI (Homematic IP Wired Presence Sensor - indoor)\n- [ ] HMIPW-STH (Homematic IP Wired Temperature and Humidity Sensor without display - indoor)\n- [ ] HMIPW-STHD (Homematic IP Wired Temperature and Humidity Sensor with display - indoor)\n- [ ] HMIPW-WGD (Homematic IP Wired Wall-mount Glas Display - black edition)\n- [ ] HMIPW-WGD-PL (Homematic IP Wired Wall-mount Glas Display Play - black edition)\n- [x] HMIPW-WRC2 (Homematic IP Wired Wall-mount Remote Control - 2x channels)\n- [x] HMIPW-WRC6 (Homematic IP Wired Wall-mount Remote Control - 6x channels)\n- [ ] HMIPW-WTH (Homematic IP Wired Wall Mounted Thermostat Pro with Display)\n\n## Events\n\nIt\u2019s also possible to use push notifications based on a websocket connection:\n\n```python\n # Example function to display incoming events.\ndef print_events(event_list):\n for event in event_list:\n print(\"EventType: {} Data: {}\".format(event[\"eventType\"], event[\"data\"]))\n\n\n# Initialise the API.\nconfig = homematicip.find_and_load_config_file()\nhome = Home()\nhome.set_auth_token(config.auth_token)\nhome.init(config.access_point)\n\n# Add function to handle events and start the connection.\nhome.onEvent += print_events\nhome.enable_events()\n\ntry:\n while True:\n time.sleep(1)\nexcept KeyboardInterrupt:\n print(\"Interrupt.\")\n```\n\n## Pathes for config.ini\n\nThe scripts will look for a config.ini in 3\ndifferent locations depending on your OS. Copy the file to one of these\nlocations so that it will be accessible for the scripts.\n\n- General\n - current working directory\n- Windows\n - %APPDATA%\\\\homematicip-rest-api\n - %PROGRAMDATA%\\\\homematicip-rest-api\n- Linux\n - ~/.homematicip-rest-api/\n - /etc/homematicip-rest-api/\n- MAC OS\n - ~/Library/Preferences/homematicip-rest-api/\n - /Library/Application Support/homematicip-rest-api/\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "An API for the homematicip cloud",
"version": "2.2.0",
"project_urls": {
"Changelog": "https://github.com/hahn-th/homematicip-rest-api/blob/master/CHANGELOG.md",
"Homepage": "https://github.com/hahn-th/homematicip-rest-api",
"Issues": "https://github.com/hahn-th/homematicip-rest-api/issues",
"Repository": "https://github.com/hahn-th/homematicip-rest-api.git"
},
"split_keywords": [
"homematicip cloud",
" homematicip"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "c4251db3270d0d97baf194b0c17f5b4fa6689451cf972beff5149f66764e159d",
"md5": "a0267304730f900ca82fe0b5f7d1409f",
"sha256": "792cd195aec2daf0408619164799e6a45d2938d880f425a0fbbd288dea9ade41"
},
"downloads": -1,
"filename": "homematicip-2.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a0267304730f900ca82fe0b5f7d1409f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 106881,
"upload_time": "2025-07-18T18:41:50",
"upload_time_iso_8601": "2025-07-18T18:41:50.596147Z",
"url": "https://files.pythonhosted.org/packages/c4/25/1db3270d0d97baf194b0c17f5b4fa6689451cf972beff5149f66764e159d/homematicip-2.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "37156c0fec9dd3207bd03ea8cec37cc8c0e3282605185a788d8497133ba23314",
"md5": "4b622ac4127370dc15744cec33034a94",
"sha256": "82c49a03dc52be2765ec98f603e1179ba797f5342301b459842369ff0c13a810"
},
"downloads": -1,
"filename": "homematicip-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "4b622ac4127370dc15744cec33034a94",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 200380,
"upload_time": "2025-07-18T18:41:52",
"upload_time_iso_8601": "2025-07-18T18:41:52.128070Z",
"url": "https://files.pythonhosted.org/packages/37/15/6c0fec9dd3207bd03ea8cec37cc8c0e3282605185a788d8497133ba23314/homematicip-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 18:41:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hahn-th",
"github_project": "homematicip-rest-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": [
[
">=",
"2.32.0"
]
]
},
{
"name": "aiohttp",
"specs": [
[
">=",
"3.10.2"
]
]
},
{
"name": "httpx",
"specs": [
[
">=",
"0.28.1"
]
]
}
],
"lcname": "homematicip"
}
JSON
