hub.addons.zwave.nodes.provisioning.list

List all existing provisioning entries if no parameters provided. Otherwise reports entries that satisfy at least one specified provision or node id.

Edit

Field	Type	Required	Description
ids	array of strings	–	Array of provisioning ids which should be present in response
nodeIds	array of integers	–	Array of node ids which should be present in response

Edit

Field	Type	Required	Description
provisioning	array of objects	+	Array of provision entries
provisioning[]._id	string	+	Id of provisioning entry
provisioning[].dsk	array of ints	+	Unique DSK key for Z-Wave device which can be included via Smart Start flow
node	int	–	Node ID in current Z-Wave network if this device has already included
provisioning[].product	object	–	This Information Type is used to advertise the product identifying data of a supporting node.
provisioning[].product.manufacturer	int	+	This field MUST carry the Manufacturer ID advertised by the node in the Manufacturer Specific Report Command (Manufacturer Specific Command Class).
provisioning[].product.type	int	+	This field MUST carry the Product Type ID advertised by the node in the Manufacturer Specific Report Command (Manufacturer Specific Command Class).
provisioning[].product.id	int	+	This field MUST carry the Product ID advertised by the node in the Manufacturer Specific Report Command (Manufacturer Specific Command Class).
provisioning[].product.version	int	+	Application Version (Firmware 0 Version) advertised by the node in the Version Report Command (Version Command Class).
provisioning[].product.subVersion	int	+	Application Sub Version (Firmware 0 Sub Version) advertised by the node in the Version Report Command (Version Command Class).
provisioning[].type	object	–	This Information Type is used to advertise the product identifying data of a supporting node.
provisioning[].type.generic	int	+	These fields MUST carry the Generic Device Class advertised in the node’s NIF. For a detailed description of all available Generic Device Classes, refer to Z-Wave nodes and for Z-Wave Plus nodes.
provisioning[].type.specific	int	+	These fields MUST carry the Specific Device Class advertised in the node’s NIF. For a detailed description of all available Generic Device Classes, refer to Z-Wave nodes and for Z-Wave Plus nodes.
provisioning[].type.icon	int	+	Icon type. This field MUST carry the Specific Device Class advertised by the node’s Root Device Z-Wave Plus Info Report Command.
provisioning[].maxRequestInterval	int	–	This Information Type is used to advertise if a power constrained Smart Start node will issue inclusion request at a higher interval value than the default 512 seconds. Range of 640..12672 seconds. Must be a multiple of 128.
provisioning[].uuid	string	–	This Information Type is used to advertise if a power constrained Smart Start node will issue inclusion request at a higher interval value than the default 512 seconds. Range of 640..12672 seconds. Must be a multiple of 128.
provisioning[].name	string	+	This Information Type is used to advertise if a power constrained Smart Start node will issue inclusion request at a higher interval value than the default 512 seconds. Range of 640..12672 seconds. Must be a multiple of 128.
provisioning[].room	string	+	This Information Type is used to advertise if a power constrained Smart Start node will issue inclusion request at a higher interval value than the default 512 seconds. Range of 640..12672 seconds. Must be a multiple of 128.
provisioning[].securityModes	array of strings	–	This Information Type is used to advertise the Security keys to grant during S2 bootstrapping to a SmartStart node in the Provisioning List. If this Information Type is used the joining node MUST NOT be granted other keys than specified in Granted Keys at the next Security bootstrapping attempt following a SmartStart inclusion. This TLV MUST NOT be used if the joining node is included with classic inclusion and MUST be used only for SmartStart inclusions.
provisioning[].nodeSecurityModes	array of strings	–	Authentication modes which were used during device inclusion.
provisioning[].addingMode	string	+	This Information Type is used to advertise the bootstrapping mode to use when including the node advertised in Provisioning List entry. Possible values: – s2 – the node MUST manually be set to Learn Mode and follow the S2 bootstrapping instructions (if any). – smart – the node will be included and S2 bootstrapped automatically using the Smart Start functionality.
provisioning[].supportedAddingModes	array of strings	+	This Information Type is used to advertise possible bootstrapping modes to use when including the node advertised in Provisioning List entry. Possible values: – s2 – the node MUST manually be set to Learn Mode and follow the S2 bootstrapping instructions (if any). – smart – the node will be included and S2 bootstrapped automatically using the Smart Start functionality.
provisioning[].status	string	+	Current status of this device. Possible values: – added – this device was added to current Z-Wave network – otherNetwork – the controller found this device at least once but it was included to another Z-Wave network – notDetected – the controller has never detected this device. – failed – the controller tried to add this device at least once but something went wrong

Edit

				
					{
   "method": "hub.addons.zwave.nodes.provisioning.list",
   "id": "_ID_",
   "params": {
      "ids": [ "2345794197" ]
   }
}

Edit

				
					{
    "error": null,
    "id": "_ID_",
    "method": "hub.addons.zwave.nodes.provisioning.list",
    "result": {
        "provisioning": [
            {
                "_id": "2345794197",
                "addingMode": "smart",
                "supportedAddingModes" : [ "s2", "smart" ],
                "dsk": [
                    58975,
                    37056,
                    29754,
                    11588,
                    18902,
                    12511,
                    34338,
                    34338
                ],
                "maxRequestInterval": 10,
                "name": "test",
                "product": {
                    "id": 30,
                    "manufacturer": 20,
                    "subVersion": 0,
                    "type": 20,
                    "version": 1
                },
                "room": "none",
                "securityModes": [
                    "accessControl",
                    "authenticated",
                    "unauthenticated",
                    "s0"
                ],
                "nodeSecurityModes": [
                    "accessControl"
                ],
                "type": {
                    "generic": 20,
                    "icon": 30,
                    "specific": 20
                },
                "uuid": "some-uuid"
            }
        ]
    }
}

Edit

none