Skip to content

Commit 9fb2734

Browse files
klaasnicolaasfabaff
authored andcommitted
Update tellstick add-on component configuration (#7541)
1 parent c4de692 commit 9fb2734

File tree

1 file changed

+36
-12
lines changed

1 file changed

+36
-12
lines changed

source/_addons/tellstick.markdown

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -17,20 +17,8 @@ After installation you are presented with a default and example configuration, t
1717

1818
After any changes have been made to the configuration, you need to restart the add-on for the changes to take effect.
1919

20-
Configuration variables:
21-
22-
- **id** (*Required*): A number and must be unique for each device.
23-
- **name** (*Required*): A name for easy identification of the device.
24-
- **protocol** (*Required*): This is the protocol the device uses. More on the different protocols later down.
25-
- **model** (*Optional*): The model parameter is only used by some protocols where there exists different types of devices using the same protocol. This can be dimmers versus non-dimmers, codeswitch versus self-learning, etc.
26-
- **house** (*Optional*): Depending on protocol the values here can vary a lot to identify or group per house or type.
27-
- **unit** (*Optional*): Unit identifier, in most cases a value between 1 to 16 and often used in combination with the house.
28-
- **fade** (*Optional*): Fade is either `true` or `false` and tells a dimmer if it should fade smooth or instant between values (only for IKEA protocol as it seems).
29-
- **code** (*Optional*): A number series based on ones and zeroes often used for dip-switch based devices.
30-
3120
You will need to add internal communication details to `configuration.yaml` to enable the integration from Hass.io and the add-on.
3221

33-
3422
```yaml
3523
# Example configuration.yaml entry
3624
tellstick:
@@ -69,11 +57,47 @@ Example for adding more devices in the add-on configuration (note the comma sepa
6957
}
7058
```
7159

60+
{% configuration %}
61+
id:
62+
description: A number and must be unique for each device.
63+
required: true
64+
type: integer
65+
name:
66+
description: A name for easy identification of the device.
67+
required: true
68+
type: string
69+
protocol:
70+
description: This is the protocol the device uses. More on the different protocols later down.
71+
required: true
72+
type: string
73+
model:
74+
description: The model parameter is only used by some protocols where there exists different types of devices using the same protocol. This can be dimmers versus non-dimmers, codeswitch versus self-learning, etc.
75+
required: false
76+
type: string
77+
house:
78+
description: Depending on protocol the values here can vary a lot to identify or group per house or type.
79+
required: false
80+
type: string
81+
unit:
82+
description: Unit identifier, in most cases a value between 1 to 16 and often used in combination with the house.
83+
required: false
84+
type: integer
85+
fade:
86+
description: Fade is either `true` or `false` and tells a dimmer if it should fade smooth or instant between values (only for IKEA protocol as it seems).
87+
required: false
88+
type: boolean
89+
code:
90+
description: A number series based on ones and zeroes often used for dip-switch based devices.
91+
required: false
92+
type: string
93+
{% endconfiguration %}
94+
7295
## {% linkable_title Service calls %}
7396

7497
If you wish to teach a self-learning device in your TellStick configuration:
7598

7699
Go to Home Assistant [service call](http://hassio.local:8123/dev-service) in Developer tools and select.
100+
77101
- Service: `hassio.addon_stdin`
78102
- Enter service Data:
79103
`{"addon":"core_tellstick","input":{"function":"learn","device":"1"}}`

0 commit comments

Comments
 (0)