Skip to main content

Python API for talking to Bosch™ Heating gateway using HTTP or XMPP

Project description

bosch-thermostat-client-python

Python3 asyncio package to talk to Bosch Thermostats via their gateway. Supported protocols are HTTP and XMPP.

Both are still in development.

Helper

Now there is extra command added with this package bosch_cli.

# Create Python virtual environment
$ python3 -m venv bosch-thermostat-client
$ source bosch-thermostat-client/bin/activate

# Install bosch-thermostat-client
$ pip install bosch-thermostat-client

# Use bosch_cli
$ bosch_cli --help
Usage: bosch_cli [OPTIONS] COMMAND [ARGS]...

  A tool to run commands against Bosch thermostat.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  put    Send value to Bosch thermostat.
  query  Query values of Bosch thermostat.
  scan   Create rawscan of Bosch thermostat.

$ bosch_cli scan --help
Usage: bosch_cli scan [OPTIONS]

  Create rawscan of Bosch thermostat.

Options:
  --config PATH                   Read configuration from PATH.  [default:
                                  config.yml]
  --host TEXT                     IP address of gateway or SERIAL for XMPP
                                  [required]
  --token TEXT                    Token from sticker without dashes.
                                  [required]
  --password TEXT                 Password you set in mobile app.
  --protocol [XMPP|HTTP]          Bosch protocol. Either XMPP or HTTP.
                                  [required]
  --device [NEFIT|IVT|EASYCONTROL]
                                  Bosch device type. NEFIT, IVT or
                                  EASYCONTROL.  [required]
  -d, --debug                     Set Debug mode. Single debug is debug of
                                  this lib. Second d is debug of aioxmpp as
                                  well.
  -o, --output TEXT               Path to output file of scan. Default to
                                  [raw/small]scan_uuid.json
  --stdout                        Print scan to stdout
  -d, --debug
  -i, --ignore-unknown            Ignore unknown device type. Try to scan
                                  anyway. Useful for discovering new devices.
  -s, --smallscan [HC|DHW|SENSORS|RECORDINGS]
                                  Scan only single circuit of thermostat.
  --help                          Show this message and exit.

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

bosch-thermostat-client-0.28.0.tar.gz (122.6 kB view details)

Uploaded Source

Built Distribution

bosch_thermostat_client-0.28.0-py3-none-any.whl (207.4 kB view details)

Uploaded Python 3

File details

Details for the file bosch-thermostat-client-0.28.0.tar.gz.

File metadata

  • Download URL: bosch-thermostat-client-0.28.0.tar.gz
  • Upload date:
  • Size: 122.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.24.2 CPython/3.12.10 Linux/6.11.0-1015-azure

File hashes

Hashes for bosch-thermostat-client-0.28.0.tar.gz
Algorithm Hash digest
SHA256 504b3bd2be510a8471401d17001b7568cc1197f3c15ac3ba7ea4b20e1e068076
MD5 1c0d929279c8e47d193a67795fedefe2
BLAKE2b-256 249b0109c724dbc632a83e5a82b2516579f033be5b7a6253d825e4458fbc0dbd

See more details on using hashes here.

File details

Details for the file bosch_thermostat_client-0.28.0-py3-none-any.whl.

File metadata

File hashes

Hashes for bosch_thermostat_client-0.28.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66e346882d60fc038b50ae00dfe4588165414a2992e5994a0decb96c80307787
MD5 25c994fad90e7cfee0ec574634be4886
BLAKE2b-256 232bff6e6e279bf4e9437e0544329a219a5fcda0a6e09544efcb2b01ee3ba6c2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page