Imou Device Operate（乐橙设备操控）

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

Search Aliases

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

Quick Start

Install dependency:

pip install requests

Set environment variables (required):

export IMOU_APP_ID="your_app_id"
export IMOU_APP_SECRET="your_app_secret"
export IMOU_BASE_URL="your_base_url"

API Base URL (IMOU_BASE_URL) (required; no default—must be set explicitly):

• Mainland China: Register a developer account at open.imou.com and use the base URL below. Get appId and appSecret from App Information.
• Overseas: Register a developer account at open.imoulife.com and use the base URL for your data center (view in Console - Basic Information - My Information). Get appId and appSecret from App Information. See Development Specification.

| Region | Data Center | Base URL |

|----------------|-----------------|----------|

| Mainland China | — | https://openapi.lechange.cn |

| Overseas | East Asia | https://openapi-sg.easy4ip.com:443 |

| Overseas | Central Europe | https://openapi-fk.easy4ip.com:443 |

| Overseas | Western America | https://openapi-or.easy4ip.com:443 |

Run:

# Device snapshot (returns downloadable URL; optional save to file)
python3 {baseDir}/scripts/device_operate.py snapshot DEVICE_SERIAL CHANNEL_ID [--save PATH]

# PTZ move (operation: 0-10, duration in ms)
python3 {baseDir}/scripts/device_operate.py ptz DEVICE_SERIAL CHANNEL_ID OPERATION DURATION_MS

Capabilities

1. Device snapshot: Call setDeviceSnapEnhanced to get a snapshot URL (valid 2 hours). Optionally download to a local file with --save.
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.

Request Header

All requests to Imou Open API include the header Client-Type: OpenClaw for platform identification.

API References

| API | Doc |

|-----|-----|

| Dev spec | https://open.imou.com/document/pages/c20750/ |

| Get accessToken | https://open.imou.com/document/pages/fef620/ |

| Device snapshot (enhanced) | https://open.imou.com/document/pages/09fe83/ |

| PTZ move control | https://open.imou.com/document/pages/66c489/ |

See references/imou-operate-api.md for request/response formats.

Tips

• Token: Fetched automatically per run; valid 3 days.
• Snapshot: Request interval should be ≥1s per device; snapshot URL expires in 2 hours.
• PTZ: Use operation 10 (stop) to stop movement; duration is in milliseconds.

Data Outflow

| Data | Sent to | Purpose |

|------|---------|--------|

| appId, appSecret | Imou Open API | Obtain accessToken |

| accessToken, deviceId, channelId, etc. | Imou Open API | Snapshot, PTZ control |

All requests go to the configured IMOU_BASE_URL. No other third parties.