2. Edge Xpert Manager¶
Edge Xpert Manager is the tool provided by IOTech to easily control and monitor the Edge Xpert microservices.
Features of Edge Xpert Manager include:
- Viewing devices and performing control and configuration operations on them
- Visualizing data that is streamed from devices
- Setting up and monitoring schedules and events
- Creating and managing export services, i.e the recipients of the data from EdgeX
- Gathering and viewing logs produced by the EdgeX microservices
- Viewing, and where possible, configuring meta data within EdgeX
In addition, many of the commands described in the EdgeX documentation can be more easily performed by using the features of the Edge Xpert Manager.
Edge Xpert Manager consists of a microservice and a web-based user interface application. The user interface requires that the microservice is already running.
The Edge Xpert Manager microservice can be started with the –ui option of the edge.sh up command.
This guide describes the use of the Edge Xpert Manager with reference to the devices started by the virtual device service. For information about Virtual Device please refer to EdgeX Virtual Device
2.1. Starting the microservice¶
Start Edge Xpert with the edge.sh up command and include the Edge Xpert Manager microservice option (–ui). In this guide, we also use the Consul Registry (–consul), Logging (–logging) and Virtual Device (–virtual) options:
$ cd ~/edgexpert $ ./edgex.sh up --consul --logging --virtual --ui Creating network "edgexpert_edgex-network" with driver "bridge" Creating volume "edgexpert_db-data" with default driver Creating volume "edgexpert_log-data" with default driver Creating volume "edgexpert_consul-config" with default driver Creating volume "edgexpert_consul-data" with default driver Creating edgex-files ... done Creating edgex-core-consul ... done Creating edgex-config-seed ... done Creating edgex-mongo ... done Creating edgex-support-logging ... done Creating edgex-core-data ... done Creating edgex-core-metadata ... done Creating edgex-core-command ... done Creating edgex-export-client ... done Creating edgex-export-distro ... done Creating edgex-device-virtual ... done Creating iotech-manager ... done
The Edge Xpert Manager microservice runs starts a web-interface on port 8080 as can be shown by the status command:
$ ./edgex.sh status .. iotech-manager /bin/sh -c java -Dconfig=c ... Up 0.0.0.0:8080->8080/tcp
2.2. Starting the User Interface¶
In a browser, navigate to localhost:8080, or use the Chromium “Edge Xpert Manager” bookmark provided in the Edge Xpert VM. Edge Expert Manager will connect and initially display the Devices view:
The Devices view will display all of the devices that are currently configured and running in EdgeX. When the virtual device service is running (as described above), the simulated devices will be displayed similar to as follows:
The Devices view includes the capability to search for particular devices and view properites of each device. Device properties include its operating State, admin state (locked/unlocked) and the last time the device was connected. The interface also allow for more detailed device information to be viewed, for the device to be locked or unlocked and for the device to be controlled as per its interface. The Devices view also provides options to add new devices to EdgeX or delete them.
2.3.1. View Device Data¶
To view more detailed information for a specific device, click the “View Device” (i) icon in the device table. This view shows device information such as its description, manufacturer, model etc as well as status and service details. Use the scroll bar to see all data available.
2.3.2. Lock or Unlock a Device¶
To lock or unlock a specific device, click the “Lock Device” (lock) icon in the device table. The interface presents a confirmation screen for locking or unlocking the device.
2.3.3. Control a Device¶
To control the specifics of a device, click the “Control Device” (dial) icon in the device table. The interface presents the configurable values that are defined by the device. For example, for the “JC.RR5.NAE9.ConfRoom.Padre.Island01” virtual device:
Then to set data for these values, the click the “Set Value” (write) icon. For example, for the “JC.RR5.NAE9.ConfRoom.Padre.Island01” virtual device the Current Temperature’s collection frequency could be changed as follows:
2.3.4. Add a Device¶
A new device can be added by clicking the “Add Device” (plus) icon on the devices pane.
2.3.5. Delete a Device¶
A device can be deleted by clicking the “Delete Device” (cross) icon in the device table. The interface presents a confirmation screen for deleting the device.
The Readings view will display data from the devices selected by the user. For easy visualization, the data is presented in both table and graph form.
As an example, if the user selects the “JC.RR5.NAE9.ConfRoom.Padre.Island01” virtual device, information like the following information is presented:
In addition, the data is presented in graph form when clicking the “Show Graph” button:
The user is able to search for specific readings and specify a time/date period for which the data should be displayed.
The Schedules view allows for the visualization, creation and management of events scheduled in EdgeX. For more information about Schedules please refer to EdgeX Scheduling
To view the schedules for a specific device, click the “Show Events” (cog) icon in the schedules table:
To view the details of a specific scheduled event, click the “View Scheduled Event” (info) icon in the events table:
The Export view allows for the visualization, creation and management of the recipients of data from EdgeX via Export Service. For more information about Export Services please refer to EdgeX Export Services
The Logs view presents items that are logged by the EdgeX microservices while they are running. These can be useful to verify and diagnose EdgeX behavior. For information about Logging please refer to EdgeX Logging:
Again, the user is able to search for specific log items and specify a time/date period for which the log data should be displayed.
2.8. Meta Data¶
The Meta Data pages display information about the device data maintained within EdgeX. For information about MetaData Profiles and Addressables please refer to EdgeX MetaData
The Profiles view display information for each device usually defined in the device’s associated YAML file. For information about Device Profiles please refer to EdgeX Device Profiles
With the virtual device service running (as described above), the profiles for the simulated devices will be displayed similar to as follows:
To view the profile for a specific device, click the “View Device” (info) icon in the profiles table. Use the scroll bar to see all data available.
An addressable is the metadata required to make a request to an EdgeX target.
With the virtual device service running (as described above), the addressables for the simulated devices will be displayed similar to as follows:
Edge Xpert Manager provides the capability to add, edit and delete EdgeX addressables.
The Edge Xpert Manager contains a facility whereby the state of the tool can be captured and exported to a file. In the event of any issues, please send this file to IOTech for analysis.