Scrypted Development

Appearance

Scrypted Documentation / DeviceState

Interface: DeviceState ​

Extended by ​

Properties ​

id ​

id: string

info? ​

optional info: DeviceInformation

interfaces ​

interfaces: string[]

mixins ​

mixins: string[]

name? ​

optional name: string

nativeId? ​

optional nativeId: string

pluginId ​

pluginId: string

providedInterfaces ​

providedInterfaces: string[]

providedName? ​

optional providedName: string

providedRoom? ​

optional providedRoom: string

providedType? ​

optional providedType: string

providerId? ​

optional providerId: string

room? ​

optional room: string

type? ​

optional type: string

scryptedRuntimeArguments? ​

optional scryptedRuntimeArguments: ScryptedRuntimeArguments

on? ​

optional on: boolean

brightness? ​

optional brightness: number

colorTemperature? ​

optional colorTemperature: number

rgb? ​

optional rgb: ColorRgb

hsv? ​

optional hsv: ColorHsv

buttons? ​

optional buttons: string[]

sensors ​

sensors: Record<string, Sensor>

running? ​

optional running: boolean

paused? ​

optional paused: boolean

docked? ​

optional docked: boolean

temperatureSetting? ​

optional temperatureSetting: TemperatureSettingStatus

temperature? ​

optional temperature: number

temperatureUnit? ​

optional temperatureUnit: TemperatureUnit

humidity? ​

optional humidity: number

audioVolumes? ​

optional audioVolumes: AudioVolumes

recordingActive? ​

optional recordingActive: boolean

ptzCapabilities? ​

optional ptzCapabilities: PanTiltZoomCapabilities

lockState? ​

optional lockState: LockState

entryOpen? ​

optional entryOpen: boolean | "jammed"

batteryLevel? ​

optional batteryLevel: number

chargeState? ​

optional chargeState: ChargeState

online? ​

optional online: boolean

fromMimeType? ​

optional fromMimeType: string

toMimeType? ​

optional toMimeType: string

converters? ​

optional converters: MediaConverterTypes[]

binaryState? ​

optional binaryState: boolean

tampered? ​

optional tampered: TamperState

sleeping? ​

optional sleeping: boolean

powerDetected? ​

optional powerDetected: boolean

audioDetected? ​

optional audioDetected: boolean

motionDetected? ​

optional motionDetected: boolean

ambientLight? ​

optional ambientLight: number

occupied? ​

optional occupied: boolean

flooded? ​

optional flooded: boolean

ultraviolet? ​

optional ultraviolet: number

luminance? ​

optional luminance: number

position? ​

optional position: Position

securitySystemState? ​

optional securitySystemState: SecuritySystemState

pm10Density? ​

optional pm10Density: number

pm25Density? ​

optional pm25Density: number

vocDensity? ​

optional vocDensity: number

noxDensity? ​

optional noxDensity: number

co2ppm? ​

optional co2ppm: number

airQuality? ​

optional airQuality: AirQuality

airPurifierState? ​

optional airPurifierState: AirPurifierState

filterChangeIndication? ​

optional filterChangeIndication: boolean

filterLifeLevel? ​

optional filterLifeLevel: number

humiditySetting? ​

optional humiditySetting: HumiditySettingStatus

fan? ​

optional fan: FanStatus

applicationInfo? ​

optional applicationInfo: LauncherApplicationInfo

systemDevice? ​

optional systemDevice: ScryptedSystemDeviceInfo