Class default

Hierarchy (View Summary)

DeviceWithTemperatureHumidity<StatusBody, CommandBody>
- default

Index

Constructors

Properties

_deps _deviceId

Methods

_getPath getHubDeviceId getHumidity getStatus getTemperature sendCommand setMode

Constructors

constructor

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

getHubDeviceId

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

getHumidity

getHumidity(): Promise<number>
Returns Promise<number>
Humidity percentage (integer, 0 - 100).
Inherited from DeviceWithTemperatureHumidity.getHumidity
- Defined in devices/Device.ts:182

getStatus

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

getTemperature

getTemperature(): Promise<number>
Returns Promise<number>
Temperature in celsius.
Inherited from DeviceWithTemperatureHumidity.getTemperature
- Defined in devices/Device.ts:177

`Protected`sendCommand

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

setMode

setMode(mode: number | "auto"): Promise<never>
Parameters
- mode: number | "auto"
  Must be "auto" or a number between 0 and 100 (atomization efficiency).
Returns Promise<never>
- Defined in devices/SwitchBotHumidifier.ts:31