tellstick: Collection of small improvements (#916)

* tellstick: Move data run to data folder

* tellstick: Prettier JSON & YAML files

* tellstick: Documentation tweaks
This commit is contained in:
Franck Nijhof
2019-12-19 13:15:06 +01:00
committed by Pascal Vizeli
parent 90736dabfd
commit 058df9b0f2
5 changed files with 20 additions and 29 deletions

View File

@@ -39,6 +39,6 @@ RUN apk add --no-cache \
&& rm -rf /usr/src/telldus && rm -rf /usr/src/telldus
# Copy data for add-on # Copy data for add-on
COPY run.sh / COPY data/run.sh /
CMD [ "/run.sh" ] CMD [ "/run.sh" ]

View File

@@ -18,7 +18,7 @@ For more details, please check the TellStick [protocol list][protocol-list].
## Installation ## Installation
The installation of this add-on is straightforward and easy to do. Follow these steps to get the add-on installed on your system:
1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**. 1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
2. Find the "TellStick" add-on and click it. 2. Find the "TellStick" add-on and click it.
@@ -96,42 +96,42 @@ Add one or more devices entries to the add-on configuration for each
device you'd like to add. Please note the comma separator between each device you'd like to add. Please note the comma separator between each
device (see example above). device (see example above).
#### Option: `devices` -> `id` (required) #### Option: `devices.id` (required)
A unique number / identifier that must be unique for each device. A unique number / identifier that must be unique for each device.
#### Option: `devices` -> `name` (required) #### Option: `devices.name` (required)
A name for your device, making it easy to identify it. A name for your device, making it easier to identify it.
#### Option: `devices` -> `protocol` (required) #### Option: `devices.protocol` (required)
This is the protocol the device uses. For a full list of supported protocols This is the protocol the device uses. For a full list of supported protocols
(and thus valid values for this configuration option), check the (and thus valid values for this configuration option), check the
TellStick [protocol list][protocol-list]. TellStick [protocol list][protocol-list].
#### Option: `devices` -> `model` (optional) #### Option: `devices.model` (optional)
The model parameter is only used by some protocols where there exists different 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, types of devices using the same protocol. This can be dimmers versus non-dimmers,
codeswitch versus self-learning, etc. codeswitch versus self-learning, etc.
#### Option: `devices` -> `house` (optional) #### Option: `devices.house` (optional)
Depending on protocol the values here can vary a lot to identify Depending on protocol the values here can vary a lot to identify
or group per house or type. or group per house or type.
#### Option: `devices` -> `unit` (optional) #### Option: `devices.unit` (optional)
Unit identifier, in most cases a value between 1 to 16 and often used in Unit identifier, in most cases a value between 1 to 16 and often used in
combination with the house. combination with the house.
#### Option: `devices` -> `fade` (optional) #### Option: `devices.fade` (optional)
Fade is either `true` or `false` and tells a dimmer if it should fade smooth 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). or instant between values (only for IKEA protocol as it seems).
#### Option: `devices` -> `code` (optional) #### Option: `devices.code` (optional)
A number series based on ones and zeroes often used for dip-switch based devices. A number series based on ones and zeroes often used for dip-switch based devices.

View File

@@ -11,12 +11,11 @@ pr: none
variables: variables:
- name: versionBuilder - name: versionBuilder
value: '2.0' value: "2.0"
- group: docker - group: docker
jobs: jobs:
- template: /.azure/azp-template-addon.yml - template: /.azure/azp-template-addon.yml
parameters: parameters:
addon: 'tellstick' addon: "tellstick"
arch: '--all' arch: "--all"

View File

@@ -4,19 +4,11 @@
"slug": "tellstick", "slug": "tellstick",
"description": "TellStick and TellStick Duo service", "description": "TellStick and TellStick Duo service",
"url": "https://github.com/home-assistant/hassio-addons/tree/master/tellstick", "url": "https://github.com/home-assistant/hassio-addons/tree/master/tellstick",
"arch": [ "arch": ["armhf", "armv7", "aarch64", "amd64", "i386"],
"armhf",
"armv7",
"aarch64",
"amd64",
"i386"
],
"startup": "system", "startup": "system",
"stdin": true, "stdin": true,
"boot": "auto", "boot": "auto",
"devices": [ "devices": ["/dev/bus/usb:/dev/bus/usb:rwm"],
"/dev/bus/usb:/dev/bus/usb:rwm"
],
"options": { "options": {
"devices": [ "devices": [
{ {