Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robertklep/bosch-xmpp
Protocol implementation for Bosch XMPP protocols
https://github.com/robertklep/bosch-xmpp
bosch easyremote ivt nefit-easy xmpp
Last synced: about 2 months ago
JSON representation
Protocol implementation for Bosch XMPP protocols
- Host: GitHub
- URL: https://github.com/robertklep/bosch-xmpp
- Owner: robertklep
- License: mit
- Created: 2018-09-23T11:48:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-13T16:05:17.000Z (over 1 year ago)
- Last Synced: 2024-10-29T00:18:59.177Z (2 months ago)
- Topics: bosch, easyremote, ivt, nefit-easy, xmpp
- Language: JavaScript
- Homepage:
- Size: 203 KB
- Stars: 47
- Watchers: 18
- Forks: 7
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bosch XMPP
Unofficial Bosch XMPP implementation, used for, amongst others:
* Nefit Easy and similar devices (Junkers Control CT100, Worcester Wave, Bosch RRC, Buderus Logamatic TC 100)
* Bosch/IVT heat pumps
* Junkers Bosch MB LANi/MB LAN2
* Buderus KM200, KM100 or KM50
* Bosch EasyControl CT200
* (probably) any Bosch EasyRemote compatible controller
## I keep getting JSON errors, but I'm sure I'm passing the correct serial/access key/password!
I found that the EasyControl app for iOS/Android is able to use your Bosch SingleKey ID password to access the device. This is _not_ possible with `bosch-xmpp` (if you use this password, you will get JSON decoding errors, which means that `bosch-xmpp` is unable to decrypt the response data).
Instead, you need to set an explicit device password. From the EasyControl app, you can change it from _"Settings > Personal > Change password"_.
## Command Line Interface
Install using `-g/--global`:
```
$ npm i -g bosch-xmpp
```
Options:
```
bosch-xmpp – Bosch XMPP command line interface
Usage:
bosch-xmpp [options] CLIENT get
bosch-xmpp [options] CLIENT put
bosch-xmpp [options] CLIENT bridge [] []
Options:
-h --help Show this screen
-v --version Show version
-V --verbose Be more verbose
--serial=SERIAL Device serial number (on some devices called "login name")
--access-key=ACCESS_KEY Device access key (on some devices called "password")
--password=PASSWORD Device password (on some devices, the user-configured password)
--xmpp-host=HOST XMPP host to connect to
--xmpp-port=PORT XMPP port to connect to [default: 5222]
--timeout=TIMEOUT Retry timeout in seconds [default: 5]
Supported values for CLIENT:
nefit Nefit Easy or compatible
ivt IVT/Bosch devices (mainly heat pumps)
easycontrol Bosch EasyControl (CT200)
Examples:
$ bosch-xmpp nefit get /ecus/rrc/uiStatus
$ bosch-xmpp ivt get /gateway/versionFirmware
$ bosch-xmpp nefit put /heatingCircuits/hc1/temperatureRoomManual '{"value":20.5}'
$ bosch-xmpp easycontrol bridge 8080 0.0.0.0
Instead of specifying serial number, access key or password through
options, you can also define them through environment variables:
BOSCH_XMPP_SERIAL_NUMBER
BOSCH_XMPP_ACCESS_KEY
BOSCH_XMPP_PASSWORD
```
## HTTP bridge
You can start a local HTTP server that will set up a persistent connection with the Bosch backend:
```
bosch-xmpp bridge
```
By default the bridge will listen on localhost port 3000. You can use the bridge from other software to retrieve endpoints.
The base URL, assuming the default, is `http://localhost:3000/bridge/ENDPOINT`. For example, to retrieve the `/ecus/rrc/uiStatus` endpoint, the URL will be `http://localhost:3000/bridge/ecus/rrc/uiStatus`.
## API
Install locally:
```
$ npm i bosch-xmpp
```
### Nefit Easy
```
const { NefitEasyClient } = require('bosch-xmpp');
// Instantiate client
const client = NefitEasyClient({
serialNumber : '...',
accessKey : '...',
password : '...',
});
await client.connect();
try {
console.log('%j', await client.get('/ecus/rrc/uiStatus'))
} catch(e) {
console.error(e.stack || e);
}
client.end();
```
### IVT
```
const { IVTClient } = require('bosch-xmpp');
const client = IVTClient({
serialNumber : '...',
accessKey : '...',
password : '...',
});
await client.connect();
try {
console.log('%j', await client.get('/gateway/versionFirmware'));
} catch(e) {
console.error(e.stack || e);
}
client.end();
```
### EasyControl (CT200)
```
const { EasyControlClient } = require('bosch-xmpp');
const client = EasyControlClient({
serialNumber : '...',
accessKey : '...',
password : '...',
});
await client.connect();
try {
console.log('%j', await client.get('/gateway/versionFirmware'));
} catch(e) {
console.error(e.stack || e);
}
client.end();
```
# Disclaimer
The implementation of this library is based on reverse-engineering the communications between the mobile apps and the backend, plus various other bits and pieces of information. It is not based on any official information given out by Bosch, Nefit or affiliated companies, and therefore there are no guarantees whatsoever regarding the safety of your devices and/or their settings, or the accuracy of the information provided.