Skip to main content

Bosch Smart Home Controller API Python Library

Project description

Bosch Smart Home Controller API Python Library

This library implements the local communication REST API for the Bosch Smart Home Controller system. The API documentation is available here. It supports both long and short polling. The following device services are implemented:

  • TemperatureLevel
  • HumidityLevel
  • RoomClimateControl
  • ShutterContact
  • ValveTappet
  • PowerSwitch
  • PowerMeter
  • Routing
  • PowerSwitchProgram
  • PresenceSimulationConfiguration
  • BinarySwitch
  • SmokeDetectorCheck
  • Alarm
  • ShutterControl
  • CameraLight
  • PrivacyMode
  • CameraNotification
  • IntrusionDetectionControl
  • Keypad
  • LatestMotion
  • AirQualityLevel
  • SurveillanceAlarm
  • BatteryLevel
  • Thermostat
  • WaterLeakageSensor
  • WaterLeakageSensorTilt

The following device models are implemented, using the above services:

  • ShutterContact
  • ShutterControl
  • SmartPlug
  • SmartPlugCompact
  • LightControl
  • SmokeDetector
  • CameraEyes
  • IntrusionDetectionSystem
  • RoomClimateControl
  • Thermostat
  • WallThermostat
  • UniversalSwitch
  • MotionDetector
  • PresenceSimulationSystem
  • Twinguard
  • WaterLeakageSensor

Example

import 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()

To get a list of all devices, rooms and scenarios, see apisummary.py Example

Usage guide

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

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

boschshcpy-0.2.42.tar.gz (26.3 kB view details)

Uploaded Source

Built Distribution

boschshcpy-0.2.42-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

Details for the file boschshcpy-0.2.42.tar.gz.

File metadata

  • Download URL: boschshcpy-0.2.42.tar.gz
  • Upload date:
  • Size: 26.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.14

File hashes

Hashes for boschshcpy-0.2.42.tar.gz
Algorithm Hash digest
SHA256 fee2b4edc78b1d10706126231de7370feaef61b84ca4849163ca5649d12d78a3
MD5 5feae7c8f6987094f5c7eed9d705ba89
BLAKE2b-256 cd6e7cb7188584a876005b136e255d570209cd2786c7a717ef1d6f2173511036

See more details on using hashes here.

File details

Details for the file boschshcpy-0.2.42-py3-none-any.whl.

File metadata

  • Download URL: boschshcpy-0.2.42-py3-none-any.whl
  • Upload date:
  • Size: 29.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.14

File hashes

Hashes for boschshcpy-0.2.42-py3-none-any.whl
Algorithm Hash digest
SHA256 938798f9120229f831c0c89983437a2495d99fbe407a1b99724428ea003bcdd9
MD5 7dd438d3e3fe81a3f63d08baf3cd0e85
BLAKE2b-256 f4894948d0f07eff4d32def0c31088bbef6e37ce4310a75ad3525c5f018f9386

See more details on using hashes here.

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