Get Driver Test Parameters by Fixture¶

This API retrieves the driver test parameters for all emergency drivers connected to a sensor in an emergency fixture. Use the Fixture ID returned by the Get Sensor Details by Floor API to send the command to the sensor controlling the fixture.

The command returns relevant driver test parameters for drivers connected to a sensor of an emergency fixture. See the description of the parameters returned in the table below.

If the API cannot get the results after trying for 60 seconds, the API displays a timeout message that the sensor took too long to respond. If you are trying to get emergency lighting test results from a non-emergency lighting fixture, the API returns an invalid Fixture ID. Check to ensure that the sensor is not offline, correct the API syntax, and reissue the call.

Request¶

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

Response¶

{
   "sensor": [
      {
         "id": "{fixture-id}",
         "emParameters": {
            "emDimLevel": "0-255",
            "emMaxLevel": "0-255",
            "emMinLevel": "0-255",
            "testTimeout": "0-255",
            "prolongTime": "0-255",
            "ratedDuration": "0-255",
            "features": "0-255",
            "testDelayTimeHigh": "0",
            "testDelayTimeLow": "0",
            "functionTestInterval": "0",
            "durationTestInterval": "0",
      }
      }
   ]
}

Parameters¶

Name	Description
Request
em_ip_address_or_hostname	The Manage IP address or hostname
fixture-id	Sensor or Fixture ID. Use the Get Sensor Details by Floor API to obtain the Fixture ID.
Response
fixture-id	Sensor or Fixture ID.
emParameters:
emDimLevel	The level at which a fixture will be illuminated during an emergency; corresponds to DALI command 233.
emMaxLevel	The maximum dim light level of the fixture. Not all drivers support this functionality. Corresponds to DALI command 248.
emMinLevel	The minimum dim level of the fixture, not all drivers support this functionality. Correspond to DALI command 247.
testTimeout	Represents the timeout period at which a driver will stop the test. The minimum timeout duration is 15 minutes. The default is 7 days. Value is defined in 15-minute increments. Corresponds to DALI command 242, DTR= 0x6.
prolongTime	Represents the time period for which the light will remain in emergency mode after the emergency event ends. Value is defined in 30-second increments. The default is 0 seconds. Corresponds to DALI command 242, DTR = 0x07.
ratedDuration	The rated duration of the Manage battery in 2-minute intervals. A value of 255 represents a time of 510 minutes or longer. Corresponds to DALI command 249.
features	Defines which features are or are not available on the driver. Corresponds to DALI command 249.
testDelayTimeHigh	Represents the highest time delay for the test. The sensor will always set the value to '0'. Corresponds to DALI command 234.
testDelayTimeLow	Represents the lowest time delay for the test. The sensor will always set the value to '0'. Corresponds to DALI command 235.
functionTestInterval	The sensor will always set the value to '0'. Corresponds to DALI command 236.
durationTestInterval	The sensor will always set the value to '0'. Corresponds to DALI command 237.

Sample Request¶

Send a request to retrieve the driver test parameters for all emergency drivers connected to the sensor with the Fixture ID '28'. The API returns the test parameters for emergency drivers connected to the sensor with Fixture ID '28' designated as an emergency fixture.

GET https://10.14.3.29/ems/api/org/fixture/v1/28/emParameters

Sample Response¶

{
   "sensor": [
      {
         "id": "28",
         "emParameters": {
            "emDimLevel": "134",
            "emMaxLevel": "254",
            "emMinLevel": "28",
            "testTimeout": "255",
            "prolongTime": "125",
            "ratedDuration": "250",
            "features": "134",
            "testDelayTimeHigh": "0",
            "testDelayTimeLow": "0",
            "functionTestInterval": "0",
            "durationTestInterval": "0"
            }
      }
   ]
}