Manage Device Groups

Managing Device Groups - How to create and manage device groups

Introduction

The following steps will guide you through the creation and management of device groups. A device group represent a number of edge devices controlled and managed by the Edgex platform.

Please note that device groups are auto registered by default and you will need to manage them manually only if they are not enabled for auto registration.

Prerequisites

Prerequisite 1: Edgex

Edgex is a vendor neutral open source platform at the edge of the network that interacts with physical devices, sensors, actuators and other IoT objects. It enables the interoperability between devices and applications at the edge and at the cloud.

From a running instance of Edgex, gather the following information:

  • Edgex Instance Name
  • Overall gps coordinates of where the Edgex platform is running
  • Edgex gateway api security token

Prerequisite 2: Project Air UI

Login to TIBCO Project Air UI

Adding Device Groups Steps

Step 1: Click the IoT Management menu on the top left corner and select Gateways.

Gateway Page image

Step 2: On the Gateways page, enter the following information and then click Add Gateway:

  • Device Group Id: the grouping name from Edgex
  • Description: a description for the group of devices
  • Address: the ip address of the machine where Edgex Gateway is running.
  • Latitude: Edgex machine latitude
  • Longitude: Edgex machine longitude
  • Access Token: The Edgex security token

Gateway Add image

Step 3: Verify connection to Edgex

Once the grouping has been added, click the grouping on the Device Groups table on the top-left corner, and then click Ping Gateway. If the connection is succesful, you should see a Success banner. Otherwise, a Failure banner is displayed and you should review that Edgex is running or make sure the Address and Access Token parameters are correct.

Gateway Verify image

Updating Device Group Steps

Step 1: Select grouping to be updated from the Device Groups table.

Step 2: Modify groupin parameters as required. Note that the Device Group Id can not be modified.

Step 3: Click the Update Gateway button.

Update Gateway image

Removing Device Group Steps

Step 1: Select grouping to be removed from the Device Groups table.

Step 3: Click the Delete Gateway button.

Delete Gateway image

Step 3: Verify removed gateway is not longer in the Device Groups table.

Delete Gateway image


Last modified December 3, 2020: add project docs-src (9d6dd4b)