Class WoAirPurifier

Class representing a SwitchBot Air Purifier device.

Hierarchy (View Summary)

SwitchbotDevice
- WoAirPurifier

Constructors

constructor

new WoAirPurifier(peripheral: Peripheral, noble: Noble): WoAirPurifier
Initializes a new instance of the SwitchbotDevice class.
Parameters
- peripheral: Peripheral
  The peripheral object from noble.
- noble: Noble
  The Noble object.
Returns WoAirPurifier
Inherited from SwitchbotDevice.constructor
- Defined in src/device.ts:576

Accessors

address

get address(): string
Returns string
Inherited from SwitchbotDevice.address
- Defined in src/device.ts:604

connectionState

get connectionState(): string
Returns string
Inherited from SwitchbotDevice.connectionState
- Defined in src/device.ts:620

friendlyName

get friendlyName(): SwitchBotBLEModelFriendlyName
Returns SwitchBotBLEModelFriendlyName
Inherited from SwitchbotDevice.friendlyName
- Defined in src/device.ts:616

id

get id(): string
Returns string
Inherited from SwitchbotDevice.id
- Defined in src/device.ts:600

model

get model(): SwitchBotBLEModel
Returns SwitchBotBLEModel
Inherited from SwitchbotDevice.model
- Defined in src/device.ts:608

modelName

get modelName(): SwitchBotBLEModelName
Returns SwitchBotBLEModelName
Inherited from SwitchbotDevice.modelName
- Defined in src/device.ts:612

onConnectHandler

get onConnectHandler(): () => Promise<void>
Returns () => Promise<void>
Inherited from SwitchbotDevice.onConnectHandler
- Defined in src/device.ts:624
set onConnectHandler(func: () => Promise<void>): void
Parameters
- func: () => Promise<void>
Returns void
Inherited from SwitchbotDevice.onConnectHandler
- Defined in src/device.ts:628

onDisconnectHandler

get onDisconnectHandler(): () => Promise<void>
Returns () => Promise<void>
Inherited from SwitchbotDevice.onDisconnectHandler
- Defined in src/device.ts:637
set onDisconnectHandler(func: () => Promise<void>): void
Parameters
- func: () => Promise<void>
Returns void
Inherited from SwitchbotDevice.onDisconnectHandler
- Defined in src/device.ts:641

Methods

command

command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>
Sends a command to the device and awaits a response.
Parameters
- reqBuf: Buffer
  The command buffer.
Returns Promise<Buffer<ArrayBufferLike>>
A Promise that resolves with the response buffer.
Inherited from SwitchbotDevice.command
- Defined in src/device.ts:872

connect

connect(): Promise<void>
Connects to the device.

Returns Promise<void>
A Promise that resolves when the connection is complete.
Inherited from SwitchbotDevice.connect
- Defined in src/device.ts:654

disconnect

disconnect(): Promise<void>
Disconnects from the device.

Returns Promise<void>
A Promise that resolves when the disconnection is complete.
Inherited from SwitchbotDevice.disconnect
- Defined in src/device.ts:793

discoverServices

discoverServices(): Promise<Service[]>
Discovers the device services.

Returns Promise<Service[]>
A Promise that resolves with the list of services.
Inherited from SwitchbotDevice.discoverServices
- Defined in src/device.ts:739

getCharacteristics

getCharacteristics(): Promise<Chars>
Retrieves the device characteristics.

Returns Promise<Chars>
A Promise that resolves with the device characteristics.
Inherited from SwitchbotDevice.getCharacteristics
- Defined in src/device.ts:697

getDeviceName

getDeviceName(): Promise<string>
Retrieves the device name.

Returns Promise<string>
A Promise that resolves with the device name.
Inherited from SwitchbotDevice.getDeviceName
- Defined in src/device.ts:823

internalConnect

internalConnect(): Promise<void>
Internal method to handle the connection process.

Returns Promise<void>
A Promise that resolves when the connection is complete.
Inherited from SwitchbotDevice.internalConnect
- Defined in src/device.ts:663

log

log(level: string, message: string): Promise<void>
Logs a message with the specified log level.
Parameters
- level: string
  The severity level of the log (e.g., 'info', 'warn', 'error').
- message: string
  The log message to be emitted.
Returns Promise<void>
Inherited from SwitchbotDevice.log
- Defined in src/device.ts:595

operateAirPurifier

operateAirPurifier(bytes: number[]): Promise<boolean>
Operates the air purifier with the given byte array.
Parameters
- bytes: number[]
  The byte array to send.
Returns Promise<boolean>
- Resolves with true if the operation was successful.
- Defined in src/device.ts:3881

setDeviceName

setDeviceName(name: string): Promise<void>
Sets the device name.
Parameters
- name: string
  The new device name.
Returns Promise<void>
A Promise that resolves when the name is set.
Inherited from SwitchbotDevice.setDeviceName
- Defined in src/device.ts:844

setMode

setMode(mode: number): Promise<boolean>
Sets the mode of the air purifier.
Parameters
- mode: number
  The mode value (1-4).
Returns Promise<boolean>
- Resolves with true if the operation was successful.
- Defined in src/device.ts:3868

setSpeed

setSpeed(speed: number): Promise<boolean>
Sets the speed of the air purifier.
Parameters
- speed: number
  The speed value (0-100).
Returns Promise<boolean>
- Resolves with true if the operation was successful.
- Defined in src/device.ts:3856

turnOff

turnOff(): Promise<boolean>
Turns the air purifier off.

Returns Promise<boolean>
- Resolves with true if the air purifier is turned off.
- Defined in src/device.ts:3847

turnOn

turnOn(): Promise<boolean>
Turns the air purifier on.

Returns Promise<boolean>
- Resolves with true if the air purifier is turned on.
- Defined in src/device.ts:3839

unsubscribeFromNotify

unsubscribeFromNotify(): Promise<void>
Unsubscribes from the notify characteristic.

Returns Promise<void>
A Promise that resolves when the unsubscription is complete.
Inherited from SwitchbotDevice.unsubscribeFromNotify
- Defined in src/device.ts:780

`Static`parseServiceData

parseServiceData(
    serviceData: null | Buffer<ArrayBufferLike>,
    manufacturerData: null | Buffer<ArrayBufferLike>,
    emitLog?: (level: string, message: string) => void,
): null | airPurifierServiceData
Parses service data for air purifier devices.
Parameters
- serviceData: null | Buffer<ArrayBufferLike>
  The service data buffer.
- manufacturerData: null | Buffer<ArrayBufferLike>
  The manufacturer data buffer.
- OptionalemitLog: (level: string, message: string) => void
  The function to emit log messages.
Returns null | airPurifierServiceData
- The parsed service data or null.
- Defined in src/device.ts:3760

Class WoAirPurifier

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns WoAirPurifier

Accessors

address

Returns string

connectionState

Returns string

friendlyName

Returns SwitchBotBLEModelFriendlyName

id

Returns string

model

Returns SwitchBotBLEModel

modelName

Returns SwitchBotBLEModelName

onConnectHandler

Returns () => Promise<void>

Parameters

Returns void

onDisconnectHandler

Returns () => Promise<void>

Parameters

Returns void

Methods

command

Parameters

Returns Promise<Buffer<ArrayBufferLike>>

connect

Returns Promise<void>

disconnect

Returns Promise<void>

discoverServices

Returns Promise<Service[]>

getCharacteristics

Returns Promise<Chars>

getDeviceName

Returns Promise<string>

internalConnect

Returns Promise<void>

log

Parameters

Returns Promise<void>

operateAirPurifier

Parameters

Returns Promise<boolean>

setDeviceName

Parameters

Returns Promise<void>

setMode

Parameters

Returns Promise<boolean>

setSpeed

Parameters

Returns Promise<boolean>

turnOff

Returns Promise<boolean>

turnOn

Returns Promise<boolean>

unsubscribeFromNotify

Returns Promise<void>

StaticparseServiceData

Parameters

Returns null | airPurifierServiceData

Settings

On This Page

`Static`parseServiceData