Interface SystemManager

SystemManager is used by scripts to query device state and access devices.

Hierarchy

SystemManager

Index

Methods

getComponent getDeviceById getDeviceByName getDeviceState getSystemState listen listenDevice removeDevice

Methods

getComponent

getComponent(id: string): Promise<any>
Retrieve a system service.
Parameters
- id: string
Returns Promise<any>

getDeviceById

getDeviceById(id: string): ScryptedDevice
Find a Scrypted device by id.
Parameters
- id: string
Returns ScryptedDevice
getDeviceById<T>(id: string): ScryptedDevice & T
Find a Scrypted device by id.
Type Parameters
- T
Parameters
- id: string
Returns ScryptedDevice & T
getDeviceById(pluginId: string, nativeId?: string): ScryptedDevice
Find a Scrypted device by pluginId and optionally the nativeId.
Parameters
- pluginId: string
- Optional nativeId: string
Returns ScryptedDevice
getDeviceById<T>(pluginId: string, nativeId?: string): ScryptedDevice & T
Find a Scrypted device by pluginId and optionally the nativeId.
Type Parameters
- T
Parameters
- pluginId: string
- Optional nativeId: string
Returns ScryptedDevice & T

getDeviceByName

getDeviceByName(name: string): ScryptedDevice
Find a Scrypted device by name.
Parameters
- name: string
Returns ScryptedDevice
getDeviceByName<T>(name: string): ScryptedDevice & T
Find a Scrypted device by name.
Type Parameters
- T
Parameters
- name: string
Returns ScryptedDevice & T

getDeviceState

getDeviceState(id: string): {
[property: string]: SystemDeviceState;
}
Get the current state of a device.

Deprecated
Parameters
- id: string
Returns {
[property: string]: SystemDeviceState;
}
- [property: string]: SystemDeviceState

getSystemState

getSystemState(): {
    [id: string]: {
        [property: string]: SystemDeviceState;
    };
}
Get the current state of every device.

Returns {
    [id: string]: {
        [property: string]: SystemDeviceState;
    };
}
- [id: string]: {
  [property: string]: SystemDeviceState;
  }
  - [property: string]: SystemDeviceState

listen

listen(callback: EventListener): EventListenerRegister
Passively (without polling) listen to property changed events.
Parameters
- callback: EventListener
Returns EventListenerRegister

listenDevice

listenDevice(id: string, event: string | EventListenerOptions, callback: EventListener): EventListenerRegister
Subscribe to events from a specific interface on a device id, such as 'OnOff' or 'Brightness'. This is a convenience method for ScryptedDevice.listen.
Parameters
- id: string
- event: string | EventListenerOptions
- callback: EventListener
Returns EventListenerRegister

removeDevice

removeDevice(id: string): Promise<void>
Remove a device from Scrypted. Plugins should use DeviceManager.onDevicesChanged or DeviceManager.onDeviceRemoved to remove their own devices
Parameters
- id: string
Returns Promise<void>

Interface SystemManager

Hierarchy

Index

Methods

Methods

getComponent

Parameters

id: string

Returns Promise<any>

getDeviceById

Parameters

id: string

Returns ScryptedDevice

Type Parameters

T

Parameters

id: string

Returns ScryptedDevice & T

Parameters

pluginId: string

Optional nativeId: string

Returns ScryptedDevice

Type Parameters

T

Parameters

pluginId: string

Optional nativeId: string

Returns ScryptedDevice & T

getDeviceByName

Parameters

name: string

Returns ScryptedDevice

Type Parameters

T

Parameters

name: string

Returns ScryptedDevice & T

getDeviceState

Deprecated

Parameters

id: string

Returns { [property: string]: SystemDeviceState; }

[property: string]: SystemDeviceState

getSystemState

Returns { [id: string]: { [property: string]: SystemDeviceState; }; }

[id: string]: { [property: string]: SystemDeviceState; }

[property: string]: SystemDeviceState

listen

Parameters

callback: EventListener

Returns EventListenerRegister

listenDevice

Parameters

id: string

event: string | EventListenerOptions

callback: EventListener

Returns EventListenerRegister

removeDevice

Parameters

id: string

Returns Promise<void>

Settings

Member Visibility

Theme

`Optional` nativeId: string

`Optional` nativeId: string

Returns {
[property: string]: SystemDeviceState;
}

Returns {
[id: string]: {
[property: string]: SystemDeviceState;
};
}

[id: string]: {
[property: string]: SystemDeviceState;
}