PUT /devices/{deviceId}/test

<< Click to Display Table of Contents >>

Navigation:  The API > JSON Adminstrator API > REST Resources > Devices > PUT >

PUT /devices/{deviceId}/test

TestDevice

The gateway can try to test/identify devices.

If a device has the flag "testExists" in its profile or device description, the gateway can send out a test procedure to the device to make it do some device specific actions like switch on/of or dim 0%/25%/50%/75%/100%.

 

The test ends by itself or can be stopped with the vale "testState = false"

 

Client to Gateway:

Resource Path

HTTP method

/devices/{deviceId}/test

PUT

 

Necessary  call parameters:

parameter

datatype

value / formatting

description

header

object

{}

 

testDevice

object

{}

 

 

deviceId

string

 

SenderID of Enocean device, EnOcean modules usually send telegrams with their unique 32-bit Chip ID. In the other case, these are the Base ID of the EnOcean device.

 

testState

string

true | false

 

 

eep

string

xx-xx-xx

EnOcean Equipment Profiles, definition of Enocean radio telegram structure

 

 

example:

The example shows the request for the gateway to test a device

 

Basic structure of gateway call:

 

PUT http://hostname:api_port/devices/FFF26803/test
 
{

  "testDevice" : {

    "deviceId" : "FFF26803",

    "testState" : "true",

    "eep" : "D2-01-08"

  }

}