Class SwitchBotCurtainBase<T>

Type Parameters

T

Hierarchy (View Summary)

DeviceWithStatus<StatusBody<T>, CommandBody>
- SwitchBotCurtainBase
  - default
  - default

Index

Constructors

Properties

_deps _deviceId

Methods

_getPath close getHubDeviceId getStatus open sendCommand setPosition

Constructors

constructor

new SwitchBotCurtainBase<T>(
deviceId: string,
deps: Deps,
): SwitchBotCurtainBase<T>
Type Parameters
- T
Parameters
- deviceId: string
- deps: Deps
Returns SwitchBotCurtainBase<T>
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

close

close(): Promise<any>
Close the curtain (equivalent to set position to 100).

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

getHubDeviceId

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

getStatus

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

open

open(): Promise<any>
Open the curtain (equivalent to set position to 0).

Returns Promise<any>
- Defined in devices/SwitchBotCurtain.ts:61

`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): Promise<any>
Parameters
- position: number
  Must be a number between 0 and 100. 0 means opened, 100 means closed.
Returns Promise<any>
- Defined in devices/SwitchBotCurtain.ts:48