> For the complete documentation index, see [llms.txt](https://edgex-api-advantech.gitbook.io/edgex-api-doc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://edgex-api-advantech.gitbook.io/edgex-api-doc/smart-device-services/smart-device-ui.md).

# DeviceChecking / Server

## **Content**

* Introduction
* Create User and login
* Dashboard
* Details
* Server Performance
* Peripheral Devices
* Network Devices
* System Setting
* Export Setting
* Alarm Setting
* User Setting
* Alarm Analysis Report

## Introduction

DeviceChecking is a standalone tool for device management. Now it has two editions,

* standard edition for client PC’s device monitoring&#x20;
* and the other one is for server monitoring.

Server monitoring edition contains all features of standard edition, and includes extra features as below

* Server performance monitor
* Network device monitoring, including IP camera, SNMP network devices

### USM Server Monitor Setup Revision History

<figure><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FxjJ0CJjgy8FgdkQGhQH1%2F00.PNG?alt=media&amp;token=115d53a4-5f07-4a87-b086-9963560f4c39" alt=""><figcaption></figcaption></figure>

## **Create User and login**

After EdgeX is running, click DeviceChecking icon on desktop, it should automatically jump to the user creation page:

Login: Input Username: admin, Password: admin, click Sign in to login DeviceChecking/ Server.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FNzCV98lYlWE9CvbAkFAz%2F2.JPG?alt=media\&token=fecf3c47-7b7b-4ba6-930e-ef688cc8cfc2)

## **Dashboard**

### System **I**nfo

Click Dashboard > System Info. In the System Info section, you can view the following information:

* Resource and Network

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FCkDdDkndPmDczGWWcKup%2F1.JPG?alt=media\&token=ddc6dbfd-3eb2-4e8f-9f0b-07f91b2fb0de)

* System configuration and Event list

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FjpdzKTV3FikzWYq0KEJn%2F2.JPG?alt=media\&token=9718bd14-c266-4841-9d35-db2401dc2b90)

### **Sensor Information**

Click Dashboard > Sensor. In the Sensor section, you can view the following information. Setup two sensors to get every data per 5 minutes. Measure ambient temperature, humidity, and battery.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FBJY5VRFxWAwKgUMtKbVC%2Fd1.jpg?alt=media&amp;token=932c7dbe-7bc9-415b-a9bc-9e926fc2d98a" alt=""></div>

## **Detailed**

Click Detailed, and then click Monitor to view the following information. You can see details about device’s information.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FUKkTjWCpfYiiKqmaqwKJ%2F11.JPG?alt=media\&token=69f2ac94-a075-467f-8e06-b4f47bf4ea28)

## **Server Performance**

The System Monitor is designed to offer you a simple way to monitor CPU usage, memory usage, memory usage rates. Main Disk drive and Network components info of your PC. Since you know what is consuming your CPU, RAM, Disk and Network, you can deal with them in time to ensure good computer performance.

### Processor

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FEDWbj5wP8fbJNDI5gULs%2Fe1.JPG?alt=media&amp;token=847ea66d-79fc-45fe-b502-744275e25fdd" alt=""></div>

### Memory

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2F9xXHCc61DFyjBTNjtiF2%2Fe2.JPG?alt=media&amp;token=a7ea904b-03e8-41d0-952a-a0d9b9297fe9" alt=""></div>

### Disk

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FBJ95LrUB0DqNXKJLiKSd%2Fe3.JPG?alt=media&amp;token=bbb477bf-4235-4fb3-bece-ead701466f80" alt=""></div>

### Network

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FRu36pXYp4zemmy6UT9gs%2Fe4.JPG?alt=media&amp;token=acbc446f-bbf4-4403-ae39-e1b61a34ebd8" alt=""></div>

## Peripheral Devices

Click Peripheral Device, you can check USB and Monitor as below information:

### USB&#x20;

Under **USB** you can see your connected USB devices. You also can find PID & VID on Windows: Go to Control Panel > Device Manager and find your USB device. Go to the Details tab and select Hardware ID to view its PID and VID.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FxPoMQKvrqomeM1AsHeBd%2F3.JPG?alt=media\&token=1bda3f4a-dbee-406f-98d2-36d9cad86a29)

### Monitor

Under **Monitor** you can see your connected monitor devices. In the case of a HDMI monitor with an industry-standard Full HD 1080p resolution, this display has a resolution of 1920 x 1080 @ 59Hz.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FYh8I3TSf5nZOC445CIKd%2F4.JPG?alt=media\&token=edb495b6-5f78-445f-b025-3413552081e0)

## Network Devices

### IP Camera

1\. Support ONVIF-compliant IP Camera as below list

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FX8TvUWKHxWZMYFaRhfrF%2Faa.JPG?alt=media\&token=508286d7-14bf-4c72-9923-f1ec9a5c6a91)

2\. Check the IP Camera's serial number, and then click + to add the IP Camera's serial number and Tag.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FYGvGX0RKNkzmTJ6urKW7%2Fcamera-1.JPG?alt=media\&token=c9c5b9b2-4967-4d73-9ccf-3e34c7bbecdc)

3\. Use IP Camera's utilities to get them IP Address.

(1) Example: GV-TBL2703, GV-TDR2700\
&#x20;     Open the GV-IP Device Utility, click **Search** icon to get IP Address.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FFQywNmx5Q8DyXKiT0DiZ%2Fa-1.JPG?alt=media&amp;token=e611eebe-d42e-4739-bd60-a5ccc51e047f" alt=""></div>

(2) Example: VIVOTEK FD9360-H\
&#x20;     Open the Sheper utility, it will auto search and get it's IP Address.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FKxWWbtAejBi8soSbS8sq%2Fa-2.jpg?alt=media\&token=d01cce85-cdfe-4ac4-945c-13c9864dfe73)

4\. Click + to add the IP, ID and Password.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FejsVDe0lUP7u1d9iawwg%2Fcamera-2.JPG?alt=media\&token=5f9380e3-2a63-4106-a4e1-c5a720ab1055)

Notice:\
(1) Edit IP Config, please click **Edit Settings** icon. If user wants to change IP, it needs to remove the original device and then create a new one.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2F34oMIP53dRcyKN1QKANH%2Fs1.JPG?alt=media\&token=460bcc65-6ed7-447d-96a3-03c1aa48da9d)

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FekBmoPzCh3EWHbTvsmYc%2Fs2.JPG?alt=media&amp;token=541ade59-bb2d-465f-8ac7-aa90d31becad" alt=""></div>

(2) We suggest to make Firefox the default browser.

(3) GeoVision's IP camera firmware version 1.05 or later can be performed.

5\. Wait for few minutes to scan and add new IP camera.

6\. Click **View** to catch the photo.\
&#x20;    Note: it's performance depends on IP camera ability.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2Fv4evWTCB83VAQp0wg1Mq%2Fx1.jpg?alt=media&amp;token=4f312443-ba8a-4997-9eee-519a505427be" alt=""></div>

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FwnhzU3NQ7NRDPO71w8xS%2Fa%2B.JPG?alt=media\&token=97e7dd41-ae0a-4cdc-a985-40b5a214cadb)

### SNMP devices

Click + to add the Device ID and IP for localhost PC and remote control PC. Choose the Scan tab, you can see all PC's information.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2Fc4TnBuiLDyHssl48e0Od%2Fa3.jpg?alt=media&amp;token=30367ba2-c57d-4f47-86fe-f18da9495d1c" alt=""></div>

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2F9L5IMtzr91Gietyxa0TU%2Fa1.JPG?alt=media&amp;token=5414e76b-7e56-41c0-b37b-1827774ea367" alt=""></div>

## **System Setting**

Click System Setting > Device Setting. You can find the Machine ID is auto filled in below Machine ID column. Auto fill in the Machine ID when start influxdb export register.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FyTibkFYH8B9CdYkytLF2%2F1.JPG?alt=media&amp;token=829d430d-527e-4ee8-a135-59d919ec26c1" alt=""></div>

## **Export Setting**

### Data Service

only devices after filtering will be displayed on the Grafana dashboard&#x20;

(1) Click Export Setting > Data Service. It was automatically fill a series of data in below columns of Analytics DB IP and Analytics DB port when start the influxdb export register.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2F72KhYrnQDpOuSBmwFH9b%2F2.JPG?alt=media\&token=f290d996-fc34-4c9f-8ae0-00edad358ed7)

(2) By selecting one of the data sources available on the list (ex. cpu), and then click Save.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FcxTwnLjC2EY5rB7slNJU%2F3.JPG?alt=media\&token=d5b11f54-c3b5-4cff-a34c-aaeb7c517116)

(3) Only devices (CPU) were filtered to display on the Grafana dashboard.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FpB2yBQvvfa70OhNJUTVW%2F8.jpg?alt=media\&token=a9b95788-51d3-472a-85ac-402ad9726bef)

### Event Export

You can export your events data as CSV file that it will be saved in your default download location.

(1) Select Data Source (ex. cpu, memory).

(2) Select Duration for All Data or set limit time. File Path, there is default location for the log file to be stored. After setup click Submit.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FmrHqoKzBZYRKW2lTMC3F%2F1.jpg?alt=media&amp;token=ca005cf7-c5da-4aeb-a3ec-6e7dbbe44094" alt=""></div>

(3) Wait for a few seconds, click the Download icon.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2Fm07ZxMZQMhIVfpzNCc2R%2F2.JPG?alt=media&amp;token=cc74064a-4298-4d8e-9691-b0e764b39dfe" alt=""></div>

(4) You can check CPU detail information as below list.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2F8zYWApgx4IN3QXTKyh13%2F3.JPG?alt=media\&token=2bd76e78-6350-45da-b5b3-69e34513c32e)

### **FTP Server**

Upload event data from the default location where downloaded file to FTP server.

(1) Setup log-in FTP server information include its IP, port, user name, password, and target directory, confirm by clicking Save.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2Fe8h92bUxRub0bBQ37Y7c%2Fd1.JPG?alt=media&amp;token=b4057e6d-514f-41fc-80f6-ac850eb12751" alt=""></div>

(2) Goes to **Detailed** on the left side menu. Select **Upload** tab that it will pop-up a FTP server setup window, the content is the same as before, confirm by clicking Save.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FDy1CXGgPbtVepY1IcZE8%2Fd2.jpg?alt=media&amp;token=a6986397-0d64-4a48-a0cc-a23a13dbd7c3" alt=""></div>

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FZzURgsX1WNguElkL1Vh4%2Fd3.JPG?alt=media&amp;token=c1e67130-56cc-4613-a813-b161bdc9547a" alt=""></div>

(3) Enter the hostname, username, and password  into the Quickconnect bar's of FileZilla, and then click on Quickconnect. If all works well, the uploaded files and directories should now be displayed in the server content listing at the right side of the window.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2Fd7gqg5PHDtSw43W8VrOK%2Fd4.jpg?alt=media&amp;token=54ea578b-cea3-4bcf-a963-4660f39b5368" alt=""></div>

## **Alarm Setting**

&#x20;We demo how to enable alarm notification on the setting page. To allow the DeviceOn and Patrol Inspection system receive alarm notifications when alarm events are triggered.

&#x20;Click Alarm Setting > Threshold Setting. Select add icon “+” on the top right side.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FFGIdWFmgpfBcmufoMStz%2Fs1.jpg?alt=media&amp;token=5a6db7b1-5142-439c-a488-b675b9cdb56a" alt=""></div>

* Add an Alarm Rule on DeviceOn system&#x20;

(1) Fill in the table below. Turn on DeviceOn, and then click Submit.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FLHwoNDZD9W9spusf0a8r%2Fs2.JPG?alt=media&amp;token=11d17cee-8963-492e-95d6-30fda52eaf7f" alt=""></div>

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2Fa9Yc2NOMMJwqC5YFJab1%2F16.JPG?alt=media\&token=6c41681f-64c7-4af8-a3f6-22418d1118eb)

(2) Make sure Status is the running and Actions is DeviceOn.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FwSfdNjQrtZIOSYDNBjS4%2Fs3.JPG?alt=media&amp;token=69000b91-c7d5-4a4f-a930-cb3ef034bbc3" alt=""></div>

(3) Log in to DeviceOn system. Click Event Log, you can find alarm messages.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FzC6kRiENHWMGcr3fjKvJ%2F18.jpg?alt=media\&token=482f0e34-57e9-46e9-a379-27874df759b9)

(4) Also, you can check Event list on Smart Device UI.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FrXk7y6LCOTtR0QuMYL7N%2F19.jpg?alt=media&amp;token=e6b238b5-5203-47cd-8a03-d04356ba31a2" alt=""></div>

* Add an Alarm Rule on Patrol Inspection

(1) Fill in the table below. Turn on Patrol Inspection, follow WISE-Paas Patrol Inspection setup parameter, and then click Submit.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FQzFL2ooHWSUIBzqCrjIX%2Fs4.JPG?alt=media&amp;token=a875e9dd-9176-4e32-b9c9-34028d524553" alt=""></div>

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2F578vy7qsGcn5FWbAGfv5%2Fs5.JPG?alt=media&amp;token=721098ae-bdfe-4f4f-831b-02c16a404b9e" alt=""></div>

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2Fl2uI8RTFB48BhIbu4w0N%2F22.JPG?alt=media\&token=7b562ebf-a29f-4a82-bd00-011057bfdece)

(2) Make sure Status is the running and Actions is Patrol Inspection.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2Fb9GjUmGwXlVTQJ6KC4HX%2Fs6.JPG?alt=media&amp;token=7bc0afd5-1608-476d-8f48-82b3d3dbc7b4" alt=""></div>

(3) Get the messages on Patrol Inspection system.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FoU2OirFCBruulMkpetFl%2F24.jpg?alt=media\&token=fd1655d0-4c3c-4482-97f4-e8fb84939799)

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FM0KsmocBvCifAYmcha1q%2F25.jpg?alt=media\&token=372914e1-4663-44e2-a238-3b88c354eb78)

## **User Setting**

### Admin

Click User Setting > Alarm Setting > Admin. Edit Name, Nickname, and Password.

![](https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FJ4DVakhOQf8vSSZYphHW%2Fs7.JPG?alt=media\&token=eabd0a8a-d14f-469c-97af-a2086248b3b1)

### User

(1) Click User Setting > Alarm Setting > Admin. Edit Name, Nickname, and Password.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FCyrOAKx9nov4LpbuVorU%2Fs8.JPG?alt=media&amp;token=bf1257bf-10ad-41a6-870d-cd92fa0fdefd" alt=""></div>

(2) User access rights that view System info only.

<div align="left"><img src="https://1210863923-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Ldahy90A1eekcr5A2U8%2Fuploads%2FUEoBTOxyI5ghuqywD4jU%2Fs9.JPG?alt=media&amp;token=939b6ab0-5e95-4022-a1a7-42e8b2218503" alt=""></div>
