Skip to content

Scrypted Documentation / ScryptedDeviceBase

Class: ScryptedDeviceBase

Extends

Constructors

new ScryptedDeviceBase()

new ScryptedDeviceBase(nativeId?): ScryptedDeviceBase

Parameters

nativeId?: string

Returns

ScryptedDeviceBase

Overrides

DeviceBase.constructor

Properties

nativeId?

readonly optional nativeId: string

Inherited from

DeviceBase.nativeId


id

id: string

Inherited from

DeviceBase.id


info?

optional info: DeviceInformation

Inherited from

DeviceBase.info


interfaces

interfaces: string[]

Inherited from

DeviceBase.interfaces


mixins

mixins: string[]

Inherited from

DeviceBase.mixins


name?

optional name: string

Inherited from

DeviceBase.name


pluginId

pluginId: string

Inherited from

DeviceBase.pluginId


providedInterfaces

providedInterfaces: string[]

Inherited from

DeviceBase.providedInterfaces


providedName?

optional providedName: ScryptedDeviceType

Inherited from

DeviceBase.providedName


providedRoom?

optional providedRoom: string

Inherited from

DeviceBase.providedRoom


providedType?

optional providedType: ScryptedDeviceType

Inherited from

DeviceBase.providedType


providerId?

optional providerId: string

Inherited from

DeviceBase.providerId


room?

optional room: string

Inherited from

DeviceBase.room


type?

optional type: ScryptedDeviceType

Inherited from

DeviceBase.type


scryptedRuntimeArguments?

optional scryptedRuntimeArguments: ScryptedRuntimeArguments

Inherited from

DeviceBase.scryptedRuntimeArguments


on?

optional on: boolean

Inherited from

DeviceBase.on


brightness?

optional brightness: number

Inherited from

DeviceBase.brightness


colorTemperature?

optional colorTemperature: number

Inherited from

DeviceBase.colorTemperature


rgb?

optional rgb: ColorRgb

Inherited from

DeviceBase.rgb


hsv?

optional hsv: ColorHsv

Inherited from

DeviceBase.hsv


running?

optional running: boolean

Inherited from

DeviceBase.running


paused?

optional paused: boolean

Inherited from

DeviceBase.paused


docked?

optional docked: boolean

Inherited from

DeviceBase.docked


temperatureSetting?

optional temperatureSetting: TemperatureSettingStatus

Inherited from

DeviceBase.temperatureSetting


temperature?

optional temperature: number

Inherited from

DeviceBase.temperature


temperatureUnit?

optional temperatureUnit: TemperatureUnit

Inherited from

DeviceBase.temperatureUnit


humidity?

optional humidity: number

Inherited from

DeviceBase.humidity


audioVolumes?

optional audioVolumes: AudioVolumes

Inherited from

DeviceBase.audioVolumes


recordingActive?

optional recordingActive: boolean

Inherited from

DeviceBase.recordingActive


ptzCapabilities?

optional ptzCapabilities: PanTiltZoomCapabilities

Inherited from

DeviceBase.ptzCapabilities


lockState?

optional lockState: LockState

Inherited from

DeviceBase.lockState


entryOpen?

optional entryOpen: boolean | "jammed"

Inherited from

DeviceBase.entryOpen


batteryLevel?

optional batteryLevel: number

Inherited from

DeviceBase.batteryLevel


chargeState?

optional chargeState: ChargeState

Inherited from

DeviceBase.chargeState


online?

optional online: boolean

Inherited from

DeviceBase.online


fromMimeType?

optional fromMimeType: string

Inherited from

DeviceBase.fromMimeType


toMimeType?

optional toMimeType: string

Inherited from

DeviceBase.toMimeType


converters?

optional converters: MediaConverterTypes[]

Inherited from

DeviceBase.converters


binaryState?

optional binaryState: boolean

Inherited from

DeviceBase.binaryState


tampered?

optional tampered: TamperState

Inherited from

DeviceBase.tampered


powerDetected?

optional powerDetected: boolean

Inherited from

DeviceBase.powerDetected


audioDetected?

optional audioDetected: boolean

Inherited from

DeviceBase.audioDetected


motionDetected?

optional motionDetected: boolean

Inherited from

DeviceBase.motionDetected


ambientLight?

optional ambientLight: number

Inherited from

DeviceBase.ambientLight


occupied?

optional occupied: boolean

Inherited from

DeviceBase.occupied


flooded?

optional flooded: boolean

Inherited from

DeviceBase.flooded


ultraviolet?

optional ultraviolet: number

Inherited from

DeviceBase.ultraviolet


luminance?

optional luminance: number

Inherited from

DeviceBase.luminance


position?

optional position: Position

Inherited from

DeviceBase.position


securitySystemState?

optional securitySystemState: SecuritySystemState

Inherited from

DeviceBase.securitySystemState


pm10Density?

optional pm10Density: number

Inherited from

DeviceBase.pm10Density


pm25Density?

optional pm25Density: number

Inherited from

DeviceBase.pm25Density


vocDensity?

optional vocDensity: number

Inherited from

DeviceBase.vocDensity


noxDensity?

optional noxDensity: number

Inherited from

DeviceBase.noxDensity


co2ppm?

optional co2ppm: number

Inherited from

DeviceBase.co2ppm


airQuality?

optional airQuality: AirQuality

Inherited from

DeviceBase.airQuality


airPurifierState?

optional airPurifierState: AirPurifierState

Inherited from

DeviceBase.airPurifierState


filterChangeIndication?

optional filterChangeIndication: boolean

Inherited from

DeviceBase.filterChangeIndication


filterLifeLevel?

optional filterLifeLevel: number

Inherited from

DeviceBase.filterLifeLevel


humiditySetting?

optional humiditySetting: HumiditySettingStatus

Inherited from

DeviceBase.humiditySetting


fan?

optional fan: FanStatus

Inherited from

DeviceBase.fan


applicationInfo?

optional applicationInfo: LauncherApplicationInfo

Inherited from

DeviceBase.applicationInfo


systemDevice?

optional systemDevice: ScryptedSystemDeviceInfo

Inherited from

DeviceBase.systemDevice

Accessors

storage

get storage(): Storage

Returns

Storage


log

get log(): Logger

Returns

Logger


console

get console(): Console

Returns

Console

Methods

createMediaObject()

createMediaObject(data, mimeType): Promise<MediaObject & object>

Parameters

data: any

mimeType: string

Returns

Promise<MediaObject & object>


getMediaObjectConsole()

getMediaObjectConsole(mediaObject): undefined | Console

Parameters

mediaObject: MediaObject

Returns

undefined | Console


_lazyLoadDeviceState()

_lazyLoadDeviceState(): void

Returns

void


onDeviceEvent()

onDeviceEvent(eventInterface, eventData): Promise<void>

Fire an event for this device.

Parameters

eventInterface: string

eventData: any

Returns

Promise<void>