Skip to content

Commit 68e50b5

Browse files
ludeeusludeeus
authored
tellstick: Split documentation (home-assistant#1300)
1 parent ee05175 commit 68e50b5

File tree

2 files changed

+168
-165
lines changed

2 files changed

+168
-165
lines changed

‎tellstick/DOCS.md

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
# Home Assistant Add-on: TellStick
2+
3+
## Installation
4+
5+
Follow these steps to get the add-on installed on your system:
6+
7+
1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
8+
2. Find the "TellStick" add-on and click it.
9+
3. Click on the "INSTALL" button.
10+
11+
## How to use
12+
13+
### Starting the add-on
14+
15+
After installation you are presented with a default and example configuration,
16+
to alter this you must follow both the JSON format and also be aligned with
17+
the [valid parameters for Tellstick configuration file (tellstick.conf)][conf].
18+
19+
1. Adjust the add-on configuration to match your devices. See the add-on
20+
configuration options below for more details.
21+
2. Save the add-on configuration by clicking the "SAVE" button.
22+
3. Start the add-on.
23+
24+
### Home Assistant integration
25+
26+
You will need to add internal communication details to the `configuration.yaml`
27+
file to enable the integration with the add-on.
28+
29+
```yaml
30+
# Example configuration.yaml entry
31+
tellstick:
32+
host: core-tellstick
33+
port: [50800, 50801]
34+
```
35+
36+
To add lights, sensors and switches to Home Assistant, you need to follow the
37+
guidelines for each type individually that is described for Home Assistant.
38+
39+
For more information, check the Home Assistant documentation:
40+
41+
<https://www.home-assistant.io/components/tellstick/>
42+
43+
## Configuration
44+
45+
After installation you are presented with a default and example configuration,
46+
to alter this you must follow both the JSON format and also be aligned with
47+
the [valid parameters for Tellstick configuration file (tellstick.conf)][conf].
48+
49+
Example add-on configuration:
50+
51+
```yaml
52+
devices:
53+
- id: 1
54+
name: Example device
55+
protocol: everflourish
56+
model: selflearning-switch
57+
house: A
58+
unit: '1'
59+
- id: 2
60+
name: Example device two
61+
protocol: everflourish
62+
model: selflearning-switch
63+
house: A
64+
unit: '2'
65+
```
66+
67+
Please note: After any changes have been made to the configuration,
68+
you need to restart the add-on for the changes to take effect.
69+
70+
### Option: `devices` (required)
71+
72+
Add one or more devices entries to the add-on configuration for each
73+
device you'd like to add. Please note the comma separator between each
74+
device (see example above).
75+
76+
#### Option: `devices.id` (required)
77+
78+
A unique number / identifier that must be unique for each device.
79+
80+
#### Option: `devices.name` (required)
81+
82+
A name for your device, making it easier to identify it.
83+
84+
#### Option: `devices.protocol` (required)
85+
86+
This is the protocol the device uses. For a full list of supported protocols
87+
(and thus valid values for this configuration option), check the
88+
TellStick [protocol list][protocol-list].
89+
90+
#### Option: `devices.model` (optional)
91+
92+
The model parameter is only used by some protocols where there exists different
93+
types of devices using the same protocol. This can be dimmers versus non-dimmers,
94+
codeswitch versus self-learning, etc.
95+
96+
#### Option: `devices.house` (optional)
97+
98+
Depending on protocol the values here can vary a lot to identify
99+
or group per house or type.
100+
101+
#### Option: `devices.unit` (optional)
102+
103+
Unit identifier, in most cases a value between 1 to 16 and often used in
104+
combination with the house.
105+
106+
#### Option: `devices.fade` (optional)
107+
108+
Fade is either `true` or `false` and tells a dimmer if it should fade smooth
109+
or instant between values (only for IKEA protocol as it seems).
110+
111+
#### Option: `devices.code` (optional)
112+
113+
A number series based on ones and zeroes often used for dip-switch based devices.
114+
115+
## Service calls
116+
117+
If you wish to teach a self-learning device in your TellStick configuration:
118+
119+
Go to Home Assistant service call in Developer tools and select:
120+
121+
- Service: `hassio.addon_stdin`
122+
- Enter service Data:
123+
`{"addon":"core_tellstick","input":{"function":"learn","device":"1"}}`
124+
125+
Replace `1` with the corresponding ID of the device in your TellStick configuration.
126+
127+
You can also use this to list devices or sensors and read the output in the
128+
add-on log: `{"addon":"core_tellstick","input":{"function":"list-sensors"}}`
129+
130+
### Supported service commands
131+
132+
- `"function":"list"`
133+
List currently configured devices with name and device id and all discovered sensors.
134+
135+
- `"function":"list-sensors"`
136+
137+
- `"function":"list-devices"`
138+
Alternative devices/sensors listing: Shows devices and/or sensors using key=value
139+
format (with tabs as separators, one device/sensor per line, no header lines.)
140+
141+
- `"function":"on","device":"x"`
142+
Turns on device. ’x’ could either be an integer of the device-id,
143+
or the name of the device.
144+
145+
- `"function":"off","device":"x"`
146+
Turns off device. ’x’ could either be an integer of the device-id,
147+
or the name of the device.
148+
149+
## Support
150+
151+
Got questions?
152+
153+
You have several options to get them answered:
154+
155+
- The [Home Assistant Discord Chat Server][discord].
156+
- The Home Assistant [Community Forum][forum].
157+
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
158+
159+
In case you've found a bug, please [open an issue on our GitHub][issue].
160+
161+
[conf]: http://developer.telldus.com/wiki/TellStick_conf
162+
[discord]: https://discord.gg/c5DvZ4e
163+
[forum]: https://community.home-assistant.io
164+
[issue]: https://github.com/home-assistant/hassio-addons/issues
165+
[protocol-list]: http://developer.telldus.com/wiki/TellStick_conf
166+
[reddit]: https://reddit.com/r/homeassistant
167+
[repository]: https://github.com/hassio-addons/repository

‎tellstick/README.md

Lines changed: 1 addition & 165 deletions
Original file line numberDiff line numberDiff line change
@@ -16,173 +16,9 @@ work with TellStick.
1616

1717
For more details, please check the TellStick [protocol list][protocol-list].
1818

19-
## Installation
20-
21-
Follow these steps to get the add-on installed on your system:
22-
23-
1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
24-
2. Find the "TellStick" add-on and click it.
25-
3. Click on the "INSTALL" button.
26-
27-
## How to use
28-
29-
### Starting the add-on
30-
31-
After installation you are presented with a default and example configuration,
32-
to alter this you must follow both the JSON format and also be aligned with
33-
the [valid parameters for Tellstick configuration file (tellstick.conf)][conf].
34-
35-
1. Adjust the add-on configuration to match your devices. See the add-on
36-
configuration options below for more details.
37-
2. Save the add-on configuration by clicking the "SAVE" button.
38-
3. Start the add-on.
39-
40-
### Home Assistant integration
41-
42-
You will need to add internal communication details to the `configuration.yaml`
43-
file to enable the integration with the add-on.
44-
45-
```yaml
46-
# Example configuration.yaml entry
47-
tellstick:
48-
host: core-tellstick
49-
port: [50800, 50801]
50-
```
51-
52-
To add lights, sensors and switches to Home Assistant, you need to follow the
53-
guidelines for each type individually that is described for Home Assistant.
54-
55-
For more information, check the Home Assistant documentation:
56-
57-
<https://www.home-assistant.io/components/tellstick/>
58-
59-
## Configuration
60-
61-
After installation you are presented with a default and example configuration,
62-
to alter this you must follow both the JSON format and also be aligned with
63-
the [valid parameters for Tellstick configuration file (tellstick.conf)][conf].
64-
65-
Example add-on configuration:
66-
67-
```yaml
68-
devices:
69-
- id: 1
70-
name: Example device
71-
protocol: everflourish
72-
model: selflearning-switch
73-
house: A
74-
unit: '1'
75-
- id: 2
76-
name: Example device two
77-
protocol: everflourish
78-
model: selflearning-switch
79-
house: A
80-
unit: '2'
81-
```
82-
83-
Please note: After any changes have been made to the configuration,
84-
you need to restart the add-on for the changes to take effect.
85-
86-
### Option: `devices` (required)
87-
88-
Add one or more devices entries to the add-on configuration for each
89-
device you'd like to add. Please note the comma separator between each
90-
device (see example above).
91-
92-
#### Option: `devices.id` (required)
93-
94-
A unique number / identifier that must be unique for each device.
95-
96-
#### Option: `devices.name` (required)
97-
98-
A name for your device, making it easier to identify it.
99-
100-
#### Option: `devices.protocol` (required)
101-
102-
This is the protocol the device uses. For a full list of supported protocols
103-
(and thus valid values for this configuration option), check the
104-
TellStick [protocol list][protocol-list].
105-
106-
#### Option: `devices.model` (optional)
107-
108-
The model parameter is only used by some protocols where there exists different
109-
types of devices using the same protocol. This can be dimmers versus non-dimmers,
110-
codeswitch versus self-learning, etc.
111-
112-
#### Option: `devices.house` (optional)
113-
114-
Depending on protocol the values here can vary a lot to identify
115-
or group per house or type.
116-
117-
#### Option: `devices.unit` (optional)
118-
119-
Unit identifier, in most cases a value between 1 to 16 and often used in
120-
combination with the house.
121-
122-
#### Option: `devices.fade` (optional)
123-
124-
Fade is either `true` or `false` and tells a dimmer if it should fade smooth
125-
or instant between values (only for IKEA protocol as it seems).
126-
127-
#### Option: `devices.code` (optional)
128-
129-
A number series based on ones and zeroes often used for dip-switch based devices.
130-
131-
## Service calls
132-
133-
If you wish to teach a self-learning device in your TellStick configuration:
134-
135-
Go to Home Assistant service call in Developer tools and select:
136-
137-
- Service: `hassio.addon_stdin`
138-
- Enter service Data:
139-
`{"addon":"core_tellstick","input":{"function":"learn","device":"1"}}`
140-
141-
Replace `1` with the corresponding ID of the device in your TellStick configuration.
142-
143-
You can also use this to list devices or sensors and read the output in the
144-
add-on log: `{"addon":"core_tellstick","input":{"function":"list-sensors"}}`
145-
146-
### Supported service commands
147-
148-
- `"function":"list"`
149-
List currently configured devices with name and device id and all discovered sensors.
150-
151-
- `"function":"list-sensors"`
152-
153-
- `"function":"list-devices"`
154-
Alternative devices/sensors listing: Shows devices and/or sensors using key=value
155-
format (with tabs as separators, one device/sensor per line, no header lines.)
156-
157-
- `"function":"on","device":"x"`
158-
Turns on device. ’x’ could either be an integer of the device-id,
159-
or the name of the device.
160-
161-
- `"function":"off","device":"x"`
162-
Turns off device. ’x’ could either be an integer of the device-id,
163-
or the name of the device.
164-
165-
## Support
166-
167-
Got questions?
168-
169-
You have several options to get them answered:
170-
171-
- The [Home Assistant Discord Chat Server][discord].
172-
- The Home Assistant [Community Forum][forum].
173-
- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]
174-
175-
In case you've found a bug, please [open an issue on our GitHub][issue].
17619

17720
[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
17821
[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
17922
[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
18023
[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
181-
[conf]: http://developer.telldus.com/wiki/TellStick_conf
182-
[discord]: https://discord.gg/c5DvZ4e
183-
[forum]: https://community.home-assistant.io
184-
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
185-
[issue]: https://github.com/home-assistant/hassio-addons/issues
186-
[protocol-list]: http://developer.telldus.com/wiki/TellStick_conf
187-
[reddit]: https://reddit.com/r/homeassistant
188-
[repository]: https://github.com/hassio-addons/repository
24+
[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg

0 commit comments

Comments
 (0)