Class default

Hierarchy (View Summary)

DeviceWithPower<StatusBody, CommandBody>
- default

Index

Constructors

Properties

_deps _deviceId

Methods

_getPath getHubDeviceId getPowerStatus getStatus press sendCommand turnOff turnOn

Constructors

constructor

new default(deviceId: string, deps: Deps): default
Parameters
- deviceId: string
- deps: Deps
Returns default
Inherited from DeviceWithPower.constructor
- Defined in devices/Device.ts:30

Properties

`Protected` `Readonly`_deps

_deps: Deps

`Protected` `Readonly`_deviceId

_deviceId: string

Methods

`Protected`_getPath

_getPath(path: string): string
Parameters
- path: string
Returns string
Inherited from DeviceWithPower._getPath
- Defined in devices/Device.ts:35

getHubDeviceId

getHubDeviceId(): Promise<string>
Returns Promise<string>
Inherited from DeviceWithPower.getHubDeviceId
- Defined in devices/Device.ts:61

getPowerStatus

getPowerStatus(): Promise<"on" | "off">
Returns Promise<"on" | "off">
Inherited from DeviceWithPower.getPowerStatus
- Defined in devices/Device.ts:86

getStatus

getStatus(options?: GetStatusOptions): Promise<StatusBody>
Parameters
- options: GetStatusOptions = {}
Returns Promise<StatusBody>
Inherited from DeviceWithPower.getStatus
- Defined in devices/Device.ts:46

press

press(): Promise<any>
Returns Promise<any>
- Defined in devices/SwitchBotBot.ts:20

`Protected`sendCommand

sendCommand(command: string, parameter?: any): Promise<any>
Parameters
- command: string
- parameter: any = "default"
Returns Promise<any>
Inherited from DeviceWithPower.sendCommand
- Defined in devices/Device.ts:66

turnOff

turnOff(): Promise<any>
Set the device to off state.

Returns Promise<any>
Inherited from DeviceWithPower.turnOff
- Defined in devices/Device.ts:106

turnOn

turnOn(): Promise<any>
Set the device to on state.

Returns Promise<any>
Inherited from DeviceWithPower.turnOn
- Defined in devices/Device.ts:99