Skip to content

Commit 9e3ccea

Browse files
hthieryfabaff
authored andcommitted
Add documenation for LaCrosse platform (home-assistant#3829)
* add documenation for lacrosse component Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com> * fix documentation Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com> * change to new style Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com> * fix after changing to new style Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com> * renamed config value Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com> * Add configuration sample * Revert change * Add quotes
1 parent 88bc7d3 commit 9e3ccea

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed
Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
---
2+
layout: page
3+
title: "LaCrosse Sensor"
4+
description: "Instructions how to integrate LaCrosse sensor data received from Jeelink into Home Assistant."
5+
date: 2017-10-29 15:00
6+
sidebar: true
7+
comments: false
8+
sharing: true
9+
footer: true
10+
logo: home-assistant.png
11+
ha_category: Sensor
12+
ha_release: 0.58
13+
ha_iot_class: "Local Polling"
14+
---
15+
16+
The `lacrosse` sensor platform is using the data provided by a [Jeelink](https://www.digitalsmarties.net/products/jeelink) USB dongle or this [Arduino sketch](https://svn.fhem.de/trac/browser/trunk/fhem/contrib/arduino/36_LaCrosse-LaCrosseITPlusReader.zip).
17+
18+
#### {% linkable_title Tested Devices %}
19+
20+
- Technoline TX 29 IT (temperature only)
21+
- Technoline TX 29 DTH-IT (including humidity)
22+
23+
## {% linkable_title Setup %}
24+
25+
Since the sensor change their ID after each powercycle/battery change you can check what sensor IDs are availble by using the command-line tool `pylacrosse` from the pylacrosse package.
26+
27+
```bash
28+
$ sudo pylacrosse -D /dev/ttyUSB0 scan
29+
```
30+
To use your `lacrosse` compatible sensor in your installation, add the following to your `configuration.yaml` file:
31+
32+
```yaml
33+
# Example configuration.yaml entry
34+
sensor:
35+
- platform: lacrosse
36+
sensors:
37+
sensor_identifier:
38+
type: SENSOR_TYPE
39+
id: SENSOR_ID
40+
```
41+
42+
{% configuration %}
43+
device:
44+
description: The serial baudrate.
45+
required: true
46+
type: string
47+
default: /dev/ttyUSB0
48+
baud:
49+
description: The serial baudrate.
50+
required: true
51+
type: int
52+
default: 57600
53+
sensors:
54+
description: A list of your sensors.
55+
required: true
56+
type: map
57+
keys:
58+
name:
59+
description: The name of the sensor.
60+
required: false
61+
type: string
62+
type:
63+
description: "The type of the sensor. Options: `battery`, `humidity`, `temperature`"
64+
required: true
65+
type: string
66+
id:
67+
description: The LaCrosse Id of the sensor.
68+
required: true
69+
type: int
70+
{% endconfiguration %}
71+
72+
73+
## {% linkable_title Examples %}
74+
75+
To setup a lacrosse sensor with multiple sensors, add the following to your `configuration.yaml` file:
76+
77+
{% raw %}
78+
```yaml
79+
# Example configuration.yaml entry
80+
sensor:
81+
- platform: lacrosse
82+
device: /dev/ttyUSB0
83+
baud: 57600
84+
sensors:
85+
kitchen_humidity:
86+
name: Kitchen Humidity
87+
type: humidity
88+
id: 72
89+
kitchen_temperature:
90+
name: Kitchen Temperature
91+
type: temperature
92+
id: 72
93+
kitchen_lacrosse_battery:
94+
name: Kitchen Sensor Battery
95+
type: battery
96+
id: 72
97+
```
98+
{% endraw %}
99+

0 commit comments

Comments
 (0)