Driver Status to Normal (Stop Test)¶
When this API call is issued, the emergency drivers connected to the Enlighted sensor will return to a 'normal' state by stopping all emergency tests.
Include the Fixture ID of the sensor controlling the fixture in the PUT request. Use the Get Sensor Details by Floor API to obtain the Fixture-ID.
The API returns OK to indicate that the Enlighted Manage (EM) has sent the stop test command to the sensor. 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 driver test status for 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¶
PUT https://{em_ip_address_or_hostname}/ems/api/org/fixture/v1/{fixture-id}/emergencyMode
{
"emergencyMode": "..."
}
Response¶
{
"emFixtureStatus": "ems/api/org/fixture/v1/{fixture_id}/emFixtureStatus"
}
Parameters¶
| Name | Description |
|---|---|
| Request | |
| fixture_id | Sensor or Fixture ID. Use the Get Sensor Details by Floor API to obtain the Fixture ID. |
| emergencyMode | 2 – Stop Test (corresponds to DALI command 229, referencing 8-bit value for DALI Command 250). |
| Response | |
| Status | 200 – The Enlighted Manage has sent the stop test command to the sensor. |
| 400 Bad Fixture ID – Invalid Fixture ID, please correct and try again. | |
| 400 Bad Body Format – Incorrect body format, please correct and try again. | |
| 403 Bad Request – The user does not have permission to issue this API call. | |
| 404 Not found – This Fixture ID does not represent an emergency fixture. This function is only supported only by emergency fixtures, please select an appropriate Fixture ID. | |
| 408 Delayed Response – The sensor took more than 60 seconds to respond but the sensor is online. If occurring frequently this could indicate wireless network setup or interference issues. | |
| 500 Internal Server error – Oops, it looks like this sensor is offline, it has not been heard for more than 15 minutes. Please resolve the issue and try again. If the sensor is powered and the issue persists, this could indicate a wireless network problem where the sensor is out of range or interfered with by another RF source. | |
| emFixtureStatus | URI for the API user to request the emergency fixture status of the fixture to confirm fixture status change |
Sample Request¶
Using the Fixture ID returned by the Get Sensor Details by Floor API, stop running the emergency test for all drivers connected to the sensor with Fixture ID '28'. It returns status code 200 OK to indicate that the Enlighted Manage has sent the stop test command to the sensor. The response provides the URI to get the emergency fixture status of the fixture.
PUT https://10.45.2.13/ems/api/org/fixture/v1/28/emergencyMode
{
“emergencyMode”: “2”
}
Sample Response¶
{
"emFixtureStatus": "ems/api/org/fixture/v1/28/emFixtureStatus"
}
Community
Connect and Collaborate with Industrial Professionals and Join the Community!