{"id":35423445,"url":"https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader","last_synced_at":"2026-05-24T16:00:58.531Z","repository":{"id":37698261,"uuid":"440864752","full_name":"darkrain-nl/home-assistant-addon-s0pcm-reader","owner":"darkrain-nl","description":"Seamlessly bridge S0PCM-2/5 pulse meters to Home Assistant via MQTT. Native UI configuration, auto-discovery, and secure state recovery included.","archived":false,"fork":false,"pushed_at":"2026-05-10T12:44:24.000Z","size":1653,"stargazers_count":6,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-05-10T13:48:55.814Z","etag":null,"topics":["energy-dashboard","energy-monitoring","home-assistant","home-assistant-addon","mqtt-client","mqtt-discovery","pulse-counter","s0pcm","stateless","water-meter"],"latest_commit_sha":null,"homepage":"https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader/blob/main/DOCS.md","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/darkrain-nl.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-12-22T13:20:39.000Z","updated_at":"2026-05-10T12:37:53.000Z","dependencies_parsed_at":"2023-02-08T13:01:14.197Z","dependency_job_id":"29126d49-39f3-47c7-ad90-564b49d81d3a","html_url":"https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader","commit_stats":null,"previous_names":[],"tags_count":173,"template":false,"template_full_name":null,"purl":"pkg:github/darkrain-nl/home-assistant-addon-s0pcm-reader","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darkrain-nl%2Fhome-assistant-addon-s0pcm-reader","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darkrain-nl%2Fhome-assistant-addon-s0pcm-reader/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darkrain-nl%2Fhome-assistant-addon-s0pcm-reader/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darkrain-nl%2Fhome-assistant-addon-s0pcm-reader/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/darkrain-nl","download_url":"https://codeload.github.com/darkrain-nl/home-assistant-addon-s0pcm-reader/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darkrain-nl%2Fhome-assistant-addon-s0pcm-reader/sbom","scorecard":{"id":1245342,"data":{"date":"2026-03-28T17:36:58Z","repo":{"name":"github.com/darkrain-nl/home-assistant-addon-s0pcm-reader","commit":"0b7490e8d672f0a962fb23d2d49cd00aa7fff32a"},"scorecard":{"version":"v5.3.0","commit":"c22063e786c11f9dd714d777a687ff7c4599b600"},"score":6.6,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/14 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/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#code-review"}},{"name":"Dependency-Update-Tool","score":10,"reason":"update tool detected","details":["Info: detected update tool: RenovateBot: renovate.json:1"],"documentation":{"short":"Determines if the project uses a dependency update tool.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dependency-update-tool"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/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/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#dangerous-workflow"}},{"name":"Security-Policy","score":4,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Warn: no linked content found","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#security-policy"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'contents' permission set to 'write': .github/workflows/update_copyright.yml:19","Warn: topLevel 'contents' permission set to 'write': .github/workflows/publish.yml:15","Warn: topLevel 'packages' permission set to 'write': .github/workflows/publish.yml:16","Info: topLevel permissions set to 'read-all': .github/workflows/scorecard.yml:9","Info: topLevel permissions set to 'read-all': .github/workflows/test.yml:3","Info: topLevel 'contents' permission set to 'read': .github/workflows/update_copyright.yml:10"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#token-permissions"}},{"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/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#vulnerabilities"}},{"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/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#cii-best-practices"}},{"name":"SAST","score":10,"reason":"SAST tool is run on all commits","details":["Info: all commits (30) are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#sast"}},{"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/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#fuzzing"}},{"name":"Pinned-Dependencies","score":5,"reason":"dependency not pinned by hash detected -- score normalized to 5","details":["Info: Possibly incomplete results: error parsing job operating system: .github/workflows/publish.yml:159","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:141: update your workflow using https://app.stepsecurity.io/secureworkflow/darkrain-nl/home-assistant-addon-s0pcm-reader/publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:169: update your workflow using https://app.stepsecurity.io/secureworkflow/darkrain-nl/home-assistant-addon-s0pcm-reader/publish.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yml:199: update your workflow using https://app.stepsecurity.io/secureworkflow/darkrain-nl/home-assistant-addon-s0pcm-reader/publish.yml/main?enable=pin","Warn: containerImage not pinned by hash: Dockerfile:2","Warn: containerImage not pinned by hash: Dockerfile.standalone:1: pin your Docker image by updating python:3.14-alpine to python:3.14-alpine@sha256:faee120f7885a06fcc9677922331391fa690d911c020abb9e8025ff3d908e510","Warn: containerImage not pinned by hash: tests/Dockerfile.test:4: pin your Docker image by updating python:3.14-alpine to python:3.14-alpine@sha256:faee120f7885a06fcc9677922331391fa690d911c020abb9e8025ff3d908e510","Warn: containerImage not pinned by hash: tests/standalone/Dockerfile.test_app:1: pin your Docker image by updating python:3.14-alpine to python:3.14-alpine@sha256:faee120f7885a06fcc9677922331391fa690d911c020abb9e8025ff3d908e510","Warn: containerImage not pinned by hash: tests/standalone/mqtt/Dockerfile:1: pin your Docker image by updating eclipse-mosquitto:2 to eclipse-mosquitto:2@sha256:9cfdd46ad59f3e3e5f592f6baf57ab23e1ad00605509d0f5c1e9b179c5314d87","Warn: containerImage not pinned by hash: tests/standalone/simulator/Dockerfile:1: pin your Docker image by updating python:3.14-alpine to python:3.14-alpine@sha256:faee120f7885a06fcc9677922331391fa690d911c020abb9e8025ff3d908e510","Warn: containerImage not pinned by hash: tests/standalone/verifier/Dockerfile:1: pin your Docker image by updating python:3.14-alpine to python:3.14-alpine@sha256:faee120f7885a06fcc9677922331391fa690d911c020abb9e8025ff3d908e510","Info:  17 out of  17 GitHub-owned GitHubAction dependencies pinned","Info:  13 out of  16 third-party GitHubAction dependencies pinned","Info:   0 out of   7 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#pinned-dependencies"}},{"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/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#signed-releases"}},{"name":"Packaging","score":10,"reason":"packaging workflow detected","details":["Info: Project packages its releases by way of GitHub Actions.: .github/workflows/publish.yml:208"],"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/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#packaging"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#license"}},{"name":"Branch-Protection","score":5,"reason":"branch protection is not maximal on development and all release branches","details":["Info: 'allow deletion' disabled on branch 'main'","Info: 'force pushes' disabled on branch 'main'","Info: 'branch protection settings apply to administrators' is required to merge on branch 'main'","Warn: 'stale review dismissal' is disabled on branch 'main'","Warn: required approving review count is 1 on branch 'main'","Warn: codeowners review is required - but no codeowners file found in repo","Warn: 'last push approval' is disabled on branch 'main'","Info: 'up-to-date branches' is required to merge on branch 'main'","Info: status check found to merge onto on branch 'main'","Info: PRs are required in order to make changes on branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#branch-protection"}},{"name":"Contributors","score":3,"reason":"project has 1 contributing companies or organizations -- score normalized to 3","details":["Info: found contributions from: actions"],"documentation":{"short":"Determines if the project has a set of contributors from multiple organizations (e.g., companies).","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#contributors"}},{"name":"CI-Tests","score":10,"reason":"14 out of 14 merged PRs checked by a CI test -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project runs tests before pull requests are merged.","url":"https://github.com/ossf/scorecard/blob/c22063e786c11f9dd714d777a687ff7c4599b600/docs/checks.md#ci-tests"}}]},"last_synced_at":"2026-03-28T17:49:17.070Z","repository_id":37698261,"created_at":"2026-03-28T17:49:17.070Z","updated_at":"2026-03-28T17:49:17.070Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32979305,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-13T06:31:55.726Z","status":"ssl_error","status_checked_at":"2026-05-13T06:31:51.336Z","response_time":115,"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":["energy-dashboard","energy-monitoring","home-assistant","home-assistant-addon","mqtt-client","mqtt-discovery","pulse-counter","s0pcm","stateless","water-meter"],"created_at":"2026-01-02T17:20:45.154Z","updated_at":"2026-05-13T11:00:55.923Z","avatar_url":"https://github.com/darkrain-nl.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# S0PCM Reader for Home Assistant\n\n[![GitHub Release][releases-shield]][releases] [![Add to Home Assistant][my-ha-shield]][my-ha] [![Reported Installations][installations-shield-stable]][installations-link]\n\nAn easy-to-use Home Assistant App that reads pulse counters from an **S0PCM-2** or **S0PCM-5** device and sends the data to Home Assistant via MQTT.\n\n## ✨ Features\n\n- **Plug \u0026 Play**: Automatically shows up in Home Assistant (MQTT Discovery).\n- **Easy Configuration**: Rename meters and fix totals directly in Home Assistant - no editing files.\n- **Reliable**: Restores your meter data on restart so you don't lose counts.\n- **Data Integrity**: Sensors automatically report as \"Unavailable\" when disconnected to prevent stale readings in HA.\n- **Simple \u0026 Clean**: No local database files to worry about.\n- **Secure**: Supports MQTT with TLS encryption.\n- **Instant Issues**: Reports connection errors immediately so you know if something is wrong.\n\n## 🛠️ Prerequisites\n\n- An **S0PCM reader** (S0PCM-2 or S0PCM-5) connected via USB.\n- An **MQTT Broker** (e.g., the official Mosquitto broker app).\n\n## 🚀 Installation (Recommended \u0026 Supported method)\n\n### Stable version\n1. Add this repository to your Home Assistant App Store:\n   `https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader`\n2. Search for **S0PCM Reader** and click **Install**.\n3. Navigate to the **Configuration** tab.\n4. Select your **S0PCM USB device** (e.g., `/dev/ttyACM0`).\n5. **Start** the app.\n\n### Beta version\nIf you want to help test upcoming features, you can install the Beta version. You can install both the Beta and Stable versions at the same time without conflicts.\n\n\u003e [!WARNING]\n\u003e While both apps can be installed simultaneously, **only one app can access the USB device at a time**. You must **stop** the Stable version before starting the Beta version, and vice-versa.\n\n1. Add the Beta repository to your Home Assistant App Store:\n   `https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader-beta`\n2. Search for **S0PCM Reader (Beta)** and click **Install**.\n3. Go to your Stable **S0PCM Reader**, **Stop** it, and disable **Start on boot**.\n4. Go to **S0PCM Reader (Beta)**, configure your USB device, and **Start** it.\n\n## 📖 Documentation\n\nFor detailed configuration, advanced settings, and standalone usage (Docker), please refer to the full documentation:\n\n**In Home Assistant:** Go to the **Documentation** tab.\n\n**On GitHub:** [View Full Documentation (DOCS.md)](https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader/blob/main/DOCS.md)\n\n### Quick Links (GitHub Only)\n- [Configuration Reference](https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader/blob/main/DOCS.md#3-configuration)\n- [Home Assistant Integration \u0026 Recipes](https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader/blob/main/DOCS.md#5-home-assistant-integration-cookbook)\n- [Standalone / Docker Usage](https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader/blob/main/DOCS.md#standalone-docker-container-advanced) (available as `ghcr.io/darkrain-nl/s0pcm-reader-standalone`)\n- [Troubleshooting](https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader/blob/main/DOCS.md#7-troubleshooting)\n\n## 🧪 Development \u0026 Testing\n\nIf you want to contribute or modify the code, we have included a test suite and a hardware simulator (`socket://`).\n\nCheck out [tests/README.md](tests/README.md) to see how to run it locally.\n\n## 🤝 Support\n\nIf you encounter issues or have suggestions, please [open an issue](https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader/issues) on GitHub.\n\n## ❤️ Credits\n\nInspired by the [docker-s0pcm-reader](https://github.com/ualex73/docker-s0pcm-reader) project by @ualex73.\n\n[releases-shield]: https://img.shields.io/github/v/release/darkrain-nl/home-assistant-addon-s0pcm-reader?style=flat-square\n[releases]: https://github.com/darkrain-nl/home-assistant-addon-s0pcm-reader/releases\n[installations-shield-stable]: https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fanalytics.home-assistant.io%2Faddons.json\u0026query=%24%5B%224a252ed0_s0pcm_reader%22%5D.total\u0026label=Reported%20Installations\u0026color=0382B9\u0026style=flat-square\n[installations-link]: https://analytics.home-assistant.io/add-ons\n[my-ha-shield]: https://img.shields.io/badge/Add%20to-Home%20Assistant-41BDF5?style=flat-square\u0026logo=home-assistant\n\n[my-ha]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fdarkrain-nl%2Fhome-assistant-addon-s0pcm-reader","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarkrain-nl%2Fhome-assistant-addon-s0pcm-reader","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarkrain-nl%2Fhome-assistant-addon-s0pcm-reader","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarkrain-nl%2Fhome-assistant-addon-s0pcm-reader/lists"}