Switch Groups control turning on or off a group of fixtures . This API returns all Switch Groups on a floor in the building. The response includes the Switch Group ID and Switch Name for each Switch Group. The Switch Name and ID are used as the primary identifiers in other API calls.
|em_ip_address or hostname||The Enlighted Manage (EM) IP address or hostname.|
|facility||The facility type can be either a floor or a company.|
|fid||Company or Floor ID. By default, the Company ID is always ‘1’. For Floor ID, use the Floor ID returned in the Get All Floors API or in EM, select Facility > Floor > in the left panel, and click the Settings tab to obtain the Floor ID.|
|id||Switch Group identifier in EM|
|name||Switch name (**used as the primary identifier in other API calls)|
|description||Description of the switch group|
id: Floor identifier
name: Name of the floor
description: Floor description
floorPlanUrl: Floorplan image name
installedSensors: Number of sensor installed in that floor
installedFixtures: Number of fixtures installed in that floor
siteId: Site identifier
calcMethod: Energy savings are calculated based on the sensor’s baseline energy or contract baseline energy
tenant: Tenant identifier and name
contractBaseline: Baseline energy savings for the groups
iconScaleFactor: Icon size
ceilingHeight: Ceiling height of the building
elevation: Vertical distance above or below the ground floor
tagEventFrequency: Communication frequency of the device to Sensor or Manage
batteryEventFrequency: Communication frequency to fetch Battery Level of the devices
parentFloorId: Parent floor identifier.
Using the Floor ID returned in the Get All Floors API, request for the list of all switch groups on the floor. The Switch Group ID and Switch name for all switch groups on Floor 1 is returned. For example, if Floor 1 has two switch groups, the Switch Group ID and Switch name are returned as shown below. The Switch name is used as the primary identifier in other API calls.
Article is closed for comments.