Class default

Hierarchy (View Summary)

DeviceWithStatus<StatusBody, CommandBody>
- default

Index

Constructors

Properties

_deps _deviceId

Methods

_getPath closeDown closeUp getHubDeviceId getStatus open sendCommand setPosition

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

closeDown

closeDown(): Promise<any>
Set the position of the Blind Tilt to closed down (equivalent to setting position to "0 down").

Returns Promise<any>
- Defined in devices/SwitchBotBlindTilt.ts:78

closeUp

closeUp(): Promise<any>
Set the position of the Blind Tilt to closed up (equivalent to setting position to "0 up").

Returns Promise<any>
- Defined in devices/SwitchBotBlindTilt.ts:72

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

open

open(): Promise<any>
Set the position of the Blind Tilt to open (equivalent to setting position to "0 up" or "100 down").

Returns Promise<any>
- Defined in devices/SwitchBotBlindTilt.ts:66

`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

setPosition

setPosition(position: number, direction: "up" | "down"): Promise<any>
Parameters
- position: number
  Must be a number between 0 and 100. 0 means closed, 100 means opened. Odd numbers are rounded down to the nearest even number.
- direction: "up" | "down"
  The direction to move the blind tilt.
Returns Promise<any>
- Defined in devices/SwitchBotBlindTilt.ts:46