orvibo doc (#846)

* orvibo doc

* switch->socket
This commit is contained in:
happyleavesaoc 2016-09-04 05:43:52 -04:00 committed by Fabian Affolter
parent 0da1ee9f55
commit 8208143432

View File

@ -1,7 +1,7 @@
---
layout: page
title: "Orvibo Switch"
description: "Instructions how to integrate Orvibo switches within Home Assistant."
description: "Instructions how to integrate Orvibo sockets within Home Assistant."
date: 2015-11-15 18:15
sidebar: true
comments: false
@ -11,20 +11,32 @@ logo: orvibo.png
ha_category: Switch
---
The `orvibo` switch platform allows you to toggle your Orvibo S20 Wifi Smart Switch.
The `orvibo` switch platform allows you to toggle your Orvibo S20 Wifi Smart Sockets.
To use your Orvibo switch in your installation, add the following to your `configuration.yaml` file:
To automatically discover Orvibo sockets on your network:
```yaml
# Example configuration.yaml entry
switch:
platform: orvibo
host: IP_ADDRESS
mac: MA:CA:DD:RE:SS:00
```
To specify Orvibo sockets and skip discovery:
```yaml
switch:
platform: orvibo
discovery: false
switches:
- host: IP_ADDRESS
mac: MA:CA:DD:RE:SS:00
name: "My Socket"
```
Configuration variables:
- **host** (*Required*): IP address of your switch, eg. 192.168.1.10.
- **mac** (*Optional*): MAC address of the switch, eg "AA:BB:CC:DD:EE:FF". This is required if the switch is connected to a different subnet to the machine running Home Assistant
- **discovery** (*Optional*): Whether to discover sockets (default true).
- **switches** (*Optional*):
- **host** (*Required*): IP address of your socket, eg. 192.168.1.10.
- **mac** (*Optional*): MAC address of the socket, eg "AA:BB:CC:DD:EE:FF". This is required if the socket is connected to a different subnet to the machine running Home Assistant
- **name** (*Optional*): Your name for the socket.