pca9685-debugging-panel 0.1.0__tar.gz

pca9685_debugging_panel-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # required for OIDC trusted publishing
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        run: uv publish

pca9685_debugging_panel-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# AI Agent
+plan.md
+
+# Hardware-sepecific configurations
+config.json
+
+# Local-only uv configuration
+uv.toml

pca9685_debugging_panel-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

pca9685_debugging_panel-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Yunkai Li
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pca9685_debugging_panel-0.1.0/PKG-INFO

@@ -0,0 +1,201 @@
+Metadata-Version: 2.4
+Name: pca9685-debugging-panel
+Version: 0.1.0
+Summary: Web-based remote control panel for debugging PCA9685 servo drivers on robots.
+Project-URL: Repository, https://github.com/xiaokai-lyk/PCA9685-debugging-panel
+Project-URL: Issues, https://github.com/xiaokai-lyk/PCA9685-debugging-panel/issues
+Author: Yunkai Li
+License: Apache-2.0
+License-File: LICENSE
+Keywords: adafruit-blinka,debugging,fastapi,i2c,pca9685,pwm,robot,servo,web-panel
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: Chinese (Simplified)
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: System :: Hardware :: Hardware Drivers
+Requires-Python: >=3.10
+Requires-Dist: adafruit-blinka>=9.1.0
+Requires-Dist: adafruit-circuitpython-servokit>=1.3.24
+Requires-Dist: fastapi>=0.136.3
+Requires-Dist: pydantic>=2.0
+Requires-Dist: uvicorn[standard]>=0.48.0
+Description-Content-Type: text/markdown
+
+# PCA9685 Debug Panel
+
+> Web-based remote control panel for debugging PCA9685 servo drivers on robots.
+
+> **⚠️ Security Notice:** This tool exposes a web server with **no authentication**. Only run it on a trusted local network (e.g., your robot's Wi‑Fi). Do **not** expose it to the public internet.
+
+[![Python](https://img.shields.io/badge/python-%3E%3D3.10-blue)](https://python.org)
+[![FastAPI](https://img.shields.io/badge/fastapi-0.136%2B-009688)](https://fastapi.tiangolo.com)
+
+[中文文档](README.zh_cn.md)
+
+## Description
+
+A lightweight web panel (similar to FTC Dashboard) that runs on your robot and lets you control PCA9685-driven servos from any browser over Wi‑Fi. Supports per-channel angle control with calibration, live device status monitoring, and workspace save/load — so you can tune and debug servos without touching code.
+
+**Why?** Adjusting servo angles on a robot usually means SSH + manual scripts. This panel gives you a visual UI in the browser with sliders, real-time feedback, and configuration persistence across restarts.
+
+## Installing / Getting started
+
+### Prerequisites
+
+- Python 3.10+
+- A Raspberry Pi (or similar) with I²C enabled and connected to PCA9685, **or** any machine for UI-only development (mock mode)
+
+### Quick setup
+
+#### Using Pip
+```shell
+# Install from PyPI
+pip install pca9685-debugging-panel
+
+# Start the server
+pca9685-panel --host 0.0.0.0 --port 8080
+```
+
+Then open `http://<robot-ip>:8080` in your browser.
+
+#### From source
+
+```shell
+git clone https://github.com/xiaokai-lyk/PCA9685-debugging-panel.git
+cd PCA9685-debugging-panel
+uv sync
+python main.py
+```
+
+On first launch a `config.json` file is created automatically with default values (I²C address `0x40`, 50 Hz, 600–2400 µs pulse range).
+
+### Running on a desktop (no hardware)
+
+Use the `--mock` flag to skip hardware initialisation entirely — all APIs work, the UI is fully interactive, and no real hardware is required for frontend development:
+
+```shell
+pca9685-panel --mock
+```
+
+## Developing
+
+### Project structure
+
+```
+PCA9685-debugging-panel/
+├── backend/
+│   ├── app.py              # FastAPI entry point (REST + SSE)
+│   ├── pca9685.py          # PCA9685 driver (real hardware + optional mock mode)
+│   ├── config_store.py     # JSON configuration persistence
+│   └── schemas.py          # Pydantic request/response models
+├── frontend/
+│   ├── index.html          # Single-page UI
+│   ├── app.js              # SSE connection, REST calls, state management
+│   └── styles.css          # Dark theme, responsive grid
+├── config.json             # Auto-generated runtime configuration
+├── main.py                 # Convenience launcher
+├── plan.md                 # Architecture & design decisions
+└── pyproject.toml          # Project metadata & dependencies
+```
+
+### API overview
+
+| Method   | Path                         | Description                                                    |
+| -------- | ---------------------------- | -------------------------------------------------------------- |
+| `GET`  | `/api/status`              | Device status, frequency, I²C address                         |
+| `GET`  | `/api/servo/channels`      | All 16 channel states                                          |
+| `POST` | `/api/servo/set`           | Set angle (`{channel, angle}`) or duty (`{channel, duty}`) |
+| `POST` | `/api/servo/name`          | Rename a channel `{channel, name}`                           |
+| `POST` | `/api/servo/calibrate`     | Set angle ↔ pulse calibration                                 |
+| `POST` | `/api/pca9685/frequency`   | Set PWM frequency `{frequency_hz}`                           |
+| `POST` | `/api/pca9685/pulse_range` | Set default pulse range                                        |
+| `GET`  | `/api/workspace/export`    | Download full configuration as JSON                            |
+| `POST` | `/api/workspace/import`    | Upload & apply a workspace JSON                                |
+| `GET`  | `/api/events`              | SSE stream for device status pushes                            |
+
+Interactive docs available at `http://<host>:8080/docs` (Swagger UI).
+
+## Features
+
+- **16-channel servo grid** — angle slider / duty-cycle slider per channel, with live pulse-width display
+- **Per-channel calibration** — map your own angle‑to‑pulse ranges for each servo
+- **Real-time status** — device online/offline indicator with heartbeat via SSE
+- **Frequency control** — adjustable 40–400 Hz PWM frequency
+- **Workspace save/load** — export the full configuration (calibration, names, settings) as a JSON file; import it later or on a different robot
+- **Restart persistence** — `config.json` survives reboots so your last setup is restored automatically
+- **Mock mode** — run with `--mock` flag for UI development & testing without hardware
+- **Dark theme** — responsive layout, works on desktop and mobile browsers
+
+## Configuration
+
+### config.json (auto-managed)
+
+| Key              | Type       | Default       | Description                                    |
+| ---------------- | ---------- | ------------- | ---------------------------------------------- |
+| `i2c_address`  | `int`    | `64` (0x40) | I²C address of the PCA9685                    |
+| `frequency_hz` | `float`  | `50.0`      | PWM frequency (40–400 Hz)                     |
+| `min_pulse_us` | `float`  | `600.0`     | Default minimum pulse width in µs             |
+| `max_pulse_us` | `float`  | `2400.0`    | Default maximum pulse width in µs             |
+| `channels`     | `object` | `{}`        | Per-channel calibration, name, and last output |
+
+This file is written automatically when settings change — no manual editing needed.
+
+### Workspace file (user-managed)
+
+Exported via the UI or `GET /api/workspace/export`. Contains the same fields plus full per-channel data (calibration, names, current positions). Can be imported on another machine to replicate a setup.
+
+## Troubleshooting
+
+### Device stays offline — "Hardware init failed: No module named 'RPi'" 
+
+This may happen when you are **NOT** using Raspberry Pi OS.
+
+The Adafruit Blinka library cannot find the GPIO driver for your Raspberry Pi.
+
+```shell
+# Recommended
+pip install rpi-lgpio
+
+# For older OS (not recommended, may involve the compilation of C extensions)
+pip install RPi.GPIO
+```
+
+### Offline — Hardware init faile2d: No I2C device at address: 0x40
+
+Your PCA9685 might be at a different address. Scan the bus:
+
+```shell
+sudo apt-get install i2c-tools
+i2cdetect -y 1
+```
+If it's all `--` in the result, please check if the device connection is correct. Make sure the connection is correct and then re-scan.
+
+Then update the address in `config.json` or via the Settings modal in the UI.
+
+## Contributing
+
+If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome.
+
+For major changes, open an issue first to discuss what you would like to change.
+
+## Links
+
+- Repository: [https://github.com/xiaokai-lyk/PCA9685-debugging-panel](https://github.com/xiaokai-lyk/PCA9685-debugging-panel)
+- Issue tracker: [https://github.com/xiaokai-lyk/PCA9685-debugging-panel/issues](https://github.com/xiaokai-lyk/PCA9685-debugging-panel/issues)
+- Related projects:
+  - [Adafruit CircuitPython PCA9685](https://github.com/adafruit/Adafruit_CircuitPython_PCA9685)
+  - [FTC Dashboard](https://github.com/acmerobotics/ftc-dashboard)
+
+## Licensing
+
+The code in this project is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).

pca9685_debugging_panel-0.1.0/README.md

@@ -0,0 +1,168 @@
+# PCA9685 Debug Panel
+
+> Web-based remote control panel for debugging PCA9685 servo drivers on robots.
+
+> **⚠️ Security Notice:** This tool exposes a web server with **no authentication**. Only run it on a trusted local network (e.g., your robot's Wi‑Fi). Do **not** expose it to the public internet.
+
+[![Python](https://img.shields.io/badge/python-%3E%3D3.10-blue)](https://python.org)
+[![FastAPI](https://img.shields.io/badge/fastapi-0.136%2B-009688)](https://fastapi.tiangolo.com)
+
+[中文文档](README.zh_cn.md)
+
+## Description
+
+A lightweight web panel (similar to FTC Dashboard) that runs on your robot and lets you control PCA9685-driven servos from any browser over Wi‑Fi. Supports per-channel angle control with calibration, live device status monitoring, and workspace save/load — so you can tune and debug servos without touching code.
+
+**Why?** Adjusting servo angles on a robot usually means SSH + manual scripts. This panel gives you a visual UI in the browser with sliders, real-time feedback, and configuration persistence across restarts.
+
+## Installing / Getting started
+
+### Prerequisites
+
+- Python 3.10+
+- A Raspberry Pi (or similar) with I²C enabled and connected to PCA9685, **or** any machine for UI-only development (mock mode)
+
+### Quick setup
+
+#### Using Pip
+```shell
+# Install from PyPI
+pip install pca9685-debugging-panel
+
+# Start the server
+pca9685-panel --host 0.0.0.0 --port 8080
+```
+
+Then open `http://<robot-ip>:8080` in your browser.
+
+#### From source
+
+```shell
+git clone https://github.com/xiaokai-lyk/PCA9685-debugging-panel.git
+cd PCA9685-debugging-panel
+uv sync
+python main.py
+```
+
+On first launch a `config.json` file is created automatically with default values (I²C address `0x40`, 50 Hz, 600–2400 µs pulse range).
+
+### Running on a desktop (no hardware)
+
+Use the `--mock` flag to skip hardware initialisation entirely — all APIs work, the UI is fully interactive, and no real hardware is required for frontend development:
+
+```shell
+pca9685-panel --mock
+```
+
+## Developing
+
+### Project structure
+
+```
+PCA9685-debugging-panel/
+├── backend/
+│   ├── app.py              # FastAPI entry point (REST + SSE)
+│   ├── pca9685.py          # PCA9685 driver (real hardware + optional mock mode)
+│   ├── config_store.py     # JSON configuration persistence
+│   └── schemas.py          # Pydantic request/response models
+├── frontend/
+│   ├── index.html          # Single-page UI
+│   ├── app.js              # SSE connection, REST calls, state management
+│   └── styles.css          # Dark theme, responsive grid
+├── config.json             # Auto-generated runtime configuration
+├── main.py                 # Convenience launcher
+├── plan.md                 # Architecture & design decisions
+└── pyproject.toml          # Project metadata & dependencies
+```
+
+### API overview
+
+| Method   | Path                         | Description                                                    |
+| -------- | ---------------------------- | -------------------------------------------------------------- |
+| `GET`  | `/api/status`              | Device status, frequency, I²C address                         |
+| `GET`  | `/api/servo/channels`      | All 16 channel states                                          |
+| `POST` | `/api/servo/set`           | Set angle (`{channel, angle}`) or duty (`{channel, duty}`) |
+| `POST` | `/api/servo/name`          | Rename a channel `{channel, name}`                           |
+| `POST` | `/api/servo/calibrate`     | Set angle ↔ pulse calibration                                 |
+| `POST` | `/api/pca9685/frequency`   | Set PWM frequency `{frequency_hz}`                           |
+| `POST` | `/api/pca9685/pulse_range` | Set default pulse range                                        |
+| `GET`  | `/api/workspace/export`    | Download full configuration as JSON                            |
+| `POST` | `/api/workspace/import`    | Upload & apply a workspace JSON                                |
+| `GET`  | `/api/events`              | SSE stream for device status pushes                            |
+
+Interactive docs available at `http://<host>:8080/docs` (Swagger UI).
+
+## Features
+
+- **16-channel servo grid** — angle slider / duty-cycle slider per channel, with live pulse-width display
+- **Per-channel calibration** — map your own angle‑to‑pulse ranges for each servo
+- **Real-time status** — device online/offline indicator with heartbeat via SSE
+- **Frequency control** — adjustable 40–400 Hz PWM frequency
+- **Workspace save/load** — export the full configuration (calibration, names, settings) as a JSON file; import it later or on a different robot
+- **Restart persistence** — `config.json` survives reboots so your last setup is restored automatically
+- **Mock mode** — run with `--mock` flag for UI development & testing without hardware
+- **Dark theme** — responsive layout, works on desktop and mobile browsers
+
+## Configuration
+
+### config.json (auto-managed)
+
+| Key              | Type       | Default       | Description                                    |
+| ---------------- | ---------- | ------------- | ---------------------------------------------- |
+| `i2c_address`  | `int`    | `64` (0x40) | I²C address of the PCA9685                    |
+| `frequency_hz` | `float`  | `50.0`      | PWM frequency (40–400 Hz)                     |
+| `min_pulse_us` | `float`  | `600.0`     | Default minimum pulse width in µs             |
+| `max_pulse_us` | `float`  | `2400.0`    | Default maximum pulse width in µs             |
+| `channels`     | `object` | `{}`        | Per-channel calibration, name, and last output |
+
+This file is written automatically when settings change — no manual editing needed.
+
+### Workspace file (user-managed)
+
+Exported via the UI or `GET /api/workspace/export`. Contains the same fields plus full per-channel data (calibration, names, current positions). Can be imported on another machine to replicate a setup.
+
+## Troubleshooting
+
+### Device stays offline — "Hardware init failed: No module named 'RPi'" 
+
+This may happen when you are **NOT** using Raspberry Pi OS.
+
+The Adafruit Blinka library cannot find the GPIO driver for your Raspberry Pi.
+
+```shell
+# Recommended
+pip install rpi-lgpio
+
+# For older OS (not recommended, may involve the compilation of C extensions)
+pip install RPi.GPIO
+```
+
+### Offline — Hardware init faile2d: No I2C device at address: 0x40
+
+Your PCA9685 might be at a different address. Scan the bus:
+
+```shell
+sudo apt-get install i2c-tools
+i2cdetect -y 1
+```
+If it's all `--` in the result, please check if the device connection is correct. Make sure the connection is correct and then re-scan.
+
+Then update the address in `config.json` or via the Settings modal in the UI.
+
+## Contributing
+
+If you'd like to contribute, please fork the repository and use a feature branch. Pull requests are welcome.
+
+For major changes, open an issue first to discuss what you would like to change.
+
+## Links
+
+- Repository: [https://github.com/xiaokai-lyk/PCA9685-debugging-panel](https://github.com/xiaokai-lyk/PCA9685-debugging-panel)
+- Issue tracker: [https://github.com/xiaokai-lyk/PCA9685-debugging-panel/issues](https://github.com/xiaokai-lyk/PCA9685-debugging-panel/issues)
+- Related projects:
+  - [Adafruit CircuitPython PCA9685](https://github.com/adafruit/Adafruit_CircuitPython_PCA9685)
+  - [FTC Dashboard](https://github.com/acmerobotics/ftc-dashboard)
+
+## Licensing
+
+The code in this project is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).