SensorGroups

SensorGroups are a virtual collection of sensors that are created based on the tags that are specified. Each sensor may consist a set of tags. The list of sensors that belong to a SensorGroup can be changed by modifying the tags attached to this SensorGroup. All sensors having the current tags will fall under this SensorGroup automatically for any subsequent operations. SensorGroups can be defined in the CentralService at http://www.example.com:81/api/sensorgroup.

Create SensorGroup

This request creates a new SensorGroup with the name and description in the building specified by the user.

POST /api/sensor_group
JSON Parameters:
  • data (dictionary) – Contains the information about the SensorGroup

    • name (string) – Name of the SensorGroup

    • building (string) – Building to which this sensor group belongs

    • description (string) – Description of the SensorGroup

Returns:

  • success (string) – Returns ‘True’ if data is posted successfully otherwise ‘False’

  • error (string) – An additional value that will be present only if the request fails specifying the cause for failure

Status Codes:

Example request:

POST /api/sensor_group HTTP/1.1
Accept: application/json; charset=utf-8

{ "data": {
              "name":"Test Sensor Group",
              "building":"NSH",
              "description":"Description for Sensor Group"
          }
}

Example response (for success):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "True"
}

Example response (for failure):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "False",
  "error": "Building does not exist"
}

Get SensorGroup Details

This request retrieves the details of a SensorGroup

GET /api/sensor_group/<name>
Parameters:

  • name (string) – Name of Sensor group (compulsory)

Returns:

  • name (string) – Contains the name of the SensorGroup

  • description (string) – Contains the description of the SensorGroup

  • building (string) – Contains the name of the building of the SensorGroup

Status Codes:

Example request:

GET /api/sensor_group/Test HTTP/1.1
Accept: application/json; charset=utf-8

Example response (for success):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success" : "true"
  "name":"Test",
  "description": "A SensorGroup for Test"
  "building":"NSH"
}

Example response (for failure):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "False",
  "error": "SensorGroup does not exist"
}

Delete SensorGroup

This request deletes the SensorGroup

DELETE /api/sensor_group/<name>
Parameters:

  • email (string) – Name of the SensorGroup

Returns:

  • success (string) – Returns ‘True’ if the SensorGroup is successfully deleted otherwise ‘False’

Status Codes:

Example request:

DELETE /api/sensor_group/Test HTTP/1.1
Accept: application/json; charset=utf-8

Example response (for success):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "True"
}

Example response (for failure):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "False",
  "error": "SensorGroup does not exist"
}

Add tags to SensorGroup

This request adds the tags specified in the request to the SensorGroup

Note: The list of tags sent in this request will overwrite the previous list.

POST /api/sensor_group/<name>/tags
Parameters:

  • name (string) – Name of SensorGroup

JSON Parameters:
  • data (dictionary) – Contains the information of the tag to be added to the SensorGroup.
    • tags (list) – Contains the list of tag key-value pairs

      • name (string) – Name of the tag point

      • value (string) – Value of the tag point

Returns:

  • success (string) – Returns ‘True’ if data is posted successfully otherwise ‘False’

Status Codes:

Example request:

POST /api/sensor_group/test/tags HTTP/1.1
Accept: application/json; charset=utf-8


{
  "data":{
      "tags":[
           {
            "name": "Corridor",
            "value": "3600"
           },
           {
            "name": "Room",
            "value": "3606"
           }
          ]
  }
}

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "success": "True"
}

Get list of tags in SensorGroup

This request retrieves two lists of key-value pairs, one list contains the array of eligible tags that can be attached to this SensorGroup and the other list contains the array of tags that are currently attached to this SensorGroup.

GET /api/sensor_group/<name>/tags
Parameters:

  • name (string) – Name of SensorGroup (compulsory)

Returns:
  • tags (list) – Contains the list of tag key-value pairs that are available for the building in which this SensorGroup is located

    • name (string) – Name of the tag point

    • value (list) – List of eligible values for this certain tag

  • tags_owned (list) – Contains the list of tag key-value pairs that are attached to this SensorGroup

    • name (string) – Name of the tag point

    • value (string) – Value for this tag

Status Codes:

Example request:

GET /api/sensor_group/test/tags HTTP/1.1
Accept: application/json; charset=utf-8

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
  "tags": {
           "Corridor": [
                        "3600",
                        "3700"
                       ],
           "Floor": [
                     "3"
                    ],
           "Room": [
                    "3606"
                   ]
          },

  "tags_owned": [
                  {
                   "name": "Corridor",
                   "value": "3600"
                  },
                  {
                   "name": "Floor",
                   "value": "3"
                  },
                  {
                   "name": "Room",
                   "value": "3606"
                  }
                ]
}