Docs
Documentation
Use these docs when you need to connect the device, understand the lights, sign in, activate service rights, or update firmware. Start with the station-internal guide for your task, then use GitHub only for source code and advanced development history.
文档
站内文档
连接设备、理解灯光、登录、激活服务权益或更新固件时,从这里进入对应站内指南。普通用户优先阅读本站文档;GitHub 只作为源码和高级开发历史入口。
Recommended reading path
Recommended reading path
Start with the physical device, then move through the desktop app, agent hooks, activation, and firmware service only when you need those capabilities.
-
1
Hardware first
Confirm what the kit includes before connecting power.
-
2
Connect and test
Use USB and Devices Test before trusting status lights.
-
3
Install the desktop app
Let the app own local state, device verification, and firmware workflows.
-
4
Configure agent hooks
Translate local agent workflow events into light states.
-
5
Activate services
Sign in, redeem an activation code, and bind the device only for official service rights.
-
6
Official firmware service
Use the desktop app service path for metadata, manifest checks, and short-lived tokens.
Find the task you need
Check the device parts and compare your hardware before plugging it in.
Connect and run Devices TestFollow the USB, device selection, and first verification path.
Configure agent hooksConnect agent workflow events to the local desktop runtime.
Activate official service rightsUse an account, activation code, and bound device for official services.
Update firmware through the appUnderstand why firmware image and manifest downloads stay behind the official service path.
The light does not reactStart with USB, power, serial visibility, and Devices Test before changing hooks or firmware.
Hardware guide for USB setup, ESP32-WROOM-32 device checks, red / yellow / green status semantics, and Devices Test.
- Device composition, USB connection, and first test path.
- Troubleshooting for power, serial visibility, lights, and state updates.
Desktop app workflow for downloads, agent hooks, local runtime behavior, setup path, and status semantics.
- Connect the local device and configure agent hooks.
- Understand local-first privacy and status meanings.
Activation guide for email password login, GitHub OAuth, activation code redemption, device binding, and service rights.
- Account creation, verified email, and GitHub account binding.
- Activation code, device binding, and support boundaries.
Firmware guide for firmware image, merged bin, manifest, entitlement-checked metadata, and official update service limits.
- Official firmware files are delivered through the desktop app service path.
- No public stable firmware image or manifest download buttons.
Use GitHub for source code and release history; ordinary product documentation is available on this site.
- Source code, releases, and advanced development notes.
- Not the primary manual for ordinary users.
masiqi/agent-status-light
推荐阅读路径
推荐阅读路径
先从物理设备开始,再进入桌面 app、agent hooks、激活和固件服务;只有需要对应能力时再阅读后面的服务文档。
-
1
先看硬件
连接电源前,先确认套件里应该有哪些部件。
-
2
连接和测试
先用 USB 和 Devices Test 验证设备,再相信灯光状态。
-
3
安装桌面 app
让 app 负责本地状态、设备验证和固件流程。
-
4
配置 agent hooks
把本地 agent 工作流事件转换为状态灯变化。
-
5
激活服务权益
只有官方服务权益需要账号、激活码和设备绑定。
-
6
官方固件更新服务
通过桌面 app 服务路径获取 metadata、manifest 校验和短期 token。
快速找到你要做的事
硬件指南覆盖 USB 设置、ESP32-WROOM-32 设备检查、红 / 黄 / 绿状态语义和 Devices Test。
- 设备组成、USB 连接和首次测试路径。
- 处理供电、串口不可见、灯不亮和状态不更新。
桌面 app 工作流覆盖下载、agent hooks、本地 runtime、设置路径和状态语义。
- 连接本地设备并配置 agent hooks。
- 理解本地优先隐私边界和状态含义。
激活指南覆盖邮箱密码登录、GitHub OAuth、激活码兑换、设备绑定和服务权益。
- 账号创建、邮箱验证和 GitHub 账号绑定。
- 激活码、设备绑定和支持边界。
固件指南覆盖固件文件、merged bin、manifest、权益校验 metadata 和官方更新服务边界。
- 官方固件文件通过桌面 app 服务路径交付。
- 普通页面不提供稳定固件文件或 manifest 下载按钮。
GitHub 用于源码和发布历史;普通产品文档在本站承载。
- 源码、release 和高级开发记录。
- 不是普通用户的主要操作手册。
masiqi/agent-status-light