Skip to content

neurio documentation #226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 38 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
c3b117f
Add release 0.13 blog post
balloob Feb 13, 2016
cab04b3
Fix image
fabaff Feb 13, 2016
b4c58c3
Updated Samsung Smart TV
GreenTurtwig Feb 13, 2016
9b71b6b
Home Assistant logos
GreenTurtwig Feb 13, 2016
71d2cc4
Grammar
GreenTurtwig Feb 13, 2016
d744aed
SnapCast
GreenTurtwig Feb 13, 2016
6177212
Added my personal configuration.yaml
GreenTurtwig Feb 13, 2016
ada6c96
Rename
GreenTurtwig Feb 13, 2016
a352c40
Merge pull request #213 from balloob/release-blog-013
balloob Feb 13, 2016
95eaf29
Update configuration_yaml_by_greenturtwig.markdown
balloob Feb 13, 2016
ef1b58d
Update social image release 13
balloob Feb 13, 2016
f562357
Update social image name
balloob Feb 13, 2016
51ea3b8
Update weblink.markdown
Gerto Feb 13, 2016
0776330
Merge pull request #214 from Gerto/patch-2
balloob Feb 13, 2016
3ae83d8
Update 2016-02-13-speedtest-bloomsky-splunk-and-garage-doors.markdown
balloob Feb 14, 2016
f7e6b3c
Update device_tracker.icloud.markdown
Feb 14, 2016
0e36c27
Merge pull request #215 from winers1290/patch-1
balloob Feb 14, 2016
cb0b767
Add simple_alarm as cookbook recipe
balloob Feb 14, 2016
ae5f303
Added supported Samsung Smart TVs
GreenTurtwig Feb 14, 2016
acd6617
Update developer docs for using tox
kk7ds Feb 14, 2016
e7fd8ba
Update light.lifx.markdown
TangoAlpha Feb 14, 2016
12decec
Merge pull request #216 from kk7ds/update-dev-docs
balloob Feb 14, 2016
23cc48f
Merge pull request #217 from TangoAlpha/patch-1
balloob Feb 14, 2016
650cf3e
Removes screen size from model and adds supported model
aslansky Feb 14, 2016
2f17f64
Merge pull request #218 from aslansky/patch-2
balloob Feb 14, 2016
ff00bdb
Update media_player.samsungtv.markdown
GreenTurtwig Feb 14, 2016
133692c
Update media_player.kodi.markdown
balloob Feb 14, 2016
db4ad9c
Update mysensors main and light pages
MartinHjelmare Feb 15, 2016
a22a4bf
Merge pull request #220 from MartinHjelmare/update-mysensors-light
fabaff Feb 15, 2016
932ce73
Small update to verisure, and fix typo
persandstrom Feb 15, 2016
a3397eb
Merge pull request #222 from persandstrom/master
balloob Feb 15, 2016
071d330
Try to fix pages not showing by adding timezone
MartinHjelmare Feb 15, 2016
d7f5e44
Merge pull request #223 from MartinHjelmare/update-mysensors-light
balloob Feb 15, 2016
a3d4979
Less bold on frontpage hero unit
balloob Feb 15, 2016
5d2e333
fixed wink hub links
persandstrom Feb 15, 2016
ae2bbfc
Merge pull request #224 from persandstrom/wink_links
balloob Feb 15, 2016
2aba0bd
neurio documentation
infamy Feb 16, 2016
b850695
transparent logo
infamy Feb 16, 2016
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions sass/custom/_paulus.scss
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
text-transform: uppercase;
white-space: nowrap;
display: inline-block;
font-weight: bold;
}

.front-install {
Expand Down
1 change: 0 additions & 1 deletion sass/oscailte/homepage/_hero_unit.scss
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
background-size: cover;
border-bottom: 1px solid $white;
color: $white;
font-weight: bold;
margin-top: -2em;
margin-bottom: 1.5em;
padding: 50px 0;
Expand Down
2 changes: 1 addition & 1 deletion source/_components/browser.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: browser.png
logo: home-assistant.png
ha_category: Other
---

Expand Down
2 changes: 1 addition & 1 deletion source/_components/conversation.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: conversation.png
logo: home-assistant.png
ha_category: "Voice"
---

Expand Down
2 changes: 1 addition & 1 deletion source/_components/device_tracker.icloud.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ ha_category: Presence Detection

The `icloud` platform allows you to detect presence using the [iCloud](https://www.icloud.com/) service. iCloud allows users to track their location on iOS devices.

It does require that your device has beend registered with "Find My iPhone".
It does require that your device is registered with "Find My iPhone".

To integrate iCloud in Home Assistant, add the following section to your `configuration.yaml` file:

Expand Down
2 changes: 1 addition & 1 deletion source/_components/downloader.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: downloader.png
logo: home-assistant.png
ha_category: Other
---

Expand Down
2 changes: 1 addition & 1 deletion source/_components/garage_door.wink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ ha_category: Garage Door

The Wink garage door platform allows you to control your [Wink](http://www.wink.com/) enabled garage door.

The requirement is that you have setup your [Wink hub](/components/light.wink/).
The requirement is that you have setup your [Wink hub](/components/wink/).

2 changes: 1 addition & 1 deletion source/_components/light.lifx.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ light:
Configuration variables:

- **server** (*Optional*): Your server address. Only needed if using more than one network interface. Omit if you are unsure.
- **consumer_secret** (*Optional*): The broadcast address, set to reach all LIFX bulbs.
- **broadcast** (*Optional*): The broadcast address, set to reach all LIFX bulbs.

24 changes: 23 additions & 1 deletion source/_components/light.mysensors.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "MySensors Light"
description: "Instructions how to integrate MySensors lights into Home Assistant."
date: 2016-01-17 15:49
date: 2016-02-15 17:37 +0100
sidebar: true
comments: false
sharing: true
Expand All @@ -13,3 +13,25 @@ featured: false
---

Integrates MySensors lights into Home Assistant. See the [main component] for configuration instructions.

The following actuator types are supported:

##### MySensors version 1.4 and higher

S_TYPE | V_TYPE
---------|--------------
S_LIGHT | V_LIGHT
S_DIMMER | V_DIMMER

##### MySensors version 1.5 and higher

S_TYPE | V_TYPE
------------|-------------
S_LIGHT | V_STATUS
S_DIMMER | V_PERCENTAGE
S_RGB_LIGHT | V_RGB

For more information, visit the [serial api] of MySensors.

[main component]: /components/mysensors/
[serial api]: https://www.mysensors.org/download/serial_api_15
2 changes: 1 addition & 1 deletion source/_components/light.wink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ ha_category: Light

The wink light platform allows you to use your [Wink](http://www.wink.com/) lights.

The requirement is that you have setup your [Wink hub](/components/light.wink/).
The requirement is that you have setup your [Wink hub](/components/wink/).
2 changes: 1 addition & 1 deletion source/_components/lock.verisure.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: wink.png
logo: verisure.png
ha_category: Lock
---

Expand Down
2 changes: 1 addition & 1 deletion source/_components/media_player.kodi.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To add Kodi to your installation, add the following to your `configuration.yaml`
# Example configuration.yaml entry
media_player:
platform: kodi
host: 192.168.0.123
host: http://192.168.0.123
port: 8080
name: Kodi
user: USERNAME
Expand Down
26 changes: 21 additions & 5 deletions source/_components/media_player.samsungtv.markdown
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: page
title: "Samsung TV"
description: "Instructions how to integrate a Samsung TV in Home Assistant."
date: 2016-02-01 19:00
title: "Samsung Smart TV"
description: "Instructions on how to integrate a Samsung Smart TV into Home Assistant."
date: 2016-02-13 12:02
sidebar: true
comments: false
sharing: true
Expand All @@ -12,14 +12,30 @@ ha_category: Media Player
featured: false
---

The `samsungtv` platform allows you to control an [Samsung TV](http://www.samsung.com).
The `samsungtv` platform allows you to control a [Samsung Smart TV](http://www.samsung.com/uk/consumer/tv-audio-video/televisions/).

When the TV is first connected, you will need to accept Home Assistant on the TV to allow communication.

To add an Samsung TV to your installation, add the following to your `configuration.yaml` file:
To add a TV to your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
media_player:
platform: samsungtv
host: 192.168.0.10
name: Living Room TV
```

Configuration variables:

- **host** *Required*: The IP of the Samsung Smart TV, e.g. 192.168.0.10
- **name** *Optional*: The name you would like to give to the Samsung Smart TV.


Currently known supported models:

- ES5500
- C7700

If your model is not on the list then give it a test, if everything works correctly then add it to the list on [GitHub](https://github.com/balloob/home-assistant.io).
The two letters at the beginning of the model number represent the region, UE is Europe, UN is North America and UA is Asia & Australia. The two numbers following that represent the screen size. If you add your model remember to remove these before adding them to the list.
8 changes: 4 additions & 4 deletions source/_components/media_player.snapcast.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "snapcast"
description: "Instructions how to integrate a snapcast in Home Assistant."
title: "SnapCast"
description: "Instructions on how to integrate SnapCast into Home Assistant."
date: 2016-02-01 19:00
sidebar: true
comments: false
Expand All @@ -12,9 +12,9 @@ ha_category: Media Player
featured: false
---

The `snapcast` platform allows you to control [Snapcast](https://github.com/badaix/snapcast).
The `snapcast` platform allows you to control [SnapCast](https://github.com/badaix/snapcast) from Home Assistant.

To add Snapcast to your installation, add the following to your `configuration.yaml` file:
To add SnapCast to your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
Expand Down
10 changes: 5 additions & 5 deletions source/_components/mysensors.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "MySensors"
description: "Instructions how to integrate MySensors sensors into Home Assistant."
date: 2015-05-14 21:57
date: 2016-02-15 17:37 +0100
sidebar: true
comments: false
sharing: true
Expand All @@ -12,9 +12,9 @@ ha_category: Hub
featured: true
---

The [MySensors](https://www.mysensors.org) project combines Arduino boards with NRF24L01 radio boards to build sensor networks. The component will automatically add all available switches and sensors to Home Assistant.
The [MySensors](https://www.mysensors.org) project combines Arduino boards with NRF24L01 radio boards to build sensor networks. The component will automatically add all available devices to Home Assistant, after [presentation](#presentation) is done.

### Configuration
### {% linkable_title Configuration %}

Integrate your Serial MySensors Gateway by adding the following to your `configuration.yaml` file:

Expand All @@ -40,15 +40,15 @@ Configuration variables:
- **persistence** (*Optional*): Enable or disable local persistence of sensor information. If this is disabled, then each sensor will need to send presentation messages after Home Assistant starts. Default is true.
- **persistence_file** (*Optional*): Path to a file to save sensor information. The file extension determines the file type. Currently supported file types are 'pickle' and 'json'.
- **version** (*Optional*): Specifies the MySensors protocol version to use. Supports 1.4 and 1.5. Default is 1.4.
- **baud_rate** (*Optional*): Specifies baud rate of the connected gateway.
- **baud_rate** (*Optional*): Specifies baud rate of the connected gateway. Default is 115200.

If you are using an original Arduino the port will be named `ttyACM*`. The exact number can be determined with the command shown below.

```bash
$ ls /dev/ttyACM*
```

### Presentation
### {% linkable_title Presentation %}

Present a MySensors sensor or actuator, by following these steps:

Expand Down
30 changes: 30 additions & 0 deletions source/_components/sensor.neurio_energy.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
layout: page
title: "Neurio"
description: "Instructions how to integrate Neurio within Home Assistant."
date: 2016-02-15 21:50
sidebar: true
comments: false
sharing: true
footer: true
logo: neurio.png
ha_category: Sensor
---


Integrate your [Neurio](http://neur.io/) meter information into Home Assistant. To get an API key and secret, login to your Neurio account at https://my.neur.io/#settings/applications/register and register an application. Note the Homepage URL and Callback URL are optional.

```yaml
# Example configuration.yaml entry
sensor:
platform: neurio_energy
api_key: API_KEY
api_secret: API_SECRET
sensor_id: "SENSOR_ID"
```

Configuration variables:

- **api_key** (*Required*): The API key for your account/application.
- **api_secret** (*Required*): The API secret for your account/application.
- **sensor_id** (*Optional*): Sensor ID, will be auto-detected but can be set if you have more then one sensor.
8 changes: 4 additions & 4 deletions source/_components/sensor.speedtest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ featured: false

The `speedtest` sensor component uses the [Speedtest.net](https://speedtest.net/) web service to measure network bandwidth performance.

By default, it will run every hour on the hour. The user can change the update frequency in the config by defining the minute, hour, and day for speedtest to run.
By default, it will run every hour. The user can change the update frequency in the config by defining the minute, hour, and day for a speedtest to run.

To add speedtest.net sensors to your installation, add the following to your `configuration.yaml` file:
To add a Speedtest.net sensor to your installation, add the following to your `configuration.yaml` file:

Once per hour, on the hour (default):

Expand Down Expand Up @@ -65,11 +65,11 @@ sensor:
Configuration variables:

- **monitored_conditions** array (*Required*): Sensors to display in the frontend.
- **ping**: Reaction time in ms of your connectionhow fast you get a response after you've sent out a request.
- **ping**: Reaction time in ms of your connection, (how fast you get a response after you've sent out a request).
- **download**: Download speed in Mbps.
- **upload**: Upload speed in Mbps.
- **minute** (*Optional*): Specify the minute(s) of the hour to schedule the speedtest. Use a list for multiple entries. Default is 0.
- **hour** (*Optional*): Specify the hour(s) of the day to schedule the speedtest. Use a list for multiple entries. Default is None.
- **day** (*Optional*): Specify the day(s) of the month to schedule the speedtest. Use a list for multiple entries. Default is None.

This component uses [speetest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display.
This component uses [speetest-cli](https://github.com/sivel/speedtest-cli) to gather network performance data from Speedtest.net. Please be aware of the potential [inconsistencies](https://github.com/sivel/speedtest-cli#inconsistency) that this component may display.
1 change: 1 addition & 0 deletions source/_components/sensor.time_date.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
---

Expand Down
2 changes: 1 addition & 1 deletion source/_components/sensor.wink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ ha_category: Sensor

The Wink sensor platform allows you to get data from your [Wink](http://www.wink.com/) sensors.

The requirement is that you have setup your [Wink hub](/components/light.wink/).
The requirement is that you have setup your [Wink hub](/components/wink/).

1 change: 1 addition & 0 deletions source/_components/sensor.worldclock.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: home-assistant.png
ha_category: Sensor
---

Expand Down
4 changes: 2 additions & 2 deletions source/_components/simple_alarm.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ simple_alarm:

Configuration variables:

- **known_light** (*Required*): Which light/light group has to flash when a known device comes home.
- **unknown_light** (*Required*): Which light/light group has to flash red when light turns on while no one home.
- **known_light** (*Optional*): Which light/light group has to flash when a known device comes home.
- **unknown_light** (*Optional*): Which light/light group has to flash red when light turns on while no one home.

2 changes: 1 addition & 1 deletion source/_components/sun.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: sun.png
logo: home-assistant.png
ha_category: Weather
---

Expand Down
4 changes: 1 addition & 3 deletions source/_components/switch.mysensors.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
layout: page
title: "MySensors Switch"
description: "Instructions how to integrate MySensors switches into Home Assistant."
date: 2016-01-17 15:49
date: 2016-02-15 20:49 +0100
sidebar: true
comments: false
sharing: true
Expand All @@ -23,14 +23,12 @@ S_TYPE | V_TYPE
S_DOOR | V_ARMED
S_MOTION | V_ARMED
S_SMOKE | V_ARMED
S_LIGHT | V_LIGHT
S_LOCK | V_LOCK_STATUS

##### MySensors version 1.5 and higher

S_TYPE | V_TYPE
-------------|------------------
S_LIGHT | V_STATUS
S_BINARY | V_STATUS, V_LIGHT
S_SPRINKLER | V_STATUS
S_WATER_LEAK | V_ARMED
Expand Down
2 changes: 1 addition & 1 deletion source/_components/switch.wink.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ ha_category: Switch

The Wink switch platform allows you to control your [Wink](http://www.wink.com/) switches.

The requirement is that you have setup your [Wink hub](/components/light.wink/).
The requirement is that you have setup your [Wink hub](/components/wink/).

2 changes: 1 addition & 1 deletion source/_components/updater.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar: true
comments: false
sharing: true
footer: true
logo: updater.png
logo: home-assistant.png
ha_category: Other
---

Expand Down
4 changes: 2 additions & 2 deletions source/_components/verisure.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Home Assistant has support to integrate your [Verisure](https://www.verisure.com

We support:

* Alarm
* Smartplugs
* Reading from thermometers and hygrometers integrated in various devices
* Reading alarm status
* Locks

To integrate Verisure with Home Assistant, add the following section to your `configuration.yaml` file:
Expand All @@ -44,7 +44,7 @@ Configuration variables:
- **alarm** (*Optional*): Set to 1 to show alarm, 0 to disable. Default 1.
- **hygrometers** (*Optional*): Set to 1 to show hygrometers, 0 to disable. Default 1.
- **smartplugs** (*Optional*): Set to 1 to show smartplugs, 0 to disable. Default 1.
- **locls** (*Optional*): Set to 1 to show locks, 0 to disable. Default 1.
- **locks** (*Optional*): Set to 1 to show locks, 0 to disable. Default 1.
- **thermometers** (*Optional*): Set to 1 to show thermometers, 0 to disable. Default 1.
- **code_digits** (*Optional*): Number of digits in PIN code. Default 4.

Loading