Interface ScryptedDevice

All devices in Scrypted implement ScryptedDevice, which contains the id, name, and type. Add listeners to subscribe to events from that device.

Hierarchy

ScryptedDevice

Index

Methods

listen

listen(event: string | EventListenerOptions, callback: EventListener): EventListenerRegister
Subscribe to events from a specific interface on a device, such as 'OnOff' or 'Brightness'.
Parameters
- event: string | EventListenerOptions
- callback: EventListener
Returns EventListenerRegister

setName

setName(name: string): Promise<void>
Parameters
- name: string
Returns Promise<void>

setRoom

setRoom(room: string): Promise<void>
Parameters
- room: string
Returns Promise<void>

setType

setType(type: ScryptedDeviceType): Promise<void>
Parameters
- type: ScryptedDeviceType
Returns Promise<void>

setMixins

setMixins(mixins: string[]): Promise<void>
Parameters
- mixins: string[]
Returns Promise<void>

probe

probe(): Promise<boolean>
Probes the device, ensuring creation of it and any mixins.

Returns Promise<boolean>

Properties

`Optional` id

id?: string

`Optional` nativeId

nativeId?: string

`Optional` pluginId

pluginId?: string

`Optional` interfaces

interfaces?: string[]

`Optional` mixins

mixins?: string[]

`Optional` name

name?: string

`Optional` info

info?: DeviceInformation

`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

Generated using TypeDoc