Fixture APIs

Get Sensor Details

This API reports information for an individual sensor at every five-minute interval. The data for the last five minutes of the sensor is reported.

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/sensor/v3/details/{fixture_id}

Parameters

Sample Code

Using the sensor ID returned by the Get Sensor Details by Floor API,  request data such as power, temperature, and light level settings from the sensor with ID ‘28’. For example, request data for the last five minutes for the sensor with ID ‘28’.  

Get https://192.80.3.2/ems/api/org/sensor/v3/details/28

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
 "sensor":[
  {
  "id": "28",
  "name": "Sensor00ce56",
  "power": "69.07",
  "temperature": "74",
  "lightLevel": "50"
  "lastCommunicationTime": "2015-07-21 15:21"
  }
 ]
}

Get Sensor Details by Floor

Returns sensor details for all sensors on the floor for a given period at every five-minute interval. For example, if the duration is from 10:00 am to 10:10 am, data is sent at every five-minute interval. The API retrieves data for a maximum period of one hour. 

The Fixture ID that is returned is used as the primary identifier in other API calls.

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/sensor/v2/stats/floor/{floorId}/{from_date}/{to_date}

Parameters

Sample Code

Request sensor details for all sensors on the first floor with Floor ID ‘1’ from 10 am through 11:30 am on Feb. 12, 2019. Data will be sent at every five-minute interval, which will be 10:05 am and 10:10 am, and so on. The Fixture ID returned for each sensor is used as the primary identifier in other API calls.

Get https://192.80.3.2/ems/api/org/sensor/v2/stats/floor/1/201902120100/201902120200

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
 "sensor": [
    {
      "id": "28", **Fixture ID**
      "power": "27.98",
      "temperature": "78",
      "lightLevel": "773",
      "avgDimLevel": "85",
      "lastCommunicationTime": "2019-02-12 10:12",
      "captureTime": "2019-02-12 10:05"
    },
    {
       "id": "29", **Fixture ID**
       "power": "12.62",
       "temperature": "74",
       "lightLevel": "593",
       "avgDimLevel": "85",
       "lastCommunicationTime": "2019-02-12 10:12",
        "captureTime": "2019-02-12 10:10"
    },
]
 "sensor": [
    {
       "id": "1327",
       "power": "27.98",
       "temperature": "74",
       "lightLevel": "99",
       "avgDimLevel": "85",
       "lastCommunicationTime": "2019-02-12 10:12",
        "captureTime": "2019-02-12 10:15"
    },
    {
        "id": "1377",
        "power": "12.62",
        "temperature": "70",
        "lightLevel": "462",
        "avgDimLevel": "75",
        "lastCommunicationTime": "2019-02-12 10:12",
        "captureTime": "2019-02-12 10:20"     
    }
  ]
}

Get Sensor Location by Floor

Refer to the Get List of Fixtures by Floor.

Get All Fixtures by Area

The API returns the location for all fixtures in an area on a floor. The data is returned as X, Y coordinates of the measured and scaled-down distance from the lower-left corner of the uploaded floor plan.

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/fixture/v1/location/list/area/{area_id} 

Parameters

Sample Code

Request the x- and y-axis coordinates for all sensors in the area with ID ‘9’.

Get https://192.80.3.2/ems/api/org/fixture/v1/location/list/area/9

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
 {
  "fixture": [
    {
      "id": "361",
      "name": "Sensor00c017",
      "xaxis": "966",
      "yaxis": "391",
      "macaddress": "0:c0:17",
      "groupid": "185",
      ..
    },
    {
      "id": "1364",
      "name": "Sensor0629dd",
      "xaxis": "270",
      "yaxis": "90",
      "macaddress": "6:29:dd",
      "groupid": "196",
      ..
    },
    {
      "id": "835",
      "name": "Sensor013ec0",
      "xaxis": "756",
      "yaxis": "462",
      "macaddress": "1:3e:c0",
      "groupid": "55",
      ..
    }
  ]

Get Sensor Profiles

The API returns the existing and applicable profiles that can be assigned to the sensor. The list of applicable profiles displayed is derived from the profile template as the existing profile. The profile group ID returned is used as the primary identifier in other API calls.

Request

GET https:/{em_ip_address_or_hostname}/ems/api/org/fixture/v1/getFixtureApplicableProfiles/{fixture_id} 

Parameters

Sample Code

Using the Fixture ID returned by the Get Sensor Details by Floor API, request the profile name assigned to the sensor. As shown in the response below, Open Office Max 35 is the profile assigned to fixture with ID ‘28’.  In addition to the profile assigned to the fixture, the API also returns the list of applicable profiles and the corresponding profile Group ID derived from Open Office Max 35. The Group ID is used as the primary identifier in other API calls.

Get https:/192.80.3.2/ems/api/org/fixture/v1/getFixtureApplicableProfiles/28

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
 {
  "id": "28",                                   **fixture-id**
 "name": "Sensor00ceed",                        **fixture name**
 "currentProfile": "Open Office Max 35",        **profile name**
 “groupId”: “27”                                **groupID**
 "applicableProfiles":                          **list of applicable profiles** 
 [
 {
 "name": "Open Office Max 35",
 "groupId": "27"
 },
 {
 "name": "Open Office Max 70",
 "groupId": "28"
 },
 {
 "name": "Open Office Max 50",
 "groupId": "29"
 },
 {
 "name": "default.Open Office_Normal",
 "groupId": "46"
 },
 {
 "name": "default.Open Office_AlwaysOn",
 "groupId": "47"
 },
 {
 "name": "default.Open Office_Dim",
 "groupId": "48"
 }
 ]
}

Assign Profile

Assigns a profile to the fixture. The fixture will operate with the new behavior.   

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/fixture/v1/op/assignProfile/{fixture_id}/{group_id}

Parameters

Sample Code

The sample code shows how to assign a profile to a fixture. Use the Fixture ID returned by the Get Sensor Details by Floor and Group ID returned by the Get Sensor Profiles to assign a new profile to the fixture. For example, use the profile Open Office Max 70 with GroupId ‘27’ to assign it to the fixture with ID ‘28’. The response indicates that the profile has been assigned successfully to the fixture.

Post https://192.80.3.2/ems/api/org/fixture/v1/op/assignProfile/28/27

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
  "status": "0"
}

Get Sensor Energy Consumption

Reports energy consumed in watt-hour for the last 15 minutes by the fixture.

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/fixture/v1/energy/{fixture_id}

Parameters

Sample Code

Send a request to the EM using the Fixture ID ‘28’ returned by the Get Sensor Details by Floor API to return the energy consumed in watt-hour for the last 15 minutes.

Get https://192.80.3.2/ems/api/org/fixture/v1/energy/28

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
  "energy": "50.96"
}

Get Sensor Energy Consumption by Area

Returns the aggregate energy consumed in watt hour by all fixtures in the area for the last 15 minutes.

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/fixture/v1/energy/area/{area_id} 

Parameters

Sample Code

Send a request to the Manage using the Area ID ‘9’ returned by the Get all Areas API to return the energy consumed in watt-hour for the last 15 minutes by all fixtures in the area.

Get https://192.80.3.2/ems/api/org/fixture/v1/energy/area/9

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
  "energy": "250.96"
}

Manual Override for a Fixture

Allows you to manually override the fixture or sensor profile settings and dim the light in the fixture to an absolute level for a period of time in minutes.   

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/fixture/v1/op/dim/{mode}/{amount}?time=60

Specify the following data payload to send along with the POST command.

<fixtures>
  <fixture>
    <id>27</id>
  </fixture>
</fixtures>

Parameters

Sample Code

Manually override the sensor profile settings and dim the light to 50% for the fixture with ID ‘27’ for a period of 60 minutes. The status shows that the fixture light was set to dim successfully.

Post https://192.80.3.2/ems/api/org/21/v1/op/dim/abs/50?time=60
<fixtures>
 <fixture>
 <id>27</id>
 </fixture>
</fixtures>

HTTP/1.1 200 
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
  "status": "0"
}

Auto Mode for a Fixture

Sets the sensors to Auto mode. In this mode, the level of occupancy in the area determines the fixture dim level.

Request

POST https://{em_ip_address_or_hostname}/ems/api/org/fixture/v1/op/auto

 <fixtures>
  <fixture>
    <id>27</id>
  </fixture>
</fixtures>

Parameters

Sample Code

Sets the sensor with ID ‘27’ to auto mode. The response is successful which means lights are dimmed based on occupancy.

POST https://192.80.3.2/ems/api/org/21/v1/op/auto
<fixtures>
 <fixture>
 <id>27</id>
 </fixture>
</fixtures>

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/json
Content-Length: 7582
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
  "status": "0"
}

Get Fixture Dim Level by Floor

This API returns the 'current' dim level of fixtures on a floor. The API uses pagination with the ‘page’  query parameters to paginate through the items in a collection. Pagination reduces the overall payload size and increases the API performance.

The sensors in Manage are classified into the following four types; only emergency and fixtured sensors may have dim levels:

1. Emergency sensors: Sensors designated as emergency fixtures in Manage 
2. Desk sensors: Sensors designated as desk sensors 
3. Fixtureless sensors: Sensors designed as fixtureless, including desk sensors
4. Fixtured sensors: Sensors that are not designated as fixtureless; exclusive of 'fixtureless' and inclusive of ‘emergency’ sensors

Request

GET https://{em_ip_address_or_hostname}/ems/api/org/sensor/dimlevel/list/floor/{floor_id}?class={class}&page={page_number}

Parameters

Sample Code

Request the current dim level details for fixtures on the first floor with Floor ID ‘1’. The first floor has 115 fixtures, and the user requests the fourth page of 5 pages. The API returns dim level for 20 fixtures on the floor.

Get https:// 192.80.3.2/ems/api/org/sensor/dimlevel/list/floor/1?class=fixtured&page=4

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Content-Type: application/xml
Content-Length: 837
Date: Sat, 21 Jul 2015 17:06:51 GMT
{
 "sensor":[
  {
     "dimlevel": "37",
     "id": "80",
  },
  {
     "dimlevel": "85",
     "id": "79",
  },
  {
     ...
  }
 ],
 "page": "4",
 "records": "115",
 "total": "6"
}