mirror of https://github.com/nymea/nymea.git
Update API json
Simon Stürz
parent
e2cbffeebd
commit
929ef2fb5d
|
|
@ -365,17 +365,14 @@
|
|||
"WirelessModeInfrastructure",
|
||||
"WirelessModeAccessPoint"
|
||||
],
|
||||
"ZigbeeBackendType": [
|
||||
"ZigbeeBackendTypeDeconz",
|
||||
"ZigbeeBackendTypeNxp"
|
||||
],
|
||||
"ZigbeeError": [
|
||||
"ZigbeeErrorNoError",
|
||||
"ZigbeeErrorAdapterNotAvailable",
|
||||
"ZigbeeErrorAdapterAlreadyInUse",
|
||||
"ZigbeeErrorNetworkUuidNotFound",
|
||||
"ZigbeeErrorDurationOutOfRange",
|
||||
"ZigbeeErrorNetworkOffline"
|
||||
"ZigbeeErrorNetworkOffline",
|
||||
"ZigbeeErrorUnknownBackend"
|
||||
],
|
||||
"ZigbeeNetworkState": [
|
||||
"ZigbeeNetworkStateOffline",
|
||||
|
|
@ -1953,11 +1950,10 @@
|
|||
}
|
||||
},
|
||||
"Zigbee.AddNetwork": {
|
||||
"description": "Create a new Zigbee network for the given serialPort, baud rate and backend type. Get those information from the available Zigbee adapters.The channel mask is optional and defaults to all channels [11, 26]. The quietest channel from the given channel mask will be picked during network creation. The channel mask is a uint32 flag and the the bit number represents the channel which should enabled for scanning. All channels would be the value 0x07fff800.",
|
||||
"description": "Create a new Zigbee network for the given 'serialPort', 'baudRate' and 'backend'. The serial ports can be fetched from the available adapters. See 'GetAdapters' for more information. The available backends can be fetched using the 'GetAvailableBackends' method.",
|
||||
"params": {
|
||||
"backendType": "$ref:ZigbeeBackendType",
|
||||
"backend": "String",
|
||||
"baudRate": "Uint",
|
||||
"o:channelMask": "Uint",
|
||||
"serialPort": "String"
|
||||
},
|
||||
"returns": {
|
||||
|
|
@ -1966,7 +1962,7 @@
|
|||
}
|
||||
},
|
||||
"Zigbee.FactoryResetNetwork": {
|
||||
"description": "Factory reset the network with the given networkUuid. The network does not have to be Online for this procedure, and all associated nodes and things will be removed permanently. Make sure the user realy wants to do this because this can not be undone.",
|
||||
"description": "Factory reset the network with the given 'networkUuid'. The network does not have to be online for this procedure, and all associated nodes and things will be removed permanently.",
|
||||
"params": {
|
||||
"networkUuid": "Uuid"
|
||||
},
|
||||
|
|
@ -1975,15 +1971,25 @@
|
|||
}
|
||||
},
|
||||
"Zigbee.GetAdapters": {
|
||||
"description": "Get the list of available Zigbee adapter candidates in order to set up the zigbee network on the desired serial interface. The serialPort property can be used as unique identifier. If an adapter hardware has been recognized as a supported hardware, the 'hardwareRecognized' property will be true and the baud rate and backend configurations can be used as they where given, otherwise the user might set the backend type and baud rate manually.",
|
||||
"description": "Get the list of available Zigbee adapters and serial ports in order to set up the Zigbee network on the desired interface. The 'serialPort' property can be used as unique identifier for an adapter. If an adapter hardware has been recognized as a well known Zigbee adapter, the 'hardwareRecognized' property will be true and the 'baudRate' and 'backend' configurations can be used as they where given, otherwise the user might set the backend and baud rate manually. The available backends can be fetched using the GetAvailableBackends method.",
|
||||
"params": {
|
||||
},
|
||||
"returns": {
|
||||
"adapters": "$ref:ZigbeeAdapters"
|
||||
}
|
||||
},
|
||||
"Zigbee.GetAvailableBackends": {
|
||||
"description": "Get the list of available Zigbee backends.",
|
||||
"params": {
|
||||
},
|
||||
"returns": {
|
||||
"backends": [
|
||||
"String"
|
||||
]
|
||||
}
|
||||
},
|
||||
"Zigbee.GetNetworks": {
|
||||
"description": "Returns the list of zigbee networks configured in the system.",
|
||||
"description": "Returns the list of configured Zigbee networks in the system.",
|
||||
"params": {
|
||||
},
|
||||
"returns": {
|
||||
|
|
@ -2002,7 +2008,7 @@
|
|||
}
|
||||
},
|
||||
"Zigbee.SetPermitJoin": {
|
||||
"description": "Allow or deny nodes to join the network with the given networkUuid for a specific duration in seconds. The duration values has to be between 0 and 255 seconds. The permitJoinDuration indicates how long permit has been enabled and the permitJoinDuration indicates the rest of the time. Those values can be used to show a countdown or progressbar. This method can be recalled for resetting the timeout. If the duration is set to 0 seconds, joining will be disabled immediatly for the entire network. The shortAddress is optional and defaults to the broadcast address (0xfffc) for all routers in the network. If the short address matches the address of a router node in the network, only that router will be able to allow new nodes to join the network. A new node will join to the router with the best link quality index (LQI).",
|
||||
"description": "Allow or deny nodes to join the network with the given 'networkUuid' for a specific 'duration' in seconds. The duration value has to be between 0 and 255 seconds. The 'permitJoinDuration' property of Zigbee network object indicates how long permit has been enabled and the 'permitJoiningRemaining' indicates the rest of the time. Those values can be used to show a countdown or progressbar. This method can be recalled for resetting the timeout. If the duration is set to 0 seconds, joining will be disabled immediatly for the entire network. The 'shortAddress' is optional and defaults to the broadcast address 0xfffc for all routers in the network. If the short address matches the address of a router node in the network, only that specific router will be able to allow new nodes to join the network. A new node will join to the router with the best link quality index (LQI).",
|
||||
"params": {
|
||||
"duration": "Uint",
|
||||
"networkUuid": "Uuid",
|
||||
|
|
@ -2431,13 +2437,13 @@
|
|||
}
|
||||
},
|
||||
"Zigbee.AdapterAdded": {
|
||||
"description": "Emitted whenever a new Zigbee adapter candidate has been detected in the system.",
|
||||
"description": "Emitted whenever a new Zigbee adapter or serial port has been detected in the system.",
|
||||
"params": {
|
||||
"adapter": "$ref:ZigbeeAdapter"
|
||||
}
|
||||
},
|
||||
"Zigbee.AdapterRemoved": {
|
||||
"description": "Emitted whenever a Zigbee adapter has been removed from the system (i.e. unplugged).",
|
||||
"description": "Emitted whenever a Zigbee adapter or serial port has been removed from the system (i.e. unplugged).",
|
||||
"params": {
|
||||
"adapter": "$ref:ZigbeeAdapter"
|
||||
}
|
||||
|
|
@ -2930,19 +2936,19 @@
|
|||
"r:state": "$ref:NetworkDeviceState"
|
||||
},
|
||||
"ZigbeeAdapter": {
|
||||
"backendType": "$ref:ZigbeeBackendType",
|
||||
"baudRate": "Int",
|
||||
"description": "String",
|
||||
"hardwareRecognized": "Bool",
|
||||
"name": "String",
|
||||
"serialNumber": "String",
|
||||
"serialPort": "String"
|
||||
"r:backend": "String",
|
||||
"r:baudRate": "Int",
|
||||
"r:description": "String",
|
||||
"r:hardwareRecognized": "Bool",
|
||||
"r:name": "String",
|
||||
"r:serialNumber": "String",
|
||||
"r:serialPort": "String"
|
||||
},
|
||||
"ZigbeeAdapters": [
|
||||
"$ref:ZigbeeAdapter"
|
||||
],
|
||||
"ZigbeeNetwork": {
|
||||
"backendType": "$ref:ZigbeeBackendType",
|
||||
"backend": "String",
|
||||
"baudRate": "Uint",
|
||||
"channel": "Uint",
|
||||
"channelMask": "Uint",
|
||||
|
|
|
|||
Loading…
Reference in New Issue