bosch-xmpp

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

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 <endpoint>
  bosch-xmpp [options] CLIENT put <endpoint> <value>
  bosch-xmpp [options] CLIENT bridge [<port>] [<host>]

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.