Types Reference

The enums and small value types the service pages take for granted. Raw values are the strings the backend sends and expects; where an enum has a fromValue(...) companion, use it to map a string from a model.

Products and devices

Type	Values (raw)
`DeviceProductType` / `SubscriptionProductType`	`HOME_SECURITY` (`HomeSecurity`), `BABY` (`Baby`), `PET` (`Pet`), `BIRD` (`Bird`), `TRAIL` (`Trail`)
`DeviceType`	`Indoor`, `Outdoor`, `DOORBELL` (`Doorbell`), `NVR`, `BIRD` (`Bird`)
`DeviceStatus`	`ONLINE` (`Online`), `OFFLINE` (`Offline`), `SLEEP` (`Sleep`), `ERROR` (`Error`), `UNINITIALIZED` (`UnInitialized`)
`PairingStatus`	`INITIALIZED` (`Initialized`), `PROCESSED` (`Processed`), `PAIRED` (`Paired`), `ACTIVATED` (`Activated`) — the raw value is the `type` property
`PowerSource`	`Battery`, `AC`, `ACAndBattery` (`ACnBattery`)
`WakeUpReason`	`LiveViewStart`, `ChangeSettings`, `OtaUpdate`
`SDCardStatus`	`Found`, `Normal`, `Formatting`, `NotFound`
`FirmwareUpdateStatus`	`NOT_INITIALIZED` (`NotInitialized`, 0), `MESSAGE_SENT` (`MessageSent`, 0.1), `INITIALIZED` (0.2), `DOWNLOADING` (0.3), `DOWNLOADED` (0.4), `VERIFIED` (0.6), `FLASHING` (0.6), `SUCCESS` (0.8), `REBOOT` (0.9), `COMPLETE` (1.0), `ERROR` (0) — the second value is the progress fraction; `COMPLETE` is the terminal state, not `SUCCESS`
`RotationAngle`	`Angle0` (0), `Angle180` (180)
`Bitrate`	`Auto`, `HD`

Device.modelProductType, deviceType, pairingStatus and powerSource are String; map them with the enums above. device.supportsCluster() (true when clusterVersion != "v0") says whether the camera uses clusters.

Camera settings

Type	Values
`LightMode` (spotlight) / `FloodLightMode`	`Intel`, `IR`, `CLR`, `Off`
`GuideLightMode`	`Intel`, `Off`, `CLR`
`NightVisionMode`	`Auto` (0), `On` (1), `Off` (2)
`ChimeModes`	`MECHANICAL` (`Mechanical`), `ELECTRONIC` (`Electronic`), `DEFAULT` (`Default`)
`DetectionSensitivity` / `MotionSensorSensitivity` / `Cooldown`	`Low` (0), `Medium` (1), `High` (2)
`MoveValue` (PTZ)	`LEFT` (-1), `RIGHT` (1), `UP` (1), `DOWN` (-1), `NONE` (0)
`EmbargoMode`	`Hunting`, `Embargo`
`TemperatureUnit`	`CELSIUS` (`C`), `FAHRENHEIT` (`F`)
`StreamType`	`MAINSTREAM`, `SUBSTREAM`

Events

Type	Values (raw)
`EventTag`	`MOTION` (`Motion`), `PERSON` (`Person`), `VEHICLE` (`Vehicle`), `ANIMAL` (`Animal`), `ALARM` (`Alarm`), `DOORBELL` (`DoorbellPress`), `CALL` (`Call`), `FACE` (`Face`), `BIRD` (`Bird`), `PET` (`Pet`), `WILDLIFE` (`Wildlife`), `CRY` (`Cry`), `HIGH_TEMPERATURE` (`HighTemperature`) / `LOW_TEMPERATURE` (`LowTemperature`) (group `Temperature`), `HIGH_HUMIDITY` (`HighHumidity`) / `LOW_HUMIDITY` (`LowHumidity`) (group `Humidity`)
`EventType`	`DOORBELL` (`Doorbell`), `SNAPSHOT` (`Snapshot`), `MOTION` (`Motion`), `ENHANCED_MOTION` (`EnhancedMotion`), `ENHANCED_SECURITY` (`EnhancedSecurity`), `MOTION_AND_ENHANCED_MOTION` (`MotionAndEnhancedMotion`), `BIRD` (`Bird`), `PET` (`Pet`), `CALL` (`Call`), `TRAIL` (`Trail`), `BABY` (`Baby`)
`SpeciesType`	`Parent`, `Child`
`RealtimeEventType`	`LullabyStateUpdated`
`RealtimeDeliveryType`	`Transient`, `Persistent`
`RealtimeConnectionState`	`Initialized`, `Connecting`, `Connected`, `Disconnected`, `Suspended`, `Closing`, `Closed`, `Failed`

Which tags a product line raises is listed on Events.

Streaming

Type	Values
`StreamStatus` (sealed)	`CONNECTING`, `STARTED`, `FAILED(message)`, `AUTO_DISCONNECT` — published as `client.status`
`CallState`	`Disconnected`, `Calling`, `Accepted`, `OnCall`, `Missed` — helpers `isCalling()`, `isAccepted()`, `isDisconnected()`, `atleast(state)`
`PlaybackEvent`	`start`, `end` (`Long`) — the items of `SDCardPlaybackClient.timeLine`

Subscriptions

Type	Values (raw)
`SubscriptionScope`	`Product`, `Space`
`SkuCategory`	`AI`, `Combo`, `Data`
`SubscriptionType`	`PREVIEW` (`Preview`), `TRIAL` (`Trial`), `PAID` (`Paid`)
`SubscriptionStatus`	`ACTIVE` (`Active`), `CANCELLED` (`Cancelled`)
`SubscriptionOverdueStatus`	`GRACE` (`Grace`), `TRAIL_OVER_DUE` (`TrialOverdue`)
`DataPassPurchaseType`	`Recurring`, `ManualTopUp`, `AutoTopUp`
`SessionType` (pairing)	`FOUR_G` (`4g`), `OTHER` (`""`)

Monitoring, faces, babies, pets

Type	Values (raw)
`SecurityScheduleType`	`ARM` (`Arm`), `DISARM` (`Disarm`)
`WeekDay`	`SUNDAY` (1) … `SATURDAY` (7)
`FaceAngles`	`CENTER`, `LEFT`, `RIGHT`, `TOP_LEFT`, `TOP_RIGHT`, `BOTTOM_LEFT`, `BOTTOM_RIGHT`
`FaceStatus`	`Created`, `ImagesUploading`, `ImagesUploaded`, `EmbeddingGenerated`, `EmbeddingGenerationFailed`
`BabyActivityType`	`Feeding`, `Formula`, `Diaper`
`FeedingSide`	`Left`, `Right`, `Both`
`DiaperChangeType`	`Wet`, `Dirty`, `Mixed`
`Gender`	`Boy`, `Girl`, `PreferNotToSay`
`HeightUnit` / `WeightUnit`	`INCH`, `CM` / `LBS`, `KG`
`PlaybackMode` (lullaby)	`PlayAll`, `Loop`
`PlaybackState` (lullaby)	`Playing`, `Paused`, `Stopped`
`PetSpecies`	`CAT` (`Cat`), `DOG` (`Dog`)
`PetActivities`	`Walking`, `Eating`, `Littering`, `Resting` (`Sleeping` is deprecated — use `Resting`)
`LoginType`	`UNKNOWN`, `EMAIL`, `GOOGLE`, `APPLE`