Scrypted Documentation / MixinDeviceBase

Class: MixinDeviceBase<T>

Extends

• DeviceBase

Type Parameters

• T

Implements

• DeviceState

Constructors

new MixinDeviceBase()

new MixinDeviceBase<T>(options): MixinDeviceBase<T>

Parameters

• options: MixinDeviceOptions<T>

Returns

MixinDeviceBase<T>

Overrides

DeviceBase.constructor

Properties

mixinProviderNativeId

mixinProviderNativeId: ScryptedNativeId

---

mixinDevice

mixinDevice: T

---

mixinDeviceInterfaces

mixinDeviceInterfaces: ScryptedInterface[]

---

id

id: string

Implementation of

DeviceState.id

Inherited from

DeviceBase.id

---

info?

optional info: DeviceInformation

Implementation of

DeviceState.info

Inherited from

DeviceBase.info

---

interfaces

interfaces: string[]

Implementation of

DeviceState.interfaces

Inherited from

DeviceBase.interfaces

---

mixins

mixins: string[]

Implementation of

DeviceState.mixins

Inherited from

DeviceBase.mixins

---

name?

optional name: string

Implementation of

DeviceState.name

Inherited from

DeviceBase.name

---

nativeId?

optional nativeId: string

Implementation of

DeviceState.nativeId

Inherited from

DeviceBase.nativeId

---

pluginId

pluginId: string

Implementation of

DeviceState.pluginId

Inherited from

DeviceBase.pluginId

---

providedInterfaces

providedInterfaces: string[]

Implementation of

DeviceState.providedInterfaces

Inherited from

DeviceBase.providedInterfaces

---

providedName?

optional providedName: string

Implementation of

DeviceState.providedName

Inherited from

DeviceBase.providedName

---

providedRoom?

optional providedRoom: string

Implementation of

DeviceState.providedRoom

Inherited from

DeviceBase.providedRoom

---

providedType?

optional providedType: string

Implementation of

DeviceState.providedType

Inherited from

DeviceBase.providedType

---

providerId?

optional providerId: string

Implementation of

DeviceState.providerId

Inherited from

DeviceBase.providerId

---

room?

optional room: string

Implementation of

DeviceState.room

Inherited from

DeviceBase.room

---

type?

optional type: string

Implementation of

DeviceState.type

Inherited from

DeviceBase.type

---

scryptedRuntimeArguments?

optional scryptedRuntimeArguments: ScryptedRuntimeArguments

Implementation of

DeviceState.scryptedRuntimeArguments

Inherited from

DeviceBase.scryptedRuntimeArguments

---

on?

optional on: boolean

Implementation of

DeviceState.on

Inherited from

DeviceBase.on

---

brightness?

optional brightness: number

Implementation of

DeviceState.brightness

Inherited from

DeviceBase.brightness

---

colorTemperature?

optional colorTemperature: number

Implementation of

DeviceState.colorTemperature

Inherited from

DeviceBase.colorTemperature

---

rgb?

optional rgb: ColorRgb

Implementation of

DeviceState.rgb

Inherited from

DeviceBase.rgb

---

hsv?

optional hsv: ColorHsv

Implementation of

DeviceState.hsv

Inherited from

DeviceBase.hsv

---

buttons?

optional buttons: string[]

Implementation of

DeviceState.buttons

Inherited from

DeviceBase.buttons

---

sensors

sensors: Record<string, Sensor>

Implementation of

DeviceState.sensors

Inherited from

DeviceBase.sensors

---

running?

optional running: boolean

Implementation of

DeviceState.running

Inherited from

DeviceBase.running

---

paused?

optional paused: boolean

Implementation of

DeviceState.paused

Inherited from

DeviceBase.paused

---

docked?

optional docked: boolean

Implementation of

DeviceState.docked

Inherited from

DeviceBase.docked

---

temperatureSetting?

optional temperatureSetting: TemperatureSettingStatus

Implementation of

DeviceState.temperatureSetting

Inherited from

DeviceBase.temperatureSetting

---

temperature?

optional temperature: number

Implementation of

DeviceState.temperature

Inherited from

DeviceBase.temperature

---

temperatureUnit?

optional temperatureUnit: TemperatureUnit

Implementation of

DeviceState.temperatureUnit

Inherited from

DeviceBase.temperatureUnit

---

humidity?

optional humidity: number

Implementation of

DeviceState.humidity

Inherited from

DeviceBase.humidity

---

audioVolumes?

optional audioVolumes: AudioVolumes

Implementation of

DeviceState.audioVolumes

Inherited from

DeviceBase.audioVolumes

---

recordingActive?

optional recordingActive: boolean

Implementation of

DeviceState.recordingActive

Inherited from

DeviceBase.recordingActive

---

ptzCapabilities?

optional ptzCapabilities: PanTiltZoomCapabilities

Implementation of

DeviceState.ptzCapabilities

Inherited from

DeviceBase.ptzCapabilities

---

lockState?

optional lockState: LockState

Implementation of

DeviceState.lockState

Inherited from

DeviceBase.lockState

---

entryOpen?

optional entryOpen: boolean | "jammed"

Implementation of

DeviceState.entryOpen

Inherited from

DeviceBase.entryOpen

---

batteryLevel?

optional batteryLevel: number

Implementation of

DeviceState.batteryLevel

Inherited from

DeviceBase.batteryLevel

---

chargeState?

optional chargeState: ChargeState

Implementation of

DeviceState.chargeState

Inherited from

DeviceBase.chargeState

---

online?

optional online: boolean

Implementation of

DeviceState.online

Inherited from

DeviceBase.online

---

fromMimeType?

optional fromMimeType: string

Implementation of

DeviceState.fromMimeType

Inherited from

DeviceBase.fromMimeType

---

toMimeType?

optional toMimeType: string

Implementation of

DeviceState.toMimeType

Inherited from

DeviceBase.toMimeType

---

converters?

optional converters: MediaConverterTypes[]

Implementation of

DeviceState.converters

Inherited from

DeviceBase.converters

---

binaryState?

optional binaryState: boolean

Implementation of

DeviceState.binaryState

Inherited from

DeviceBase.binaryState

---

tampered?

optional tampered: TamperState

Implementation of

DeviceState.tampered

Inherited from

DeviceBase.tampered

---

sleeping?

optional sleeping: boolean

Implementation of

DeviceState.sleeping

Inherited from

DeviceBase.sleeping

---

powerDetected?

optional powerDetected: boolean

Implementation of

DeviceState.powerDetected

Inherited from

DeviceBase.powerDetected

---

audioDetected?

optional audioDetected: boolean

Implementation of

DeviceState.audioDetected

Inherited from

DeviceBase.audioDetected

---

motionDetected?

optional motionDetected: boolean

Implementation of

DeviceState.motionDetected

Inherited from

DeviceBase.motionDetected

---

ambientLight?

optional ambientLight: number

Implementation of

DeviceState.ambientLight

Inherited from

DeviceBase.ambientLight

---

occupied?

optional occupied: boolean

Implementation of

DeviceState.occupied

Inherited from

DeviceBase.occupied

---

flooded?

optional flooded: boolean

Implementation of

DeviceState.flooded

Inherited from

DeviceBase.flooded

---

ultraviolet?

optional ultraviolet: number

Implementation of

DeviceState.ultraviolet

Inherited from

DeviceBase.ultraviolet

---

luminance?

optional luminance: number

Implementation of

DeviceState.luminance

Inherited from

DeviceBase.luminance

---

position?

optional position: Position

Implementation of

DeviceState.position

Inherited from

DeviceBase.position

---

securitySystemState?

optional securitySystemState: SecuritySystemState

Implementation of

DeviceState.securitySystemState

Inherited from

DeviceBase.securitySystemState

---

pm10Density?

optional pm10Density: number

Implementation of

DeviceState.pm10Density

Inherited from

DeviceBase.pm10Density

---

pm25Density?

optional pm25Density: number

Implementation of

DeviceState.pm25Density

Inherited from

DeviceBase.pm25Density

---

vocDensity?

optional vocDensity: number

Implementation of

DeviceState.vocDensity

Inherited from

DeviceBase.vocDensity

---

noxDensity?

optional noxDensity: number

Implementation of

DeviceState.noxDensity

Inherited from

DeviceBase.noxDensity

---

co2ppm?

optional co2ppm: number

Implementation of

DeviceState.co2ppm

Inherited from

DeviceBase.co2ppm

---

airQuality?

optional airQuality: AirQuality

Implementation of

DeviceState.airQuality

Inherited from

DeviceBase.airQuality

---

airPurifierState?

optional airPurifierState: AirPurifierState

Implementation of

DeviceState.airPurifierState

Inherited from

DeviceBase.airPurifierState

---

filterChangeIndication?

optional filterChangeIndication: boolean

Implementation of

DeviceState.filterChangeIndication

Inherited from

DeviceBase.filterChangeIndication

---

filterLifeLevel?

optional filterLifeLevel: number

Implementation of

DeviceState.filterLifeLevel

Inherited from

DeviceBase.filterLifeLevel

---

humiditySetting?

optional humiditySetting: HumiditySettingStatus

Implementation of

DeviceState.humiditySetting

Inherited from

DeviceBase.humiditySetting

---

fan?

optional fan: FanStatus

Implementation of

DeviceState.fan

Inherited from

DeviceBase.fan

---

applicationInfo?

optional applicationInfo: LauncherApplicationInfo

Implementation of

DeviceState.applicationInfo

Inherited from

DeviceBase.applicationInfo

---

systemDevice?

optional systemDevice: ScryptedSystemDeviceInfo

Implementation of

DeviceState.systemDevice

Inherited from

DeviceBase.systemDevice

Accessors

storage

get storage(): Storage

Returns

Storage

---

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): Console

Parameters

• mediaObject: MediaObject

Returns

Console

---

onDeviceEvent()

onDeviceEvent(eventInterface, eventData): Promise<void>

Fire an event for this device.

Parameters

• eventInterface: string

• eventData: any

Returns

Promise<void>

---

_lazyLoadDeviceState()

_lazyLoadDeviceState(): void

Returns

void

---

manageListener()

manageListener(listener): void

Parameters

• listener: EventListenerRegister

Returns

void

---

release()

release(): void

Returns

void