{"id":15287640,"url":"https://github.com/tripflex/node-homie2-config","last_synced_at":"2026-05-04T23:35:46.244Z","repository":{"id":57266416,"uuid":"116997052","full_name":"tripflex/node-homie2-config","owner":"tripflex","description":"Use the Homie Configuration API to setup a homie board (using Homie 2.0+). This is an alternative to using the web configuration interface and the Android app. You could use this to setup lots of boards if you needed or design your own web interface.","archived":false,"fork":false,"pushed_at":"2018-01-10T20:07:26.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-24T11:00:01.983Z","etag":null,"topics":["homie","homie-convention","homie-esp8266","node","nodejs","npm","npm-package"],"latest_commit_sha":null,"homepage":"https://github.com/marvinroger/homie","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tripflex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-10T18:46:40.000Z","updated_at":"2018-01-10T18:48:30.000Z","dependencies_parsed_at":"2022-08-25T03:41:05.829Z","dependency_job_id":null,"html_url":"https://github.com/tripflex/node-homie2-config","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tripflex/node-homie2-config","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tripflex%2Fnode-homie2-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tripflex%2Fnode-homie2-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tripflex%2Fnode-homie2-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tripflex%2Fnode-homie2-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tripflex","download_url":"https://codeload.github.com/tripflex/node-homie2-config/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tripflex%2Fnode-homie2-config/sbom","scorecard":{"id":898835,"data":{"date":"2025-08-11","repo":{"name":"github.com/tripflex/node-homie2-config","commit":"892d5a10acba1168d26ae9b6f77f62e2a083ca37"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.6,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/17 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":"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":"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":"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":"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":"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":"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":"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":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"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":"License","score":0,"reason":"license file not detected","details":["Warn: project does not have a license file"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"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"}}]},"last_synced_at":"2025-08-24T14:45:04.266Z","repository_id":57266416,"created_at":"2025-08-24T14:45:04.267Z","updated_at":"2025-08-24T14:45:04.267Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32628976,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-04T10:08:07.713Z","status":"ssl_error","status_checked_at":"2026-05-04T10:08:02.005Z","response_time":58,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["homie","homie-convention","homie-esp8266","node","nodejs","npm","npm-package"],"created_at":"2024-09-30T15:33:44.228Z","updated_at":"2026-05-04T23:35:46.226Z","avatar_url":"https://github.com/tripflex.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Homie2Config\n\nHomie2Config is a node.js module to configure esp8266 boards loaded with [Homie firmware](https://github.com/marvinroger/homie-esp8266).\n\nThis is for Homie version 2.0+, original codebase from [HomieConfig](https://github.com/hongkongkiwi/node-homie-config)\n\n## QuickStart\n\nYou can grab homie2-config from npm.\n\n`npm install --save homie2-config`\n\nMake sure to set an ip address or hostname for the board. By default, `192.168.123.1` is used in case you don't pass anything.\n\n```javascript\nvar Homie2Config = require('homie2-config');\n\nvar homie2 = new Homie2Config();\n```\n\nIf you want to set the url/ip you can do it this way:\n\n`var homie2 = new Homie2Config({url: 'homie.local'});`\n\nTraditional Callbacks\n\n```javascript\n// You can choose to use traditional callbacks\nhomie2.getHeartBeat(function(isAlive) {\n  if (!isAlive) {\n    return console.log(\"Oh no, we don't have a heartbeat!\");\n  }\n  console.log(\"We have a heartbeat!\");\n});\n```\n\nPromises are also supported by attaching (async) to method names\n\n```javascript\nhomie2.getHeartBeatAsync()\n  .then(function(isAlive) {\n    if (!isAlive) {\n      console.log(\"Oh no, we don't have a heartbeat! Please check the server url \" + this.baseUrl);\n    }\n    console.log(\"We have a heartbeat!\");\n  }).catch(function (error) {\n    console.log('error',error);\n  });\n```\n\nYou can chain up the methods easily using promises. I recommend you always use getHeartBeat before other methods.\n\n```javascript\nhomie2.getHeartBeatAsync()\n  .then(function(isAlive) {\n    if (!isAlive) {\n      console.log(\"Oh no, we don't have a heartbeat! Please check the server url \" + this.baseUrl);\n    }\n    return homie2.getDeviceInfoAsync();\n  }).then(function(deviceInfo) {\n    console.log('Device Info', deviceInfo);\n  }).catch(function (error) {\n    console.log('error',error);\n  });\n```\n\nPlease find more examples in the [examples directory](https://github.com/tripflex/node-homie2-config/tree/master/examples).\n\n## Meteor Package\nThere is also a Meteor Package available that uses this npm module, and includes numerous other Homie helper methods:\n\n[https://github.com/tripflex/meteor-homie](https://github.com/tripflex/meteor-homie)\n\n## Configuration Wizard\n\nThere is a simple interactive configuration wizard available incase you just don't want to both with using it programatically.\n\nIn the examples directory run node ./configWizard.js\n\n## Supported Methods\n\nThe library supports all [current Configuration API functions](http://marvinroger.github.io/homie-esp8266/docs/2.0.0-beta.3/configuration/http-json-api/).\n\nThese require the board to be accessible.\n\n* getHeartBeat(callback)\n* getDeviceInfo(callback)\n* getNetworks(callback)\n* saveConfig(config, callback)\n* connectToWifi(ssid, password, callback)\n* getWifiStatus(callback)\n* setTransparentWifiProxy(enable, callback)\n* generateConfig(device_name, device_id, wifi_ssid, wifi_password, mqtt_host, mqtt_options, ota, callback)\n\n## Contributing\n\nFeel free to submit any pull requests or add functionality, and check out the Meteor Package that includes this module, as well as numerous other helper methods:\n[https://github.com/tripflex/meteor-homie](https://github.com/tripflex/meteor-homie)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftripflex%2Fnode-homie2-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftripflex%2Fnode-homie2-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftripflex%2Fnode-homie2-config/lists"}