Cameras
Reading and controlling an individual camera: settings, clusters, firmware, PTZ, SD card, two-way calling.
Calls on a single camera are addressed by spaceId and deviceId; list calls take spaceId only.
Two settings models
Cameras expose their settings in one of two ways, and which one applies depends on the model:
- Flat settings —
getDeviceSettings/updateDeviceSettings, with a fixed field per feature. - Clusters — a capability-driven model where the camera advertises clusters and each cluster advertises attributes. Newer features appear here first, without an SDK update.
A camera is cluster-based when DeviceModel.clusters is non-empty (see also clusterGroupVersion). Check that before writing a setting; for a cluster-based camera the cluster APIs are the ones that take effect.
The wakeup parameter
Battery cameras sleep between events. Pass wakeup: true and the SDK first reads the camera’s state; if it is Sleep it sends a wake-up and polls the device every 3 seconds until it is awake, then sends your request — slower, but the camera receives the change now. Pass false to send the request straight away and let the camera pick the change up when it next checks in.
In this section
| Page | Covers |
|---|---|
| Device Retrieval and Information | Listing cameras, model capabilities |
| Device Configuration and Update | Name, flat settings, light mode, two-way call records |
| Device Cloud Settings | Cloud AI detections and notification flags |
| Device Settings | Reading current settings |
| Device Clusters | The cluster-based settings model |
| PTZ, Wake-up and Bitrate | Moving the camera, waking a battery camera, stream quality |
| Firmware Management | Checking, starting and tracking an upgrade |
| Device Maintenance | SD card formatting, OTA schedule, deleting a camera |
Product-specific features
Features that only one product line has are documented with that product, even when the call lives on Factory.deviceService:
| Feature | Product page |
|---|---|
| Manual siren, alarm light, flood light, activity zones | Home Security → Alarm & Deterrence |
| Chime | Home Security → Doorbell |
| Lullaby player | Baby → Lullaby |
| Cry detection, temperature and humidity alerts, night lamp | Baby → Nursery Monitoring |
| Hunting / embargo mode, GPS, timelapse, cellular | Trail |
Pairing session keys are covered with Pairing a Camera.