Repeater Pairing
Starts or stops time window for repeaters to pair with gateway.
POST /api/v2/repeaters/beginPairing [SECURED]
Body Parameters
Property | Description | Type |
---|---|---|
timeout | Time window (in seconds) to allow zigbee repeaters to join and pair with gateway. | integer default: 60 min: 0 max: 254 |
Responses
200 OK
Time window to allow repeaters to pair has started. timeout
is greater than zero.
{
"status": 200,
"returnCode": 1012,
"message": "Gateway listening for repeaters."
}
200 OK
If timeout
is zero, then gateway will cut time window prematurely and stop listening for repeaters.
{
"status": 200,
"returnCode": 1013,
"message": "Gateway has stopped listening for repeaters."
}
400 Bad Request (Invalid timeout
or timeout
greater than 254)
timeout
or timeout
greater than 254){
"status": 400,
"message": "Invalid integer value for timeout query parameter. Must be a valid integer between 0-254",
"returnCode": -16
}
POST /api/v2/repeaters/endPairing [SECURED]
This is a convenience endpoint. It is equivalent to calling POST /api/v2/repeaters/enablePairing?refresh=0
. Even though no body parameters are required, the body should have an empty JSON payload {}
.
Responses
200 OK
{
"status": 200,
"returnCode": 1013,
"message": "Gateway has stopped listening for repeaters."
}
Updated less than a minute ago