@switchbot/homebridge-switchbot 2.2.3-beta.0 → 2.3.0-beta.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
 
+## [Version 2.3.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v2.3.0) (2022-10-29)
+
+## What's Changed
+
+- Added Support for SwitchBot Robot Vacuum Cleaner S1 & SwitchBot Robot Vacuum Cleaner S1 Plus
+- Housekeeping and updated dependencies.
+
+**Full Changelog**: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v2.2.2....v2.3.0
+
 ## [Version 2.2.2](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v2.2.2) (2022-10-22)
 
 ## What's Changed

package/README.md

@@ -103,6 +103,14 @@
   - If using OpenAPI:
     - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
     - Enable Cloud Services for Device on SwitchBot App
+- [SwitchBot Lock](https://us.switch-bot.com/products/switchbot-lock)
+  - Supports OpenAPI Connection Only
+  - If using OpenAPI:
+    - [SwitchBot Hub Mini](https://www.switch-bot.com/products/switchbot-hub-mini) or [SwitchBot Hub Plus](https://www.switch-bot.com/products/switchbot-hub-plus) Required
+    - Enable Cloud Services for Device on SwitchBot App
+- [SwitchBot Robot Vacuum Cleaner S1](https://www.switchbot.jp/products/switchbot-robot-vacuum-cleaner)
+- [SwitchBot Robot Vacuum Cleaner S1 Plus](https://www.switchbot.jp/products/switchbot-robot-vacuum-cleaner)
+  - Supports OpenAPI Connection Only
 - [SwitchBot Plug](https://www.switch-bot.com/products/switchbot-plug)
 - [SwitchBot Plug Mini (US)](https://www.switch-bot.com/products/switchbot-plug-mini)
 - [SwitchBot Plug Mini (JP)](https://www.switchbot.jp/products/switchbot-plug-mini)

package/config.schema.json

@@ -131,6 +131,14 @@
                     {
                       "title": "Plug Mini (JP)",
                       "enum": ["Plug Mini (JP)"]
+                    },
+                    {
+                      "title": "Robot Vacuum Cleaner S1",
+                      "enum": ["Robot Vacuum Cleaner S1"]
+                    },
+                    {
+                      "title": "Robot Vacuum Cleaner S1 Plus",
+                      "enum": ["Robot Vacuum Cleaner S1 Plus"]
                     }
                   ],
                   "condition": {

package/dist/device/robotvacuumcleaner.d.ts

@@ -0,0 +1,106 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Context } from 'vm';
+import { IncomingMessage } from 'http';
+import { Subject } from 'rxjs';
+import { SwitchBotPlatform } from '../platform';
+import { Service, PlatformAccessory, CharacteristicValue } from 'homebridge';
+import { device, devicesConfig, deviceStatus, ad, serviceData, switchbot } from '../settings';
+export declare class RobotVacuumCleaner {
+    private readonly platform;
+    private accessory;
+    device: device & devicesConfig;
+    robotVacuumCleanerService: Service;
+    batteryService?: Service;
+    On: CharacteristicValue;
+    Brightness: CharacteristicValue;
+    BatteryLevel?: CharacteristicValue;
+    StatusLowBattery?: CharacteristicValue;
+    power: deviceStatus['power'];
+    deviceStatus: any;
+    connected?: boolean;
+    switchbot: switchbot;
+    address: ad['address'];
+    serviceData: serviceData;
+    state: serviceData['state'];
+    scanDuration: number;
+    deviceLogging: string;
+    deviceRefreshRate: number;
+    robotVacuumCleanerUpdateInProgress: boolean;
+    doRobotVacuumCleanerUpdate: Subject<void>;
+    private readonly BLE;
+    private readonly OpenAPI;
+    constructor(platform: SwitchBotPlatform, accessory: PlatformAccessory, device: device & devicesConfig);
+    /**
+     * Parse the device status from the SwitchBot api
+     */
+    parseStatus(): Promise<void>;
+    BLEparseStatus(): Promise<void>;
+    openAPIparseStatus(): Promise<void>;
+    /**
+     * Asks the SwitchBot API for the latest device information
+     */
+    refreshStatus(): Promise<void>;
+    BLERefreshStatus(): Promise<void>;
+    openAPIRefreshStatus(): Promise<void>;
+    /**
+     * Pushes the requested changes to the SwitchBot API
+     * deviceType	              commandType	    Command	    parameter	        Description
+     * Robot Vacuum Cleaner S1   "command"     "start"      "default"	  =     start vacuuming
+     * Robot Vacuum Cleaner S1   "command"     "stop"       "default"	  =     stop vacuuming
+     * Robot Vacuum Cleaner S1   "command"     "dock"       "default"   =     return to charging dock
+     * Robot Vacuum Cleaner S1   "command"     "PowLevel"   "{0-3}"     =     set suction power level: 0 (Quiet), 1 (Standard), 2 (Strong), 3 (MAX)
+     */
+    pushChanges(): Promise<void>;
+    BLEpushChanges(): Promise<void>;
+    openAPIpushChanges(): Promise<void>;
+    openAPIpushBrightnessChanges(): Promise<void>;
+    private commands;
+    private brightnessCommands;
+    /**
+     * Handle requests to set the value of the "On" characteristic
+     */
+    OnSet(value: CharacteristicValue): Promise<void>;
+    /**
+     * Handle requests to set the value of the "Brightness" characteristic
+     */
+    BrightnessSet(value: CharacteristicValue): Promise<void>;
+    updateHomeKitCharacteristics(): Promise<void>;
+    stopScanning(switchbot: any): Promise<void>;
+    BLEmodel(): 'g' | 'j';
+    getCustomBLEAddress(switchbot: any): Promise<void>;
+    BLEPushConnection(): Promise<void>;
+    BLERefreshConnection(switchbot: any): Promise<void>;
+    turnOnOff(device_list: any): Promise<any>;
+    retry({ max, fn }: {
+        max: number;
+        fn: {
+            (): any;
+            (): Promise<any>;
+        };
+    }): Promise<null>;
+    maxRetry(): Promise<number>;
+    model(device: device & devicesConfig): string;
+    scan(device: device & devicesConfig): Promise<void>;
+    statusCode({ res }: {
+        res: IncomingMessage;
+    }): Promise<void>;
+    offlineOff(): Promise<void>;
+    apiError(e: any): Promise<void>;
+    FirmwareRevision(accessory: PlatformAccessory<Context>, device: device & devicesConfig): CharacteristicValue;
+    context(): Promise<void>;
+    refreshRate(device: device & devicesConfig): Promise<void>;
+    config(device: device & devicesConfig): Promise<void>;
+    logs(device: device & devicesConfig): Promise<void>;
+    /**
+     * Logging for Device
+     */
+    infoLog(...log: any[]): void;
+    warnLog(...log: any[]): void;
+    debugWarnLog(...log: any[]): void;
+    errorLog(...log: any[]): void;
+    debugErrorLog(...log: any[]): void;
+    debugLog(...log: any[]): void;
+    enablingDeviceLogging(): boolean;
+}
+//# sourceMappingURL=robotvacuumcleaner.d.ts.map

package/dist/device/robotvacuumcleaner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"robotvacuumcleaner.d.ts","sourceRoot":"","sources":["../../src/device/robotvacuumcleaner.ts"],"names":[],"mappings":";;AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAC7B,OAAO,EAAE,eAAe,EAAE,MAAM,MAAM,CAAC;AACvC,OAAO,EAAY,OAAO,EAAE,MAAM,MAAM,CAAC;AAEzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,EAAE,EAAE,WAAW,EAAE,SAAS,EAA0B,MAAM,aAAa,CAAC;AAEtH,qBAAa,kBAAkB;IAmCjB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IAAqB,OAAO,CAAC,SAAS;IAA4B,MAAM,EAAE,MAAM,GAAG,aAAa;IAjCrI,yBAAyB,EAAE,OAAO,CAAC;IACnC,cAAc,CAAC,EAAE,OAAO,CAAC;IAGzB,EAAE,EAAG,mBAAmB,CAAC;IACzB,UAAU,EAAG,mBAAmB,CAAC;IACjC,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;IAGvC,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;IAC7B,YAAY,EAAG,GAAG,CAAC;IAGnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,EAAG,SAAS,CAAC;IACtB,OAAO,EAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACxB,WAAW,EAAG,WAAW,CAAC;IAC1B,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IAG5B,YAAY,EAAG,MAAM,CAAC;IACtB,aAAa,EAAG,MAAM,CAAC;IACvB,iBAAiB,EAAG,MAAM,CAAC;IAG3B,kCAAkC,EAAG,OAAO,CAAC;IAC7C,0BAA0B,EAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAG3C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAA0F;IAC9G,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA8F;gBAEzF,QAAQ,EAAE,iBAAiB,EAAU,SAAS,EAAE,iBAAiB,EAAS,MAAM,EAAE,MAAM,GAAG,aAAa;IA+FrI;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAc5B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAa/B,kBAAkB;IAYxB;;OAEG;IACG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAc9B,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IA2DjC,oBAAoB;IAqD1B;;;;;;;OAOG;IAEG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAqB5B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAsC/B,kBAAkB;IAiDlB,4BAA4B;IAiDlC,OAAO,CAAC,QAAQ;IAkBhB,OAAO,CAAC,kBAAkB;IA2B1B;;OAEG;IACG,KAAK,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAWtD;;OAEG;IACG,aAAa,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAaxD,4BAA4B,IAAI,OAAO,CAAC,IAAI,CAAC;IA+B7C,YAAY,CAAC,SAAS,EAAE,GAAG;IAUjC,QAAQ,IAAI,GAAG,GAAG,GAAG;IAQf,mBAAmB,CAAC,SAAS,EAAE,GAAG;IAkBlC,iBAAiB;IAOjB,oBAAoB,CAAC,SAAS,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAQnD,SAAS,CAAC,WAAW,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAazC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,EAAE,EAAE;YAAE,IAAI,GAAG,CAAC;YAAC,IAAI,OAAO,CAAC,GAAG,CAAC,CAAA;SAAE,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAYrF,QAAQ,IAAI,OAAO,CAAC,MAAM,CAAC;IAUjC,KAAK,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,MAAM;IAYvC,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAcnD,UAAU,CAAC,EAAE,GAAG,EAAE,EAAE;QAAE,GAAG,EAAE,eAAe,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiC5D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAO3B,QAAQ,CAAC,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrC,gBAAgB,CAAC,SAAS,EAAE,iBAAiB,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,mBAAmB;IAgBtG,OAAO;IAaP,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAU1D,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IA4BrD,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBzD;;OAEG;IACH,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAM5B,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAM5B,YAAY,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAQjC,QAAQ,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAM7B,aAAa,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAQlC,QAAQ,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAU7B,qBAAqB,IAAI,OAAO;CAGjC"}