Class default

Hierarchy (View Summary)

SwitchBotCurtainBase<DeviceType>
- default

Index

Constructors

Properties

_deps _deviceId

Methods

_getPath close getHubDeviceId getStatus open sendCommand setPosition

Constructors

constructor

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

close

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

Returns Promise<any>
Inherited from SwitchBotCurtainBase.close
- Defined in devices/SwitchBotCurtain.ts:65

getHubDeviceId

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

getStatus

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

open

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

Returns Promise<any>
Inherited from SwitchBotCurtainBase.open
- Defined in devices/SwitchBotCurtain.ts:60

`Protected`sendCommand

sendCommand(command: string, parameter?: any): Promise<any>
Parameters
- command: string
- parameter: any = "default"
Returns Promise<any>
Inherited from SwitchBotCurtainBase.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>
Inherited from SwitchBotCurtainBase.setPosition
- Defined in devices/SwitchBotCurtain.ts:47