Class default

Hierarchy (View Summary)

DeviceWithStatus<StatusBody, CommandBody>
- default

Index

Constructors

Properties

_deps _deviceId

Methods

_getPath dock getHubDeviceId getStatus sendCommand start stop

Constructors

constructor

new default(deviceId: string, deps: Deps): default
Parameters
- deviceId: string
- deps: Deps
Returns default
Inherited from DeviceWithStatus.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 DeviceWithStatus._getPath
- Defined in devices/Device.ts:35

dock

dock(): Promise<any>
Return to charging dock.

Returns Promise<any>
- Defined in devices/SwitchBotRobotVacuumCleaner.ts:47

getHubDeviceId

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

getStatus

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

`Protected`sendCommand

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

start

start(): Promise<any>
Start vacuuming.

Returns Promise<any>
- Defined in devices/SwitchBotRobotVacuumCleaner.ts:37

stop

stop(): Promise<any>
Stop vacuuming.

Returns Promise<any>
- Defined in devices/SwitchBotRobotVacuumCleaner.ts:42