{"id":13588536,"url":"https://github.com/vectronic/homebridge-nut","last_synced_at":"2025-10-04T05:31:43.107Z","repository":{"id":44327077,"uuid":"177674983","full_name":"vectronic/homebridge-nut","owner":"vectronic","description":"Homebridge plugin for NUT (Network UPS Tools) Client","archived":false,"fork":true,"pushed_at":"2023-04-16T17:19:44.000Z","size":215,"stargazers_count":17,"open_issues_count":0,"forks_count":3,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-09-13T16:54:59.641Z","etag":null,"topics":["homebridge","homebridge-plugin","nut"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"ToddGreenfield/homebridge-nut","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vectronic.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":"2019-03-25T22:36:19.000Z","updated_at":"2025-07-26T07:09:58.000Z","dependencies_parsed_at":"2023-01-23T10:47:10.110Z","dependency_job_id":null,"html_url":"https://github.com/vectronic/homebridge-nut","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/vectronic/homebridge-nut","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vectronic%2Fhomebridge-nut","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vectronic%2Fhomebridge-nut/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vectronic%2Fhomebridge-nut/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vectronic%2Fhomebridge-nut/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vectronic","download_url":"https://codeload.github.com/vectronic/homebridge-nut/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vectronic%2Fhomebridge-nut/sbom","scorecard":{"id":917786,"data":{"date":"2025-08-11","repo":{"name":"github.com/vectronic/homebridge-nut","commit":"31163b5f9d491ffa441dc481a2ff5c642a9b39f3"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.3,"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":"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":"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":"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":"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":"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":"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":"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":"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":"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"}},{"name":"Vulnerabilities","score":0,"reason":"10 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22","Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7"],"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-24T21:49:39.409Z","repository_id":44327077,"created_at":"2025-08-24T21:49:39.409Z","updated_at":"2025-08-24T21:49:39.409Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278267498,"owners_count":25958877,"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-04T02:00:05.491Z","response_time":63,"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":["homebridge","homebridge-plugin","nut"],"created_at":"2024-08-01T15:06:46.680Z","updated_at":"2025-10-04T05:31:41.823Z","avatar_url":"https://github.com/vectronic.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# homebridge-nut\n\u003e A NUT (Network UPS Tools) Plugin for [Homebridge](https://github.com/nfarina/homebridge) leveraging [node-nut](https://github.com/skarcha/node-nut). \n\nThis plugin allows you to monitor multiple UPS devices with HomeKit via a NUT Client.\n\n**NOTE**: This is re-write of https://github.com/ToddGreenfield/homebridge-nut to avoid usage of `system-sleep` and \n`deasync` module dependencies which end up relying on native code. I was having problems with these blocking the\nNode event loop (possibly due to running on FreeBSD). I also wanted to avoid the need of having to do native code rebuilds...\n\n# Installation\n1. Install Homebridge using: `npm install -g homebridge`\n1. Install this plugin using: `npm install -g @vectronic/homebridge-nut`\n1. Update your configuration file. See a sample `config.json` snippet below.\n1. Ensure you have a NUT Client running somewhere.\n\nThis plugin will create an accessory for each UPS returned from the NUT Client.\n\nThe accessory will have a `ContactSensor` service and a `BatteryService`.\n\nThe `ContactSensor` will have the following characteristics:\n\n* `ContactSensorState` will be open if UPS Status starts with `OB` (On Battery).\n* `StatusActive` will be true if UPS Load is greater than 0.\n* `StatusFault` will be true if NUT is not reachable.\n\nThe `BatteryService` will have the following characteristics:\n \n* `BatteryLevel` will show the battery charge percentage.\n* `ChargingState` will show *Charging*, *Not Charging* (online and 100% battery charge), or *Not Chargeable* (on battery).\n* `StatusLowBattery` will be true if `BatteryLevel` is below `low_batt_threshold`.\n\n# Configuration\n\nExample `config.json` entry:\n\n```\n\"platforms\": [\n  {\n    \"platform\": \"Nut\",\n    \"name\": \"Nut\",\n    \"host\": \"localhost\",\n    \"port\": 3493,\n    \"username\": \"foo\",\n    \"password\": \"bar\",\n    \"low_batt_threshold\": 40,\n    \"poll_interval\": 60,\n    \"connect_interval\": 5,\n    \"command_interval\": 1,\n    \"ups_key_excludes\": [\n        \"foo\",\n        \"bar\"\n    ],\n    \"disable_battery_service\": false\n  }\n]\n```\n\nWhere the following properties are all optional:\n\n* `name` is the name used for Homebridge logging. Default is `Nut`.\n* `host` is the IP or hostname for the Nut Client. Default is `localhost`.\n* `port` is the port for the Nut Client. Default is `3493`.\n* `username` is the username to use for Nut Client authentication.\n* `password` is the password to use for Nut Client authentication.\n* `low_batt_threshold` is the battery level percentage at which to set the Low Battery Status to true. Default is `40`.\n* `poll_interval` is the UPS polling interval in seconds. Default is `60`.\n* `connect_interval` is the NUT client connection attempt interval in seconds. Default is `5`.\n* `command_interval` is the NUT client delay interval between success requests in seconds. Default is `1`.\n* `ups_key_excludes` is a list of Nut configured UPS keys which should be ignored.\n* `disable_battery_service` is optional and should almost always be `false` which is the default. In rare circumstances where your UPS is not fully supported by NUT you may wish to disable this.\n\n# Help etc.\n\nIf you have a query or problem, raise an issue in GitHub, or better yet submit a PR!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvectronic%2Fhomebridge-nut","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvectronic%2Fhomebridge-nut","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvectronic%2Fhomebridge-nut/lists"}