mirror of
https://github.com/mtan93/homebridge.git
synced 2026-05-22 22:07:30 +01:00
Doc updates
This commit is contained in:
Snowdd1
+154
-152
@@ -1,154 +1,156 @@
|
|||||||
{
|
{
|
||||||
"bridge": {
|
"bridge": {
|
||||||
"name": "Homebridge",
|
"name": "Homebridge",
|
||||||
"username": "CC:22:3D:E3:CE:30",
|
"username": "CC:22:3D:E3:CE:30",
|
||||||
"port": 51826,
|
"port": 51826,
|
||||||
"pin": "031-45-154"
|
"pin": "031-45-154"
|
||||||
},
|
},
|
||||||
"description": "This is an example configuration file for KNX platform shim",
|
"description": "This is an example configuration file for KNX platform shim",
|
||||||
"hint": "Always paste into jsonlint.com validation page before starting your homebridge, saves a lot of frustration",
|
"hint": "Always paste into jsonlint.com validation page before starting your homebridge, saves a lot of frustration",
|
||||||
"hint2": "Replace all group addresses by current addresses of your installation, these are arbitrary examples!",
|
"hint2": "Replace all group addresses by current addresses of your installation, these are arbitrary examples!",
|
||||||
"hint3": "For valid services and their characteristics have a look at the knxdevice.md file in folder accessories!",
|
"hint3": "For valid services and their characteristics have a look at the knxdevice.md file in folder accessories!",
|
||||||
"platforms": [
|
"platforms": [
|
||||||
{
|
{
|
||||||
"platform": "KNX",
|
"platform": "KNX",
|
||||||
"name": "KNX",
|
"name": "KNX",
|
||||||
"knxd_ip": "192.168.178.205",
|
"knxd_ip": "192.168.178.205",
|
||||||
"knxd_port": 6720,
|
"knxd_port": 6720,
|
||||||
"accessories": [
|
"accessories": [
|
||||||
{
|
{
|
||||||
"accessory_type": "knxdevice",
|
"accessory_type": "knxdevice",
|
||||||
"description": "Only generic type knxdevice is supported, all previous knx types have been merged into that.",
|
"description": "Only generic type knxdevice is supported, all previous knx types have been merged into that.",
|
||||||
"name": "Living Room North Lamp",
|
"name": "Living Room North Lamp",
|
||||||
"services": [
|
"services": [
|
||||||
{
|
{
|
||||||
"type": "Lightbulb",
|
"type": "Lightbulb",
|
||||||
"description": "iOS8 Lightbulb type, supports On (Switch) and Brightness",
|
"description": "iOS8 Lightbulb type, supports On (Switch) and Brightness",
|
||||||
"name": "Living Room North Lamp",
|
"name": "Living Room North Lamp",
|
||||||
"On": {
|
"On": {
|
||||||
"Set": "1/1/6",
|
"Set": "1/1/6",
|
||||||
"Listen": [
|
"Listen": [
|
||||||
"1/1/63"
|
"1/1/63"
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
"Brightness": {
|
"Brightness": {
|
||||||
"Set": "1/1/62",
|
"Set": "1/1/62",
|
||||||
"Listen": [
|
"Listen": [
|
||||||
"1/1/64"
|
"1/1/64"
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"services-description": "Services is an array, you CAN have multiple service types in one accessory, though it is not fully supported in many iOS HK apps, such as EVE and myTouchHome"
|
"services-description": "Services is an array, you CAN have multiple service types in one accessory, though it is not fully supported in many iOS HK apps, such as EVE and myTouchHome"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"accessory_type": "knxdevice",
|
"accessory_type": "knxdevice",
|
||||||
"name": "Office Temperature",
|
"name": "Office Temperature",
|
||||||
"description": "iOS8.4.1 TemperatureSensor type, supports CurrentTemperature",
|
"description": "iOS8.4.1 TemperatureSensor type, supports CurrentTemperature",
|
||||||
"services": [
|
"services": [
|
||||||
{
|
{
|
||||||
"type": "TemperatureSensor",
|
"type": "TemperatureSensor",
|
||||||
"name": "Raumtemperatur",
|
"name": "Raumtemperatur",
|
||||||
"CurrentTemperature": {
|
"CurrentTemperature": {
|
||||||
"Listen": "3/3/44"
|
"Listen": "3/3/44"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"accessory_type": "knxdevice",
|
"accessory_type": "knxdevice",
|
||||||
"name": "Office Window Lock",
|
"name": "Office Window Lock",
|
||||||
"services": [
|
"services": [
|
||||||
{
|
{
|
||||||
"type": "LockMechanism",
|
"type": "LockMechanism",
|
||||||
"description": "iOS8 Lock mechanism, Supports LockCurrentStateSecured0 OR LockCurrentState, LockTargetStateSecured0 OR LockTargetState, use depending if LOCKED is 0 or 1",
|
"description": "iOS8 Lock mechanism, Supports LockCurrentStateSecured0 OR LockCurrentState, LockTargetStateSecured0 OR LockTargetState, use depending if LOCKED is 0 or 1",
|
||||||
"name": "Office Window Lock",
|
"name": "Office Window Lock",
|
||||||
"LockCurrentStateSecured0": {
|
"LockCurrentStateSecured0": {
|
||||||
"Listen": "5/3/15"
|
"Listen": "5/3/15"
|
||||||
},
|
},
|
||||||
"LockTargetStateSecured0": {
|
"LockTargetStateSecured0": {
|
||||||
"Listen": "5/3/15"
|
"Listen": "5/3/15"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"accessory_type": "knxdevice",
|
"accessory_type": "knxdevice",
|
||||||
"description": "sample device with multiple services. Multiple services of different types are widely supported",
|
"description": "sample device with multiple services. Multiple services of different types are widely supported",
|
||||||
"name": "Office",
|
"name": "Office",
|
||||||
"services": [
|
"services": [
|
||||||
{
|
{
|
||||||
"type": "Lightbulb",
|
"type": "Lightbulb",
|
||||||
"name": "Office Lamp",
|
"name": "Office Lamp",
|
||||||
"On": {
|
"On": {
|
||||||
"Set": "1/3/5"
|
"Set": "1/3/5"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Thermostat",
|
"type": "Thermostat",
|
||||||
"description": "iOS8 Thermostat type, supports CurrentTemperature, TargetTemperature, CurrentHeatingCoolingState ",
|
"description": "iOS8 Thermostat type, supports CurrentTemperature, TargetTemperature, CurrentHeatingCoolingState ",
|
||||||
"name": "Raumtemperatur",
|
"name": "Raumtemperatur",
|
||||||
"CurrentTemperature": {
|
"CurrentTemperature": {
|
||||||
"Listen": "3/3/44"
|
"Listen": "3/3/44"
|
||||||
},
|
},
|
||||||
"TargetTemperature": {
|
"TargetTemperature": {
|
||||||
"Set": "3/3/94"
|
"Set": "3/3/94"
|
||||||
},
|
},
|
||||||
"CurrentHeatingCoolingState": {
|
"CurrentHeatingCoolingState": {
|
||||||
"Listen": "3/3/64"
|
"Listen": "3/3/64"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "WindowCovering",
|
"type": "WindowCovering",
|
||||||
"description": "iOS9 Window covering (blinds etc) type, still WIP",
|
"description": "iOS9 Window covering (blinds etc) type, still WIP",
|
||||||
"name": "Blinds",
|
"name": "Blinds",
|
||||||
"TargetPosition": {
|
"TargetPosition": {
|
||||||
"Set": "1/2/3",
|
"Set": "1/2/3",
|
||||||
"Listen": "1/2/4"
|
"Listen": "1/2/4"
|
||||||
},
|
},
|
||||||
"CurrentPosition": {
|
"CurrentPosition": {
|
||||||
"Set": "1/3/1",
|
"Set": "1/3/1",
|
||||||
"Listen": "1/3/2"
|
"Listen": "1/3/2"
|
||||||
},
|
},
|
||||||
"PositionState": {
|
"PositionState": {
|
||||||
"Listen": "2/7/1"
|
"Listen": "2/7/1"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"accessory_type": "knxdevice",
|
"accessory_type": "knxdevice",
|
||||||
"description": "sample contact sensor device",
|
"description": "sample contact sensor device",
|
||||||
"name": "Office Contact",
|
"name": "Office Contact",
|
||||||
"services": [
|
"services": [
|
||||||
{
|
{
|
||||||
"type": "ContactSensor",
|
"type": "ContactSensor",
|
||||||
"name": "Office Door",
|
"name": "Office Door",
|
||||||
"ContactSensorState": {
|
"ContactSensorState": {
|
||||||
"Listen": "5/3/5"
|
"Listen": "5/3/5"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"accessory_type": "knxdevice",
|
"accessory_type": "knxdevice",
|
||||||
"description": "sample garage door opener",
|
"description": "sample garage door opener",
|
||||||
"name": "Office Garage",
|
"name": "Office Garage",
|
||||||
"services": [
|
"services": [
|
||||||
{
|
{
|
||||||
"type": "GarageDoorOpener",
|
"type": "GarageDoorOpener",
|
||||||
"name": "Office Garage Opener",
|
"name": "Office Garage Opener",
|
||||||
"CurrentDoorState": {
|
"CurrentDoorState": {
|
||||||
"Listen": "5/4/5"
|
"Listen": "5/4/5"
|
||||||
},
|
},
|
||||||
"TargetDoorState": {
|
"TargetDoorState": {
|
||||||
"Listen": "5/4/6"
|
"Listen": "5/4/6"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"accessories": []
|
"accessories": [
|
||||||
|
|
||||||
|
]
|
||||||
}
|
}
|
||||||
+1
-1
@@ -152,7 +152,7 @@ Two kinds of addresses are supported: `"Set":"1/2/3"` is a writable group addres
|
|||||||
## WindowCovering
|
## WindowCovering
|
||||||
- CurrentPosition: DPT5 percentage
|
- CurrentPosition: DPT5 percentage
|
||||||
- TargetPosition: DPT5 percentage
|
- TargetPosition: DPT5 percentage
|
||||||
- PositionState: DPT5 value [listen only]
|
- PositionState: DPT5 value [listen only: 0 Closing, 1 Opening, 2 STopped]
|
||||||
|
|
||||||
### not yet supported
|
### not yet supported
|
||||||
- HoldPosition
|
- HoldPosition
|
||||||
|
|||||||
Reference in New Issue
Block a user