Class MixinDeviceBase<T>

Type Parameters

Hierarchy

DeviceBase
- MixinDeviceBase

Implements

DeviceState

Index

Properties

mixinProviderNativeId

mixinProviderNativeId: string

mixinDevice

mixinDevice: T

mixinDeviceInterfaces

mixinDeviceInterfaces: ScryptedInterface[]

`Optional` id

id?: string

`Optional` info

info?: DeviceInformation

`Optional` interfaces

interfaces?: string[]

`Optional` mixins

mixins?: string[]

`Optional` name

name?: string

`Optional` nativeId

nativeId?: string

`Optional` pluginId

pluginId?: string

`Optional` providedInterfaces

providedInterfaces?: string[]

`Optional` providedName

providedName?: ScryptedDeviceType

`Optional` providedRoom

providedRoom?: string

`Optional` providedType

providedType?: ScryptedDeviceType

`Optional` providerId

providerId?: string

`Optional` room

room?: string

`Optional` type

type?: ScryptedDeviceType

`Optional` on

on?: boolean

`Optional` brightness

brightness?: number

`Optional` colorTemperature

colorTemperature?: number

`Optional` rgb

rgb?: ColorRgb

`Optional` hsv

hsv?: ColorHsv

`Optional` running

running?: boolean

`Optional` paused

paused?: boolean

`Optional` docked

docked?: boolean

`Optional` temperatureSetting

temperatureSetting?: TemperatureSettingStatus

`Optional` thermostatActiveMode

thermostatActiveMode?: ThermostatMode

`Optional` thermostatAvailableModes

thermostatAvailableModes?: ThermostatMode[]

`Optional` thermostatMode

thermostatMode?: ThermostatMode

`Optional` thermostatSetpoint

thermostatSetpoint?: number

`Optional` thermostatSetpointHigh

thermostatSetpointHigh?: number

`Optional` thermostatSetpointLow

thermostatSetpointLow?: number

`Optional` temperature

temperature?: number

`Optional` temperatureUnit

temperatureUnit?: TemperatureUnit

`Optional` humidity

humidity?: number

`Optional` ptzCapabilities

ptzCapabilities?: PanTiltZoomCapabilities

`Optional` lockState

lockState?: LockState

`Optional` entryOpen

entryOpen?: boolean | "jammed"

`Optional` batteryLevel

batteryLevel?: number

`Optional` chargeState

chargeState?: ChargeState

`Optional` online

online?: boolean

`Optional` fromMimeType

fromMimeType?: string

`Optional` toMimeType

toMimeType?: string

`Optional` binaryState

binaryState?: boolean

`Optional` tampered

tampered?: TamperState

`Optional` powerDetected

powerDetected?: boolean

`Optional` audioDetected

audioDetected?: boolean

`Optional` motionDetected

motionDetected?: boolean

`Optional` ambientLight

ambientLight?: number

`Optional` occupied

occupied?: boolean

`Optional` flooded

flooded?: boolean

`Optional` ultraviolet

ultraviolet?: number

`Optional` luminance

luminance?: number

`Optional` position

position?: Position

`Optional` securitySystemState

securitySystemState?: SecuritySystemState

`Optional` pm10Density

pm10Density?: number

`Optional` pm25Density

pm25Density?: number

`Optional` vocDensity

vocDensity?: number

`Optional` noxDensity

noxDensity?: number

`Optional` co2ppm

co2ppm?: number

`Optional` airQuality

airQuality?: AirQuality

`Optional` airPurifierState

airPurifierState?: AirPurifierState

`Optional` filterChangeIndication

filterChangeIndication?: boolean

`Optional` filterLifeLevel

filterLifeLevel?: number

`Optional` humiditySetting

humiditySetting?: HumiditySettingStatus

`Optional` fan

fan?: FanStatus

`Optional` applicationInfo

applicationInfo?: LauncherApplicationInfo

Constructors

constructor

new MixinDeviceBase<T>(options: MixinDeviceOptions<T>): MixinDeviceBase<T>
Type Parameters
- T
Parameters
- options: MixinDeviceOptions<T>
Returns MixinDeviceBase<T>

Overrides DeviceBase.constructor

Accessors

storage

get storage(): Storage
Returns Storage

console

get console(): Console
Returns Console

Methods

createMediaObject

createMediaObject(data: any, mimeType: string): Promise<MediaObject & {
sourceId: string;
}>
Parameters
- data: any
- mimeType: string
Returns Promise<MediaObject & {
sourceId: string;
}>

getMediaObjectConsole

getMediaObjectConsole(mediaObject: MediaObject): Console
Parameters
- mediaObject: MediaObject
Returns Console

onDeviceEvent

onDeviceEvent(eventInterface: string, eventData: any): Promise<void>
Fire an event for this device.
Parameters
- eventInterface: string
- eventData: any
Returns Promise<void>

_lazyLoadDeviceState

_lazyLoadDeviceState(): void
Returns void

manageListener

manageListener(listener: EventListenerRegister): void
Parameters
- listener: EventListenerRegister
Returns void

release

release(): void
Returns void

Class MixinDeviceBase<T>

Type Parameters

T

Hierarchy

Implements

Index

Properties

Constructors

Accessors

Methods

Properties

mixinProviderNativeId

mixinDevice

mixinDeviceInterfaces

Optional id

Optional info

Optional interfaces

Optional mixins

Optional name

Optional nativeId

Optional pluginId

Optional providedInterfaces

Optional providedName

Optional providedRoom

Optional providedType

Optional providerId

Optional room

Optional type

Optional on

Optional brightness

Optional colorTemperature

Optional rgb

Optional hsv

Optional running

Optional paused

Optional docked

Optional temperatureSetting

Optional thermostatActiveMode

Optional thermostatAvailableModes

Optional thermostatMode

Optional thermostatSetpoint

Optional thermostatSetpointHigh

Optional thermostatSetpointLow

Optional temperature

Optional temperatureUnit

Optional humidity

Optional ptzCapabilities

Optional lockState

Optional entryOpen

Optional batteryLevel

Optional chargeState

Optional online

Optional fromMimeType

Optional toMimeType

Optional binaryState

Optional tampered

Optional powerDetected

Optional audioDetected

Optional motionDetected

Optional ambientLight

Optional occupied

Optional flooded

Optional ultraviolet

Optional luminance

Optional position

Optional securitySystemState

Optional pm10Density

Optional pm25Density

Optional vocDensity

Optional noxDensity

Optional co2ppm

Optional airQuality

Optional airPurifierState

Optional filterChangeIndication

Optional filterLifeLevel

Optional humiditySetting

Optional fan

Optional applicationInfo

Constructors

constructor

`Optional` id

`Optional` info

`Optional` interfaces

`Optional` mixins

`Optional` name

`Optional` nativeId

`Optional` pluginId

`Optional` providedInterfaces

`Optional` providedName

`Optional` providedRoom

`Optional` providedType

`Optional` providerId

`Optional` room

`Optional` type

`Optional` on

`Optional` brightness

`Optional` colorTemperature

`Optional` rgb

`Optional` hsv

`Optional` running

`Optional` paused

`Optional` docked

`Optional` temperatureSetting

`Optional` thermostatActiveMode

`Optional` thermostatAvailableModes

`Optional` thermostatMode

`Optional` thermostatSetpoint

`Optional` thermostatSetpointHigh

`Optional` thermostatSetpointLow

`Optional` temperature

`Optional` temperatureUnit

`Optional` humidity

`Optional` ptzCapabilities

`Optional` lockState

`Optional` entryOpen

`Optional` batteryLevel

`Optional` chargeState

`Optional` online

`Optional` fromMimeType

`Optional` toMimeType

`Optional` binaryState

`Optional` tampered

`Optional` powerDetected

`Optional` audioDetected

`Optional` motionDetected

`Optional` ambientLight

`Optional` occupied

`Optional` flooded

`Optional` ultraviolet

`Optional` luminance

`Optional` position

`Optional` securitySystemState

`Optional` pm10Density

`Optional` pm25Density

`Optional` vocDensity

`Optional` noxDensity

`Optional` co2ppm

`Optional` airQuality

`Optional` airPurifierState

`Optional` filterChangeIndication

`Optional` filterLifeLevel

`Optional` humiditySetting

`Optional` fan

`Optional` applicationInfo

Returns Promise<MediaObject & {
sourceId: string;
}>