Scrypted Documentation / WritableDeviceState

Interface: WritableDeviceState

Extends

• DeviceState

Properties

id

id: string

Inherited from

DeviceState.id

---

info?

optional info: DeviceInformation

Inherited from

DeviceState.info

---

interfaces

interfaces: string[]

Inherited from

DeviceState.interfaces

---

mixins

mixins: string[]

Inherited from

DeviceState.mixins

---

name?

optional name: string

Inherited from

DeviceState.name

---

nativeId?

optional nativeId: string

Inherited from

DeviceState.nativeId

---

pluginId

pluginId: string

Inherited from

DeviceState.pluginId

---

providedInterfaces

providedInterfaces: string[]

Inherited from

DeviceState.providedInterfaces

---

providedName?

optional providedName: string

Inherited from

DeviceState.providedName

---

providedRoom?

optional providedRoom: string

Inherited from

DeviceState.providedRoom

---

providedType?

optional providedType: string

Inherited from

DeviceState.providedType

---

providerId?

optional providerId: string

Inherited from

DeviceState.providerId

---

room?

optional room: string

Inherited from

DeviceState.room

---

type?

optional type: string

Inherited from

DeviceState.type

---

scryptedRuntimeArguments?

optional scryptedRuntimeArguments: ScryptedRuntimeArguments

Inherited from

DeviceState.scryptedRuntimeArguments

---

on?

optional on: boolean

Inherited from

DeviceState.on

---

brightness?

optional brightness: number

Inherited from

DeviceState.brightness

---

colorTemperature?

optional colorTemperature: number

Inherited from

DeviceState.colorTemperature

---

rgb?

optional rgb: ColorRgb

Inherited from

DeviceState.rgb

---

hsv?

optional hsv: ColorHsv

Inherited from

DeviceState.hsv

---

buttons?

optional buttons: string[]

Inherited from

DeviceState.buttons

---

sensors

sensors: Record<string, Sensor>

Inherited from

DeviceState.sensors

---

running?

optional running: boolean

Inherited from

DeviceState.running

---

paused?

optional paused: boolean

Inherited from

DeviceState.paused

---

docked?

optional docked: boolean

Inherited from

DeviceState.docked

---

temperatureSetting?

optional temperatureSetting: TemperatureSettingStatus

Inherited from

DeviceState.temperatureSetting

---

temperature?

optional temperature: number

Inherited from

DeviceState.temperature

---

temperatureUnit?

optional temperatureUnit: TemperatureUnit

Inherited from

DeviceState.temperatureUnit

---

humidity?

optional humidity: number

Inherited from

DeviceState.humidity

---

audioVolumes?

optional audioVolumes: AudioVolumes

Inherited from

DeviceState.audioVolumes

---

recordingActive?

optional recordingActive: boolean

Inherited from

DeviceState.recordingActive

---

ptzCapabilities?

optional ptzCapabilities: PanTiltZoomCapabilities

Inherited from

DeviceState.ptzCapabilities

---

lockState?

optional lockState: LockState

Inherited from

DeviceState.lockState

---

entryOpen?

optional entryOpen: boolean | "jammed"

Inherited from

DeviceState.entryOpen

---

batteryLevel?

optional batteryLevel: number

Inherited from

DeviceState.batteryLevel

---

chargeState?

optional chargeState: ChargeState

Inherited from

DeviceState.chargeState

---

online?

optional online: boolean

Inherited from

DeviceState.online

---

fromMimeType?

optional fromMimeType: string

Inherited from

DeviceState.fromMimeType

---

toMimeType?

optional toMimeType: string

Inherited from

DeviceState.toMimeType

---

converters?

optional converters: MediaConverterTypes[]

Inherited from

DeviceState.converters

---

binaryState?

optional binaryState: boolean

Inherited from

DeviceState.binaryState

---

tampered?

optional tampered: TamperState

Inherited from

DeviceState.tampered

---

sleeping?

optional sleeping: boolean

Inherited from

DeviceState.sleeping

---

powerDetected?

optional powerDetected: boolean

Inherited from

DeviceState.powerDetected

---

audioDetected?

optional audioDetected: boolean

Inherited from

DeviceState.audioDetected

---

motionDetected?

optional motionDetected: boolean

Inherited from

DeviceState.motionDetected

---

ambientLight?

optional ambientLight: number

Inherited from

DeviceState.ambientLight

---

occupied?

optional occupied: boolean

Inherited from

DeviceState.occupied

---

flooded?

optional flooded: boolean

Inherited from

DeviceState.flooded

---

ultraviolet?

optional ultraviolet: number

Inherited from

DeviceState.ultraviolet

---

luminance?

optional luminance: number

Inherited from

DeviceState.luminance

---

position?

optional position: Position

Inherited from

DeviceState.position

---

securitySystemState?

optional securitySystemState: SecuritySystemState

Inherited from

DeviceState.securitySystemState

---

pm10Density?

optional pm10Density: number

Inherited from

DeviceState.pm10Density

---

pm25Density?

optional pm25Density: number

Inherited from

DeviceState.pm25Density

---

vocDensity?

optional vocDensity: number

Inherited from

DeviceState.vocDensity

---

noxDensity?

optional noxDensity: number

Inherited from

DeviceState.noxDensity

---

co2ppm?

optional co2ppm: number

Inherited from

DeviceState.co2ppm

---

airQuality?

optional airQuality: AirQuality

Inherited from

DeviceState.airQuality

---

airPurifierState?

optional airPurifierState: AirPurifierState

Inherited from

DeviceState.airPurifierState

---

filterChangeIndication?

optional filterChangeIndication: boolean

Inherited from

DeviceState.filterChangeIndication

---

filterLifeLevel?

optional filterLifeLevel: number

Inherited from

DeviceState.filterLifeLevel

---

humiditySetting?

optional humiditySetting: HumiditySettingStatus

Inherited from

DeviceState.humiditySetting

---

fan?

optional fan: FanStatus

Inherited from

DeviceState.fan

---

applicationInfo?

optional applicationInfo: LauncherApplicationInfo

Inherited from

DeviceState.applicationInfo

---

systemDevice?

optional systemDevice: ScryptedSystemDeviceInfo

Inherited from

DeviceState.systemDevice

Methods

setState()

setState(property, value): Promise<void>

Parameters

• property: string

• value: any

Returns

Promise<void>