{"id":18665335,"url":"https://github.com/robertklep/nefit-easy-core","last_synced_at":"2025-10-10T00:06:14.896Z","repository":{"id":3340900,"uuid":"49134798","full_name":"robertklep/nefit-easy-core","owner":"robertklep","description":"Core functionality to implementation communications with Nefit/Bosch backend.","archived":false,"fork":false,"pushed_at":"2022-12-07T02:50:40.000Z","size":84,"stargazers_count":21,"open_issues_count":12,"forks_count":4,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-09-09T13:01:48.104Z","etag":null,"topics":["bosch","home-automation","nefit-easy","node"],"latest_commit_sha":null,"homepage":null,"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}},"created_at":"2016-01-06T12:48:28.000Z","updated_at":"2024-01-09T12:34:11.000Z","dependencies_parsed_at":"2023-01-13T12:26:49.916Z","dependency_job_id":null,"html_url":"https://github.com/robertklep/nefit-easy-core","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"purl":"pkg:github/robertklep/nefit-easy-core","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fnefit-easy-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fnefit-easy-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fnefit-easy-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fnefit-easy-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robertklep","download_url":"https://codeload.github.com/robertklep/nefit-easy-core/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertklep%2Fnefit-easy-core/sbom","scorecard":{"id":780242,"data":{"date":"2025-08-11","repo":{"name":"github.com/robertklep/nefit-easy-core","commit":"255740c3e25d11255d4997068c1828341f650bb6"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"15 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-rq8g-5pc5-wrhr","Warn: Project is vulnerable to: GHSA-qrmc-fj45-qfc2","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-44pw-h2cw-w3vq","Warn: Project is vulnerable to: GHSA-jp4x-w63m-7wgm","Warn: Project is vulnerable to: GHSA-c429-5p7v-vgjp","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-2m39-62fm-q8r3","Warn: Project is vulnerable to: GHSA-mf6x-7mm4-x2g7","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-5v72-xg48-5rpm"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T04:44:20.157Z","repository_id":3340900,"created_at":"2025-08-23T04:44:20.157Z","updated_at":"2025-08-23T04:44:20.157Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278614458,"owners_count":26015967,"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","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","home-automation","nefit-easy","node"],"created_at":"2024-11-07T08:27:14.458Z","updated_at":"2025-10-10T00:06:14.881Z","avatar_url":"https://github.com/robertklep.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nefit Easy™ core\n\nCore functionality to implementation communications with Nefit/Bosch backend.\n\nUnless you're implementing a client yourself, this library is probably not what you're looking for.\n\n## Installation\n\n```\n$ npm i nefit-easy-core\n```\n\n### Synopsis\n\nThe Nefit Easy™ smart thermostat is sold in The Netherlands by [Nefit](http://www.welkombijnefit.nl/nl), a company owned by [Robert Bosch GmbH](http://www.bosch.com/).\n\nThe Easy can be controlled through apps for Android and iOS, which communicate with a Bosch-hosted backend using the [XMPP](https://en.wikipedia.org/wiki/XMPP) protocol. This library aims to implement the communication protocol used between the apps and the backend.\n\nDevices related to the Nefit Easy, like the Worcester Wave, the Junkers Control, the Buderus Logamatic TC100 and the Bosch Greenstar CT100, are _probably_ also supported.\n\n### Installation\n\nThis library requires Node.js 4.0.0 or later.\n\n#### Install it as a Node module\n\n``` javascript\n$ npm install nefit-easy-core\n```\n\n#### Checkout the repository (in case you want to run the example code)\n\n``` javascript\n$ git clone https://github.com/robertklep/nefit-easy-core\n$ cd nefit-easy-core\n$ npm install\n```\n\n### Other/related projects\n\n* [`nefit-easy-http-server`](https://github.com/robertklep/nefit-easy-http-server): an HTTP-to-XMPP bridge that allow projects that can't implement this library directly (for instance, if they aren't written in Javascript) to communicate, using an HTTP-based interface, with the Nefit Easy\n* [`nefit-easy-cli`](https://github.com/robertklep/nefit-easy-cli): a command line interface tool to communicate with the Nefit Easy\n* [`bosch-xmpp`](https://github.com/robertklep/bosch-xmpp): a similar library that can be used to communicate with other Bosch devices (it supports the Nefit Easy, but also IVT, Junkers Bosch, Buderus and probably any Bosch EasyRemote-compatible controller)\n* [`node-red-contrib-nefit-easy2`](https://flows.nodered.org/node/node-red-contrib-nefit-easy2): a Node RED node to interact with the Nefit Easy (fork of `node-red-contrib-nefit-easy`, which doesn't work anymore and its author has abandoned the project)\n\n### Disclaimer\n\nThe implementation of this library is based on reverse-engineering the communications between the apps and the backend, plus various other bits and pieces of information. It is _not_ based on any official information given out by Nefit/Bosch, 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\n## API\n\n### General information\n\nAll (asynchronous) methods return a promise that resolves to a plain object.\n\n`nefit-easy-core` uses [`debug`](https://github.com/visionmedia/debug) to provide some debug logging:\n\n```\n$ env DEBUG=nefit-easy-core node your-app.js\n```\n\n#### Constructor\n\n```\nconst Client = require('nefit-easy-core');\nconst client = Client({\n  serialNumber   : NEFIT_SERIAL_NUMBER,\n  accessKey      : NEFIT_ACCESS_KEY,\n  password       : NEFIT_PASSWORD,\n[ retryTimeout   : Number ]\n[ maxRetries     : Number ]\n});\n```\n\nA request is retried a few times (because the backend can only handle one request at a time, requests may get dropped when more than one client is active). The default is to retry every 2000 milliseconds (`retryTimeout`) for a maximum of 15 times (`maxRetries`).\n\n#### Reading data\n\n`client.get(uri : String) : Promise`\n\nThis allows retrieving specific URI's from the backend.\n\nA non-exhaustive list of URI's can be found [here](https://github.com/robertklep/nefit-easy-core/wiki/List-of-endpoints). And @marcelrv has done a great job of documenting a lot of endpoints, the results of which can be found [here](https://github.com/marcelrv/nefit_easy_protocol).\n\n#### Writing data\n\n`client.put(uri : String, data) : Promise`\n\nThis allows writing values to specific URI's.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertklep%2Fnefit-easy-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertklep%2Fnefit-easy-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertklep%2Fnefit-easy-core/lists"}