diff --git a/README.md b/README.md index 856ec3a..9e28a98 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,65 @@ # bosch-thermostat-client-python Python3 asyncio package to talk to Bosch Thermostats via their gateway. -Suppored protocols are HTTP and XMPP. +Supported protocols are HTTP and XMPP. Both are still in development. -# Helper +## Helper -Now there is extra command added with this package `bosch_scan`. +Now there is extra command added with this package `bosch_cli`. -``` +```shell +# 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: - --help Show this message and exit. + --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 - +$ 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] + --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 - -s, --smallscan [HC|DHW|SENSORS] + -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. - ```