Add documentation for the new mochad platform

This commit adds documentation around the mochad and mochad switch
platforms which are added in home-assistant/home-assistant#3970
This commit is contained in:
Matthew Treinish 2016-10-20 21:26:11 -04:00
parent b5c7c6822d
commit 41c1825448
No known key found for this signature in database
GPG Key ID: FD12A0F214C9E177
2 changed files with 64 additions and 0 deletions

View File

@ -0,0 +1,32 @@
---
layout: page
title: "Mochad"
description: "Instructions how to integrate Mochad into Home Assistant."
date: 2016-10-20 17:09
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Hub
---
The Mochad component is the main component to integrate all X10 platforms being
controlled by [mochad](https://sourceforge.net/projects/mochad/). Besides this component you will have to setup your X10 devices separately.
```yaml
# Example configuration.yaml entry
mochad:
host: localhost
port: 1099
switch:
platform: mochad
devices:
- name: Light Switch
address: a1
```
Configuration variables:
- **host** (*Optional*): The host that mochad is running on, defaults to *localhost*
- **port** (*Optional*): The port that mochad is running on, defaults to *1099*

View File

@ -0,0 +1,32 @@
---
layout: page
title: "Mochad Switch"
description: "Instructions how to integrate X10 Mochad switches into Home Assistant."
date: 2016-10-20 21:13
sidebar: true
comments: false
sharing: true
footer: true
ha_category: Switch
ha_iot_class: depends
---
The `mochad` switch platform lets you control an X10 enabled switch device.
To enable this switch in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yml entry
switch:
- platform: mochad
devices:
- name: Switch A
address: a1
- name: Living Room Lamp
address: a5
```
Configuration variables:
- **name** (*Optional*): The name of the switch. Default is: x10_switch_dev_*address*
- **address** (*Required*): The X10 address of the switch