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
  • 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
  • LightControl
  • SmokeDetector
  • CameraEyes
  • IntrusionDetectionSystem
  • RoomClimateControl
  • Thermostat
  • WallThermostat
  • UniversalSwitch
  • MotionDetector
  • 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.device_helper.intrusion_detection_system
intrusion_control.arm_instant()

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.8.dev1.tar.gz (19.0 kB view details)

Uploaded Source

Built Distribution

boschshcpy-0.2.8.dev1-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file boschshcpy-0.2.8.dev1.tar.gz.

File metadata

  • Download URL: boschshcpy-0.2.8.dev1.tar.gz
  • Upload date:
  • Size: 19.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for boschshcpy-0.2.8.dev1.tar.gz
Algorithm Hash digest
SHA256 6440ae4b545ee5844750b27ae9e76ce514acf2d083663cd168859c9a899ba49b
MD5 b1c2556cc29df81954c1a44022a123d1
BLAKE2b-256 f8b44c7483c4d809091ad8c0a5b1528720d457e3dfc71c9c74219447837568eb

See more details on using hashes here.

File details

Details for the file boschshcpy-0.2.8.dev1-py3-none-any.whl.

File metadata

  • Download URL: boschshcpy-0.2.8.dev1-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/52.0.0 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for boschshcpy-0.2.8.dev1-py3-none-any.whl
Algorithm Hash digest
SHA256 35f6d124a512ffc5966ff7447ec393f4910862c788db3ffff120f0449c3db763
MD5 600efbe7e8147b663d263ea8702cbafc
BLAKE2b-256 5523f50ead50b795dfbd7fe6feb1d8a4e08ea42af3c16de17548ba3ef1b31f33

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