Add support for sliders with steps

grover · Feb 21, 2018 · cb38200 · cb38200
1 parent 6ab26af
commit cb38200
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 2 deletions.
diff --git a/docs/Slider.md b/docs/Slider.md
@@ -45,9 +45,40 @@ A slider can accept a value between a minimum and a maximum bound. The default v
 | stored | No | Set this to true if you want the slider to retain its value across restarts. The default setting for the ```slider``` type is  ```false```. |
 | minValue | Yes | Sets the minimum boundary of the slider. |
 | maxValue | Yes | Sets the maximum boundary of the slider. |
+| minStep | No | The minimum step between values of the slider. The default is 1. |
 
 See [configuration](Configuration.md) for more advanced configuration examples.
 
-# Restrictions
+## Restrictions
 
 The slider is not useable in the official Apple Home app as it makes use of a custom service and characteristic.
+
+## Examples
+
+### Slider with steps
+
+```json
+{
+  "bridge": {
+      ...
+  },
+  "platforms": [
+    {
+      "platform": "AutomationSwitches",
+      "switches": [
+        {
+          "type": "slider",
+          "name": "My basic slider",
+          "stored": true,
+          "default": 5,
+          "minValue": 0,
+          "maxValue": 10,
+          "minStep": 2
+        }
+      ]
+    }
+  ]
+}
+```
+
+![Preview](SliderWithSteps.png "Preview of Slider with steps")
diff --git a/docs/SliderWithSteps.png b/docs/SliderWithSteps.png
diff --git a/examples/slider/config.json b/examples/slider/config.json
@@ -16,6 +16,15 @@
           "default": 5,
           "minValue": 1,
           "maxValue": 10
+        },
+        {
+          "type": "slider",
+          "name": "Example Slider with step 2",
+          "stored": true,
+          "default": 4,
+          "minValue": 0,
+          "maxValue": 10,
+          "minStep": 2
         }
       ]
     }

diff --git a/src/SliderAccessory.js b/src/SliderAccessory.js
@@ -64,9 +64,13 @@ class SliderAccessory {
 
     const props = {
       minValue: this.config.minValue,
-      maxValue: this.config.maxValue,
+      maxValue: this.config.maxValue
     };
 
+    if (this.config.minStep !== undefined) {
+      props.minStep = this.config.minStep;
+    }
+
     this._sliderService.getCharacteristic(Characteristic.SliderValue)
       .on('set', this._setValue.bind(this))
       .setProps(props)