This library implements the local communication REST API for the Bosch Smart Home Controller system. It supports both long and short polling. The API documentation is available here.
The following device services are implemented:
TemperatureLevelHumidityLevelRoomClimateControlShutterContactValveTappetPowerSwitchPowerMeterRoutingPowerSwitchProgramPresenceSimulationConfigurationBinarySwitchSmokeDetectorCheckAlarmShutterControlCameraLightPrivacyModeCameraNotificationIntrusionDetectionControlKeypadLatestMotionAirQualityLevelSurveillanceAlarmBatteryLevelThermostatWaterLeakageSensorWaterLeakageSensorTilt- and more
The following device models are implemented, using the above services:
ShutterContact,ShutterContact2ShutterControl,Micromodule ShutterSmartPlugSmartPlugCompactLightControl,Micromodule Light Control,Micromodule Light Attached,Micromodule RelaySmokeDetectorCameraEyes,Camera360IntrusionDetectionSystemRoomClimateControlThermostat,Thermostat2WallThermostatUniversalSwitchMotionDetectorPresenceSimulationSystemTwinguardWaterLeakageSensor
- Install a
python(>=3.10) environment on your computer. - Install latest version of
boschshcpy, you should have at leastversion>=0.2.45.
pip install boschshcpyTo register a new client, use the script boschshc_registerclient:
boschshc_registerclient -ip _your_shc_ip_ -pw _your_shc_password_This will register your client and will write the associated certificate/key pair into your working directory. See also Usage Guide
To make a rawscan of your devices, use the script boschshc_rawscan
boschshc_rawscan -ip _your_shc_ip_ -cert _your_shc_cert_file_ -key _your_shc_key_file_ public_informationboschshc_rawscan -ip _your_shc_ip_ -cert _your_shc_cert_file_ -key _your_shc_key_file_ devicesboschshc_rawscan -ip _your_shc_ip_ -cert _your_shc_cert_file_ -key _your_shc_key_file_ device _your_device_id_An exemplary output looks as follows:
{
"@type": "device",
"rootDeviceId": "xx-xx-xx-xx-xx-xx",
"id": "hdm:HomeMaticIP:30xxx",
"deviceServiceIds": [
"Thermostat",
"BatteryLevel",
"ValveTappet",
"SilentMode",
"TemperatureLevel",
"Linking",
"TemperatureOffset"
],
"manufacturer": "BOSCH",
"roomId": "hz_8",
"deviceModel": "TRV",
"serial": "30xxx",
"profile": "GENERIC",
"name": "Test Thermostat",
"status": "AVAILABLE",
"parentDeviceId": "roomClimateControl_hz_8",
"childDeviceIds": []
},boschshc_rawscan -ip _your_shc_ip_ -cert _your_shc_cert_file_ -key _your_shc_key_file_ device_services _your_device_id_The exemplary output will look as follows:
[
{
"@type": "DeviceServiceData",
"id": "BatteryLevel",
"deviceId": "hdm:HomeMaticIP:30xxx",
"path": "/devices/hdm:HomeMaticIP:30xxx/services/BatteryLevel"
},
{
"@type": "DeviceServiceData",
"id": "Thermostat",
"deviceId": "hdm:HomeMaticIP:30xxx",
"state": {
"@type": "childLockState",
"childLock": "OFF"
},
"path": "/devices/hdm:HomeMaticIP:30xxx/services/Thermostat"
},
...
]Make a rawscan of the a service of a device, where the device_id as well as the service_id are known
boschshc_rawscan -ip _your_shc_ip_ -cert _your_shc_cert_file_ -key _your_shc_key_file_ device_service _your_device_id_ _your_service_idboschshc_rawscan -ip _your_shc_ip_ -cert _your_shc_cert_file_ -key _your_shc_key_file_ scenariosboschshc_rawscan -ip _your_shc_ip_ -cert _your_shc_cert_file_ -key _your_shc_key_file_ roomsimport boschshcpy
# Create session
session = boschshcpy.SHCSession(controller_ip="192.168.25.51", certificate='cert.pem', key='key.pem')
session.information.summary()
device = session.device('roomClimateControl_hz_5')
service = device.device_service('TemperatureLevel')
print(service.temperature)
# Update this service's state
service.short_poll()
# Start long polling thread in background
session.start_polling()
# Do work here
...
# Stop polling
session.stop_polling()
# Trigger intrusion detection system
intrusion_control = session.intrusion_system
intrusion_control.arm()
# Get rawscan of devices
scan_result = session.rawscan(command="devices")Before accessing the Bosch Smart Home Controller, a client must be registered on the controller. For this a valid cert/key pair must be provided to the controller. To start the client registration, press and hold the button on the controller until the led starts flashing. More information here.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent