mtan93/homebridge
1
0
Fork 0
mirror of https://github.com/mtan93/homebridge.git synced 2026-03-08 05:31:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup KNX file names and markdown

Browse Source 
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?
This commit is contained in:
Snowdd1
2015-09-18 09:37:10 +02:00
parent 6f77e55c7b
commit c7ab475dd4
2 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
platforms/config-sample-knx.json → platforms/KNX-sample-config.json
View File

16
accessories/knxdevice.md → platforms/KNX.md
View File

@@ -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