From 6a3c596a78d1f1a993ea001ffe7a60213f2b49f2 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Thu, 19 Dec 2019 13:15:06 +0100 Subject: [PATCH] tellstick: Collection of small improvements (#916) * tellstick: Move data run to data folder * tellstick: Prettier JSON & YAML files * tellstick: Documentation tweaks --- tellstick/Dockerfile | 2 +- tellstick/README.md | 20 ++++++++++---------- tellstick/azure-pipelines.yml | 15 +++++++-------- tellstick/config.json | 12 ++---------- tellstick/{ => data}/run.sh | 0 5 files changed, 20 insertions(+), 29 deletions(-) rename tellstick/{ => data}/run.sh (100%) diff --git a/tellstick/Dockerfile b/tellstick/Dockerfile index 13a71d70c57..6266d78ff03 100644 --- a/tellstick/Dockerfile +++ b/tellstick/Dockerfile @@ -39,6 +39,6 @@ RUN apk add --no-cache \ && rm -rf /usr/src/telldus # Copy data for add-on -COPY run.sh / +COPY data/run.sh / CMD [ "/run.sh" ] diff --git a/tellstick/README.md b/tellstick/README.md index b9b47f51335..05640008690 100644 --- a/tellstick/README.md +++ b/tellstick/README.md @@ -18,7 +18,7 @@ For more details, please check the TellStick [protocol list][protocol-list]. ## 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**. 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 (see example above). -#### Option: `devices` -> `id` (required) +#### Option: `devices.id` (required) 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 (and thus valid values for this configuration option), check the 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 types of devices using the same protocol. This can be dimmers versus non-dimmers, 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 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 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 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. diff --git a/tellstick/azure-pipelines.yml b/tellstick/azure-pipelines.yml index 322e1364c1c..de758f400b1 100644 --- a/tellstick/azure-pipelines.yml +++ b/tellstick/azure-pipelines.yml @@ -3,20 +3,19 @@ trigger: branches: include: - - master + - master paths: include: - - tellstick/* + - tellstick/* pr: none variables: - name: versionBuilder - value: '2.0' + value: "2.0" - group: docker - jobs: -- template: /.azure/azp-template-addon.yml - parameters: - addon: 'tellstick' - arch: '--all' + - template: /.azure/azp-template-addon.yml + parameters: + addon: "tellstick" + arch: "--all" diff --git a/tellstick/config.json b/tellstick/config.json index a871f5d4200..9ab122fdaac 100644 --- a/tellstick/config.json +++ b/tellstick/config.json @@ -4,19 +4,11 @@ "slug": "tellstick", "description": "TellStick and TellStick Duo service", "url": "https://github.com/home-assistant/hassio-addons/tree/master/tellstick", - "arch": [ - "armhf", - "armv7", - "aarch64", - "amd64", - "i386" - ], + "arch": ["armhf", "armv7", "aarch64", "amd64", "i386"], "startup": "system", "stdin": true, "boot": "auto", - "devices": [ - "/dev/bus/usb:/dev/bus/usb:rwm" - ], + "devices": ["/dev/bus/usb:/dev/bus/usb:rwm"], "options": { "devices": [ { diff --git a/tellstick/run.sh b/tellstick/data/run.sh similarity index 100% rename from tellstick/run.sh rename to tellstick/data/run.sh