Created new documentation for GC100 component and platforms (home-assistant#3789)

davegravy · fabaff · commit 0582ebc39ed1 · 2017-10-30T08:40:22.000+01:00
* Create gc100.markdown

* Create binary_sensor.gc100.markdown

* Create switch.gc100.markdown

* Fixed formatting of configuration variables

* Elaborated on what gc100 is

* Implemented fabaff's requested changes

removed blank line, updated yaml example to be a list of ports, added period to ports parameter description.

* Implemented changes requested by fabaff

removed blank line, fixed yaml format, added period to ports parameter description

* Fixed ha_release and ha_category

* Fixed ha_release and ha_category

* Implemented changes requested by fabaff.

fixed ha_release and added parameters.

* Updated introduciton description

Implemented suggestion by upsert and referenced iTach library.
diff --git a/source/_components/binary_sensor.gc100.markdown b/source/_components/binary_sensor.gc100.markdown
@@ -0,0 +1,29 @@
+---
+layout: page
+title: gc100 Binary Sensor
+description: "Instructions on how to set up an gc100 binary sensor within Home Assistant."
+date: 2017-10-27 17:26
+sidebar: true
+comments: false
+sharing: true
+footer: true
+ha_category: Binary Sensor
+ha_release: 0.57
+ha_iot_class: "Local Polling"
+---
+
+To enable this sensor, you first have to set up [gc100](/components/gc100/), and add the following lines to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+binary_sensor:
+  - platform: gc100
+    ports:
+      - '3:1': Doorchime
+      - '3:2': Garage Obstruction
+```
+
+Configuration variables:
+
+- **ports** (*Required*): A list of module-address to name mappings in the format 'x:y': name, where x is module #, y is address.
+
diff --git a/source/_components/gc100.markdown b/source/_components/gc100.markdown
@@ -0,0 +1,31 @@
+---
+layout: page
+title: "gc100"
+description: "Instructions on how to integrate gc100 with Home Assistant."
+date: 2017-10-26 17:20
+sidebar: true
+comments: false
+sharing: true
+footer: true
+ha_category: Hub
+ha_release: 0.57
+---
+
+The Global Caché [GC-100](https://www.globalcache.com/products/gc-100/) can be integrated into Home Assistant. GC-100 is a TCP-controllable
+hardware device which has an array of relays, RS232 serial ports, and flexible ports which can be programmed to be either digital inputs or IR blaster outputs. There are a variety of submodels of the GC-100 which have different amounts of each I/O type.
+
+Currently, only relays and ports configured to be digital inputs are supported in Home Assistant. For IR support, please use the iTach remote platform (https://home-assistant.io/components/remote.itach/), but note that it will likely not function concurrently on the same GC100 due to limitations in the TCP socket server implementation used by Global Caché.
+
+To enable this device, add the following lines to your `configuration.yaml`:
+
+```yaml
+# Example configuration.yaml entry
+gc100:
+  host: 192.168.1.114
+  port: 4998
+```
+
+Configuration variables:
+
+- **host** (*Required*): The hostname/IP address of your GC100 device.
+- **port** (*Optional*): The port on which the GC100 is listening.
diff --git a/source/_components/switch.gc100.markdown b/source/_components/switch.gc100.markdown
@@ -0,0 +1,31 @@
+---
+layout: page
+title: gc100 Switch
+description: "Instructions on how to set up an gc100 switch within Home Assistant."
+date: 2017-10-27 17:26
+sidebar: true
+comments: false
+sharing: true
+footer: true
+ha_category: Switch
+ha_release: 0.57
+ha_iot_class: "Local Polling"
+---
+
+This allows you to control and monitor the relay state on your GC100.
+
+To enable this switch, you first have to set up [gc100](/components/gc100/), and add the following lines to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+switch:
+  - platform: gc100
+    ports:
+      - '4:1': Siren
+      - '4:2': Sprinkler
+```
+
+Configuration variables:
+
+- **ports** (*Required*): A list of module-address to name mappings in the format 'x:y': name, where x is module #, y is address.
+
