{"id":35221268,"url":"https://github.com/ramses-rf/ramses_rf","last_synced_at":"2026-04-09T05:31:57.092Z","repository":{"id":37578745,"uuid":"223912799","full_name":"ramses-rf/ramses_rf","owner":"ramses-rf","description":"An interface for the RAMSES-II RF protocol, as used by Honeywell-compatible HVAC \u0026 CH/DHW systems.","archived":false,"fork":false,"pushed_at":"2026-03-07T19:36:31.000Z","size":8138,"stargazers_count":80,"open_issues_count":14,"forks_count":24,"subscribers_count":8,"default_branch":"master","last_synced_at":"2026-03-08T01:25:02.982Z","etag":null,"topics":["airios","bdr91a","chronotherm","evohome","evohome-rf","hgi80","hometronics","itho","orcon","ramses","ramses-rf","resideo","rf","sundial","vasco"],"latest_commit_sha":null,"homepage":"","language":"Python","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/ramses-rf.png","metadata":{"files":{"readme":"README-developers.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"buy_me_a_coffee":"zxdavb"}},"created_at":"2019-11-25T09:42:01.000Z","updated_at":"2026-03-07T19:36:41.000Z","dependencies_parsed_at":"2024-01-17T12:34:58.202Z","dependency_job_id":"6be01ba3-66d4-4f22-8d6e-5dfa49f86c62","html_url":"https://github.com/ramses-rf/ramses_rf","commit_stats":{"total_commits":3197,"total_committers":9,"mean_commits":"355.22222222222223","dds":"0.31091648420394125","last_synced_commit":"e43119c6d041e8d7ac831a5e234b7f947232b1e6"},"previous_names":["zxdavb/evohome","zxdavb/evohome_rf","ramses-rf/ramses_rf","zxdavb/ramses_rf"],"tags_count":256,"template":false,"template_full_name":null,"purl":"pkg:github/ramses-rf/ramses_rf","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ramses-rf%2Framses_rf","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ramses-rf%2Framses_rf/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ramses-rf%2Framses_rf/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ramses-rf%2Framses_rf/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ramses-rf","download_url":"https://codeload.github.com/ramses-rf/ramses_rf/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ramses-rf%2Framses_rf/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30467872,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-13T11:00:43.441Z","status":"ssl_error","status_checked_at":"2026-03-13T11:00:23.173Z","response_time":60,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["airios","bdr91a","chronotherm","evohome","evohome-rf","hgi80","hometronics","itho","orcon","ramses","ramses-rf","resideo","rf","sundial","vasco"],"created_at":"2025-12-30T00:01:47.996Z","updated_at":"2026-03-13T14:01:33.325Z","avatar_url":"https://github.com/ramses-rf.png","language":"Python","funding_links":["https://buymeacoffee.com/zxdavb"],"categories":[],"sub_categories":[],"readme":"![Linting](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-lint.yml/badge.svg)\n![Typing](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-type.yml/badge.svg)\n![Testing](https://github.com/ramses-rf/ramses_rf/actions/workflows/check-test.yml/badge.svg)\n\n# Ramses_rf developer's resource\n\n## Installation\n\nConfirm you have Python 3.13.x installed by running:\n```commandline\npython3 --version\n```\nNote: the ramses_cc HA integration venv runs Python 3.14.x to match current Home Assistant.\n\nUpgrade `pip` (or uv if you prefer):\n```commandline\npython -m pip install --upgrade pip\n```\n\nRun the following command to ensure you have the latest version of virtualenv:\n```commandline\npip install --upgrade virtualenv\n```\n\n### Virtual environment\n\nCreate a `venv` virtual environment, for example on macOS or Linux:\n```\nmkdir /your-path-to/virtual-envs\nmkdir /your-path-to/virtual-envs/ramses_rf\ncd /your-path-to/virtual-envs/ramses_rf\nPython3.13 -m venv ~/your-path-to/virtual-envs/ramses_rf\n```\nwhere `Python3.13` is the python version to set for the `venv`.\n\nYou might also create or link to this venv inside your preferred IDE.\n\n### Clone this repo\n\nClone this repo and install the requirements.\nUsing `pip`, in a location where your IDE has access:\n```commandline\ngit clone https://github.com/ramses-rf/ramses_rf\n```\n\nActivate the venv (repeat every new session):\n```commandline\ncd /your-path-to/ramses_rf\nsource /your-path-to/virtual-envs/ramses_rf/bin/activate\n```\nand confirm your Terminal prompt looks like:\n`(ramses_rf) user:ramses_rf`\n\n### Install dependencies:\n```commandline\ncd /your-path-to/ramses_rf\npip install -r requirements/requirements.txt\npip install -r requirements/requirements_dev.txt\n```\n\nRepeat this after a new release and also when dev_requirements change in master.\n\n### Install pre-commit hook\nFirst, verify the installed prek version (compare to requirements/requirements_dev.txt):\n```commandline\nprek --version\n```\nFinally, install the pre-commit hooks, and confirm all tests pass:\n```bash\nprek install\n```\n```\nprek installed at .git/hooks/pre-commit\n```\n\nSince we have moved from `pre-commit` to `prek`, a much faster drop-in replacement, you should update existing pre-commit hooks to use `prek` by running:\n```commandline\nprek install -f\n```\n```\nOverwriting existing hook at `.git/hooks/pre-commit`\nprek installed at `.git/hooks/pre-commit`\n```\n\nThe command to run the hooks from the terminal:\n```commandline\nprek run -a\n```\n\nRunning `prek run` will only check staged files before a commit, while\n`prek run -a` will check all files.\n\nYour IDE should automatically activate the prek pre-commit hook checks when you try to commit.\nThe rules for prek are in git in `.pre-commit-config.yaml`.\nCheck [issue 407](https://github.com/ramses-rf/ramses_rf/issues/407) when you run into troubles here.\n\n## Regression Snapshot Suite\n\nTo guarantee packet processing stability, this repository includes a comprehensive regression suite located in:\n* `tests/tests_tx/test_regression_tx.py` (Transport Layer / Parsing)\n* `tests/tests_rf/test_regression_rf.py` (Application Layer / Device State)\n\nThese tests utilize a large dataset of historical raw packets:\n* `tests/fixtures/regression_packets_sorted.txt`\n\n### What these tests do\nThese tests are **Replay Tests**, not functional logic tests. They feed the static packet log through the system and assert that the output exactly matches the stored \"Gold Standard\" snapshots (`.ambr` files) located in:\n* `tests/tests_tx/__snapshots__/test_regression_tx.ambr`\n* `tests/tests_rf/__snapshots__/test_regression_rf.ambr`\n\nThey ensure that refactoring parsers or device logic does not inadvertently alter how historical devices are detected or how their state is decoded.\n\n### Snapshot Update Policy\n**Strict Rule:** The snapshot files (`.ambr`) are treated as source code. They should **not** be altered (through a snapshot update) unless there is a specific, understood reason.\n\nIf your PR causes a regression test failure:\n1.  **Do not** simply run `--snapshot-update` to make the test pass.\n2.  **Inspect the failure:** Determine if the change in output is a **Regression** (you broke support for an old device) or an **Improvement** (you added support for a new device/attribute).\n3.  **If it is a Regression:** Fix your code.\n4.  **If it is an Improvement:** You may update the snapshot. However, you **must** provide a detailed explanation in your Pull Request description justifying the specific changes seen in the snapshot diff (e.g., *\"The snapshot diff shows `device_class` changing from `None` to `CO2Sensor` because this PR adds support for that sensor type\"*).\n\n## More\nBuild and view the code documentation locally for easier access and to confirm that\nyour own code contribution include proper documentation. See [Usage](docs/source/usage.md) for details.\n\nFor more hints, see the [How to submit a PR wiki page](https://github.com/ramses-rf/ramses_cc/wiki/7.-How-to-submit-a-PR)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Framses-rf%2Framses_rf","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Framses-rf%2Framses_rf","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Framses-rf%2Framses_rf/lists"}