@switchbot/homebridge-switchbot 1.3.1-beta.9 → 1.4.1-beta.2

package/CHANGELOG.md

@@ -2,14 +2,30 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
 
-## [Beta - Version 1.3.1](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.3.1) (2021-12-XX)
+## [Beta - Version 2.0.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v2.0.0) (2021-12-XX)
+
+## What's Changed
+### * Major Change To Logging:
+* Added the following Logging Options:
+    * `Standard`
+        * `None`
+        * `Debug`
+    * Removed Device Logging Option, which was pushed into new logging under debug.
+    * Added Device Logging Override for each Device, by using the Device Config.
+### * Major Changes to `refreshRate`:
+* Added an option to override `refreshRate` for each Device, by using the Device Config.
+* Fixed Bug:
+
+## [Version 1.4.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.4.0) (2021-12-15)
 
 ## What's Changed
 * Added Status Messages to logs for discoverDevices request.
+* Added Cached Status to IR device, Status will be saved to accessory context and restored on restart.
 * Added Option `Offline as Off` to be able set the device as off, if API reports offline.
+* Removed Meter Unit Config Option as it was confusing and probably never used.
 * Housekeeping and updated dependencies.
 
-**Full Changelog**: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.3.0...v1.3.1
+**Full Changelog**: https://github.com/OpenWonderLabs/homebridge-switchbot/compare/v1.3.0...v1.4.0
 
 ## [Version 1.3.0](https://github.com/OpenWonderLabs/homebridge-switchbot/releases/tag/v1.3.0) (2021-12-02)
 

package/config.schema.json

@@ -67,7 +67,7 @@
                   "title": "Offline as Off",
                   "type": "boolean",
                   "condition": {
-                    "functionBody": "return (model.options && model.options.devices && model.options.devices[arrayIndices].deviceId);"
+                    "functionBody": "return (model.options && model.options.devices && model.options.devices[arrayIndices].deviceId && !model.options.devices[arrayIndices].hide_device);"
                   }
                 },
                 "configDeviceType": {
@@ -204,27 +204,6 @@
                       "condition": {
                         "functionBody": "return (model.options && model.options.devices && !model.options.devices[arrayIndices].hide_device && model.options.devices[arrayIndices].configDeviceType === 'Meter' && model.options.devices[arrayIndices].deviceId);"
                       }
-                    },
-                    "unit": {
-                      "title": "Convert your Meter's Temperature to Celsius or Fahrenheit",
-                      "type": "number",
-                      "oneOf": [
-                        {
-                          "title": "Celsius",
-                          "enum": [
-                            0
-                          ]
-                        },
-                        {
-                          "title": "Fahrenheit",
-                          "enum": [
-                            1
-                          ]
-                        }
-                      ],
-                      "condition": {
-                        "functionBody": "return (model.options && model.options.devices && !model.options.devices[arrayIndices].hide_device && model.options.devices[arrayIndices].configDeviceType === 'Meter' && model.options.devices[arrayIndices].deviceId  && !model.options.devices[arrayIndices].meter.hide_temperature);"
-                      }
                     }
                   }
                 },
@@ -360,6 +339,43 @@
                       }
                     }
                   }
+                },
+                "refreshRate": {
+                  "title": "Device Refresh Rate",
+                  "type": "number",
+                  "minimum": 30,
+                  "placeholder": 360,
+                  "description": "Indicates the number of seconds between polls of SwitchBot API.",
+                  "condition": {
+                    "functionBody": "return (model.options && model.options.devices && model.options.devices[arrayIndices].deviceId && !model.options.devices[arrayIndices].hide_device);"
+                  }
+                },
+                "logging": {
+                  "title": "Device Logging Override Setting",
+                  "type": "string",
+                  "oneOf": [
+                    {
+                      "title": "Standard Logging",
+                      "enum": [
+                        "standard"
+                      ]
+                    },
+                    {
+                      "title": "No Logging",
+                      "enum": [
+                        "none"
+                      ]
+                    },
+                    {
+                      "title": "Debug Logging",
+                      "enum": [
+                        "debug"
+                      ]
+                    }
+                  ],
+                  "condition": {
+                    "functionBody": "return (model.options && model.options.devices && model.options.devices[arrayIndices].deviceId && !model.options.devices[arrayIndices].hide_device);"
+                  }
                 }
               }
             }
@@ -655,6 +671,33 @@
                       }
                     }
                   }
+                },
+                "logging": {
+                  "title": "Device Logging Override Setting",
+                  "type": "string",
+                  "oneOf": [
+                    {
+                      "title": "Standard Logging",
+                      "enum": [
+                        "standard"
+                      ]
+                    },
+                    {
+                      "title": "No Logging",
+                      "enum": [
+                        "none"
+                      ]
+                    },
+                    {
+                      "title": "Debug Logging",
+                      "enum": [
+                        "debug"
+                      ]
+                    }
+                  ],
+                  "condition": {
+                    "functionBody": "return (model.options && model.options.irdevices && model.options.irdevices[arrayIndices].deviceId && !model.options.irdevices[arrayIndices].hide_device);"
+                  }
                 }
               }
             }
@@ -672,21 +715,26 @@
             "placeholder": 1,
             "description": "Indicates the number of seconds between pushes to SwitchBot API."
           },
-          "debug": {
+          "logging": {
             "title": "Logging Setting",
             "type": "string",
-            "description": "Enable 'Device' or 'Debug' logging.",
             "oneOf": [
               {
-                "title": "Enable Debug Logging",
+                "title": "Standard Logging",
                 "enum": [
-                  "debug"
+                  "standard"
+                ]
+              },
+              {
+                "title": "No Logging",
+                "enum": [
+                  "none"
                 ]
               },
               {
-                "title": "Enable Device Logging",
+                "title": "Debug Logging",
                 "enum": [
-                  "device"
+                  "debug"
                 ]
               }
             ]
@@ -731,7 +779,6 @@
             "options.devices[].bot.deviceType",
             "options.devices[].meter.hide_temperature",
             "options.devices[].meter.hide_humidity",
-            "options.devices[].meter.unit",
             "options.devices[].humidifier.set_minStep",
             "options.devices[].humidifier.hide_temperature",
             "options.devices[].curtain.set_minStep",
@@ -745,7 +792,9 @@
             "options.devices[].contact.hide_lightsensor",
             "options.devices[].contact.hide_motionsensor",
             "options.devices[].colorbulb.set_minStep",
-            "options.devices[].colorbulb.adaptiveLightingShift"
+            "options.devices[].colorbulb.adaptiveLightingShift",
+            "options.devices[].refreshRate",
+            "options.devices[].logging"
           ]
         }
       ]
@@ -778,7 +827,8 @@
             "options.irdevices[].irtv.disable_power",
             "options.irdevices[].other.deviceType",
             "options.irdevices[].other.commandOn",
-            "options.irdevices[].other.commandOff"
+            "options.irdevices[].other.commandOff",
+            "options.irdevices[].logging"
           ]
         }
       ]
@@ -805,7 +855,7 @@
           "key": "options.pushRate",
           "notitle": true
         },
-        "options.debug"
+        "options.logging"
       ]
     }
   ]

package/dist/devices/bots.d.ts

@@ -15,6 +15,7 @@ export declare class Bot {
     private switchService?;
     private batteryService?;
     On: CharacteristicValue;
+    OnCached: CharacteristicValue;
     BatteryLevel: CharacteristicValue;
     StatusLowBattery: CharacteristicValue;
     deviceStatus: deviceStatusResponse;
@@ -24,11 +25,13 @@ export declare class Bot {
     mode: serviceData['mode'];
     state: serviceData['state'];
     battery: serviceData['battery'];
-    private readonly deviceDebug;
-    private readonly debugDebug;
+    deviceLogging: string;
+    deviceRefreshRate: number;
     botUpdateInProgress: boolean;
     doBotUpdate: Subject<void>;
     constructor(platform: SwitchBotPlatform, accessory: PlatformAccessory, device: device & devicesConfig);
+    refreshRate(): void;
+    logs(): void;
     /**
      * Parse the device status from the SwitchBot api
      */
@@ -57,11 +60,20 @@ export declare class Bot {
      * Updates the status for each of the HomeKit Characteristics
      */
     updateHomeKitCharacteristics(): void;
-    apiError(e: any): void;
+    apiError(): void;
     private statusCode;
+    private offlineOff;
     /**
      * Handle requests to set the "On" characteristic
      */
     private handleOnSet;
+    /**
+   * Logging for Device
+   */
+    infoLog(...log: any[]): void;
+    warnLog(...log: any[]): void;
+    errorLog(...log: any[]): void;
+    debugLog(...log: any[]): void;
+    enablingDeviceLogging(): boolean;
 }
 //# sourceMappingURL=bots.d.ts.map

package/dist/devices/bots.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"bots.d.ts","sourceRoot":"","sources":["../../src/devices/bots.ts"],"names":[],"mappings":"AAGA,OAAO,EAAY,OAAO,EAAE,MAAM,MAAM,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,OAAO,EAAW,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAC7E,OAAO,EAAa,MAAM,EAAE,aAAa,EAAE,WAAW,EAAM,SAAS,EAAE,oBAAoB,EAAW,MAAM,aAAa,CAAC;AAE1H;;;;GAIG;AACH,qBAAa,GAAG;IA+BZ,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,SAAS;IACV,MAAM,EAAE,MAAM,GAAG,aAAa;IA/BvC,OAAO,CAAC,aAAa,CAAC,CAAU;IAChC,OAAO,CAAC,aAAa,CAAC,CAAU;IAChC,OAAO,CAAC,cAAc,CAAC,CAAU;IAGjC,EAAE,EAAG,mBAAmB,CAAC;IACzB,YAAY,EAAG,mBAAmB,CAAC;IACnC,gBAAgB,EAAG,mBAAmB,CAAC;IAGvC,YAAY,EAAG,oBAAoB,CAAC;IAGpC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,EAAG,SAAS,CAAC;IACtB,WAAW,EAAG,WAAW,CAAC;IAC1B,IAAI,EAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAC3B,KAAK,EAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7B,OAAO,EAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IAGjC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA+E;IAC3G,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA8E;IAGzG,mBAAmB,EAAG,OAAO,CAAC;IAC9B,WAAW,EAAG,OAAO,CAAC,IAAI,CAAC,CAAC;gBAGT,QAAQ,EAAE,iBAAiB,EACpC,SAAS,EAAE,iBAAiB,EAC7B,MAAM,EAAE,MAAM,GAAG,aAAa;IAiHvC;;OAEG;IACG,WAAW;YAQH,cAAc;YAsBd,kBAAkB;IAgBhC;;OAEG;IACG,aAAa;IAQnB,OAAO,CAAC,UAAU;YAOJ,gBAAgB;YA4DhB,oBAAoB;IAiClC;;;;;;OAMG;IACG,WAAW;YAcH,cAAc;IAuD5B,OAAO,CAAC,SAAS;YAQH,kBAAkB;IA+ChC;;OAEG;IACH,4BAA4B;IA2BrB,QAAQ,CAAC,CAAC,EAAE,GAAG;IAYtB,OAAO,CAAC,UAAU;IAmClB;;OAEG;IACH,OAAO,CAAC,WAAW;CAKpB"}
+{"version":3,"file":"bots.d.ts","sourceRoot":"","sources":["../../src/devices/bots.ts"],"names":[],"mappings":"AAGA,OAAO,EAAY,OAAO,EAAE,MAAM,MAAM,CAAC;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,OAAO,EAAW,iBAAiB,EAAE,mBAAmB,EAAa,MAAM,YAAY,CAAC;AACxF,OAAO,EAAa,MAAM,EAAE,aAAa,EAAE,WAAW,EAAM,SAAS,EAAE,oBAAoB,EAAW,MAAM,aAAa,CAAC;AAE1H;;;;GAIG;AACH,qBAAa,GAAG;IAgCZ,OAAO,CAAC,QAAQ,CAAC,QAAQ;IACzB,OAAO,CAAC,SAAS;IACV,MAAM,EAAE,MAAM,GAAG,aAAa;IAhCvC,OAAO,CAAC,aAAa,CAAC,CAAU;IAChC,OAAO,CAAC,aAAa,CAAC,CAAU;IAChC,OAAO,CAAC,cAAc,CAAC,CAAU;IAGjC,EAAE,EAAG,mBAAmB,CAAC;IACzB,QAAQ,EAAG,mBAAmB,CAAC;IAC/B,YAAY,EAAG,mBAAmB,CAAC;IACnC,gBAAgB,EAAG,mBAAmB,CAAC;IAGvC,YAAY,EAAG,oBAAoB,CAAC;IAGpC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,EAAG,SAAS,CAAC;IACtB,WAAW,EAAG,WAAW,CAAC;IAC1B,IAAI,EAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAC3B,KAAK,EAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7B,OAAO,EAAG,WAAW,CAAC,SAAS,CAAC,CAAC;IAGjC,aAAa,EAAG,MAAM,CAAC;IACvB,iBAAiB,EAAG,MAAM,CAAC;IAG3B,mBAAmB,EAAG,OAAO,CAAC;IAC9B,WAAW,EAAG,OAAO,CAAC,IAAI,CAAC,CAAC;gBAGT,QAAQ,EAAE,iBAAiB,EACpC,SAAS,EAAE,iBAAiB,EAC7B,MAAM,EAAE,MAAM,GAAG,aAAa;IAyHvC,WAAW;IAQX,IAAI;IAUJ;;OAEG;IACG,WAAW;YAQH,cAAc;YAsBd,kBAAkB;IAgBhC;;OAEG;IACG,aAAa;IAQnB,OAAO,CAAC,UAAU;YAOJ,gBAAgB;YA4DhB,oBAAoB;IAiClC;;;;;;OAMG;IACG,WAAW;YAcH,cAAc;IA2D5B,OAAO,CAAC,SAAS;YAQH,kBAAkB;IAmDhC;;OAEG;IACH,4BAA4B;IA2BrB,QAAQ;IAIf,OAAO,CAAC,UAAU;IA+BlB,OAAO,CAAC,UAAU;IAWlB;;OAEG;IACH,OAAO,CAAC,WAAW;IAMnB;;KAEC;IACD,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE;IAMrB,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE;IAMrB,QAAQ,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE;IAMtB,QAAQ,CAAC,GAAG,GAAG,EAAE,GAAG,EAAE;IAUtB,qBAAqB,IAAI,OAAO;CAGjC"}