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.33.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

boschshcpy-0.2.33-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: boschshcpy-0.2.33.tar.gz
  • Upload date:
  • Size: 25.8 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.10

File hashes

Hashes for boschshcpy-0.2.33.tar.gz
Algorithm Hash digest
SHA256 2f8d2034db2e5fcde128297c3e3f0404a185e5814bf3f183794bfeccf66c7827
MD5 4f5714306c879b1fcf5b0a31b9fe0cb4
BLAKE2b-256 2743b5dce5052e72dbcd0c291e8475c7bc834e1b86164fa6ff7ccae24eade162

See more details on using hashes here.

File details

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

File metadata

  • Download URL: boschshcpy-0.2.33-py3-none-any.whl
  • Upload date:
  • Size: 28.7 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.10

File hashes

Hashes for boschshcpy-0.2.33-py3-none-any.whl
Algorithm Hash digest
SHA256 0815809c8d086f6a49df3995d993feb5172f425e64528f63c2b7b2ffbc706b1a
MD5 d519dd4db6a4d1c453024333cb3b3507
BLAKE2b-256 f5138d94b3469b6e5718f8efb6ea352ce50b146d6006f20290bb6f79786a9b23

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