Add raspihats binary_sensor documentation (home-assistant#2574)

florincosta · fabaff · commit 9f3139e872b4 · 2017-05-20T22:51:29.000+02:00
* Add raspihats component documentation

* Added raspihats binary_sensor documentation

* Add raspihats switch documentation
diff --git a/source/_components/binary_sensor.raspihats.markdown b/source/_components/binary_sensor.raspihats.markdown
@@ -0,0 +1,47 @@
+---
+layout: page
+title: "Raspihats Binary Sensor"
+description: "Instructions how to integrate Raspihats add-on boards for Raspberry PI into Home Assistant as a binary_sensor."
+date: 2017-05-01 04:09
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: raspihats.png
+ha_category: Binary Sensor
+ha_release: 0.44
+ha_iot_class: "Local Push"
+---
+
+The `raspihats` binary sensor platform allows you to read sensor values ​​using the digital inputs of the [raspihats](http://www.raspihats.com/) boards.
+
+To use your `raspihats` boards in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+binary_sensor:
+  - platform: raspihats
+    i2c_hats:
+      - board: DI6acDQ6rly
+        address: 0x60
+        channels:
+          - index: 0
+            name: PIR Office
+            invert_logic: true
+            device_class: motion
+          - index: 1
+            name: PIR Bedroom
+```
+
+Configuration variables:
+
+- **i2c_hats** (*Optional*): Array of used I2C-HATs.
+  - **board** (*Required*): The board name [Di16, Di6Rly6, DI16ac, DI6acDQ6rly].
+  - **address** (*Required*): The board I2C address, hex value.
+    - **channels** (*Required*): Array of used digital input channels.
+      - **index** (*Required*): Digital input channel index.
+      - **name** (*Required*): Friendly name to use for the frontend.
+      - **invert_logic** (*Optional*): Inverts the input logic, default is `false`.
+      - **device_class** (*Optional*): See device classes in [binary_sensor component](/components/binary_sensor/), default is `None`
+
+For more details about the `raspihats` add-on boards for Raspberry PI, visit [raspihats.com](http://www.raspihats.com/).
diff --git a/source/_components/switch.raspihats.markdown b/source/_components/switch.raspihats.markdown
@@ -0,0 +1,47 @@
+---
+layout: page
+title: "Raspihats Switch"
+description: "Instructions how to integrate Raspihats add-on boards for Raspberry PI into Home Assistant as a switch."
+date: 2017-05-15 04:20
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: raspihats.png
+ha_category: Switch
+ha_release: 0.45
+---
+
+
+The `raspihats` switch platform allows you to control the digital outputs of your [raspihats](http://www.raspihats.com/) boards.
+
+To use your raspihats boards in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+switch:
+  - platform: raspihats
+    i2c_hats:
+      - board: DI6acDQ6rly
+        address: 0x60
+        channels:
+          - index: 0
+            name: Fan Office
+            invert_logic: true
+            initial_state: true
+          - index: 1
+            name: Light Office
+```
+
+Configuration variables:
+
+- **i2c_hats** (*Optional*): Array of used I2C-HATs.
+  - **board** (*Required*): The board name.
+  - **address** (*Required*): The board I2C address, hex value.
+    - **channels** (*Required*): Array of used digital output channels.
+      - **index** (*Required*): Digital output channel index.
+      - **name** (*Required*): Friendly name to use for the frontend.
+      - **invert_logic** (*Optional*): Inverts the output logic, default is `False`.
+      - **initial_state** (*Optional*): Initial state, default is `None`, can also be `True` or `False`. `None` means no state is forced on the corresponding digital output when this switch is instantiated.
+
+For more details about the Raspihats add-on boards for Raspberry PI, visit [raspihats.com](http://www.raspihats.com/).
