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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bosch_thermostat_client-0.28.2-py3-none-any.whl (207.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: bosch-thermostat-client-0.28.2.tar.gz
  • Upload date:
  • Size: 122.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: pdm/2.25.5 CPython/3.12.11 Linux/6.11.0-1018-azure

File hashes

Hashes for bosch-thermostat-client-0.28.2.tar.gz
Algorithm Hash digest
SHA256 e7e4a19be627a37a4ba40bac98b62f7f83884c10b98f025ff4d182b7086e4171
MD5 a33e202fbc778772c46bc3797a460f72
BLAKE2b-256 6579c21c22b6bbac10d97614fa85482224d94214deea0846e38d8cdcd88a8e16

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for bosch_thermostat_client-0.28.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0d035ac89d7c94e85e3bf2c530a296a79aa055ae686602b2f1e7068f10a89204
MD5 7913f507d4d49b7ccb12c9464731c832
BLAKE2b-256 e8efe483e77ac57b2174f821f929e8cab44479924fabc2996c27f397092746f6

See more details on using hashes here.

Supported by

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