From c7ab475dd4d72d5f7278082b1e2f02539e89db86 Mon Sep 17 00:00:00 2001 From: Snowdd1 Date: Fri, 18 Sep 2015 09:37:10 +0200 Subject: [PATCH] Cleanup KNX file names and markdown I found that the description was wrongly named and in the wrong folder. It is now named after the platform shim to appear next to it in listings, also the config-sample that comes along with it. As long as we do not go for own repositories and npm packages, should we consider folders for additional files if required? --- ...ig-sample-knx.json => KNX-sample-config.json} | 0 accessories/knxdevice.md => platforms/KNX.md | 16 ++++++++++------ 2 files changed, 10 insertions(+), 6 deletions(-) rename platforms/{config-sample-knx.json => KNX-sample-config.json} (100%) rename accessories/knxdevice.md => platforms/KNX.md (85%) diff --git a/platforms/config-sample-knx.json b/platforms/KNX-sample-config.json similarity index 100% rename from platforms/config-sample-knx.json rename to platforms/KNX-sample-config.json diff --git a/accessories/knxdevice.md b/platforms/KNX.md similarity index 85% rename from accessories/knxdevice.md rename to platforms/KNX.md index c9131cc..77dfe4d 100644 --- a/accessories/knxdevice.md +++ b/platforms/KNX.md @@ -1,7 +1,7 @@ # Syntax of the config.json In the platforms section, you can insert a KNX type platform. You need to configure all devices directly in the config.json. - +````json "platforms": [ { "platform": "KNX", @@ -33,8 +33,9 @@ You need to configure all devices directly in the config.json. ] } } - +```` In the accessories section (the array within the brackets [ ]) you can insert as many objects as you like in the following form +````json { "accessory_type": "knxdevice", "name": "Here goes your display name, this will be shown in HomeKit apps", @@ -43,8 +44,9 @@ In the accessories section (the array within the brackets [ ]) you can insert as } ] } - +```` You have to add services in the following syntax: +````json { "type": "SERVICENAME", "description": "This is just for you to remember things", @@ -62,9 +64,11 @@ You have to add services in the following syntax: ] } } -CHARACTERISTIC are properties that are dependent on the service type, so they are listed below. -Two kinds of addresses are supported: "Set":"1/2/3" is a writable group address, to which changes are sent if the service supports changing values. Changes on the bus are listened to, too. -"Listen":["1/2/3","1/2/4","1/2/5"] is an array of addresses that are listened to additionally. To these addresses never values get written, but the on startup the service will issue read requests to ALL addresses listed in Set: and in Listen: +```` +`CHARACTERISTICx` are properties that are dependent on the service type, so they are listed below. + +Two kinds of addresses are supported: `"Set":"1/2/3"` is a writable group address, to which changes are sent if the service supports changing values. Changes on the bus are listened to, too. +`"Listen":["1/2/3","1/2/4","1/2/5"]` is an array of addresses that are listened to additionally. To these addresses never values get written, but the on startup the service will issue *KNX read requests* to ALL addresses listed in `Set:` and in `Listen:` # Supported Services and their characteristics