{"id":18665322,"url":"https://github.com/robertklep/bosch-xmpp","last_synced_at":"2025-04-11T22:31:02.598Z","repository":{"id":33081243,"uuid":"149979539","full_name":"robertklep/bosch-xmpp","owner":"robertklep","description":"Protocol implementation for Bosch XMPP protocols","archived":false,"fork":false,"pushed_at":"2025-03-25T06:29:05.000Z","size":226,"stargazers_count":52,"open_issues_count":18,"forks_count":8,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-04-10T01:53:17.244Z","etag":null,"topics":["bosch","easyremote","ivt","nefit-easy","xmpp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robertklep.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-23T11:48:52.000Z","updated_at":"2025-03-25T06:29:08.000Z","dependencies_parsed_at":"2024-06-19T22:48:01.936Z","dependency_job_id":"a5709cf7-c860-4825-9dfb-0bc4858bd795","html_url":"https://github.com/robertklep/bosch-xmpp","commit_stats":{"total_commits":33,"total_committers":3,"mean_commits":11.0,"dds":0.06060606060606055,"last_synced_commit":"3ebf279219323f588263e1351cbbea96ca3365ad"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fbosch-xmpp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fbosch-xmpp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fbosch-xmpp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fbosch-xmpp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robertklep","download_url":"https://codeload.github.com/robertklep/bosch-xmpp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248489537,"owners_count":21112594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bosch","easyremote","ivt","nefit-easy","xmpp"],"created_at":"2024-11-07T08:27:11.769Z","updated_at":"2025-04-11T22:31:02.187Z","avatar_url":"https://github.com/robertklep.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Bosch XMPP\n\nUnofficial Bosch XMPP implementation, used for, amongst others:\n\n* Nefit Easy and similar devices (Junkers Control CT100, Worcester Wave, Bosch RRC, Buderus Logamatic TC 100)\n* Bosch/IVT heat pumps\n* Junkers Bosch MB LANi/MB LAN2\n* Buderus KM200, KM100 or KM50\n* Bosch EasyControl CT200\n* (probably) any Bosch EasyRemote compatible controller\n\n## I keep getting JSON errors, but I'm sure I'm passing the correct serial/access key/password!\n\nI 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).\n\nInstead, you need to set an explicit device password. From the EasyControl app, you can change it from _\"Settings \u003e Personal \u003e Change password\"_. \n\n## Command Line Interface\n\nInstall using `-g/--global`:\n```\n$ npm i -g bosch-xmpp\n```\n\nOptions:\n\n```\nbosch-xmpp – Bosch XMPP command line interface\n\nUsage:\n  bosch-xmpp [options] CLIENT get \u003cendpoint\u003e\n  bosch-xmpp [options] CLIENT put \u003cendpoint\u003e \u003cvalue\u003e\n  bosch-xmpp [options] CLIENT bridge [\u003cport\u003e] [\u003chost\u003e]\n\nOptions:\n  -h --help                Show this screen\n  -v --version             Show version\n  -V --verbose             Be more verbose\n  --serial=SERIAL          Device serial number (on some devices called \"login name\")\n  --access-key=ACCESS_KEY  Device access key (on some devices called \"password\")\n  --password=PASSWORD      Device password (on some devices, the user-configured password)\n  --xmpp-host=HOST         XMPP host to connect to\n  --xmpp-port=PORT         XMPP port to connect to [default: 5222]\n  --timeout=TIMEOUT        Retry timeout in seconds [default: 5]\n\nSupported values for CLIENT:\n  nefit                    Nefit Easy or compatible\n  ivt                      IVT/Bosch devices (mainly heat pumps)\n  easycontrol              Bosch EasyControl (CT200)\n\nExamples:\n  $ bosch-xmpp nefit get /ecus/rrc/uiStatus\n  $ bosch-xmpp ivt get /gateway/versionFirmware\n  $ bosch-xmpp nefit put /heatingCircuits/hc1/temperatureRoomManual '{\"value\":20.5}'\n  $ bosch-xmpp easycontrol bridge 8080 0.0.0.0\n\nInstead of specifying serial number, access key or password through\noptions, you can also define them through environment variables:\n\n  BOSCH_XMPP_SERIAL_NUMBER\n  BOSCH_XMPP_ACCESS_KEY\n  BOSCH_XMPP_PASSWORD\n```\n\n## HTTP bridge\n\nYou can start a local HTTP server that will set up a persistent connection with the Bosch backend:\n```\nbosch-xmpp bridge\n```\n\nBy default the bridge will listen on localhost port 3000. You can use the bridge from other software to retrieve endpoints.\n\nThe 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`.\n\n## API\n\nInstall locally:\n```\n$ npm i bosch-xmpp\n```\n\n### Nefit Easy\n\n```\nconst { NefitEasyClient } = require('bosch-xmpp');\n\n// Instantiate client\nconst client = NefitEasyClient({\n  serialNumber : '...',\n  accessKey    : '...',\n  password     : '...',\n});\n\nawait client.connect();\ntry {\n  console.log('%j', await client.get('/ecus/rrc/uiStatus'))\n} catch(e) {\n  console.error(e.stack || e);\n}\nclient.end();\n```\n\n### IVT\n\n```\nconst { IVTClient } = require('bosch-xmpp');\n\nconst client = IVTClient({\n  serialNumber : '...',\n  accessKey    : '...',\n  password     : '...',\n});\n\nawait client.connect();\ntry {\n  console.log('%j', await client.get('/gateway/versionFirmware'));\n} catch(e) {\n  console.error(e.stack || e);\n}\nclient.end();\n```\n\n### EasyControl (CT200)\n\n```\nconst { EasyControlClient } = require('bosch-xmpp');\n\nconst client = EasyControlClient({\n  serialNumber : '...',\n  accessKey    : '...',\n  password     : '...',\n});\n\nawait client.connect();\ntry {\n  console.log('%j', await client.get('/gateway/versionFirmware'));\n} catch(e) {\n  console.error(e.stack || e);\n}\nclient.end();\n```\n\n# Disclaimer\n\nThe 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertklep%2Fbosch-xmpp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertklep%2Fbosch-xmpp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertklep%2Fbosch-xmpp/lists"}