\r \r

Imou Device Operate（乐橙设备操控）\r

\r Control Imou cloud devices: PTZ (pan-tilt-zoom) movement, device snapshot capture, and download snapshot image by URL.\r \r

Search Aliases\r

\r

• imou\r
• Imou\r
• 乐橙\r
• lechange\r
• easy4ip\r
• imou-device-operate\r
• 乐橙设备\r
• 乐橙云台\r
• 乐橙抓图\r
• 乐橙摄像头\r \r

Quick Start\r

\r Install dependency:\r

pip install requests\r
```\r
\r
Set environment variables (required):\r
```bash\r
export IMOU_APP_ID="your_app_id"\r
export IMOU_APP_SECRET="your_app_secret"\r
export IMOU_BASE_URL="your_base_url"\r
```\r
\r
**API Base URL (IMOU_BASE_URL)** (required; no default—must be set explicitly):\r
- **Mainland China**: Register a developer account at [open.imou.com](https://open.imou.com) and use the base URL below. Get `appId` and `appSecret` from [App Information](https://open.imou.com/consoleNew/myApp/appInfo).\r
- **Overseas**: Register a developer account at [open.imoulife.com](https://open.imoulife.com) and use the base URL for your data center (view in [Console - Basic Information - My Information](https://open.imoulife.com/consoleNew/basicInfo/myInfo)). Get `appId` and `appSecret` from [App Information](https://open.imoulife.com/consoleNew/myApp/appInfo). See [Development Specification](https://open.imoulife.com/book/http/develop.html).\r
\r
| Region         | Data Center     | Base URL |\r
|----------------|-----------------|----------|\r
| Mainland China | —               | `https://openapi.lechange.cn` |\r
| Overseas       | East Asia       | `https://openapi-sg.easy4ip.com:443` |\r
| Overseas       | Central Europe  | `https://openapi-fk.easy4ip.com:443` |\r
| Overseas       | Western America | `https://openapi-or.easy4ip.com:443` |\r
\r
Run:\r
```bash\r
# Device snapshot (returns downloadable URL; optional save to file)\r
python3 {baseDir}/scripts/device_operate.py snapshot DEVICE_SERIAL CHANNEL_ID [--save PATH]\r
\r
# PTZ move (operation: 0-10, duration in ms)\r
python3 {baseDir}/scripts/device_operate.py ptz DEVICE_SERIAL CHANNEL_ID OPERATION DURATION_MS\r
```\r
\r
## Capabilities\r
\r
1. **Device snapshot**: Call setDeviceSnapEnhanced to get a snapshot URL (valid 2 hours). Optionally download to a local file with `--save`.\r
2. **PTZ control**: controlMovePTZ with operation (0=up, 1=down, 2=left, 3=right, 4=up-left, 5=down-left, 6=up-right, 7=down-right, 8=zoom in, 9=zoom out, 10=stop) and duration in milliseconds. Device must support PT/PTZ.\r
\r
## Request Header\r
\r
All requests to Imou Open API include the header `Client-Type: OpenClaw` for platform identification.\r
\r
## API References\r
\r
| API | Doc |\r
|-----|-----|\r
| Dev spec | https://open.imou.com/document/pages/c20750/ |\r
| Get accessToken | https://open.imou.com/document/pages/fef620/ |\r
| Device snapshot (enhanced) | https://open.imou.com/document/pages/09fe83/ |\r
| PTZ move control | https://open.imou.com/document/pages/66c489/ |\r
\r
See `references/imou-operate-api.md` for request/response formats.\r
\r
## Tips\r
\r
- **Token**: Fetched automatically per run; valid 3 days.\r
- **Snapshot**: Request interval should be ≥1s per device; snapshot URL expires in 2 hours.\r
- **PTZ**: Use operation 10 (stop) to stop movement; duration is in milliseconds.\r
\r
## Data Outflow\r
\r
| Data | Sent to | Purpose |\r
|------|---------|--------|\r
| appId, appSecret | Imou Open API | Obtain accessToken |\r
| accessToken, deviceId, channelId, etc. | Imou Open API | Snapshot, PTZ control |\r
\r
All requests go to the configured `IMOU_BASE_URL`. No other third parties.\r