ETM-Schurig
/
nymea
mirror of https://github.com/nymea/nymea.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update JSON RPC descriptions and rename Zigbee to ZigBee

pull/346/head
Simon Stürz 2020-12-16 12:59:00 +01:00
parent 0cf7679341
commit d51327b97a
2 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
libnymea-core/jsonrpc/zigbeehandler.cpp
View File

@ -69,15 +69,15 @@ ZigbeeHandler::ZigbeeHandler(ZigbeeManager *zigbeeManager, QObject *parent) :
// GetAvailableBackends
params.clear(); returns.clear();
description = "Get the list of available Zigbee backends.";
description = "Get the list of available ZigBee backends.";
returns.insert("backends", QVariantList() << enumValueName(String));
registerMethod("GetAvailableBackends", description, params, returns);
// GetAdapters
params.clear(); returns.clear();
description = "Get the list of available Zigbee adapters and serial ports in order to set up the Zigbee network "
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, "
"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.";
@ -86,25 +86,25 @@ ZigbeeHandler::ZigbeeHandler(ZigbeeManager *zigbeeManager, QObject *parent) :
// AdapterAdded notification
params.clear();
description = "Emitted whenever a new Zigbee adapter or serial port has been detected in the system.";
description = "Emitted whenever a new ZigBee adapter or serial port has been detected in the system.";
params.insert("adapter", objectRef<ZigbeeAdapter>());
registerNotification("AdapterAdded", description, params);
// AdapterRemoved notification
params.clear();
description = "Emitted whenever a Zigbee adapter or serial port 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.insert("adapter", objectRef<ZigbeeAdapter>());
registerNotification("AdapterRemoved", description, params);
// GetNetworks
params.clear(); returns.clear();
description = "Returns the list of configured Zigbee networks in the system.";
description = "Returns the list of configured ZigBee networks in the system.";
returns.insert("zigbeeNetworks", QVariantList() << objectRef("ZigbeeNetwork"));
registerMethod("GetNetworks", description, params, returns);
// AddNetwork
params.clear(); returns.clear();
description = "Create a new Zigbee network for the given \'serialPort\', \'baudRate\' and \'backend\'. "
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.insert("serialPort", enumValueName(String));
@ -116,26 +116,26 @@ ZigbeeHandler::ZigbeeHandler(ZigbeeManager *zigbeeManager, QObject *parent) :
// RemoveNetwork
params.clear(); returns.clear();
description = "Remove the zigbee network with the given network uuid.";
description = "Remove the ZigBee network with the given network uuid.";
params.insert("networkUuid", enumValueName(Uuid));
returns.insert("zigbeeError", enumRef<ZigbeeManager::ZigbeeError>());
registerMethod("RemoveNetwork", description, params, returns);
// NetworkAdded notification
params.clear();
description = "Emitted whenever a new Zigbee network has been added.";
description = "Emitted whenever a new ZigBee network has been added.";
params.insert("zigbeeNetwork", objectRef("ZigbeeNetwork"));
registerNotification("NetworkAdded", description, params);
// NetworkRemoved notification
params.clear();
description = "Emitted whenever a new Zigbee network has been removed.";
description = "Emitted whenever a new ZigBee network has been removed.";
params.insert("networkUuid", enumValueName(Uuid));
registerNotification("NetworkRemoved", description, params);
// NetworkChanged notification
params.clear();
description = "Emitted whenever a new Zigbee network has changed.";
description = "Emitted whenever a new ZigBee network has changed.";
params.insert("zigbeeNetwork", objectRef("ZigbeeNetwork"));
registerNotification("NetworkChanged", description, params);
@ -150,7 +150,7 @@ ZigbeeHandler::ZigbeeHandler(ZigbeeManager *zigbeeManager, QObject *parent) :
// SetPermitJoin
params.clear(); returns.clear();
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 "
"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. "

22
tests/auto/api.json
View File

@ -1950,7 +1950,7 @@
}
},
"Zigbee.AddNetwork": {
"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.",
"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": {
"backend": "String",
"baudRate": "Uint",
@ -1971,7 +1971,7 @@
}
},
"Zigbee.GetAdapters": {
"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.",
"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": {
@ -1979,7 +1979,7 @@
}
},
"Zigbee.GetAvailableBackends": {
"description": "Get the list of available Zigbee backends.",
"description": "Get the list of available ZigBee backends.",
"params": {
},
"returns": {
@ -1989,7 +1989,7 @@
}
},
"Zigbee.GetNetworks": {
"description": "Returns the list of configured Zigbee networks in the system.",
"description": "Returns the list of configured ZigBee networks in the system.",
"params": {
},
"returns": {
@ -1999,7 +1999,7 @@
}
},
"Zigbee.RemoveNetwork": {
"description": "Remove the zigbee network with the given network uuid.",
"description": "Remove the ZigBee network with the given network uuid.",
"params": {
"networkUuid": "Uuid"
},
@ -2008,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 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).",
"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",
@ -2437,31 +2437,31 @@
}
},
"Zigbee.AdapterAdded": {
"description": "Emitted whenever a new Zigbee adapter or serial port 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 or serial port 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"
}
},
"Zigbee.NetworkAdded": {
"description": "Emitted whenever a new Zigbee network has been added.",
"description": "Emitted whenever a new ZigBee network has been added.",
"params": {
"zigbeeNetwork": "$ref:ZigbeeNetwork"
}
},
"Zigbee.NetworkChanged": {
"description": "Emitted whenever a new Zigbee network has changed.",
"description": "Emitted whenever a new ZigBee network has changed.",
"params": {
"zigbeeNetwork": "$ref:ZigbeeNetwork"
}
},
"Zigbee.NetworkRemoved": {
"description": "Emitted whenever a new Zigbee network has been removed.",
"description": "Emitted whenever a new ZigBee network has been removed.",
"params": {
"networkUuid": "Uuid"
}