Update Test Parameters for a Fixture

This API updates relevant driver test parameters for the emergency driver connected to the sensor. Use the Fixture ID returned by the Get Sensor Details by Floor API  to update the following driver test parameters for the emergency driver connected to the sensor.

• Enlighted Manage Dim Level – This is the light level at which a fixture will be illuminated during an emergency (0-100%). The fixture manufacturer sets the default value.
• Test timeout – This is the timeout period, after which a driver will stop a test or stop trying to run a test. This parameter is relevant to duration tests, and the value is defined in 15-minute increments. The minimum timeout is 15 minutes (0), and the default is seven days.
• Prolong time – This is the length of time the light will stay in the emergency state after an emergency event, such as a power failure, ends. The value is defined in 30-second increments; the default value is 0 seconds.

Note: You will not be able to update test parameters on a fixture that is already performing an emergency test. Stop the test and then send the API request.

Request

PUT https: //{em_ip_address_or_hostname}/ems/api/org/fixture/v1/{fixture-id}/emParameters

{
    "emDimLevel": "..."
    "testTimeout": "..."
    "prolongTime": "..."
}

Response

{
   “emFixtureStatus”: ems/api/org/fixture/v1/{fixture-id}/emFixtureStatus 
}

Parameters 

Sample Code

Using the Fixture ID returned by the Get Sensor Details by Floor API, update the driver test parameters' values for the emergency driver connected to the sensor with Fixture ID '28'. The API returns status code 200 to indicate the Enlighted Manage has sent the appropriate messages to the sensor. 

Note that if you attempt to update the test parameters on a fixture that is already performing a test, then Manage will reject the API request.

PUT https: //{em_ip_address_or_hostname}/ems/api/org/fixture/v1/28/emParameters
{
  "emDimLevel": "120"
  "testTimeout": "84"
  "prolongTime": "20"
}

Response

HTTP/1.1 200
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 54
Date: Sat, 26 Sep 2020 10:36:51 GMT
{
  “emParameters”: "ems/api/org/fixture/v1/28/emParameters"
}