Merge branch 'main' into protocol_listening

Author: Lash-L

CHANGELOG.md

@@ -2,6 +2,188 @@
 
 <!-- version list -->
 
+## v4.8.0 (2026-01-27)
+
+### Features
+
+- Add the ability to set q7 mode
+  ([#748](https://github.com/Python-roborock/python-roborock/pull/748),
+  [`bf1f8af`](https://github.com/Python-roborock/python-roborock/commit/bf1f8af7bf39a15d546fbd420ff3979f7014042c))
+
+
+## v4.7.2 (2026-01-20)
+
+### Bug Fixes
+
+- Handle different error format for map status
+  ([#744](https://github.com/Python-roborock/python-roborock/pull/744),
+  [`9897379`](https://github.com/Python-roborock/python-roborock/commit/98973795af550ed7940c9c637c85adc84ec5a511))
+
+
+## v4.7.1 (2026-01-19)
+
+### Bug Fixes
+
+- Add rooms from map_info which is occassionally available
+  ([#750](https://github.com/Python-roborock/python-roborock/pull/750),
+  [`814054e`](https://github.com/Python-roborock/python-roborock/commit/814054ee4200c5f172d3f658843a9c8ee99c7f52))
+
+
+## v4.7.0 (2026-01-18)
+
+### Chores
+
+- Address PR comments ([#747](https://github.com/Python-roborock/python-roborock/pull/747),
+  [`a97e90a`](https://github.com/Python-roborock/python-roborock/commit/a97e90aa11b4e60732014d8d65265a334568f32c))
+
+- Include snapshots ([#747](https://github.com/Python-roborock/python-roborock/pull/747),
+  [`a97e90a`](https://github.com/Python-roborock/python-roborock/commit/a97e90aa11b4e60732014d8d65265a334568f32c))
+
+- **deps-dev**: Bump ruff from 0.14.10 to 0.14.11
+  ([#742](https://github.com/Python-roborock/python-roborock/pull/742),
+  [`9274642`](https://github.com/Python-roborock/python-roborock/commit/92746429ddb029e20073dab127598645a223c856))
+
+### Features
+
+- Add from diagnostics ([#747](https://github.com/Python-roborock/python-roborock/pull/747),
+  [`a97e90a`](https://github.com/Python-roborock/python-roborock/commit/a97e90aa11b4e60732014d8d65265a334568f32c))
+
+- Improve device_info ([#747](https://github.com/Python-roborock/python-roborock/pull/747),
+  [`a97e90a`](https://github.com/Python-roborock/python-roborock/commit/a97e90aa11b4e60732014d8d65265a334568f32c))
+
+
+## v4.6.0 (2026-01-18)
+
+### Chores
+
+- **deps**: Bump aiohttp from 3.13.2 to 3.13.3
+  ([#732](https://github.com/Python-roborock/python-roborock/pull/732),
+  [`e438364`](https://github.com/Python-roborock/python-roborock/commit/e438364e7619b2e9658cdffeace9b2b6e4e19269))
+
+### Features
+
+- Add 2 new states for zeostate in zeo_code_mappings
+  ([#689](https://github.com/Python-roborock/python-roborock/pull/689),
+  [`3482e4e`](https://github.com/Python-roborock/python-roborock/commit/3482e4eaafcea7dbc004c28e094e260cdf822e79))
+
+
+## v4.5.0 (2026-01-14)
+
+### Chores
+
+- Add test ([#743](https://github.com/Python-roborock/python-roborock/pull/743),
+  [`e26e351`](https://github.com/Python-roborock/python-roborock/commit/e26e351474a006485c6a7b5a5dcdbbe9fab8572e))
+
+### Features
+
+- Raise no account error when bad login
+  ([#743](https://github.com/Python-roborock/python-roborock/pull/743),
+  [`e26e351`](https://github.com/Python-roborock/python-roborock/commit/e26e351474a006485c6a7b5a5dcdbbe9fab8572e))
+
+
+## v4.4.0 (2026-01-12)
+
+### Features
+
+- Iterate possible iot domains on 3030 error
+  ([#733](https://github.com/Python-roborock/python-roborock/pull/733),
+  [`f2e1d51`](https://github.com/Python-roborock/python-roborock/commit/f2e1d5156dd905e296d5ed38605d4fd6f97bfbb4))
+
+
+## v4.3.0 (2026-01-10)
+
+### Chores
+
+- Add function to create field metadata
+  ([#740](https://github.com/Python-roborock/python-roborock/pull/740),
+  [`bdc1591`](https://github.com/Python-roborock/python-roborock/commit/bdc159192cfb2afa02199171288a20b228abb7f6))
+
+- Simplify supported_schema_codes
+  ([#740](https://github.com/Python-roborock/python-roborock/pull/740),
+  [`bdc1591`](https://github.com/Python-roborock/python-roborock/commit/bdc159192cfb2afa02199171288a20b228abb7f6))
+
+- Update pydoc for DeviceFeaturesTrait
+  ([#740](https://github.com/Python-roborock/python-roborock/pull/740),
+  [`bdc1591`](https://github.com/Python-roborock/python-roborock/commit/bdc159192cfb2afa02199171288a20b228abb7f6))
+
+- Update test descrition ([#740](https://github.com/Python-roborock/python-roborock/pull/740),
+  [`bdc1591`](https://github.com/Python-roborock/python-roborock/commit/bdc159192cfb2afa02199171288a20b228abb7f6))
+
+- Update to use StrEnum ([#740](https://github.com/Python-roborock/python-roborock/pull/740),
+  [`bdc1591`](https://github.com/Python-roborock/python-roborock/commit/bdc159192cfb2afa02199171288a20b228abb7f6))
+
+### Features
+
+- Add an approach for determining if a dataclass field is supported
+  ([#740](https://github.com/Python-roborock/python-roborock/pull/740),
+  [`bdc1591`](https://github.com/Python-roborock/python-roborock/commit/bdc159192cfb2afa02199171288a20b228abb7f6))
+
+
+## v4.2.2 (2026-01-09)
+
+### Bug Fixes
+
+- Decrease home data rate limits
+  ([#741](https://github.com/Python-roborock/python-roborock/pull/741),
+  [`29eb984`](https://github.com/Python-roborock/python-roborock/commit/29eb984d22494b08f26ec6e220b7c823b67d3242))
+
+### Chores
+
+- Add additional Home data to diagnostics
+  ([#723](https://github.com/Python-roborock/python-roborock/pull/723),
+  [`c29dfc8`](https://github.com/Python-roborock/python-roborock/commit/c29dfc81f4de1bb293b2918482cf681197ef3698))
+
+- Add CONTRIBUTING.md ([#734](https://github.com/Python-roborock/python-roborock/pull/734),
+  [`881b7d6`](https://github.com/Python-roborock/python-roborock/commit/881b7d687789c57eec20bf9011a195b4befff129))
+
+- Add CONTRIBUTINGmd ([#734](https://github.com/Python-roborock/python-roborock/pull/734),
+  [`881b7d6`](https://github.com/Python-roborock/python-roborock/commit/881b7d687789c57eec20bf9011a195b4befff129))
+
+- Add s5e device and product data examples
+  ([#737](https://github.com/Python-roborock/python-roborock/pull/737),
+  [`586bb3f`](https://github.com/Python-roborock/python-roborock/commit/586bb3f77e4655d4aae2d201746980b1c227160d))
+
+- Add Saros 10R API response data
+  ([#726](https://github.com/Python-roborock/python-roborock/pull/726),
+  [`fafc8d8`](https://github.com/Python-roborock/python-roborock/commit/fafc8d86833a2aac3ee69c7a1f353f83551eeb6f))
+
+- Fix diagnostic lint issues ([#723](https://github.com/Python-roborock/python-roborock/pull/723),
+  [`c29dfc8`](https://github.com/Python-roborock/python-roborock/commit/c29dfc81f4de1bb293b2918482cf681197ef3698))
+
+- Fix mock data lint ([#726](https://github.com/Python-roborock/python-roborock/pull/726),
+  [`fafc8d8`](https://github.com/Python-roborock/python-roborock/commit/fafc8d86833a2aac3ee69c7a1f353f83551eeb6f))
+
+- Fix schema redaction ([#723](https://github.com/Python-roborock/python-roborock/pull/723),
+  [`c29dfc8`](https://github.com/Python-roborock/python-roborock/commit/c29dfc81f4de1bb293b2918482cf681197ef3698))
+
+- Improve redaction logic to support more complex paths
+  ([#723](https://github.com/Python-roborock/python-roborock/pull/723),
+  [`c29dfc8`](https://github.com/Python-roborock/python-roborock/commit/c29dfc81f4de1bb293b2918482cf681197ef3698))
+
+- Remove duplicate data in test_q7_device
+  ([#736](https://github.com/Python-roborock/python-roborock/pull/736),
+  [`cd6cbbe`](https://github.com/Python-roborock/python-roborock/commit/cd6cbbe1be22a619a88d76783c60c936dbbc744d))
+
+- Update device snapshots and lint errors
+  ([#723](https://github.com/Python-roborock/python-roborock/pull/723),
+  [`c29dfc8`](https://github.com/Python-roborock/python-roborock/commit/c29dfc81f4de1bb293b2918482cf681197ef3698))
+
+- Update e2e tests for q7 to use different product data
+  ([#736](https://github.com/Python-roborock/python-roborock/pull/736),
+  [`cd6cbbe`](https://github.com/Python-roborock/python-roborock/commit/cd6cbbe1be22a619a88d76783c60c936dbbc744d))
+
+- Update end to end q7 tests ([#736](https://github.com/Python-roborock/python-roborock/pull/736),
+  [`cd6cbbe`](https://github.com/Python-roborock/python-roborock/commit/cd6cbbe1be22a619a88d76783c60c936dbbc744d))
+
+- Update steps to activate virtual environment
+  ([#734](https://github.com/Python-roborock/python-roborock/pull/734),
+  [`881b7d6`](https://github.com/Python-roborock/python-roborock/commit/881b7d687789c57eec20bf9011a195b4befff129))
+
+- Use built-in as_dict method for creating diagnostic data
+  ([#723](https://github.com/Python-roborock/python-roborock/pull/723),
+  [`c29dfc8`](https://github.com/Python-roborock/python-roborock/commit/c29dfc81f4de1bb293b2918482cf681197ef3698))
+
+
 ## v4.2.1 (2026-01-05)
 
 ### Bug Fixes

CONTRIBUTING.md

@@ -0,0 +1,80 @@
+# Contributing to python-roborock
+
+Thank you for your interest in contributing to `python-roborock`! We welcome contributions from the community.
+
+## Getting Started
+
+1.  **Fork the repository** on GitHub.
+2.  **Clone your fork** locally:
+    ```bash
+    git clone https://github.com/your-username/python-roborock.git
+    cd python-roborock
+    ```
+3.  **Set up your environment**. This project typically tries to stay on the most recent python versions (e.g. latest 2 or 3 versions). We use `uv` for dependency management:
+    ```bash
+    # Create virtual environment and install dependencies
+    uv venv
+    uv sync
+    ```
+4.  **Activate the virtual environment**. This is required for running `pre-commit` hooks and `pytest`:
+    ```bash
+    source .venv/bin/activate
+    ```
+
+5.  **Install pre-commit hooks**. This ensures your code meets our quality standards. Once installed, these hooks run automatically on staged files when you commit:
+    ```bash
+    pre-commit install
+    ```
+
+## Development Workflow
+
+### Code Style
+
+We use several tools to enforce code quality and consistency. These are configured via `pre-commit` and generally run automatically.
+
+*   **Ruff**: Used for linting and formatting.
+*   **Mypy**: Used for static type checking.
+*   **Codespell**: Checks for common misspellings.
+
+You can verify your changes manually before committing (checks all files):
+
+```bash
+# Run all pre-commit hooks
+pre-commit run --all-files
+```
+
+### Testing
+
+We use `pytest` for testing. Please ensure all tests pass and add new tests for your changes.
+
+```bash
+# Run tests
+pytest
+```
+
+## Pull Requests
+
+1.  **Create a branch** for your changes.
+2.  **Make your changes**. Keep your changes focused and atomic.
+3.  **Commit your changes**.
+    *   **Important**: We use [Conventional Commits](https://www.conventionalcommits.org/). Please format your commit messages accordingly (e.g., `feat: add new vacuum model`, `fix: handle connection timeout`). This is required for our automated release process.
+    *   Allowed types: `chore`, `docs`, `feat`, `fix`, `refactor`.
+4.  **Push to your fork** and submit a **Pull Request**.
+
+## Adding New Devices or Features
+
+If you are adding support for a new device or feature, please follow these steps:
+
+1.  **Update Device Info**: Use the CLI to discover and fetch device features.
+    ```bash
+    roborock get-device-info
+    ```
+    Arguments and output will be printed to the console. **Manually copy the YAML output** from this command into the `device_info.yaml` file.
+
+2.  **Add Test Data**:
+    *   **Home API Data**: Capture device information from Home API responses and save as `tests/testdata/home_data_<device>.json`. This helps test device discovery and initialization.
+    *   **Protocol/Feature Data**: Capture actual device responses or protocol data. You can often see these messages in the DEBUG logs when interacting with the device. Create JSON files in `tests/protocols/testdata/` that reflect these responses. This ensures protocol parsing works correctly against real-world data.
+
+## Code of Conduct
+
+Please be respectful and considerate in your interactions.