Skip to content

Scrypted Documentation / DeviceBase

Class: DeviceBase ​

Extended by ​

Implements ​

Constructors ​

new DeviceBase() ​

new DeviceBase(): DeviceBase

Returns ​

DeviceBase

Properties ​

id ​

id: string

Implementation of ​

DeviceState.id


info? ​

optional info: DeviceInformation

Implementation of ​

DeviceState.info


interfaces ​

interfaces: string[]

Implementation of ​

DeviceState.interfaces


mixins ​

mixins: string[]

Implementation of ​

DeviceState.mixins


name? ​

optional name: string

Implementation of ​

DeviceState.name


nativeId? ​

optional nativeId: string

Implementation of ​

DeviceState.nativeId


pluginId ​

pluginId: string

Implementation of ​

DeviceState.pluginId


providedInterfaces ​

providedInterfaces: string[]

Implementation of ​

DeviceState.providedInterfaces


providedName? ​

optional providedName: string

Implementation of ​

DeviceState.providedName


providedRoom? ​

optional providedRoom: string

Implementation of ​

DeviceState.providedRoom


providedType? ​

optional providedType: string

Implementation of ​

DeviceState.providedType


providerId? ​

optional providerId: string

Implementation of ​

DeviceState.providerId


room? ​

optional room: string

Implementation of ​

DeviceState.room


type? ​

optional type: string

Implementation of ​

DeviceState.type


scryptedRuntimeArguments? ​

optional scryptedRuntimeArguments: ScryptedRuntimeArguments

Implementation of ​

DeviceState.scryptedRuntimeArguments


on? ​

optional on: boolean

Implementation of ​

DeviceState.on


brightness? ​

optional brightness: number

Implementation of ​

DeviceState.brightness


colorTemperature? ​

optional colorTemperature: number

Implementation of ​

DeviceState.colorTemperature


rgb? ​

optional rgb: ColorRgb

Implementation of ​

DeviceState.rgb


hsv? ​

optional hsv: ColorHsv

Implementation of ​

DeviceState.hsv


buttons? ​

optional buttons: string[]

Implementation of ​

DeviceState.buttons


sensors ​

sensors: Record<string, Sensor>

Implementation of ​

DeviceState.sensors


running? ​

optional running: boolean

Implementation of ​

DeviceState.running


paused? ​

optional paused: boolean

Implementation of ​

DeviceState.paused


docked? ​

optional docked: boolean

Implementation of ​

DeviceState.docked


temperatureSetting? ​

optional temperatureSetting: TemperatureSettingStatus

Implementation of ​

DeviceState.temperatureSetting


temperature? ​

optional temperature: number

Implementation of ​

DeviceState.temperature


temperatureUnit? ​

optional temperatureUnit: TemperatureUnit

Implementation of ​

DeviceState.temperatureUnit


humidity? ​

optional humidity: number

Implementation of ​

DeviceState.humidity


audioVolumes? ​

optional audioVolumes: AudioVolumes

Implementation of ​

DeviceState.audioVolumes


recordingActive? ​

optional recordingActive: boolean

Implementation of ​

DeviceState.recordingActive


ptzCapabilities? ​

optional ptzCapabilities: PanTiltZoomCapabilities

Implementation of ​

DeviceState.ptzCapabilities


lockState? ​

optional lockState: LockState

Implementation of ​

DeviceState.lockState


entryOpen? ​

optional entryOpen: boolean | "jammed"

Implementation of ​

DeviceState.entryOpen


batteryLevel? ​

optional batteryLevel: number

Implementation of ​

DeviceState.batteryLevel


chargeState? ​

optional chargeState: ChargeState

Implementation of ​

DeviceState.chargeState


online? ​

optional online: boolean

Implementation of ​

DeviceState.online


fromMimeType? ​

optional fromMimeType: string

Implementation of ​

DeviceState.fromMimeType


toMimeType? ​

optional toMimeType: string

Implementation of ​

DeviceState.toMimeType


converters? ​

optional converters: MediaConverterTypes[]

Implementation of ​

DeviceState.converters


binaryState? ​

optional binaryState: boolean

Implementation of ​

DeviceState.binaryState


tampered? ​

optional tampered: TamperState

Implementation of ​

DeviceState.tampered


sleeping? ​

optional sleeping: boolean

Implementation of ​

DeviceState.sleeping


powerDetected? ​

optional powerDetected: boolean

Implementation of ​

DeviceState.powerDetected


audioDetected? ​

optional audioDetected: boolean

Implementation of ​

DeviceState.audioDetected


motionDetected? ​

optional motionDetected: boolean

Implementation of ​

DeviceState.motionDetected


ambientLight? ​

optional ambientLight: number

Implementation of ​

DeviceState.ambientLight


occupied? ​

optional occupied: boolean

Implementation of ​

DeviceState.occupied


flooded? ​

optional flooded: boolean

Implementation of ​

DeviceState.flooded


ultraviolet? ​

optional ultraviolet: number

Implementation of ​

DeviceState.ultraviolet


luminance? ​

optional luminance: number

Implementation of ​

DeviceState.luminance


position? ​

optional position: Position

Implementation of ​

DeviceState.position


securitySystemState? ​

optional securitySystemState: SecuritySystemState

Implementation of ​

DeviceState.securitySystemState


pm10Density? ​

optional pm10Density: number

Implementation of ​

DeviceState.pm10Density


pm25Density? ​

optional pm25Density: number

Implementation of ​

DeviceState.pm25Density


vocDensity? ​

optional vocDensity: number

Implementation of ​

DeviceState.vocDensity


noxDensity? ​

optional noxDensity: number

Implementation of ​

DeviceState.noxDensity


co2ppm? ​

optional co2ppm: number

Implementation of ​

DeviceState.co2ppm


airQuality? ​

optional airQuality: AirQuality

Implementation of ​

DeviceState.airQuality


airPurifierState? ​

optional airPurifierState: AirPurifierState

Implementation of ​

DeviceState.airPurifierState


filterChangeIndication? ​

optional filterChangeIndication: boolean

Implementation of ​

DeviceState.filterChangeIndication


filterLifeLevel? ​

optional filterLifeLevel: number

Implementation of ​

DeviceState.filterLifeLevel


humiditySetting? ​

optional humiditySetting: HumiditySettingStatus

Implementation of ​

DeviceState.humiditySetting


fan? ​

optional fan: FanStatus

Implementation of ​

DeviceState.fan


applicationInfo? ​

optional applicationInfo: LauncherApplicationInfo

Implementation of ​

DeviceState.applicationInfo


systemDevice? ​

optional systemDevice: ScryptedSystemDeviceInfo

Implementation of ​

DeviceState.systemDevice