Scrypted Documentation / MixinDeviceBase
Class: MixinDeviceBase<T>
Extends
Type Parameters
• T
Implements
Constructors
new MixinDeviceBase()
new MixinDeviceBase<
T
>(options
):MixinDeviceBase
<T
>
Parameters
• options: MixinDeviceOptions
<T
>
Returns
Overrides
Properties
mixinProviderNativeId
mixinProviderNativeId:
ScryptedNativeId
mixinDevice
mixinDevice:
T
mixinDeviceInterfaces
mixinDeviceInterfaces:
ScryptedInterface
[]
id
id:
string
Implementation of
Inherited from
info?
optional
info:DeviceInformation
Implementation of
Inherited from
interfaces
interfaces:
string
[]
Implementation of
Inherited from
mixins
mixins:
string
[]
Implementation of
Inherited from
name?
optional
name:string
Implementation of
Inherited from
nativeId?
optional
nativeId:string
Implementation of
Inherited from
pluginId
pluginId:
string
Implementation of
Inherited from
providedInterfaces
providedInterfaces:
string
[]
Implementation of
DeviceState
.providedInterfaces
Inherited from
providedName?
optional
providedName:ScryptedDeviceType
Implementation of
Inherited from
providedRoom?
optional
providedRoom:string
Implementation of
Inherited from
providedType?
optional
providedType:ScryptedDeviceType
Implementation of
Inherited from
providerId?
optional
providerId:string
Implementation of
Inherited from
room?
optional
room:string
Implementation of
Inherited from
type?
optional
type:ScryptedDeviceType
Implementation of
Inherited from
scryptedRuntimeArguments?
optional
scryptedRuntimeArguments:ScryptedRuntimeArguments
Implementation of
DeviceState
.scryptedRuntimeArguments
Inherited from
DeviceBase
.scryptedRuntimeArguments
on?
optional
on:boolean
Implementation of
Inherited from
brightness?
optional
brightness:number
Implementation of
Inherited from
colorTemperature?
optional
colorTemperature:number
Implementation of
Inherited from
rgb?
optional
rgb:ColorRgb
Implementation of
Inherited from
hsv?
optional
hsv:ColorHsv
Implementation of
Inherited from
running?
optional
running:boolean
Implementation of
Inherited from
paused?
optional
paused:boolean
Implementation of
Inherited from
docked?
optional
docked:boolean
Implementation of
Inherited from
temperatureSetting?
optional
temperatureSetting:TemperatureSettingStatus
Implementation of
DeviceState
.temperatureSetting
Inherited from
temperature?
optional
temperature:number
Implementation of
Inherited from
temperatureUnit?
optional
temperatureUnit:TemperatureUnit
Implementation of
Inherited from
humidity?
optional
humidity:number
Implementation of
Inherited from
audioVolumes?
optional
audioVolumes:AudioVolumes
Implementation of
Inherited from
recordingActive?
optional
recordingActive:boolean
Implementation of
Inherited from
ptzCapabilities?
optional
ptzCapabilities:PanTiltZoomCapabilities
Implementation of
Inherited from
lockState?
optional
lockState:LockState
Implementation of
Inherited from
entryOpen?
optional
entryOpen:boolean
|"jammed"
Implementation of
Inherited from
batteryLevel?
optional
batteryLevel:number
Implementation of
Inherited from
chargeState?
optional
chargeState:ChargeState
Implementation of
Inherited from
online?
optional
online:boolean
Implementation of
Inherited from
fromMimeType?
optional
fromMimeType:string
Implementation of
Inherited from
toMimeType?
optional
toMimeType:string
Implementation of
Inherited from
converters?
optional
converters:MediaConverterTypes
[]
Implementation of
Inherited from
binaryState?
optional
binaryState:boolean
Implementation of
Inherited from
tampered?
optional
tampered:TamperState
Implementation of
Inherited from
powerDetected?
optional
powerDetected:boolean
Implementation of
Inherited from
audioDetected?
optional
audioDetected:boolean
Implementation of
Inherited from
motionDetected?
optional
motionDetected:boolean
Implementation of
Inherited from
ambientLight?
optional
ambientLight:number
Implementation of
Inherited from
occupied?
optional
occupied:boolean
Implementation of
Inherited from
flooded?
optional
flooded:boolean
Implementation of
Inherited from
ultraviolet?
optional
ultraviolet:number
Implementation of
Inherited from
luminance?
optional
luminance:number
Implementation of
Inherited from
position?
optional
position:Position
Implementation of
Inherited from
securitySystemState?
optional
securitySystemState:SecuritySystemState
Implementation of
DeviceState
.securitySystemState
Inherited from
DeviceBase
.securitySystemState
pm10Density?
optional
pm10Density:number
Implementation of
Inherited from
pm25Density?
optional
pm25Density:number
Implementation of
Inherited from
vocDensity?
optional
vocDensity:number
Implementation of
Inherited from
noxDensity?
optional
noxDensity:number
Implementation of
Inherited from
co2ppm?
optional
co2ppm:number
Implementation of
Inherited from
airQuality?
optional
airQuality:AirQuality
Implementation of
Inherited from
airPurifierState?
optional
airPurifierState:AirPurifierState
Implementation of
Inherited from
filterChangeIndication?
optional
filterChangeIndication:boolean
Implementation of
DeviceState
.filterChangeIndication
Inherited from
DeviceBase
.filterChangeIndication
filterLifeLevel?
optional
filterLifeLevel:number
Implementation of
Inherited from
humiditySetting?
optional
humiditySetting:HumiditySettingStatus
Implementation of
Inherited from
fan?
optional
fan:FanStatus
Implementation of
Inherited from
applicationInfo?
optional
applicationInfo:LauncherApplicationInfo
Implementation of
Inherited from
systemDevice?
optional
systemDevice:ScryptedSystemDeviceInfo
Implementation of
Inherited from
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