Repeaters

Managing repeaters and enabling them to pair with gateway.

Repeaters are zigbee nodes that can resend zigbee events, useful for ensuring areas that might encounter some interference still receive events to and from the gateway.

GET /api/v2/repeaters{?refresh} [SECURED]

Retrieves list of repeaters that are currently paired with gateway. May not reflect accurately due to caching, therefore refresh can be used if new repeaters are added to force a zigbee scan.

Query Parameters

NameDescriptionType
refreshForce a zigbee scan instead of returning results that might be cached.boolean
default: false

Responses

200 OK

{
  "status": 200,
  "returnCode": 15,
  "count": 2,
  "repeaters": [
    {
      "extendedAddress": "00:11:22:33:44:55:66:77:88",
      "shortAddress": 1234,
      "label": "Cashier 1",
      "manufacturerId": 4126,
      "profileId": 49413,
      "parentShortAddress": 65534,
      "firmwareVersion": "22A7",
      "hardwareVersion": 7745,
      "remainingChildren": 18,
      "deviceType": 196616,
      "deviceModel": "XB24-ZB XBee Wall Router",
      "status": "ACTIVE",
      "lastSeen": "2013-11-20T09:59:34"
    },
    {
      "extendedAddress": "00:11:22:33:44:55:66:77:a0",
      "shortAddress": 4212,
      "label": "",
      "manufacturerId": 4126,
      "profileId": 49413,
      "parentShortAddress": 65534,
      "firmwareVersion": "2270",
      "hardwareVersion": 7745,
      "remainingChildren": 12,
      "deviceType": 196616,
      "deviceModel": "XB24-ZB XBee Wall Router",
      "status": "INACTIVE",
      "lastSeen": "2013-11-19T23:43:12"
    }
  ]
}

400 Bad Request

Bad value for refresh query.

{
  "status": 400,
  "message": "Invalid boolean value for refresh parameter. Must be true or false.",
  "returnCode": -15
}

DELETE /api/v2/repeaters [SECURED]

Clear table of repeaters.

Responses

200 OK

{
  "status": 200,
  "returnCode": 1006,
  "message": "Repeater clearing successful."
}