noDockOnStop -> DockOnStop

Resolves #73, merges #74

commit 478c293
Author: rcoletti116 <[email protected]>
Date:   Fri Sep 24 15:42:44 2021 -0400

    attempt to fix readme

commit 65b5fa3
Author: rcoletti116 <[email protected]>
Date:   Fri Sep 24 15:22:31 2021 -0400

    Update config.schema.json

commit 22cd135
Author: rcoletti116 <[email protected]>
Date:   Fri Sep 24 10:45:37 2021 -0400

    Update README.md

commit 30e8b31
Author: rcoletti116 <[email protected]>
Date:   Fri Sep 24 10:40:24 2021 -0400

    Update README.md

commit 667730f
Author: rcoletti116 <[email protected]>
Date:   Fri Sep 24 10:37:11 2021 -0400

    Update config.schema.json

commit 48cd769
Author: rcoletti116 <[email protected]>
Date:   Fri Sep 24 10:32:33 2021 -0400

    Update README.md

commit 01a3082
Author: Karl von Randow <[email protected]>
Date:   Sat Sep 25 10:54:33 2021 +1200

    Update README.md

commit 3fe2ccc
Author: rcoletti116 <[email protected]>
Date:   Fri Sep 24 10:31:28 2021 -0400

    Update ReadMe

commit 26d32f3
Author: rcoletti116 <[email protected]>
Date:   Fri Sep 24 10:27:54 2021 -0400

    Update readmne

commit 72df304
Author: Karl von Randow <[email protected]>
Date:   Sat Sep 25 10:53:26 2021 +1200

    Only update Characteristics with changes

commit 39cdc96
Author: Karl von Randow <[email protected]>
Date:   Sat Sep 25 10:51:49 2021 +1200

    Update Config Docs

commit 9a0bafa
Author: rcoletti116 <[email protected]>
Date:   Fri Sep 24 10:00:09 2021 -0400

    make dockOnStop default true w/o configschema

commit ea22cc8
Author: rcoletti116 <[email protected]>
Date:   Thu Sep 23 16:17:01 2021 -0400

    revert order of callback & mergeCahedStatus

commit 634eb40
Author: rcoletti116 <[email protected]>
Date:   Thu Sep 23 15:27:39 2021 -0400

    lower case 'dock'

commit 2d8af4c
Author: rcoletti116 <[email protected]>
Date:   Thu Sep 23 15:26:11 2021 -0400

    lower case 'dock'

commit 1c70969
Author: rcoletti116 <[email protected]>
Date:   Thu Sep 23 15:25:09 2021 -0400

    lower case 'dock'

commit 7e0f964
Author: rcoletti116 <[email protected]>
Date:   Thu Sep 23 12:27:02 2021 -0400

    noDockOnStop -> DockOnStop

commit 0a6a9f4
Author: rcoletti116 <[email protected]>
Date:   Thu Sep 23 12:23:20 2021 -0400

    Reverse noDockOnStop to DockOnStop

commit cf06343
Author: rcoletti116 <[email protected]>
Date:   Thu Sep 23 11:29:24 2021 -0400

    Reverse noDockOnStop tp DockOnStop

    DockOnStop = true will now send the robot home on stop. This is the default value.

commit 9fd8704
Author: rcoletti116 <[email protected]>
Date:   Thu Sep 23 11:28:10 2021 -0400

    Reverse noDockOnStop function to DockOnStop

    No uses positive languages to indicate DockOnStop. If True (Default), Roomba will return home when stopped.

Author: karlvr

.changeset/khaki-suits-reply.md

@@ -0,0 +1,5 @@
+---
+"homebridge-roomba2": minor
+---
+
+Rename noDockOnStop to dockOnStop [#73 #74] (thanks @rcoletti116, @khad)

README.md

@@ -67,24 +67,25 @@ configure your accessory using JSON:
   "ipaddress": "192.168.x.xxx",
   "dockContactSensor": true,
   "runningContactSensor": true,
-  "binContactSensor": true
+  "binContactSensor": true,
+  "dockOnStop": true
 }
 ```
 
-|Key|Description|
-|---|-----------|
-|`accessory`|Loads this plugin. Must be set to `Roomba2`|
-|`name`|The name of your Roomb as it should appear in Homebridge and HomeKit|
-|`model`|The model of your Roomba as you'd like it to appear in HomeKit|
-|`serialnum`|The serial number as you'd like it to appear in HomeKit|
-|`blid`|The `blid` of your Roomba, obtained during setup|
-|`robotpwd`|The password for your Roomba, obtained during setup|
-|`ipaddress`|The IP address of your Roomba on your network|
-|`dockContactSensor`|Add a contact sensor to HomeKit that's _closed_ when Roomba is docked|
-|`runningContactSensor`|Add a contact sensor to HomeKit that's _open_ when Roomba is running|
-|`binContactSensor`|Add a contact sensor to HomeKit that's _open_ when Roomba's bin is full|
-|`dockingContactSensor`|Add a contact sensor to HomeKit that's _open_ when Roomba is docking|
-|`noDockOnStop`|Do not send home when stopped|
+|Key|Description|Default Value|
+|---|-----------|---|
+|`accessory`|Loads this plugin. Must be set to `Roomba2`||
+|`name`|The name of your Roomb as it should appear in Homebridge and HomeKit||
+|`model`|The model of your Roomba as you'd like it to appear in HomeKit||
+|`serialnum`|The serial number as you'd like it to appear in HomeKit||
+|`blid`|The `blid` of your Roomba, obtained during setup||
+|`robotpwd`|The password for your Roomba, obtained during setup||
+|`ipaddress`|The [IP address](#troubleshooting) of your Roomba on your network||
+|`dockContactSensor`|Add a contact sensor to HomeKit that's _closed_ when Roomba is docked|`true`|
+|`runningContactSensor`|Add a contact sensor to HomeKit that's _open_ when Roomba is running|`false`|
+|`binContactSensor`|Add a contact sensor to HomeKit that's _open_ when Roomba's bin is full|`false`|
+|`dockingContactSensor`|Add a contact sensor to HomeKit that's _open_ when Roomba is docking|`false`|
+|`dockOnStop`|Send home to dock when stopped|`true`|
 
 ### Deprecated configuration
 

config.schema.json

@@ -55,9 +55,10 @@
                 "title": "Show docking status as a contact sensor",
                 "required": false
             },
-            "noDockOnStop": {
+            "dockOnStop": {
                 "type": "boolean",
-                "title": "Do not send home when stopped",
+                "title": "Dock when stopped",
+                "default": true,
                 "required": false
             }
         }

src/accessory.ts

@@ -81,7 +81,7 @@ export default class RoombaAccessory implements AccessoryPlugin {
     private robotpwd: string
     private ipaddress: string
     private firmware: string
-    private noDockOnStop: boolean
+    private dockOnStop: boolean
 
     private accessoryInfo: Service
     private filterMaintenance: Service
@@ -133,7 +133,7 @@ export default class RoombaAccessory implements AccessoryPlugin {
         this.robotpwd = config.robotpwd;
         this.ipaddress = config.ipaddress;
         this.firmware = "N/A";
-        this.noDockOnStop = config.noDockOnStop;
+        this.dockOnStop = config.dockOnStop !== undefined ? config.dockOnStop : true;
 
         const showDockAsContactSensor = config.dockContactSensor === undefined ? true : config.dockContactSensor;
         const showRunningAsContactSensor = config.runningContactSensor;
@@ -456,8 +456,7 @@ export default class RoombaAccessory implements AccessoryPlugin {
                             charging: false,
                             docking: false,
                         });
-
-                        if (!this.noDockOnStop) {
+                        if (this.dockOnStop) {
                             this.log("Roomba paused, returning to Dock");
                             await this.dockWhenStopped(roomba, 3000);
                         } else {