V1.0

EdgeX Fuji version 1.0.4 in Windows 10 LTSC 64bit

Content

Introduction EdgeX UI Go Console • Create User and login • Gateway • Device Service • Logging • Scheduler • Notification • Multimedia • Export • Rule Engine

Introduction

The EdgeX UI is for demonstration and developer use to manage and monitor a single instance of EdgeX Foundry. Specifically, it can:

Manage the EdgeX objects (device, device services, profiles, etc.)
Monitor the EdgeX data flow (events and readings) and services
Monitor and manage from on-box with EdgeX (on the same host)

As is, the EdgeX UI is not meant for production use!

The EdgeX UI supports the functions

Multiple gateways.
Device service
Logging
Scheduler
Notification
Multimedia
Export
Rule Engine

Note:

It is form open source community. Majorly, we use it for the device service development and testing.
It supports multiple gateway usage
Fuji version uses Application service to replace Export service. So Export and Rule Engine are not applicable for this version.
Notification service needs to combine some related REST API calls to make it working.

EdgeX UI Console

If this is your first deploy and open EdgeX UI, you will automatically jump to the user creation page:

Open a browser and go to: http://10.0.75.1:4000
Login: Input Username: admin, Password: admin, click Sign in to login EdgeX UI.

Gateway

EdgeX UI Go Console supports multiple gateway devices management. One is to collect various sensor data, and the other one is to send the data to the applications which are hosted on different clouds or enterprise servers.

User add one gateway instance before operating other function modules:

Click Add to add one gateway

2. Gateway addition with 10.0.75.1

3. Below is a completed setup

Device Service

After you create and register devices in EdgeX, you can use Device service page to manage all your device services and devices.

EdgeX uses a device profile to describe the device, its data format and supported commands.

1. In the first table DeviceService, all device services are listed: a. Addressable button can show some information about this device service:

b. Devices button lists all devices, you can manage the devices

c. In Devices table, Commands button can send commands to the device.

d. Set Parameter range of GenerateRandomValue_Int8

e. Outputs the minimum or maximum values by setting the parameter.

f. Click + to add a new Device

g. Fill the data: • DeviceService Name: DeviceService Name • Device Name: Same as DeviceService Name • DeviceProfile: DeviceProfile Name • DeviceAddressable: i.e. other, address: 10.0.75.1, and port: 301

2. The second table Device Profile, user can use profile.yml (ie.mqtt.test.device.profile.yml) to create Device Profile.

Note: Use can use REST APIs to collect data and send commands in the application. The sample REST API call is http://127.0.0.1:Port/api/v1/device/name/Devices Name/Commands Name.

Logging

Logging is critical for all modern software applications. Proper logging provides the users with the following benefits:

Ability to monitor and understand what systems are doing
Ability to understand how services interact with each other
Problems are detected and fixed quickly
Monitoring to foster performance improvements

The Logging provides the user the capability to monitor the system operation and debug problems. Logging may be used to limit to any range of dates and output records.

Scheduler

The Scheduler can be configured to remove stale event/reading data that has not been exported. The removing state event/reading data enables the gateway to continue to operate with a static amount of storage.

Scheduler can manage all Intervals.

1.In the Scheduler table: Click + to add a new Scheduler, you can decide SchedulerName, SchedulerStart, SchedulerEnd, Scheduler Frequency, SchedulerCron, and SchedulerRunOnce: a. ScheduleName: unique name of the service. b. ScheduleStart: identifies when the operation starts. Expressed in ISO 8601 YYYYMMDD't'HHmmss format. Empty means now. c. SchedulerEnd: identifies when the operation ends. Expressed in ISO 8601 YYYYMMDD't'HHmmss format. Empty means never. d. ScheduleFrequency: identifies the interval between invocations. Expressed in ISO 8601 PxYxMxDTxHxMxS format. Empty means no frequency. e. ScheduleCron: cron styled regular expression indicating how often the action under interval should occur. Use either runOnce, frequency or cron and not all. f. SchedulerRunOnce: boolean indicating that this interval runs one time - at the time indicated by the start.

Note: When user create a new Schedule, user should create ScheduleEvent in this Schedule.

2. In the SchedulerEvent table: a. Click + to add a new SchedulerEvent

b. After added a new SchedulerEvent

c. Addressable can show method and url in this action

Notification

Notification to manage notifications, to view transmissions, or custom subscription to receive notifications or logs. Besides, if you combine Alert Notification and Rule Engine settings, users will be notified in time through e-mail when the setting conditions are triggered, and inspection management is supported.