Touchlink¶

The touchlink endpoint allows to communicate with near by located devices.

Scan for devices ¶

POST /api/<apikey>/touchlink/scan

Starts scanning on all channels for devices which are located close to the gateway. The whole scan process will take about 10 seconds.

Note

While scanning is in progress further API requests which require network access aren’t allowed.

Parameters¶

None

Response¶


HTTP/1.1 200 OK

Possible errors¶

403 Forbidden

503 Service Unavailable

Get scan results ¶

GET /api/<apikey>/touchlink/scan

Returns the results of a touchlink scan.

Parameters¶

None

Response¶


HTTP/1.1 200 OK


{
    "scanstate": "scanning",
    "lastscan": "2013-11-05T08:14:12",
    "result": {
        "1": {
            "factorynew": true,
            "address": "0x0017880100bfbfed"
        },
        "2": {
            "factorynew": false,
            "address": "0x001788010022b40a"
        }
     },
}

Response fields¶

Field	Type	Description
scanstate	String	State of a scan request: idle - scan is finished or was not started scanning - scan is in progress
lastscan	String	UTC time of the last scan in ISO 8601 format.
result	Object	A list of all devices which where found during the scan.

Possible errors¶

403 Forbidden

Identify a device ¶

POST /api/<apikey>/touchlink/<id>/identify

Puts a device into identify mode for example a light will blink a few times.

Note

id must be one of the indentifiers which are returned in the scan result.

Parameters¶

None

Response¶


HTTP/1.1 200 OK

Possible errors¶

403 Forbidden

404 Not Found

503 Service Unavailable

Reset a device ¶

POST /api/<apikey>/touchlink/<id>/reset

Send a reset to factory new request to a device.

Note

id must be one of the indentifiers which are returned in the scan result.

Parameters¶

None

Response¶


HTTP/1.1 200 OK

Possible errors¶

403 Forbidden

404 Not Found

503 Service Unavailable