From 9eac6f1cd82f79c1782f3dbe8c6baa4126436e2f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 21 Aug 2025 05:08:41 +0000 Subject: [PATCH 1/3] Initial plan From e16e330e8c189c44763f8c5ef14e698ff1159ac4 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 21 Aug 2025 05:13:38 +0000 Subject: [PATCH 2/3] Initial exploration and analysis of node-switchbot codebase Co-authored-by: donavanbecker <9875439+donavanbecker@users.noreply.github.com> --- docs/classes/Advertising.html | 8 ++-- docs/classes/SwitchBotBLE.html | 16 +++---- docs/classes/SwitchBotOpenAPI.html | 14 +++--- docs/classes/SwitchbotDevice.html | 24 +++++----- docs/classes/WoBlindTilt.html | 42 ++++++++--------- docs/classes/WoBulb.html | 38 +++++++-------- docs/classes/WoCeilingLight.html | 44 +++++++++--------- docs/classes/WoContact.html | 26 +++++------ docs/classes/WoCurtain.html | 36 +++++++-------- docs/classes/WoHand.html | 36 +++++++-------- docs/classes/WoHub2.html | 26 +++++------ docs/classes/WoHumi.html | 40 ++++++++-------- docs/classes/WoHumi2.html | 40 ++++++++-------- docs/classes/WoIOSensorTH.html | 26 +++++------ docs/classes/WoKeypad.html | 26 +++++------ docs/classes/WoLeak.html | 26 +++++------ docs/classes/WoPlugMiniJP.html | 36 +++++++-------- docs/classes/WoPlugMiniUS.html | 36 +++++++-------- docs/classes/WoPresence.html | 26 +++++------ docs/classes/WoRelaySwitch1.html | 30 ++++++------ docs/classes/WoRelaySwitch1PM.html | 30 ++++++------ docs/classes/WoRemote.html | 26 +++++------ docs/classes/WoSensorTH.html | 24 +++++----- docs/classes/WoSensorTHPlus.html | 24 +++++----- docs/classes/WoSensorTHPro.html | 24 +++++----- docs/classes/WoSensorTHProCO2.html | 24 +++++----- docs/classes/WoSmartLock.html | 46 +++++++++---------- docs/classes/WoSmartLockPro.html | 46 +++++++++---------- docs/classes/WoStrip.html | 40 ++++++++-------- docs/enums/LogLevel.html | 4 +- docs/enums/SwitchBotBLEModel.html | 4 +- docs/enums/SwitchBotBLEModelFriendlyName.html | 4 +- docs/enums/SwitchBotBLEModelName.html | 4 +- docs/enums/SwitchBotModel.html | 4 +- docs/interfaces/AdvertisementData.html | 4 +- docs/interfaces/Chars.html | 4 +- docs/interfaces/ErrorObject.html | 4 +- docs/interfaces/NobleTypes.html | 4 +- docs/interfaces/Params.html | 4 +- docs/interfaces/Rule.html | 4 +- docs/interfaces/ServiceData.html | 4 +- docs/interfaces/SwitchBotBLEDevice.html | 4 +- docs/interfaces/WebhookDetail.html | 4 +- docs/interfaces/ad.html | 4 +- docs/interfaces/body.html | 4 +- docs/interfaces/bodyChange.html | 4 +- docs/interfaces/deleteWebhookResponse.html | 4 +- docs/interfaces/device.html | 4 +- docs/interfaces/deviceList.html | 4 +- docs/interfaces/deviceStatus.html | 4 +- docs/interfaces/deviceStatusRequest.html | 4 +- docs/interfaces/deviceWebhook.html | 4 +- docs/interfaces/deviceWebhookContext.html | 4 +- docs/interfaces/devices.html | 4 +- docs/interfaces/infraredRemoteList.html | 4 +- docs/interfaces/irdevice.html | 4 +- docs/interfaces/pushResponse.html | 4 +- docs/interfaces/queryWebhookResponse.html | 4 +- docs/interfaces/setupWebhookResponse.html | 4 +- docs/interfaces/switchbot.html | 4 +- docs/interfaces/updateWebhookResponse.html | 4 +- docs/interfaces/webhookRequest.html | 4 +- docs/types/MacAddress.html | 2 +- docs/types/batteryCirculatorFan.html | 2 +- .../batteryCirculatorFanServiceData.html | 2 +- docs/types/batteryCirculatorFanStatus.html | 2 +- .../batteryCirculatorFanWebhookContext.html | 2 +- docs/types/blindTilt.html | 2 +- docs/types/blindTiltServiceData.html | 2 +- docs/types/blindTiltStatus.html | 2 +- docs/types/blindTiltWebhookContext.html | 2 +- docs/types/bot.html | 2 +- docs/types/botServiceData.html | 2 +- docs/types/botStatus.html | 2 +- docs/types/botWebhookContext.html | 2 +- docs/types/ceilingLight.html | 2 +- docs/types/ceilingLightPro.html | 2 +- docs/types/ceilingLightProServiceData.html | 2 +- docs/types/ceilingLightProStatus.html | 2 +- docs/types/ceilingLightProWebhookContext.html | 2 +- docs/types/ceilingLightServiceData.html | 2 +- docs/types/ceilingLightStatus.html | 2 +- docs/types/ceilingLightWebhookContext.html | 2 +- docs/types/circulatorFanStatus.html | 2 +- docs/types/circulatorFanWebhookContext.html | 2 +- docs/types/colorBulb.html | 2 +- docs/types/colorBulbServiceData.html | 2 +- docs/types/colorBulbStatus.html | 2 +- docs/types/colorBulbWebhookContext.html | 2 +- docs/types/contactSensor.html | 2 +- docs/types/contactSensorServiceData.html | 2 +- docs/types/contactSensorStatus.html | 2 +- docs/types/contactSensorWebhookContext.html | 2 +- docs/types/curtain.html | 2 +- docs/types/curtain3.html | 2 +- docs/types/curtain3ServiceData.html | 2 +- docs/types/curtain3WebhookContext.html | 2 +- docs/types/curtainServiceData.html | 2 +- docs/types/curtainStatus.html | 2 +- docs/types/curtainWebhookContext.html | 2 +- docs/types/floorCleaningRobotS10.html | 2 +- docs/types/floorCleaningRobotS10Status.html | 2 +- .../floorCleaningRobotS10WebhookContext.html | 2 +- docs/types/hub2.html | 2 +- docs/types/hub2ServiceData.html | 2 +- docs/types/hub2Status.html | 2 +- docs/types/hub2WebhookContext.html | 2 +- docs/types/humidifier.html | 2 +- docs/types/humidifier2ServiceData.html | 2 +- docs/types/humidifier2Status.html | 2 +- docs/types/humidifier2WebhookContext.html | 2 +- docs/types/humidifierServiceData.html | 2 +- docs/types/humidifierStatus.html | 2 +- docs/types/humidifierWebhookContext.html | 2 +- docs/types/indoorCam.html | 2 +- docs/types/indoorCameraWebhookContext.html | 2 +- docs/types/keypad.html | 2 +- docs/types/keypadDetectorServiceData.html | 2 +- docs/types/keypadTouch.html | 2 +- docs/types/keypadTouchWebhookContext.html | 2 +- docs/types/keypadWebhookContext.html | 2 +- docs/types/lock.html | 2 +- docs/types/lockPro.html | 2 +- docs/types/lockProServiceData.html | 2 +- docs/types/lockProStatus.html | 2 +- docs/types/lockProWebhookContext.html | 2 +- docs/types/lockServiceData.html | 2 +- docs/types/lockStatus.html | 2 +- docs/types/lockWebhookContext.html | 2 +- docs/types/meter.html | 2 +- docs/types/meterPlus.html | 2 +- docs/types/meterPlusServiceData.html | 2 +- docs/types/meterPlusStatus.html | 2 +- docs/types/meterPlusWebhookContext.html | 2 +- docs/types/meterPro.html | 2 +- docs/types/meterProCO2ServiceData.html | 2 +- docs/types/meterProCO2Status.html | 2 +- docs/types/meterProCO2WebhookContext.html | 2 +- docs/types/meterProServiceData.html | 2 +- docs/types/meterProStatus.html | 2 +- docs/types/meterProWebhookContext.html | 2 +- docs/types/meterServiceData.html | 2 +- docs/types/meterStatus.html | 2 +- docs/types/meterWebhookContext.html | 2 +- docs/types/motionSensor.html | 2 +- docs/types/motionSensorServiceData.html | 2 +- docs/types/motionSensorStatus.html | 2 +- docs/types/motionSensorWebhookContext.html | 2 +- docs/types/onadvertisement.html | 2 +- docs/types/ondiscover.html | 2 +- docs/types/outdoorMeter.html | 2 +- docs/types/outdoorMeterServiceData.html | 2 +- docs/types/outdoorMeterStatus.html | 2 +- docs/types/outdoorMeterWebhookContext.html | 2 +- docs/types/panTiltCamWebhookContext.html | 2 +- docs/types/pantiltCam.html | 2 +- docs/types/pantiltCam2k.html | 2 +- docs/types/plug.html | 2 +- docs/types/plugMini.html | 2 +- docs/types/plugMiniJPServiceData.html | 2 +- docs/types/plugMiniJPWebhookContext.html | 2 +- docs/types/plugMiniStatus.html | 2 +- docs/types/plugMiniUSServiceData.html | 2 +- docs/types/plugMiniUSWebhookContext.html | 2 +- docs/types/plugStatus.html | 2 +- docs/types/plugWebhookContext.html | 2 +- docs/types/relaySwitch1Context.html | 2 +- docs/types/relaySwitch1PMContext.html | 2 +- docs/types/relaySwitch1PMServiceData.html | 2 +- docs/types/relaySwitch1PMStatus.html | 2 +- docs/types/relaySwitch1ServiceData.html | 2 +- docs/types/relaySwitch1Status.html | 2 +- docs/types/remote.html | 2 +- docs/types/remoteServiceData.html | 2 +- docs/types/robotVacuumCleanerS1.html | 2 +- docs/types/robotVacuumCleanerS1Plus.html | 2 +- .../types/robotVacuumCleanerS1PlusStatus.html | 2 +- ...obotVacuumCleanerS1PlusWebhookContext.html | 2 +- docs/types/robotVacuumCleanerS1Status.html | 2 +- .../robotVacuumCleanerS1WebhookContext.html | 2 +- docs/types/robotVacuumCleanerServiceData.html | 2 +- docs/types/stripLight.html | 2 +- docs/types/stripLightServiceData.html | 2 +- docs/types/stripLightStatus.html | 2 +- docs/types/stripLightWebhookContext.html | 2 +- docs/types/waterLeakDetector.html | 2 +- docs/types/waterLeakDetectorServiceData.html | 2 +- docs/types/waterLeakDetectorStatus.html | 2 +- .../waterLeakDetectorWebhookContext.html | 2 +- 189 files changed, 633 insertions(+), 633 deletions(-) diff --git a/docs/classes/Advertising.html b/docs/classes/Advertising.html index 8e7c0ec6..1fb9f92f 100644 --- a/docs/classes/Advertising.html +++ b/docs/classes/Advertising.html @@ -1,8 +1,8 @@ Advertising | node-switchbot

Class Advertising

Represents the advertising data parser for SwitchBot devices.

-

Constructors

constructor +

Constructors

constructor

Methods

parse parseServiceData -

Constructors

constructor

Methods

Staticparse

  • parse(
        peripheral: Peripheral,
        emitLog: (level: string, message: string) => void,
    ): Promise<null | ad>

    Parses the advertisement data coming from SwitchBot device.

    +

Constructors

constructor

Methods

Staticparse

  • parse(
        peripheral: Peripheral,
        emitLog: (level: string, message: string) => void,
    ): Promise<null | ad>

    Parses the advertisement data coming from SwitchBot device.

    This function processes advertising packets received from SwitchBot devices and extracts relevant information based on the device type.

    Parameters

    • peripheral: Peripheral

      The peripheral device object from noble.

      @@ -10,7 +10,7 @@

    Returns Promise<null | ad>

    • An object containing parsed data specific to the SwitchBot device type, or null if the device is not recognized.
    -

StaticparseServiceData

  • parseServiceData(
        model: string,
        serviceData: Buffer,
        manufacturerData: Buffer,
        emitLog: (level: string, message: string) => void,
    ): Promise<any>

    Parses the service data based on the device model.

    +

StaticparseServiceData

  • parseServiceData(
        model: string,
        serviceData: Buffer,
        manufacturerData: Buffer,
        emitLog: (level: string, message: string) => void,
    ): Promise<any>

    Parses the service data based on the device model.

    Parameters

    • model: string

      The device model.

    • serviceData: Buffer

      The service data buffer.

    • manufacturerData: Buffer

      The manufacturer data buffer.

      @@ -18,4 +18,4 @@

    Returns Promise<any>

    • The parsed service data.
    -

Settings

Member Visibility

On This Page

Constructors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/SwitchBotBLE.html b/docs/classes/SwitchBotBLE.html index 340f36b4..9051f50c 100644 --- a/docs/classes/SwitchBotBLE.html +++ b/docs/classes/SwitchBotBLE.html @@ -1,5 +1,5 @@ SwitchBotBLE | node-switchbot

Class SwitchBotBLE

SwitchBotBLE class to interact with SwitchBot devices.

-

Hierarchy

  • EventEmitter
    • SwitchBotBLE

Constructors

constructor +

Hierarchy

  • EventEmitter
    • SwitchBotBLE

Constructors

constructor

Properties

noble onadvertisement? ondiscover? @@ -12,30 +12,30 @@ wait

Constructors

constructor

Properties

noble

noble: any

Optionalonadvertisement

onadvertisement?: onadvertisement

Optionalondiscover

ondiscover?: ondiscover

ready

ready: Promise<void>

Methods

discover

Returns SwitchBotBLE

Properties

noble

noble: any

Optionalonadvertisement

onadvertisement?: onadvertisement

Optionalondiscover

ondiscover?: ondiscover

ready

ready: Promise<void>

Methods

discover

log

  • log(level: string, message: string): Promise<void>

    Emits a log event with the specified log level and message.

    +

log

  • log(level: string, message: string): Promise<void>

    Emits a log event with the specified log level and message.

    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>

startScan

  • startScan(params?: Params): Promise<void>

    Starts scanning for SwitchBot devices.

    +

Returns Promise<void>

startScan

stopScan

stopScan

validate

validate

wait

wait

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/SwitchBotOpenAPI.html b/docs/classes/SwitchBotOpenAPI.html index 74770b36..1531680e 100644 --- a/docs/classes/SwitchBotOpenAPI.html +++ b/docs/classes/SwitchBotOpenAPI.html @@ -5,7 +5,7 @@

Param: token

The API token used for authentication.

Param: secret

The secret key used for signing requests.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

webhookEventListener?

Methods

controlDevice deleteWebhook @@ -15,7 +15,7 @@

Constructors

constructor

  • new SwitchBotOpenAPI(
        token: string,
        secret: string,
        hostname?: string,
    ): SwitchBotOpenAPI

    Creates an instance of the SwitchBot OpenAPI client.

    Parameters

    • token: string

      The API token used for authentication.

    • secret: string

      The secret key used for signing requests.

      -
    • Optionalhostname: string

    Returns SwitchBotOpenAPI

Properties

OptionalwebhookEventListener

webhookEventListener?:
    | null
    | Server<typeof IncomingMessage, typeof ServerResponse> = null

Methods

controlDevice

  • controlDevice(
        deviceId: string,
        command: string,
        parameter: string,
        commandType?: string,
        token?: string,
        secret?: string,
    ): Promise<{ response: { commandId: string }; statusCode: number }>

    Controls a device by sending a command to the SwitchBot API.

    +
  • Optionalhostname: string

Returns SwitchBotOpenAPI

Properties

OptionalwebhookEventListener

webhookEventListener?:
    | null
    | Server<typeof IncomingMessage, typeof ServerResponse> = null

Methods

controlDevice

  • controlDevice(
        deviceId: string,
        command: string,
        parameter: string,
        commandType?: string,
        token?: string,
        secret?: string,
    ): Promise<{ response: { commandId: string }; statusCode: number }>

    Controls a device by sending a command to the SwitchBot API.

    Parameters

    • deviceId: string

      The ID of the device to control.

    • command: string

      The command to send to the device.

    • parameter: string

      The parameter for the command.

      @@ -24,24 +24,24 @@
    • Optionalsecret: string

      (Optional) The secret used for authentication. If not provided, the instance secret will be used.

    Returns Promise<{ response: { commandId: string }; statusCode: number }>

    A promise that resolves to an object containing the response body and status code.

    Throws

    An error if the device control fails.

    -

deleteWebhook

  • deleteWebhook(url: string, token?: string, secret?: string): Promise<void>

    Deletes a webhook by sending a request to the specified URL.

    +

deleteWebhook

  • deleteWebhook(url: string, token?: string, secret?: string): Promise<void>

    Deletes a webhook by sending a request to the specified URL.

    Parameters

    • url: string

      The URL of the webhook to be deleted.

    • Optionaltoken: string

      (Optional) The token used for authentication. If not provided, the instance token will be used.

    • Optionalsecret: string

      (Optional) The secret used for authentication. If not provided, the instance secret will be used.

    Returns Promise<void>

    A promise that resolves when the webhook is successfully deleted.

    Throws

    Will log an error if the deletion fails.

    -

getDevices

  • getDevices(
        token?: string,
        secret?: string,
    ): Promise<{ response: devices; statusCode: number }>

    Retrieves the list of devices from the SwitchBot OpenAPI.

    +

getDevices

  • getDevices(
        token?: string,
        secret?: string,
    ): Promise<{ response: devices; statusCode: number }>

    Retrieves the list of devices from the SwitchBot OpenAPI.

    Parameters

    • Optionaltoken: string

      (Optional) The token used for authentication. If not provided, the instance token will be used.

    • Optionalsecret: string

      (Optional) The secret used for authentication. If not provided, the instance secret will be used.

    Returns Promise<{ response: devices; statusCode: number }>

    A promise that resolves to an object containing the API response.

    Throws

    Throws an error if the request to get devices fails.

    -

getDeviceStatus

  • getDeviceStatus(
        deviceId: string,
        token?: string,
        secret?: string,
    ): Promise<{ response: deviceStatus; statusCode: number }>

    Retrieves the status of a specific device.

    +

getDeviceStatus

  • getDeviceStatus(
        deviceId: string,
        token?: string,
        secret?: string,
    ): Promise<{ response: deviceStatus; statusCode: number }>

    Retrieves the status of a specific device.

    Parameters

    • deviceId: string

      The unique identifier of the device.

    • Optionaltoken: string

      (Optional) The token used for authentication. If not provided, the instance token will be used.

    • Optionalsecret: string

      (Optional) The secret used for authentication. If not provided, the instance secret will be used.

    Returns Promise<{ response: deviceStatus; statusCode: number }>

    A promise that resolves to an object containing the device status and the status code of the request.

    Throws

    An error if the request fails.

    -

setupWebhook

  • setupWebhook(url: string, token?: string, secret?: string): Promise<void>

    Sets up a webhook listener and configures the webhook on the server.

    +

setupWebhook

  • setupWebhook(url: string, token?: string, secret?: string): Promise<void>

    Sets up a webhook listener and configures the webhook on the server.

    This method performs the following steps:

    1. Creates a local server to listen for incoming webhook events.
      2. @@ -54,4 +54,4 @@
  • Optionalsecret: string

    (Optional) The secret used for authentication. If not provided, the instance secret will be used.

Returns Promise<void>

A promise that resolves when the webhook setup is complete.

Throws

Will log an error if any step in the webhook setup process fails.

-

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/classes/SwitchbotDevice.html b/docs/classes/SwitchbotDevice.html index e4f19dcf..4663ca7a 100644 --- a/docs/classes/SwitchbotDevice.html +++ b/docs/classes/SwitchbotDevice.html @@ -1,5 +1,5 @@ SwitchbotDevice | node-switchbot

Class SwitchbotDevice

Represents a Switchbot Device.

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Accessors

address connectionState friendlyName @@ -21,27 +21,27 @@

Constructors

constructor

  • new SwitchbotDevice(peripheral: Peripheral, noble: __module): SwitchbotDevice

    Initializes a new instance of the SwitchbotDevice class.

    Parameters

    • peripheral: Peripheral

      The peripheral object from noble.

    • noble: __module

      The Noble object.

      -

    Returns SwitchbotDevice

Accessors

address

connectionState

  • get connectionState(): string

    Returns string

friendlyName

id

model

modelName

onConnectHandler

  • get onConnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onConnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onDisconnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

Methods

command

  • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

    Sends a command to the device and awaits a response.

    +

Returns SwitchbotDevice

Accessors

address

connectionState

  • get connectionState(): string

    Returns string

friendlyName

id

model

modelName

onConnectHandler

  • get onConnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onConnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onDisconnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

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.

    -

connect

  • connect(): Promise<void>

    Connects to the device.

    +

connect

  • connect(): Promise<void>

    Connects to the device.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

    -

disconnect

  • disconnect(): Promise<void>

    Disconnects from the device.

    +

disconnect

  • disconnect(): Promise<void>

    Disconnects from the device.

    Returns Promise<void>

    A Promise that resolves when the disconnection is complete.

    -

discoverServices

  • discoverServices(): Promise<Service[]>

    Discovers the device services.

    +

discoverServices

  • discoverServices(): Promise<Service[]>

    Discovers the device services.

    Returns Promise<Service[]>

    A Promise that resolves with the list of services.

    -

getCharacteristics

  • getCharacteristics(): Promise<Chars>

    Retrieves the device characteristics.

    +

getCharacteristics

  • getCharacteristics(): Promise<Chars>

    Retrieves the device characteristics.

    Returns Promise<Chars>

    A Promise that resolves with the device characteristics.

    -

getDeviceName

  • getDeviceName(): Promise<string>

    Retrieves the device name.

    +

getDeviceName

  • getDeviceName(): Promise<string>

    Retrieves the device name.

    Returns Promise<string>

    A Promise that resolves with the device name.

    -

internalConnect

  • internalConnect(): Promise<void>

    Internal method to handle the connection process.

    +

internalConnect

  • internalConnect(): Promise<void>

    Internal method to handle the connection process.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

    -

log

  • log(level: string, message: string): Promise<void>

    Logs a message with the specified log level.

    +

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>

setDeviceName

  • setDeviceName(name: string): Promise<void>

    Sets the device name.

    +

Returns Promise<void>

setDeviceName

unsubscribeFromNotify

unsubscribeFromNotify

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/docs/classes/WoBlindTilt.html b/docs/classes/WoBlindTilt.html index c9b4ded1..2881175b 100644 --- a/docs/classes/WoBlindTilt.html +++ b/docs/classes/WoBlindTilt.html @@ -1,6 +1,6 @@ WoBlindTilt | node-switchbot

Class WoBlindTilt

Class representing a WoBlindTilt device.

See

https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/curtain.md

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Accessors

address connectionState friendlyName @@ -28,46 +28,46 @@ setDeviceName unsubscribeFromNotify parseServiceData -

Constructors

constructor

Accessors

address

  • get address(): string

    Returns string

connectionState

  • get connectionState(): string

    Returns string

friendlyName

id

  • get id(): string

    Returns string

model

modelName

onConnectHandler

  • get onConnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onConnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onDisconnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

Methods

close

  • close(): Promise<void>

    Closes the blind tilt to the nearest endpoint.

    -

    Returns Promise<void>

closeDown

  • closeDown(): Promise<void>

    Closes the blind tilt down to the nearest endpoint.

    -

    Returns Promise<void>

closeUp

  • closeUp(): Promise<void>

    Closes the blind tilt up to the nearest endpoint.

    -

    Returns Promise<void>

command

  • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

    Sends a command to the device and awaits a response.

    +

Constructors

constructor

Accessors

address

  • get address(): string

    Returns string

connectionState

  • get connectionState(): string

    Returns string

friendlyName

id

  • get id(): string

    Returns string

model

modelName

onConnectHandler

  • get onConnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onConnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onDisconnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

Methods

close

  • close(): Promise<void>

    Closes the blind tilt to the nearest endpoint.

    +

    Returns Promise<void>

closeDown

  • closeDown(): Promise<void>

    Closes the blind tilt down to the nearest endpoint.

    +

    Returns Promise<void>

closeUp

  • closeUp(): Promise<void>

    Closes the blind tilt up to the nearest endpoint.

    +

    Returns Promise<void>

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.

    -

connect

connect

  • connect(): Promise<void>

    Connects to the device.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

    -

disconnect

disconnect

  • disconnect(): Promise<void>

    Disconnects from the device.

    Returns Promise<void>

    A Promise that resolves when the disconnection is complete.

    -

discoverServices

discoverServices

getBasicInfo

getBasicInfo

  • getBasicInfo(): Promise<null | object>

    Retrieves the basic information of the blind tilt.

    Returns Promise<null | object>

    • A promise that resolves to an object containing the basic information of the blind tilt.
    -

getCharacteristics

  • getCharacteristics(): Promise<Chars>

    Retrieves the device characteristics.

    +

getCharacteristics

getDeviceName

getDeviceName

getPosition

getPosition

  • getPosition(): Promise<number>

    Retrieves the current position of the blind tilt.

    Returns Promise<number>

    • The current position of the blind tilt (0-100).
    -

internalConnect

  • internalConnect(): Promise<void>

    Internal method to handle the connection process.

    +

internalConnect

  • internalConnect(): Promise<void>

    Internal method to handle the connection process.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

    -

log

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>

open

  • open(): Promise<void>

    Opens the blind tilt to the fully open position.

    -

    Returns Promise<void>

pause

  • pause(): Promise<void>

    Pauses the blind tilt operation.

    -

    Returns Promise<void>

runToPos

  • runToPos(percent: number, mode: number): Promise<void>

    Runs the blind tilt to the specified position.

    +

Returns Promise<void>

open

pause

runToPos

setDeviceName

Returns Promise<void>

setDeviceName

unsubscribeFromNotify

unsubscribeFromNotify

StaticparseServiceData

StaticparseServiceData

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/docs/classes/WoBulb.html b/docs/classes/WoBulb.html index 46dbc4af..62dd84d0 100644 --- a/docs/classes/WoBulb.html +++ b/docs/classes/WoBulb.html @@ -1,6 +1,6 @@ WoBulb | node-switchbot

Class WoBulb

Class representing a WoBulb device.

See

https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/colorbulb.md

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Accessors

address connectionState friendlyName @@ -26,42 +26,42 @@ turnOn unsubscribeFromNotify parseServiceData -

Constructors

constructor

Accessors

address

  • get address(): string

    Returns string

connectionState

  • get connectionState(): string

    Returns string

friendlyName

id

  • get id(): string

    Returns string

model

modelName

onConnectHandler

  • get onConnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onConnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onDisconnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

Methods

command

  • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

    Sends a command to the device and awaits a response.

    +

Constructors

constructor

Accessors

address

  • get address(): string

    Returns string

connectionState

  • get connectionState(): string

    Returns string

friendlyName

id

  • get id(): string

    Returns string

model

modelName

onConnectHandler

  • get onConnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onConnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onDisconnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

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.

    -

connect

connect

  • connect(): Promise<void>

    Connects to the device.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

    -

disconnect

disconnect

  • disconnect(): Promise<void>

    Disconnects from the device.

    Returns Promise<void>

    A Promise that resolves when the disconnection is complete.

    -

discoverServices

discoverServices

getCharacteristics

getCharacteristics

getDeviceName

getDeviceName

internalConnect

internalConnect

  • internalConnect(): Promise<void>

    Internal method to handle the connection process.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

    -

log

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>

readState

  • readState(): Promise<boolean>

    Reads the state of the bulb.

    +

Returns Promise<void>

readState

setBrightness

setBrightness

setColorTemperature

setColorTemperature

setDeviceName

setDeviceName

setRGB

setRGB

turnOff

turnOff

turnOn

turnOn

unsubscribeFromNotify

unsubscribeFromNotify

StaticparseServiceData

StaticparseServiceData

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/docs/classes/WoCeilingLight.html b/docs/classes/WoCeilingLight.html index c1e58d0c..e4d432f0 100644 --- a/docs/classes/WoCeilingLight.html +++ b/docs/classes/WoCeilingLight.html @@ -1,6 +1,6 @@ WoCeilingLight | node-switchbot

Class WoCeilingLight

Class representing a WoCeilingLight device.

See

https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/colorbulb.md

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Accessors

address connectionState friendlyName @@ -29,47 +29,47 @@ unsubscribeFromNotify parseServiceData parseServiceData_Pro -

Constructors

constructor

Accessors

address

  • get address(): string

    Returns string

connectionState

  • get connectionState(): string

    Returns string

friendlyName

id

  • get id(): string

    Returns string

model

modelName

onConnectHandler

  • get onConnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onConnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onDisconnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

Methods

command

  • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

    Sends a command to the device and awaits a response.

    +

Constructors

constructor

Accessors

address

  • get address(): string

    Returns string

connectionState

  • get connectionState(): string

    Returns string

friendlyName

id

  • get id(): string

    Returns string

model

modelName

onConnectHandler

  • get onConnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onConnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onDisconnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

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.

    -

connect

connect

  • connect(): Promise<void>

    Connects to the device.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

    -

disconnect

disconnect

  • disconnect(): Promise<void>

    Disconnects from the device.

    Returns Promise<void>

    A Promise that resolves when the disconnection is complete.

    -

discoverServices

discoverServices

getCharacteristics

getCharacteristics

getDeviceName

getDeviceName

internalConnect

internalConnect

  • internalConnect(): Promise<void>

    Internal method to handle the connection process.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

    -

log

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>

operateCeilingLight

  • operateCeilingLight(bytes: number[]): Promise<boolean>

    Sends a command to the ceiling light.

    +

Returns Promise<void>

operateCeilingLight

readState

readState

setBrightness

setBrightness

setColorTemperature

setColorTemperature

setDeviceName

setDeviceName

setRGB

setRGB

setState

setState

turnOff

turnOff

turnOn

turnOn

unsubscribeFromNotify

unsubscribeFromNotify

StaticparseServiceData

StaticparseServiceData

StaticparseServiceData_Pro

StaticparseServiceData_Pro

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/docs/classes/WoContact.html b/docs/classes/WoContact.html index 58684c4b..3a647d2a 100644 --- a/docs/classes/WoContact.html +++ b/docs/classes/WoContact.html @@ -1,6 +1,6 @@ WoContact | node-switchbot

Class WoContact

Class representing a WoContact device.

See

https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/contactsensor.md

-

Hierarchy (View Summary)

Constructors

constructor +

Hierarchy (View Summary)

Constructors

constructor

Accessors

address connectionState friendlyName @@ -20,33 +20,33 @@ setDeviceName unsubscribeFromNotify parseServiceData -

Constructors

constructor

Accessors

address

  • get address(): string

    Returns string

connectionState

  • get connectionState(): string

    Returns string

friendlyName

id

  • get id(): string

    Returns string

model

modelName

onConnectHandler

  • get onConnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onConnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onDisconnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

Methods

command

  • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

    Sends a command to the device and awaits a response.

    +

Constructors

constructor

Accessors

address

  • get address(): string

    Returns string

connectionState

  • get connectionState(): string

    Returns string

friendlyName

id

  • get id(): string

    Returns string

model

modelName

onConnectHandler

  • get onConnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onConnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

onDisconnectHandler

  • get onDisconnectHandler(): () => Promise<void>

    Returns () => Promise<void>

  • set onDisconnectHandler(func: () => Promise<void>): void

    Parameters

    • func: () => Promise<void>

    Returns void

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.

    -

connect

connect

  • connect(): Promise<void>

    Connects to the device.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

    -

disconnect

disconnect

  • disconnect(): Promise<void>

    Disconnects from the device.

    Returns Promise<void>

    A Promise that resolves when the disconnection is complete.

    -

discoverServices

discoverServices

getCharacteristics

getCharacteristics

getDeviceName

getDeviceName

internalConnect

internalConnect

  • internalConnect(): Promise<void>

    Internal method to handle the connection process.

    Returns Promise<void>

    A Promise that resolves when the connection is complete.

    -

log

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>

setDeviceName

  • setDeviceName(name: string): Promise<void>

    Sets the device name.

    +

Returns Promise<void>

setDeviceName

unsubscribeFromNotify

unsubscribeFromNotify

StaticparseServiceData

StaticparseServiceData

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/docs/classes/WoCurtain.html b/docs/classes/WoCurtain.html index 35b620e1..bff50386 100644 --- a/docs/classes/WoCurtain.html +++ b/docs/classes/WoCurtain.html @@ -3,7 +3,7 @@
  • https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/curtain.md
  • https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/curtain3.md
    • -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -28,40 +28,40 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    close

    • close(mode?: number): Promise<void>

      Closes the curtain.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    close

    • close(mode?: number): Promise<void>

      Closes the curtain.

      Parameters

      • Optionalmode: number = 0xFF

        Running mode (0x01 = QuietDrift, 0xFF = Default).

        -

      Returns Promise<void>

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Returns Promise<void>

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    open

    • open(mode?: number): Promise<void>

      Opens the curtain.

      +

    Returns Promise<void>

    open

    • open(mode?: number): Promise<void>

      Opens the curtain.

      Parameters

      • Optionalmode: number = 0xFF

        Running mode (0x01 = QuietDrift, 0xFF = Default).

        -

      Returns Promise<void>

    operateCurtain

    • operateCurtain(bytes: number[]): Promise<void>

      Sends a command to the curtain.

      +

    Returns Promise<void>

    operateCurtain

    • operateCurtain(bytes: number[]): Promise<void>

      Sends a command to the curtain.

      Parameters

      • bytes: number[]

        The command bytes.

        -

      Returns Promise<void>

    pause

    • pause(): Promise<void>

      Pauses the curtain.

      -

      Returns Promise<void>

    runToPos

    • runToPos(percent: number, mode?: number): Promise<void>

      Runs the curtain to the target position.

      +

    Returns Promise<void>

    pause

    • pause(): Promise<void>

      Pauses the curtain.

      +

      Returns Promise<void>

    runToPos

    • runToPos(percent: number, mode?: number): Promise<void>

      Runs the curtain to the target position.

      Parameters

      • percent: number

        The percentage of the target position.

      • Optionalmode: number = 0xFF

        Running mode (0x01 = QuietDrift, 0xFF = Default).

        -

      Returns Promise<void>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    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.

      -

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    • parseServiceData(
          serviceData: Buffer,
          manufacturerData: Buffer,
          emitLog: (level: string, message: string) => void,
          reverse?: boolean,
      ): Promise<null | curtainServiceData | curtain3ServiceData>

      Parses the service data for WoCurtain.

      Parameters

      • serviceData: Buffer

        The service data buffer.

      • manufacturerData: Buffer

        The manufacturer data buffer.

      • emitLog: (level: string, message: string) => void

        The function to emit log messages.

        @@ -69,4 +69,4 @@

      Returns Promise<null | curtainServiceData | curtain3ServiceData>

      • Parsed service data or null if invalid.
      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoHand.html b/docs/classes/WoHand.html index 467ba27c..5d73c2d2 100644 --- a/docs/classes/WoHand.html +++ b/docs/classes/WoHand.html @@ -1,6 +1,6 @@ WoHand | node-switchbot

    Class WoHand

    Class representing a WoHand device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/bot.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -25,38 +25,38 @@ unsubscribeFromNotify up parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    down

    • down(): Promise<void>

      Moves the bot down.

      -

      Returns Promise<void>

    getCharacteristics

    down

    • down(): Promise<void>

      Moves the bot down.

      +

      Returns Promise<void>

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    press

    • press(): Promise<void>

      Presses the bot.

      -

      Returns Promise<void>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    press

    setDeviceName

    turnOff

    turnOn

    unsubscribeFromNotify

    turnOff

    turnOn

    unsubscribeFromNotify

    up

    StaticparseServiceData

    up

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoHub2.html b/docs/classes/WoHub2.html index ee7100f4..951c71e3 100644 --- a/docs/classes/WoHub2.html +++ b/docs/classes/WoHub2.html @@ -1,6 +1,6 @@ WoHub2 | node-switchbot

    Class WoHub2

    Class representing a WoHub2 device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,33 +20,33 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoHumi.html b/docs/classes/WoHumi.html index bda304cb..128649e2 100644 --- a/docs/classes/WoHumi.html +++ b/docs/classes/WoHumi.html @@ -1,6 +1,6 @@ WoHumi | node-switchbot

    Class WoHumi

    Class representing a WoHumi device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/tree/latest/devicetypes

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -27,41 +27,41 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    decrease

    • decrease(): Promise<void>

      Decreases the humidifier setting.

      -

      Returns Promise<void>

    disconnect

    decrease

    • decrease(): Promise<void>

      Decreases the humidifier setting.

      +

      Returns Promise<void>

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    increase

    • increase(): Promise<void>

      Increases the humidifier setting.

      -

      Returns Promise<void>

    internalConnect

    increase

    • increase(): Promise<void>

      Increases the humidifier setting.

      +

      Returns Promise<void>

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    percentage

    • percentage(level: number): Promise<void>

      Sets the humidifier level.

      +

    Returns Promise<void>

    percentage

    setAutoMode

    setDeviceName

    Returns Promise<void>

    setAutoMode

    setDeviceName

    setManualMode

    turnOff

    turnOn

    unsubscribeFromNotify

    setManualMode

    turnOff

    turnOn

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoHumi2.html b/docs/classes/WoHumi2.html index b70ebf43..93bdd775 100644 --- a/docs/classes/WoHumi2.html +++ b/docs/classes/WoHumi2.html @@ -1,6 +1,6 @@ WoHumi2 | node-switchbot

    Class WoHumi2

    Class representing a WoHumi device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/tree/latest/devicetypes

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -27,41 +27,41 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    decrease

    • decrease(): Promise<void>

      Decreases the humidifier setting.

      -

      Returns Promise<void>

    disconnect

    decrease

    • decrease(): Promise<void>

      Decreases the humidifier setting.

      +

      Returns Promise<void>

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    increase

    • increase(): Promise<void>

      Increases the humidifier setting.

      -

      Returns Promise<void>

    internalConnect

    increase

    • increase(): Promise<void>

      Increases the humidifier setting.

      +

      Returns Promise<void>

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    percentage

    • percentage(level: number): Promise<void>

      Sets the humidifier level.

      +

    Returns Promise<void>

    percentage

    setAutoMode

    setDeviceName

    Returns Promise<void>

    setAutoMode

    setDeviceName

    setManualMode

    turnOff

    turnOn

    unsubscribeFromNotify

    setManualMode

    turnOff

    turnOn

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoIOSensorTH.html b/docs/classes/WoIOSensorTH.html index e3a3dfc7..a7d6e9f0 100644 --- a/docs/classes/WoIOSensorTH.html +++ b/docs/classes/WoIOSensorTH.html @@ -1,6 +1,6 @@ WoIOSensorTH | node-switchbot

    Class WoIOSensorTH

    Class representing a WoIOSensorTH device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md#outdoor-temperaturehumidity-sensor

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,34 +20,34 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoKeypad.html b/docs/classes/WoKeypad.html index e12b4bbc..16354c01 100644 --- a/docs/classes/WoKeypad.html +++ b/docs/classes/WoKeypad.html @@ -1,5 +1,5 @@ WoKeypad | node-switchbot

    Class WoKeypad

    Class representing a WoKeypad device.

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -19,34 +19,34 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoLeak.html b/docs/classes/WoLeak.html index de4aa539..bd5d63f2 100644 --- a/docs/classes/WoLeak.html +++ b/docs/classes/WoLeak.html @@ -1,6 +1,6 @@ WoLeak | node-switchbot

    Class WoLeak

    Class representing a WoLeak device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md#outdoor-temperaturehumidity-sensor

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,34 +20,34 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoPlugMiniJP.html b/docs/classes/WoPlugMiniJP.html index 033d61c2..a4cfebcd 100644 --- a/docs/classes/WoPlugMiniJP.html +++ b/docs/classes/WoPlugMiniJP.html @@ -1,6 +1,6 @@ WoPlugMiniJP | node-switchbot

    Class WoPlugMiniJP

    Class representing a WoPlugMini device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/plugmini.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -25,54 +25,54 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    operatePlug

    • operatePlug(bytes: number[]): Promise<boolean>

      Operates the plug with the given bytes.

      +

    Returns Promise<void>

    operatePlug

    readState

    readState

    setDeviceName

    setDeviceName

    toggle

    toggle

    turnOff

    turnOff

    turnOn

    turnOn

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoPlugMiniUS.html b/docs/classes/WoPlugMiniUS.html index 3b8ebca5..8bc5179f 100644 --- a/docs/classes/WoPlugMiniUS.html +++ b/docs/classes/WoPlugMiniUS.html @@ -1,6 +1,6 @@ WoPlugMiniUS | node-switchbot

    Class WoPlugMiniUS

    Class representing a WoPlugMini device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/plugmini.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -25,54 +25,54 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    operatePlug

    • operatePlug(bytes: number[]): Promise<boolean>

      Operates the plug with the given bytes.

      +

    Returns Promise<void>

    operatePlug

    readState

    readState

    setDeviceName

    setDeviceName

    toggle

    toggle

    turnOff

    turnOff

    turnOn

    turnOn

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoPresence.html b/docs/classes/WoPresence.html index de0330a5..a32acc81 100644 --- a/docs/classes/WoPresence.html +++ b/docs/classes/WoPresence.html @@ -1,6 +1,6 @@ WoPresence | node-switchbot

    Class WoPresence

    Class representing a WoPresence device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,33 +20,33 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoRelaySwitch1.html b/docs/classes/WoRelaySwitch1.html index 4a420fa5..0dbce770 100644 --- a/docs/classes/WoRelaySwitch1.html +++ b/docs/classes/WoRelaySwitch1.html @@ -1,6 +1,6 @@ WoRelaySwitch1 | node-switchbot

    Class WoRelaySwitch1

    Class representing a WoRelaySwitch1 device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -22,36 +22,36 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    turnOff

    turnOn

    unsubscribeFromNotify

    turnOff

    turnOn

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoRelaySwitch1PM.html b/docs/classes/WoRelaySwitch1PM.html index e05ef790..d6fe3e52 100644 --- a/docs/classes/WoRelaySwitch1PM.html +++ b/docs/classes/WoRelaySwitch1PM.html @@ -1,6 +1,6 @@ WoRelaySwitch1PM | node-switchbot

    Class WoRelaySwitch1PM

    Class representing a WoRelaySwitch1PM device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -22,36 +22,36 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    turnOff

    turnOn

    unsubscribeFromNotify

    turnOff

    turnOn

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoRemote.html b/docs/classes/WoRemote.html index caeda51a..b3eac8e5 100644 --- a/docs/classes/WoRemote.html +++ b/docs/classes/WoRemote.html @@ -1,6 +1,6 @@ WoRemote | node-switchbot

    Class WoRemote

    Class representing a WoRemote device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,33 +20,33 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoSensorTH.html b/docs/classes/WoSensorTH.html index b3c8c676..b9553dff 100644 --- a/docs/classes/WoSensorTH.html +++ b/docs/classes/WoSensorTH.html @@ -1,6 +1,6 @@ WoSensorTH | node-switchbot

    Class WoSensorTH

    Class representing a WoSensorTH device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,27 +20,27 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoSensorTHPlus.html b/docs/classes/WoSensorTHPlus.html index 8af535cd..6fa69790 100644 --- a/docs/classes/WoSensorTHPlus.html +++ b/docs/classes/WoSensorTHPlus.html @@ -1,6 +1,6 @@ WoSensorTHPlus | node-switchbot

    Class WoSensorTHPlus

    Class representing a WoSensorTH device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,27 +20,27 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoSensorTHPro.html b/docs/classes/WoSensorTHPro.html index 7c6504f0..a6aab114 100644 --- a/docs/classes/WoSensorTHPro.html +++ b/docs/classes/WoSensorTHPro.html @@ -1,6 +1,6 @@ WoSensorTHPro | node-switchbot

    Class WoSensorTHPro

    Class representing a WoSensorTH device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,27 +20,27 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoSensorTHProCO2.html b/docs/classes/WoSensorTHProCO2.html index 07daec64..082f5bd1 100644 --- a/docs/classes/WoSensorTHProCO2.html +++ b/docs/classes/WoSensorTHProCO2.html @@ -1,6 +1,6 @@ WoSensorTHProCO2 | node-switchbot

    Class WoSensorTHProCO2

    Class representing a WoSensorTH device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,27 +20,27 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoSmartLock.html b/docs/classes/WoSmartLock.html index b31ca4c0..054f318e 100644 --- a/docs/classes/WoSmartLock.html +++ b/docs/classes/WoSmartLock.html @@ -1,6 +1,6 @@ WoSmartLock | node-switchbot

    Class WoSmartLock

    Class representing a WoSmartLock device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/lock.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    encryption_key iv key_id @@ -36,78 +36,78 @@ getLockStatus parseServiceData validateResponse -

    Constructors

    constructor

    Properties

    encryption_key

    encryption_key: null | Buffer<ArrayBufferLike> = null

    iv

    iv: null | Buffer<ArrayBufferLike> = null

    key_id

    key_id: string = ''

    StaticResult

    Result: { ERROR: number; SUCCESS: number; SUCCESS_LOW_BATTERY: number } = ...

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Properties

    encryption_key

    encryption_key: null | Buffer<ArrayBufferLike> = null

    iv

    iv: null | Buffer<ArrayBufferLike> = null

    key_id

    key_id: string = ''

    StaticResult

    Result: { ERROR: number; SUCCESS: number; SUCCESS_LOW_BATTERY: number } = ...

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    decrypt

    decrypt

    • decrypt(data: Buffer): Promise<Buffer<ArrayBufferLike>>

      Decrypts a buffer using AES-128-CTR.

      Parameters

      • data: Buffer

        The data to decrypt.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The decrypted data.
      -

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      +

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    encrypt

    encrypt

    • encrypt(str: string): Promise<string>

      Encrypts a string using AES-128-CTR.

      Parameters

      • str: string

        The string to encrypt.

      Returns Promise<string>

      • The encrypted string in hex format.
      -

    encryptedCommand

    • encryptedCommand(key: string): Promise<Buffer<ArrayBufferLike>>

      Sends an encrypted command to the device.

      +

    encryptedCommand

    • encryptedCommand(key: string): Promise<Buffer<ArrayBufferLike>>

      Sends an encrypted command to the device.

      Parameters

      • key: string

        The command key.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The response buffer.
      -

    getCharacteristics

    • getCharacteristics(): Promise<Chars>

      Retrieves the device characteristics.

      +

    getCharacteristics

    getDeviceName

    getDeviceName

    getIv

    getIv

    • getIv(): Promise<Buffer<ArrayBufferLike>>

      Retrieves the IV from the device.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The IV buffer.
      -

    info

    • info(): Promise<null | object>

      Gets general state info from the Smart Lock.

      +

    info

    • info(): Promise<null | object>

      Gets general state info from the Smart Lock.

      Returns Promise<null | object>

      • The state object or null if an error occurred.
      -

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      +

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    lock

    lock

    • lock(): Promise<number>

      Locks the Smart Lock.

      Returns Promise<number>

      • The result of the lock operation.
      -

    log

    • log(level: string, message: string): Promise<void>

      Logs a message with the specified log level.

      +

    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>

    operateLock

    • operateLock(key: string, encrypt?: boolean): Promise<Buffer<ArrayBufferLike>>

      Operates the lock with the given command.

      +

    Returns Promise<void>

    operateLock

    setDeviceName

    setDeviceName

    setKey

    setKey

    unlock

    Returns Promise<void>

    unlock

    unlockNoUnlatch

    unlockNoUnlatch

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticgetLockStatus

    StaticparseServiceData

    StaticgetLockStatus

    StaticparseServiceData

    StaticvalidateResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    StaticvalidateResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/WoSmartLockPro.html b/docs/classes/WoSmartLockPro.html index e810d700..3172f68d 100644 --- a/docs/classes/WoSmartLockPro.html +++ b/docs/classes/WoSmartLockPro.html @@ -1,6 +1,6 @@ WoSmartLockPro | node-switchbot

    Class WoSmartLockPro

    Class representing a WoSmartLockPro device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/lock.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    encryption_key iv key_id @@ -36,78 +36,78 @@ getLockStatus parseServiceData validateResponse -

    Constructors

    constructor

    Properties

    encryption_key

    encryption_key: null | Buffer<ArrayBufferLike> = null

    iv

    iv: null | Buffer<ArrayBufferLike> = null

    key_id

    key_id: string = ''

    StaticResult

    Result: { ERROR: number; SUCCESS: number; SUCCESS_LOW_BATTERY: number } = ...

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Properties

    encryption_key

    encryption_key: null | Buffer<ArrayBufferLike> = null

    iv

    iv: null | Buffer<ArrayBufferLike> = null

    key_id

    key_id: string = ''

    StaticResult

    Result: { ERROR: number; SUCCESS: number; SUCCESS_LOW_BATTERY: number } = ...

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    decrypt

    decrypt

    • decrypt(data: Buffer): Promise<Buffer<ArrayBufferLike>>

      Decrypts a buffer using AES-128-CTR.

      Parameters

      • data: Buffer

        The data to decrypt.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The decrypted data.
      -

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      +

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    encrypt

    encrypt

    • encrypt(str: string): Promise<string>

      Encrypts a string using AES-128-CTR.

      Parameters

      • str: string

        The string to encrypt.

      Returns Promise<string>

      • The encrypted string in hex format.
      -

    encryptedCommand

    • encryptedCommand(key: string): Promise<Buffer<ArrayBufferLike>>

      Sends an encrypted command to the device.

      +

    encryptedCommand

    • encryptedCommand(key: string): Promise<Buffer<ArrayBufferLike>>

      Sends an encrypted command to the device.

      Parameters

      • key: string

        The command key.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The response buffer.
      -

    getCharacteristics

    • getCharacteristics(): Promise<Chars>

      Retrieves the device characteristics.

      +

    getCharacteristics

    getDeviceName

    getDeviceName

    getIv

    getIv

    • getIv(): Promise<Buffer<ArrayBufferLike>>

      Retrieves the IV from the device.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The IV buffer.
      -

    info

    • info(): Promise<null | object>

      Gets general state info from the Smart Lock.

      +

    info

    • info(): Promise<null | object>

      Gets general state info from the Smart Lock.

      Returns Promise<null | object>

      • The state object or null if an error occurred.
      -

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      +

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    lock

    lock

    • lock(): Promise<number>

      Locks the Smart Lock.

      Returns Promise<number>

      • The result of the lock operation.
      -

    log

    • log(level: string, message: string): Promise<void>

      Logs a message with the specified log level.

      +

    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>

    operateLockPro

    • operateLockPro(key: string, encrypt?: boolean): Promise<Buffer<ArrayBufferLike>>

      Operates the lock with the given command.

      +

    Returns Promise<void>

    operateLockPro

    setDeviceName

    setDeviceName

    setKey

    setKey

    unlock

    Returns Promise<void>

    unlock

    unlockNoUnlatch

    unlockNoUnlatch

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticgetLockStatus

    StaticparseServiceData

    StaticgetLockStatus

    StaticparseServiceData

    StaticvalidateResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    StaticvalidateResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/WoStrip.html b/docs/classes/WoStrip.html index 59b3d772..95c3b713 100644 --- a/docs/classes/WoStrip.html +++ b/docs/classes/WoStrip.html @@ -1,6 +1,6 @@ WoStrip | node-switchbot

    Class WoStrip

    Class representing a WoStrip device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/ledstriplight.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -27,42 +27,42 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    operateStripLight

    • operateStripLight(bytes: number[]): Promise<boolean>

      Operates the strip light with the given byte array.

      +

    Returns Promise<void>

    operateStripLight

    readState

    readState

    setBrightness

    setBrightness

    setDeviceName

    setDeviceName

    setRGB

    setRGB

    setState

    setState

    turnOff

    turnOff

    turnOn

    turnOn

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/enums/LogLevel.html b/docs/enums/LogLevel.html index f58cbac7..44c7867a 100644 --- a/docs/enums/LogLevel.html +++ b/docs/enums/LogLevel.html @@ -1,5 +1,5 @@ LogLevel | node-switchbot

    Enumeration LogLevel

    Enum for log levels.

    -

    Enumeration Members

    DEBUG +

    Enumeration Members

    DEBUG DEBUGERROR DEBUGSUCCESS DEBUGWARN @@ -7,4 +7,4 @@ INFO SUCCESS WARN -

    Enumeration Members

    DEBUG

    DEBUG: "debug"

    DEBUGERROR

    DEBUGERROR: "debugerror"

    DEBUGSUCCESS

    DEBUGSUCCESS: "debugsuccess"

    DEBUGWARN

    DEBUGWARN: "debugwarn"

    ERROR

    ERROR: "error"

    INFO

    INFO: "info"

    SUCCESS

    SUCCESS: "success"

    WARN

    WARN: "warn"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    DEBUG

    DEBUG: "debug"

    DEBUGERROR

    DEBUGERROR: "debugerror"

    DEBUGSUCCESS

    DEBUGSUCCESS: "debugsuccess"

    DEBUGWARN

    DEBUGWARN: "debugwarn"

    ERROR

    ERROR: "error"

    INFO

    INFO: "info"

    SUCCESS

    SUCCESS: "success"

    WARN

    WARN: "warn"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/enums/SwitchBotBLEModel.html b/docs/enums/SwitchBotBLEModel.html index 2e6e04ce..5870ef35 100644 --- a/docs/enums/SwitchBotBLEModel.html +++ b/docs/enums/SwitchBotBLEModel.html @@ -1,4 +1,4 @@ -SwitchBotBLEModel | node-switchbot

    Enumeration SwitchBotBLEModel

    Enumeration Members

    BlindTilt +SwitchBotBLEModel | node-switchbot

    Enumeration SwitchBotBLEModel

    Enumeration Members

    BlindTilt Bot CeilingLight CeilingLightPro @@ -26,4 +26,4 @@ Remote StripLight Unknown -

    Enumeration Members

    BlindTilt

    BlindTilt: "x"

    Bot

    Bot: "H"

    CeilingLight

    CeilingLight: "q"

    CeilingLightPro

    CeilingLightPro: "n"

    ColorBulb

    ColorBulb: "u"

    ContactSensor

    ContactSensor: "d"

    Curtain

    Curtain: "c"

    Curtain3

    Curtain3: "{"

    Hub2

    Hub2: "v"

    Humidifier

    Humidifier: "e"

    Humidifier2

    Humidifier2: "#"

    Keypad

    Keypad: "y"

    Leak

    Leak: "&"

    Lock

    Lock: "o"

    LockPro

    LockPro: "$"

    Meter

    Meter: "T"

    MeterPlus

    MeterPlus: "i"

    MeterPro

    MeterPro: "4"

    MeterProCO2

    MeterProCO2: "5"

    MotionSensor

    MotionSensor: "s"

    OutdoorMeter

    OutdoorMeter: "w"

    PlugMiniJP

    PlugMiniJP: "j"

    PlugMiniUS

    PlugMiniUS: "g"

    RelaySwitch1

    RelaySwitch1: ";"

    RelaySwitch1PM

    RelaySwitch1PM: "<"

    Remote

    Remote: "b"

    StripLight

    StripLight: "r"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    BlindTilt

    BlindTilt: "x"

    Bot

    Bot: "H"

    CeilingLight

    CeilingLight: "q"

    CeilingLightPro

    CeilingLightPro: "n"

    ColorBulb

    ColorBulb: "u"

    ContactSensor

    ContactSensor: "d"

    Curtain

    Curtain: "c"

    Curtain3

    Curtain3: "{"

    Hub2

    Hub2: "v"

    Humidifier

    Humidifier: "e"

    Humidifier2

    Humidifier2: "#"

    Keypad

    Keypad: "y"

    Leak

    Leak: "&"

    Lock

    Lock: "o"

    LockPro

    LockPro: "$"

    Meter

    Meter: "T"

    MeterPlus

    MeterPlus: "i"

    MeterPro

    MeterPro: "4"

    MeterProCO2

    MeterProCO2: "5"

    MotionSensor

    MotionSensor: "s"

    OutdoorMeter

    OutdoorMeter: "w"

    PlugMiniJP

    PlugMiniJP: "j"

    PlugMiniUS

    PlugMiniUS: "g"

    RelaySwitch1

    RelaySwitch1: ";"

    RelaySwitch1PM

    RelaySwitch1PM: "<"

    Remote

    Remote: "b"

    StripLight

    StripLight: "r"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/enums/SwitchBotBLEModelFriendlyName.html b/docs/enums/SwitchBotBLEModelFriendlyName.html index c0243412..6b50aa24 100644 --- a/docs/enums/SwitchBotBLEModelFriendlyName.html +++ b/docs/enums/SwitchBotBLEModelFriendlyName.html @@ -1,4 +1,4 @@ -SwitchBotBLEModelFriendlyName | node-switchbot

    Enumeration SwitchBotBLEModelFriendlyName

    Enumeration Members

    BatteryCirculatorFan +SwitchBotBLEModelFriendlyName | node-switchbot

    Enumeration SwitchBotBLEModelFriendlyName

    Enumeration Members

    BatteryCirculatorFan BlindTilt Bot CeilingLight @@ -27,4 +27,4 @@ Remote StripLight Unknown -

    Enumeration Members

    BatteryCirculatorFan

    BatteryCirculatorFan: "Battery Circulator Fan"

    BlindTilt

    BlindTilt: "Blind Tilt"

    Bot

    Bot: "Bot"

    CeilingLight

    CeilingLight: "Ceiling Light"

    CeilingLightPro

    CeilingLightPro: "Ceiling Light Pro"

    CirculatorFan

    CirculatorFan: "Circulator Fan"

    ColorBulb

    ColorBulb: "Color Bulb"

    ContactSensor

    ContactSensor: "Contact Sensor"

    Curtain

    Curtain: "Curtain"

    Curtain3

    Curtain3: "Curtain 3"

    Hub2

    Hub2: "Hub 2"

    Humidifier

    Humidifier: "Humidifier"

    Humidifier2

    Humidifier2: "Humidifier2"

    Keypad

    Keypad: "Keypad"

    Leak

    Leak: "Water Detector"

    Lock

    Lock: "Lock"

    LockPro

    LockPro: "Lock Pro"

    Meter

    Meter: "Meter"

    MeterPlus

    MeterPlus: "Meter Plus"

    MeterPro

    MeterPro: "Meter Pro"

    MeterProCO2

    MeterProCO2: "Meter Pro CO2"

    MotionSensor

    MotionSensor: "Motion Sensor"

    OutdoorMeter

    OutdoorMeter: "Outdoor Meter"

    PlugMini

    PlugMini: "Plug Mini"

    RelaySwitch1

    RelaySwitch1: "Relay Switch 1"

    RelaySwitch1PM

    RelaySwitch1PM: "Relay Switch 1PM"

    Remote

    Remote: "Remote"

    StripLight

    StripLight: "Strip Light"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    BatteryCirculatorFan

    BatteryCirculatorFan: "Battery Circulator Fan"

    BlindTilt

    BlindTilt: "Blind Tilt"

    Bot

    Bot: "Bot"

    CeilingLight

    CeilingLight: "Ceiling Light"

    CeilingLightPro

    CeilingLightPro: "Ceiling Light Pro"

    CirculatorFan

    CirculatorFan: "Circulator Fan"

    ColorBulb

    ColorBulb: "Color Bulb"

    ContactSensor

    ContactSensor: "Contact Sensor"

    Curtain

    Curtain: "Curtain"

    Curtain3

    Curtain3: "Curtain 3"

    Hub2

    Hub2: "Hub 2"

    Humidifier

    Humidifier: "Humidifier"

    Humidifier2

    Humidifier2: "Humidifier2"

    Keypad

    Keypad: "Keypad"

    Leak

    Leak: "Water Detector"

    Lock

    Lock: "Lock"

    LockPro

    LockPro: "Lock Pro"

    Meter

    Meter: "Meter"

    MeterPlus

    MeterPlus: "Meter Plus"

    MeterPro

    MeterPro: "Meter Pro"

    MeterProCO2

    MeterProCO2: "Meter Pro CO2"

    MotionSensor

    MotionSensor: "Motion Sensor"

    OutdoorMeter

    OutdoorMeter: "Outdoor Meter"

    PlugMini

    PlugMini: "Plug Mini"

    RelaySwitch1

    RelaySwitch1: "Relay Switch 1"

    RelaySwitch1PM

    RelaySwitch1PM: "Relay Switch 1PM"

    Remote

    Remote: "Remote"

    StripLight

    StripLight: "Strip Light"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/enums/SwitchBotBLEModelName.html b/docs/enums/SwitchBotBLEModelName.html index 79e37901..6b9e4730 100644 --- a/docs/enums/SwitchBotBLEModelName.html +++ b/docs/enums/SwitchBotBLEModelName.html @@ -1,4 +1,4 @@ -SwitchBotBLEModelName | node-switchbot

    Enumeration SwitchBotBLEModelName

    Enumeration Members

    BlindTilt +SwitchBotBLEModelName | node-switchbot

    Enumeration SwitchBotBLEModelName

    Enumeration Members

    BlindTilt Bot CeilingLight CeilingLightPro @@ -25,4 +25,4 @@ Remote StripLight Unknown -

    Enumeration Members

    BlindTilt

    BlindTilt: "WoBlindTilt"

    Bot

    Bot: "WoHand"

    CeilingLight

    CeilingLight: "WoCeilingLight"

    CeilingLightPro

    CeilingLightPro: "WoCeilingLightPro"

    ColorBulb

    ColorBulb: "WoBulb"

    ContactSensor

    ContactSensor: "WoContact"

    Curtain

    Curtain: "WoCurtain"

    Curtain3

    Curtain3: "WoCurtain3"

    Hub2

    Hub2: "WoHub2"

    Humidifier

    Humidifier: "WoHumi"

    Humidifier2

    Humidifier2: "WoHumi2"

    Keypad

    Keypad: "WoKeypad"

    Leak

    Leak: "WoLeakDetector"

    Lock

    Lock: "WoSmartLock"

    LockPro

    LockPro: "WoSmartLockPro"

    Meter

    Meter: "WoSensorTH"

    MeterPlus

    MeterPlus: "WoSensorTHPlus"

    MeterPro

    MeterPro: "WoSensorTHP"

    MeterProCO2

    MeterProCO2: "WoSensorTHPc"

    MotionSensor

    MotionSensor: "WoMotion"

    OutdoorMeter

    OutdoorMeter: "WoIOSensorTH"

    PlugMini

    PlugMini: "WoPlugMini"

    RelaySwitch1

    RelaySwitch1: "WoRelaySwitch1Plus"

    RelaySwitch1PM

    RelaySwitch1PM: "WoRelaySwitch1PM"

    Remote

    Remote: "WoRemote"

    StripLight

    StripLight: "WoStrip"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    BlindTilt

    BlindTilt: "WoBlindTilt"

    Bot

    Bot: "WoHand"

    CeilingLight

    CeilingLight: "WoCeilingLight"

    CeilingLightPro

    CeilingLightPro: "WoCeilingLightPro"

    ColorBulb

    ColorBulb: "WoBulb"

    ContactSensor

    ContactSensor: "WoContact"

    Curtain

    Curtain: "WoCurtain"

    Curtain3

    Curtain3: "WoCurtain3"

    Hub2

    Hub2: "WoHub2"

    Humidifier

    Humidifier: "WoHumi"

    Humidifier2

    Humidifier2: "WoHumi2"

    Keypad

    Keypad: "WoKeypad"

    Leak

    Leak: "WoLeakDetector"

    Lock

    Lock: "WoSmartLock"

    LockPro

    LockPro: "WoSmartLockPro"

    Meter

    Meter: "WoSensorTH"

    MeterPlus

    MeterPlus: "WoSensorTHPlus"

    MeterPro

    MeterPro: "WoSensorTHP"

    MeterProCO2

    MeterProCO2: "WoSensorTHPc"

    MotionSensor

    MotionSensor: "WoMotion"

    OutdoorMeter

    OutdoorMeter: "WoIOSensorTH"

    PlugMini

    PlugMini: "WoPlugMini"

    RelaySwitch1

    RelaySwitch1: "WoRelaySwitch1Plus"

    RelaySwitch1PM

    RelaySwitch1PM: "WoRelaySwitch1PM"

    Remote

    Remote: "WoRemote"

    StripLight

    StripLight: "WoStrip"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/enums/SwitchBotModel.html b/docs/enums/SwitchBotModel.html index 31f67c71..10ad15bc 100644 --- a/docs/enums/SwitchBotModel.html +++ b/docs/enums/SwitchBotModel.html @@ -1,4 +1,4 @@ -SwitchBotModel | node-switchbot

    Enumeration SwitchBotModel

    Enumeration Members

    BatteryCirculatorFan +SwitchBotModel | node-switchbot

    Enumeration SwitchBotModel

    Enumeration Members

    BatteryCirculatorFan BlindTilt Bot CeilingLight @@ -44,4 +44,4 @@ WaterDetector WoSweeper WoSweeperMini -

    Enumeration Members

    BatteryCirculatorFan

    BatteryCirculatorFan: "W3800510"

    BlindTilt

    BlindTilt: "W2701600"

    Bot

    Bot: "SwitchBot S1"

    CeilingLight

    CeilingLight: "W2612230/W2612240"

    CeilingLightPro

    CeilingLightPro: "W2612210/W2612220"

    CirculatorFan

    CirculatorFan: "W3800511"

    ColorBulb

    ColorBulb: "W1401400"

    ContactSensor

    ContactSensor: "W1201500"

    Curtain

    Curtain: "W0701600"

    Curtain3

    Curtain3: "W2400000"

    Hub2

    Hub2: "W3202100"

    HubMini

    HubMini: "W0202200"

    HubPlus

    HubPlus: "SwitchBot Hub S1"

    Humidifier

    Humidifier: "W0801800"

    Humidifier2

    Humidifier2: "WXXXXXXX"

    IndoorCam

    IndoorCam: "W1301200"

    K10

    K10: "K10+"

    K10Pro

    K10Pro: "K10+ Pro"

    Keypad

    Keypad: "W2500010"

    KeypadTouch

    KeypadTouch: "W2500020"

    Lock

    Lock: "W1601700"

    LockPro

    LockPro: "W3500000"

    Meter

    Meter: "SwitchBot MeterTH S1"

    MeterPlusJP

    MeterPlusJP: "W2201500"

    MeterPlusUS

    MeterPlusUS: "W2301500"

    MeterPro

    MeterPro: "W4900000"

    MeterProCO2

    MeterProCO2: "W4900010"

    MotionSensor

    MotionSensor: "W1101500"

    OutdoorMeter

    OutdoorMeter: "W3400010"

    PanTiltCam

    PanTiltCam: "W1801200"

    PanTiltCam2K

    PanTiltCam2K: "W3101100"

    Plug

    Plug: "SP11"

    PlugMiniJP

    PlugMiniJP: "W2001400/W2001401"

    PlugMiniUS

    PlugMiniUS: "W1901400/W1901401"

    RelaySwitch1

    RelaySwitch1: "W5502300"

    RelaySwitch1PM

    RelaySwitch1PM: "W5502310"

    Remote

    Remote: "Remote"

    RobotVacuumCleanerS1

    RobotVacuumCleanerS1: "W3011000"

    RobotVacuumCleanerS10

    RobotVacuumCleanerS10: "W3211800"

    RobotVacuumCleanerS1Plus

    RobotVacuumCleanerS1Plus: "W3011010"

    StripLight

    StripLight: "W1701100"

    UniversalRemote

    UniversalRemote: "UniversalRemote"

    Unknown

    Unknown: "Unknown"

    WaterDetector

    WaterDetector: "W4402000"

    WoSweeper

    WoSweeper: "WoSweeper"

    WoSweeperMini

    WoSweeperMini: "WoSweeperMini"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    BatteryCirculatorFan

    BatteryCirculatorFan: "W3800510"

    BlindTilt

    BlindTilt: "W2701600"

    Bot

    Bot: "SwitchBot S1"

    CeilingLight

    CeilingLight: "W2612230/W2612240"

    CeilingLightPro

    CeilingLightPro: "W2612210/W2612220"

    CirculatorFan

    CirculatorFan: "W3800511"

    ColorBulb

    ColorBulb: "W1401400"

    ContactSensor

    ContactSensor: "W1201500"

    Curtain

    Curtain: "W0701600"

    Curtain3

    Curtain3: "W2400000"

    Hub2

    Hub2: "W3202100"

    HubMini

    HubMini: "W0202200"

    HubPlus

    HubPlus: "SwitchBot Hub S1"

    Humidifier

    Humidifier: "W0801800"

    Humidifier2

    Humidifier2: "WXXXXXXX"

    IndoorCam

    IndoorCam: "W1301200"

    K10

    K10: "K10+"

    K10Pro

    K10Pro: "K10+ Pro"

    Keypad

    Keypad: "W2500010"

    KeypadTouch

    KeypadTouch: "W2500020"

    Lock

    Lock: "W1601700"

    LockPro

    LockPro: "W3500000"

    Meter

    Meter: "SwitchBot MeterTH S1"

    MeterPlusJP

    MeterPlusJP: "W2201500"

    MeterPlusUS

    MeterPlusUS: "W2301500"

    MeterPro

    MeterPro: "W4900000"

    MeterProCO2

    MeterProCO2: "W4900010"

    MotionSensor

    MotionSensor: "W1101500"

    OutdoorMeter

    OutdoorMeter: "W3400010"

    PanTiltCam

    PanTiltCam: "W1801200"

    PanTiltCam2K

    PanTiltCam2K: "W3101100"

    Plug

    Plug: "SP11"

    PlugMiniJP

    PlugMiniJP: "W2001400/W2001401"

    PlugMiniUS

    PlugMiniUS: "W1901400/W1901401"

    RelaySwitch1

    RelaySwitch1: "W5502300"

    RelaySwitch1PM

    RelaySwitch1PM: "W5502310"

    Remote

    Remote: "Remote"

    RobotVacuumCleanerS1

    RobotVacuumCleanerS1: "W3011000"

    RobotVacuumCleanerS10

    RobotVacuumCleanerS10: "W3211800"

    RobotVacuumCleanerS1Plus

    RobotVacuumCleanerS1Plus: "W3011010"

    StripLight

    StripLight: "W1701100"

    UniversalRemote

    UniversalRemote: "UniversalRemote"

    Unknown

    Unknown: "Unknown"

    WaterDetector

    WaterDetector: "W4402000"

    WoSweeper

    WoSweeper: "WoSweeper"

    WoSweeperMini

    WoSweeperMini: "WoSweeperMini"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/interfaces/AdvertisementData.html b/docs/interfaces/AdvertisementData.html index 9a845eed..cfb2b75c 100644 --- a/docs/interfaces/AdvertisementData.html +++ b/docs/interfaces/AdvertisementData.html @@ -1,3 +1,3 @@ -AdvertisementData | node-switchbot

    Interface AdvertisementData

    interface AdvertisementData {
        manufacturerData: null | Buffer<ArrayBufferLike>;
        serviceData: null | Buffer<ArrayBufferLike>;
    }

    Properties

    manufacturerData +AdvertisementData | node-switchbot

    Interface AdvertisementData

    interface AdvertisementData {
        manufacturerData: null | Buffer<ArrayBufferLike>;
        serviceData: null | Buffer<ArrayBufferLike>;
    }

    Properties

    manufacturerData serviceData -

    Properties

    manufacturerData

    manufacturerData: null | Buffer<ArrayBufferLike>

    serviceData

    serviceData: null | Buffer<ArrayBufferLike>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    manufacturerData

    manufacturerData: null | Buffer<ArrayBufferLike>

    serviceData

    serviceData: null | Buffer<ArrayBufferLike>

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/Chars.html b/docs/interfaces/Chars.html index dc628704..d4ced4b4 100644 --- a/docs/interfaces/Chars.html +++ b/docs/interfaces/Chars.html @@ -1,4 +1,4 @@ -Chars | node-switchbot

    Interface Chars

    interface Chars {
        device: null | Characteristic;
        notify: null | Characteristic;
        write: null | Characteristic;
    }

    Properties

    device +Chars | node-switchbot

    Interface Chars

    interface Chars {
        device: null | Characteristic;
        notify: null | Characteristic;
        write: null | Characteristic;
    }

    Properties

    device notify write -

    Properties

    device

    device: null | Characteristic

    notify

    notify: null | Characteristic

    write

    write: null | Characteristic

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    device

    device: null | Characteristic

    notify

    notify: null | Characteristic

    write

    write: null | Characteristic

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/ErrorObject.html b/docs/interfaces/ErrorObject.html index 7af4eec7..e34892e8 100644 --- a/docs/interfaces/ErrorObject.html +++ b/docs/interfaces/ErrorObject.html @@ -1,3 +1,3 @@ -ErrorObject | node-switchbot

    Interface ErrorObject

    interface ErrorObject {
        code: string;
        message: string;
    }

    Properties

    code +ErrorObject | node-switchbot

    Interface ErrorObject

    interface ErrorObject {
        code: string;
        message: string;
    }

    Properties

    code message -

    Properties

    code

    code: string

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    code

    code: string

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/NobleTypes.html b/docs/interfaces/NobleTypes.html index 2a8cc173..099801a9 100644 --- a/docs/interfaces/NobleTypes.html +++ b/docs/interfaces/NobleTypes.html @@ -1,4 +1,4 @@ -NobleTypes | node-switchbot

    Interface NobleTypes

    interface NobleTypes {
        noble: __module;
        peripheral: Peripheral;
        state:
            | "unknown"
            | "resetting"
            | "unsupported"
            | "unauthorized"
            | "poweredOff"
            | "poweredOn";
    }

    Properties

    noble +NobleTypes | node-switchbot

    Interface NobleTypes

    interface NobleTypes {
        noble: __module;
        peripheral: Peripheral;
        state:
            | "unknown"
            | "resetting"
            | "unsupported"
            | "unauthorized"
            | "poweredOff"
            | "poweredOn";
    }

    Properties

    noble peripheral state -

    Properties

    noble

    noble: __module

    peripheral

    peripheral: Peripheral

    state

    state:
        | "unknown"
        | "resetting"
        | "unsupported"
        | "unauthorized"
        | "poweredOff"
        | "poweredOn"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    noble

    noble: __module

    peripheral

    peripheral: Peripheral

    state

    state:
        | "unknown"
        | "resetting"
        | "unsupported"
        | "unauthorized"
        | "poweredOff"
        | "poweredOn"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/Params.html b/docs/interfaces/Params.html index 819ea888..6c1e5860 100644 --- a/docs/interfaces/Params.html +++ b/docs/interfaces/Params.html @@ -1,6 +1,6 @@ -Params | node-switchbot

    Interface Params

    interface Params {
        duration?: number;
        id?: string;
        model?: string;
        noble?: __module;
        quick?: boolean;
    }

    Properties

    duration? +Params | node-switchbot

    Interface Params

    interface Params {
        duration?: number;
        id?: string;
        model?: string;
        noble?: __module;
        quick?: boolean;
    }

    Properties

    duration? id? model? noble? quick? -

    Properties

    Optionalduration

    duration?: number

    Optionalid

    id?: string

    Optionalmodel

    model?: string

    Optionalnoble

    noble?: __module

    Optionalquick

    quick?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalduration

    duration?: number

    Optionalid

    id?: string

    Optionalmodel

    model?: string

    Optionalnoble

    noble?: __module

    Optionalquick

    quick?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/Rule.html b/docs/interfaces/Rule.html index e8477323..d2bd04ea 100644 --- a/docs/interfaces/Rule.html +++ b/docs/interfaces/Rule.html @@ -1,4 +1,4 @@ -Rule | node-switchbot

    Interface Rule

    interface Rule {
        enum?: unknown[];
        max?: number;
        maxBytes?: number;
        min?: number;
        minBytes?: number;
        pattern?: RegExp;
        required?: boolean;
        type?: "string" | "boolean" | "object" | "float" | "integer" | "array";
    }

    Properties

    enum? +Rule | node-switchbot

    Interface Rule

    interface Rule {
        enum?: unknown[];
        max?: number;
        maxBytes?: number;
        min?: number;
        minBytes?: number;
        pattern?: RegExp;
        required?: boolean;
        type?: "string" | "boolean" | "object" | "float" | "integer" | "array";
    }

    Properties

    enum? max? maxBytes? min? @@ -6,4 +6,4 @@ pattern? required? type? -

    Properties

    Optionalenum

    enum?: unknown[]

    Optionalmax

    max?: number

    OptionalmaxBytes

    maxBytes?: number

    Optionalmin

    min?: number

    OptionalminBytes

    minBytes?: number

    Optionalpattern

    pattern?: RegExp

    Optionalrequired

    required?: boolean

    Optionaltype

    type?: "string" | "boolean" | "object" | "float" | "integer" | "array"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalenum

    enum?: unknown[]

    Optionalmax

    max?: number

    OptionalmaxBytes

    maxBytes?: number

    Optionalmin

    min?: number

    OptionalminBytes

    minBytes?: number

    Optionalpattern

    pattern?: RegExp

    Optionalrequired

    required?: boolean

    Optionaltype

    type?: "string" | "boolean" | "object" | "float" | "integer" | "array"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/ServiceData.html b/docs/interfaces/ServiceData.html index aa9e1847..7b9ad5a6 100644 --- a/docs/interfaces/ServiceData.html +++ b/docs/interfaces/ServiceData.html @@ -1,2 +1,2 @@ -ServiceData | node-switchbot

    Interface ServiceData

    interface ServiceData {
        model: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

    Properties

    model -

    Properties

    model

    model: string

    Settings

    Member Visibility

    On This Page

    Properties
    +ServiceData | node-switchbot

    Interface ServiceData

    interface ServiceData {
        model: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

    Properties

    model +

    Properties

    model

    model: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/SwitchBotBLEDevice.html b/docs/interfaces/SwitchBotBLEDevice.html index c69f2ef2..791606e7 100644 --- a/docs/interfaces/SwitchBotBLEDevice.html +++ b/docs/interfaces/SwitchBotBLEDevice.html @@ -1,4 +1,4 @@ -SwitchBotBLEDevice | node-switchbot

    Interface SwitchBotBLEDevice

    interface SwitchBotBLEDevice {
        BlindTilt: DeviceInfo;
        Bot: DeviceInfo;
        CeilingLight: DeviceInfo;
        CeilingLightPro: DeviceInfo;
        ColorBulb: DeviceInfo;
        ContactSensor: DeviceInfo;
        Curtain: DeviceInfo;
        Curtain3: DeviceInfo;
        Hub2: DeviceInfo;
        Humidifier: DeviceInfo;
        Lock: DeviceInfo;
        LockPro: DeviceInfo;
        Meter: DeviceInfo;
        MeterPlus: DeviceInfo;
        MeterPro: DeviceInfo;
        MeterProCO2: DeviceInfo;
        MotionSensor: DeviceInfo;
        OutdoorMeter: DeviceInfo;
        PlugMiniJP: DeviceInfo;
        PlugMiniUS: DeviceInfo;
        StripLight: DeviceInfo;
        Unknown: DeviceInfo;
    }

    Properties

    BlindTilt +SwitchBotBLEDevice | node-switchbot

    Interface SwitchBotBLEDevice

    interface SwitchBotBLEDevice {
        BlindTilt: DeviceInfo;
        Bot: DeviceInfo;
        CeilingLight: DeviceInfo;
        CeilingLightPro: DeviceInfo;
        ColorBulb: DeviceInfo;
        ContactSensor: DeviceInfo;
        Curtain: DeviceInfo;
        Curtain3: DeviceInfo;
        Hub2: DeviceInfo;
        Humidifier: DeviceInfo;
        Lock: DeviceInfo;
        LockPro: DeviceInfo;
        Meter: DeviceInfo;
        MeterPlus: DeviceInfo;
        MeterPro: DeviceInfo;
        MeterProCO2: DeviceInfo;
        MotionSensor: DeviceInfo;
        OutdoorMeter: DeviceInfo;
        PlugMiniJP: DeviceInfo;
        PlugMiniUS: DeviceInfo;
        StripLight: DeviceInfo;
        Unknown: DeviceInfo;
    }

    Properties

    BlindTilt Bot CeilingLight CeilingLightPro @@ -20,4 +20,4 @@ PlugMiniUS StripLight Unknown -

    Properties

    BlindTilt

    BlindTilt: DeviceInfo

    Bot

    Bot: DeviceInfo

    CeilingLight

    CeilingLight: DeviceInfo

    CeilingLightPro

    CeilingLightPro: DeviceInfo

    ColorBulb

    ColorBulb: DeviceInfo

    ContactSensor

    ContactSensor: DeviceInfo

    Curtain

    Curtain: DeviceInfo

    Curtain3

    Curtain3: DeviceInfo

    Hub2

    Hub2: DeviceInfo

    Humidifier

    Humidifier: DeviceInfo

    Lock

    Lock: DeviceInfo

    LockPro

    LockPro: DeviceInfo

    Meter

    Meter: DeviceInfo

    MeterPlus

    MeterPlus: DeviceInfo

    MeterPro

    MeterPro: DeviceInfo

    MeterProCO2

    MeterProCO2: DeviceInfo

    MotionSensor

    MotionSensor: DeviceInfo

    OutdoorMeter

    OutdoorMeter: DeviceInfo

    PlugMiniJP

    PlugMiniJP: DeviceInfo

    PlugMiniUS

    PlugMiniUS: DeviceInfo

    StripLight

    StripLight: DeviceInfo

    Unknown

    Unknown: DeviceInfo

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    BlindTilt

    BlindTilt: DeviceInfo

    Bot

    Bot: DeviceInfo

    CeilingLight

    CeilingLight: DeviceInfo

    CeilingLightPro

    CeilingLightPro: DeviceInfo

    ColorBulb

    ColorBulb: DeviceInfo

    ContactSensor

    ContactSensor: DeviceInfo

    Curtain

    Curtain: DeviceInfo

    Curtain3

    Curtain3: DeviceInfo

    Hub2

    Hub2: DeviceInfo

    Humidifier

    Humidifier: DeviceInfo

    Lock

    Lock: DeviceInfo

    LockPro

    LockPro: DeviceInfo

    Meter

    Meter: DeviceInfo

    MeterPlus

    MeterPlus: DeviceInfo

    MeterPro

    MeterPro: DeviceInfo

    MeterProCO2

    MeterProCO2: DeviceInfo

    MotionSensor

    MotionSensor: DeviceInfo

    OutdoorMeter

    OutdoorMeter: DeviceInfo

    PlugMiniJP

    PlugMiniJP: DeviceInfo

    PlugMiniUS

    PlugMiniUS: DeviceInfo

    StripLight

    StripLight: DeviceInfo

    Unknown

    Unknown: DeviceInfo

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/WebhookDetail.html b/docs/interfaces/WebhookDetail.html index 1ecbc8ea..b84d624f 100644 --- a/docs/interfaces/WebhookDetail.html +++ b/docs/interfaces/WebhookDetail.html @@ -1,6 +1,6 @@ -WebhookDetail | node-switchbot

    Interface WebhookDetail

    interface WebhookDetail {
        createTime: number;
        deviceList: string;
        enable: boolean;
        lastUpdateTime: number;
        url: string;
    }

    Properties

    createTime +WebhookDetail | node-switchbot

    Interface WebhookDetail

    interface WebhookDetail {
        createTime: number;
        deviceList: string;
        enable: boolean;
        lastUpdateTime: number;
        url: string;
    }

    Properties

    createTime deviceList enable lastUpdateTime url -

    Properties

    createTime

    createTime: number

    deviceList

    deviceList: string

    enable

    enable: boolean

    lastUpdateTime

    lastUpdateTime: number

    url

    url: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    createTime

    createTime: number

    deviceList

    deviceList: string

    enable

    enable: boolean

    lastUpdateTime

    lastUpdateTime: number

    url

    url: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/ad.html b/docs/interfaces/ad.html index ec8cdbc2..419f4faa 100644 --- a/docs/interfaces/ad.html +++ b/docs/interfaces/ad.html @@ -1,5 +1,5 @@ -ad | node-switchbot

    Interface ad

    interface ad {
        address: string;
        id: string;
        rssi: number;
        serviceData:
            | botServiceData
            | colorBulbServiceData
            | contactSensorServiceData
            | curtainServiceData
            | curtain3ServiceData
            | stripLightServiceData
            | lockServiceData
            | lockProServiceData
            | meterServiceData
            | meterPlusServiceData
            | meterProServiceData
            | meterProCO2ServiceData
            | outdoorMeterServiceData
            | motionSensorServiceData
            | plugMiniUSServiceData
            | plugMiniJPServiceData
            | blindTiltServiceData
            | ceilingLightServiceData
            | ceilingLightProServiceData
            | hub2ServiceData
            | batteryCirculatorFanServiceData
            | waterLeakDetectorServiceData
            | humidifierServiceData
            | humidifier2ServiceData
            | robotVacuumCleanerServiceData
            | keypadDetectorServiceData
            | relaySwitch1ServiceData
            | relaySwitch1PMServiceData
            | remoteServiceData;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

    Properties

    address +ad | node-switchbot

    Interface ad

    interface ad {
        address: string;
        id: string;
        rssi: number;
        serviceData:
            | botServiceData
            | colorBulbServiceData
            | contactSensorServiceData
            | curtainServiceData
            | curtain3ServiceData
            | stripLightServiceData
            | lockServiceData
            | lockProServiceData
            | meterServiceData
            | meterPlusServiceData
            | meterProServiceData
            | meterProCO2ServiceData
            | outdoorMeterServiceData
            | motionSensorServiceData
            | plugMiniUSServiceData
            | plugMiniJPServiceData
            | blindTiltServiceData
            | ceilingLightServiceData
            | ceilingLightProServiceData
            | hub2ServiceData
            | batteryCirculatorFanServiceData
            | waterLeakDetectorServiceData
            | humidifierServiceData
            | humidifier2ServiceData
            | robotVacuumCleanerServiceData
            | keypadDetectorServiceData
            | relaySwitch1ServiceData
            | relaySwitch1PMServiceData
            | remoteServiceData;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

    Properties

    address id rssi serviceData -

    Properties

    address

    address: string

    id

    id: string

    rssi

    rssi: number

    serviceData

    serviceData:
        | botServiceData
        | colorBulbServiceData
        | contactSensorServiceData
        | curtainServiceData
        | curtain3ServiceData
        | stripLightServiceData
        | lockServiceData
        | lockProServiceData
        | meterServiceData
        | meterPlusServiceData
        | meterProServiceData
        | meterProCO2ServiceData
        | outdoorMeterServiceData
        | motionSensorServiceData
        | plugMiniUSServiceData
        | plugMiniJPServiceData
        | blindTiltServiceData
        | ceilingLightServiceData
        | ceilingLightProServiceData
        | hub2ServiceData
        | batteryCirculatorFanServiceData
        | waterLeakDetectorServiceData
        | humidifierServiceData
        | humidifier2ServiceData
        | robotVacuumCleanerServiceData
        | keypadDetectorServiceData
        | relaySwitch1ServiceData
        | relaySwitch1PMServiceData
        | remoteServiceData

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    address

    address: string

    id

    id: string

    rssi

    rssi: number

    serviceData

    serviceData:
        | botServiceData
        | colorBulbServiceData
        | contactSensorServiceData
        | curtainServiceData
        | curtain3ServiceData
        | stripLightServiceData
        | lockServiceData
        | lockProServiceData
        | meterServiceData
        | meterPlusServiceData
        | meterProServiceData
        | meterProCO2ServiceData
        | outdoorMeterServiceData
        | motionSensorServiceData
        | plugMiniUSServiceData
        | plugMiniJPServiceData
        | blindTiltServiceData
        | ceilingLightServiceData
        | ceilingLightProServiceData
        | hub2ServiceData
        | batteryCirculatorFanServiceData
        | waterLeakDetectorServiceData
        | humidifierServiceData
        | humidifier2ServiceData
        | robotVacuumCleanerServiceData
        | keypadDetectorServiceData
        | relaySwitch1ServiceData
        | relaySwitch1PMServiceData
        | remoteServiceData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/body.html b/docs/interfaces/body.html index 7b127afb..ed54cbd7 100644 --- a/docs/interfaces/body.html +++ b/docs/interfaces/body.html @@ -1,3 +1,3 @@ -body | node-switchbot

    Interface body

    interface body {
        deviceList: deviceList;
        infraredRemoteList: infraredRemoteList;
    }

    Properties

    deviceList +body | node-switchbot

    Interface body

    interface body {
        deviceList: deviceList;
        infraredRemoteList: infraredRemoteList;
    }

    Properties

    deviceList infraredRemoteList -

    Properties

    deviceList

    deviceList: deviceList

    infraredRemoteList

    infraredRemoteList: infraredRemoteList

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    deviceList

    deviceList: deviceList

    infraredRemoteList

    infraredRemoteList: infraredRemoteList

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/bodyChange.html b/docs/interfaces/bodyChange.html index b98ebbc3..14a8068a 100644 --- a/docs/interfaces/bodyChange.html +++ b/docs/interfaces/bodyChange.html @@ -1,4 +1,4 @@ -bodyChange | node-switchbot

    Interface bodyChange

    interface bodyChange {
        command: string;
        commandType: string;
        parameter: string;
    }

    Properties

    command +bodyChange | node-switchbot

    Interface bodyChange

    interface bodyChange {
        command: string;
        commandType: string;
        parameter: string;
    }

    Properties

    command commandType parameter -

    Properties

    command

    command: string

    commandType

    commandType: string

    parameter

    parameter: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    command

    command: string

    commandType

    commandType: string

    parameter

    parameter: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deleteWebhookResponse.html b/docs/interfaces/deleteWebhookResponse.html index c7593b91..b91d798d 100644 --- a/docs/interfaces/deleteWebhookResponse.html +++ b/docs/interfaces/deleteWebhookResponse.html @@ -1,4 +1,4 @@ -deleteWebhookResponse | node-switchbot

    Interface deleteWebhookResponse

    interface deleteWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body +deleteWebhookResponse | node-switchbot

    Interface deleteWebhookResponse

    interface deleteWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/device.html b/docs/interfaces/device.html index f2dcf165..b84c7110 100644 --- a/docs/interfaces/device.html +++ b/docs/interfaces/device.html @@ -1,7 +1,7 @@ -device | node-switchbot

    Interface device

    interface device {
        deviceId: string;
        deviceName: string;
        deviceType: string;
        enableCloudService: boolean;
        hubDeviceId: string;
        version?: number;
    }

    Hierarchy (View Summary)

    Properties

    deviceId +device | node-switchbot

    Interface device

    interface device {
        deviceId: string;
        deviceName: string;
        deviceType: string;
        enableCloudService: boolean;
        hubDeviceId: string;
        version?: number;
    }

    Hierarchy (View Summary)

    Properties

    deviceId deviceName deviceType enableCloudService hubDeviceId version? -

    Properties

    deviceId

    deviceId: string

    deviceName

    deviceName: string

    deviceType

    deviceType: string

    enableCloudService

    enableCloudService: boolean

    hubDeviceId

    hubDeviceId: string

    Optionalversion

    version?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    deviceId

    deviceId: string

    deviceName

    deviceName: string

    deviceType

    deviceType: string

    enableCloudService

    enableCloudService: boolean

    hubDeviceId

    hubDeviceId: string

    Optionalversion

    version?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deviceList.html b/docs/interfaces/deviceList.html index 733f944c..56031abb 100644 --- a/docs/interfaces/deviceList.html +++ b/docs/interfaces/deviceList.html @@ -1,2 +1,2 @@ -deviceList | node-switchbot

    Interface deviceList

    interface deviceList {
        device: device[];
    }

    Properties

    device -

    Properties

    device

    device: device[]

    Settings

    Member Visibility

    On This Page

    Properties
    +deviceList | node-switchbot

    Interface deviceList

    interface deviceList {
        device: device[];
    }

    Properties

    device +

    Properties

    device

    device: device[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deviceStatus.html b/docs/interfaces/deviceStatus.html index 3d09fb4b..9f49f194 100644 --- a/docs/interfaces/deviceStatus.html +++ b/docs/interfaces/deviceStatus.html @@ -1,7 +1,7 @@ -deviceStatus | node-switchbot

    Interface deviceStatus

    interface deviceStatus {
        deviceId: string;
        deviceName: string;
        deviceType: string;
        enableCloudService: boolean;
        hubDeviceId: string;
        version: number;
    }

    Hierarchy (View Summary)

    Properties

    deviceId +deviceStatus | node-switchbot

    Interface deviceStatus

    interface deviceStatus {
        deviceId: string;
        deviceName: string;
        deviceType: string;
        enableCloudService: boolean;
        hubDeviceId: string;
        version: number;
    }

    Hierarchy (View Summary)

    Properties

    deviceId deviceName deviceType enableCloudService hubDeviceId version -

    Properties

    deviceId

    deviceId: string

    deviceName

    deviceName: string

    deviceType

    deviceType: string

    enableCloudService

    enableCloudService: boolean

    hubDeviceId

    hubDeviceId: string

    version

    version: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    deviceId

    deviceId: string

    deviceName

    deviceName: string

    deviceType

    deviceType: string

    enableCloudService

    enableCloudService: boolean

    hubDeviceId

    hubDeviceId: string

    version

    version: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deviceStatusRequest.html b/docs/interfaces/deviceStatusRequest.html index 79bdc58f..f1beeef7 100644 --- a/docs/interfaces/deviceStatusRequest.html +++ b/docs/interfaces/deviceStatusRequest.html @@ -1,4 +1,4 @@ -deviceStatusRequest | node-switchbot

    Interface deviceStatusRequest

    interface deviceStatusRequest {
        body: deviceStatus;
        message: string;
        statusCode: number;
    }

    Properties

    body +deviceStatusRequest | node-switchbot

    Interface deviceStatusRequest

    interface deviceStatusRequest {
        body: deviceStatus;
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: deviceStatus

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: deviceStatus

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deviceWebhook.html b/docs/interfaces/deviceWebhook.html index 79e6d56e..f725d707 100644 --- a/docs/interfaces/deviceWebhook.html +++ b/docs/interfaces/deviceWebhook.html @@ -1,4 +1,4 @@ -deviceWebhook | node-switchbot

    Interface deviceWebhook

    interface deviceWebhook {
        context: deviceWebhookContext;
        eventType: string;
        eventVersion: string;
    }

    Properties

    context +deviceWebhook | node-switchbot

    Interface deviceWebhook

    interface deviceWebhook {
        context: deviceWebhookContext;
        eventType: string;
        eventVersion: string;
    }

    Properties

    context eventType eventVersion -

    Properties

    context

    context: deviceWebhookContext

    eventType

    eventType: string

    eventVersion

    eventVersion: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    context

    context: deviceWebhookContext

    eventType

    eventType: string

    eventVersion

    eventVersion: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deviceWebhookContext.html b/docs/interfaces/deviceWebhookContext.html index bd4fce4f..c257abed 100644 --- a/docs/interfaces/deviceWebhookContext.html +++ b/docs/interfaces/deviceWebhookContext.html @@ -1,4 +1,4 @@ -deviceWebhookContext | node-switchbot

    Interface deviceWebhookContext

    interface deviceWebhookContext {
        deviceMac: string;
        deviceType: string;
        timeOfSample: number;
    }

    Properties

    deviceMac +deviceWebhookContext | node-switchbot

    Interface deviceWebhookContext

    interface deviceWebhookContext {
        deviceMac: string;
        deviceType: string;
        timeOfSample: number;
    }

    Properties

    deviceMac deviceType timeOfSample -

    Properties

    deviceMac

    deviceMac: string

    deviceType

    deviceType: string

    timeOfSample

    timeOfSample: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    deviceMac

    deviceMac: string

    deviceType

    deviceType: string

    timeOfSample

    timeOfSample: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/devices.html b/docs/interfaces/devices.html index 56287811..3c09680c 100644 --- a/docs/interfaces/devices.html +++ b/docs/interfaces/devices.html @@ -1,4 +1,4 @@ -devices | node-switchbot

    Interface devices

    interface devices {
        body: body;
        message: string;
        statusCode: number;
    }

    Properties

    body +devices | node-switchbot

    Interface devices

    interface devices {
        body: body;
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: body

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: body

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/infraredRemoteList.html b/docs/interfaces/infraredRemoteList.html index 6d98950f..3f866be9 100644 --- a/docs/interfaces/infraredRemoteList.html +++ b/docs/interfaces/infraredRemoteList.html @@ -1,2 +1,2 @@ -infraredRemoteList | node-switchbot

    Interface infraredRemoteList

    interface infraredRemoteList {
        device: irdevice[];
    }

    Properties

    device -

    Properties

    device

    device: irdevice[]

    Settings

    Member Visibility

    On This Page

    Properties
    +infraredRemoteList | node-switchbot

    Interface infraredRemoteList

    interface infraredRemoteList {
        device: irdevice[];
    }

    Properties

    device +

    Properties

    device

    device: irdevice[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/irdevice.html b/docs/interfaces/irdevice.html index 08dadb6d..b3109607 100644 --- a/docs/interfaces/irdevice.html +++ b/docs/interfaces/irdevice.html @@ -1,5 +1,5 @@ -irdevice | node-switchbot

    Interface irdevice

    interface irdevice {
        deviceId?: string;
        deviceName: string;
        hubDeviceId: string;
        remoteType: string;
    }

    Properties

    deviceId? +irdevice | node-switchbot

    Interface irdevice

    interface irdevice {
        deviceId?: string;
        deviceName: string;
        hubDeviceId: string;
        remoteType: string;
    }

    Properties

    deviceId? deviceName hubDeviceId remoteType -

    Properties

    OptionaldeviceId

    deviceId?: string

    deviceName

    deviceName: string

    hubDeviceId

    hubDeviceId: string

    remoteType

    remoteType: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionaldeviceId

    deviceId?: string

    deviceName

    deviceName: string

    hubDeviceId

    hubDeviceId: string

    remoteType

    remoteType: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/pushResponse.html b/docs/interfaces/pushResponse.html index 2bf447bf..c14ad72c 100644 --- a/docs/interfaces/pushResponse.html +++ b/docs/interfaces/pushResponse.html @@ -1,4 +1,4 @@ -pushResponse | node-switchbot

    Interface pushResponse

    interface pushResponse {
        body: { commandId: string };
        message: string;
        statusCode: number;
    }

    Properties

    body +pushResponse | node-switchbot

    Interface pushResponse

    interface pushResponse {
        body: { commandId: string };
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: { commandId: string }

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: { commandId: string }

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/queryWebhookResponse.html b/docs/interfaces/queryWebhookResponse.html index d6b2d461..7410ee27 100644 --- a/docs/interfaces/queryWebhookResponse.html +++ b/docs/interfaces/queryWebhookResponse.html @@ -1,4 +1,4 @@ -queryWebhookResponse | node-switchbot

    Interface queryWebhookResponse

    interface queryWebhookResponse {
        body: WebhookDetail[];
        message: string;
        statusCode: number;
    }

    Properties

    body +queryWebhookResponse | node-switchbot

    Interface queryWebhookResponse

    interface queryWebhookResponse {
        body: WebhookDetail[];
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: WebhookDetail[]

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: WebhookDetail[]

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/setupWebhookResponse.html b/docs/interfaces/setupWebhookResponse.html index 7a8c1dbc..03979f0e 100644 --- a/docs/interfaces/setupWebhookResponse.html +++ b/docs/interfaces/setupWebhookResponse.html @@ -1,4 +1,4 @@ -setupWebhookResponse | node-switchbot

    Interface setupWebhookResponse

    interface setupWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body +setupWebhookResponse | node-switchbot

    Interface setupWebhookResponse

    interface setupWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/switchbot.html b/docs/interfaces/switchbot.html index b8898935..e600c057 100644 --- a/docs/interfaces/switchbot.html +++ b/docs/interfaces/switchbot.html @@ -1,3 +1,3 @@ -switchbot | node-switchbot

    Interface switchbot

    interface switchbot {
        discover: (
            arg0: { duration?: any; id?: string; model: string; quick: boolean },
        ) => Promise<any>;
        wait: (arg0: number) => any;
    }

    Properties

    discover +switchbot | node-switchbot

    Interface switchbot

    interface switchbot {
        discover: (
            arg0: { duration?: any; id?: string; model: string; quick: boolean },
        ) => Promise<any>;
        wait: (arg0: number) => any;
    }

    Properties

    discover wait -

    Properties

    discover

    discover: (
        arg0: { duration?: any; id?: string; model: string; quick: boolean },
    ) => Promise<any>

    wait

    wait: (arg0: number) => any

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    discover

    discover: (
        arg0: { duration?: any; id?: string; model: string; quick: boolean },
    ) => Promise<any>

    wait

    wait: (arg0: number) => any

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/updateWebhookResponse.html b/docs/interfaces/updateWebhookResponse.html index 19ca9499..dd87f682 100644 --- a/docs/interfaces/updateWebhookResponse.html +++ b/docs/interfaces/updateWebhookResponse.html @@ -1,4 +1,4 @@ -updateWebhookResponse | node-switchbot

    Interface updateWebhookResponse

    interface updateWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body +updateWebhookResponse | node-switchbot

    Interface updateWebhookResponse

    interface updateWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/webhookRequest.html b/docs/interfaces/webhookRequest.html index 66ea3ba7..b929b8c4 100644 --- a/docs/interfaces/webhookRequest.html +++ b/docs/interfaces/webhookRequest.html @@ -1,4 +1,4 @@ -webhookRequest | node-switchbot

    Interface webhookRequest

    interface webhookRequest {
        action: string;
        deviceList: string;
        url: string;
    }

    Properties

    action +webhookRequest | node-switchbot

    Interface webhookRequest

    interface webhookRequest {
        action: string;
        deviceList: string;
        url: string;
    }

    Properties

    action deviceList url -

    Properties

    action

    action: string

    deviceList

    deviceList: string

    url

    url: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    action

    action: string

    deviceList

    deviceList: string

    url

    url: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/types/MacAddress.html b/docs/types/MacAddress.html index a4aa0ac5..e74a4c2f 100644 --- a/docs/types/MacAddress.html +++ b/docs/types/MacAddress.html @@ -1 +1 @@ -MacAddress | node-switchbot

    Type Alias MacAddress

    MacAddress: string

    Settings

    Member Visibility
    +MacAddress | node-switchbot

    Type Alias MacAddress

    MacAddress: string

    Settings

    Member Visibility
    diff --git a/docs/types/batteryCirculatorFan.html b/docs/types/batteryCirculatorFan.html index 808a2a81..a92150c5 100644 --- a/docs/types/batteryCirculatorFan.html +++ b/docs/types/batteryCirculatorFan.html @@ -1 +1 @@ -batteryCirculatorFan | node-switchbot

    Type Alias batteryCirculatorFan

    batteryCirculatorFan: device & {}

    Settings

    Member Visibility
    +batteryCirculatorFan | node-switchbot

    Type Alias batteryCirculatorFan

    batteryCirculatorFan: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/batteryCirculatorFanServiceData.html b/docs/types/batteryCirculatorFanServiceData.html index 9e19bc6c..ca8bf951 100644 --- a/docs/types/batteryCirculatorFanServiceData.html +++ b/docs/types/batteryCirculatorFanServiceData.html @@ -1 +1 @@ -batteryCirculatorFanServiceData | node-switchbot

    Type Alias batteryCirculatorFanServiceData

    batteryCirculatorFanServiceData: serviceData & {
        fanSpeed: number;
        model: Unknown;
        modelFriendlyName: Unknown;
        modelName: Unknown;
        state: string;
    }

    Settings

    Member Visibility
    +batteryCirculatorFanServiceData | node-switchbot

    Type Alias batteryCirculatorFanServiceData

    batteryCirculatorFanServiceData: serviceData & {
        fanSpeed: number;
        model: Unknown;
        modelFriendlyName: Unknown;
        modelName: Unknown;
        state: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/batteryCirculatorFanStatus.html b/docs/types/batteryCirculatorFanStatus.html index 13a8da90..1262ee1d 100644 --- a/docs/types/batteryCirculatorFanStatus.html +++ b/docs/types/batteryCirculatorFanStatus.html @@ -1 +1 @@ -batteryCirculatorFanStatus | node-switchbot

    Type Alias batteryCirculatorFanStatus

    batteryCirculatorFanStatus: deviceStatus & {
        battery: number;
        chargingStatus: string;
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: number;
        oscillation: string;
        power: string;
        version: string;
        verticalOscillation: string;
    }

    Settings

    Member Visibility
    +batteryCirculatorFanStatus | node-switchbot

    Type Alias batteryCirculatorFanStatus

    batteryCirculatorFanStatus: deviceStatus & {
        battery: number;
        chargingStatus: string;
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: number;
        oscillation: string;
        power: string;
        version: string;
        verticalOscillation: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/batteryCirculatorFanWebhookContext.html b/docs/types/batteryCirculatorFanWebhookContext.html index b3ce83ad..12c8d227 100644 --- a/docs/types/batteryCirculatorFanWebhookContext.html +++ b/docs/types/batteryCirculatorFanWebhookContext.html @@ -1 +1 @@ -batteryCirculatorFanWebhookContext | node-switchbot

    Type Alias batteryCirculatorFanWebhookContext

    batteryCirculatorFanWebhookContext: deviceWebhookContext & {
        battery: number;
        chargingStatus: "charging" | "uncharged";
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: "off" | 1 | 2;
        oscillation: "on" | "off";
        powerState: "ON" | "OFF";
        version: string;
        verticalOscillation: "on" | "off";
    }

    Settings

    Member Visibility
    +batteryCirculatorFanWebhookContext | node-switchbot

    Type Alias batteryCirculatorFanWebhookContext

    batteryCirculatorFanWebhookContext: deviceWebhookContext & {
        battery: number;
        chargingStatus: "charging" | "uncharged";
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: "off" | 1 | 2;
        oscillation: "on" | "off";
        powerState: "ON" | "OFF";
        version: string;
        verticalOscillation: "on" | "off";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/blindTilt.html b/docs/types/blindTilt.html index 5b983b08..a8528ecf 100644 --- a/docs/types/blindTilt.html +++ b/docs/types/blindTilt.html @@ -1 +1 @@ -blindTilt | node-switchbot

    Type Alias blindTilt

    blindTilt: device & {
        blindTiltDevicesIds: string[];
        calibrate: boolean;
        direction: string;
        group: boolean;
        master: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    +blindTilt | node-switchbot

    Type Alias blindTilt

    blindTilt: device & {
        blindTiltDevicesIds: string[];
        calibrate: boolean;
        direction: string;
        group: boolean;
        master: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/blindTiltServiceData.html b/docs/types/blindTiltServiceData.html index d29b85b8..f733321c 100644 --- a/docs/types/blindTiltServiceData.html +++ b/docs/types/blindTiltServiceData.html @@ -1 +1 @@ -blindTiltServiceData | node-switchbot

    Type Alias blindTiltServiceData

    blindTiltServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        inMotion: boolean;
        lightLevel: number;
        model: BlindTilt;
        modelFriendlyName: BlindTilt;
        modelName: BlindTilt;
        sequenceNumber: number;
        tilt: number;
    }

    Settings

    Member Visibility
    +blindTiltServiceData | node-switchbot

    Type Alias blindTiltServiceData

    blindTiltServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        inMotion: boolean;
        lightLevel: number;
        model: BlindTilt;
        modelFriendlyName: BlindTilt;
        modelName: BlindTilt;
        sequenceNumber: number;
        tilt: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/blindTiltStatus.html b/docs/types/blindTiltStatus.html index 92d03a66..15107e2b 100644 --- a/docs/types/blindTiltStatus.html +++ b/docs/types/blindTiltStatus.html @@ -1 +1 @@ -blindTiltStatus | node-switchbot

    Type Alias blindTiltStatus

    blindTiltStatus: deviceStatus & {
        battery: number;
        calibrate: boolean;
        direction: string;
        lightLevel?: "bright" | "dim";
        slidePosition: string;
    }

    Settings

    Member Visibility
    +blindTiltStatus | node-switchbot

    Type Alias blindTiltStatus

    blindTiltStatus: deviceStatus & {
        battery: number;
        calibrate: boolean;
        direction: string;
        lightLevel?: "bright" | "dim";
        slidePosition: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/blindTiltWebhookContext.html b/docs/types/blindTiltWebhookContext.html index b84a5f3e..0f6e7808 100644 --- a/docs/types/blindTiltWebhookContext.html +++ b/docs/types/blindTiltWebhookContext.html @@ -1 +1 @@ -blindTiltWebhookContext | node-switchbot

    Type Alias blindTiltWebhookContext

    blindTiltWebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        direction: string;
        group: boolean;
        slidePosition: number;
        version: string;
    }

    Settings

    Member Visibility
    +blindTiltWebhookContext | node-switchbot

    Type Alias blindTiltWebhookContext

    blindTiltWebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        direction: string;
        group: boolean;
        slidePosition: number;
        version: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/bot.html b/docs/types/bot.html index 3f10c685..d409b436 100644 --- a/docs/types/bot.html +++ b/docs/types/bot.html @@ -1 +1 @@ -bot | node-switchbot

    Type Alias bot

    bot: device & {}

    Settings

    Member Visibility
    +bot | node-switchbot

    Type Alias bot

    bot: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/botServiceData.html b/docs/types/botServiceData.html index 49025142..09db4aae 100644 --- a/docs/types/botServiceData.html +++ b/docs/types/botServiceData.html @@ -1 +1 @@ -botServiceData | node-switchbot

    Type Alias botServiceData

    botServiceData: serviceData & {
        battery: number;
        mode: boolean;
        model: Bot;
        modelFriendlyName: Bot;
        modelName: Bot;
        state: boolean;
    }

    Settings

    Member Visibility
    +botServiceData | node-switchbot

    Type Alias botServiceData

    botServiceData: serviceData & {
        battery: number;
        mode: boolean;
        model: Bot;
        modelFriendlyName: Bot;
        modelName: Bot;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/botStatus.html b/docs/types/botStatus.html index d027313d..7789493b 100644 --- a/docs/types/botStatus.html +++ b/docs/types/botStatus.html @@ -1 +1 @@ -botStatus | node-switchbot

    Type Alias botStatus

    botStatus: deviceStatus & {
        battery: number;
        mode: "pressMode" | "switchMode" | "customizeMode";
        power: string;
    }

    Settings

    Member Visibility
    +botStatus | node-switchbot

    Type Alias botStatus

    botStatus: deviceStatus & {
        battery: number;
        mode: "pressMode" | "switchMode" | "customizeMode";
        power: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/botWebhookContext.html b/docs/types/botWebhookContext.html index a08ac08c..46ab7fb1 100644 --- a/docs/types/botWebhookContext.html +++ b/docs/types/botWebhookContext.html @@ -1 +1 @@ -botWebhookContext | node-switchbot

    Type Alias botWebhookContext

    botWebhookContext: deviceWebhookContext & {
        battery: number;
        deviceMode: "pressMode" | "switchMode" | "customizeMode";
        power: string;
    }

    Settings

    Member Visibility
    +botWebhookContext | node-switchbot

    Type Alias botWebhookContext

    botWebhookContext: deviceWebhookContext & {
        battery: number;
        deviceMode: "pressMode" | "switchMode" | "customizeMode";
        power: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLight.html b/docs/types/ceilingLight.html index 87da08a1..4bd45f42 100644 --- a/docs/types/ceilingLight.html +++ b/docs/types/ceilingLight.html @@ -1 +1 @@ -ceilingLight | node-switchbot

    Type Alias ceilingLight

    ceilingLight: device & {}

    Settings

    Member Visibility
    +ceilingLight | node-switchbot

    Type Alias ceilingLight

    ceilingLight: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightPro.html b/docs/types/ceilingLightPro.html index 518c2b09..ca1719fe 100644 --- a/docs/types/ceilingLightPro.html +++ b/docs/types/ceilingLightPro.html @@ -1 +1 @@ -ceilingLightPro | node-switchbot

    Type Alias ceilingLightPro

    ceilingLightPro: device & {}

    Settings

    Member Visibility
    +ceilingLightPro | node-switchbot

    Type Alias ceilingLightPro

    ceilingLightPro: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightProServiceData.html b/docs/types/ceilingLightProServiceData.html index 4bd99054..d714eddd 100644 --- a/docs/types/ceilingLightProServiceData.html +++ b/docs/types/ceilingLightProServiceData.html @@ -1 +1 @@ -ceilingLightProServiceData | node-switchbot

    Type Alias ceilingLightProServiceData

    ceilingLightProServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: CeilingLightPro;
        modelFriendlyName: CeilingLightPro;
        modelName: CeilingLightPro;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    +ceilingLightProServiceData | node-switchbot

    Type Alias ceilingLightProServiceData

    ceilingLightProServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: CeilingLightPro;
        modelFriendlyName: CeilingLightPro;
        modelName: CeilingLightPro;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightProStatus.html b/docs/types/ceilingLightProStatus.html index 7c2d1cfe..6f7b8a6b 100644 --- a/docs/types/ceilingLightProStatus.html +++ b/docs/types/ceilingLightProStatus.html @@ -1 +1 @@ -ceilingLightProStatus | node-switchbot

    Type Alias ceilingLightProStatus

    ceilingLightProStatus: deviceStatus & {
        brightness: number;
        colorTemperature: number;
        power: boolean;
    }

    Settings

    Member Visibility
    +ceilingLightProStatus | node-switchbot

    Type Alias ceilingLightProStatus

    ceilingLightProStatus: deviceStatus & {
        brightness: number;
        colorTemperature: number;
        power: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightProWebhookContext.html b/docs/types/ceilingLightProWebhookContext.html index a7123a16..34a80505 100644 --- a/docs/types/ceilingLightProWebhookContext.html +++ b/docs/types/ceilingLightProWebhookContext.html @@ -1 +1 @@ -ceilingLightProWebhookContext | node-switchbot

    Type Alias ceilingLightProWebhookContext

    ceilingLightProWebhookContext: deviceWebhookContext & {
        brightness: number;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    +ceilingLightProWebhookContext | node-switchbot

    Type Alias ceilingLightProWebhookContext

    ceilingLightProWebhookContext: deviceWebhookContext & {
        brightness: number;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightServiceData.html b/docs/types/ceilingLightServiceData.html index ee710608..00a7059d 100644 --- a/docs/types/ceilingLightServiceData.html +++ b/docs/types/ceilingLightServiceData.html @@ -1 +1 @@ -ceilingLightServiceData | node-switchbot

    Type Alias ceilingLightServiceData

    ceilingLightServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: CeilingLight;
        modelFriendlyName: CeilingLight;
        modelName: CeilingLight;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    +ceilingLightServiceData | node-switchbot

    Type Alias ceilingLightServiceData

    ceilingLightServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: CeilingLight;
        modelFriendlyName: CeilingLight;
        modelName: CeilingLight;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightStatus.html b/docs/types/ceilingLightStatus.html index 04af2ea2..0be610f9 100644 --- a/docs/types/ceilingLightStatus.html +++ b/docs/types/ceilingLightStatus.html @@ -1 +1 @@ -ceilingLightStatus | node-switchbot

    Type Alias ceilingLightStatus

    ceilingLightStatus: deviceStatus & {
        brightness: number;
        colorTemperature: number;
        power: boolean;
    }

    Settings

    Member Visibility
    +ceilingLightStatus | node-switchbot

    Type Alias ceilingLightStatus

    ceilingLightStatus: deviceStatus & {
        brightness: number;
        colorTemperature: number;
        power: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightWebhookContext.html b/docs/types/ceilingLightWebhookContext.html index a7794522..2d8d5b8d 100644 --- a/docs/types/ceilingLightWebhookContext.html +++ b/docs/types/ceilingLightWebhookContext.html @@ -1 +1 @@ -ceilingLightWebhookContext | node-switchbot

    Type Alias ceilingLightWebhookContext

    ceilingLightWebhookContext: deviceWebhookContext & {
        brightness: number;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    +ceilingLightWebhookContext | node-switchbot

    Type Alias ceilingLightWebhookContext

    ceilingLightWebhookContext: deviceWebhookContext & {
        brightness: number;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/circulatorFanStatus.html b/docs/types/circulatorFanStatus.html index e8ae13f1..f13b0a89 100644 --- a/docs/types/circulatorFanStatus.html +++ b/docs/types/circulatorFanStatus.html @@ -1 +1 @@ -circulatorFanStatus | node-switchbot

    Type Alias circulatorFanStatus

    circulatorFanStatus: deviceStatus & {
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: number;
        oscillation: string;
        power: string;
        version: string;
        verticalOscillation: string;
    }

    Settings

    Member Visibility
    +circulatorFanStatus | node-switchbot

    Type Alias circulatorFanStatus

    circulatorFanStatus: deviceStatus & {
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: number;
        oscillation: string;
        power: string;
        version: string;
        verticalOscillation: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/circulatorFanWebhookContext.html b/docs/types/circulatorFanWebhookContext.html index d96085af..ee14c8ef 100644 --- a/docs/types/circulatorFanWebhookContext.html +++ b/docs/types/circulatorFanWebhookContext.html @@ -1 +1 @@ -circulatorFanWebhookContext | node-switchbot

    Type Alias circulatorFanWebhookContext

    circulatorFanWebhookContext: deviceWebhookContext & {
        battery: number;
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: "off" | 1 | 2;
        oscillation: "on" | "off";
        powerState: "ON" | "OFF";
        version: string;
        verticalOscillation: "on" | "off";
    }

    Settings

    Member Visibility
    +circulatorFanWebhookContext | node-switchbot

    Type Alias circulatorFanWebhookContext

    circulatorFanWebhookContext: deviceWebhookContext & {
        battery: number;
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: "off" | 1 | 2;
        oscillation: "on" | "off";
        powerState: "ON" | "OFF";
        version: string;
        verticalOscillation: "on" | "off";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/colorBulb.html b/docs/types/colorBulb.html index a9011486..6dd1a939 100644 --- a/docs/types/colorBulb.html +++ b/docs/types/colorBulb.html @@ -1 +1 @@ -colorBulb | node-switchbot

    Type Alias colorBulb

    colorBulb: device & {}

    Settings

    Member Visibility
    +colorBulb | node-switchbot

    Type Alias colorBulb

    colorBulb: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/colorBulbServiceData.html b/docs/types/colorBulbServiceData.html index 4e3e88a0..8047f060 100644 --- a/docs/types/colorBulbServiceData.html +++ b/docs/types/colorBulbServiceData.html @@ -1 +1 @@ -colorBulbServiceData | node-switchbot

    Type Alias colorBulbServiceData

    colorBulbServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: ColorBulb;
        modelFriendlyName: ColorBulb;
        modelName: ColorBulb;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    +colorBulbServiceData | node-switchbot

    Type Alias colorBulbServiceData

    colorBulbServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: ColorBulb;
        modelFriendlyName: ColorBulb;
        modelName: ColorBulb;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/colorBulbStatus.html b/docs/types/colorBulbStatus.html index 0c364463..7e6569f1 100644 --- a/docs/types/colorBulbStatus.html +++ b/docs/types/colorBulbStatus.html @@ -1 +1 @@ -colorBulbStatus | node-switchbot

    Type Alias colorBulbStatus

    colorBulbStatus: deviceStatus & {
        brightness: number;
        color: string;
        colorTemperature: number;
        power: string;
    }

    Settings

    Member Visibility
    +colorBulbStatus | node-switchbot

    Type Alias colorBulbStatus

    colorBulbStatus: deviceStatus & {
        brightness: number;
        color: string;
        colorTemperature: number;
        power: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/colorBulbWebhookContext.html b/docs/types/colorBulbWebhookContext.html index 58d4854c..7a10ff26 100644 --- a/docs/types/colorBulbWebhookContext.html +++ b/docs/types/colorBulbWebhookContext.html @@ -1 +1 @@ -colorBulbWebhookContext | node-switchbot

    Type Alias colorBulbWebhookContext

    colorBulbWebhookContext: deviceWebhookContext & {
        brightness: number;
        color: string;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    +colorBulbWebhookContext | node-switchbot

    Type Alias colorBulbWebhookContext

    colorBulbWebhookContext: deviceWebhookContext & {
        brightness: number;
        color: string;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/contactSensor.html b/docs/types/contactSensor.html index 6ffc5a31..0146968a 100644 --- a/docs/types/contactSensor.html +++ b/docs/types/contactSensor.html @@ -1 +1 @@ -contactSensor | node-switchbot

    Type Alias contactSensor

    contactSensor: device & {}

    Settings

    Member Visibility
    +contactSensor | node-switchbot

    Type Alias contactSensor

    contactSensor: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/contactSensorServiceData.html b/docs/types/contactSensorServiceData.html index d4769f3b..5e7c0faf 100644 --- a/docs/types/contactSensorServiceData.html +++ b/docs/types/contactSensorServiceData.html @@ -1 +1 @@ -contactSensorServiceData | node-switchbot

    Type Alias contactSensorServiceData

    contactSensorServiceData: serviceData & {
        battery: number;
        button_count: number;
        contact_open: boolean;
        contact_timeout: boolean;
        doorState: string;
        lightLevel: string;
        model: ContactSensor;
        modelFriendlyName: ContactSensor;
        modelName: ContactSensor;
        movement: boolean;
        tested: boolean;
    }

    Settings

    Member Visibility
    +contactSensorServiceData | node-switchbot

    Type Alias contactSensorServiceData

    contactSensorServiceData: serviceData & {
        battery: number;
        button_count: number;
        contact_open: boolean;
        contact_timeout: boolean;
        doorState: string;
        lightLevel: string;
        model: ContactSensor;
        modelFriendlyName: ContactSensor;
        modelName: ContactSensor;
        movement: boolean;
        tested: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/contactSensorStatus.html b/docs/types/contactSensorStatus.html index edb58a11..b383b95e 100644 --- a/docs/types/contactSensorStatus.html +++ b/docs/types/contactSensorStatus.html @@ -1 +1 @@ -contactSensorStatus | node-switchbot

    Type Alias contactSensorStatus

    contactSensorStatus: deviceStatus & {
        battery: number;
        brightness: "bright" | "dim";
        moveDetected: boolean;
        openState: "open" | "close" | "timeOutNotClose";
    }

    Settings

    Member Visibility
    +contactSensorStatus | node-switchbot

    Type Alias contactSensorStatus

    contactSensorStatus: deviceStatus & {
        battery: number;
        brightness: "bright" | "dim";
        moveDetected: boolean;
        openState: "open" | "close" | "timeOutNotClose";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/contactSensorWebhookContext.html b/docs/types/contactSensorWebhookContext.html index af06dbef..4d524a37 100644 --- a/docs/types/contactSensorWebhookContext.html +++ b/docs/types/contactSensorWebhookContext.html @@ -1 +1 @@ -contactSensorWebhookContext | node-switchbot

    Type Alias contactSensorWebhookContext

    contactSensorWebhookContext: deviceWebhookContext & {
        battery: number;
        brightness: "dim" | "bright";
        detectionState: "NOT_DETECTED" | "DETECTED";
        doorMode: "IN_DOOR" | "OUT_DOOR";
        openState: "open" | "close" | "timeOutNotClose";
    }

    Settings

    Member Visibility
    +contactSensorWebhookContext | node-switchbot

    Type Alias contactSensorWebhookContext

    contactSensorWebhookContext: deviceWebhookContext & {
        battery: number;
        brightness: "dim" | "bright";
        detectionState: "NOT_DETECTED" | "DETECTED";
        doorMode: "IN_DOOR" | "OUT_DOOR";
        openState: "open" | "close" | "timeOutNotClose";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtain.html b/docs/types/curtain.html index 50f27f0a..1f580d7b 100644 --- a/docs/types/curtain.html +++ b/docs/types/curtain.html @@ -1 +1 @@ -curtain | node-switchbot

    Type Alias curtain

    curtain: device & {
        calibrate: boolean;
        curtainDevicesIds: string[];
        group: boolean;
        master: boolean;
        openDirection: string;
    }

    Settings

    Member Visibility
    +curtain | node-switchbot

    Type Alias curtain

    curtain: device & {
        calibrate: boolean;
        curtainDevicesIds: string[];
        group: boolean;
        master: boolean;
        openDirection: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtain3.html b/docs/types/curtain3.html index 45abd19b..7ce97dc6 100644 --- a/docs/types/curtain3.html +++ b/docs/types/curtain3.html @@ -1 +1 @@ -curtain3 | node-switchbot

    Type Alias curtain3

    curtain3: device & {
        calibrate: boolean;
        curtainDevicesIds: string[];
        group: boolean;
        master: boolean;
        openDirection?: string;
    }

    Settings

    Member Visibility
    +curtain3 | node-switchbot

    Type Alias curtain3

    curtain3: device & {
        calibrate: boolean;
        curtainDevicesIds: string[];
        group: boolean;
        master: boolean;
        openDirection?: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtain3ServiceData.html b/docs/types/curtain3ServiceData.html index 0d7332da..59179bd3 100644 --- a/docs/types/curtain3ServiceData.html +++ b/docs/types/curtain3ServiceData.html @@ -1 +1 @@ -curtain3ServiceData | node-switchbot

    Type Alias curtain3ServiceData

    curtain3ServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        deviceChain: number;
        inMotion: boolean;
        lightLevel: number;
        model: Curtain3;
        modelFriendlyName: Curtain3;
        modelName: Curtain3;
        position: number;
    }

    Settings

    Member Visibility
    +curtain3ServiceData | node-switchbot

    Type Alias curtain3ServiceData

    curtain3ServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        deviceChain: number;
        inMotion: boolean;
        lightLevel: number;
        model: Curtain3;
        modelFriendlyName: Curtain3;
        modelName: Curtain3;
        position: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtain3WebhookContext.html b/docs/types/curtain3WebhookContext.html index 4b81ed99..a3fb3c8c 100644 --- a/docs/types/curtain3WebhookContext.html +++ b/docs/types/curtain3WebhookContext.html @@ -1 +1 @@ -curtain3WebhookContext | node-switchbot

    Type Alias curtain3WebhookContext

    curtain3WebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    +curtain3WebhookContext | node-switchbot

    Type Alias curtain3WebhookContext

    curtain3WebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtainServiceData.html b/docs/types/curtainServiceData.html index 1244333a..761e86c3 100644 --- a/docs/types/curtainServiceData.html +++ b/docs/types/curtainServiceData.html @@ -1 +1 @@ -curtainServiceData | node-switchbot

    Type Alias curtainServiceData

    curtainServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        deviceChain: number;
        inMotion: boolean;
        lightLevel: number;
        model: Curtain;
        modelFriendlyName: Curtain;
        modelName: Curtain;
        position: number;
    }

    Settings

    Member Visibility
    +curtainServiceData | node-switchbot

    Type Alias curtainServiceData

    curtainServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        deviceChain: number;
        inMotion: boolean;
        lightLevel: number;
        model: Curtain;
        modelFriendlyName: Curtain;
        modelName: Curtain;
        position: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtainStatus.html b/docs/types/curtainStatus.html index 78b247a4..c6978367 100644 --- a/docs/types/curtainStatus.html +++ b/docs/types/curtainStatus.html @@ -1 +1 @@ -curtainStatus | node-switchbot

    Type Alias curtainStatus

    curtainStatus: deviceStatus & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        lightLevel?: "bright" | "dim";
        moving: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    +curtainStatus | node-switchbot

    Type Alias curtainStatus

    curtainStatus: deviceStatus & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        lightLevel?: "bright" | "dim";
        moving: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtainWebhookContext.html b/docs/types/curtainWebhookContext.html index 0dcbf93d..450ce87c 100644 --- a/docs/types/curtainWebhookContext.html +++ b/docs/types/curtainWebhookContext.html @@ -1 +1 @@ -curtainWebhookContext | node-switchbot

    Type Alias curtainWebhookContext

    curtainWebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    +curtainWebhookContext | node-switchbot

    Type Alias curtainWebhookContext

    curtainWebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/floorCleaningRobotS10.html b/docs/types/floorCleaningRobotS10.html index c072533f..a4109741 100644 --- a/docs/types/floorCleaningRobotS10.html +++ b/docs/types/floorCleaningRobotS10.html @@ -1 +1 @@ -floorCleaningRobotS10 | node-switchbot

    Type Alias floorCleaningRobotS10

    floorCleaningRobotS10: device & {}

    Settings

    Member Visibility
    +floorCleaningRobotS10 | node-switchbot

    Type Alias floorCleaningRobotS10

    floorCleaningRobotS10: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/floorCleaningRobotS10Status.html b/docs/types/floorCleaningRobotS10Status.html index 5e3b9542..367af4d2 100644 --- a/docs/types/floorCleaningRobotS10Status.html +++ b/docs/types/floorCleaningRobotS10Status.html @@ -1 +1 @@ -floorCleaningRobotS10Status | node-switchbot

    Type Alias floorCleaningRobotS10Status

    floorCleaningRobotS10Status: deviceStatus & {
        battery: number;
        onlineStatus: string;
        taskType: string;
        waterBaseBattery: number;
        workingStatus: string;
    }

    Settings

    Member Visibility
    +floorCleaningRobotS10Status | node-switchbot

    Type Alias floorCleaningRobotS10Status

    floorCleaningRobotS10Status: deviceStatus & {
        battery: number;
        onlineStatus: string;
        taskType: string;
        waterBaseBattery: number;
        workingStatus: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/floorCleaningRobotS10WebhookContext.html b/docs/types/floorCleaningRobotS10WebhookContext.html index 2de4056f..ff387ccb 100644 --- a/docs/types/floorCleaningRobotS10WebhookContext.html +++ b/docs/types/floorCleaningRobotS10WebhookContext.html @@ -1 +1 @@ -floorCleaningRobotS10WebhookContext | node-switchbot

    Type Alias floorCleaningRobotS10WebhookContext

    floorCleaningRobotS10WebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        taskType:
            | "standBy"
            | "explore"
            | "cleanAll"
            | "cleanArea"
            | "cleanRoom"
            | "fillWater"
            | "deepWashing"
            | "backToCharge"
            | "markingWaterBase"
            | "drying"
            | "collectDust"
            | "remoteControl"
            | "cleanWithExplorer"
            | "fillWaterForHumi"
            | "markingHumi";
        waterBaseBattery: number;
        workingStatus: | "Standby"
        | "Clearing"
        | "Paused"
        | "GotoChargeBase"
        | "Charging"
        | "ChargeDone"
        | "Dormant"
        | "InTrouble"
        | "InRemoteControl"
        | "InDustCollecting";
    }

    Settings

    Member Visibility
    +floorCleaningRobotS10WebhookContext | node-switchbot

    Type Alias floorCleaningRobotS10WebhookContext

    floorCleaningRobotS10WebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        taskType:
            | "standBy"
            | "explore"
            | "cleanAll"
            | "cleanArea"
            | "cleanRoom"
            | "fillWater"
            | "deepWashing"
            | "backToCharge"
            | "markingWaterBase"
            | "drying"
            | "collectDust"
            | "remoteControl"
            | "cleanWithExplorer"
            | "fillWaterForHumi"
            | "markingHumi";
        waterBaseBattery: number;
        workingStatus: | "Standby"
        | "Clearing"
        | "Paused"
        | "GotoChargeBase"
        | "Charging"
        | "ChargeDone"
        | "Dormant"
        | "InTrouble"
        | "InRemoteControl"
        | "InDustCollecting";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/hub2.html b/docs/types/hub2.html index 58a3f264..f92e863b 100644 --- a/docs/types/hub2.html +++ b/docs/types/hub2.html @@ -1 +1 @@ -hub2 | node-switchbot

    Type Alias hub2

    hub2: device & {}

    Settings

    Member Visibility
    +hub2 | node-switchbot

    Type Alias hub2

    hub2: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/hub2ServiceData.html b/docs/types/hub2ServiceData.html index c9ffb2a7..cf825fe3 100644 --- a/docs/types/hub2ServiceData.html +++ b/docs/types/hub2ServiceData.html @@ -1 +1 @@ -hub2ServiceData | node-switchbot

    Type Alias hub2ServiceData

    hub2ServiceData: serviceData & {
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        lightLevel: number;
        model: Hub2;
        modelFriendlyName: Hub2;
        modelName: Hub2;
    }

    Settings

    Member Visibility
    +hub2ServiceData | node-switchbot

    Type Alias hub2ServiceData

    hub2ServiceData: serviceData & {
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        lightLevel: number;
        model: Hub2;
        modelFriendlyName: Hub2;
        modelName: Hub2;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/hub2Status.html b/docs/types/hub2Status.html index e6338d9c..771c63ce 100644 --- a/docs/types/hub2Status.html +++ b/docs/types/hub2Status.html @@ -1 +1 @@ -hub2Status | node-switchbot

    Type Alias hub2Status

    hub2Status: deviceStatus & {
        humidity: number;
        lightLevel: number;
        temperature: number;
    }

    Settings

    Member Visibility
    +hub2Status | node-switchbot

    Type Alias hub2Status

    hub2Status: deviceStatus & {
        humidity: number;
        lightLevel: number;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/hub2WebhookContext.html b/docs/types/hub2WebhookContext.html index 743c18f7..3ffcff4b 100644 --- a/docs/types/hub2WebhookContext.html +++ b/docs/types/hub2WebhookContext.html @@ -1 +1 @@ -hub2WebhookContext | node-switchbot

    Type Alias hub2WebhookContext

    hub2WebhookContext: deviceWebhookContext & {
        humidity: number;
        lightLevel: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +hub2WebhookContext | node-switchbot

    Type Alias hub2WebhookContext

    hub2WebhookContext: deviceWebhookContext & {
        humidity: number;
        lightLevel: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifier.html b/docs/types/humidifier.html index 0569a115..7df5b408 100644 --- a/docs/types/humidifier.html +++ b/docs/types/humidifier.html @@ -1 +1 @@ -humidifier | node-switchbot

    Type Alias humidifier

    humidifier: device & {}

    Settings

    Member Visibility
    +humidifier | node-switchbot

    Type Alias humidifier

    humidifier: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/humidifier2ServiceData.html b/docs/types/humidifier2ServiceData.html index 3bdbcfff..70e01fb0 100644 --- a/docs/types/humidifier2ServiceData.html +++ b/docs/types/humidifier2ServiceData.html @@ -1 +1 @@ -humidifier2ServiceData | node-switchbot

    Type Alias humidifier2ServiceData

    humidifier2ServiceData: serviceData & {
        autoMode: boolean;
        childLock: boolean;
        filterAlert: boolean;
        filterMissing: boolean;
        filterRunTime: number;
        humidity: number;
        model: Humidifier2;
        modelFriendlyName: Humidifier2;
        modelName: Humidifier2;
        onState: boolean;
        overHumidifyProtection: boolean;
        percentage: number;
        tankRemoved: boolean;
        temperature: number;
        tiltedAlert: boolean;
        waterLevel: number;
    }

    Settings

    Member Visibility
    +humidifier2ServiceData | node-switchbot

    Type Alias humidifier2ServiceData

    humidifier2ServiceData: serviceData & {
        autoMode: boolean;
        childLock: boolean;
        filterAlert: boolean;
        filterMissing: boolean;
        filterRunTime: number;
        humidity: number;
        model: Humidifier2;
        modelFriendlyName: Humidifier2;
        modelName: Humidifier2;
        onState: boolean;
        overHumidifyProtection: boolean;
        percentage: number;
        tankRemoved: boolean;
        temperature: number;
        tiltedAlert: boolean;
        waterLevel: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifier2Status.html b/docs/types/humidifier2Status.html index 03dd5d2f..6c13bce4 100644 --- a/docs/types/humidifier2Status.html +++ b/docs/types/humidifier2Status.html @@ -1 +1 @@ -humidifier2Status | node-switchbot

    Type Alias humidifier2Status

    humidifier2Status: deviceStatus & {
        auto: boolean;
        childLock: boolean;
        humidity: number;
        lackWater: boolean;
        nebulizationEfficiency: number;
        power: string;
        sound: boolean;
        temperature: number;
    }

    Settings

    Member Visibility
    +humidifier2Status | node-switchbot

    Type Alias humidifier2Status

    humidifier2Status: deviceStatus & {
        auto: boolean;
        childLock: boolean;
        humidity: number;
        lackWater: boolean;
        nebulizationEfficiency: number;
        power: string;
        sound: boolean;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifier2WebhookContext.html b/docs/types/humidifier2WebhookContext.html index 36d1637c..6420ad6a 100644 --- a/docs/types/humidifier2WebhookContext.html +++ b/docs/types/humidifier2WebhookContext.html @@ -1 +1 @@ -humidifier2WebhookContext | node-switchbot

    Type Alias humidifier2WebhookContext

    humidifier2WebhookContext: deviceWebhookContext & {
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +humidifier2WebhookContext | node-switchbot

    Type Alias humidifier2WebhookContext

    humidifier2WebhookContext: deviceWebhookContext & {
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifierServiceData.html b/docs/types/humidifierServiceData.html index 443e5290..0c3b28a7 100644 --- a/docs/types/humidifierServiceData.html +++ b/docs/types/humidifierServiceData.html @@ -1 +1 @@ -humidifierServiceData | node-switchbot

    Type Alias humidifierServiceData

    humidifierServiceData: serviceData & {
        autoMode: boolean;
        humidity: number;
        model: Humidifier;
        modelFriendlyName: Humidifier;
        modelName: Humidifier;
        onState: boolean;
        percentage: number;
    }

    Settings

    Member Visibility
    +humidifierServiceData | node-switchbot

    Type Alias humidifierServiceData

    humidifierServiceData: serviceData & {
        autoMode: boolean;
        humidity: number;
        model: Humidifier;
        modelFriendlyName: Humidifier;
        modelName: Humidifier;
        onState: boolean;
        percentage: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifierStatus.html b/docs/types/humidifierStatus.html index e5f53d49..d212b8e5 100644 --- a/docs/types/humidifierStatus.html +++ b/docs/types/humidifierStatus.html @@ -1 +1 @@ -humidifierStatus | node-switchbot

    Type Alias humidifierStatus

    humidifierStatus: deviceStatus & {
        auto: boolean;
        childLock: boolean;
        humidity: number;
        lackWater: boolean;
        nebulizationEfficiency: number;
        power: string;
        sound: boolean;
        temperature: number;
    }

    Settings

    Member Visibility
    +humidifierStatus | node-switchbot

    Type Alias humidifierStatus

    humidifierStatus: deviceStatus & {
        auto: boolean;
        childLock: boolean;
        humidity: number;
        lackWater: boolean;
        nebulizationEfficiency: number;
        power: string;
        sound: boolean;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifierWebhookContext.html b/docs/types/humidifierWebhookContext.html index 1e2dbfab..4fc42001 100644 --- a/docs/types/humidifierWebhookContext.html +++ b/docs/types/humidifierWebhookContext.html @@ -1 +1 @@ -humidifierWebhookContext | node-switchbot

    Type Alias humidifierWebhookContext

    humidifierWebhookContext: deviceWebhookContext & {
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +humidifierWebhookContext | node-switchbot

    Type Alias humidifierWebhookContext

    humidifierWebhookContext: deviceWebhookContext & {
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/indoorCam.html b/docs/types/indoorCam.html index 88198ac6..00bcc597 100644 --- a/docs/types/indoorCam.html +++ b/docs/types/indoorCam.html @@ -1 +1 @@ -indoorCam | node-switchbot

    Type Alias indoorCam

    indoorCam: device & {}

    Settings

    Member Visibility
    +indoorCam | node-switchbot

    Type Alias indoorCam

    indoorCam: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/indoorCameraWebhookContext.html b/docs/types/indoorCameraWebhookContext.html index e4126712..089306a8 100644 --- a/docs/types/indoorCameraWebhookContext.html +++ b/docs/types/indoorCameraWebhookContext.html @@ -1 +1 @@ -indoorCameraWebhookContext | node-switchbot

    Type Alias indoorCameraWebhookContext

    indoorCameraWebhookContext: deviceWebhookContext & {
        detectionState: "DETECTED";
    }

    Settings

    Member Visibility
    +indoorCameraWebhookContext | node-switchbot

    Type Alias indoorCameraWebhookContext

    indoorCameraWebhookContext: deviceWebhookContext & {
        detectionState: "DETECTED";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/keypad.html b/docs/types/keypad.html index 53e760e2..36cfba60 100644 --- a/docs/types/keypad.html +++ b/docs/types/keypad.html @@ -1 +1 @@ -keypad | node-switchbot

    Type Alias keypad

    keypad: device & { keyList: keyList; lockDeviceId: string; remoteType: string }

    Settings

    Member Visibility
    +keypad | node-switchbot

    Type Alias keypad

    keypad: device & { keyList: keyList; lockDeviceId: string; remoteType: string }

    Settings

    Member Visibility
    diff --git a/docs/types/keypadDetectorServiceData.html b/docs/types/keypadDetectorServiceData.html index 606d27b8..8795050b 100644 --- a/docs/types/keypadDetectorServiceData.html +++ b/docs/types/keypadDetectorServiceData.html @@ -1 +1 @@ -keypadDetectorServiceData | node-switchbot

    Type Alias keypadDetectorServiceData

    keypadDetectorServiceData: serviceData & {
        battery: number;
        event: boolean;
        low_battery: boolean;
        model: Keypad;
        modelFriendlyName: Keypad;
        modelName: Keypad;
        tampered: boolean;
    }

    Settings

    Member Visibility
    +keypadDetectorServiceData | node-switchbot

    Type Alias keypadDetectorServiceData

    keypadDetectorServiceData: serviceData & {
        battery: number;
        event: boolean;
        low_battery: boolean;
        model: Keypad;
        modelFriendlyName: Keypad;
        modelName: Keypad;
        tampered: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/keypadTouch.html b/docs/types/keypadTouch.html index 6adf96fd..070a9667 100644 --- a/docs/types/keypadTouch.html +++ b/docs/types/keypadTouch.html @@ -1 +1 @@ -keypadTouch | node-switchbot

    Type Alias keypadTouch

    keypadTouch: device & {
        keyList: keyList;
        lockDeviceId: string;
        remoteType: string;
    }

    Settings

    Member Visibility
    +keypadTouch | node-switchbot

    Type Alias keypadTouch

    keypadTouch: device & {
        keyList: keyList;
        lockDeviceId: string;
        remoteType: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/keypadTouchWebhookContext.html b/docs/types/keypadTouchWebhookContext.html index a3430fdc..16cc0bd7 100644 --- a/docs/types/keypadTouchWebhookContext.html +++ b/docs/types/keypadTouchWebhookContext.html @@ -1 +1 @@ -keypadTouchWebhookContext | node-switchbot

    Type Alias keypadTouchWebhookContext

    keypadTouchWebhookContext: deviceWebhookContext & {
        commandId: string;
        eventName: "createKey" | "deleteKey";
        result: "success" | "failed" | "timeout";
    }

    Settings

    Member Visibility
    +keypadTouchWebhookContext | node-switchbot

    Type Alias keypadTouchWebhookContext

    keypadTouchWebhookContext: deviceWebhookContext & {
        commandId: string;
        eventName: "createKey" | "deleteKey";
        result: "success" | "failed" | "timeout";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/keypadWebhookContext.html b/docs/types/keypadWebhookContext.html index 77de4b24..d9740a3f 100644 --- a/docs/types/keypadWebhookContext.html +++ b/docs/types/keypadWebhookContext.html @@ -1 +1 @@ -keypadWebhookContext | node-switchbot

    Type Alias keypadWebhookContext

    keypadWebhookContext: deviceWebhookContext & {
        commandId: string;
        eventName: "createKey" | "deleteKey";
        result: "success" | "failed" | "timeout";
    }

    Settings

    Member Visibility
    +keypadWebhookContext | node-switchbot

    Type Alias keypadWebhookContext

    keypadWebhookContext: deviceWebhookContext & {
        commandId: string;
        eventName: "createKey" | "deleteKey";
        result: "success" | "failed" | "timeout";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lock.html b/docs/types/lock.html index 1d0df836..db8ca056 100644 --- a/docs/types/lock.html +++ b/docs/types/lock.html @@ -1 +1 @@ -lock | node-switchbot

    Type Alias lock

    lock: device & {
        group: boolean;
        groupName: string;
        lockDevicesIds: string[];
        master: boolean;
    }

    Settings

    Member Visibility
    +lock | node-switchbot

    Type Alias lock

    lock: device & {
        group: boolean;
        groupName: string;
        lockDevicesIds: string[];
        master: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockPro.html b/docs/types/lockPro.html index 01d016fc..a5a0ff95 100644 --- a/docs/types/lockPro.html +++ b/docs/types/lockPro.html @@ -1 +1 @@ -lockPro | node-switchbot

    Type Alias lockPro

    lockPro: device & {
        group: boolean;
        groupName: string;
        lockDevicesIds: string[];
        master: boolean;
    }

    Settings

    Member Visibility
    +lockPro | node-switchbot

    Type Alias lockPro

    lockPro: device & {
        group: boolean;
        groupName: string;
        lockDevicesIds: string[];
        master: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockProServiceData.html b/docs/types/lockProServiceData.html index e06688ff..6f1a6190 100644 --- a/docs/types/lockProServiceData.html +++ b/docs/types/lockProServiceData.html @@ -1 +1 @@ -lockProServiceData | node-switchbot

    Type Alias lockProServiceData

    lockProServiceData: serviceData & {
        auto_lock_paused: boolean;
        battery: number;
        calibration: boolean;
        door_open: boolean;
        double_lock_mode: boolean;
        model: LockPro;
        modelFriendlyName: LockPro;
        modelName: LockPro;
        night_latch: boolean;
        status: string;
        unclosed_alarm: boolean;
        unlocked_alarm: boolean;
        update_from_secondary_lock: boolean;
    }

    Settings

    Member Visibility
    +lockProServiceData | node-switchbot

    Type Alias lockProServiceData

    lockProServiceData: serviceData & {
        auto_lock_paused: boolean;
        battery: number;
        calibration: boolean;
        door_open: boolean;
        double_lock_mode: boolean;
        model: LockPro;
        modelFriendlyName: LockPro;
        modelName: LockPro;
        night_latch: boolean;
        status: string;
        unclosed_alarm: boolean;
        unlocked_alarm: boolean;
        update_from_secondary_lock: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockProStatus.html b/docs/types/lockProStatus.html index 27ce3ac4..171ae5e7 100644 --- a/docs/types/lockProStatus.html +++ b/docs/types/lockProStatus.html @@ -1 +1 @@ -lockProStatus | node-switchbot

    Type Alias lockProStatus

    lockProStatus: deviceStatus & {
        battery: number;
        doorState: string;
        lockState: string;
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    +lockProStatus | node-switchbot

    Type Alias lockProStatus

    lockProStatus: deviceStatus & {
        battery: number;
        doorState: string;
        lockState: string;
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockProWebhookContext.html b/docs/types/lockProWebhookContext.html index fe4384cc..dad5e44e 100644 --- a/docs/types/lockProWebhookContext.html +++ b/docs/types/lockProWebhookContext.html @@ -1 +1 @@ -lockProWebhookContext | node-switchbot

    Type Alias lockProWebhookContext

    lockProWebhookContext: deviceWebhookContext & {
        battery: number;
        lockState: "UNLOCKED" | "LOCKED" | "JAMMED";
    }

    Settings

    Member Visibility
    +lockProWebhookContext | node-switchbot

    Type Alias lockProWebhookContext

    lockProWebhookContext: deviceWebhookContext & {
        battery: number;
        lockState: "UNLOCKED" | "LOCKED" | "JAMMED";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockServiceData.html b/docs/types/lockServiceData.html index bfe47ebf..9db98bfb 100644 --- a/docs/types/lockServiceData.html +++ b/docs/types/lockServiceData.html @@ -1 +1 @@ -lockServiceData | node-switchbot

    Type Alias lockServiceData

    lockServiceData: serviceData & {
        auto_lock_paused: boolean;
        battery: number;
        calibration: boolean;
        door_open: boolean;
        double_lock_mode: boolean;
        model: Lock;
        modelFriendlyName: Lock;
        modelName: Lock;
        night_latch: boolean;
        status: string;
        unclosed_alarm: boolean;
        unlocked_alarm: boolean;
        update_from_secondary_lock: boolean;
    }

    Settings

    Member Visibility
    +lockServiceData | node-switchbot

    Type Alias lockServiceData

    lockServiceData: serviceData & {
        auto_lock_paused: boolean;
        battery: number;
        calibration: boolean;
        door_open: boolean;
        double_lock_mode: boolean;
        model: Lock;
        modelFriendlyName: Lock;
        modelName: Lock;
        night_latch: boolean;
        status: string;
        unclosed_alarm: boolean;
        unlocked_alarm: boolean;
        update_from_secondary_lock: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockStatus.html b/docs/types/lockStatus.html index 738877a8..d274b3f3 100644 --- a/docs/types/lockStatus.html +++ b/docs/types/lockStatus.html @@ -1 +1 @@ -lockStatus | node-switchbot

    Type Alias lockStatus

    lockStatus: deviceStatus & {
        battery: number;
        doorState: string;
        lockState: string;
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    +lockStatus | node-switchbot

    Type Alias lockStatus

    lockStatus: deviceStatus & {
        battery: number;
        doorState: string;
        lockState: string;
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockWebhookContext.html b/docs/types/lockWebhookContext.html index 0adff51f..cd91c37e 100644 --- a/docs/types/lockWebhookContext.html +++ b/docs/types/lockWebhookContext.html @@ -1 +1 @@ -lockWebhookContext | node-switchbot

    Type Alias lockWebhookContext

    lockWebhookContext: deviceWebhookContext & {
        battery: number;
        lockState: "UNLOCKED" | "LOCKED" | "JAMMED";
    }

    Settings

    Member Visibility
    +lockWebhookContext | node-switchbot

    Type Alias lockWebhookContext

    lockWebhookContext: deviceWebhookContext & {
        battery: number;
        lockState: "UNLOCKED" | "LOCKED" | "JAMMED";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meter.html b/docs/types/meter.html index 42b77ae2..d4988467 100644 --- a/docs/types/meter.html +++ b/docs/types/meter.html @@ -1 +1 @@ -meter | node-switchbot

    Type Alias meter

    meter: device & {}

    Settings

    Member Visibility
    +meter | node-switchbot

    Type Alias meter

    meter: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/meterPlus.html b/docs/types/meterPlus.html index 7d5cebe5..6322eed8 100644 --- a/docs/types/meterPlus.html +++ b/docs/types/meterPlus.html @@ -1 +1 @@ -meterPlus | node-switchbot

    Type Alias meterPlus

    meterPlus: device & {}

    Settings

    Member Visibility
    +meterPlus | node-switchbot

    Type Alias meterPlus

    meterPlus: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/meterPlusServiceData.html b/docs/types/meterPlusServiceData.html index ada9ee4e..a2b78cf4 100644 --- a/docs/types/meterPlusServiceData.html +++ b/docs/types/meterPlusServiceData.html @@ -1 +1 @@ -meterPlusServiceData | node-switchbot

    Type Alias meterPlusServiceData

    meterPlusServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterPlus;
        modelFriendlyName: MeterPlus;
        modelName: MeterPlus;
    }

    Settings

    Member Visibility
    +meterPlusServiceData | node-switchbot

    Type Alias meterPlusServiceData

    meterPlusServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterPlus;
        modelFriendlyName: MeterPlus;
        modelName: MeterPlus;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterPlusStatus.html b/docs/types/meterPlusStatus.html index e672fc6e..29868514 100644 --- a/docs/types/meterPlusStatus.html +++ b/docs/types/meterPlusStatus.html @@ -1 +1 @@ -meterPlusStatus | node-switchbot

    Type Alias meterPlusStatus

    meterPlusStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    +meterPlusStatus | node-switchbot

    Type Alias meterPlusStatus

    meterPlusStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterPlusWebhookContext.html b/docs/types/meterPlusWebhookContext.html index 5dc18eb6..65738aa4 100644 --- a/docs/types/meterPlusWebhookContext.html +++ b/docs/types/meterPlusWebhookContext.html @@ -1 +1 @@ -meterPlusWebhookContext | node-switchbot

    Type Alias meterPlusWebhookContext

    meterPlusWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +meterPlusWebhookContext | node-switchbot

    Type Alias meterPlusWebhookContext

    meterPlusWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterPro.html b/docs/types/meterPro.html index 840f44d3..0cd5a233 100644 --- a/docs/types/meterPro.html +++ b/docs/types/meterPro.html @@ -1 +1 @@ -meterPro | node-switchbot

    Type Alias meterPro

    meterPro: device & {}

    Settings

    Member Visibility
    +meterPro | node-switchbot

    Type Alias meterPro

    meterPro: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/meterProCO2ServiceData.html b/docs/types/meterProCO2ServiceData.html index 060ca939..7e604f15 100644 --- a/docs/types/meterProCO2ServiceData.html +++ b/docs/types/meterProCO2ServiceData.html @@ -1 +1 @@ -meterProCO2ServiceData | node-switchbot

    Type Alias meterProCO2ServiceData

    meterProCO2ServiceData: serviceData & {
        battery: number;
        celsius: number;
        co2: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterProCO2;
        modelFriendlyName: MeterProCO2;
        modelName: MeterProCO2;
    }

    Settings

    Member Visibility
    +meterProCO2ServiceData | node-switchbot

    Type Alias meterProCO2ServiceData

    meterProCO2ServiceData: serviceData & {
        battery: number;
        celsius: number;
        co2: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterProCO2;
        modelFriendlyName: MeterProCO2;
        modelName: MeterProCO2;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterProCO2Status.html b/docs/types/meterProCO2Status.html index b03ed691..eccf9199 100644 --- a/docs/types/meterProCO2Status.html +++ b/docs/types/meterProCO2Status.html @@ -1 +1 @@ -meterProCO2Status | node-switchbot

    Type Alias meterProCO2Status

    meterProCO2Status: deviceStatus & {
        battery: number;
        CO2: number;
        humidity: number;
        temperature: number;
        version: string;
    }

    Settings

    Member Visibility
    +meterProCO2Status | node-switchbot

    Type Alias meterProCO2Status

    meterProCO2Status: deviceStatus & {
        battery: number;
        CO2: number;
        humidity: number;
        temperature: number;
        version: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterProCO2WebhookContext.html b/docs/types/meterProCO2WebhookContext.html index 723c597a..86533f42 100644 --- a/docs/types/meterProCO2WebhookContext.html +++ b/docs/types/meterProCO2WebhookContext.html @@ -1 +1 @@ -meterProCO2WebhookContext | node-switchbot

    Type Alias meterProCO2WebhookContext

    meterProCO2WebhookContext: deviceWebhookContext & {
        battery: number;
        CO2: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +meterProCO2WebhookContext | node-switchbot

    Type Alias meterProCO2WebhookContext

    meterProCO2WebhookContext: deviceWebhookContext & {
        battery: number;
        CO2: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterProServiceData.html b/docs/types/meterProServiceData.html index aabe3664..baad410f 100644 --- a/docs/types/meterProServiceData.html +++ b/docs/types/meterProServiceData.html @@ -1 +1 @@ -meterProServiceData | node-switchbot

    Type Alias meterProServiceData

    meterProServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterPro;
        modelFriendlyName: MeterPro;
        modelName: MeterPro;
    }

    Settings

    Member Visibility
    +meterProServiceData | node-switchbot

    Type Alias meterProServiceData

    meterProServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterPro;
        modelFriendlyName: MeterPro;
        modelName: MeterPro;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterProStatus.html b/docs/types/meterProStatus.html index 7816492a..dca04400 100644 --- a/docs/types/meterProStatus.html +++ b/docs/types/meterProStatus.html @@ -1 +1 @@ -meterProStatus | node-switchbot

    Type Alias meterProStatus

    meterProStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
        version: string;
    }

    Settings

    Member Visibility
    +meterProStatus | node-switchbot

    Type Alias meterProStatus

    meterProStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
        version: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterProWebhookContext.html b/docs/types/meterProWebhookContext.html index 65d48373..49412a79 100644 --- a/docs/types/meterProWebhookContext.html +++ b/docs/types/meterProWebhookContext.html @@ -1 +1 @@ -meterProWebhookContext | node-switchbot

    Type Alias meterProWebhookContext

    meterProWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +meterProWebhookContext | node-switchbot

    Type Alias meterProWebhookContext

    meterProWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterServiceData.html b/docs/types/meterServiceData.html index 3c1d2ecd..33d87bd2 100644 --- a/docs/types/meterServiceData.html +++ b/docs/types/meterServiceData.html @@ -1 +1 @@ -meterServiceData | node-switchbot

    Type Alias meterServiceData

    meterServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: Meter;
        modelFriendlyName: Meter;
        modelName: Meter;
    }

    Settings

    Member Visibility
    +meterServiceData | node-switchbot

    Type Alias meterServiceData

    meterServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: Meter;
        modelFriendlyName: Meter;
        modelName: Meter;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterStatus.html b/docs/types/meterStatus.html index 8774c567..0e5c6d34 100644 --- a/docs/types/meterStatus.html +++ b/docs/types/meterStatus.html @@ -1 +1 @@ -meterStatus | node-switchbot

    Type Alias meterStatus

    meterStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    +meterStatus | node-switchbot

    Type Alias meterStatus

    meterStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterWebhookContext.html b/docs/types/meterWebhookContext.html index 2c2d722b..7b75dd97 100644 --- a/docs/types/meterWebhookContext.html +++ b/docs/types/meterWebhookContext.html @@ -1 +1 @@ -meterWebhookContext | node-switchbot

    Type Alias meterWebhookContext

    meterWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +meterWebhookContext | node-switchbot

    Type Alias meterWebhookContext

    meterWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/motionSensor.html b/docs/types/motionSensor.html index 7059edd8..5ac30d55 100644 --- a/docs/types/motionSensor.html +++ b/docs/types/motionSensor.html @@ -1 +1 @@ -motionSensor | node-switchbot

    Type Alias motionSensor

    motionSensor: device & {}

    Settings

    Member Visibility
    +motionSensor | node-switchbot

    Type Alias motionSensor

    motionSensor: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/motionSensorServiceData.html b/docs/types/motionSensorServiceData.html index 9563ad01..df8f35fb 100644 --- a/docs/types/motionSensorServiceData.html +++ b/docs/types/motionSensorServiceData.html @@ -1 +1 @@ -motionSensorServiceData | node-switchbot

    Type Alias motionSensorServiceData

    motionSensorServiceData: serviceData & {
        battery: number;
        iot: number;
        is_light: boolean;
        led: number;
        lightLevel: string;
        model: MotionSensor;
        modelFriendlyName: MotionSensor;
        modelName: MotionSensor;
        movement: boolean;
        sense_distance: number;
        tested: boolean;
    }

    Settings

    Member Visibility
    +motionSensorServiceData | node-switchbot

    Type Alias motionSensorServiceData

    motionSensorServiceData: serviceData & {
        battery: number;
        iot: number;
        is_light: boolean;
        led: number;
        lightLevel: string;
        model: MotionSensor;
        modelFriendlyName: MotionSensor;
        modelName: MotionSensor;
        movement: boolean;
        sense_distance: number;
        tested: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/motionSensorStatus.html b/docs/types/motionSensorStatus.html index 255dc82a..782b4826 100644 --- a/docs/types/motionSensorStatus.html +++ b/docs/types/motionSensorStatus.html @@ -1 +1 @@ -motionSensorStatus | node-switchbot

    Type Alias motionSensorStatus

    motionSensorStatus: deviceStatus & {
        battery: number;
        brightness: "bright" | "dim";
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    +motionSensorStatus | node-switchbot

    Type Alias motionSensorStatus

    motionSensorStatus: deviceStatus & {
        battery: number;
        brightness: "bright" | "dim";
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/motionSensorWebhookContext.html b/docs/types/motionSensorWebhookContext.html index 21badf8e..054dccfb 100644 --- a/docs/types/motionSensorWebhookContext.html +++ b/docs/types/motionSensorWebhookContext.html @@ -1 +1 @@ -motionSensorWebhookContext | node-switchbot

    Type Alias motionSensorWebhookContext

    motionSensorWebhookContext: deviceWebhookContext & {
        battery: number;
        detectionState: "NOT_DETECTED" | "DETECTED";
    }

    Settings

    Member Visibility
    +motionSensorWebhookContext | node-switchbot

    Type Alias motionSensorWebhookContext

    motionSensorWebhookContext: deviceWebhookContext & {
        battery: number;
        detectionState: "NOT_DETECTED" | "DETECTED";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/onadvertisement.html b/docs/types/onadvertisement.html index 7c31d440..a3c187e0 100644 --- a/docs/types/onadvertisement.html +++ b/docs/types/onadvertisement.html @@ -1 +1 @@ -onadvertisement | node-switchbot

    Type Alias onadvertisement

    onadvertisement: (ad: ad) => Promise<void> | void

    Type declaration

      • (ad: ad): Promise<void> | void

      • Parameters

        Returns Promise<void> | void

    Settings

    Member Visibility
    +onadvertisement | node-switchbot

    Type Alias onadvertisement

    onadvertisement: (ad: ad) => Promise<void> | void

    Type declaration

      • (ad: ad): Promise<void> | void

      • Parameters

        Returns Promise<void> | void

    Settings

    Member Visibility
    diff --git a/docs/types/ondiscover.html b/docs/types/ondiscover.html index d03dca40..6424a520 100644 --- a/docs/types/ondiscover.html +++ b/docs/types/ondiscover.html @@ -1 +1 @@ -ondiscover | node-switchbot

    Type Alias ondiscover

    ondiscover: (device: SwitchbotDevice) => Promise<void> | void

    Type declaration

    Settings

    Member Visibility
    +ondiscover | node-switchbot

    Type Alias ondiscover

    ondiscover: (device: SwitchbotDevice) => Promise<void> | void

    Type declaration

    Settings

    Member Visibility
    diff --git a/docs/types/outdoorMeter.html b/docs/types/outdoorMeter.html index 314d0f70..ba6d1d4a 100644 --- a/docs/types/outdoorMeter.html +++ b/docs/types/outdoorMeter.html @@ -1 +1 @@ -outdoorMeter | node-switchbot

    Type Alias outdoorMeter

    outdoorMeter: device & {}

    Settings

    Member Visibility
    +outdoorMeter | node-switchbot

    Type Alias outdoorMeter

    outdoorMeter: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/outdoorMeterServiceData.html b/docs/types/outdoorMeterServiceData.html index 19fbd9d4..09ce0863 100644 --- a/docs/types/outdoorMeterServiceData.html +++ b/docs/types/outdoorMeterServiceData.html @@ -1 +1 @@ -outdoorMeterServiceData | node-switchbot

    Type Alias outdoorMeterServiceData

    outdoorMeterServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: OutdoorMeter;
        modelFriendlyName: OutdoorMeter;
        modelName: OutdoorMeter;
    }

    Settings

    Member Visibility
    +outdoorMeterServiceData | node-switchbot

    Type Alias outdoorMeterServiceData

    outdoorMeterServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: OutdoorMeter;
        modelFriendlyName: OutdoorMeter;
        modelName: OutdoorMeter;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/outdoorMeterStatus.html b/docs/types/outdoorMeterStatus.html index e118951b..abb84b11 100644 --- a/docs/types/outdoorMeterStatus.html +++ b/docs/types/outdoorMeterStatus.html @@ -1 +1 @@ -outdoorMeterStatus | node-switchbot

    Type Alias outdoorMeterStatus

    outdoorMeterStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    +outdoorMeterStatus | node-switchbot

    Type Alias outdoorMeterStatus

    outdoorMeterStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/outdoorMeterWebhookContext.html b/docs/types/outdoorMeterWebhookContext.html index 031b9253..1ac32d9b 100644 --- a/docs/types/outdoorMeterWebhookContext.html +++ b/docs/types/outdoorMeterWebhookContext.html @@ -1 +1 @@ -outdoorMeterWebhookContext | node-switchbot

    Type Alias outdoorMeterWebhookContext

    outdoorMeterWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +outdoorMeterWebhookContext | node-switchbot

    Type Alias outdoorMeterWebhookContext

    outdoorMeterWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/panTiltCamWebhookContext.html b/docs/types/panTiltCamWebhookContext.html index 63616e78..d6e3fbeb 100644 --- a/docs/types/panTiltCamWebhookContext.html +++ b/docs/types/panTiltCamWebhookContext.html @@ -1 +1 @@ -panTiltCamWebhookContext | node-switchbot

    Type Alias panTiltCamWebhookContext

    panTiltCamWebhookContext: deviceWebhookContext & { detectionState: "DETECTED" }

    Settings

    Member Visibility
    +panTiltCamWebhookContext | node-switchbot

    Type Alias panTiltCamWebhookContext

    panTiltCamWebhookContext: deviceWebhookContext & { detectionState: "DETECTED" }

    Settings

    Member Visibility
    diff --git a/docs/types/pantiltCam.html b/docs/types/pantiltCam.html index 43d6d07f..1ae8f29d 100644 --- a/docs/types/pantiltCam.html +++ b/docs/types/pantiltCam.html @@ -1 +1 @@ -pantiltCam | node-switchbot

    Type Alias pantiltCam

    pantiltCam: device & {}

    Settings

    Member Visibility
    +pantiltCam | node-switchbot

    Type Alias pantiltCam

    pantiltCam: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/pantiltCam2k.html b/docs/types/pantiltCam2k.html index 9f38eae3..a2c355ba 100644 --- a/docs/types/pantiltCam2k.html +++ b/docs/types/pantiltCam2k.html @@ -1 +1 @@ -pantiltCam2k | node-switchbot

    Type Alias pantiltCam2k

    pantiltCam2k: device & {}

    Settings

    Member Visibility
    +pantiltCam2k | node-switchbot

    Type Alias pantiltCam2k

    pantiltCam2k: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/plug.html b/docs/types/plug.html index 612f02aa..5760147e 100644 --- a/docs/types/plug.html +++ b/docs/types/plug.html @@ -1 +1 @@ -plug | node-switchbot

    Type Alias plug

    plug: device & {}

    Settings

    Member Visibility
    +plug | node-switchbot

    Type Alias plug

    plug: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/plugMini.html b/docs/types/plugMini.html index 86c00d83..f006554c 100644 --- a/docs/types/plugMini.html +++ b/docs/types/plugMini.html @@ -1 +1 @@ -plugMini | node-switchbot

    Type Alias plugMini

    plugMini: device & {}

    Settings

    Member Visibility
    +plugMini | node-switchbot

    Type Alias plugMini

    plugMini: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/plugMiniJPServiceData.html b/docs/types/plugMiniJPServiceData.html index 20751e09..9e76f224 100644 --- a/docs/types/plugMiniJPServiceData.html +++ b/docs/types/plugMiniJPServiceData.html @@ -1 +1 @@ -plugMiniJPServiceData | node-switchbot

    Type Alias plugMiniJPServiceData

    plugMiniJPServiceData: serviceData & {
        currentPower: number;
        delay: boolean;
        model: PlugMiniJP;
        modelFriendlyName: PlugMini;
        modelName: PlugMini;
        overload: boolean;
        state: string;
        syncUtcTime: boolean;
        timer: boolean;
        wifiRssi: number;
    }

    Settings

    Member Visibility
    +plugMiniJPServiceData | node-switchbot

    Type Alias plugMiniJPServiceData

    plugMiniJPServiceData: serviceData & {
        currentPower: number;
        delay: boolean;
        model: PlugMiniJP;
        modelFriendlyName: PlugMini;
        modelName: PlugMini;
        overload: boolean;
        state: string;
        syncUtcTime: boolean;
        timer: boolean;
        wifiRssi: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/plugMiniJPWebhookContext.html b/docs/types/plugMiniJPWebhookContext.html index cf296397..888581e8 100644 --- a/docs/types/plugMiniJPWebhookContext.html +++ b/docs/types/plugMiniJPWebhookContext.html @@ -1 +1 @@ -plugMiniJPWebhookContext | node-switchbot

    Type Alias plugMiniJPWebhookContext

    plugMiniJPWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    +plugMiniJPWebhookContext | node-switchbot

    Type Alias plugMiniJPWebhookContext

    plugMiniJPWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    diff --git a/docs/types/plugMiniStatus.html b/docs/types/plugMiniStatus.html index 83b21e3f..5e76344c 100644 --- a/docs/types/plugMiniStatus.html +++ b/docs/types/plugMiniStatus.html @@ -1 +1 @@ -plugMiniStatus | node-switchbot

    Type Alias plugMiniStatus

    plugMiniStatus: deviceStatus & {
        electricCurrent: Float64Array;
        electricityOfDay: number;
        power: string;
        voltage: Float64Array;
        weight: Float64Array;
    }

    Settings

    Member Visibility
    +plugMiniStatus | node-switchbot

    Type Alias plugMiniStatus

    plugMiniStatus: deviceStatus & {
        electricCurrent: Float64Array;
        electricityOfDay: number;
        power: string;
        voltage: Float64Array;
        weight: Float64Array;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/plugMiniUSServiceData.html b/docs/types/plugMiniUSServiceData.html index 65312c32..af69e3d3 100644 --- a/docs/types/plugMiniUSServiceData.html +++ b/docs/types/plugMiniUSServiceData.html @@ -1 +1 @@ -plugMiniUSServiceData | node-switchbot

    Type Alias plugMiniUSServiceData

    plugMiniUSServiceData: serviceData & {
        currentPower: number;
        delay: boolean;
        model: PlugMiniUS;
        modelFriendlyName: PlugMini;
        modelName: PlugMini;
        overload: boolean;
        state: string;
        syncUtcTime: boolean;
        timer: boolean;
        wifiRssi: number;
    }

    Settings

    Member Visibility
    +plugMiniUSServiceData | node-switchbot

    Type Alias plugMiniUSServiceData

    plugMiniUSServiceData: serviceData & {
        currentPower: number;
        delay: boolean;
        model: PlugMiniUS;
        modelFriendlyName: PlugMini;
        modelName: PlugMini;
        overload: boolean;
        state: string;
        syncUtcTime: boolean;
        timer: boolean;
        wifiRssi: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/plugMiniUSWebhookContext.html b/docs/types/plugMiniUSWebhookContext.html index 18d3b7ae..ac264a22 100644 --- a/docs/types/plugMiniUSWebhookContext.html +++ b/docs/types/plugMiniUSWebhookContext.html @@ -1 +1 @@ -plugMiniUSWebhookContext | node-switchbot

    Type Alias plugMiniUSWebhookContext

    plugMiniUSWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    +plugMiniUSWebhookContext | node-switchbot

    Type Alias plugMiniUSWebhookContext

    plugMiniUSWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    diff --git a/docs/types/plugStatus.html b/docs/types/plugStatus.html index 50d5b90c..4984dadd 100644 --- a/docs/types/plugStatus.html +++ b/docs/types/plugStatus.html @@ -1 +1 @@ -plugStatus | node-switchbot

    Type Alias plugStatus

    plugStatus: deviceStatus & { power: string; version: string }

    Settings

    Member Visibility
    +plugStatus | node-switchbot

    Type Alias plugStatus

    plugStatus: deviceStatus & { power: string; version: string }

    Settings

    Member Visibility
    diff --git a/docs/types/plugWebhookContext.html b/docs/types/plugWebhookContext.html index 970b8f78..250f650c 100644 --- a/docs/types/plugWebhookContext.html +++ b/docs/types/plugWebhookContext.html @@ -1 +1 @@ -plugWebhookContext | node-switchbot

    Type Alias plugWebhookContext

    plugWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    +plugWebhookContext | node-switchbot

    Type Alias plugWebhookContext

    plugWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1Context.html b/docs/types/relaySwitch1Context.html index d2c1f42c..f2d48201 100644 --- a/docs/types/relaySwitch1Context.html +++ b/docs/types/relaySwitch1Context.html @@ -1 +1 @@ -relaySwitch1Context | node-switchbot

    Type Alias relaySwitch1Context

    relaySwitch1Context: deviceWebhookContext & {
        online: boolean;
        overTemperature: boolean;
        switchStatus: 0 | 1;
        version: string;
    }

    Settings

    Member Visibility
    +relaySwitch1Context | node-switchbot

    Type Alias relaySwitch1Context

    relaySwitch1Context: deviceWebhookContext & {
        online: boolean;
        overTemperature: boolean;
        switchStatus: 0 | 1;
        version: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1PMContext.html b/docs/types/relaySwitch1PMContext.html index 9260c5a5..5ec42008 100644 --- a/docs/types/relaySwitch1PMContext.html +++ b/docs/types/relaySwitch1PMContext.html @@ -1 +1 @@ -relaySwitch1PMContext | node-switchbot

    Type Alias relaySwitch1PMContext

    relaySwitch1PMContext: deviceWebhookContext & {
        online: boolean;
        overload: boolean;
        overTemperature: boolean;
        switchStatus: 0 | 1;
        version: string;
    }

    Settings

    Member Visibility
    +relaySwitch1PMContext | node-switchbot

    Type Alias relaySwitch1PMContext

    relaySwitch1PMContext: deviceWebhookContext & {
        online: boolean;
        overload: boolean;
        overTemperature: boolean;
        switchStatus: 0 | 1;
        version: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1PMServiceData.html b/docs/types/relaySwitch1PMServiceData.html index bf1e9987..42c47366 100644 --- a/docs/types/relaySwitch1PMServiceData.html +++ b/docs/types/relaySwitch1PMServiceData.html @@ -1 +1 @@ -relaySwitch1PMServiceData | node-switchbot

    Type Alias relaySwitch1PMServiceData

    relaySwitch1PMServiceData: serviceData & {
        current: number;
        mode: boolean;
        model: RelaySwitch1PM;
        modelFriendlyName: RelaySwitch1PM;
        modelName: RelaySwitch1PM;
        power: number;
        sequence_number: number;
        state: boolean;
        voltage: number;
    }

    Settings

    Member Visibility
    +relaySwitch1PMServiceData | node-switchbot

    Type Alias relaySwitch1PMServiceData

    relaySwitch1PMServiceData: serviceData & {
        current: number;
        mode: boolean;
        model: RelaySwitch1PM;
        modelFriendlyName: RelaySwitch1PM;
        modelName: RelaySwitch1PM;
        power: number;
        sequence_number: number;
        state: boolean;
        voltage: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1PMStatus.html b/docs/types/relaySwitch1PMStatus.html index 840e79b5..630efc90 100644 --- a/docs/types/relaySwitch1PMStatus.html +++ b/docs/types/relaySwitch1PMStatus.html @@ -1 +1 @@ -relaySwitch1PMStatus | node-switchbot

    Type Alias relaySwitch1PMStatus

    relaySwitch1PMStatus: deviceStatus & {
        electricCurrent: number;
        power: number;
        switchStatus: 0 | 1;
        usedElectricity: number;
        version: string;
        voltage: number;
    }

    Settings

    Member Visibility
    +relaySwitch1PMStatus | node-switchbot

    Type Alias relaySwitch1PMStatus

    relaySwitch1PMStatus: deviceStatus & {
        electricCurrent: number;
        power: number;
        switchStatus: 0 | 1;
        usedElectricity: number;
        version: string;
        voltage: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1ServiceData.html b/docs/types/relaySwitch1ServiceData.html index aea68ac8..d6512b76 100644 --- a/docs/types/relaySwitch1ServiceData.html +++ b/docs/types/relaySwitch1ServiceData.html @@ -1 +1 @@ -relaySwitch1ServiceData | node-switchbot

    Type Alias relaySwitch1ServiceData

    relaySwitch1ServiceData: serviceData & {
        mode: boolean;
        model: RelaySwitch1;
        modelFriendlyName: RelaySwitch1;
        modelName: RelaySwitch1;
        sequence_number: number;
        state: boolean;
    }

    Settings

    Member Visibility
    +relaySwitch1ServiceData | node-switchbot

    Type Alias relaySwitch1ServiceData

    relaySwitch1ServiceData: serviceData & {
        mode: boolean;
        model: RelaySwitch1;
        modelFriendlyName: RelaySwitch1;
        modelName: RelaySwitch1;
        sequence_number: number;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1Status.html b/docs/types/relaySwitch1Status.html index b6e00606..e7ff6d20 100644 --- a/docs/types/relaySwitch1Status.html +++ b/docs/types/relaySwitch1Status.html @@ -1 +1 @@ -relaySwitch1Status | node-switchbot

    Type Alias relaySwitch1Status

    relaySwitch1Status: deviceStatus & { switchStatus: 0 | 1; version: string }

    Settings

    Member Visibility
    +relaySwitch1Status | node-switchbot

    Type Alias relaySwitch1Status

    relaySwitch1Status: deviceStatus & { switchStatus: 0 | 1; version: string }

    Settings

    Member Visibility
    diff --git a/docs/types/remote.html b/docs/types/remote.html index 2614deb1..496d8a54 100644 --- a/docs/types/remote.html +++ b/docs/types/remote.html @@ -1 +1 @@ -remote | node-switchbot

    Type Alias remote

    remote: device & {}

    Settings

    Member Visibility
    +remote | node-switchbot

    Type Alias remote

    remote: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/remoteServiceData.html b/docs/types/remoteServiceData.html index e1bfca29..eae49d62 100644 --- a/docs/types/remoteServiceData.html +++ b/docs/types/remoteServiceData.html @@ -1 +1 @@ -remoteServiceData | node-switchbot

    Type Alias remoteServiceData

    remoteServiceData: serviceData & {
        battery: number;
        model: Remote;
        modelFriendlyName: Remote;
        modelName: Remote;
    }

    Settings

    Member Visibility
    +remoteServiceData | node-switchbot

    Type Alias remoteServiceData

    remoteServiceData: serviceData & {
        battery: number;
        model: Remote;
        modelFriendlyName: Remote;
        modelName: Remote;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1.html b/docs/types/robotVacuumCleanerS1.html index 6b426a33..fabd46b5 100644 --- a/docs/types/robotVacuumCleanerS1.html +++ b/docs/types/robotVacuumCleanerS1.html @@ -1 +1 @@ -robotVacuumCleanerS1 | node-switchbot

    Type Alias robotVacuumCleanerS1

    robotVacuumCleanerS1: device & {}

    Settings

    Member Visibility
    +robotVacuumCleanerS1 | node-switchbot

    Type Alias robotVacuumCleanerS1

    robotVacuumCleanerS1: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1Plus.html b/docs/types/robotVacuumCleanerS1Plus.html index 062a4777..a013e3ee 100644 --- a/docs/types/robotVacuumCleanerS1Plus.html +++ b/docs/types/robotVacuumCleanerS1Plus.html @@ -1 +1 @@ -robotVacuumCleanerS1Plus | node-switchbot

    Type Alias robotVacuumCleanerS1Plus

    robotVacuumCleanerS1Plus: device & {}

    Settings

    Member Visibility
    +robotVacuumCleanerS1Plus | node-switchbot

    Type Alias robotVacuumCleanerS1Plus

    robotVacuumCleanerS1Plus: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1PlusStatus.html b/docs/types/robotVacuumCleanerS1PlusStatus.html index 75b6602a..9deb05a4 100644 --- a/docs/types/robotVacuumCleanerS1PlusStatus.html +++ b/docs/types/robotVacuumCleanerS1PlusStatus.html @@ -1 +1 @@ -robotVacuumCleanerS1PlusStatus | node-switchbot

    Type Alias robotVacuumCleanerS1PlusStatus

    robotVacuumCleanerS1PlusStatus: deviceStatus & {
        battery: number;
        onlineStatus: string;
        workingStatus: string;
    }

    Settings

    Member Visibility
    +robotVacuumCleanerS1PlusStatus | node-switchbot

    Type Alias robotVacuumCleanerS1PlusStatus

    robotVacuumCleanerS1PlusStatus: deviceStatus & {
        battery: number;
        onlineStatus: string;
        workingStatus: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1PlusWebhookContext.html b/docs/types/robotVacuumCleanerS1PlusWebhookContext.html index 39df9370..95fb49f9 100644 --- a/docs/types/robotVacuumCleanerS1PlusWebhookContext.html +++ b/docs/types/robotVacuumCleanerS1PlusWebhookContext.html @@ -1 +1 @@ -robotVacuumCleanerS1PlusWebhookContext | node-switchbot

    Type Alias robotVacuumCleanerS1PlusWebhookContext

    robotVacuumCleanerS1PlusWebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        workingStatus:
            | "Standby"
            | "Clearing"
            | "Paused"
            | "GotoChargeBase"
            | "Charging"
            | "ChargeDone"
            | "Dormant"
            | "InTrouble"
            | "InRemoteControl"
            | "InDustCollecting";
    }

    Settings

    Member Visibility
    +robotVacuumCleanerS1PlusWebhookContext | node-switchbot

    Type Alias robotVacuumCleanerS1PlusWebhookContext

    robotVacuumCleanerS1PlusWebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        workingStatus:
            | "Standby"
            | "Clearing"
            | "Paused"
            | "GotoChargeBase"
            | "Charging"
            | "ChargeDone"
            | "Dormant"
            | "InTrouble"
            | "InRemoteControl"
            | "InDustCollecting";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1Status.html b/docs/types/robotVacuumCleanerS1Status.html index 0a4b9e56..7e67aa75 100644 --- a/docs/types/robotVacuumCleanerS1Status.html +++ b/docs/types/robotVacuumCleanerS1Status.html @@ -1 +1 @@ -robotVacuumCleanerS1Status | node-switchbot

    Type Alias robotVacuumCleanerS1Status

    robotVacuumCleanerS1Status: deviceStatus & {
        battery: number;
        onlineStatus: string;
        workingStatus: string;
    }

    Settings

    Member Visibility
    +robotVacuumCleanerS1Status | node-switchbot

    Type Alias robotVacuumCleanerS1Status

    robotVacuumCleanerS1Status: deviceStatus & {
        battery: number;
        onlineStatus: string;
        workingStatus: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1WebhookContext.html b/docs/types/robotVacuumCleanerS1WebhookContext.html index 6054d296..39fa7d92 100644 --- a/docs/types/robotVacuumCleanerS1WebhookContext.html +++ b/docs/types/robotVacuumCleanerS1WebhookContext.html @@ -1 +1 @@ -robotVacuumCleanerS1WebhookContext | node-switchbot

    Type Alias robotVacuumCleanerS1WebhookContext

    robotVacuumCleanerS1WebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        workingStatus:
            | "Standby"
            | "Clearing"
            | "Paused"
            | "GotoChargeBase"
            | "Charging"
            | "ChargeDone"
            | "Dormant"
            | "InTrouble"
            | "InRemoteControl"
            | "InDustCollecting";
    }

    Settings

    Member Visibility
    +robotVacuumCleanerS1WebhookContext | node-switchbot

    Type Alias robotVacuumCleanerS1WebhookContext

    robotVacuumCleanerS1WebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        workingStatus:
            | "Standby"
            | "Clearing"
            | "Paused"
            | "GotoChargeBase"
            | "Charging"
            | "ChargeDone"
            | "Dormant"
            | "InTrouble"
            | "InRemoteControl"
            | "InDustCollecting";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerServiceData.html b/docs/types/robotVacuumCleanerServiceData.html index 6e4810c6..7663dd20 100644 --- a/docs/types/robotVacuumCleanerServiceData.html +++ b/docs/types/robotVacuumCleanerServiceData.html @@ -1 +1 @@ -robotVacuumCleanerServiceData | node-switchbot

    Type Alias robotVacuumCleanerServiceData

    robotVacuumCleanerServiceData: serviceData & {
        battery: number;
        model: Unknown;
        modelFriendlyName: Unknown;
        modelName: Unknown;
        state: string;
    }

    Settings

    Member Visibility
    +robotVacuumCleanerServiceData | node-switchbot

    Type Alias robotVacuumCleanerServiceData

    robotVacuumCleanerServiceData: serviceData & {
        battery: number;
        model: Unknown;
        modelFriendlyName: Unknown;
        modelName: Unknown;
        state: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/stripLight.html b/docs/types/stripLight.html index 57f1d51b..b5dd45d7 100644 --- a/docs/types/stripLight.html +++ b/docs/types/stripLight.html @@ -1 +1 @@ -stripLight | node-switchbot

    Type Alias stripLight

    stripLight: device & {}

    Settings

    Member Visibility
    +stripLight | node-switchbot

    Type Alias stripLight

    stripLight: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/stripLightServiceData.html b/docs/types/stripLightServiceData.html index fcf393ce..5f522195 100644 --- a/docs/types/stripLightServiceData.html +++ b/docs/types/stripLightServiceData.html @@ -1 +1 @@ -stripLightServiceData | node-switchbot

    Type Alias stripLightServiceData

    stripLightServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        delay: number;
        green: number;
        loop_index: number;
        model: StripLight;
        modelFriendlyName: StripLight;
        modelName: StripLight;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    +stripLightServiceData | node-switchbot

    Type Alias stripLightServiceData

    stripLightServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        delay: number;
        green: number;
        loop_index: number;
        model: StripLight;
        modelFriendlyName: StripLight;
        modelName: StripLight;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/stripLightStatus.html b/docs/types/stripLightStatus.html index dbe29931..b1e08c85 100644 --- a/docs/types/stripLightStatus.html +++ b/docs/types/stripLightStatus.html @@ -1 +1 @@ -stripLightStatus | node-switchbot

    Type Alias stripLightStatus

    stripLightStatus: deviceStatus & {
        brightness: number;
        color: string;
        power: string;
    }

    Settings

    Member Visibility
    +stripLightStatus | node-switchbot

    Type Alias stripLightStatus

    stripLightStatus: deviceStatus & {
        brightness: number;
        color: string;
        power: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/stripLightWebhookContext.html b/docs/types/stripLightWebhookContext.html index 23c6209b..f30fc78f 100644 --- a/docs/types/stripLightWebhookContext.html +++ b/docs/types/stripLightWebhookContext.html @@ -1 +1 @@ -stripLightWebhookContext | node-switchbot

    Type Alias stripLightWebhookContext

    stripLightWebhookContext: deviceWebhookContext & {
        brightness: number;
        color: string;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    +stripLightWebhookContext | node-switchbot

    Type Alias stripLightWebhookContext

    stripLightWebhookContext: deviceWebhookContext & {
        brightness: number;
        color: string;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/waterLeakDetector.html b/docs/types/waterLeakDetector.html index cdb26c35..103d7bdb 100644 --- a/docs/types/waterLeakDetector.html +++ b/docs/types/waterLeakDetector.html @@ -1 +1 @@ -waterLeakDetector | node-switchbot

    Type Alias waterLeakDetector

    waterLeakDetector: device & {}

    Settings

    Member Visibility
    +waterLeakDetector | node-switchbot

    Type Alias waterLeakDetector

    waterLeakDetector: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/waterLeakDetectorServiceData.html b/docs/types/waterLeakDetectorServiceData.html index 04075224..f5c5387f 100644 --- a/docs/types/waterLeakDetectorServiceData.html +++ b/docs/types/waterLeakDetectorServiceData.html @@ -1 +1 @@ -waterLeakDetectorServiceData | node-switchbot

    Type Alias waterLeakDetectorServiceData

    waterLeakDetectorServiceData: serviceData & {
        battery: number;
        leak: boolean;
        low_battery: boolean;
        model: Leak;
        modelFriendlyName: Leak;
        modelName: Leak;
        tampered: boolean;
    }

    Settings

    Member Visibility
    +waterLeakDetectorServiceData | node-switchbot

    Type Alias waterLeakDetectorServiceData

    waterLeakDetectorServiceData: serviceData & {
        battery: number;
        leak: boolean;
        low_battery: boolean;
        model: Leak;
        modelFriendlyName: Leak;
        modelName: Leak;
        tampered: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/waterLeakDetectorStatus.html b/docs/types/waterLeakDetectorStatus.html index 3f92f65d..bb162110 100644 --- a/docs/types/waterLeakDetectorStatus.html +++ b/docs/types/waterLeakDetectorStatus.html @@ -1 +1 @@ -waterLeakDetectorStatus | node-switchbot

    Type Alias waterLeakDetectorStatus

    waterLeakDetectorStatus: deviceStatus & { battery: number; status: 0 | 1 }

    Settings

    Member Visibility
    +waterLeakDetectorStatus | node-switchbot

    Type Alias waterLeakDetectorStatus

    waterLeakDetectorStatus: deviceStatus & { battery: number; status: 0 | 1 }

    Settings

    Member Visibility
    diff --git a/docs/types/waterLeakDetectorWebhookContext.html b/docs/types/waterLeakDetectorWebhookContext.html index 0d381410..9df1d63e 100644 --- a/docs/types/waterLeakDetectorWebhookContext.html +++ b/docs/types/waterLeakDetectorWebhookContext.html @@ -1 +1 @@ -waterLeakDetectorWebhookContext | node-switchbot

    Type Alias waterLeakDetectorWebhookContext

    waterLeakDetectorWebhookContext: deviceWebhookContext & {
        battery: number;
        detectionState: 0 | 1;
    }

    Settings

    Member Visibility
    +waterLeakDetectorWebhookContext | node-switchbot

    Type Alias waterLeakDetectorWebhookContext

    waterLeakDetectorWebhookContext: deviceWebhookContext & {
        battery: number;
        detectionState: 0 | 1;
    }

    Settings

    Member Visibility
    From c8e8ae233879918a57eeaf7a00dc2228fc46024d Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 21 Aug 2025 05:17:49 +0000 Subject: [PATCH 3/3] Add comprehensive GitHub Copilot instructions with validated commands Co-authored-by: donavanbecker <9875439+donavanbecker@users.noreply.github.com> --- .github/copilot-instructions.md | 165 ++++++++++++++++++ docs/classes/Advertising.html | 8 +- docs/classes/SwitchBotBLE.html | 16 +- docs/classes/SwitchBotOpenAPI.html | 14 +- docs/classes/SwitchbotDevice.html | 24 +-- docs/classes/WoBlindTilt.html | 42 ++--- docs/classes/WoBulb.html | 38 ++-- docs/classes/WoCeilingLight.html | 44 ++--- docs/classes/WoContact.html | 26 +-- docs/classes/WoCurtain.html | 36 ++-- docs/classes/WoHand.html | 36 ++-- docs/classes/WoHub2.html | 26 +-- docs/classes/WoHumi.html | 40 ++--- docs/classes/WoHumi2.html | 40 ++--- docs/classes/WoIOSensorTH.html | 26 +-- docs/classes/WoKeypad.html | 26 +-- docs/classes/WoLeak.html | 26 +-- docs/classes/WoPlugMiniJP.html | 36 ++-- docs/classes/WoPlugMiniUS.html | 36 ++-- docs/classes/WoPresence.html | 26 +-- docs/classes/WoRelaySwitch1.html | 30 ++-- docs/classes/WoRelaySwitch1PM.html | 30 ++-- docs/classes/WoRemote.html | 26 +-- docs/classes/WoSensorTH.html | 24 +-- docs/classes/WoSensorTHPlus.html | 24 +-- docs/classes/WoSensorTHPro.html | 24 +-- docs/classes/WoSensorTHProCO2.html | 24 +-- docs/classes/WoSmartLock.html | 46 ++--- docs/classes/WoSmartLockPro.html | 46 ++--- docs/classes/WoStrip.html | 40 ++--- docs/enums/LogLevel.html | 4 +- docs/enums/SwitchBotBLEModel.html | 4 +- docs/enums/SwitchBotBLEModelFriendlyName.html | 4 +- docs/enums/SwitchBotBLEModelName.html | 4 +- docs/enums/SwitchBotModel.html | 4 +- docs/interfaces/AdvertisementData.html | 4 +- docs/interfaces/Chars.html | 4 +- docs/interfaces/ErrorObject.html | 4 +- docs/interfaces/NobleTypes.html | 4 +- docs/interfaces/Params.html | 4 +- docs/interfaces/Rule.html | 4 +- docs/interfaces/ServiceData.html | 4 +- docs/interfaces/SwitchBotBLEDevice.html | 4 +- docs/interfaces/WebhookDetail.html | 4 +- docs/interfaces/ad.html | 4 +- docs/interfaces/body.html | 4 +- docs/interfaces/bodyChange.html | 4 +- docs/interfaces/deleteWebhookResponse.html | 4 +- docs/interfaces/device.html | 4 +- docs/interfaces/deviceList.html | 4 +- docs/interfaces/deviceStatus.html | 4 +- docs/interfaces/deviceStatusRequest.html | 4 +- docs/interfaces/deviceWebhook.html | 4 +- docs/interfaces/deviceWebhookContext.html | 4 +- docs/interfaces/devices.html | 4 +- docs/interfaces/infraredRemoteList.html | 4 +- docs/interfaces/irdevice.html | 4 +- docs/interfaces/pushResponse.html | 4 +- docs/interfaces/queryWebhookResponse.html | 4 +- docs/interfaces/setupWebhookResponse.html | 4 +- docs/interfaces/switchbot.html | 4 +- docs/interfaces/updateWebhookResponse.html | 4 +- docs/interfaces/webhookRequest.html | 4 +- docs/types/MacAddress.html | 2 +- docs/types/batteryCirculatorFan.html | 2 +- .../batteryCirculatorFanServiceData.html | 2 +- docs/types/batteryCirculatorFanStatus.html | 2 +- .../batteryCirculatorFanWebhookContext.html | 2 +- docs/types/blindTilt.html | 2 +- docs/types/blindTiltServiceData.html | 2 +- docs/types/blindTiltStatus.html | 2 +- docs/types/blindTiltWebhookContext.html | 2 +- docs/types/bot.html | 2 +- docs/types/botServiceData.html | 2 +- docs/types/botStatus.html | 2 +- docs/types/botWebhookContext.html | 2 +- docs/types/ceilingLight.html | 2 +- docs/types/ceilingLightPro.html | 2 +- docs/types/ceilingLightProServiceData.html | 2 +- docs/types/ceilingLightProStatus.html | 2 +- docs/types/ceilingLightProWebhookContext.html | 2 +- docs/types/ceilingLightServiceData.html | 2 +- docs/types/ceilingLightStatus.html | 2 +- docs/types/ceilingLightWebhookContext.html | 2 +- docs/types/circulatorFanStatus.html | 2 +- docs/types/circulatorFanWebhookContext.html | 2 +- docs/types/colorBulb.html | 2 +- docs/types/colorBulbServiceData.html | 2 +- docs/types/colorBulbStatus.html | 2 +- docs/types/colorBulbWebhookContext.html | 2 +- docs/types/contactSensor.html | 2 +- docs/types/contactSensorServiceData.html | 2 +- docs/types/contactSensorStatus.html | 2 +- docs/types/contactSensorWebhookContext.html | 2 +- docs/types/curtain.html | 2 +- docs/types/curtain3.html | 2 +- docs/types/curtain3ServiceData.html | 2 +- docs/types/curtain3WebhookContext.html | 2 +- docs/types/curtainServiceData.html | 2 +- docs/types/curtainStatus.html | 2 +- docs/types/curtainWebhookContext.html | 2 +- docs/types/floorCleaningRobotS10.html | 2 +- docs/types/floorCleaningRobotS10Status.html | 2 +- .../floorCleaningRobotS10WebhookContext.html | 2 +- docs/types/hub2.html | 2 +- docs/types/hub2ServiceData.html | 2 +- docs/types/hub2Status.html | 2 +- docs/types/hub2WebhookContext.html | 2 +- docs/types/humidifier.html | 2 +- docs/types/humidifier2ServiceData.html | 2 +- docs/types/humidifier2Status.html | 2 +- docs/types/humidifier2WebhookContext.html | 2 +- docs/types/humidifierServiceData.html | 2 +- docs/types/humidifierStatus.html | 2 +- docs/types/humidifierWebhookContext.html | 2 +- docs/types/indoorCam.html | 2 +- docs/types/indoorCameraWebhookContext.html | 2 +- docs/types/keypad.html | 2 +- docs/types/keypadDetectorServiceData.html | 2 +- docs/types/keypadTouch.html | 2 +- docs/types/keypadTouchWebhookContext.html | 2 +- docs/types/keypadWebhookContext.html | 2 +- docs/types/lock.html | 2 +- docs/types/lockPro.html | 2 +- docs/types/lockProServiceData.html | 2 +- docs/types/lockProStatus.html | 2 +- docs/types/lockProWebhookContext.html | 2 +- docs/types/lockServiceData.html | 2 +- docs/types/lockStatus.html | 2 +- docs/types/lockWebhookContext.html | 2 +- docs/types/meter.html | 2 +- docs/types/meterPlus.html | 2 +- docs/types/meterPlusServiceData.html | 2 +- docs/types/meterPlusStatus.html | 2 +- docs/types/meterPlusWebhookContext.html | 2 +- docs/types/meterPro.html | 2 +- docs/types/meterProCO2ServiceData.html | 2 +- docs/types/meterProCO2Status.html | 2 +- docs/types/meterProCO2WebhookContext.html | 2 +- docs/types/meterProServiceData.html | 2 +- docs/types/meterProStatus.html | 2 +- docs/types/meterProWebhookContext.html | 2 +- docs/types/meterServiceData.html | 2 +- docs/types/meterStatus.html | 2 +- docs/types/meterWebhookContext.html | 2 +- docs/types/motionSensor.html | 2 +- docs/types/motionSensorServiceData.html | 2 +- docs/types/motionSensorStatus.html | 2 +- docs/types/motionSensorWebhookContext.html | 2 +- docs/types/onadvertisement.html | 2 +- docs/types/ondiscover.html | 2 +- docs/types/outdoorMeter.html | 2 +- docs/types/outdoorMeterServiceData.html | 2 +- docs/types/outdoorMeterStatus.html | 2 +- docs/types/outdoorMeterWebhookContext.html | 2 +- docs/types/panTiltCamWebhookContext.html | 2 +- docs/types/pantiltCam.html | 2 +- docs/types/pantiltCam2k.html | 2 +- docs/types/plug.html | 2 +- docs/types/plugMini.html | 2 +- docs/types/plugMiniJPServiceData.html | 2 +- docs/types/plugMiniJPWebhookContext.html | 2 +- docs/types/plugMiniStatus.html | 2 +- docs/types/plugMiniUSServiceData.html | 2 +- docs/types/plugMiniUSWebhookContext.html | 2 +- docs/types/plugStatus.html | 2 +- docs/types/plugWebhookContext.html | 2 +- docs/types/relaySwitch1Context.html | 2 +- docs/types/relaySwitch1PMContext.html | 2 +- docs/types/relaySwitch1PMServiceData.html | 2 +- docs/types/relaySwitch1PMStatus.html | 2 +- docs/types/relaySwitch1ServiceData.html | 2 +- docs/types/relaySwitch1Status.html | 2 +- docs/types/remote.html | 2 +- docs/types/remoteServiceData.html | 2 +- docs/types/robotVacuumCleanerS1.html | 2 +- docs/types/robotVacuumCleanerS1Plus.html | 2 +- .../types/robotVacuumCleanerS1PlusStatus.html | 2 +- ...obotVacuumCleanerS1PlusWebhookContext.html | 2 +- docs/types/robotVacuumCleanerS1Status.html | 2 +- .../robotVacuumCleanerS1WebhookContext.html | 2 +- docs/types/robotVacuumCleanerServiceData.html | 2 +- docs/types/stripLight.html | 2 +- docs/types/stripLightServiceData.html | 2 +- docs/types/stripLightStatus.html | 2 +- docs/types/stripLightWebhookContext.html | 2 +- docs/types/waterLeakDetector.html | 2 +- docs/types/waterLeakDetectorServiceData.html | 2 +- docs/types/waterLeakDetectorStatus.html | 2 +- .../waterLeakDetectorWebhookContext.html | 2 +- 190 files changed, 798 insertions(+), 633 deletions(-) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 00000000..67e1454c --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,165 @@ +# Node-SwitchBot Development Instructions + +Always reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here. + +## Working Effectively + +### Bootstrap and Setup +- Install Node.js (^20 || ^22 || ^24): Use the existing version if available +- Install dependencies: `npm install` -- takes ~5-25 seconds (varies by cache). **NEVER CANCEL** +- Build the project: `npm run build` -- takes ~5 seconds. **NEVER CANCEL** +- Run tests: `npm run test` -- takes ~1 second with 12 tests. **NEVER CANCEL** + +### Development Workflow +- **ALWAYS run these commands in order when starting work:** + 1. `npm install` + 2. `npm run build` + 3. `npm run test` + 4. `npm run lint` +- **Build and validate EVERY change**: After any code modification, always run `npm run build && npm run test && npm run lint` +- **NEVER skip linting**: Run `npm run lint` before committing or the CI (.github/workflows/build.yml) will fail +- **Use lint:fix for automatic fixes**: `npm run lint:fix` to automatically fix ESLint issues + +### Platform Requirements and Constraints +- **BLE functionality requires Linux-based OS only** (Raspbian, Ubuntu, etc.) +- **Windows and macOS are NOT supported** for BLE operations (use OpenAPI instead) +- **Node.js versions**: Must use ^20, ^22, or ^24 (currently using v20.19.4) +- **ES Modules**: This project uses `"type": "module"` - always use ES import/export syntax + +### Testing and Validation +- **Basic functionality test**: After any changes to core classes, run this validation: + ```javascript + const { SwitchBotBLE, SwitchBotOpenAPI } = require('./dist/index.js'); + const ble = new SwitchBotBLE(); // Should not throw + const api = new SwitchBotOpenAPI('test', 'test'); // Should not throw + ``` +- **Complete test suite**: `npm run test` (12 tests) -- should always pass before committing +- **Test coverage**: `npm run test-coverage` to see coverage report (~15% coverage is normal) +- **Documentation generation**: `npm run docs` generates TypeDoc documentation in ./docs/ + +### Build and Timing Expectations +- **npm install**: ~5-25 seconds (varies by cache) -- **NEVER CANCEL**. Set timeout to 5+ minutes for safety +- **npm run build**: ~5 seconds -- **NEVER CANCEL**. Set timeout to 2+ minutes for safety +- **npm run test**: ~1 second (12 tests) -- **NEVER CANCEL**. Set timeout to 2+ minutes for safety +- **npm run lint**: ~3 seconds -- **NEVER CANCEL**. Set timeout to 2+ minutes for safety +- **npm run docs**: ~2 seconds -- **NEVER CANCEL**. Set timeout to 2+ minutes for safety + +## Project Structure and Key Files + +### Source Code Organization +- **src/index.ts**: Main export file - exports SwitchBotBLE, SwitchBotOpenAPI, and device classes +- **src/switchbot-ble.ts**: Bluetooth Low Energy interface for direct device control +- **src/switchbot-openapi.ts**: HTTP API interface for cloud-based SwitchBot control +- **src/device.ts**: Individual device classes (WoHand, WoCurtain, WoSmartLock, etc.) +- **src/types/**: TypeScript type definitions for all device interfaces +- **src/settings.ts**: Configuration constants and API URLs +- **dist/**: Compiled JavaScript output (generated by `npm run build`) + +### Configuration Files +- **package.json**: Main project config - scripts, dependencies, ES module config +- **tsconfig.json**: TypeScript compilation settings (target: ES2022, module: ES2022) +- **eslint.config.js**: ESLint configuration using @antfu/eslint-config +- **jest.config.js**: Test configuration (uses Vitest, not Jest) +- **.gitignore**: Excludes dist/, node_modules/, coverage/, and build artifacts + +### Documentation +- **README.md**: Main project documentation and installation instructions +- **BLE.md**: Comprehensive BLE usage documentation and device examples +- **OpenAPI.md**: OpenAPI usage documentation and authentication setup +- **CHANGELOG.md**: Version history and release notes +- **docs/**: Generated TypeDoc API documentation (HTML format) + +## Common Development Tasks + +### Adding New Device Support +- **Add device class**: Create new class in src/device.ts extending SwitchbotDevice +- **Update exports**: Add export to src/index.ts +- **Add type definitions**: Create types in src/types/ if needed +- **Test basic instantiation**: Ensure the device class can be imported and instantiated +- **Always run full build and test cycle**: `npm run build && npm run test && npm run lint` + +### API Changes and Extensions +- **OpenAPI changes**: Modify src/switchbot-openapi.ts +- **BLE changes**: Modify src/switchbot-ble.ts +- **Update type definitions**: Modify corresponding files in src/types/ +- **Always verify exports**: Check that new functionality is exported in src/index.ts +- **Test import functionality**: Verify new exports can be imported correctly + +### Working with Dependencies +- **Noble (BLE)**: @stoprocent/noble for Bluetooth functionality - Linux only +- **HTTP requests**: Uses undici for HTTP calls (not axios or fetch) +- **Async operations**: Uses async-mutex for concurrency control +- **Adding dependencies**: Use `npm install --save` for runtime deps, `--save-dev` for dev deps + +## Validation and Quality Assurance + +### Pre-commit Checklist +1. **Build succeeds**: `npm run build` completes without errors +2. **All tests pass**: `npm run test` shows all 12 tests passing +3. **Linting passes**: `npm run lint` shows no errors +4. **Documentation builds**: `npm run docs` generates without warnings +5. **Basic import works**: Can import and instantiate main classes + +### Manual Testing Scenarios +- **SwitchBotBLE instantiation**: `new SwitchBotBLE()` should not throw errors +- **SwitchBotOpenAPI instantiation**: `new SwitchBotOpenAPI('token', 'secret')` should not throw +- **Module exports**: All exported classes should be importable from main package +- **TypeScript compilation**: No TypeScript errors in dist/ output +- **Documentation completeness**: Check that new public APIs appear in generated docs + +### CI/CD Integration +- **GitHub Actions**: Build runs on push to 'latest' branch and PRs +- **External workflows**: Uses OpenWonderLabs/.github/.github/workflows/nodejs-build-and-test.yml +- **Required checks**: Build, test, and lint must all pass +- **Coverage reporting**: Test coverage is tracked and reported + +## Troubleshooting Common Issues + +### BLE Not Working +- **Check OS**: BLE only works on Linux-based systems +- **Install noble prerequisites**: May need additional system libraries for @stoprocent/noble +- **Use OpenAPI instead**: For Windows/macOS development, use SwitchBotOpenAPI class + +### Build Failures +- **Check Node.js version**: Must be ^20, ^22, or ^24 +- **Clean and rebuild**: `npm run clean && npm install && npm run build` +- **TypeScript errors**: Check tsconfig.json settings and type definitions + +### Test Failures +- **Run individual tests**: Use `npm run test:watch` for interactive testing +- **Check imports**: Ensure all imports use correct ES module syntax +- **Verify exports**: Check that src/index.ts exports all necessary components + +### Linting Errors +- **Auto-fix**: Use `npm run lint:fix` to automatically fix many issues +- **ESLint config**: Review eslint.config.js for current rules +- **Import sorting**: ESLint enforces specific import order - use lint:fix + +## Frequently Referenced Information + +### Package Scripts (from package.json) +```bash +npm run build # Clean and compile TypeScript +npm run test # Run test suite with Vitest +npm run lint # Run ESLint on src/**/*.ts +npm run lint:fix # Auto-fix ESLint issues +npm run docs # Generate TypeDoc documentation +npm run clean # Remove dist/ directory +npm run watch # Build and link for development +``` + +### Main Exports (from src/index.ts) +- **SwitchBotBLE**: Bluetooth interface class +- **SwitchBotOpenAPI**: HTTP API interface class +- **SwitchbotDevice**: Base device class +- **Device classes**: WoHand, WoCurtain, WoSmartLock, etc. +- **Type definitions**: All device status and response types + +### Dependencies Summary +- **@stoprocent/noble**: BLE functionality (Linux only) +- **undici**: HTTP client for API requests +- **async-mutex**: Concurrency control +- **TypeScript**: Language and compilation +- **Vitest**: Testing framework +- **ESLint**: Code linting with @antfu/eslint-config +- **TypeDoc**: API documentation generation \ No newline at end of file diff --git a/docs/classes/Advertising.html b/docs/classes/Advertising.html index 1fb9f92f..b028ea19 100644 --- a/docs/classes/Advertising.html +++ b/docs/classes/Advertising.html @@ -1,8 +1,8 @@ Advertising | node-switchbot

    Class Advertising

    Represents the advertising data parser for SwitchBot devices.

    -

    Constructors

    constructor +

    Constructors

    constructor

    Methods

    parse parseServiceData -

    Constructors

    constructor

    Methods

    Staticparse

    • parse(
          peripheral: Peripheral,
          emitLog: (level: string, message: string) => void,
      ): Promise<null | ad>

      Parses the advertisement data coming from SwitchBot device.

      +

    Constructors

    constructor

    Methods

    Staticparse

    • parse(
          peripheral: Peripheral,
          emitLog: (level: string, message: string) => void,
      ): Promise<null | ad>

      Parses the advertisement data coming from SwitchBot device.

      This function processes advertising packets received from SwitchBot devices and extracts relevant information based on the device type.

      Parameters

      • peripheral: Peripheral

        The peripheral device object from noble.

        @@ -10,7 +10,7 @@

      Returns Promise<null | ad>

      • An object containing parsed data specific to the SwitchBot device type, or null if the device is not recognized.
      -

    StaticparseServiceData

    • parseServiceData(
          model: string,
          serviceData: Buffer,
          manufacturerData: Buffer,
          emitLog: (level: string, message: string) => void,
      ): Promise<any>

      Parses the service data based on the device model.

      +

    StaticparseServiceData

    • parseServiceData(
          model: string,
          serviceData: Buffer,
          manufacturerData: Buffer,
          emitLog: (level: string, message: string) => void,
      ): Promise<any>

      Parses the service data based on the device model.

      Parameters

      • model: string

        The device model.

      • serviceData: Buffer

        The service data buffer.

      • manufacturerData: Buffer

        The manufacturer data buffer.

        @@ -18,4 +18,4 @@

      Returns Promise<any>

      • The parsed service data.
      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/docs/classes/SwitchBotBLE.html b/docs/classes/SwitchBotBLE.html index 9051f50c..6f40f042 100644 --- a/docs/classes/SwitchBotBLE.html +++ b/docs/classes/SwitchBotBLE.html @@ -1,5 +1,5 @@ SwitchBotBLE | node-switchbot

    Class SwitchBotBLE

    SwitchBotBLE class to interact with SwitchBot devices.

    -

    Hierarchy

    • EventEmitter
      • SwitchBotBLE

    Constructors

    constructor +

    Hierarchy

    • EventEmitter
      • SwitchBotBLE

    Constructors

    constructor

    Properties

    noble onadvertisement? ondiscover? @@ -12,30 +12,30 @@ wait

    Constructors

    constructor

    Properties

    noble

    noble: any

    Optionalonadvertisement

    onadvertisement?: onadvertisement

    Optionalondiscover

    ondiscover?: ondiscover

    ready

    ready: Promise<void>

    Methods

    discover

    Returns SwitchBotBLE

    Properties

    noble

    noble: any

    Optionalonadvertisement

    onadvertisement?: onadvertisement

    Optionalondiscover

    ondiscover?: ondiscover

    ready

    ready: Promise<void>

    Methods

    discover

    log

    • log(level: string, message: string): Promise<void>

      Emits a log event with the specified log level and message.

      +

    log

    • log(level: string, message: string): Promise<void>

      Emits a log event with the specified log level and message.

      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>

    startScan

    • startScan(params?: Params): Promise<void>

      Starts scanning for SwitchBot devices.

      +

    Returns Promise<void>

    startScan

    stopScan

    stopScan

    validate

    validate

    wait

    wait

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/classes/SwitchBotOpenAPI.html b/docs/classes/SwitchBotOpenAPI.html index 1531680e..aae2d239 100644 --- a/docs/classes/SwitchBotOpenAPI.html +++ b/docs/classes/SwitchBotOpenAPI.html @@ -5,7 +5,7 @@

    Param: token

    The API token used for authentication.

    Param: secret

    The secret key used for signing requests.

    -

    Hierarchy

    Constructors

    constructor +

    Hierarchy

    Constructors

    constructor

    Properties

    webhookEventListener?

    Methods

    controlDevice deleteWebhook @@ -15,7 +15,7 @@

    Constructors

    constructor

    • new SwitchBotOpenAPI(
          token: string,
          secret: string,
          hostname?: string,
      ): SwitchBotOpenAPI

      Creates an instance of the SwitchBot OpenAPI client.

      Parameters

      • token: string

        The API token used for authentication.

      • secret: string

        The secret key used for signing requests.

        -
      • Optionalhostname: string

      Returns SwitchBotOpenAPI

    Properties

    OptionalwebhookEventListener

    webhookEventListener?:
        | null
        | Server<typeof IncomingMessage, typeof ServerResponse> = null

    Methods

    controlDevice

    • controlDevice(
          deviceId: string,
          command: string,
          parameter: string,
          commandType?: string,
          token?: string,
          secret?: string,
      ): Promise<{ response: { commandId: string }; statusCode: number }>

      Controls a device by sending a command to the SwitchBot API.

      +
    • Optionalhostname: string

    Returns SwitchBotOpenAPI

    Properties

    OptionalwebhookEventListener

    webhookEventListener?:
        | null
        | Server<typeof IncomingMessage, typeof ServerResponse> = null

    Methods

    controlDevice

    • controlDevice(
          deviceId: string,
          command: string,
          parameter: string,
          commandType?: string,
          token?: string,
          secret?: string,
      ): Promise<{ response: { commandId: string }; statusCode: number }>

      Controls a device by sending a command to the SwitchBot API.

      Parameters

      • deviceId: string

        The ID of the device to control.

      • command: string

        The command to send to the device.

      • parameter: string

        The parameter for the command.

        @@ -24,24 +24,24 @@
      • Optionalsecret: string

        (Optional) The secret used for authentication. If not provided, the instance secret will be used.

      Returns Promise<{ response: { commandId: string }; statusCode: number }>

      A promise that resolves to an object containing the response body and status code.

      Throws

      An error if the device control fails.

      -

    deleteWebhook

    • deleteWebhook(url: string, token?: string, secret?: string): Promise<void>

      Deletes a webhook by sending a request to the specified URL.

      +

    deleteWebhook

    • deleteWebhook(url: string, token?: string, secret?: string): Promise<void>

      Deletes a webhook by sending a request to the specified URL.

      Parameters

      • url: string

        The URL of the webhook to be deleted.

      • Optionaltoken: string

        (Optional) The token used for authentication. If not provided, the instance token will be used.

      • Optionalsecret: string

        (Optional) The secret used for authentication. If not provided, the instance secret will be used.

      Returns Promise<void>

      A promise that resolves when the webhook is successfully deleted.

      Throws

      Will log an error if the deletion fails.

      -

    getDevices

    • getDevices(
          token?: string,
          secret?: string,
      ): Promise<{ response: devices; statusCode: number }>

      Retrieves the list of devices from the SwitchBot OpenAPI.

      +

    getDevices

    • getDevices(
          token?: string,
          secret?: string,
      ): Promise<{ response: devices; statusCode: number }>

      Retrieves the list of devices from the SwitchBot OpenAPI.

      Parameters

      • Optionaltoken: string

        (Optional) The token used for authentication. If not provided, the instance token will be used.

      • Optionalsecret: string

        (Optional) The secret used for authentication. If not provided, the instance secret will be used.

      Returns Promise<{ response: devices; statusCode: number }>

      A promise that resolves to an object containing the API response.

      Throws

      Throws an error if the request to get devices fails.

      -

    getDeviceStatus

    • getDeviceStatus(
          deviceId: string,
          token?: string,
          secret?: string,
      ): Promise<{ response: deviceStatus; statusCode: number }>

      Retrieves the status of a specific device.

      +

    getDeviceStatus

    • getDeviceStatus(
          deviceId: string,
          token?: string,
          secret?: string,
      ): Promise<{ response: deviceStatus; statusCode: number }>

      Retrieves the status of a specific device.

      Parameters

      • deviceId: string

        The unique identifier of the device.

      • Optionaltoken: string

        (Optional) The token used for authentication. If not provided, the instance token will be used.

      • Optionalsecret: string

        (Optional) The secret used for authentication. If not provided, the instance secret will be used.

      Returns Promise<{ response: deviceStatus; statusCode: number }>

      A promise that resolves to an object containing the device status and the status code of the request.

      Throws

      An error if the request fails.

      -

    setupWebhook

    • setupWebhook(url: string, token?: string, secret?: string): Promise<void>

      Sets up a webhook listener and configures the webhook on the server.

      +

    setupWebhook

    • setupWebhook(url: string, token?: string, secret?: string): Promise<void>

      Sets up a webhook listener and configures the webhook on the server.

      This method performs the following steps:

      1. Creates a local server to listen for incoming webhook events.
        2. @@ -54,4 +54,4 @@
    • Optionalsecret: string

      (Optional) The secret used for authentication. If not provided, the instance secret will be used.

    Returns Promise<void>

    A promise that resolves when the webhook setup is complete.

    Throws

    Will log an error if any step in the webhook setup process fails.

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/docs/classes/SwitchbotDevice.html b/docs/classes/SwitchbotDevice.html index 4663ca7a..b172adf9 100644 --- a/docs/classes/SwitchbotDevice.html +++ b/docs/classes/SwitchbotDevice.html @@ -1,5 +1,5 @@ SwitchbotDevice | node-switchbot

    Class SwitchbotDevice

    Represents a Switchbot Device.

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -21,27 +21,27 @@

    Constructors

    constructor

    • new SwitchbotDevice(peripheral: Peripheral, noble: __module): SwitchbotDevice

      Initializes a new instance of the SwitchbotDevice class.

      Parameters

      • peripheral: Peripheral

        The peripheral object from noble.

      • noble: __module

        The Noble object.

        -

      Returns SwitchbotDevice

    Accessors

    address

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Returns SwitchbotDevice

    Accessors

    address

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    • connect(): Promise<void>

      Connects to the device.

      +

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      +

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    • discoverServices(): Promise<Service[]>

      Discovers the device services.

      +

    discoverServices

    • discoverServices(): Promise<Service[]>

      Discovers the device services.

      Returns Promise<Service[]>

      A Promise that resolves with the list of services.

      -

    getCharacteristics

    • getCharacteristics(): Promise<Chars>

      Retrieves the device characteristics.

      +

    getCharacteristics

    • getCharacteristics(): Promise<Chars>

      Retrieves the device characteristics.

      Returns Promise<Chars>

      A Promise that resolves with the device characteristics.

      -

    getDeviceName

    • getDeviceName(): Promise<string>

      Retrieves the device name.

      +

    getDeviceName

    • getDeviceName(): Promise<string>

      Retrieves the device name.

      Returns Promise<string>

      A Promise that resolves with the device name.

      -

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      +

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    • log(level: string, message: string): Promise<void>

      Logs a message with the specified log level.

      +

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoBlindTilt.html b/docs/classes/WoBlindTilt.html index 2881175b..c78eb235 100644 --- a/docs/classes/WoBlindTilt.html +++ b/docs/classes/WoBlindTilt.html @@ -1,6 +1,6 @@ WoBlindTilt | node-switchbot

    Class WoBlindTilt

    Class representing a WoBlindTilt device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/curtain.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -28,46 +28,46 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    close

    • close(): Promise<void>

      Closes the blind tilt to the nearest endpoint.

      -

      Returns Promise<void>

    closeDown

    • closeDown(): Promise<void>

      Closes the blind tilt down to the nearest endpoint.

      -

      Returns Promise<void>

    closeUp

    • closeUp(): Promise<void>

      Closes the blind tilt up to the nearest endpoint.

      -

      Returns Promise<void>

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    close

    • close(): Promise<void>

      Closes the blind tilt to the nearest endpoint.

      +

      Returns Promise<void>

    closeDown

    • closeDown(): Promise<void>

      Closes the blind tilt down to the nearest endpoint.

      +

      Returns Promise<void>

    closeUp

    • closeUp(): Promise<void>

      Closes the blind tilt up to the nearest endpoint.

      +

      Returns Promise<void>

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getBasicInfo

    getBasicInfo

    • getBasicInfo(): Promise<null | object>

      Retrieves the basic information of the blind tilt.

      Returns Promise<null | object>

      • A promise that resolves to an object containing the basic information of the blind tilt.
      -

    getCharacteristics

    • getCharacteristics(): Promise<Chars>

      Retrieves the device characteristics.

      +

    getCharacteristics

    getDeviceName

    getDeviceName

    getPosition

    getPosition

    • getPosition(): Promise<number>

      Retrieves the current position of the blind tilt.

      Returns Promise<number>

      • The current position of the blind tilt (0-100).
      -

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      +

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    open

    • open(): Promise<void>

      Opens the blind tilt to the fully open position.

      -

      Returns Promise<void>

    pause

    • pause(): Promise<void>

      Pauses the blind tilt operation.

      -

      Returns Promise<void>

    runToPos

    • runToPos(percent: number, mode: number): Promise<void>

      Runs the blind tilt to the specified position.

      +

    Returns Promise<void>

    open

    pause

    runToPos

    setDeviceName

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoBulb.html b/docs/classes/WoBulb.html index 62dd84d0..604a314f 100644 --- a/docs/classes/WoBulb.html +++ b/docs/classes/WoBulb.html @@ -1,6 +1,6 @@ WoBulb | node-switchbot

    Class WoBulb

    Class representing a WoBulb device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/colorbulb.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -26,42 +26,42 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    readState

    • readState(): Promise<boolean>

      Reads the state of the bulb.

      +

    Returns Promise<void>

    readState

    setBrightness

    setBrightness

    setColorTemperature

    setColorTemperature

    setDeviceName

    setDeviceName

    setRGB

    setRGB

    turnOff

    turnOff

    turnOn

    turnOn

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoCeilingLight.html b/docs/classes/WoCeilingLight.html index e4d432f0..8b28748b 100644 --- a/docs/classes/WoCeilingLight.html +++ b/docs/classes/WoCeilingLight.html @@ -1,6 +1,6 @@ WoCeilingLight | node-switchbot

    Class WoCeilingLight

    Class representing a WoCeilingLight device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/colorbulb.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -29,47 +29,47 @@ unsubscribeFromNotify parseServiceData parseServiceData_Pro -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    operateCeilingLight

    • operateCeilingLight(bytes: number[]): Promise<boolean>

      Sends a command to the ceiling light.

      +

    Returns Promise<void>

    operateCeilingLight

    readState

    readState

    setBrightness

    setBrightness

    setColorTemperature

    setColorTemperature

    setDeviceName

    setDeviceName

    setRGB

    setRGB

    setState

    setState

    turnOff

    turnOff

    turnOn

    turnOn

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    StaticparseServiceData_Pro

    StaticparseServiceData_Pro

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoContact.html b/docs/classes/WoContact.html index 3a647d2a..ac676b87 100644 --- a/docs/classes/WoContact.html +++ b/docs/classes/WoContact.html @@ -1,6 +1,6 @@ WoContact | node-switchbot

    Class WoContact

    Class representing a WoContact device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/contactsensor.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,33 +20,33 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoCurtain.html b/docs/classes/WoCurtain.html index bff50386..e51160bd 100644 --- a/docs/classes/WoCurtain.html +++ b/docs/classes/WoCurtain.html @@ -3,7 +3,7 @@
  • https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/curtain.md
  • https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/curtain3.md
    • -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -28,40 +28,40 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    close

    • close(mode?: number): Promise<void>

      Closes the curtain.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    close

    • close(mode?: number): Promise<void>

      Closes the curtain.

      Parameters

      • Optionalmode: number = 0xFF

        Running mode (0x01 = QuietDrift, 0xFF = Default).

        -

      Returns Promise<void>

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Returns Promise<void>

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    open

    • open(mode?: number): Promise<void>

      Opens the curtain.

      +

    Returns Promise<void>

    open

    • open(mode?: number): Promise<void>

      Opens the curtain.

      Parameters

      • Optionalmode: number = 0xFF

        Running mode (0x01 = QuietDrift, 0xFF = Default).

        -

      Returns Promise<void>

    operateCurtain

    • operateCurtain(bytes: number[]): Promise<void>

      Sends a command to the curtain.

      +

    Returns Promise<void>

    operateCurtain

    • operateCurtain(bytes: number[]): Promise<void>

      Sends a command to the curtain.

      Parameters

      • bytes: number[]

        The command bytes.

        -

      Returns Promise<void>

    pause

    • pause(): Promise<void>

      Pauses the curtain.

      -

      Returns Promise<void>

    runToPos

    • runToPos(percent: number, mode?: number): Promise<void>

      Runs the curtain to the target position.

      +

    Returns Promise<void>

    pause

    • pause(): Promise<void>

      Pauses the curtain.

      +

      Returns Promise<void>

    runToPos

    • runToPos(percent: number, mode?: number): Promise<void>

      Runs the curtain to the target position.

      Parameters

      • percent: number

        The percentage of the target position.

      • Optionalmode: number = 0xFF

        Running mode (0x01 = QuietDrift, 0xFF = Default).

        -

      Returns Promise<void>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    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.

      -

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    • parseServiceData(
          serviceData: Buffer,
          manufacturerData: Buffer,
          emitLog: (level: string, message: string) => void,
          reverse?: boolean,
      ): Promise<null | curtainServiceData | curtain3ServiceData>

      Parses the service data for WoCurtain.

      Parameters

      • serviceData: Buffer

        The service data buffer.

      • manufacturerData: Buffer

        The manufacturer data buffer.

      • emitLog: (level: string, message: string) => void

        The function to emit log messages.

        @@ -69,4 +69,4 @@

      Returns Promise<null | curtainServiceData | curtain3ServiceData>

      • Parsed service data or null if invalid.
      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoHand.html b/docs/classes/WoHand.html index 5d73c2d2..45319242 100644 --- a/docs/classes/WoHand.html +++ b/docs/classes/WoHand.html @@ -1,6 +1,6 @@ WoHand | node-switchbot

    Class WoHand

    Class representing a WoHand device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/bot.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -25,38 +25,38 @@ unsubscribeFromNotify up parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    down

    • down(): Promise<void>

      Moves the bot down.

      -

      Returns Promise<void>

    getCharacteristics

    down

    • down(): Promise<void>

      Moves the bot down.

      +

      Returns Promise<void>

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    press

    • press(): Promise<void>

      Presses the bot.

      -

      Returns Promise<void>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    press

    setDeviceName

    turnOff

    turnOn

    unsubscribeFromNotify

    turnOff

    turnOn

    unsubscribeFromNotify

    up

    StaticparseServiceData

    up

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoHub2.html b/docs/classes/WoHub2.html index 951c71e3..b09245db 100644 --- a/docs/classes/WoHub2.html +++ b/docs/classes/WoHub2.html @@ -1,6 +1,6 @@ WoHub2 | node-switchbot

    Class WoHub2

    Class representing a WoHub2 device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,33 +20,33 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoHumi.html b/docs/classes/WoHumi.html index 128649e2..b094054a 100644 --- a/docs/classes/WoHumi.html +++ b/docs/classes/WoHumi.html @@ -1,6 +1,6 @@ WoHumi | node-switchbot

    Class WoHumi

    Class representing a WoHumi device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/tree/latest/devicetypes

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -27,41 +27,41 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    decrease

    • decrease(): Promise<void>

      Decreases the humidifier setting.

      -

      Returns Promise<void>

    disconnect

    decrease

    • decrease(): Promise<void>

      Decreases the humidifier setting.

      +

      Returns Promise<void>

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    increase

    • increase(): Promise<void>

      Increases the humidifier setting.

      -

      Returns Promise<void>

    internalConnect

    increase

    • increase(): Promise<void>

      Increases the humidifier setting.

      +

      Returns Promise<void>

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    percentage

    • percentage(level: number): Promise<void>

      Sets the humidifier level.

      +

    Returns Promise<void>

    percentage

    setAutoMode

    setDeviceName

    Returns Promise<void>

    setAutoMode

    setDeviceName

    setManualMode

    turnOff

    turnOn

    unsubscribeFromNotify

    setManualMode

    turnOff

    turnOn

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoHumi2.html b/docs/classes/WoHumi2.html index 93bdd775..cc8baa87 100644 --- a/docs/classes/WoHumi2.html +++ b/docs/classes/WoHumi2.html @@ -1,6 +1,6 @@ WoHumi2 | node-switchbot

    Class WoHumi2

    Class representing a WoHumi device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/tree/latest/devicetypes

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -27,41 +27,41 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    decrease

    • decrease(): Promise<void>

      Decreases the humidifier setting.

      -

      Returns Promise<void>

    disconnect

    decrease

    • decrease(): Promise<void>

      Decreases the humidifier setting.

      +

      Returns Promise<void>

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    increase

    • increase(): Promise<void>

      Increases the humidifier setting.

      -

      Returns Promise<void>

    internalConnect

    increase

    • increase(): Promise<void>

      Increases the humidifier setting.

      +

      Returns Promise<void>

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    percentage

    • percentage(level: number): Promise<void>

      Sets the humidifier level.

      +

    Returns Promise<void>

    percentage

    setAutoMode

    setDeviceName

    Returns Promise<void>

    setAutoMode

    setDeviceName

    setManualMode

    turnOff

    turnOn

    unsubscribeFromNotify

    setManualMode

    turnOff

    turnOn

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoIOSensorTH.html b/docs/classes/WoIOSensorTH.html index a7d6e9f0..9d5f3109 100644 --- a/docs/classes/WoIOSensorTH.html +++ b/docs/classes/WoIOSensorTH.html @@ -1,6 +1,6 @@ WoIOSensorTH | node-switchbot

    Class WoIOSensorTH

    Class representing a WoIOSensorTH device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md#outdoor-temperaturehumidity-sensor

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,34 +20,34 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoKeypad.html b/docs/classes/WoKeypad.html index 16354c01..f515e677 100644 --- a/docs/classes/WoKeypad.html +++ b/docs/classes/WoKeypad.html @@ -1,5 +1,5 @@ WoKeypad | node-switchbot

    Class WoKeypad

    Class representing a WoKeypad device.

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -19,34 +19,34 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoLeak.html b/docs/classes/WoLeak.html index bd5d63f2..6f56a61d 100644 --- a/docs/classes/WoLeak.html +++ b/docs/classes/WoLeak.html @@ -1,6 +1,6 @@ WoLeak | node-switchbot

    Class WoLeak

    Class representing a WoLeak device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md#outdoor-temperaturehumidity-sensor

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,34 +20,34 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoPlugMiniJP.html b/docs/classes/WoPlugMiniJP.html index a4cfebcd..e4dad5c4 100644 --- a/docs/classes/WoPlugMiniJP.html +++ b/docs/classes/WoPlugMiniJP.html @@ -1,6 +1,6 @@ WoPlugMiniJP | node-switchbot

    Class WoPlugMiniJP

    Class representing a WoPlugMini device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/plugmini.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -25,54 +25,54 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    operatePlug

    • operatePlug(bytes: number[]): Promise<boolean>

      Operates the plug with the given bytes.

      +

    Returns Promise<void>

    operatePlug

    readState

    readState

    setDeviceName

    setDeviceName

    toggle

    toggle

    turnOff

    turnOff

    turnOn

    turnOn

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoPlugMiniUS.html b/docs/classes/WoPlugMiniUS.html index 8bc5179f..299e0d74 100644 --- a/docs/classes/WoPlugMiniUS.html +++ b/docs/classes/WoPlugMiniUS.html @@ -1,6 +1,6 @@ WoPlugMiniUS | node-switchbot

    Class WoPlugMiniUS

    Class representing a WoPlugMini device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/plugmini.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -25,54 +25,54 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    operatePlug

    • operatePlug(bytes: number[]): Promise<boolean>

      Operates the plug with the given bytes.

      +

    Returns Promise<void>

    operatePlug

    readState

    readState

    setDeviceName

    setDeviceName

    toggle

    toggle

    turnOff

    turnOff

    turnOn

    turnOn

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoPresence.html b/docs/classes/WoPresence.html index a32acc81..34cdcfa3 100644 --- a/docs/classes/WoPresence.html +++ b/docs/classes/WoPresence.html @@ -1,6 +1,6 @@ WoPresence | node-switchbot

    Class WoPresence

    Class representing a WoPresence device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,33 +20,33 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoRelaySwitch1.html b/docs/classes/WoRelaySwitch1.html index 0dbce770..c893db2c 100644 --- a/docs/classes/WoRelaySwitch1.html +++ b/docs/classes/WoRelaySwitch1.html @@ -1,6 +1,6 @@ WoRelaySwitch1 | node-switchbot

    Class WoRelaySwitch1

    Class representing a WoRelaySwitch1 device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -22,36 +22,36 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    turnOff

    turnOn

    unsubscribeFromNotify

    turnOff

    turnOn

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoRelaySwitch1PM.html b/docs/classes/WoRelaySwitch1PM.html index d6fe3e52..50b5585c 100644 --- a/docs/classes/WoRelaySwitch1PM.html +++ b/docs/classes/WoRelaySwitch1PM.html @@ -1,6 +1,6 @@ WoRelaySwitch1PM | node-switchbot

    Class WoRelaySwitch1PM

    Class representing a WoRelaySwitch1PM device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -22,36 +22,36 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    turnOff

    turnOn

    unsubscribeFromNotify

    turnOff

    turnOn

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoRemote.html b/docs/classes/WoRemote.html index b3eac8e5..f506924e 100644 --- a/docs/classes/WoRemote.html +++ b/docs/classes/WoRemote.html @@ -1,6 +1,6 @@ WoRemote | node-switchbot

    Class WoRemote

    Class representing a WoRemote device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,33 +20,33 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoSensorTH.html b/docs/classes/WoSensorTH.html index b9553dff..ffa9a4c2 100644 --- a/docs/classes/WoSensorTH.html +++ b/docs/classes/WoSensorTH.html @@ -1,6 +1,6 @@ WoSensorTH | node-switchbot

    Class WoSensorTH

    Class representing a WoSensorTH device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,27 +20,27 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoSensorTHPlus.html b/docs/classes/WoSensorTHPlus.html index 6fa69790..eac3ec60 100644 --- a/docs/classes/WoSensorTHPlus.html +++ b/docs/classes/WoSensorTHPlus.html @@ -1,6 +1,6 @@ WoSensorTHPlus | node-switchbot

    Class WoSensorTHPlus

    Class representing a WoSensorTH device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,27 +20,27 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoSensorTHPro.html b/docs/classes/WoSensorTHPro.html index a6aab114..caa06dd6 100644 --- a/docs/classes/WoSensorTHPro.html +++ b/docs/classes/WoSensorTHPro.html @@ -1,6 +1,6 @@ WoSensorTHPro | node-switchbot

    Class WoSensorTHPro

    Class representing a WoSensorTH device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,27 +20,27 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoSensorTHProCO2.html b/docs/classes/WoSensorTHProCO2.html index 082f5bd1..9534d65b 100644 --- a/docs/classes/WoSensorTHProCO2.html +++ b/docs/classes/WoSensorTHProCO2.html @@ -1,6 +1,6 @@ WoSensorTHProCO2 | node-switchbot

    Class WoSensorTHProCO2

    Class representing a WoSensorTH device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/meter.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -20,27 +20,27 @@ setDeviceName unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    setDeviceName

    • setDeviceName(name: string): Promise<void>

      Sets the device name.

      +

    Returns Promise<void>

    setDeviceName

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/classes/WoSmartLock.html b/docs/classes/WoSmartLock.html index 054f318e..92f0d210 100644 --- a/docs/classes/WoSmartLock.html +++ b/docs/classes/WoSmartLock.html @@ -1,6 +1,6 @@ WoSmartLock | node-switchbot

    Class WoSmartLock

    Class representing a WoSmartLock device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/lock.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    encryption_key iv key_id @@ -36,78 +36,78 @@ getLockStatus parseServiceData validateResponse -

    Constructors

    constructor

    Properties

    encryption_key

    encryption_key: null | Buffer<ArrayBufferLike> = null

    iv

    iv: null | Buffer<ArrayBufferLike> = null

    key_id

    key_id: string = ''

    StaticResult

    Result: { ERROR: number; SUCCESS: number; SUCCESS_LOW_BATTERY: number } = ...

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Properties

    encryption_key

    encryption_key: null | Buffer<ArrayBufferLike> = null

    iv

    iv: null | Buffer<ArrayBufferLike> = null

    key_id

    key_id: string = ''

    StaticResult

    Result: { ERROR: number; SUCCESS: number; SUCCESS_LOW_BATTERY: number } = ...

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    decrypt

    decrypt

    • decrypt(data: Buffer): Promise<Buffer<ArrayBufferLike>>

      Decrypts a buffer using AES-128-CTR.

      Parameters

      • data: Buffer

        The data to decrypt.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The decrypted data.
      -

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      +

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    encrypt

    encrypt

    • encrypt(str: string): Promise<string>

      Encrypts a string using AES-128-CTR.

      Parameters

      • str: string

        The string to encrypt.

      Returns Promise<string>

      • The encrypted string in hex format.
      -

    encryptedCommand

    • encryptedCommand(key: string): Promise<Buffer<ArrayBufferLike>>

      Sends an encrypted command to the device.

      +

    encryptedCommand

    • encryptedCommand(key: string): Promise<Buffer<ArrayBufferLike>>

      Sends an encrypted command to the device.

      Parameters

      • key: string

        The command key.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The response buffer.
      -

    getCharacteristics

    • getCharacteristics(): Promise<Chars>

      Retrieves the device characteristics.

      +

    getCharacteristics

    getDeviceName

    getDeviceName

    getIv

    getIv

    • getIv(): Promise<Buffer<ArrayBufferLike>>

      Retrieves the IV from the device.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The IV buffer.
      -

    info

    • info(): Promise<null | object>

      Gets general state info from the Smart Lock.

      +

    info

    • info(): Promise<null | object>

      Gets general state info from the Smart Lock.

      Returns Promise<null | object>

      • The state object or null if an error occurred.
      -

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      +

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    lock

    lock

    • lock(): Promise<number>

      Locks the Smart Lock.

      Returns Promise<number>

      • The result of the lock operation.
      -

    log

    • log(level: string, message: string): Promise<void>

      Logs a message with the specified log level.

      +

    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>

    operateLock

    • operateLock(key: string, encrypt?: boolean): Promise<Buffer<ArrayBufferLike>>

      Operates the lock with the given command.

      +

    Returns Promise<void>

    operateLock

    setDeviceName

    setDeviceName

    setKey

    setKey

    unlock

    Returns Promise<void>

    unlock

    unlockNoUnlatch

    unlockNoUnlatch

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticgetLockStatus

    StaticparseServiceData

    StaticgetLockStatus

    StaticparseServiceData

    StaticvalidateResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    StaticvalidateResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/WoSmartLockPro.html b/docs/classes/WoSmartLockPro.html index 3172f68d..7f9c9782 100644 --- a/docs/classes/WoSmartLockPro.html +++ b/docs/classes/WoSmartLockPro.html @@ -1,6 +1,6 @@ WoSmartLockPro | node-switchbot

    Class WoSmartLockPro

    Class representing a WoSmartLockPro device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/lock.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Properties

    encryption_key iv key_id @@ -36,78 +36,78 @@ getLockStatus parseServiceData validateResponse -

    Constructors

    constructor

    Properties

    encryption_key

    encryption_key: null | Buffer<ArrayBufferLike> = null

    iv

    iv: null | Buffer<ArrayBufferLike> = null

    key_id

    key_id: string = ''

    StaticResult

    Result: { ERROR: number; SUCCESS: number; SUCCESS_LOW_BATTERY: number } = ...

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Properties

    encryption_key

    encryption_key: null | Buffer<ArrayBufferLike> = null

    iv

    iv: null | Buffer<ArrayBufferLike> = null

    key_id

    key_id: string = ''

    StaticResult

    Result: { ERROR: number; SUCCESS: number; SUCCESS_LOW_BATTERY: number } = ...

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    decrypt

    decrypt

    • decrypt(data: Buffer): Promise<Buffer<ArrayBufferLike>>

      Decrypts a buffer using AES-128-CTR.

      Parameters

      • data: Buffer

        The data to decrypt.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The decrypted data.
      -

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      +

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    encrypt

    encrypt

    • encrypt(str: string): Promise<string>

      Encrypts a string using AES-128-CTR.

      Parameters

      • str: string

        The string to encrypt.

      Returns Promise<string>

      • The encrypted string in hex format.
      -

    encryptedCommand

    • encryptedCommand(key: string): Promise<Buffer<ArrayBufferLike>>

      Sends an encrypted command to the device.

      +

    encryptedCommand

    • encryptedCommand(key: string): Promise<Buffer<ArrayBufferLike>>

      Sends an encrypted command to the device.

      Parameters

      • key: string

        The command key.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The response buffer.
      -

    getCharacteristics

    • getCharacteristics(): Promise<Chars>

      Retrieves the device characteristics.

      +

    getCharacteristics

    getDeviceName

    getDeviceName

    getIv

    getIv

    • getIv(): Promise<Buffer<ArrayBufferLike>>

      Retrieves the IV from the device.

      Returns Promise<Buffer<ArrayBufferLike>>

      • The IV buffer.
      -

    info

    • info(): Promise<null | object>

      Gets general state info from the Smart Lock.

      +

    info

    • info(): Promise<null | object>

      Gets general state info from the Smart Lock.

      Returns Promise<null | object>

      • The state object or null if an error occurred.
      -

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      +

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    lock

    lock

    • lock(): Promise<number>

      Locks the Smart Lock.

      Returns Promise<number>

      • The result of the lock operation.
      -

    log

    • log(level: string, message: string): Promise<void>

      Logs a message with the specified log level.

      +

    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>

    operateLockPro

    • operateLockPro(key: string, encrypt?: boolean): Promise<Buffer<ArrayBufferLike>>

      Operates the lock with the given command.

      +

    Returns Promise<void>

    operateLockPro

    setDeviceName

    setDeviceName

    setKey

    setKey

    unlock

    Returns Promise<void>

    unlock

    unlockNoUnlatch

    unlockNoUnlatch

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticgetLockStatus

    StaticparseServiceData

    StaticgetLockStatus

    StaticparseServiceData

    StaticvalidateResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    StaticvalidateResponse

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/docs/classes/WoStrip.html b/docs/classes/WoStrip.html index 95c3b713..0ca70a05 100644 --- a/docs/classes/WoStrip.html +++ b/docs/classes/WoStrip.html @@ -1,6 +1,6 @@ WoStrip | node-switchbot

    Class WoStrip

    Class representing a WoStrip device.

    See

    https://github.com/OpenWonderLabs/SwitchBotAPI-BLE/blob/latest/devicetypes/ledstriplight.md

    -

    Hierarchy (View Summary)

    Constructors

    constructor +

    Hierarchy (View Summary)

    Constructors

    constructor

    Accessors

    address connectionState friendlyName @@ -27,42 +27,42 @@ turnOn unsubscribeFromNotify parseServiceData -

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    Methods

    command

    • command(reqBuf: Buffer): Promise<Buffer<ArrayBufferLike>>

      Sends a command to the device and awaits a response.

      +

    Constructors

    constructor

    Accessors

    address

    • get address(): string

      Returns string

    connectionState

    • get connectionState(): string

      Returns string

    friendlyName

    id

    • get id(): string

      Returns string

    model

    modelName

    onConnectHandler

    • get onConnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onConnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    onDisconnectHandler

    • get onDisconnectHandler(): () => Promise<void>

      Returns () => Promise<void>

    • set onDisconnectHandler(func: () => Promise<void>): void

      Parameters

      • func: () => Promise<void>

      Returns void

    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.

      -

    connect

    connect

    • connect(): Promise<void>

      Connects to the device.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    disconnect

    disconnect

    • disconnect(): Promise<void>

      Disconnects from the device.

      Returns Promise<void>

      A Promise that resolves when the disconnection is complete.

      -

    discoverServices

    discoverServices

    getCharacteristics

    getCharacteristics

    getDeviceName

    getDeviceName

    internalConnect

    internalConnect

    • internalConnect(): Promise<void>

      Internal method to handle the connection process.

      Returns Promise<void>

      A Promise that resolves when the connection is complete.

      -

    log

    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>

    operateStripLight

    • operateStripLight(bytes: number[]): Promise<boolean>

      Operates the strip light with the given byte array.

      +

    Returns Promise<void>

    operateStripLight

    readState

    readState

    setBrightness

    setBrightness

    setDeviceName

    setDeviceName

    setRGB

    setRGB

    setState

    setState

    turnOff

    turnOff

    turnOn

    turnOn

    unsubscribeFromNotify

    unsubscribeFromNotify

    StaticparseServiceData

    StaticparseServiceData

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    diff --git a/docs/enums/LogLevel.html b/docs/enums/LogLevel.html index 44c7867a..df8df730 100644 --- a/docs/enums/LogLevel.html +++ b/docs/enums/LogLevel.html @@ -1,5 +1,5 @@ LogLevel | node-switchbot

    Enumeration LogLevel

    Enum for log levels.

    -

    Enumeration Members

    DEBUG +

    Enumeration Members

    DEBUG DEBUGERROR DEBUGSUCCESS DEBUGWARN @@ -7,4 +7,4 @@ INFO SUCCESS WARN -

    Enumeration Members

    DEBUG

    DEBUG: "debug"

    DEBUGERROR

    DEBUGERROR: "debugerror"

    DEBUGSUCCESS

    DEBUGSUCCESS: "debugsuccess"

    DEBUGWARN

    DEBUGWARN: "debugwarn"

    ERROR

    ERROR: "error"

    INFO

    INFO: "info"

    SUCCESS

    SUCCESS: "success"

    WARN

    WARN: "warn"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    DEBUG

    DEBUG: "debug"

    DEBUGERROR

    DEBUGERROR: "debugerror"

    DEBUGSUCCESS

    DEBUGSUCCESS: "debugsuccess"

    DEBUGWARN

    DEBUGWARN: "debugwarn"

    ERROR

    ERROR: "error"

    INFO

    INFO: "info"

    SUCCESS

    SUCCESS: "success"

    WARN

    WARN: "warn"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/enums/SwitchBotBLEModel.html b/docs/enums/SwitchBotBLEModel.html index 5870ef35..4a108bb4 100644 --- a/docs/enums/SwitchBotBLEModel.html +++ b/docs/enums/SwitchBotBLEModel.html @@ -1,4 +1,4 @@ -SwitchBotBLEModel | node-switchbot

    Enumeration SwitchBotBLEModel

    Enumeration Members

    BlindTilt +SwitchBotBLEModel | node-switchbot

    Enumeration SwitchBotBLEModel

    Enumeration Members

    BlindTilt Bot CeilingLight CeilingLightPro @@ -26,4 +26,4 @@ Remote StripLight Unknown -

    Enumeration Members

    BlindTilt

    BlindTilt: "x"

    Bot

    Bot: "H"

    CeilingLight

    CeilingLight: "q"

    CeilingLightPro

    CeilingLightPro: "n"

    ColorBulb

    ColorBulb: "u"

    ContactSensor

    ContactSensor: "d"

    Curtain

    Curtain: "c"

    Curtain3

    Curtain3: "{"

    Hub2

    Hub2: "v"

    Humidifier

    Humidifier: "e"

    Humidifier2

    Humidifier2: "#"

    Keypad

    Keypad: "y"

    Leak

    Leak: "&"

    Lock

    Lock: "o"

    LockPro

    LockPro: "$"

    Meter

    Meter: "T"

    MeterPlus

    MeterPlus: "i"

    MeterPro

    MeterPro: "4"

    MeterProCO2

    MeterProCO2: "5"

    MotionSensor

    MotionSensor: "s"

    OutdoorMeter

    OutdoorMeter: "w"

    PlugMiniJP

    PlugMiniJP: "j"

    PlugMiniUS

    PlugMiniUS: "g"

    RelaySwitch1

    RelaySwitch1: ";"

    RelaySwitch1PM

    RelaySwitch1PM: "<"

    Remote

    Remote: "b"

    StripLight

    StripLight: "r"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    BlindTilt

    BlindTilt: "x"

    Bot

    Bot: "H"

    CeilingLight

    CeilingLight: "q"

    CeilingLightPro

    CeilingLightPro: "n"

    ColorBulb

    ColorBulb: "u"

    ContactSensor

    ContactSensor: "d"

    Curtain

    Curtain: "c"

    Curtain3

    Curtain3: "{"

    Hub2

    Hub2: "v"

    Humidifier

    Humidifier: "e"

    Humidifier2

    Humidifier2: "#"

    Keypad

    Keypad: "y"

    Leak

    Leak: "&"

    Lock

    Lock: "o"

    LockPro

    LockPro: "$"

    Meter

    Meter: "T"

    MeterPlus

    MeterPlus: "i"

    MeterPro

    MeterPro: "4"

    MeterProCO2

    MeterProCO2: "5"

    MotionSensor

    MotionSensor: "s"

    OutdoorMeter

    OutdoorMeter: "w"

    PlugMiniJP

    PlugMiniJP: "j"

    PlugMiniUS

    PlugMiniUS: "g"

    RelaySwitch1

    RelaySwitch1: ";"

    RelaySwitch1PM

    RelaySwitch1PM: "<"

    Remote

    Remote: "b"

    StripLight

    StripLight: "r"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/enums/SwitchBotBLEModelFriendlyName.html b/docs/enums/SwitchBotBLEModelFriendlyName.html index 6b50aa24..9e805c40 100644 --- a/docs/enums/SwitchBotBLEModelFriendlyName.html +++ b/docs/enums/SwitchBotBLEModelFriendlyName.html @@ -1,4 +1,4 @@ -SwitchBotBLEModelFriendlyName | node-switchbot

    Enumeration SwitchBotBLEModelFriendlyName

    Enumeration Members

    BatteryCirculatorFan +SwitchBotBLEModelFriendlyName | node-switchbot

    Enumeration SwitchBotBLEModelFriendlyName

    Enumeration Members

    BatteryCirculatorFan BlindTilt Bot CeilingLight @@ -27,4 +27,4 @@ Remote StripLight Unknown -

    Enumeration Members

    BatteryCirculatorFan

    BatteryCirculatorFan: "Battery Circulator Fan"

    BlindTilt

    BlindTilt: "Blind Tilt"

    Bot

    Bot: "Bot"

    CeilingLight

    CeilingLight: "Ceiling Light"

    CeilingLightPro

    CeilingLightPro: "Ceiling Light Pro"

    CirculatorFan

    CirculatorFan: "Circulator Fan"

    ColorBulb

    ColorBulb: "Color Bulb"

    ContactSensor

    ContactSensor: "Contact Sensor"

    Curtain

    Curtain: "Curtain"

    Curtain3

    Curtain3: "Curtain 3"

    Hub2

    Hub2: "Hub 2"

    Humidifier

    Humidifier: "Humidifier"

    Humidifier2

    Humidifier2: "Humidifier2"

    Keypad

    Keypad: "Keypad"

    Leak

    Leak: "Water Detector"

    Lock

    Lock: "Lock"

    LockPro

    LockPro: "Lock Pro"

    Meter

    Meter: "Meter"

    MeterPlus

    MeterPlus: "Meter Plus"

    MeterPro

    MeterPro: "Meter Pro"

    MeterProCO2

    MeterProCO2: "Meter Pro CO2"

    MotionSensor

    MotionSensor: "Motion Sensor"

    OutdoorMeter

    OutdoorMeter: "Outdoor Meter"

    PlugMini

    PlugMini: "Plug Mini"

    RelaySwitch1

    RelaySwitch1: "Relay Switch 1"

    RelaySwitch1PM

    RelaySwitch1PM: "Relay Switch 1PM"

    Remote

    Remote: "Remote"

    StripLight

    StripLight: "Strip Light"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    BatteryCirculatorFan

    BatteryCirculatorFan: "Battery Circulator Fan"

    BlindTilt

    BlindTilt: "Blind Tilt"

    Bot

    Bot: "Bot"

    CeilingLight

    CeilingLight: "Ceiling Light"

    CeilingLightPro

    CeilingLightPro: "Ceiling Light Pro"

    CirculatorFan

    CirculatorFan: "Circulator Fan"

    ColorBulb

    ColorBulb: "Color Bulb"

    ContactSensor

    ContactSensor: "Contact Sensor"

    Curtain

    Curtain: "Curtain"

    Curtain3

    Curtain3: "Curtain 3"

    Hub2

    Hub2: "Hub 2"

    Humidifier

    Humidifier: "Humidifier"

    Humidifier2

    Humidifier2: "Humidifier2"

    Keypad

    Keypad: "Keypad"

    Leak

    Leak: "Water Detector"

    Lock

    Lock: "Lock"

    LockPro

    LockPro: "Lock Pro"

    Meter

    Meter: "Meter"

    MeterPlus

    MeterPlus: "Meter Plus"

    MeterPro

    MeterPro: "Meter Pro"

    MeterProCO2

    MeterProCO2: "Meter Pro CO2"

    MotionSensor

    MotionSensor: "Motion Sensor"

    OutdoorMeter

    OutdoorMeter: "Outdoor Meter"

    PlugMini

    PlugMini: "Plug Mini"

    RelaySwitch1

    RelaySwitch1: "Relay Switch 1"

    RelaySwitch1PM

    RelaySwitch1PM: "Relay Switch 1PM"

    Remote

    Remote: "Remote"

    StripLight

    StripLight: "Strip Light"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/enums/SwitchBotBLEModelName.html b/docs/enums/SwitchBotBLEModelName.html index 6b9e4730..fef7ed11 100644 --- a/docs/enums/SwitchBotBLEModelName.html +++ b/docs/enums/SwitchBotBLEModelName.html @@ -1,4 +1,4 @@ -SwitchBotBLEModelName | node-switchbot

    Enumeration SwitchBotBLEModelName

    Enumeration Members

    BlindTilt +SwitchBotBLEModelName | node-switchbot

    Enumeration SwitchBotBLEModelName

    Enumeration Members

    BlindTilt Bot CeilingLight CeilingLightPro @@ -25,4 +25,4 @@ Remote StripLight Unknown -

    Enumeration Members

    BlindTilt

    BlindTilt: "WoBlindTilt"

    Bot

    Bot: "WoHand"

    CeilingLight

    CeilingLight: "WoCeilingLight"

    CeilingLightPro

    CeilingLightPro: "WoCeilingLightPro"

    ColorBulb

    ColorBulb: "WoBulb"

    ContactSensor

    ContactSensor: "WoContact"

    Curtain

    Curtain: "WoCurtain"

    Curtain3

    Curtain3: "WoCurtain3"

    Hub2

    Hub2: "WoHub2"

    Humidifier

    Humidifier: "WoHumi"

    Humidifier2

    Humidifier2: "WoHumi2"

    Keypad

    Keypad: "WoKeypad"

    Leak

    Leak: "WoLeakDetector"

    Lock

    Lock: "WoSmartLock"

    LockPro

    LockPro: "WoSmartLockPro"

    Meter

    Meter: "WoSensorTH"

    MeterPlus

    MeterPlus: "WoSensorTHPlus"

    MeterPro

    MeterPro: "WoSensorTHP"

    MeterProCO2

    MeterProCO2: "WoSensorTHPc"

    MotionSensor

    MotionSensor: "WoMotion"

    OutdoorMeter

    OutdoorMeter: "WoIOSensorTH"

    PlugMini

    PlugMini: "WoPlugMini"

    RelaySwitch1

    RelaySwitch1: "WoRelaySwitch1Plus"

    RelaySwitch1PM

    RelaySwitch1PM: "WoRelaySwitch1PM"

    Remote

    Remote: "WoRemote"

    StripLight

    StripLight: "WoStrip"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    BlindTilt

    BlindTilt: "WoBlindTilt"

    Bot

    Bot: "WoHand"

    CeilingLight

    CeilingLight: "WoCeilingLight"

    CeilingLightPro

    CeilingLightPro: "WoCeilingLightPro"

    ColorBulb

    ColorBulb: "WoBulb"

    ContactSensor

    ContactSensor: "WoContact"

    Curtain

    Curtain: "WoCurtain"

    Curtain3

    Curtain3: "WoCurtain3"

    Hub2

    Hub2: "WoHub2"

    Humidifier

    Humidifier: "WoHumi"

    Humidifier2

    Humidifier2: "WoHumi2"

    Keypad

    Keypad: "WoKeypad"

    Leak

    Leak: "WoLeakDetector"

    Lock

    Lock: "WoSmartLock"

    LockPro

    LockPro: "WoSmartLockPro"

    Meter

    Meter: "WoSensorTH"

    MeterPlus

    MeterPlus: "WoSensorTHPlus"

    MeterPro

    MeterPro: "WoSensorTHP"

    MeterProCO2

    MeterProCO2: "WoSensorTHPc"

    MotionSensor

    MotionSensor: "WoMotion"

    OutdoorMeter

    OutdoorMeter: "WoIOSensorTH"

    PlugMini

    PlugMini: "WoPlugMini"

    RelaySwitch1

    RelaySwitch1: "WoRelaySwitch1Plus"

    RelaySwitch1PM

    RelaySwitch1PM: "WoRelaySwitch1PM"

    Remote

    Remote: "WoRemote"

    StripLight

    StripLight: "WoStrip"

    Unknown

    Unknown: "Unknown"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/enums/SwitchBotModel.html b/docs/enums/SwitchBotModel.html index 10ad15bc..07f3c0b8 100644 --- a/docs/enums/SwitchBotModel.html +++ b/docs/enums/SwitchBotModel.html @@ -1,4 +1,4 @@ -SwitchBotModel | node-switchbot

    Enumeration SwitchBotModel

    Enumeration Members

    BatteryCirculatorFan +SwitchBotModel | node-switchbot

    Enumeration SwitchBotModel

    Enumeration Members

    BatteryCirculatorFan BlindTilt Bot CeilingLight @@ -44,4 +44,4 @@ WaterDetector WoSweeper WoSweeperMini -

    Enumeration Members

    BatteryCirculatorFan

    BatteryCirculatorFan: "W3800510"

    BlindTilt

    BlindTilt: "W2701600"

    Bot

    Bot: "SwitchBot S1"

    CeilingLight

    CeilingLight: "W2612230/W2612240"

    CeilingLightPro

    CeilingLightPro: "W2612210/W2612220"

    CirculatorFan

    CirculatorFan: "W3800511"

    ColorBulb

    ColorBulb: "W1401400"

    ContactSensor

    ContactSensor: "W1201500"

    Curtain

    Curtain: "W0701600"

    Curtain3

    Curtain3: "W2400000"

    Hub2

    Hub2: "W3202100"

    HubMini

    HubMini: "W0202200"

    HubPlus

    HubPlus: "SwitchBot Hub S1"

    Humidifier

    Humidifier: "W0801800"

    Humidifier2

    Humidifier2: "WXXXXXXX"

    IndoorCam

    IndoorCam: "W1301200"

    K10

    K10: "K10+"

    K10Pro

    K10Pro: "K10+ Pro"

    Keypad

    Keypad: "W2500010"

    KeypadTouch

    KeypadTouch: "W2500020"

    Lock

    Lock: "W1601700"

    LockPro

    LockPro: "W3500000"

    Meter

    Meter: "SwitchBot MeterTH S1"

    MeterPlusJP

    MeterPlusJP: "W2201500"

    MeterPlusUS

    MeterPlusUS: "W2301500"

    MeterPro

    MeterPro: "W4900000"

    MeterProCO2

    MeterProCO2: "W4900010"

    MotionSensor

    MotionSensor: "W1101500"

    OutdoorMeter

    OutdoorMeter: "W3400010"

    PanTiltCam

    PanTiltCam: "W1801200"

    PanTiltCam2K

    PanTiltCam2K: "W3101100"

    Plug

    Plug: "SP11"

    PlugMiniJP

    PlugMiniJP: "W2001400/W2001401"

    PlugMiniUS

    PlugMiniUS: "W1901400/W1901401"

    RelaySwitch1

    RelaySwitch1: "W5502300"

    RelaySwitch1PM

    RelaySwitch1PM: "W5502310"

    Remote

    Remote: "Remote"

    RobotVacuumCleanerS1

    RobotVacuumCleanerS1: "W3011000"

    RobotVacuumCleanerS10

    RobotVacuumCleanerS10: "W3211800"

    RobotVacuumCleanerS1Plus

    RobotVacuumCleanerS1Plus: "W3011010"

    StripLight

    StripLight: "W1701100"

    UniversalRemote

    UniversalRemote: "UniversalRemote"

    Unknown

    Unknown: "Unknown"

    WaterDetector

    WaterDetector: "W4402000"

    WoSweeper

    WoSweeper: "WoSweeper"

    WoSweeperMini

    WoSweeperMini: "WoSweeperMini"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    +

    Enumeration Members

    BatteryCirculatorFan

    BatteryCirculatorFan: "W3800510"

    BlindTilt

    BlindTilt: "W2701600"

    Bot

    Bot: "SwitchBot S1"

    CeilingLight

    CeilingLight: "W2612230/W2612240"

    CeilingLightPro

    CeilingLightPro: "W2612210/W2612220"

    CirculatorFan

    CirculatorFan: "W3800511"

    ColorBulb

    ColorBulb: "W1401400"

    ContactSensor

    ContactSensor: "W1201500"

    Curtain

    Curtain: "W0701600"

    Curtain3

    Curtain3: "W2400000"

    Hub2

    Hub2: "W3202100"

    HubMini

    HubMini: "W0202200"

    HubPlus

    HubPlus: "SwitchBot Hub S1"

    Humidifier

    Humidifier: "W0801800"

    Humidifier2

    Humidifier2: "WXXXXXXX"

    IndoorCam

    IndoorCam: "W1301200"

    K10

    K10: "K10+"

    K10Pro

    K10Pro: "K10+ Pro"

    Keypad

    Keypad: "W2500010"

    KeypadTouch

    KeypadTouch: "W2500020"

    Lock

    Lock: "W1601700"

    LockPro

    LockPro: "W3500000"

    Meter

    Meter: "SwitchBot MeterTH S1"

    MeterPlusJP

    MeterPlusJP: "W2201500"

    MeterPlusUS

    MeterPlusUS: "W2301500"

    MeterPro

    MeterPro: "W4900000"

    MeterProCO2

    MeterProCO2: "W4900010"

    MotionSensor

    MotionSensor: "W1101500"

    OutdoorMeter

    OutdoorMeter: "W3400010"

    PanTiltCam

    PanTiltCam: "W1801200"

    PanTiltCam2K

    PanTiltCam2K: "W3101100"

    Plug

    Plug: "SP11"

    PlugMiniJP

    PlugMiniJP: "W2001400/W2001401"

    PlugMiniUS

    PlugMiniUS: "W1901400/W1901401"

    RelaySwitch1

    RelaySwitch1: "W5502300"

    RelaySwitch1PM

    RelaySwitch1PM: "W5502310"

    Remote

    Remote: "Remote"

    RobotVacuumCleanerS1

    RobotVacuumCleanerS1: "W3011000"

    RobotVacuumCleanerS10

    RobotVacuumCleanerS10: "W3211800"

    RobotVacuumCleanerS1Plus

    RobotVacuumCleanerS1Plus: "W3011010"

    StripLight

    StripLight: "W1701100"

    UniversalRemote

    UniversalRemote: "UniversalRemote"

    Unknown

    Unknown: "Unknown"

    WaterDetector

    WaterDetector: "W4402000"

    WoSweeper

    WoSweeper: "WoSweeper"

    WoSweeperMini

    WoSweeperMini: "WoSweeperMini"

    Settings

    Member Visibility

    On This Page

    Enumeration Members
    diff --git a/docs/interfaces/AdvertisementData.html b/docs/interfaces/AdvertisementData.html index cfb2b75c..691a9949 100644 --- a/docs/interfaces/AdvertisementData.html +++ b/docs/interfaces/AdvertisementData.html @@ -1,3 +1,3 @@ -AdvertisementData | node-switchbot

    Interface AdvertisementData

    interface AdvertisementData {
        manufacturerData: null | Buffer<ArrayBufferLike>;
        serviceData: null | Buffer<ArrayBufferLike>;
    }

    Properties

    manufacturerData +AdvertisementData | node-switchbot

    Interface AdvertisementData

    interface AdvertisementData {
        manufacturerData: null | Buffer<ArrayBufferLike>;
        serviceData: null | Buffer<ArrayBufferLike>;
    }

    Properties

    manufacturerData serviceData -

    Properties

    manufacturerData

    manufacturerData: null | Buffer<ArrayBufferLike>

    serviceData

    serviceData: null | Buffer<ArrayBufferLike>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    manufacturerData

    manufacturerData: null | Buffer<ArrayBufferLike>

    serviceData

    serviceData: null | Buffer<ArrayBufferLike>

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/Chars.html b/docs/interfaces/Chars.html index d4ced4b4..08720e74 100644 --- a/docs/interfaces/Chars.html +++ b/docs/interfaces/Chars.html @@ -1,4 +1,4 @@ -Chars | node-switchbot

    Interface Chars

    interface Chars {
        device: null | Characteristic;
        notify: null | Characteristic;
        write: null | Characteristic;
    }

    Properties

    device +Chars | node-switchbot

    Interface Chars

    interface Chars {
        device: null | Characteristic;
        notify: null | Characteristic;
        write: null | Characteristic;
    }

    Properties

    device notify write -

    Properties

    device

    device: null | Characteristic

    notify

    notify: null | Characteristic

    write

    write: null | Characteristic

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    device

    device: null | Characteristic

    notify

    notify: null | Characteristic

    write

    write: null | Characteristic

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/ErrorObject.html b/docs/interfaces/ErrorObject.html index e34892e8..f0ca5752 100644 --- a/docs/interfaces/ErrorObject.html +++ b/docs/interfaces/ErrorObject.html @@ -1,3 +1,3 @@ -ErrorObject | node-switchbot

    Interface ErrorObject

    interface ErrorObject {
        code: string;
        message: string;
    }

    Properties

    code +ErrorObject | node-switchbot

    Interface ErrorObject

    interface ErrorObject {
        code: string;
        message: string;
    }

    Properties

    code message -

    Properties

    code

    code: string

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    code

    code: string

    message

    message: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/NobleTypes.html b/docs/interfaces/NobleTypes.html index 099801a9..221cc3c2 100644 --- a/docs/interfaces/NobleTypes.html +++ b/docs/interfaces/NobleTypes.html @@ -1,4 +1,4 @@ -NobleTypes | node-switchbot

    Interface NobleTypes

    interface NobleTypes {
        noble: __module;
        peripheral: Peripheral;
        state:
            | "unknown"
            | "resetting"
            | "unsupported"
            | "unauthorized"
            | "poweredOff"
            | "poweredOn";
    }

    Properties

    noble +NobleTypes | node-switchbot

    Interface NobleTypes

    interface NobleTypes {
        noble: __module;
        peripheral: Peripheral;
        state:
            | "unknown"
            | "resetting"
            | "unsupported"
            | "unauthorized"
            | "poweredOff"
            | "poweredOn";
    }

    Properties

    noble peripheral state -

    Properties

    noble

    noble: __module

    peripheral

    peripheral: Peripheral

    state

    state:
        | "unknown"
        | "resetting"
        | "unsupported"
        | "unauthorized"
        | "poweredOff"
        | "poweredOn"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    noble

    noble: __module

    peripheral

    peripheral: Peripheral

    state

    state:
        | "unknown"
        | "resetting"
        | "unsupported"
        | "unauthorized"
        | "poweredOff"
        | "poweredOn"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/Params.html b/docs/interfaces/Params.html index 6c1e5860..7059f46d 100644 --- a/docs/interfaces/Params.html +++ b/docs/interfaces/Params.html @@ -1,6 +1,6 @@ -Params | node-switchbot

    Interface Params

    interface Params {
        duration?: number;
        id?: string;
        model?: string;
        noble?: __module;
        quick?: boolean;
    }

    Properties

    duration? +Params | node-switchbot

    Interface Params

    interface Params {
        duration?: number;
        id?: string;
        model?: string;
        noble?: __module;
        quick?: boolean;
    }

    Properties

    duration? id? model? noble? quick? -

    Properties

    Optionalduration

    duration?: number

    Optionalid

    id?: string

    Optionalmodel

    model?: string

    Optionalnoble

    noble?: __module

    Optionalquick

    quick?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalduration

    duration?: number

    Optionalid

    id?: string

    Optionalmodel

    model?: string

    Optionalnoble

    noble?: __module

    Optionalquick

    quick?: boolean

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/Rule.html b/docs/interfaces/Rule.html index d2bd04ea..97f1701e 100644 --- a/docs/interfaces/Rule.html +++ b/docs/interfaces/Rule.html @@ -1,4 +1,4 @@ -Rule | node-switchbot

    Interface Rule

    interface Rule {
        enum?: unknown[];
        max?: number;
        maxBytes?: number;
        min?: number;
        minBytes?: number;
        pattern?: RegExp;
        required?: boolean;
        type?: "string" | "boolean" | "object" | "float" | "integer" | "array";
    }

    Properties

    enum? +Rule | node-switchbot

    Interface Rule

    interface Rule {
        enum?: unknown[];
        max?: number;
        maxBytes?: number;
        min?: number;
        minBytes?: number;
        pattern?: RegExp;
        required?: boolean;
        type?: "string" | "boolean" | "object" | "float" | "integer" | "array";
    }

    Properties

    enum? max? maxBytes? min? @@ -6,4 +6,4 @@ pattern? required? type? -

    Properties

    Optionalenum

    enum?: unknown[]

    Optionalmax

    max?: number

    OptionalmaxBytes

    maxBytes?: number

    Optionalmin

    min?: number

    OptionalminBytes

    minBytes?: number

    Optionalpattern

    pattern?: RegExp

    Optionalrequired

    required?: boolean

    Optionaltype

    type?: "string" | "boolean" | "object" | "float" | "integer" | "array"

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalenum

    enum?: unknown[]

    Optionalmax

    max?: number

    OptionalmaxBytes

    maxBytes?: number

    Optionalmin

    min?: number

    OptionalminBytes

    minBytes?: number

    Optionalpattern

    pattern?: RegExp

    Optionalrequired

    required?: boolean

    Optionaltype

    type?: "string" | "boolean" | "object" | "float" | "integer" | "array"

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/ServiceData.html b/docs/interfaces/ServiceData.html index 7b9ad5a6..01d5e307 100644 --- a/docs/interfaces/ServiceData.html +++ b/docs/interfaces/ServiceData.html @@ -1,2 +1,2 @@ -ServiceData | node-switchbot

    Interface ServiceData

    interface ServiceData {
        model: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

    Properties

    model -

    Properties

    model

    model: string

    Settings

    Member Visibility

    On This Page

    Properties
    +ServiceData | node-switchbot

    Interface ServiceData

    interface ServiceData {
        model: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

    Properties

    model +

    Properties

    model

    model: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/SwitchBotBLEDevice.html b/docs/interfaces/SwitchBotBLEDevice.html index 791606e7..d1ecbd92 100644 --- a/docs/interfaces/SwitchBotBLEDevice.html +++ b/docs/interfaces/SwitchBotBLEDevice.html @@ -1,4 +1,4 @@ -SwitchBotBLEDevice | node-switchbot

    Interface SwitchBotBLEDevice

    interface SwitchBotBLEDevice {
        BlindTilt: DeviceInfo;
        Bot: DeviceInfo;
        CeilingLight: DeviceInfo;
        CeilingLightPro: DeviceInfo;
        ColorBulb: DeviceInfo;
        ContactSensor: DeviceInfo;
        Curtain: DeviceInfo;
        Curtain3: DeviceInfo;
        Hub2: DeviceInfo;
        Humidifier: DeviceInfo;
        Lock: DeviceInfo;
        LockPro: DeviceInfo;
        Meter: DeviceInfo;
        MeterPlus: DeviceInfo;
        MeterPro: DeviceInfo;
        MeterProCO2: DeviceInfo;
        MotionSensor: DeviceInfo;
        OutdoorMeter: DeviceInfo;
        PlugMiniJP: DeviceInfo;
        PlugMiniUS: DeviceInfo;
        StripLight: DeviceInfo;
        Unknown: DeviceInfo;
    }

    Properties

    BlindTilt +SwitchBotBLEDevice | node-switchbot

    Interface SwitchBotBLEDevice

    interface SwitchBotBLEDevice {
        BlindTilt: DeviceInfo;
        Bot: DeviceInfo;
        CeilingLight: DeviceInfo;
        CeilingLightPro: DeviceInfo;
        ColorBulb: DeviceInfo;
        ContactSensor: DeviceInfo;
        Curtain: DeviceInfo;
        Curtain3: DeviceInfo;
        Hub2: DeviceInfo;
        Humidifier: DeviceInfo;
        Lock: DeviceInfo;
        LockPro: DeviceInfo;
        Meter: DeviceInfo;
        MeterPlus: DeviceInfo;
        MeterPro: DeviceInfo;
        MeterProCO2: DeviceInfo;
        MotionSensor: DeviceInfo;
        OutdoorMeter: DeviceInfo;
        PlugMiniJP: DeviceInfo;
        PlugMiniUS: DeviceInfo;
        StripLight: DeviceInfo;
        Unknown: DeviceInfo;
    }

    Properties

    BlindTilt Bot CeilingLight CeilingLightPro @@ -20,4 +20,4 @@ PlugMiniUS StripLight Unknown -

    Properties

    BlindTilt

    BlindTilt: DeviceInfo

    Bot

    Bot: DeviceInfo

    CeilingLight

    CeilingLight: DeviceInfo

    CeilingLightPro

    CeilingLightPro: DeviceInfo

    ColorBulb

    ColorBulb: DeviceInfo

    ContactSensor

    ContactSensor: DeviceInfo

    Curtain

    Curtain: DeviceInfo

    Curtain3

    Curtain3: DeviceInfo

    Hub2

    Hub2: DeviceInfo

    Humidifier

    Humidifier: DeviceInfo

    Lock

    Lock: DeviceInfo

    LockPro

    LockPro: DeviceInfo

    Meter

    Meter: DeviceInfo

    MeterPlus

    MeterPlus: DeviceInfo

    MeterPro

    MeterPro: DeviceInfo

    MeterProCO2

    MeterProCO2: DeviceInfo

    MotionSensor

    MotionSensor: DeviceInfo

    OutdoorMeter

    OutdoorMeter: DeviceInfo

    PlugMiniJP

    PlugMiniJP: DeviceInfo

    PlugMiniUS

    PlugMiniUS: DeviceInfo

    StripLight

    StripLight: DeviceInfo

    Unknown

    Unknown: DeviceInfo

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    BlindTilt

    BlindTilt: DeviceInfo

    Bot

    Bot: DeviceInfo

    CeilingLight

    CeilingLight: DeviceInfo

    CeilingLightPro

    CeilingLightPro: DeviceInfo

    ColorBulb

    ColorBulb: DeviceInfo

    ContactSensor

    ContactSensor: DeviceInfo

    Curtain

    Curtain: DeviceInfo

    Curtain3

    Curtain3: DeviceInfo

    Hub2

    Hub2: DeviceInfo

    Humidifier

    Humidifier: DeviceInfo

    Lock

    Lock: DeviceInfo

    LockPro

    LockPro: DeviceInfo

    Meter

    Meter: DeviceInfo

    MeterPlus

    MeterPlus: DeviceInfo

    MeterPro

    MeterPro: DeviceInfo

    MeterProCO2

    MeterProCO2: DeviceInfo

    MotionSensor

    MotionSensor: DeviceInfo

    OutdoorMeter

    OutdoorMeter: DeviceInfo

    PlugMiniJP

    PlugMiniJP: DeviceInfo

    PlugMiniUS

    PlugMiniUS: DeviceInfo

    StripLight

    StripLight: DeviceInfo

    Unknown

    Unknown: DeviceInfo

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/WebhookDetail.html b/docs/interfaces/WebhookDetail.html index b84d624f..aa841c6c 100644 --- a/docs/interfaces/WebhookDetail.html +++ b/docs/interfaces/WebhookDetail.html @@ -1,6 +1,6 @@ -WebhookDetail | node-switchbot

    Interface WebhookDetail

    interface WebhookDetail {
        createTime: number;
        deviceList: string;
        enable: boolean;
        lastUpdateTime: number;
        url: string;
    }

    Properties

    createTime +WebhookDetail | node-switchbot

    Interface WebhookDetail

    interface WebhookDetail {
        createTime: number;
        deviceList: string;
        enable: boolean;
        lastUpdateTime: number;
        url: string;
    }

    Properties

    createTime deviceList enable lastUpdateTime url -

    Properties

    createTime

    createTime: number

    deviceList

    deviceList: string

    enable

    enable: boolean

    lastUpdateTime

    lastUpdateTime: number

    url

    url: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    createTime

    createTime: number

    deviceList

    deviceList: string

    enable

    enable: boolean

    lastUpdateTime

    lastUpdateTime: number

    url

    url: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/ad.html b/docs/interfaces/ad.html index 419f4faa..22c3935b 100644 --- a/docs/interfaces/ad.html +++ b/docs/interfaces/ad.html @@ -1,5 +1,5 @@ -ad | node-switchbot

    Interface ad

    interface ad {
        address: string;
        id: string;
        rssi: number;
        serviceData:
            | botServiceData
            | colorBulbServiceData
            | contactSensorServiceData
            | curtainServiceData
            | curtain3ServiceData
            | stripLightServiceData
            | lockServiceData
            | lockProServiceData
            | meterServiceData
            | meterPlusServiceData
            | meterProServiceData
            | meterProCO2ServiceData
            | outdoorMeterServiceData
            | motionSensorServiceData
            | plugMiniUSServiceData
            | plugMiniJPServiceData
            | blindTiltServiceData
            | ceilingLightServiceData
            | ceilingLightProServiceData
            | hub2ServiceData
            | batteryCirculatorFanServiceData
            | waterLeakDetectorServiceData
            | humidifierServiceData
            | humidifier2ServiceData
            | robotVacuumCleanerServiceData
            | keypadDetectorServiceData
            | relaySwitch1ServiceData
            | relaySwitch1PMServiceData
            | remoteServiceData;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

    Properties

    address +ad | node-switchbot

    Interface ad

    interface ad {
        address: string;
        id: string;
        rssi: number;
        serviceData:
            | botServiceData
            | colorBulbServiceData
            | contactSensorServiceData
            | curtainServiceData
            | curtain3ServiceData
            | stripLightServiceData
            | lockServiceData
            | lockProServiceData
            | meterServiceData
            | meterPlusServiceData
            | meterProServiceData
            | meterProCO2ServiceData
            | outdoorMeterServiceData
            | motionSensorServiceData
            | plugMiniUSServiceData
            | plugMiniJPServiceData
            | blindTiltServiceData
            | ceilingLightServiceData
            | ceilingLightProServiceData
            | hub2ServiceData
            | batteryCirculatorFanServiceData
            | waterLeakDetectorServiceData
            | humidifierServiceData
            | humidifier2ServiceData
            | robotVacuumCleanerServiceData
            | keypadDetectorServiceData
            | relaySwitch1ServiceData
            | relaySwitch1PMServiceData
            | remoteServiceData;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

    Properties

    address id rssi serviceData -

    Properties

    address

    address: string

    id

    id: string

    rssi

    rssi: number

    serviceData

    serviceData:
        | botServiceData
        | colorBulbServiceData
        | contactSensorServiceData
        | curtainServiceData
        | curtain3ServiceData
        | stripLightServiceData
        | lockServiceData
        | lockProServiceData
        | meterServiceData
        | meterPlusServiceData
        | meterProServiceData
        | meterProCO2ServiceData
        | outdoorMeterServiceData
        | motionSensorServiceData
        | plugMiniUSServiceData
        | plugMiniJPServiceData
        | blindTiltServiceData
        | ceilingLightServiceData
        | ceilingLightProServiceData
        | hub2ServiceData
        | batteryCirculatorFanServiceData
        | waterLeakDetectorServiceData
        | humidifierServiceData
        | humidifier2ServiceData
        | robotVacuumCleanerServiceData
        | keypadDetectorServiceData
        | relaySwitch1ServiceData
        | relaySwitch1PMServiceData
        | remoteServiceData

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    address

    address: string

    id

    id: string

    rssi

    rssi: number

    serviceData

    serviceData:
        | botServiceData
        | colorBulbServiceData
        | contactSensorServiceData
        | curtainServiceData
        | curtain3ServiceData
        | stripLightServiceData
        | lockServiceData
        | lockProServiceData
        | meterServiceData
        | meterPlusServiceData
        | meterProServiceData
        | meterProCO2ServiceData
        | outdoorMeterServiceData
        | motionSensorServiceData
        | plugMiniUSServiceData
        | plugMiniJPServiceData
        | blindTiltServiceData
        | ceilingLightServiceData
        | ceilingLightProServiceData
        | hub2ServiceData
        | batteryCirculatorFanServiceData
        | waterLeakDetectorServiceData
        | humidifierServiceData
        | humidifier2ServiceData
        | robotVacuumCleanerServiceData
        | keypadDetectorServiceData
        | relaySwitch1ServiceData
        | relaySwitch1PMServiceData
        | remoteServiceData

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/body.html b/docs/interfaces/body.html index ed54cbd7..4d76fa6e 100644 --- a/docs/interfaces/body.html +++ b/docs/interfaces/body.html @@ -1,3 +1,3 @@ -body | node-switchbot

    Interface body

    interface body {
        deviceList: deviceList;
        infraredRemoteList: infraredRemoteList;
    }

    Properties

    deviceList +body | node-switchbot

    Interface body

    interface body {
        deviceList: deviceList;
        infraredRemoteList: infraredRemoteList;
    }

    Properties

    deviceList infraredRemoteList -

    Properties

    deviceList

    deviceList: deviceList

    infraredRemoteList

    infraredRemoteList: infraredRemoteList

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    deviceList

    deviceList: deviceList

    infraredRemoteList

    infraredRemoteList: infraredRemoteList

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/bodyChange.html b/docs/interfaces/bodyChange.html index 14a8068a..bce10983 100644 --- a/docs/interfaces/bodyChange.html +++ b/docs/interfaces/bodyChange.html @@ -1,4 +1,4 @@ -bodyChange | node-switchbot

    Interface bodyChange

    interface bodyChange {
        command: string;
        commandType: string;
        parameter: string;
    }

    Properties

    command +bodyChange | node-switchbot

    Interface bodyChange

    interface bodyChange {
        command: string;
        commandType: string;
        parameter: string;
    }

    Properties

    command commandType parameter -

    Properties

    command

    command: string

    commandType

    commandType: string

    parameter

    parameter: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    command

    command: string

    commandType

    commandType: string

    parameter

    parameter: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deleteWebhookResponse.html b/docs/interfaces/deleteWebhookResponse.html index b91d798d..1df44e35 100644 --- a/docs/interfaces/deleteWebhookResponse.html +++ b/docs/interfaces/deleteWebhookResponse.html @@ -1,4 +1,4 @@ -deleteWebhookResponse | node-switchbot

    Interface deleteWebhookResponse

    interface deleteWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body +deleteWebhookResponse | node-switchbot

    Interface deleteWebhookResponse

    interface deleteWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/device.html b/docs/interfaces/device.html index b84c7110..52d4f675 100644 --- a/docs/interfaces/device.html +++ b/docs/interfaces/device.html @@ -1,7 +1,7 @@ -device | node-switchbot

    Interface device

    interface device {
        deviceId: string;
        deviceName: string;
        deviceType: string;
        enableCloudService: boolean;
        hubDeviceId: string;
        version?: number;
    }

    Hierarchy (View Summary)

    Properties

    deviceId +device | node-switchbot

    Interface device

    interface device {
        deviceId: string;
        deviceName: string;
        deviceType: string;
        enableCloudService: boolean;
        hubDeviceId: string;
        version?: number;
    }

    Hierarchy (View Summary)

    Properties

    deviceId deviceName deviceType enableCloudService hubDeviceId version? -

    Properties

    deviceId

    deviceId: string

    deviceName

    deviceName: string

    deviceType

    deviceType: string

    enableCloudService

    enableCloudService: boolean

    hubDeviceId

    hubDeviceId: string

    Optionalversion

    version?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    deviceId

    deviceId: string

    deviceName

    deviceName: string

    deviceType

    deviceType: string

    enableCloudService

    enableCloudService: boolean

    hubDeviceId

    hubDeviceId: string

    Optionalversion

    version?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deviceList.html b/docs/interfaces/deviceList.html index 56031abb..c42854a7 100644 --- a/docs/interfaces/deviceList.html +++ b/docs/interfaces/deviceList.html @@ -1,2 +1,2 @@ -deviceList | node-switchbot

    Interface deviceList

    interface deviceList {
        device: device[];
    }

    Properties

    device -

    Properties

    device

    device: device[]

    Settings

    Member Visibility

    On This Page

    Properties
    +deviceList | node-switchbot

    Interface deviceList

    interface deviceList {
        device: device[];
    }

    Properties

    device +

    Properties

    device

    device: device[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deviceStatus.html b/docs/interfaces/deviceStatus.html index 9f49f194..09359e17 100644 --- a/docs/interfaces/deviceStatus.html +++ b/docs/interfaces/deviceStatus.html @@ -1,7 +1,7 @@ -deviceStatus | node-switchbot

    Interface deviceStatus

    interface deviceStatus {
        deviceId: string;
        deviceName: string;
        deviceType: string;
        enableCloudService: boolean;
        hubDeviceId: string;
        version: number;
    }

    Hierarchy (View Summary)

    Properties

    deviceId +deviceStatus | node-switchbot

    Interface deviceStatus

    interface deviceStatus {
        deviceId: string;
        deviceName: string;
        deviceType: string;
        enableCloudService: boolean;
        hubDeviceId: string;
        version: number;
    }

    Hierarchy (View Summary)

    Properties

    deviceId deviceName deviceType enableCloudService hubDeviceId version -

    Properties

    deviceId

    deviceId: string

    deviceName

    deviceName: string

    deviceType

    deviceType: string

    enableCloudService

    enableCloudService: boolean

    hubDeviceId

    hubDeviceId: string

    version

    version: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    deviceId

    deviceId: string

    deviceName

    deviceName: string

    deviceType

    deviceType: string

    enableCloudService

    enableCloudService: boolean

    hubDeviceId

    hubDeviceId: string

    version

    version: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deviceStatusRequest.html b/docs/interfaces/deviceStatusRequest.html index f1beeef7..826acae0 100644 --- a/docs/interfaces/deviceStatusRequest.html +++ b/docs/interfaces/deviceStatusRequest.html @@ -1,4 +1,4 @@ -deviceStatusRequest | node-switchbot

    Interface deviceStatusRequest

    interface deviceStatusRequest {
        body: deviceStatus;
        message: string;
        statusCode: number;
    }

    Properties

    body +deviceStatusRequest | node-switchbot

    Interface deviceStatusRequest

    interface deviceStatusRequest {
        body: deviceStatus;
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: deviceStatus

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: deviceStatus

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deviceWebhook.html b/docs/interfaces/deviceWebhook.html index f725d707..a92f7225 100644 --- a/docs/interfaces/deviceWebhook.html +++ b/docs/interfaces/deviceWebhook.html @@ -1,4 +1,4 @@ -deviceWebhook | node-switchbot

    Interface deviceWebhook

    interface deviceWebhook {
        context: deviceWebhookContext;
        eventType: string;
        eventVersion: string;
    }

    Properties

    context +deviceWebhook | node-switchbot

    Interface deviceWebhook

    interface deviceWebhook {
        context: deviceWebhookContext;
        eventType: string;
        eventVersion: string;
    }

    Properties

    context eventType eventVersion -

    Properties

    context

    context: deviceWebhookContext

    eventType

    eventType: string

    eventVersion

    eventVersion: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    context

    context: deviceWebhookContext

    eventType

    eventType: string

    eventVersion

    eventVersion: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/deviceWebhookContext.html b/docs/interfaces/deviceWebhookContext.html index c257abed..4d459118 100644 --- a/docs/interfaces/deviceWebhookContext.html +++ b/docs/interfaces/deviceWebhookContext.html @@ -1,4 +1,4 @@ -deviceWebhookContext | node-switchbot

    Interface deviceWebhookContext

    interface deviceWebhookContext {
        deviceMac: string;
        deviceType: string;
        timeOfSample: number;
    }

    Properties

    deviceMac +deviceWebhookContext | node-switchbot

    Interface deviceWebhookContext

    interface deviceWebhookContext {
        deviceMac: string;
        deviceType: string;
        timeOfSample: number;
    }

    Properties

    deviceMac deviceType timeOfSample -

    Properties

    deviceMac

    deviceMac: string

    deviceType

    deviceType: string

    timeOfSample

    timeOfSample: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    deviceMac

    deviceMac: string

    deviceType

    deviceType: string

    timeOfSample

    timeOfSample: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/devices.html b/docs/interfaces/devices.html index 3c09680c..57654d71 100644 --- a/docs/interfaces/devices.html +++ b/docs/interfaces/devices.html @@ -1,4 +1,4 @@ -devices | node-switchbot

    Interface devices

    interface devices {
        body: body;
        message: string;
        statusCode: number;
    }

    Properties

    body +devices | node-switchbot

    Interface devices

    interface devices {
        body: body;
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: body

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: body

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/infraredRemoteList.html b/docs/interfaces/infraredRemoteList.html index 3f866be9..db55c87c 100644 --- a/docs/interfaces/infraredRemoteList.html +++ b/docs/interfaces/infraredRemoteList.html @@ -1,2 +1,2 @@ -infraredRemoteList | node-switchbot

    Interface infraredRemoteList

    interface infraredRemoteList {
        device: irdevice[];
    }

    Properties

    device -

    Properties

    device

    device: irdevice[]

    Settings

    Member Visibility

    On This Page

    Properties
    +infraredRemoteList | node-switchbot

    Interface infraredRemoteList

    interface infraredRemoteList {
        device: irdevice[];
    }

    Properties

    device +

    Properties

    device

    device: irdevice[]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/irdevice.html b/docs/interfaces/irdevice.html index b3109607..c331cf6e 100644 --- a/docs/interfaces/irdevice.html +++ b/docs/interfaces/irdevice.html @@ -1,5 +1,5 @@ -irdevice | node-switchbot

    Interface irdevice

    interface irdevice {
        deviceId?: string;
        deviceName: string;
        hubDeviceId: string;
        remoteType: string;
    }

    Properties

    deviceId? +irdevice | node-switchbot

    Interface irdevice

    interface irdevice {
        deviceId?: string;
        deviceName: string;
        hubDeviceId: string;
        remoteType: string;
    }

    Properties

    deviceId? deviceName hubDeviceId remoteType -

    Properties

    OptionaldeviceId

    deviceId?: string

    deviceName

    deviceName: string

    hubDeviceId

    hubDeviceId: string

    remoteType

    remoteType: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionaldeviceId

    deviceId?: string

    deviceName

    deviceName: string

    hubDeviceId

    hubDeviceId: string

    remoteType

    remoteType: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/pushResponse.html b/docs/interfaces/pushResponse.html index c14ad72c..fb036ffb 100644 --- a/docs/interfaces/pushResponse.html +++ b/docs/interfaces/pushResponse.html @@ -1,4 +1,4 @@ -pushResponse | node-switchbot

    Interface pushResponse

    interface pushResponse {
        body: { commandId: string };
        message: string;
        statusCode: number;
    }

    Properties

    body +pushResponse | node-switchbot

    Interface pushResponse

    interface pushResponse {
        body: { commandId: string };
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: { commandId: string }

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: { commandId: string }

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/queryWebhookResponse.html b/docs/interfaces/queryWebhookResponse.html index 7410ee27..5e2d181c 100644 --- a/docs/interfaces/queryWebhookResponse.html +++ b/docs/interfaces/queryWebhookResponse.html @@ -1,4 +1,4 @@ -queryWebhookResponse | node-switchbot

    Interface queryWebhookResponse

    interface queryWebhookResponse {
        body: WebhookDetail[];
        message: string;
        statusCode: number;
    }

    Properties

    body +queryWebhookResponse | node-switchbot

    Interface queryWebhookResponse

    interface queryWebhookResponse {
        body: WebhookDetail[];
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: WebhookDetail[]

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: WebhookDetail[]

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/setupWebhookResponse.html b/docs/interfaces/setupWebhookResponse.html index 03979f0e..7b660153 100644 --- a/docs/interfaces/setupWebhookResponse.html +++ b/docs/interfaces/setupWebhookResponse.html @@ -1,4 +1,4 @@ -setupWebhookResponse | node-switchbot

    Interface setupWebhookResponse

    interface setupWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body +setupWebhookResponse | node-switchbot

    Interface setupWebhookResponse

    interface setupWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/switchbot.html b/docs/interfaces/switchbot.html index e600c057..1822ae26 100644 --- a/docs/interfaces/switchbot.html +++ b/docs/interfaces/switchbot.html @@ -1,3 +1,3 @@ -switchbot | node-switchbot

    Interface switchbot

    interface switchbot {
        discover: (
            arg0: { duration?: any; id?: string; model: string; quick: boolean },
        ) => Promise<any>;
        wait: (arg0: number) => any;
    }

    Properties

    discover +switchbot | node-switchbot

    Interface switchbot

    interface switchbot {
        discover: (
            arg0: { duration?: any; id?: string; model: string; quick: boolean },
        ) => Promise<any>;
        wait: (arg0: number) => any;
    }

    Properties

    discover wait -

    Properties

    discover

    discover: (
        arg0: { duration?: any; id?: string; model: string; quick: boolean },
    ) => Promise<any>

    wait

    wait: (arg0: number) => any

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    discover

    discover: (
        arg0: { duration?: any; id?: string; model: string; quick: boolean },
    ) => Promise<any>

    wait

    wait: (arg0: number) => any

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/updateWebhookResponse.html b/docs/interfaces/updateWebhookResponse.html index dd87f682..10802315 100644 --- a/docs/interfaces/updateWebhookResponse.html +++ b/docs/interfaces/updateWebhookResponse.html @@ -1,4 +1,4 @@ -updateWebhookResponse | node-switchbot

    Interface updateWebhookResponse

    interface updateWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body +updateWebhookResponse | node-switchbot

    Interface updateWebhookResponse

    interface updateWebhookResponse {
        body: object;
        message: string;
        statusCode: number;
    }

    Properties

    body message statusCode -

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    body

    body: object

    message

    message: string

    statusCode

    statusCode: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/webhookRequest.html b/docs/interfaces/webhookRequest.html index b929b8c4..41eeb76a 100644 --- a/docs/interfaces/webhookRequest.html +++ b/docs/interfaces/webhookRequest.html @@ -1,4 +1,4 @@ -webhookRequest | node-switchbot

    Interface webhookRequest

    interface webhookRequest {
        action: string;
        deviceList: string;
        url: string;
    }

    Properties

    action +webhookRequest | node-switchbot

    Interface webhookRequest

    interface webhookRequest {
        action: string;
        deviceList: string;
        url: string;
    }

    Properties

    action deviceList url -

    Properties

    action

    action: string

    deviceList

    deviceList: string

    url

    url: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    action

    action: string

    deviceList

    deviceList: string

    url

    url: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/types/MacAddress.html b/docs/types/MacAddress.html index e74a4c2f..a24f0658 100644 --- a/docs/types/MacAddress.html +++ b/docs/types/MacAddress.html @@ -1 +1 @@ -MacAddress | node-switchbot

    Type Alias MacAddress

    MacAddress: string

    Settings

    Member Visibility
    +MacAddress | node-switchbot

    Type Alias MacAddress

    MacAddress: string

    Settings

    Member Visibility
    diff --git a/docs/types/batteryCirculatorFan.html b/docs/types/batteryCirculatorFan.html index a92150c5..59dc8560 100644 --- a/docs/types/batteryCirculatorFan.html +++ b/docs/types/batteryCirculatorFan.html @@ -1 +1 @@ -batteryCirculatorFan | node-switchbot

    Type Alias batteryCirculatorFan

    batteryCirculatorFan: device & {}

    Settings

    Member Visibility
    +batteryCirculatorFan | node-switchbot

    Type Alias batteryCirculatorFan

    batteryCirculatorFan: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/batteryCirculatorFanServiceData.html b/docs/types/batteryCirculatorFanServiceData.html index ca8bf951..9c53c8c9 100644 --- a/docs/types/batteryCirculatorFanServiceData.html +++ b/docs/types/batteryCirculatorFanServiceData.html @@ -1 +1 @@ -batteryCirculatorFanServiceData | node-switchbot

    Type Alias batteryCirculatorFanServiceData

    batteryCirculatorFanServiceData: serviceData & {
        fanSpeed: number;
        model: Unknown;
        modelFriendlyName: Unknown;
        modelName: Unknown;
        state: string;
    }

    Settings

    Member Visibility
    +batteryCirculatorFanServiceData | node-switchbot

    Type Alias batteryCirculatorFanServiceData

    batteryCirculatorFanServiceData: serviceData & {
        fanSpeed: number;
        model: Unknown;
        modelFriendlyName: Unknown;
        modelName: Unknown;
        state: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/batteryCirculatorFanStatus.html b/docs/types/batteryCirculatorFanStatus.html index 1262ee1d..a68aaa8f 100644 --- a/docs/types/batteryCirculatorFanStatus.html +++ b/docs/types/batteryCirculatorFanStatus.html @@ -1 +1 @@ -batteryCirculatorFanStatus | node-switchbot

    Type Alias batteryCirculatorFanStatus

    batteryCirculatorFanStatus: deviceStatus & {
        battery: number;
        chargingStatus: string;
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: number;
        oscillation: string;
        power: string;
        version: string;
        verticalOscillation: string;
    }

    Settings

    Member Visibility
    +batteryCirculatorFanStatus | node-switchbot

    Type Alias batteryCirculatorFanStatus

    batteryCirculatorFanStatus: deviceStatus & {
        battery: number;
        chargingStatus: string;
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: number;
        oscillation: string;
        power: string;
        version: string;
        verticalOscillation: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/batteryCirculatorFanWebhookContext.html b/docs/types/batteryCirculatorFanWebhookContext.html index 12c8d227..9118b7e7 100644 --- a/docs/types/batteryCirculatorFanWebhookContext.html +++ b/docs/types/batteryCirculatorFanWebhookContext.html @@ -1 +1 @@ -batteryCirculatorFanWebhookContext | node-switchbot

    Type Alias batteryCirculatorFanWebhookContext

    batteryCirculatorFanWebhookContext: deviceWebhookContext & {
        battery: number;
        chargingStatus: "charging" | "uncharged";
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: "off" | 1 | 2;
        oscillation: "on" | "off";
        powerState: "ON" | "OFF";
        version: string;
        verticalOscillation: "on" | "off";
    }

    Settings

    Member Visibility
    +batteryCirculatorFanWebhookContext | node-switchbot

    Type Alias batteryCirculatorFanWebhookContext

    batteryCirculatorFanWebhookContext: deviceWebhookContext & {
        battery: number;
        chargingStatus: "charging" | "uncharged";
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: "off" | 1 | 2;
        oscillation: "on" | "off";
        powerState: "ON" | "OFF";
        version: string;
        verticalOscillation: "on" | "off";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/blindTilt.html b/docs/types/blindTilt.html index a8528ecf..ecf0cbff 100644 --- a/docs/types/blindTilt.html +++ b/docs/types/blindTilt.html @@ -1 +1 @@ -blindTilt | node-switchbot

    Type Alias blindTilt

    blindTilt: device & {
        blindTiltDevicesIds: string[];
        calibrate: boolean;
        direction: string;
        group: boolean;
        master: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    +blindTilt | node-switchbot

    Type Alias blindTilt

    blindTilt: device & {
        blindTiltDevicesIds: string[];
        calibrate: boolean;
        direction: string;
        group: boolean;
        master: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/blindTiltServiceData.html b/docs/types/blindTiltServiceData.html index f733321c..17bde8f4 100644 --- a/docs/types/blindTiltServiceData.html +++ b/docs/types/blindTiltServiceData.html @@ -1 +1 @@ -blindTiltServiceData | node-switchbot

    Type Alias blindTiltServiceData

    blindTiltServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        inMotion: boolean;
        lightLevel: number;
        model: BlindTilt;
        modelFriendlyName: BlindTilt;
        modelName: BlindTilt;
        sequenceNumber: number;
        tilt: number;
    }

    Settings

    Member Visibility
    +blindTiltServiceData | node-switchbot

    Type Alias blindTiltServiceData

    blindTiltServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        inMotion: boolean;
        lightLevel: number;
        model: BlindTilt;
        modelFriendlyName: BlindTilt;
        modelName: BlindTilt;
        sequenceNumber: number;
        tilt: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/blindTiltStatus.html b/docs/types/blindTiltStatus.html index 15107e2b..7f576c26 100644 --- a/docs/types/blindTiltStatus.html +++ b/docs/types/blindTiltStatus.html @@ -1 +1 @@ -blindTiltStatus | node-switchbot

    Type Alias blindTiltStatus

    blindTiltStatus: deviceStatus & {
        battery: number;
        calibrate: boolean;
        direction: string;
        lightLevel?: "bright" | "dim";
        slidePosition: string;
    }

    Settings

    Member Visibility
    +blindTiltStatus | node-switchbot

    Type Alias blindTiltStatus

    blindTiltStatus: deviceStatus & {
        battery: number;
        calibrate: boolean;
        direction: string;
        lightLevel?: "bright" | "dim";
        slidePosition: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/blindTiltWebhookContext.html b/docs/types/blindTiltWebhookContext.html index 0f6e7808..06e37dbf 100644 --- a/docs/types/blindTiltWebhookContext.html +++ b/docs/types/blindTiltWebhookContext.html @@ -1 +1 @@ -blindTiltWebhookContext | node-switchbot

    Type Alias blindTiltWebhookContext

    blindTiltWebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        direction: string;
        group: boolean;
        slidePosition: number;
        version: string;
    }

    Settings

    Member Visibility
    +blindTiltWebhookContext | node-switchbot

    Type Alias blindTiltWebhookContext

    blindTiltWebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        direction: string;
        group: boolean;
        slidePosition: number;
        version: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/bot.html b/docs/types/bot.html index d409b436..467010e6 100644 --- a/docs/types/bot.html +++ b/docs/types/bot.html @@ -1 +1 @@ -bot | node-switchbot

    Type Alias bot

    bot: device & {}

    Settings

    Member Visibility
    +bot | node-switchbot

    Type Alias bot

    bot: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/botServiceData.html b/docs/types/botServiceData.html index 09db4aae..a196e311 100644 --- a/docs/types/botServiceData.html +++ b/docs/types/botServiceData.html @@ -1 +1 @@ -botServiceData | node-switchbot

    Type Alias botServiceData

    botServiceData: serviceData & {
        battery: number;
        mode: boolean;
        model: Bot;
        modelFriendlyName: Bot;
        modelName: Bot;
        state: boolean;
    }

    Settings

    Member Visibility
    +botServiceData | node-switchbot

    Type Alias botServiceData

    botServiceData: serviceData & {
        battery: number;
        mode: boolean;
        model: Bot;
        modelFriendlyName: Bot;
        modelName: Bot;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/botStatus.html b/docs/types/botStatus.html index 7789493b..914be20b 100644 --- a/docs/types/botStatus.html +++ b/docs/types/botStatus.html @@ -1 +1 @@ -botStatus | node-switchbot

    Type Alias botStatus

    botStatus: deviceStatus & {
        battery: number;
        mode: "pressMode" | "switchMode" | "customizeMode";
        power: string;
    }

    Settings

    Member Visibility
    +botStatus | node-switchbot

    Type Alias botStatus

    botStatus: deviceStatus & {
        battery: number;
        mode: "pressMode" | "switchMode" | "customizeMode";
        power: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/botWebhookContext.html b/docs/types/botWebhookContext.html index 46ab7fb1..f537bac4 100644 --- a/docs/types/botWebhookContext.html +++ b/docs/types/botWebhookContext.html @@ -1 +1 @@ -botWebhookContext | node-switchbot

    Type Alias botWebhookContext

    botWebhookContext: deviceWebhookContext & {
        battery: number;
        deviceMode: "pressMode" | "switchMode" | "customizeMode";
        power: string;
    }

    Settings

    Member Visibility
    +botWebhookContext | node-switchbot

    Type Alias botWebhookContext

    botWebhookContext: deviceWebhookContext & {
        battery: number;
        deviceMode: "pressMode" | "switchMode" | "customizeMode";
        power: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLight.html b/docs/types/ceilingLight.html index 4bd45f42..59b677db 100644 --- a/docs/types/ceilingLight.html +++ b/docs/types/ceilingLight.html @@ -1 +1 @@ -ceilingLight | node-switchbot

    Type Alias ceilingLight

    ceilingLight: device & {}

    Settings

    Member Visibility
    +ceilingLight | node-switchbot

    Type Alias ceilingLight

    ceilingLight: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightPro.html b/docs/types/ceilingLightPro.html index ca1719fe..af8b8ae2 100644 --- a/docs/types/ceilingLightPro.html +++ b/docs/types/ceilingLightPro.html @@ -1 +1 @@ -ceilingLightPro | node-switchbot

    Type Alias ceilingLightPro

    ceilingLightPro: device & {}

    Settings

    Member Visibility
    +ceilingLightPro | node-switchbot

    Type Alias ceilingLightPro

    ceilingLightPro: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightProServiceData.html b/docs/types/ceilingLightProServiceData.html index d714eddd..546f567b 100644 --- a/docs/types/ceilingLightProServiceData.html +++ b/docs/types/ceilingLightProServiceData.html @@ -1 +1 @@ -ceilingLightProServiceData | node-switchbot

    Type Alias ceilingLightProServiceData

    ceilingLightProServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: CeilingLightPro;
        modelFriendlyName: CeilingLightPro;
        modelName: CeilingLightPro;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    +ceilingLightProServiceData | node-switchbot

    Type Alias ceilingLightProServiceData

    ceilingLightProServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: CeilingLightPro;
        modelFriendlyName: CeilingLightPro;
        modelName: CeilingLightPro;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightProStatus.html b/docs/types/ceilingLightProStatus.html index 6f7b8a6b..80813737 100644 --- a/docs/types/ceilingLightProStatus.html +++ b/docs/types/ceilingLightProStatus.html @@ -1 +1 @@ -ceilingLightProStatus | node-switchbot

    Type Alias ceilingLightProStatus

    ceilingLightProStatus: deviceStatus & {
        brightness: number;
        colorTemperature: number;
        power: boolean;
    }

    Settings

    Member Visibility
    +ceilingLightProStatus | node-switchbot

    Type Alias ceilingLightProStatus

    ceilingLightProStatus: deviceStatus & {
        brightness: number;
        colorTemperature: number;
        power: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightProWebhookContext.html b/docs/types/ceilingLightProWebhookContext.html index 34a80505..9bd2bb83 100644 --- a/docs/types/ceilingLightProWebhookContext.html +++ b/docs/types/ceilingLightProWebhookContext.html @@ -1 +1 @@ -ceilingLightProWebhookContext | node-switchbot

    Type Alias ceilingLightProWebhookContext

    ceilingLightProWebhookContext: deviceWebhookContext & {
        brightness: number;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    +ceilingLightProWebhookContext | node-switchbot

    Type Alias ceilingLightProWebhookContext

    ceilingLightProWebhookContext: deviceWebhookContext & {
        brightness: number;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightServiceData.html b/docs/types/ceilingLightServiceData.html index 00a7059d..6e49987b 100644 --- a/docs/types/ceilingLightServiceData.html +++ b/docs/types/ceilingLightServiceData.html @@ -1 +1 @@ -ceilingLightServiceData | node-switchbot

    Type Alias ceilingLightServiceData

    ceilingLightServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: CeilingLight;
        modelFriendlyName: CeilingLight;
        modelName: CeilingLight;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    +ceilingLightServiceData | node-switchbot

    Type Alias ceilingLightServiceData

    ceilingLightServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: CeilingLight;
        modelFriendlyName: CeilingLight;
        modelName: CeilingLight;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightStatus.html b/docs/types/ceilingLightStatus.html index 0be610f9..6a549a73 100644 --- a/docs/types/ceilingLightStatus.html +++ b/docs/types/ceilingLightStatus.html @@ -1 +1 @@ -ceilingLightStatus | node-switchbot

    Type Alias ceilingLightStatus

    ceilingLightStatus: deviceStatus & {
        brightness: number;
        colorTemperature: number;
        power: boolean;
    }

    Settings

    Member Visibility
    +ceilingLightStatus | node-switchbot

    Type Alias ceilingLightStatus

    ceilingLightStatus: deviceStatus & {
        brightness: number;
        colorTemperature: number;
        power: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/ceilingLightWebhookContext.html b/docs/types/ceilingLightWebhookContext.html index 2d8d5b8d..3740b02a 100644 --- a/docs/types/ceilingLightWebhookContext.html +++ b/docs/types/ceilingLightWebhookContext.html @@ -1 +1 @@ -ceilingLightWebhookContext | node-switchbot

    Type Alias ceilingLightWebhookContext

    ceilingLightWebhookContext: deviceWebhookContext & {
        brightness: number;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    +ceilingLightWebhookContext | node-switchbot

    Type Alias ceilingLightWebhookContext

    ceilingLightWebhookContext: deviceWebhookContext & {
        brightness: number;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/circulatorFanStatus.html b/docs/types/circulatorFanStatus.html index f13b0a89..afa58eca 100644 --- a/docs/types/circulatorFanStatus.html +++ b/docs/types/circulatorFanStatus.html @@ -1 +1 @@ -circulatorFanStatus | node-switchbot

    Type Alias circulatorFanStatus

    circulatorFanStatus: deviceStatus & {
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: number;
        oscillation: string;
        power: string;
        version: string;
        verticalOscillation: string;
    }

    Settings

    Member Visibility
    +circulatorFanStatus | node-switchbot

    Type Alias circulatorFanStatus

    circulatorFanStatus: deviceStatus & {
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: number;
        oscillation: string;
        power: string;
        version: string;
        verticalOscillation: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/circulatorFanWebhookContext.html b/docs/types/circulatorFanWebhookContext.html index ee14c8ef..c48c0526 100644 --- a/docs/types/circulatorFanWebhookContext.html +++ b/docs/types/circulatorFanWebhookContext.html @@ -1 +1 @@ -circulatorFanWebhookContext | node-switchbot

    Type Alias circulatorFanWebhookContext

    circulatorFanWebhookContext: deviceWebhookContext & {
        battery: number;
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: "off" | 1 | 2;
        oscillation: "on" | "off";
        powerState: "ON" | "OFF";
        version: string;
        verticalOscillation: "on" | "off";
    }

    Settings

    Member Visibility
    +circulatorFanWebhookContext | node-switchbot

    Type Alias circulatorFanWebhookContext

    circulatorFanWebhookContext: deviceWebhookContext & {
        battery: number;
        fanSpeed: number;
        mode: "direct" | "natural" | "sleep" | "baby";
        nightStatus: "off" | 1 | 2;
        oscillation: "on" | "off";
        powerState: "ON" | "OFF";
        version: string;
        verticalOscillation: "on" | "off";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/colorBulb.html b/docs/types/colorBulb.html index 6dd1a939..65266f88 100644 --- a/docs/types/colorBulb.html +++ b/docs/types/colorBulb.html @@ -1 +1 @@ -colorBulb | node-switchbot

    Type Alias colorBulb

    colorBulb: device & {}

    Settings

    Member Visibility
    +colorBulb | node-switchbot

    Type Alias colorBulb

    colorBulb: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/colorBulbServiceData.html b/docs/types/colorBulbServiceData.html index 8047f060..6e25646b 100644 --- a/docs/types/colorBulbServiceData.html +++ b/docs/types/colorBulbServiceData.html @@ -1 +1 @@ -colorBulbServiceData | node-switchbot

    Type Alias colorBulbServiceData

    colorBulbServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: ColorBulb;
        modelFriendlyName: ColorBulb;
        modelName: ColorBulb;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    +colorBulbServiceData | node-switchbot

    Type Alias colorBulbServiceData

    colorBulbServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        color_temperature: number;
        delay: number;
        green: number;
        loop_index: number;
        model: ColorBulb;
        modelFriendlyName: ColorBulb;
        modelName: ColorBulb;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/colorBulbStatus.html b/docs/types/colorBulbStatus.html index 7e6569f1..cf54b614 100644 --- a/docs/types/colorBulbStatus.html +++ b/docs/types/colorBulbStatus.html @@ -1 +1 @@ -colorBulbStatus | node-switchbot

    Type Alias colorBulbStatus

    colorBulbStatus: deviceStatus & {
        brightness: number;
        color: string;
        colorTemperature: number;
        power: string;
    }

    Settings

    Member Visibility
    +colorBulbStatus | node-switchbot

    Type Alias colorBulbStatus

    colorBulbStatus: deviceStatus & {
        brightness: number;
        color: string;
        colorTemperature: number;
        power: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/colorBulbWebhookContext.html b/docs/types/colorBulbWebhookContext.html index 7a10ff26..bed74f8f 100644 --- a/docs/types/colorBulbWebhookContext.html +++ b/docs/types/colorBulbWebhookContext.html @@ -1 +1 @@ -colorBulbWebhookContext | node-switchbot

    Type Alias colorBulbWebhookContext

    colorBulbWebhookContext: deviceWebhookContext & {
        brightness: number;
        color: string;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    +colorBulbWebhookContext | node-switchbot

    Type Alias colorBulbWebhookContext

    colorBulbWebhookContext: deviceWebhookContext & {
        brightness: number;
        color: string;
        colorTemperature: number;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/contactSensor.html b/docs/types/contactSensor.html index 0146968a..45621b9f 100644 --- a/docs/types/contactSensor.html +++ b/docs/types/contactSensor.html @@ -1 +1 @@ -contactSensor | node-switchbot

    Type Alias contactSensor

    contactSensor: device & {}

    Settings

    Member Visibility
    +contactSensor | node-switchbot

    Type Alias contactSensor

    contactSensor: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/contactSensorServiceData.html b/docs/types/contactSensorServiceData.html index 5e7c0faf..5c277901 100644 --- a/docs/types/contactSensorServiceData.html +++ b/docs/types/contactSensorServiceData.html @@ -1 +1 @@ -contactSensorServiceData | node-switchbot

    Type Alias contactSensorServiceData

    contactSensorServiceData: serviceData & {
        battery: number;
        button_count: number;
        contact_open: boolean;
        contact_timeout: boolean;
        doorState: string;
        lightLevel: string;
        model: ContactSensor;
        modelFriendlyName: ContactSensor;
        modelName: ContactSensor;
        movement: boolean;
        tested: boolean;
    }

    Settings

    Member Visibility
    +contactSensorServiceData | node-switchbot

    Type Alias contactSensorServiceData

    contactSensorServiceData: serviceData & {
        battery: number;
        button_count: number;
        contact_open: boolean;
        contact_timeout: boolean;
        doorState: string;
        lightLevel: string;
        model: ContactSensor;
        modelFriendlyName: ContactSensor;
        modelName: ContactSensor;
        movement: boolean;
        tested: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/contactSensorStatus.html b/docs/types/contactSensorStatus.html index b383b95e..1a772719 100644 --- a/docs/types/contactSensorStatus.html +++ b/docs/types/contactSensorStatus.html @@ -1 +1 @@ -contactSensorStatus | node-switchbot

    Type Alias contactSensorStatus

    contactSensorStatus: deviceStatus & {
        battery: number;
        brightness: "bright" | "dim";
        moveDetected: boolean;
        openState: "open" | "close" | "timeOutNotClose";
    }

    Settings

    Member Visibility
    +contactSensorStatus | node-switchbot

    Type Alias contactSensorStatus

    contactSensorStatus: deviceStatus & {
        battery: number;
        brightness: "bright" | "dim";
        moveDetected: boolean;
        openState: "open" | "close" | "timeOutNotClose";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/contactSensorWebhookContext.html b/docs/types/contactSensorWebhookContext.html index 4d524a37..eba4215f 100644 --- a/docs/types/contactSensorWebhookContext.html +++ b/docs/types/contactSensorWebhookContext.html @@ -1 +1 @@ -contactSensorWebhookContext | node-switchbot

    Type Alias contactSensorWebhookContext

    contactSensorWebhookContext: deviceWebhookContext & {
        battery: number;
        brightness: "dim" | "bright";
        detectionState: "NOT_DETECTED" | "DETECTED";
        doorMode: "IN_DOOR" | "OUT_DOOR";
        openState: "open" | "close" | "timeOutNotClose";
    }

    Settings

    Member Visibility
    +contactSensorWebhookContext | node-switchbot

    Type Alias contactSensorWebhookContext

    contactSensorWebhookContext: deviceWebhookContext & {
        battery: number;
        brightness: "dim" | "bright";
        detectionState: "NOT_DETECTED" | "DETECTED";
        doorMode: "IN_DOOR" | "OUT_DOOR";
        openState: "open" | "close" | "timeOutNotClose";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtain.html b/docs/types/curtain.html index 1f580d7b..c2639afa 100644 --- a/docs/types/curtain.html +++ b/docs/types/curtain.html @@ -1 +1 @@ -curtain | node-switchbot

    Type Alias curtain

    curtain: device & {
        calibrate: boolean;
        curtainDevicesIds: string[];
        group: boolean;
        master: boolean;
        openDirection: string;
    }

    Settings

    Member Visibility
    +curtain | node-switchbot

    Type Alias curtain

    curtain: device & {
        calibrate: boolean;
        curtainDevicesIds: string[];
        group: boolean;
        master: boolean;
        openDirection: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtain3.html b/docs/types/curtain3.html index 7ce97dc6..efba7553 100644 --- a/docs/types/curtain3.html +++ b/docs/types/curtain3.html @@ -1 +1 @@ -curtain3 | node-switchbot

    Type Alias curtain3

    curtain3: device & {
        calibrate: boolean;
        curtainDevicesIds: string[];
        group: boolean;
        master: boolean;
        openDirection?: string;
    }

    Settings

    Member Visibility
    +curtain3 | node-switchbot

    Type Alias curtain3

    curtain3: device & {
        calibrate: boolean;
        curtainDevicesIds: string[];
        group: boolean;
        master: boolean;
        openDirection?: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtain3ServiceData.html b/docs/types/curtain3ServiceData.html index 59179bd3..0c344724 100644 --- a/docs/types/curtain3ServiceData.html +++ b/docs/types/curtain3ServiceData.html @@ -1 +1 @@ -curtain3ServiceData | node-switchbot

    Type Alias curtain3ServiceData

    curtain3ServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        deviceChain: number;
        inMotion: boolean;
        lightLevel: number;
        model: Curtain3;
        modelFriendlyName: Curtain3;
        modelName: Curtain3;
        position: number;
    }

    Settings

    Member Visibility
    +curtain3ServiceData | node-switchbot

    Type Alias curtain3ServiceData

    curtain3ServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        deviceChain: number;
        inMotion: boolean;
        lightLevel: number;
        model: Curtain3;
        modelFriendlyName: Curtain3;
        modelName: Curtain3;
        position: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtain3WebhookContext.html b/docs/types/curtain3WebhookContext.html index a3fb3c8c..73c9406f 100644 --- a/docs/types/curtain3WebhookContext.html +++ b/docs/types/curtain3WebhookContext.html @@ -1 +1 @@ -curtain3WebhookContext | node-switchbot

    Type Alias curtain3WebhookContext

    curtain3WebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    +curtain3WebhookContext | node-switchbot

    Type Alias curtain3WebhookContext

    curtain3WebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtainServiceData.html b/docs/types/curtainServiceData.html index 761e86c3..df0e5b13 100644 --- a/docs/types/curtainServiceData.html +++ b/docs/types/curtainServiceData.html @@ -1 +1 @@ -curtainServiceData | node-switchbot

    Type Alias curtainServiceData

    curtainServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        deviceChain: number;
        inMotion: boolean;
        lightLevel: number;
        model: Curtain;
        modelFriendlyName: Curtain;
        modelName: Curtain;
        position: number;
    }

    Settings

    Member Visibility
    +curtainServiceData | node-switchbot

    Type Alias curtainServiceData

    curtainServiceData: serviceData & {
        battery: number;
        calibration: boolean;
        deviceChain: number;
        inMotion: boolean;
        lightLevel: number;
        model: Curtain;
        modelFriendlyName: Curtain;
        modelName: Curtain;
        position: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtainStatus.html b/docs/types/curtainStatus.html index c6978367..6f42acc6 100644 --- a/docs/types/curtainStatus.html +++ b/docs/types/curtainStatus.html @@ -1 +1 @@ -curtainStatus | node-switchbot

    Type Alias curtainStatus

    curtainStatus: deviceStatus & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        lightLevel?: "bright" | "dim";
        moving: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    +curtainStatus | node-switchbot

    Type Alias curtainStatus

    curtainStatus: deviceStatus & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        lightLevel?: "bright" | "dim";
        moving: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/curtainWebhookContext.html b/docs/types/curtainWebhookContext.html index 450ce87c..a8214c90 100644 --- a/docs/types/curtainWebhookContext.html +++ b/docs/types/curtainWebhookContext.html @@ -1 +1 @@ -curtainWebhookContext | node-switchbot

    Type Alias curtainWebhookContext

    curtainWebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    +curtainWebhookContext | node-switchbot

    Type Alias curtainWebhookContext

    curtainWebhookContext: deviceWebhookContext & {
        battery: number;
        calibrate: boolean;
        group: boolean;
        slidePosition: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/floorCleaningRobotS10.html b/docs/types/floorCleaningRobotS10.html index a4109741..32d5c86a 100644 --- a/docs/types/floorCleaningRobotS10.html +++ b/docs/types/floorCleaningRobotS10.html @@ -1 +1 @@ -floorCleaningRobotS10 | node-switchbot

    Type Alias floorCleaningRobotS10

    floorCleaningRobotS10: device & {}

    Settings

    Member Visibility
    +floorCleaningRobotS10 | node-switchbot

    Type Alias floorCleaningRobotS10

    floorCleaningRobotS10: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/floorCleaningRobotS10Status.html b/docs/types/floorCleaningRobotS10Status.html index 367af4d2..2e5f6563 100644 --- a/docs/types/floorCleaningRobotS10Status.html +++ b/docs/types/floorCleaningRobotS10Status.html @@ -1 +1 @@ -floorCleaningRobotS10Status | node-switchbot

    Type Alias floorCleaningRobotS10Status

    floorCleaningRobotS10Status: deviceStatus & {
        battery: number;
        onlineStatus: string;
        taskType: string;
        waterBaseBattery: number;
        workingStatus: string;
    }

    Settings

    Member Visibility
    +floorCleaningRobotS10Status | node-switchbot

    Type Alias floorCleaningRobotS10Status

    floorCleaningRobotS10Status: deviceStatus & {
        battery: number;
        onlineStatus: string;
        taskType: string;
        waterBaseBattery: number;
        workingStatus: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/floorCleaningRobotS10WebhookContext.html b/docs/types/floorCleaningRobotS10WebhookContext.html index ff387ccb..1b1e7c75 100644 --- a/docs/types/floorCleaningRobotS10WebhookContext.html +++ b/docs/types/floorCleaningRobotS10WebhookContext.html @@ -1 +1 @@ -floorCleaningRobotS10WebhookContext | node-switchbot

    Type Alias floorCleaningRobotS10WebhookContext

    floorCleaningRobotS10WebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        taskType:
            | "standBy"
            | "explore"
            | "cleanAll"
            | "cleanArea"
            | "cleanRoom"
            | "fillWater"
            | "deepWashing"
            | "backToCharge"
            | "markingWaterBase"
            | "drying"
            | "collectDust"
            | "remoteControl"
            | "cleanWithExplorer"
            | "fillWaterForHumi"
            | "markingHumi";
        waterBaseBattery: number;
        workingStatus: | "Standby"
        | "Clearing"
        | "Paused"
        | "GotoChargeBase"
        | "Charging"
        | "ChargeDone"
        | "Dormant"
        | "InTrouble"
        | "InRemoteControl"
        | "InDustCollecting";
    }

    Settings

    Member Visibility
    +floorCleaningRobotS10WebhookContext | node-switchbot

    Type Alias floorCleaningRobotS10WebhookContext

    floorCleaningRobotS10WebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        taskType:
            | "standBy"
            | "explore"
            | "cleanAll"
            | "cleanArea"
            | "cleanRoom"
            | "fillWater"
            | "deepWashing"
            | "backToCharge"
            | "markingWaterBase"
            | "drying"
            | "collectDust"
            | "remoteControl"
            | "cleanWithExplorer"
            | "fillWaterForHumi"
            | "markingHumi";
        waterBaseBattery: number;
        workingStatus: | "Standby"
        | "Clearing"
        | "Paused"
        | "GotoChargeBase"
        | "Charging"
        | "ChargeDone"
        | "Dormant"
        | "InTrouble"
        | "InRemoteControl"
        | "InDustCollecting";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/hub2.html b/docs/types/hub2.html index f92e863b..9f0e6a88 100644 --- a/docs/types/hub2.html +++ b/docs/types/hub2.html @@ -1 +1 @@ -hub2 | node-switchbot

    Type Alias hub2

    hub2: device & {}

    Settings

    Member Visibility
    +hub2 | node-switchbot

    Type Alias hub2

    hub2: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/hub2ServiceData.html b/docs/types/hub2ServiceData.html index cf825fe3..c3c56591 100644 --- a/docs/types/hub2ServiceData.html +++ b/docs/types/hub2ServiceData.html @@ -1 +1 @@ -hub2ServiceData | node-switchbot

    Type Alias hub2ServiceData

    hub2ServiceData: serviceData & {
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        lightLevel: number;
        model: Hub2;
        modelFriendlyName: Hub2;
        modelName: Hub2;
    }

    Settings

    Member Visibility
    +hub2ServiceData | node-switchbot

    Type Alias hub2ServiceData

    hub2ServiceData: serviceData & {
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        lightLevel: number;
        model: Hub2;
        modelFriendlyName: Hub2;
        modelName: Hub2;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/hub2Status.html b/docs/types/hub2Status.html index 771c63ce..1f95e6ff 100644 --- a/docs/types/hub2Status.html +++ b/docs/types/hub2Status.html @@ -1 +1 @@ -hub2Status | node-switchbot

    Type Alias hub2Status

    hub2Status: deviceStatus & {
        humidity: number;
        lightLevel: number;
        temperature: number;
    }

    Settings

    Member Visibility
    +hub2Status | node-switchbot

    Type Alias hub2Status

    hub2Status: deviceStatus & {
        humidity: number;
        lightLevel: number;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/hub2WebhookContext.html b/docs/types/hub2WebhookContext.html index 3ffcff4b..8a2476c8 100644 --- a/docs/types/hub2WebhookContext.html +++ b/docs/types/hub2WebhookContext.html @@ -1 +1 @@ -hub2WebhookContext | node-switchbot

    Type Alias hub2WebhookContext

    hub2WebhookContext: deviceWebhookContext & {
        humidity: number;
        lightLevel: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +hub2WebhookContext | node-switchbot

    Type Alias hub2WebhookContext

    hub2WebhookContext: deviceWebhookContext & {
        humidity: number;
        lightLevel: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifier.html b/docs/types/humidifier.html index 7df5b408..339ee067 100644 --- a/docs/types/humidifier.html +++ b/docs/types/humidifier.html @@ -1 +1 @@ -humidifier | node-switchbot

    Type Alias humidifier

    humidifier: device & {}

    Settings

    Member Visibility
    +humidifier | node-switchbot

    Type Alias humidifier

    humidifier: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/humidifier2ServiceData.html b/docs/types/humidifier2ServiceData.html index 70e01fb0..3ff3c5da 100644 --- a/docs/types/humidifier2ServiceData.html +++ b/docs/types/humidifier2ServiceData.html @@ -1 +1 @@ -humidifier2ServiceData | node-switchbot

    Type Alias humidifier2ServiceData

    humidifier2ServiceData: serviceData & {
        autoMode: boolean;
        childLock: boolean;
        filterAlert: boolean;
        filterMissing: boolean;
        filterRunTime: number;
        humidity: number;
        model: Humidifier2;
        modelFriendlyName: Humidifier2;
        modelName: Humidifier2;
        onState: boolean;
        overHumidifyProtection: boolean;
        percentage: number;
        tankRemoved: boolean;
        temperature: number;
        tiltedAlert: boolean;
        waterLevel: number;
    }

    Settings

    Member Visibility
    +humidifier2ServiceData | node-switchbot

    Type Alias humidifier2ServiceData

    humidifier2ServiceData: serviceData & {
        autoMode: boolean;
        childLock: boolean;
        filterAlert: boolean;
        filterMissing: boolean;
        filterRunTime: number;
        humidity: number;
        model: Humidifier2;
        modelFriendlyName: Humidifier2;
        modelName: Humidifier2;
        onState: boolean;
        overHumidifyProtection: boolean;
        percentage: number;
        tankRemoved: boolean;
        temperature: number;
        tiltedAlert: boolean;
        waterLevel: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifier2Status.html b/docs/types/humidifier2Status.html index 6c13bce4..0c23323a 100644 --- a/docs/types/humidifier2Status.html +++ b/docs/types/humidifier2Status.html @@ -1 +1 @@ -humidifier2Status | node-switchbot

    Type Alias humidifier2Status

    humidifier2Status: deviceStatus & {
        auto: boolean;
        childLock: boolean;
        humidity: number;
        lackWater: boolean;
        nebulizationEfficiency: number;
        power: string;
        sound: boolean;
        temperature: number;
    }

    Settings

    Member Visibility
    +humidifier2Status | node-switchbot

    Type Alias humidifier2Status

    humidifier2Status: deviceStatus & {
        auto: boolean;
        childLock: boolean;
        humidity: number;
        lackWater: boolean;
        nebulizationEfficiency: number;
        power: string;
        sound: boolean;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifier2WebhookContext.html b/docs/types/humidifier2WebhookContext.html index 6420ad6a..6e50b557 100644 --- a/docs/types/humidifier2WebhookContext.html +++ b/docs/types/humidifier2WebhookContext.html @@ -1 +1 @@ -humidifier2WebhookContext | node-switchbot

    Type Alias humidifier2WebhookContext

    humidifier2WebhookContext: deviceWebhookContext & {
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +humidifier2WebhookContext | node-switchbot

    Type Alias humidifier2WebhookContext

    humidifier2WebhookContext: deviceWebhookContext & {
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifierServiceData.html b/docs/types/humidifierServiceData.html index 0c3b28a7..cc2afa74 100644 --- a/docs/types/humidifierServiceData.html +++ b/docs/types/humidifierServiceData.html @@ -1 +1 @@ -humidifierServiceData | node-switchbot

    Type Alias humidifierServiceData

    humidifierServiceData: serviceData & {
        autoMode: boolean;
        humidity: number;
        model: Humidifier;
        modelFriendlyName: Humidifier;
        modelName: Humidifier;
        onState: boolean;
        percentage: number;
    }

    Settings

    Member Visibility
    +humidifierServiceData | node-switchbot

    Type Alias humidifierServiceData

    humidifierServiceData: serviceData & {
        autoMode: boolean;
        humidity: number;
        model: Humidifier;
        modelFriendlyName: Humidifier;
        modelName: Humidifier;
        onState: boolean;
        percentage: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifierStatus.html b/docs/types/humidifierStatus.html index d212b8e5..faeb673f 100644 --- a/docs/types/humidifierStatus.html +++ b/docs/types/humidifierStatus.html @@ -1 +1 @@ -humidifierStatus | node-switchbot

    Type Alias humidifierStatus

    humidifierStatus: deviceStatus & {
        auto: boolean;
        childLock: boolean;
        humidity: number;
        lackWater: boolean;
        nebulizationEfficiency: number;
        power: string;
        sound: boolean;
        temperature: number;
    }

    Settings

    Member Visibility
    +humidifierStatus | node-switchbot

    Type Alias humidifierStatus

    humidifierStatus: deviceStatus & {
        auto: boolean;
        childLock: boolean;
        humidity: number;
        lackWater: boolean;
        nebulizationEfficiency: number;
        power: string;
        sound: boolean;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/humidifierWebhookContext.html b/docs/types/humidifierWebhookContext.html index 4fc42001..dd71481e 100644 --- a/docs/types/humidifierWebhookContext.html +++ b/docs/types/humidifierWebhookContext.html @@ -1 +1 @@ -humidifierWebhookContext | node-switchbot

    Type Alias humidifierWebhookContext

    humidifierWebhookContext: deviceWebhookContext & {
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +humidifierWebhookContext | node-switchbot

    Type Alias humidifierWebhookContext

    humidifierWebhookContext: deviceWebhookContext & {
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/indoorCam.html b/docs/types/indoorCam.html index 00bcc597..3a34af8b 100644 --- a/docs/types/indoorCam.html +++ b/docs/types/indoorCam.html @@ -1 +1 @@ -indoorCam | node-switchbot

    Type Alias indoorCam

    indoorCam: device & {}

    Settings

    Member Visibility
    +indoorCam | node-switchbot

    Type Alias indoorCam

    indoorCam: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/indoorCameraWebhookContext.html b/docs/types/indoorCameraWebhookContext.html index 089306a8..c5b49c3b 100644 --- a/docs/types/indoorCameraWebhookContext.html +++ b/docs/types/indoorCameraWebhookContext.html @@ -1 +1 @@ -indoorCameraWebhookContext | node-switchbot

    Type Alias indoorCameraWebhookContext

    indoorCameraWebhookContext: deviceWebhookContext & {
        detectionState: "DETECTED";
    }

    Settings

    Member Visibility
    +indoorCameraWebhookContext | node-switchbot

    Type Alias indoorCameraWebhookContext

    indoorCameraWebhookContext: deviceWebhookContext & {
        detectionState: "DETECTED";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/keypad.html b/docs/types/keypad.html index 36cfba60..e46c1a60 100644 --- a/docs/types/keypad.html +++ b/docs/types/keypad.html @@ -1 +1 @@ -keypad | node-switchbot

    Type Alias keypad

    keypad: device & { keyList: keyList; lockDeviceId: string; remoteType: string }

    Settings

    Member Visibility
    +keypad | node-switchbot

    Type Alias keypad

    keypad: device & { keyList: keyList; lockDeviceId: string; remoteType: string }

    Settings

    Member Visibility
    diff --git a/docs/types/keypadDetectorServiceData.html b/docs/types/keypadDetectorServiceData.html index 8795050b..d77328bf 100644 --- a/docs/types/keypadDetectorServiceData.html +++ b/docs/types/keypadDetectorServiceData.html @@ -1 +1 @@ -keypadDetectorServiceData | node-switchbot

    Type Alias keypadDetectorServiceData

    keypadDetectorServiceData: serviceData & {
        battery: number;
        event: boolean;
        low_battery: boolean;
        model: Keypad;
        modelFriendlyName: Keypad;
        modelName: Keypad;
        tampered: boolean;
    }

    Settings

    Member Visibility
    +keypadDetectorServiceData | node-switchbot

    Type Alias keypadDetectorServiceData

    keypadDetectorServiceData: serviceData & {
        battery: number;
        event: boolean;
        low_battery: boolean;
        model: Keypad;
        modelFriendlyName: Keypad;
        modelName: Keypad;
        tampered: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/keypadTouch.html b/docs/types/keypadTouch.html index 070a9667..b2d39879 100644 --- a/docs/types/keypadTouch.html +++ b/docs/types/keypadTouch.html @@ -1 +1 @@ -keypadTouch | node-switchbot

    Type Alias keypadTouch

    keypadTouch: device & {
        keyList: keyList;
        lockDeviceId: string;
        remoteType: string;
    }

    Settings

    Member Visibility
    +keypadTouch | node-switchbot

    Type Alias keypadTouch

    keypadTouch: device & {
        keyList: keyList;
        lockDeviceId: string;
        remoteType: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/keypadTouchWebhookContext.html b/docs/types/keypadTouchWebhookContext.html index 16cc0bd7..106bf1fd 100644 --- a/docs/types/keypadTouchWebhookContext.html +++ b/docs/types/keypadTouchWebhookContext.html @@ -1 +1 @@ -keypadTouchWebhookContext | node-switchbot

    Type Alias keypadTouchWebhookContext

    keypadTouchWebhookContext: deviceWebhookContext & {
        commandId: string;
        eventName: "createKey" | "deleteKey";
        result: "success" | "failed" | "timeout";
    }

    Settings

    Member Visibility
    +keypadTouchWebhookContext | node-switchbot

    Type Alias keypadTouchWebhookContext

    keypadTouchWebhookContext: deviceWebhookContext & {
        commandId: string;
        eventName: "createKey" | "deleteKey";
        result: "success" | "failed" | "timeout";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/keypadWebhookContext.html b/docs/types/keypadWebhookContext.html index d9740a3f..714cdb35 100644 --- a/docs/types/keypadWebhookContext.html +++ b/docs/types/keypadWebhookContext.html @@ -1 +1 @@ -keypadWebhookContext | node-switchbot

    Type Alias keypadWebhookContext

    keypadWebhookContext: deviceWebhookContext & {
        commandId: string;
        eventName: "createKey" | "deleteKey";
        result: "success" | "failed" | "timeout";
    }

    Settings

    Member Visibility
    +keypadWebhookContext | node-switchbot

    Type Alias keypadWebhookContext

    keypadWebhookContext: deviceWebhookContext & {
        commandId: string;
        eventName: "createKey" | "deleteKey";
        result: "success" | "failed" | "timeout";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lock.html b/docs/types/lock.html index db8ca056..ce823e58 100644 --- a/docs/types/lock.html +++ b/docs/types/lock.html @@ -1 +1 @@ -lock | node-switchbot

    Type Alias lock

    lock: device & {
        group: boolean;
        groupName: string;
        lockDevicesIds: string[];
        master: boolean;
    }

    Settings

    Member Visibility
    +lock | node-switchbot

    Type Alias lock

    lock: device & {
        group: boolean;
        groupName: string;
        lockDevicesIds: string[];
        master: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockPro.html b/docs/types/lockPro.html index a5a0ff95..c7c53d19 100644 --- a/docs/types/lockPro.html +++ b/docs/types/lockPro.html @@ -1 +1 @@ -lockPro | node-switchbot

    Type Alias lockPro

    lockPro: device & {
        group: boolean;
        groupName: string;
        lockDevicesIds: string[];
        master: boolean;
    }

    Settings

    Member Visibility
    +lockPro | node-switchbot

    Type Alias lockPro

    lockPro: device & {
        group: boolean;
        groupName: string;
        lockDevicesIds: string[];
        master: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockProServiceData.html b/docs/types/lockProServiceData.html index 6f1a6190..52186c1a 100644 --- a/docs/types/lockProServiceData.html +++ b/docs/types/lockProServiceData.html @@ -1 +1 @@ -lockProServiceData | node-switchbot

    Type Alias lockProServiceData

    lockProServiceData: serviceData & {
        auto_lock_paused: boolean;
        battery: number;
        calibration: boolean;
        door_open: boolean;
        double_lock_mode: boolean;
        model: LockPro;
        modelFriendlyName: LockPro;
        modelName: LockPro;
        night_latch: boolean;
        status: string;
        unclosed_alarm: boolean;
        unlocked_alarm: boolean;
        update_from_secondary_lock: boolean;
    }

    Settings

    Member Visibility
    +lockProServiceData | node-switchbot

    Type Alias lockProServiceData

    lockProServiceData: serviceData & {
        auto_lock_paused: boolean;
        battery: number;
        calibration: boolean;
        door_open: boolean;
        double_lock_mode: boolean;
        model: LockPro;
        modelFriendlyName: LockPro;
        modelName: LockPro;
        night_latch: boolean;
        status: string;
        unclosed_alarm: boolean;
        unlocked_alarm: boolean;
        update_from_secondary_lock: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockProStatus.html b/docs/types/lockProStatus.html index 171ae5e7..50d930bd 100644 --- a/docs/types/lockProStatus.html +++ b/docs/types/lockProStatus.html @@ -1 +1 @@ -lockProStatus | node-switchbot

    Type Alias lockProStatus

    lockProStatus: deviceStatus & {
        battery: number;
        doorState: string;
        lockState: string;
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    +lockProStatus | node-switchbot

    Type Alias lockProStatus

    lockProStatus: deviceStatus & {
        battery: number;
        doorState: string;
        lockState: string;
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockProWebhookContext.html b/docs/types/lockProWebhookContext.html index dad5e44e..32981e85 100644 --- a/docs/types/lockProWebhookContext.html +++ b/docs/types/lockProWebhookContext.html @@ -1 +1 @@ -lockProWebhookContext | node-switchbot

    Type Alias lockProWebhookContext

    lockProWebhookContext: deviceWebhookContext & {
        battery: number;
        lockState: "UNLOCKED" | "LOCKED" | "JAMMED";
    }

    Settings

    Member Visibility
    +lockProWebhookContext | node-switchbot

    Type Alias lockProWebhookContext

    lockProWebhookContext: deviceWebhookContext & {
        battery: number;
        lockState: "UNLOCKED" | "LOCKED" | "JAMMED";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockServiceData.html b/docs/types/lockServiceData.html index 9db98bfb..49564b89 100644 --- a/docs/types/lockServiceData.html +++ b/docs/types/lockServiceData.html @@ -1 +1 @@ -lockServiceData | node-switchbot

    Type Alias lockServiceData

    lockServiceData: serviceData & {
        auto_lock_paused: boolean;
        battery: number;
        calibration: boolean;
        door_open: boolean;
        double_lock_mode: boolean;
        model: Lock;
        modelFriendlyName: Lock;
        modelName: Lock;
        night_latch: boolean;
        status: string;
        unclosed_alarm: boolean;
        unlocked_alarm: boolean;
        update_from_secondary_lock: boolean;
    }

    Settings

    Member Visibility
    +lockServiceData | node-switchbot

    Type Alias lockServiceData

    lockServiceData: serviceData & {
        auto_lock_paused: boolean;
        battery: number;
        calibration: boolean;
        door_open: boolean;
        double_lock_mode: boolean;
        model: Lock;
        modelFriendlyName: Lock;
        modelName: Lock;
        night_latch: boolean;
        status: string;
        unclosed_alarm: boolean;
        unlocked_alarm: boolean;
        update_from_secondary_lock: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockStatus.html b/docs/types/lockStatus.html index d274b3f3..6213cfe0 100644 --- a/docs/types/lockStatus.html +++ b/docs/types/lockStatus.html @@ -1 +1 @@ -lockStatus | node-switchbot

    Type Alias lockStatus

    lockStatus: deviceStatus & {
        battery: number;
        doorState: string;
        lockState: string;
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    +lockStatus | node-switchbot

    Type Alias lockStatus

    lockStatus: deviceStatus & {
        battery: number;
        doorState: string;
        lockState: string;
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/lockWebhookContext.html b/docs/types/lockWebhookContext.html index cd91c37e..88c98eb8 100644 --- a/docs/types/lockWebhookContext.html +++ b/docs/types/lockWebhookContext.html @@ -1 +1 @@ -lockWebhookContext | node-switchbot

    Type Alias lockWebhookContext

    lockWebhookContext: deviceWebhookContext & {
        battery: number;
        lockState: "UNLOCKED" | "LOCKED" | "JAMMED";
    }

    Settings

    Member Visibility
    +lockWebhookContext | node-switchbot

    Type Alias lockWebhookContext

    lockWebhookContext: deviceWebhookContext & {
        battery: number;
        lockState: "UNLOCKED" | "LOCKED" | "JAMMED";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meter.html b/docs/types/meter.html index d4988467..f45aaf81 100644 --- a/docs/types/meter.html +++ b/docs/types/meter.html @@ -1 +1 @@ -meter | node-switchbot

    Type Alias meter

    meter: device & {}

    Settings

    Member Visibility
    +meter | node-switchbot

    Type Alias meter

    meter: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/meterPlus.html b/docs/types/meterPlus.html index 6322eed8..b9ea1a3d 100644 --- a/docs/types/meterPlus.html +++ b/docs/types/meterPlus.html @@ -1 +1 @@ -meterPlus | node-switchbot

    Type Alias meterPlus

    meterPlus: device & {}

    Settings

    Member Visibility
    +meterPlus | node-switchbot

    Type Alias meterPlus

    meterPlus: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/meterPlusServiceData.html b/docs/types/meterPlusServiceData.html index a2b78cf4..a40acf36 100644 --- a/docs/types/meterPlusServiceData.html +++ b/docs/types/meterPlusServiceData.html @@ -1 +1 @@ -meterPlusServiceData | node-switchbot

    Type Alias meterPlusServiceData

    meterPlusServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterPlus;
        modelFriendlyName: MeterPlus;
        modelName: MeterPlus;
    }

    Settings

    Member Visibility
    +meterPlusServiceData | node-switchbot

    Type Alias meterPlusServiceData

    meterPlusServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterPlus;
        modelFriendlyName: MeterPlus;
        modelName: MeterPlus;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterPlusStatus.html b/docs/types/meterPlusStatus.html index 29868514..d7c18539 100644 --- a/docs/types/meterPlusStatus.html +++ b/docs/types/meterPlusStatus.html @@ -1 +1 @@ -meterPlusStatus | node-switchbot

    Type Alias meterPlusStatus

    meterPlusStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    +meterPlusStatus | node-switchbot

    Type Alias meterPlusStatus

    meterPlusStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterPlusWebhookContext.html b/docs/types/meterPlusWebhookContext.html index 65738aa4..94e2d395 100644 --- a/docs/types/meterPlusWebhookContext.html +++ b/docs/types/meterPlusWebhookContext.html @@ -1 +1 @@ -meterPlusWebhookContext | node-switchbot

    Type Alias meterPlusWebhookContext

    meterPlusWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +meterPlusWebhookContext | node-switchbot

    Type Alias meterPlusWebhookContext

    meterPlusWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterPro.html b/docs/types/meterPro.html index 0cd5a233..4426facd 100644 --- a/docs/types/meterPro.html +++ b/docs/types/meterPro.html @@ -1 +1 @@ -meterPro | node-switchbot

    Type Alias meterPro

    meterPro: device & {}

    Settings

    Member Visibility
    +meterPro | node-switchbot

    Type Alias meterPro

    meterPro: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/meterProCO2ServiceData.html b/docs/types/meterProCO2ServiceData.html index 7e604f15..3cfafe10 100644 --- a/docs/types/meterProCO2ServiceData.html +++ b/docs/types/meterProCO2ServiceData.html @@ -1 +1 @@ -meterProCO2ServiceData | node-switchbot

    Type Alias meterProCO2ServiceData

    meterProCO2ServiceData: serviceData & {
        battery: number;
        celsius: number;
        co2: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterProCO2;
        modelFriendlyName: MeterProCO2;
        modelName: MeterProCO2;
    }

    Settings

    Member Visibility
    +meterProCO2ServiceData | node-switchbot

    Type Alias meterProCO2ServiceData

    meterProCO2ServiceData: serviceData & {
        battery: number;
        celsius: number;
        co2: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterProCO2;
        modelFriendlyName: MeterProCO2;
        modelName: MeterProCO2;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterProCO2Status.html b/docs/types/meterProCO2Status.html index eccf9199..c597e912 100644 --- a/docs/types/meterProCO2Status.html +++ b/docs/types/meterProCO2Status.html @@ -1 +1 @@ -meterProCO2Status | node-switchbot

    Type Alias meterProCO2Status

    meterProCO2Status: deviceStatus & {
        battery: number;
        CO2: number;
        humidity: number;
        temperature: number;
        version: string;
    }

    Settings

    Member Visibility
    +meterProCO2Status | node-switchbot

    Type Alias meterProCO2Status

    meterProCO2Status: deviceStatus & {
        battery: number;
        CO2: number;
        humidity: number;
        temperature: number;
        version: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterProCO2WebhookContext.html b/docs/types/meterProCO2WebhookContext.html index 86533f42..3bc38cae 100644 --- a/docs/types/meterProCO2WebhookContext.html +++ b/docs/types/meterProCO2WebhookContext.html @@ -1 +1 @@ -meterProCO2WebhookContext | node-switchbot

    Type Alias meterProCO2WebhookContext

    meterProCO2WebhookContext: deviceWebhookContext & {
        battery: number;
        CO2: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +meterProCO2WebhookContext | node-switchbot

    Type Alias meterProCO2WebhookContext

    meterProCO2WebhookContext: deviceWebhookContext & {
        battery: number;
        CO2: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterProServiceData.html b/docs/types/meterProServiceData.html index baad410f..ff05e568 100644 --- a/docs/types/meterProServiceData.html +++ b/docs/types/meterProServiceData.html @@ -1 +1 @@ -meterProServiceData | node-switchbot

    Type Alias meterProServiceData

    meterProServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterPro;
        modelFriendlyName: MeterPro;
        modelName: MeterPro;
    }

    Settings

    Member Visibility
    +meterProServiceData | node-switchbot

    Type Alias meterProServiceData

    meterProServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: MeterPro;
        modelFriendlyName: MeterPro;
        modelName: MeterPro;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterProStatus.html b/docs/types/meterProStatus.html index dca04400..b7e08b50 100644 --- a/docs/types/meterProStatus.html +++ b/docs/types/meterProStatus.html @@ -1 +1 @@ -meterProStatus | node-switchbot

    Type Alias meterProStatus

    meterProStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
        version: string;
    }

    Settings

    Member Visibility
    +meterProStatus | node-switchbot

    Type Alias meterProStatus

    meterProStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
        version: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterProWebhookContext.html b/docs/types/meterProWebhookContext.html index 49412a79..170bdbc7 100644 --- a/docs/types/meterProWebhookContext.html +++ b/docs/types/meterProWebhookContext.html @@ -1 +1 @@ -meterProWebhookContext | node-switchbot

    Type Alias meterProWebhookContext

    meterProWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +meterProWebhookContext | node-switchbot

    Type Alias meterProWebhookContext

    meterProWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterServiceData.html b/docs/types/meterServiceData.html index 33d87bd2..16d6730e 100644 --- a/docs/types/meterServiceData.html +++ b/docs/types/meterServiceData.html @@ -1 +1 @@ -meterServiceData | node-switchbot

    Type Alias meterServiceData

    meterServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: Meter;
        modelFriendlyName: Meter;
        modelName: Meter;
    }

    Settings

    Member Visibility
    +meterServiceData | node-switchbot

    Type Alias meterServiceData

    meterServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: Meter;
        modelFriendlyName: Meter;
        modelName: Meter;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterStatus.html b/docs/types/meterStatus.html index 0e5c6d34..4979528f 100644 --- a/docs/types/meterStatus.html +++ b/docs/types/meterStatus.html @@ -1 +1 @@ -meterStatus | node-switchbot

    Type Alias meterStatus

    meterStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    +meterStatus | node-switchbot

    Type Alias meterStatus

    meterStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/meterWebhookContext.html b/docs/types/meterWebhookContext.html index 7b75dd97..e0b9a57c 100644 --- a/docs/types/meterWebhookContext.html +++ b/docs/types/meterWebhookContext.html @@ -1 +1 @@ -meterWebhookContext | node-switchbot

    Type Alias meterWebhookContext

    meterWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +meterWebhookContext | node-switchbot

    Type Alias meterWebhookContext

    meterWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/motionSensor.html b/docs/types/motionSensor.html index 5ac30d55..fa3b4efe 100644 --- a/docs/types/motionSensor.html +++ b/docs/types/motionSensor.html @@ -1 +1 @@ -motionSensor | node-switchbot

    Type Alias motionSensor

    motionSensor: device & {}

    Settings

    Member Visibility
    +motionSensor | node-switchbot

    Type Alias motionSensor

    motionSensor: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/motionSensorServiceData.html b/docs/types/motionSensorServiceData.html index df8f35fb..ef820690 100644 --- a/docs/types/motionSensorServiceData.html +++ b/docs/types/motionSensorServiceData.html @@ -1 +1 @@ -motionSensorServiceData | node-switchbot

    Type Alias motionSensorServiceData

    motionSensorServiceData: serviceData & {
        battery: number;
        iot: number;
        is_light: boolean;
        led: number;
        lightLevel: string;
        model: MotionSensor;
        modelFriendlyName: MotionSensor;
        modelName: MotionSensor;
        movement: boolean;
        sense_distance: number;
        tested: boolean;
    }

    Settings

    Member Visibility
    +motionSensorServiceData | node-switchbot

    Type Alias motionSensorServiceData

    motionSensorServiceData: serviceData & {
        battery: number;
        iot: number;
        is_light: boolean;
        led: number;
        lightLevel: string;
        model: MotionSensor;
        modelFriendlyName: MotionSensor;
        modelName: MotionSensor;
        movement: boolean;
        sense_distance: number;
        tested: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/motionSensorStatus.html b/docs/types/motionSensorStatus.html index 782b4826..9078cbdd 100644 --- a/docs/types/motionSensorStatus.html +++ b/docs/types/motionSensorStatus.html @@ -1 +1 @@ -motionSensorStatus | node-switchbot

    Type Alias motionSensorStatus

    motionSensorStatus: deviceStatus & {
        battery: number;
        brightness: "bright" | "dim";
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    +motionSensorStatus | node-switchbot

    Type Alias motionSensorStatus

    motionSensorStatus: deviceStatus & {
        battery: number;
        brightness: "bright" | "dim";
        moveDetected: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/motionSensorWebhookContext.html b/docs/types/motionSensorWebhookContext.html index 054dccfb..b08e2221 100644 --- a/docs/types/motionSensorWebhookContext.html +++ b/docs/types/motionSensorWebhookContext.html @@ -1 +1 @@ -motionSensorWebhookContext | node-switchbot

    Type Alias motionSensorWebhookContext

    motionSensorWebhookContext: deviceWebhookContext & {
        battery: number;
        detectionState: "NOT_DETECTED" | "DETECTED";
    }

    Settings

    Member Visibility
    +motionSensorWebhookContext | node-switchbot

    Type Alias motionSensorWebhookContext

    motionSensorWebhookContext: deviceWebhookContext & {
        battery: number;
        detectionState: "NOT_DETECTED" | "DETECTED";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/onadvertisement.html b/docs/types/onadvertisement.html index a3c187e0..1414376d 100644 --- a/docs/types/onadvertisement.html +++ b/docs/types/onadvertisement.html @@ -1 +1 @@ -onadvertisement | node-switchbot

    Type Alias onadvertisement

    onadvertisement: (ad: ad) => Promise<void> | void

    Type declaration

      • (ad: ad): Promise<void> | void

      • Parameters

        Returns Promise<void> | void

    Settings

    Member Visibility
    +onadvertisement | node-switchbot

    Type Alias onadvertisement

    onadvertisement: (ad: ad) => Promise<void> | void

    Type declaration

      • (ad: ad): Promise<void> | void

      • Parameters

        Returns Promise<void> | void

    Settings

    Member Visibility
    diff --git a/docs/types/ondiscover.html b/docs/types/ondiscover.html index 6424a520..fb212b01 100644 --- a/docs/types/ondiscover.html +++ b/docs/types/ondiscover.html @@ -1 +1 @@ -ondiscover | node-switchbot

    Type Alias ondiscover

    ondiscover: (device: SwitchbotDevice) => Promise<void> | void

    Type declaration

    Settings

    Member Visibility
    +ondiscover | node-switchbot

    Type Alias ondiscover

    ondiscover: (device: SwitchbotDevice) => Promise<void> | void

    Type declaration

    Settings

    Member Visibility
    diff --git a/docs/types/outdoorMeter.html b/docs/types/outdoorMeter.html index ba6d1d4a..889304a9 100644 --- a/docs/types/outdoorMeter.html +++ b/docs/types/outdoorMeter.html @@ -1 +1 @@ -outdoorMeter | node-switchbot

    Type Alias outdoorMeter

    outdoorMeter: device & {}

    Settings

    Member Visibility
    +outdoorMeter | node-switchbot

    Type Alias outdoorMeter

    outdoorMeter: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/outdoorMeterServiceData.html b/docs/types/outdoorMeterServiceData.html index 09ce0863..46a36026 100644 --- a/docs/types/outdoorMeterServiceData.html +++ b/docs/types/outdoorMeterServiceData.html @@ -1 +1 @@ -outdoorMeterServiceData | node-switchbot

    Type Alias outdoorMeterServiceData

    outdoorMeterServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: OutdoorMeter;
        modelFriendlyName: OutdoorMeter;
        modelName: OutdoorMeter;
    }

    Settings

    Member Visibility
    +outdoorMeterServiceData | node-switchbot

    Type Alias outdoorMeterServiceData

    outdoorMeterServiceData: serviceData & {
        battery: number;
        celsius: number;
        fahrenheit: number;
        fahrenheit_mode: boolean;
        humidity: number;
        model: OutdoorMeter;
        modelFriendlyName: OutdoorMeter;
        modelName: OutdoorMeter;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/outdoorMeterStatus.html b/docs/types/outdoorMeterStatus.html index abb84b11..4cd8eb08 100644 --- a/docs/types/outdoorMeterStatus.html +++ b/docs/types/outdoorMeterStatus.html @@ -1 +1 @@ -outdoorMeterStatus | node-switchbot

    Type Alias outdoorMeterStatus

    outdoorMeterStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    +outdoorMeterStatus | node-switchbot

    Type Alias outdoorMeterStatus

    outdoorMeterStatus: deviceStatus & {
        battery: number;
        humidity: number;
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/outdoorMeterWebhookContext.html b/docs/types/outdoorMeterWebhookContext.html index 1ac32d9b..5b4aaf23 100644 --- a/docs/types/outdoorMeterWebhookContext.html +++ b/docs/types/outdoorMeterWebhookContext.html @@ -1 +1 @@ -outdoorMeterWebhookContext | node-switchbot

    Type Alias outdoorMeterWebhookContext

    outdoorMeterWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    +outdoorMeterWebhookContext | node-switchbot

    Type Alias outdoorMeterWebhookContext

    outdoorMeterWebhookContext: deviceWebhookContext & {
        battery: number;
        humidity: number;
        scale: "CELSIUS" | "FAHRENHEIT";
        temperature: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/panTiltCamWebhookContext.html b/docs/types/panTiltCamWebhookContext.html index d6e3fbeb..bbfe7801 100644 --- a/docs/types/panTiltCamWebhookContext.html +++ b/docs/types/panTiltCamWebhookContext.html @@ -1 +1 @@ -panTiltCamWebhookContext | node-switchbot

    Type Alias panTiltCamWebhookContext

    panTiltCamWebhookContext: deviceWebhookContext & { detectionState: "DETECTED" }

    Settings

    Member Visibility
    +panTiltCamWebhookContext | node-switchbot

    Type Alias panTiltCamWebhookContext

    panTiltCamWebhookContext: deviceWebhookContext & { detectionState: "DETECTED" }

    Settings

    Member Visibility
    diff --git a/docs/types/pantiltCam.html b/docs/types/pantiltCam.html index 1ae8f29d..8c93ceff 100644 --- a/docs/types/pantiltCam.html +++ b/docs/types/pantiltCam.html @@ -1 +1 @@ -pantiltCam | node-switchbot

    Type Alias pantiltCam

    pantiltCam: device & {}

    Settings

    Member Visibility
    +pantiltCam | node-switchbot

    Type Alias pantiltCam

    pantiltCam: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/pantiltCam2k.html b/docs/types/pantiltCam2k.html index a2c355ba..16857032 100644 --- a/docs/types/pantiltCam2k.html +++ b/docs/types/pantiltCam2k.html @@ -1 +1 @@ -pantiltCam2k | node-switchbot

    Type Alias pantiltCam2k

    pantiltCam2k: device & {}

    Settings

    Member Visibility
    +pantiltCam2k | node-switchbot

    Type Alias pantiltCam2k

    pantiltCam2k: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/plug.html b/docs/types/plug.html index 5760147e..e5357782 100644 --- a/docs/types/plug.html +++ b/docs/types/plug.html @@ -1 +1 @@ -plug | node-switchbot

    Type Alias plug

    plug: device & {}

    Settings

    Member Visibility
    +plug | node-switchbot

    Type Alias plug

    plug: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/plugMini.html b/docs/types/plugMini.html index f006554c..5a79faea 100644 --- a/docs/types/plugMini.html +++ b/docs/types/plugMini.html @@ -1 +1 @@ -plugMini | node-switchbot

    Type Alias plugMini

    plugMini: device & {}

    Settings

    Member Visibility
    +plugMini | node-switchbot

    Type Alias plugMini

    plugMini: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/plugMiniJPServiceData.html b/docs/types/plugMiniJPServiceData.html index 9e76f224..077fff3b 100644 --- a/docs/types/plugMiniJPServiceData.html +++ b/docs/types/plugMiniJPServiceData.html @@ -1 +1 @@ -plugMiniJPServiceData | node-switchbot

    Type Alias plugMiniJPServiceData

    plugMiniJPServiceData: serviceData & {
        currentPower: number;
        delay: boolean;
        model: PlugMiniJP;
        modelFriendlyName: PlugMini;
        modelName: PlugMini;
        overload: boolean;
        state: string;
        syncUtcTime: boolean;
        timer: boolean;
        wifiRssi: number;
    }

    Settings

    Member Visibility
    +plugMiniJPServiceData | node-switchbot

    Type Alias plugMiniJPServiceData

    plugMiniJPServiceData: serviceData & {
        currentPower: number;
        delay: boolean;
        model: PlugMiniJP;
        modelFriendlyName: PlugMini;
        modelName: PlugMini;
        overload: boolean;
        state: string;
        syncUtcTime: boolean;
        timer: boolean;
        wifiRssi: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/plugMiniJPWebhookContext.html b/docs/types/plugMiniJPWebhookContext.html index 888581e8..9a01f3e1 100644 --- a/docs/types/plugMiniJPWebhookContext.html +++ b/docs/types/plugMiniJPWebhookContext.html @@ -1 +1 @@ -plugMiniJPWebhookContext | node-switchbot

    Type Alias plugMiniJPWebhookContext

    plugMiniJPWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    +plugMiniJPWebhookContext | node-switchbot

    Type Alias plugMiniJPWebhookContext

    plugMiniJPWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    diff --git a/docs/types/plugMiniStatus.html b/docs/types/plugMiniStatus.html index 5e76344c..113fa216 100644 --- a/docs/types/plugMiniStatus.html +++ b/docs/types/plugMiniStatus.html @@ -1 +1 @@ -plugMiniStatus | node-switchbot

    Type Alias plugMiniStatus

    plugMiniStatus: deviceStatus & {
        electricCurrent: Float64Array;
        electricityOfDay: number;
        power: string;
        voltage: Float64Array;
        weight: Float64Array;
    }

    Settings

    Member Visibility
    +plugMiniStatus | node-switchbot

    Type Alias plugMiniStatus

    plugMiniStatus: deviceStatus & {
        electricCurrent: Float64Array;
        electricityOfDay: number;
        power: string;
        voltage: Float64Array;
        weight: Float64Array;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/plugMiniUSServiceData.html b/docs/types/plugMiniUSServiceData.html index af69e3d3..1dcff841 100644 --- a/docs/types/plugMiniUSServiceData.html +++ b/docs/types/plugMiniUSServiceData.html @@ -1 +1 @@ -plugMiniUSServiceData | node-switchbot

    Type Alias plugMiniUSServiceData

    plugMiniUSServiceData: serviceData & {
        currentPower: number;
        delay: boolean;
        model: PlugMiniUS;
        modelFriendlyName: PlugMini;
        modelName: PlugMini;
        overload: boolean;
        state: string;
        syncUtcTime: boolean;
        timer: boolean;
        wifiRssi: number;
    }

    Settings

    Member Visibility
    +plugMiniUSServiceData | node-switchbot

    Type Alias plugMiniUSServiceData

    plugMiniUSServiceData: serviceData & {
        currentPower: number;
        delay: boolean;
        model: PlugMiniUS;
        modelFriendlyName: PlugMini;
        modelName: PlugMini;
        overload: boolean;
        state: string;
        syncUtcTime: boolean;
        timer: boolean;
        wifiRssi: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/plugMiniUSWebhookContext.html b/docs/types/plugMiniUSWebhookContext.html index ac264a22..6dbc645b 100644 --- a/docs/types/plugMiniUSWebhookContext.html +++ b/docs/types/plugMiniUSWebhookContext.html @@ -1 +1 @@ -plugMiniUSWebhookContext | node-switchbot

    Type Alias plugMiniUSWebhookContext

    plugMiniUSWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    +plugMiniUSWebhookContext | node-switchbot

    Type Alias plugMiniUSWebhookContext

    plugMiniUSWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    diff --git a/docs/types/plugStatus.html b/docs/types/plugStatus.html index 4984dadd..7600a436 100644 --- a/docs/types/plugStatus.html +++ b/docs/types/plugStatus.html @@ -1 +1 @@ -plugStatus | node-switchbot

    Type Alias plugStatus

    plugStatus: deviceStatus & { power: string; version: string }

    Settings

    Member Visibility
    +plugStatus | node-switchbot

    Type Alias plugStatus

    plugStatus: deviceStatus & { power: string; version: string }

    Settings

    Member Visibility
    diff --git a/docs/types/plugWebhookContext.html b/docs/types/plugWebhookContext.html index 250f650c..9695b36f 100644 --- a/docs/types/plugWebhookContext.html +++ b/docs/types/plugWebhookContext.html @@ -1 +1 @@ -plugWebhookContext | node-switchbot

    Type Alias plugWebhookContext

    plugWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    +plugWebhookContext | node-switchbot

    Type Alias plugWebhookContext

    plugWebhookContext: deviceWebhookContext & { powerState: "ON" | "OFF" }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1Context.html b/docs/types/relaySwitch1Context.html index f2d48201..169890fb 100644 --- a/docs/types/relaySwitch1Context.html +++ b/docs/types/relaySwitch1Context.html @@ -1 +1 @@ -relaySwitch1Context | node-switchbot

    Type Alias relaySwitch1Context

    relaySwitch1Context: deviceWebhookContext & {
        online: boolean;
        overTemperature: boolean;
        switchStatus: 0 | 1;
        version: string;
    }

    Settings

    Member Visibility
    +relaySwitch1Context | node-switchbot

    Type Alias relaySwitch1Context

    relaySwitch1Context: deviceWebhookContext & {
        online: boolean;
        overTemperature: boolean;
        switchStatus: 0 | 1;
        version: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1PMContext.html b/docs/types/relaySwitch1PMContext.html index 5ec42008..053b5c96 100644 --- a/docs/types/relaySwitch1PMContext.html +++ b/docs/types/relaySwitch1PMContext.html @@ -1 +1 @@ -relaySwitch1PMContext | node-switchbot

    Type Alias relaySwitch1PMContext

    relaySwitch1PMContext: deviceWebhookContext & {
        online: boolean;
        overload: boolean;
        overTemperature: boolean;
        switchStatus: 0 | 1;
        version: string;
    }

    Settings

    Member Visibility
    +relaySwitch1PMContext | node-switchbot

    Type Alias relaySwitch1PMContext

    relaySwitch1PMContext: deviceWebhookContext & {
        online: boolean;
        overload: boolean;
        overTemperature: boolean;
        switchStatus: 0 | 1;
        version: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1PMServiceData.html b/docs/types/relaySwitch1PMServiceData.html index 42c47366..902a2d8b 100644 --- a/docs/types/relaySwitch1PMServiceData.html +++ b/docs/types/relaySwitch1PMServiceData.html @@ -1 +1 @@ -relaySwitch1PMServiceData | node-switchbot

    Type Alias relaySwitch1PMServiceData

    relaySwitch1PMServiceData: serviceData & {
        current: number;
        mode: boolean;
        model: RelaySwitch1PM;
        modelFriendlyName: RelaySwitch1PM;
        modelName: RelaySwitch1PM;
        power: number;
        sequence_number: number;
        state: boolean;
        voltage: number;
    }

    Settings

    Member Visibility
    +relaySwitch1PMServiceData | node-switchbot

    Type Alias relaySwitch1PMServiceData

    relaySwitch1PMServiceData: serviceData & {
        current: number;
        mode: boolean;
        model: RelaySwitch1PM;
        modelFriendlyName: RelaySwitch1PM;
        modelName: RelaySwitch1PM;
        power: number;
        sequence_number: number;
        state: boolean;
        voltage: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1PMStatus.html b/docs/types/relaySwitch1PMStatus.html index 630efc90..d32e7bc7 100644 --- a/docs/types/relaySwitch1PMStatus.html +++ b/docs/types/relaySwitch1PMStatus.html @@ -1 +1 @@ -relaySwitch1PMStatus | node-switchbot

    Type Alias relaySwitch1PMStatus

    relaySwitch1PMStatus: deviceStatus & {
        electricCurrent: number;
        power: number;
        switchStatus: 0 | 1;
        usedElectricity: number;
        version: string;
        voltage: number;
    }

    Settings

    Member Visibility
    +relaySwitch1PMStatus | node-switchbot

    Type Alias relaySwitch1PMStatus

    relaySwitch1PMStatus: deviceStatus & {
        electricCurrent: number;
        power: number;
        switchStatus: 0 | 1;
        usedElectricity: number;
        version: string;
        voltage: number;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1ServiceData.html b/docs/types/relaySwitch1ServiceData.html index d6512b76..56724c8d 100644 --- a/docs/types/relaySwitch1ServiceData.html +++ b/docs/types/relaySwitch1ServiceData.html @@ -1 +1 @@ -relaySwitch1ServiceData | node-switchbot

    Type Alias relaySwitch1ServiceData

    relaySwitch1ServiceData: serviceData & {
        mode: boolean;
        model: RelaySwitch1;
        modelFriendlyName: RelaySwitch1;
        modelName: RelaySwitch1;
        sequence_number: number;
        state: boolean;
    }

    Settings

    Member Visibility
    +relaySwitch1ServiceData | node-switchbot

    Type Alias relaySwitch1ServiceData

    relaySwitch1ServiceData: serviceData & {
        mode: boolean;
        model: RelaySwitch1;
        modelFriendlyName: RelaySwitch1;
        modelName: RelaySwitch1;
        sequence_number: number;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/relaySwitch1Status.html b/docs/types/relaySwitch1Status.html index e7ff6d20..6ae32679 100644 --- a/docs/types/relaySwitch1Status.html +++ b/docs/types/relaySwitch1Status.html @@ -1 +1 @@ -relaySwitch1Status | node-switchbot

    Type Alias relaySwitch1Status

    relaySwitch1Status: deviceStatus & { switchStatus: 0 | 1; version: string }

    Settings

    Member Visibility
    +relaySwitch1Status | node-switchbot

    Type Alias relaySwitch1Status

    relaySwitch1Status: deviceStatus & { switchStatus: 0 | 1; version: string }

    Settings

    Member Visibility
    diff --git a/docs/types/remote.html b/docs/types/remote.html index 496d8a54..aa0a23c3 100644 --- a/docs/types/remote.html +++ b/docs/types/remote.html @@ -1 +1 @@ -remote | node-switchbot

    Type Alias remote

    remote: device & {}

    Settings

    Member Visibility
    +remote | node-switchbot

    Type Alias remote

    remote: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/remoteServiceData.html b/docs/types/remoteServiceData.html index eae49d62..763f1e6c 100644 --- a/docs/types/remoteServiceData.html +++ b/docs/types/remoteServiceData.html @@ -1 +1 @@ -remoteServiceData | node-switchbot

    Type Alias remoteServiceData

    remoteServiceData: serviceData & {
        battery: number;
        model: Remote;
        modelFriendlyName: Remote;
        modelName: Remote;
    }

    Settings

    Member Visibility
    +remoteServiceData | node-switchbot

    Type Alias remoteServiceData

    remoteServiceData: serviceData & {
        battery: number;
        model: Remote;
        modelFriendlyName: Remote;
        modelName: Remote;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1.html b/docs/types/robotVacuumCleanerS1.html index fabd46b5..b675965f 100644 --- a/docs/types/robotVacuumCleanerS1.html +++ b/docs/types/robotVacuumCleanerS1.html @@ -1 +1 @@ -robotVacuumCleanerS1 | node-switchbot

    Type Alias robotVacuumCleanerS1

    robotVacuumCleanerS1: device & {}

    Settings

    Member Visibility
    +robotVacuumCleanerS1 | node-switchbot

    Type Alias robotVacuumCleanerS1

    robotVacuumCleanerS1: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1Plus.html b/docs/types/robotVacuumCleanerS1Plus.html index a013e3ee..9f70f978 100644 --- a/docs/types/robotVacuumCleanerS1Plus.html +++ b/docs/types/robotVacuumCleanerS1Plus.html @@ -1 +1 @@ -robotVacuumCleanerS1Plus | node-switchbot

    Type Alias robotVacuumCleanerS1Plus

    robotVacuumCleanerS1Plus: device & {}

    Settings

    Member Visibility
    +robotVacuumCleanerS1Plus | node-switchbot

    Type Alias robotVacuumCleanerS1Plus

    robotVacuumCleanerS1Plus: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1PlusStatus.html b/docs/types/robotVacuumCleanerS1PlusStatus.html index 9deb05a4..f4e599ce 100644 --- a/docs/types/robotVacuumCleanerS1PlusStatus.html +++ b/docs/types/robotVacuumCleanerS1PlusStatus.html @@ -1 +1 @@ -robotVacuumCleanerS1PlusStatus | node-switchbot

    Type Alias robotVacuumCleanerS1PlusStatus

    robotVacuumCleanerS1PlusStatus: deviceStatus & {
        battery: number;
        onlineStatus: string;
        workingStatus: string;
    }

    Settings

    Member Visibility
    +robotVacuumCleanerS1PlusStatus | node-switchbot

    Type Alias robotVacuumCleanerS1PlusStatus

    robotVacuumCleanerS1PlusStatus: deviceStatus & {
        battery: number;
        onlineStatus: string;
        workingStatus: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1PlusWebhookContext.html b/docs/types/robotVacuumCleanerS1PlusWebhookContext.html index 95fb49f9..3c71e558 100644 --- a/docs/types/robotVacuumCleanerS1PlusWebhookContext.html +++ b/docs/types/robotVacuumCleanerS1PlusWebhookContext.html @@ -1 +1 @@ -robotVacuumCleanerS1PlusWebhookContext | node-switchbot

    Type Alias robotVacuumCleanerS1PlusWebhookContext

    robotVacuumCleanerS1PlusWebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        workingStatus:
            | "Standby"
            | "Clearing"
            | "Paused"
            | "GotoChargeBase"
            | "Charging"
            | "ChargeDone"
            | "Dormant"
            | "InTrouble"
            | "InRemoteControl"
            | "InDustCollecting";
    }

    Settings

    Member Visibility
    +robotVacuumCleanerS1PlusWebhookContext | node-switchbot

    Type Alias robotVacuumCleanerS1PlusWebhookContext

    robotVacuumCleanerS1PlusWebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        workingStatus:
            | "Standby"
            | "Clearing"
            | "Paused"
            | "GotoChargeBase"
            | "Charging"
            | "ChargeDone"
            | "Dormant"
            | "InTrouble"
            | "InRemoteControl"
            | "InDustCollecting";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1Status.html b/docs/types/robotVacuumCleanerS1Status.html index 7e67aa75..1c365f5d 100644 --- a/docs/types/robotVacuumCleanerS1Status.html +++ b/docs/types/robotVacuumCleanerS1Status.html @@ -1 +1 @@ -robotVacuumCleanerS1Status | node-switchbot

    Type Alias robotVacuumCleanerS1Status

    robotVacuumCleanerS1Status: deviceStatus & {
        battery: number;
        onlineStatus: string;
        workingStatus: string;
    }

    Settings

    Member Visibility
    +robotVacuumCleanerS1Status | node-switchbot

    Type Alias robotVacuumCleanerS1Status

    robotVacuumCleanerS1Status: deviceStatus & {
        battery: number;
        onlineStatus: string;
        workingStatus: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerS1WebhookContext.html b/docs/types/robotVacuumCleanerS1WebhookContext.html index 39fa7d92..4db18452 100644 --- a/docs/types/robotVacuumCleanerS1WebhookContext.html +++ b/docs/types/robotVacuumCleanerS1WebhookContext.html @@ -1 +1 @@ -robotVacuumCleanerS1WebhookContext | node-switchbot

    Type Alias robotVacuumCleanerS1WebhookContext

    robotVacuumCleanerS1WebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        workingStatus:
            | "Standby"
            | "Clearing"
            | "Paused"
            | "GotoChargeBase"
            | "Charging"
            | "ChargeDone"
            | "Dormant"
            | "InTrouble"
            | "InRemoteControl"
            | "InDustCollecting";
    }

    Settings

    Member Visibility
    +robotVacuumCleanerS1WebhookContext | node-switchbot

    Type Alias robotVacuumCleanerS1WebhookContext

    robotVacuumCleanerS1WebhookContext: deviceWebhookContext & {
        battery: number;
        onlineStatus: "online" | "offline";
        workingStatus:
            | "Standby"
            | "Clearing"
            | "Paused"
            | "GotoChargeBase"
            | "Charging"
            | "ChargeDone"
            | "Dormant"
            | "InTrouble"
            | "InRemoteControl"
            | "InDustCollecting";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/robotVacuumCleanerServiceData.html b/docs/types/robotVacuumCleanerServiceData.html index 7663dd20..4edf2069 100644 --- a/docs/types/robotVacuumCleanerServiceData.html +++ b/docs/types/robotVacuumCleanerServiceData.html @@ -1 +1 @@ -robotVacuumCleanerServiceData | node-switchbot

    Type Alias robotVacuumCleanerServiceData

    robotVacuumCleanerServiceData: serviceData & {
        battery: number;
        model: Unknown;
        modelFriendlyName: Unknown;
        modelName: Unknown;
        state: string;
    }

    Settings

    Member Visibility
    +robotVacuumCleanerServiceData | node-switchbot

    Type Alias robotVacuumCleanerServiceData

    robotVacuumCleanerServiceData: serviceData & {
        battery: number;
        model: Unknown;
        modelFriendlyName: Unknown;
        modelName: Unknown;
        state: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/stripLight.html b/docs/types/stripLight.html index b5dd45d7..d97012b3 100644 --- a/docs/types/stripLight.html +++ b/docs/types/stripLight.html @@ -1 +1 @@ -stripLight | node-switchbot

    Type Alias stripLight

    stripLight: device & {}

    Settings

    Member Visibility
    +stripLight | node-switchbot

    Type Alias stripLight

    stripLight: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/stripLightServiceData.html b/docs/types/stripLightServiceData.html index 5f522195..4d27921c 100644 --- a/docs/types/stripLightServiceData.html +++ b/docs/types/stripLightServiceData.html @@ -1 +1 @@ -stripLightServiceData | node-switchbot

    Type Alias stripLightServiceData

    stripLightServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        delay: number;
        green: number;
        loop_index: number;
        model: StripLight;
        modelFriendlyName: StripLight;
        modelName: StripLight;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    +stripLightServiceData | node-switchbot

    Type Alias stripLightServiceData

    stripLightServiceData: serviceData & {
        blue: number;
        brightness: number;
        color_mode: number;
        delay: number;
        green: number;
        loop_index: number;
        model: StripLight;
        modelFriendlyName: StripLight;
        modelName: StripLight;
        power: boolean;
        preset: number;
        red: number;
        speed: number;
        state: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/stripLightStatus.html b/docs/types/stripLightStatus.html index b1e08c85..44c4ae7f 100644 --- a/docs/types/stripLightStatus.html +++ b/docs/types/stripLightStatus.html @@ -1 +1 @@ -stripLightStatus | node-switchbot

    Type Alias stripLightStatus

    stripLightStatus: deviceStatus & {
        brightness: number;
        color: string;
        power: string;
    }

    Settings

    Member Visibility
    +stripLightStatus | node-switchbot

    Type Alias stripLightStatus

    stripLightStatus: deviceStatus & {
        brightness: number;
        color: string;
        power: string;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/stripLightWebhookContext.html b/docs/types/stripLightWebhookContext.html index f30fc78f..4d7602e9 100644 --- a/docs/types/stripLightWebhookContext.html +++ b/docs/types/stripLightWebhookContext.html @@ -1 +1 @@ -stripLightWebhookContext | node-switchbot

    Type Alias stripLightWebhookContext

    stripLightWebhookContext: deviceWebhookContext & {
        brightness: number;
        color: string;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    +stripLightWebhookContext | node-switchbot

    Type Alias stripLightWebhookContext

    stripLightWebhookContext: deviceWebhookContext & {
        brightness: number;
        color: string;
        powerState: "ON" | "OFF";
    }

    Settings

    Member Visibility
    diff --git a/docs/types/waterLeakDetector.html b/docs/types/waterLeakDetector.html index 103d7bdb..70189b39 100644 --- a/docs/types/waterLeakDetector.html +++ b/docs/types/waterLeakDetector.html @@ -1 +1 @@ -waterLeakDetector | node-switchbot

    Type Alias waterLeakDetector

    waterLeakDetector: device & {}

    Settings

    Member Visibility
    +waterLeakDetector | node-switchbot

    Type Alias waterLeakDetector

    waterLeakDetector: device & {}

    Settings

    Member Visibility
    diff --git a/docs/types/waterLeakDetectorServiceData.html b/docs/types/waterLeakDetectorServiceData.html index f5c5387f..023b4b9b 100644 --- a/docs/types/waterLeakDetectorServiceData.html +++ b/docs/types/waterLeakDetectorServiceData.html @@ -1 +1 @@ -waterLeakDetectorServiceData | node-switchbot

    Type Alias waterLeakDetectorServiceData

    waterLeakDetectorServiceData: serviceData & {
        battery: number;
        leak: boolean;
        low_battery: boolean;
        model: Leak;
        modelFriendlyName: Leak;
        modelName: Leak;
        tampered: boolean;
    }

    Settings

    Member Visibility
    +waterLeakDetectorServiceData | node-switchbot

    Type Alias waterLeakDetectorServiceData

    waterLeakDetectorServiceData: serviceData & {
        battery: number;
        leak: boolean;
        low_battery: boolean;
        model: Leak;
        modelFriendlyName: Leak;
        modelName: Leak;
        tampered: boolean;
    }

    Settings

    Member Visibility
    diff --git a/docs/types/waterLeakDetectorStatus.html b/docs/types/waterLeakDetectorStatus.html index bb162110..aa7002d9 100644 --- a/docs/types/waterLeakDetectorStatus.html +++ b/docs/types/waterLeakDetectorStatus.html @@ -1 +1 @@ -waterLeakDetectorStatus | node-switchbot

    Type Alias waterLeakDetectorStatus

    waterLeakDetectorStatus: deviceStatus & { battery: number; status: 0 | 1 }

    Settings

    Member Visibility
    +waterLeakDetectorStatus | node-switchbot

    Type Alias waterLeakDetectorStatus

    waterLeakDetectorStatus: deviceStatus & { battery: number; status: 0 | 1 }

    Settings

    Member Visibility
    diff --git a/docs/types/waterLeakDetectorWebhookContext.html b/docs/types/waterLeakDetectorWebhookContext.html index 9df1d63e..796ccbb2 100644 --- a/docs/types/waterLeakDetectorWebhookContext.html +++ b/docs/types/waterLeakDetectorWebhookContext.html @@ -1 +1 @@ -waterLeakDetectorWebhookContext | node-switchbot

    Type Alias waterLeakDetectorWebhookContext

    waterLeakDetectorWebhookContext: deviceWebhookContext & {
        battery: number;
        detectionState: 0 | 1;
    }

    Settings

    Member Visibility
    +waterLeakDetectorWebhookContext | node-switchbot

    Type Alias waterLeakDetectorWebhookContext

    waterLeakDetectorWebhookContext: deviceWebhookContext & {
        battery: number;
        detectionState: 0 | 1;
    }

    Settings

    Member Visibility