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

Uploaded Source

Built Distribution

boschshcpy-0.2.8.dev4-py3-none-any.whl (27.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: boschshcpy-0.2.8.dev4.tar.gz
  • Upload date:
  • Size: 20.2 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.dev4.tar.gz
Algorithm Hash digest
SHA256 ca0bec4d757a4c28f357929aa7bdbfc0725bc156ebefc8cd1ab487386f554072
MD5 b303981405e925533d22da2afc2a4d49
BLAKE2b-256 d08470ffb5ce36af86f38e53f7582f1a64f82a78dcacbc7f920ca167dafc4900

See more details on using hashes here.

File details

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

File metadata

  • Download URL: boschshcpy-0.2.8.dev4-py3-none-any.whl
  • Upload date:
  • Size: 27.3 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.dev4-py3-none-any.whl
Algorithm Hash digest
SHA256 a7d4867f00e1d1e806a4844ff788a11a8f8a398e2d2be3162e3ce958a64d0e7c
MD5 6556df54aa92095f2345cd487908df19
BLAKE2b-256 db2e7a470af4e3cabe068a7527f958b712ce820437380ca7cc5483af5a3ea569

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