Devices

Organization Structure

Purpose:To create a hierarchical structure of the organization, starting with a factory node, creating departments with machines in each.

The section describes:

Add Factory

Precondition: The user is logged in to the Upkip Administration through their Azure AD account.

Purpose: By selecting the Organization menu, the user can add the top node to the factory organization.

Select the menu Organization.

Click the Add button. Select the menu Factory.

Figure 1: Organization - Add Factory

Figure 2: Organization - add factory

Click Add.

Add Department

Precondition: The Factory node in the organization tree is created and selected.

Purpose: It is possible to create different departments corresponding to the structure of the factory. Departments are associated with groups in Azure Active Directory (AAD). Users added to the corresponding Azure group can only see machines from the department associated with the group.

Figure 3: Organization - add department

Click the Add button. Select the menu Department.

Figure 4: Organization - add department

Add Machine

Precondition: Added Factory and Department item to the organization tree. The department is selected.

Purpose: To add machines to the department from the organization.

Figure 5: Organization - add sensor

Click the Add button. Select the Sensor menu.

Figure 6: Organization - Add sensor properties

Fill in all machine properties and click the Add button.

Delete machine

Precondition: The machine is configured in the organization tree.

Select the machine in the organization tree. Click the button Delete.

Figure 7: Delete machine warning

To delete machine from the organization first is necessary to delete all machine tags.

Go to Preview and manage tags.

Machine Properties

Precondition: The Add sensor form is opened following the steps in Add machine.

Machine properties are grouped into three groups: General, Data communication, and Analysis.

General properties

Precondition: The Add sensor form is opened following the steps in Add machine.

Figure 8: Add machine - general properties

Fill in the fields in the General section:

Figure 9: Add machine - seect 3D model

Analysis properties

Precondition: The Add sensor form is opened following the steps in Add machine.

Figure 10: Add machine - analysis properties

Fill in the fields in the Analysis section:

Data Communication properties

To configure data communication properties and settings, go to Data Communication

Data Communication

The section describes:

Data communication template

Precondition: The Add sensor form is opened following the steps in Add machine.

Select a template from the Teampate Name dropdown menu in the General section.

Figure 11: Add machine - select template

When you select the New option for the template name, a message is displayed prompting to select Device/Controller type and Communication type. When the machine is saved, a new template named Device/Controller type - Communication type is created, for example MAZATROL - MTCONNECT (WINDOWS).

Device Controller type

Precondition: The Add sensor form is opened following the steps in Add machine.

The user can create a new name or select from the list of already defined to label the machine/device controller type.

Selecting Add from the dropdown list opens a form to add a device/controller type name.

Figure 12: Select Add to add a new device/controller type

Enter name of the device/controller type, click Add.

Figure 13: Add a new device/controller type

Select the machine controller type from the list.

Communication type

Precondition: The Add sensor form is opened following the steps in Add machine.

Users must select a machine communication type from the dropdown list of adapters in Upkip, developed as IoT Hub IoT Device modules running on Windows or IoT Edge device modules running on Linux OS.

Figure 14: Select communication type

The list of supported adapters in Upkip.

WINDOWS ADAPTERS LINUX ADAPTERS
ABB ROBOTICS PC SDK (WINDOWS) MODBUS TCP (LINUX)
FANUC ROBOT INTERFACE(WINDOWS) MODBUS RTU (LINUX)
MTCONNECT HEIDENHAIN INVENTCOM (WINDOWS) MTCONNECT (LINUX)
MELSEC (WINDOWS) OPC UA (LINUX)
MODBUS TCP (WINDOWS) REST(LINUX)
MODBUS RTU (WINDOWS) SIEMENS S7 (LINUX)
MQTT (WINDOWS)
MTCONNECT (WINDOWS)
MTCONNECT FANUC FOCAS (WINDOWS)
OPC CLASSIC (WINDOWS)
OPC UA (WINDOWS)
PICO DATA LOGGER (WINDOWS)
PICOLOG 1000 SERIES (WINDOWS)
RPC SINUMERIC (WINDOWS)
SIEMENS S7 (WINDOWS)

Note! For more details, see Adapters section.

Gateway

After selecting the machine communication type as a Windows or Linux adapter, the Gateway dropdown list is loaded with the available gateways corresponding to Windows or Linux.

Figure 15: Select Linux gateway with Linux adapter

The user can select a gateway from the dropdown list or create a new gateway by selecting Add from the list.

Figure 16: Select Windows gateway with Windows adapter

When Add is selected from the list, a New Gateway form is opened.

Figure 17: Add new gateway

Fill in gateway details.

Click the Add button.

Note! When you create a Linux gateway, additional custom gateway deployment must be done to make it usable. Ask the platform administrators for further information.

When all the required data in the machine properties form is filled in, click the Add button.

Communication settings

Precondition: The machine has been added to some department with their properties.

Select the added machine in the organization tree. Click the Properties tab.

In the Data Communication Settings, a predefined set of fields for user-configurable settings appears based on the adapter type. The settings are sufficient for normal communication with the machine.

Before some fields there is an information icon (“i” sign). Hover the icon, a tooltip is displayed explaining the format of the field data. For other fields without an information icon and tooltip, the field label is sufficient to inform the user about the format of the field data (e.g. port, IP Address, etc.).

Figure 18: Machine properties with data communication settings

Fill in the data communication settings fields with the requested machine communication data. Click the Update button.

For example, if the machine has an adapter type SIEMENS S7 (WINDOWS). Fill in the machine communication data and click Update.

Figure 19: Machine communication settings for SIEMENS S7 (WINDOWS)

Select the GATEWAYS menu, select the machine gateway and click the Modules tab. Select a Siemens S7 module.

Figure 20: Gateway module with machine configuration

Click the Edit button.

Figure 21: Gateway module with machine configuration data

For example, if the machine has adapter type ABB ROBOTICS PC SDK (WINDOWS) with filled communication data.

Figure 22: Machine communication settings

Figure 23: Gateway module with machine configuration

Click the Edit button.

Figure 24: Gateway module with machine configuration

Note! For more details, see Adapters section.

Update Machine Properties

Precondition: The machine is configured in the organization tree.

Select the machine in the organization tree. Select tab Properties.

Figure 25 Update machine properties and communication settings data

The user can view or edit the editable properties. After changing some properties or data communication settings click the Update button.

Machine Tags

Purpose: Machine tags are used for receiving data from the machine. Received data is analyzed and used for visualization in different dashboards presented by user-friendly view. In the section are described functionalities:

Machine Tags

Precondition: The machine is selected in the organization tree. Select tab TAGS.

Figure 11: Machine tags - sources

Source of the tag indicates tag origin with specific icon before description:

Filtering machine tags – machine tags can be filtered by typing in the filter field.

Figure 12: Machine tags - filtering the tags

Created alarms for tags are indicated with an icon in the first column after the Tag ID.

Figure 13: Machine tags - icon for created alarms from tag

Edit Tag

Precondition: The machine is selected in the organization tree. Select tab TAGS.

Select some tag and click Update.

Tag with value type String has the following data:

Figure 14:Machine - tags -edit tag

Tag of type INT or Float has 3 additional fields – Min, Max, and Set Point.

Figure 15: Upkip Administration -Edit machine - Add new tag Min and Max limits

Min/Max fields are used to enter integers/floats for minimal and maximal value.

Set Point is used to enter the optimal value as integer/float.

Min and/or Max values can be used to create warnings for them following the steps Create Warnings from Tag Limits

Add Tag

Precondition: The machine is selected in the organization tree. Select tab TAGS.

To add new tag click the Tag button.

Figure 16: Machine - Tags - Add new tag

Figure 17: Machine - Tags - Add new tag

Figure 18: Add tag - select tag type

Figure 19: Add tag with selected tag type

Fill in the Name with tag name and Description (optional) and click Save.

Add Tag type with a specific adapter configuration

Precondition: The machine is configured in the organization tree.

Select the machine in the organization tree. Select tab TAGS.

Follow to steps in Add Tag to select Tag type.

When creating a tag and adding a tag type, depending on the machine's communication type, additional settings may appear.

For example, when adding a tag to a machine with Modbus communication adapter, additional settings may appear. There is an information icon for each field. Hover the icon, a tooltip appears explaining the format of the data in the field.

Figure 20: Select tag type with additional adapter configuration

Add Tag to all machines with the same template

Precondition: The machine is selected in the organization tree. Select tab TAGS.

To add a new tag click the Tag button.

Select a new tag type.

Figure 21: Add tag to all machines with the same template

Fill in the Name with tag name and Description (optional) and click Save.

Figure 22: Add tag to all machines with the same template message

Click the OK.

Add Tag with External sensor

Precondition: The machine is selected in the organization tree. Select tab TAGS.

The external sensors can be connected to:

Data received from the external sensors are visualized as charts showing min, max, average values, and current values.

Upkip supports external sensors of the following types:

How to install external sensors is described in the documentаtion Installer support/External sensors setup

To configure tag with external sensor open menu Organization. Select the machine. Open Tags. Find the tags connected with external sensors by filtering.

Figure 23: Machine tags - external sensors connected to machine tags

Click Tag button to create a new tag.

Select tag type related to value type, add Name.

Select type of the external source (sensors) from the dropdown list.

Figure 24: Machine - new tag – select external sensor type

In addition to fields described in the Add Tag section tags connected to external sensors have attributes:

When selecting type of the external sensor additional fields are shown for configuration.

Configuration of tag with ReMoni sensor

Precondition: The New tag form is opened. Filled in the tag name and tag type.

Select from the External source dropdown the type of the external sensor - ReMoni.

Figure 25: Add tag - external sensor ReMoni configuration

After selecting type of the external sensor, fill in base URL with username and password.

Select external type – Data or Alarm. Fill in Sensor ID.

When Data is selected additional fields for Aggregate type, Channel number, and Data type have to be filled in.

After saving the tag with an external sensor in the column Source of the tags list is shown ReMoni .

Figure 26: Tag with ReMoni sensor

For more details go to ReMoni sensors configuration

Configuration of tag with Disruptive technologies sensor

Precondition: The New tag form is opened. Filled in the tag name and tag type.

Select from the External source dropdown the type of the external sensor – Disruptive technologies.

Figure 27: Add Tag - external sensor Disruptive technologies configuration

Select Tag type Data. Select Event type from the list and fill in Sensor ID.

After saving the tag with an external sensor in the column Source of the tags list is shown Disruptive technologies.

Figure 28: Tag with Disruptive technology sensor

For more details go to Distuptive technoloty sensors configuration

Configuration of tag with El-Watch sensor

Precondition: The New tag form is opened. Filled in the tag name and tag type.

Select from the External source dropdown the type of the external sensor – El-Watch.

Fill in the fields API Key, Base URL, Data type and Sensor ID.

Figure 29: Add Tag - external sensor El-Watch configuration

After saving the tag with an external sensor in the column Source of the tags list is shown El-Watch.

Figure 30: Tag with El-Watch sensor

For more details go to El-Watch sensors configuration

Configuration of tag with Neuron sensor

Precondition: The New tag form is opened. Filled in the tag name and tag type.

Select from the External source dropdown the type of the external sensor – Neuron Sensors.

Figure 31: Add Tag - external sensor Neuron sensors configuration

Fill in the fields Base URL, API Key, Data Type, Serial Number.

After saving the tag with an external sensor in the column Source of the tags list is shown Neuron Sensors.

Figure 32: Tag with Neuron sensors

For more details go to Neuron sensors configuration

Configuration of tag with NCD sensor

Precondition: The New tag form is opened. Filled in the tag name and tag type.

Select from the External source dropdown the type of the external sensor – NCD Sensors.

NCD sensors have two tag types – PPMS and PMS.

Figure 33: Add Tag - external sensor NCD sensors configuration

Fill in the fields Source, Sensor ID, select Event type.

After saving the tag with an external sensor in the column Source of the tags list is shown NCD Sensors.

For more details go to NCD sensors configuration

Configuration of tag with Weather sensor

Precondition: The New tag form is opened. Filled in the tag name and tag type.

Select from the External source dropdown the type of the external sensor – Weather.

Figure 34: Add Tag - external sensor Weather configuration

Fill in the fields API Key, Base URL, City ID, Type, Units. Save the tag.

For more details go to Open weather map configuration

Import tags from file

Precondition: The machine is selected in the organization tree. Select tab Bulk Create.

Purpose: Add tags for the machine by importing from a file.

Tags for the machine could be imported from a CSV file. TAB is visible only for users with the role System administrator.

Upload a CSV file with description of each tag by name, valueType, (PayloadType), and (DisplayName).

Figure 35: Machine - Import tags

Delete Tag

Precondition: The machine is selected in the organization tree. The TAGS tab is selected.

Purpose: To delete the machine tag.

Select some machine tag and click Delete.

Figure 36: Tags - Delete tag without data confirmation

Confirm with Delete.

When a tag has data after clicking Delete appears warning:

Figure 37: Tags - Delete tag with data confirmation

When a events are created with the tag after clicking Delete appears warning:

Figure 38: Tags - Delete tag with events confirmation

The user has to select another tag by clicking on the Select Tag button.

Click the Delete button.

Preview and manage tags

Precondition: The machine is selected in the organization tree. Select tab TAGS. Click on the Preview Data button.

Figure 39: Tags list - Open Preview Data

Purpose: The Preview Data form allows:

Figure 40: Preview data form

Tags in the table are shown in columns: Name, Label, Last, Min, Max, Avg, and Count (the last, minimum, maximum, average, and count of data for the selected time period). In the columns Events and Calculated tags are shown the numbers of events and calculated tags created with this tag. In the last column Source is visible the type of the tag source.

The source of the tag indicates the tag origin with a specific icon before the description:

Table with tags is possible to sort by clicking on each column title.

Filtering machine tags is possible by entering the text in the Filter field:

Figure 41: Preview data - filter by text

Filtering machine tags is possible by period.

Change the Date From – Date To. From the filter Select Tags is possible to select: All, Empty tags, Tags with data, or Disabled tags. Click the Search button.

Filtering the tags is possible by the following options: All, Empty tags, Tags with data, Disabled tags.

Figure 42: Preview Data - filtering tags

Select option Tags with data and click Search.

Figure 43: Preview data - tags with data for the selected period

Select option Empty tags and click Search.

Figure 44: Tags - Preview Data – tags without data for the selected period

Some tags are possible to select by checkboxes and disable by clicking Disable tags button.

Figure 45: Preview Tags - Disable tags confirmation

Select the option Disabled tags and click Search.

Only disabled tags are possible to delete.

To Delete tags:

Figure 46: Preview Tags - Delete tag without data confirmation

Click Delete to confirm

Select a tag with data and disable. Filter disabled tags and click Delete tags.

Figure 47: Preview Tags - Delete tag with data confirmation

Click Delete to confirm.

Select to delete a tag that has events or calculated tags created with it.

Click Delete tags button.

Figure 48: Preview Data - select tag to replace and delete tag

Click the Select Tag button and select another tag.

Click Delete button.

Write tags to gateway

Precondition:

Purpose: All machine's type-specific tags are possible to write to the gateway.

Select the machine in the organization tree. The machine has a template type for example Sinumerik 840D

The machine is configured with communication type RPC SINUMERIC(WINDOWS) and a gateway.

The machine is updated with Communication settings for the selected communication type.

Figure 49: Machine - Properties

In the gateway module, RPC-Sinumeric837 desired properties JSON configuration is added machine's configuration.

Add tags to the machine following the steps in the Add Tag

Filter the machine-specific tags.

Figure 50: Machine - machine-specific tags

Click the button Write all to gateway.

Select the menu Gateways. Select the machine gateway from the list. Click the tab Modules.

Select the module corresponding to the machine communication type.

Click the Edit button.

Figure 51: The gateway module with machine communication settings

  "DataItemsToMonitor": {
    "TG511": "cut_time,total_time"
  },

Tags Browser

Purpose: The Tags browser functionality is developed for specific adapters. From the machine tags' list clicking the Browse Device button is opened a form with a loaded tree with tags from the adapter server. Users can select some tags, view or change the tag name, type, payload, or display name, and click the Save button.

Note: To use the functionality machine configuration has to be added in the gateway adapter module Desired Properties JSON configuration. То adapters configuration.

Select the machine in the organization tree and click TAGS. Click the button Browse Device.

Figure 52: Machine - tags

OPC UA Tags Browser

Precondition: The machine has to be configured with the correct data communication settings.

Figure 53: Machine with OPC UA communication type

Example of configuration for machine with OPC UA(LINUX) communication type.

"ws350": {
	"DiscoveryUrl": "opc.tcp://ws206.icb.bg:51212",
	"SessionChannelTimeout": 30000,
	"PublishingInterval": 60000,
	"KeepAliveCount": 30,
	"LifetimeCount": 30,
	"PublishingEnabled": true,
	"UserName": "",
	"Password": "",
	"SamplingInterval": -1,
	"QueueSize": 0,
	"DiscardOldest": true,
	"QualityControl": {
		 "Characteristics": "2:Robot1\_Axis1",
		 "SerialNumber": "2:Robot1\_Axis2",
		 "Order": "2:Robot1\_Mode",
		 "Operation": "2:Robot1\_Speed",
		 "OrdPosCombined": false,
		 "OrdPosSeparator": "-",
		 "Event": "Always",
		 "HandshakeTag": "",
		 "Position": "2:Robot1\_Speed"
	}
}

Select the machine in the organization tree and click TAGS. Click the button Browse Device.

Figure 54: OPC UA Tags browser

At the top are visible device adapter (gateway), device module and machine ID.

Figure 55: Tags browser - edit tags properties

After successful saving appears Create Tags message.

Figure 56: Tags browser - create tags successfully

If trying to duplicate some tag by name or payload appears Duplicates found message.

Figure 57: Tags browser - duplicates found

After successful import:

Figure 58: Machine tags list with imported tags

"dataItemsToMonitor": {
	"ws350": "2:Robot1\_Axis1,2:Robot1\_Axis4,2:Robot1\_Axis3"
}

OPC Classic Tags Browser

Precondition: The machine has to be configured with the correct data communication settings.

Figure 59: Machine with OPC Classic communication type

Example of configuration for machine with OPC CLASSIC(WINDOWS) communication type.

"opc_cl": {
      "UrlNoProtocol": "DEV-204/Matrikon.OPC.Simulation.1/{f8582c...}",
      "ConnectDaClient": true,
      "ConnectAeClient": true,
      "UpdateRate": 1000,
      "SamplingRate": 500,
      "SamplingRateSpecified": true,
      "EnableBufferingSpecified": false,
      "MaxAgeSpecified": false,
      "DeadbandSpecified": false,
      "CheckConnectionIntervalSeconds": 30,
      "OverrideServerTime": true,
      "ConvertServerTimeToUtc": true,
      "IgnoreTimestampSpecified": true,
      "AlarmMinSeverity": 500,
      "AlarmsAndEventsFilters": null,
      "ParseByteArrayAsText": true,
      "SendEmptyStrings": true,
      "EmptyTagsToFix": null,
      "EmptyTagsToFixValue": "-",
      "SendFalseBooleans": false,
	  ...
	}

Select the machine in the organization tree and click TAGS. Click button Browse Device

Figure 60: OPC Classic Tags browser

The user can select tags from the adapter server tags tree and import them to the machine tags list.

"SensorDataItemsToMonitor": {
	"opc_cl": "Random.Int1,Random.Int4,Random.UInt2,Random.Int2",
	"ws360_opccl": "Random.Int1,Random.Int2"
}

MTConnect Tags Browser

Precondition: The machine has to be configured with the correct data communication settings.

Figure 61: Machine with MTConnect communication type

Example of configuration for machine with MTConnect(WINDOWS) communication type.

In the MTConnect Agent is configured:

{
    "Adapters": {
      "TG601": {
      "Host": "127.0.0.1",
      "Port": "120.....",
      "AutoAvailable": "false"
	  }
	  ....
   }...
  },

Select the machine in the organization tree and click TAGS. Click the button Browse Device

Figure 62: MTConnect Tags browser

The user can select tags from the adapter server tags tree and import them to the machine tags list.

In the MTConnect-Collector are added tags to monitor:

{
  "DataItemsToMonitor": {
    "TG504": "A1load,TG60X,total_time,Xload",
    "TG600": "cut_time,TG60X",
    "TG601": "Sload,TG60X",
  },
}

Machine Alarms

Precondition: The machine is configured in the organization tree.

Select the machine in the organization tree. Select tab Alarms.

Figure 63: Machine alarms

Each alarm has a Severity. The available severity types are Critical, Alarm, Warning, and Info. To change the alarm severity click on the severity value, select from the dropdown another value and click the Save button.

Figure 64: Machine alarms severity

Selecting some alarm(s) is possible automatically to create an event, warning, and notification for the selected alarms.

Go to Notifications from machine alarms.

There is an indication with an icon on the first column if for some alarm is created notification.

Figure 65: Machine alarm with notification

There is developed a Built-in function for checking alarm severity. The function can be used when creating expressions in events or calculated tags. Go to Add function in expression

AlarmSeverity(GetTagNameByTagType('Alarm')) = 'Alarm'

Go to Create new event

Factory Layout

Purpose: The Factory layout functionality in the Upkip Administration allows:

In the section are described:

Configure factory layout

Precondition: The user has logged in to the Upkip Administration. The Organization menu is selected.

The user clicks on the configuration icon on the top right of the organization tree:

Purpose: The form is used to define the main properties and upload the pictures for the factory floors.

Figure 66: Organization - Configure factory layout and floors

In the Configure form is possible to define the:

To upload pictures for the factory floors:

Figure 67: Configure factory floors

Add machine to factory floor

Precondition: The machine is added to the organization tree.

Purpose: The selected machine can be added to some of the defined floors of the enterprise.

Figure 68: Add machine to factory floor menu

Select the machine in the organization tree. Click the button Add to floor and select from the menu one of the configured floors.

Figure 69: Organization - Add machine to floor

Connect animation with machine statuses

When the machine is added to the floor and selected, the right appears Machine Data. Machine models are possible to develop with some animation.

Figure 70: Selected machine on the floor – Animations

In the section Animations is possible to select machine statuses to connect them with the animation. This means when the machine has the configured statuses on the Factory Layout the machine animation will be played.

Select a machine

Purpose: Select a machine in the organization tree or on the factory layout

Select a machine in the organization tree. Select the Factory Layout tab.

Figure 71: Selected machine on the tree - visualized on the factory layout

Figure 72: Organization tree - Add to floor button

Clicking on the button Add to floor and selecting floor from the menu, the machine is added to the factory layout floor.

In reverse when selecting some machine in the factory layout floor, the machine appears selected in the organization tree.

Figure 73: Select machine on the floor - show machine selected in the organization tree

Deselect a machine

Precondition: Machine is selected on the factory layout.

Deselecting the machine on the factory layout is possible by clicking again on the selected machine.

Figure 74: Deselected machine on the factory layout and organization tree

Deselecting the machine is also possible also by clicking the Refresh button at the top right of the organization tree.

Figure 75: Organization tree and layout - deselect machine by refresh

After clicking the Refresh button:

Change a machine location

Precondition: Click on the machine on the floor layout.

Clicking on the machine without releasing the mouse is possible to move the machine to another location on the floor area.

On the Machine Data form the X and Y positions are changed.

Figure 76: Factory floor - move the machine on the floor

Click the Save button.

Resize and rotate a machine

Precondition: Click on the machine on the factory layout.

Machine models can be resized and rotated.

Figure 77: Machine model - resize or rotate

By clicking on (1) the machine can be resized, by clicking on the (2) machine can be rotated on the map.

When the machines are located on their places on the floor layout click the button Save to save the created layout with the machines locations.

Change the machine floor

Precondition: Click on the machine on the factory layout.

Figure 78: Factory Design layout – change the machine floor

From Machine Data change the current floor from the dropdown.

View floors of the factory layout

Precondition: The Factory layout is opened.

There is possible to switch between floors by clicking on the arrow after/before the floor name.

Figure 79: Factory layout - go to next floor

Figure 80: Factory layout - go to previous floor

Zoom the factory floor

Precondition: The Factory floor is opened.

It is possible to Zoom in or Zoom out the floor area to see better the machines and their locations by using the mouse scroll wheel.

Save the floor layout

Precondition: Factory floors are designed with added machines.

Click on the Save button to save the layout of the floors.

Expand and collapse the main menu

There is possible to collapse and expand the main menu.

Collapsing the main menu increases the floor design area and shows all main menus only with icons.

Figure 81: Upkip Administration -collapsed menu and button to expand

Expanding the main menu shows all menus with icon and text.

Figure 82: Upkip Administration -expanded menu and button to collapse

Visualize Factory Layout

Precondition: Factory floors with machines are configured in the Upkip Administration.

Log in to Upkip Visualization following the steps in Upkip Visualization Sign in

Selecting from the main menu Factory Layout opens the dashboard Factory Layout.

To Factory Layout dashboard

Gateways

Purpose: Gateways are configured in Microsoft Azure IoT Hub as IoT Devices or IoT Edge devices and installed on the computers on the manufacturer's premises.

They act as a Cloud Gateway which:

Precondition: Log in to Upkip Administration with Microsoft AD user account.

Select under Devices the menu Gateways.

Figure 83: Upkip Gateways list

Click the Create button to add a new gateway.

Figure 84: Create new gateway

Fill in gateway details.

Click Add.

Note! When you create a Linux gateway, additional custom gateway deployment must be done to make it usable. Ask the platform administrators for further information.

For example, in the Upkip Administration are used the following gateways (IoT devices or IoT Edge devices)

Used by the system internally:

Software gateways installed on premises:

Select a gateway from the list.

Figure 85: Gateway properties

Gateway Properties shows: Name, Device ID, Is Edge, Desired and Reported configurations.

By clicking the Edit Json button it is possible to edit the gateway configuration written as a JSON data. The Reported configuration is returned by the Azure and is usually equal to the Desired configuration.

Click on the tab Modules.

Figure 86: Gateway modules as IoT Hub devices

A module is created or updated when machine configuration settings are set or updated.

The modules run on the configured Devices in the IoT Hub.

When selecting some Linux Gateway name and then Modules are listed the modules:

Figure 87: Gateway modules as IoT Edge devices

The modules run on the configured IoT Edge devices in the IoT Hub.

External Sources

Purpose: Menu External sources allows to define new type of external sources (sensors) and properties to connect and fetch the data from the source. Data from the source can be received in two ways:

Received input data are transformed by liquid JSON transformation template to Upkip internal data format.

Machine tags are connected to the selected external source and external data type with filled properties to fetch data from the source.

Configure tag with external sensor

Precondition: Log in to Upkip Administration as a user with the role System administrator or Organization administrator.

Expand the menu Devices and select menu External Sources.

Figure 88: Upkip Administration - External sources

Add external source and tag type

The sources and their data types are configured in a tree view structure.

Figure 89: External sources - add new Source or Tag type

By clicking Add button and selecting menu Source (1) is opened form – Add External source.

The New external source is added by Name and Label. Label appears in the tree.

Figure 90: External sources - Add new external source

Selecting some source in the tree and clicking Add button and selecting the menu Tag Type is added new tag type of the source.

The New tag type is added by Name and Label. The Option “Data will be fetched from external API” can be checked or not.

Figure 91: External sources - Add new tag type for source

Add source properties

The source properties are used to connect to the source.

Precondition: The source is added to the tree. Select source in the tree.

Click on the button Add new Property (1)

New property of the source is added by Name and Label (2). The label appears in Add/Edit Tag form when the external source is selected from the dropdown. Configure external sensor

Figure 92: External source - Add new source property

After adding a new source property it appears in the source Settings form (3).

Add tag type properties

Precondition: The Tag type of the source is added by Add/Tag Type.

Select tag type of the source in the tree (1).

Figure 93: Tag Type Settings - Add tag type property

Click the button Add New Tag Type Property (2)

Tag type is added by the Name , Label and Data Type with options Primitive or Dropdown.

When the Dropdown option has selected the values of the dropdown are added.

Figure 94: External source - tag type dropdown property

Entered dropdown values for the tag type property can be edited.

Verity API Endpoint template

In a tag type settings are specified Api Endpoints including template or only Template.

The template is used for Liquid JSON transformation of input message JSON to Upkip internal data format https://shopify.github.io/liquid/

Click the button Verify API Endpoint.

In the Verify API Endpoint templates form at the left paste the JSON with input message from the source.

At the right is the template for Liquid JSON transformation. Click on the Verify button.

Figure 95: External source - Verify API Endpoint template

Delete source and tag types

Select some Source in the tree. Click the button Delete and select menu Source

Figure 96: External source - Delete source menu

Figure 97: External source - Delete source confirmation

Select some Tag Type in the tree. Click the button Delete and select menu Tag Type

Figure 98: External source - Delete tag type menu

Figure 99: External source - Delete tag type confirmation

Consumption Status

Overview

Consumption status (aka Power Status) is a type of machine status calculated based on the total power consumption of the target device.

The power cosumption metrics are analyzed per device using the K-means clustering method which is a type of complex ML algorithm. It is applied for a moving time window (e.g. last 7 days) for which power metrics are analyzed by the system to determine K-clusters of values for the power consumption. The result is a calculation of specific threshold levels.

In the common case 3 levels of power consumption rates are expected - StandBy, Idle, Active. Based on the analysis of clusters, threshold level is determined for each cluster and then later marked with specific status. Each threshold indicates the minimum level of power consumption for the machine to be considered in that status. Calculated thresholds are stored in special machine tags and the number of threshold tags determines the number of threshold levels to calculate for that machine.

With the help of these threshold levels different statuses are set for the machine. Status names are the IDs of the thresholds which are later mapped to user-friendly names and colors in the Visualization Portal dashboards and panels.

Required Tags and Data

Power Consumption

The basis for all calculations is the power consumption data of the machine. The analysis is based on the total power consumption which for three phase machines is the sum of power consumed accross all phases. This data should be stored in a tag with Label "Power Phase All" and data type of Float.

Figure 100: Total power consumption tag

Thresholds

The power consumption data is analyzed and split into groups based on the number of Threshold tags defined on the machine. Threshold tags are special tags which trigger the consumption status analysis. These tags should always have a Label starting with PowerStatusThreshold_ and data type of Float. For each threshold level two tags are required with the following labels: PowerStatusThreshold_X and PowerStatusThreshold_X_Avg.

In the general case, for good results at least three levels should be defined (0, 1, 2) in order to meaningfully split power consumption data. Threshold levels are evaluated once per day.

Figure 101: Threshold tags

A simplified example:

Consumption Status

The calculated consumption status is also stored in a special tag that needs to be created for the machine. This tag should have its Label set to PowerStatus and data type to Int.

Figure 102: Power status tag

Visualization

Within the Visualization portal the Consumption Status is usually displayed with a Discrete Panel. Figure 103: Discrete panel selector

In the common scenario the consumption status is extracted with the following query against the InfluxDB data source:

SELECT IntValue FROM telemetry WHERE $timeFilter and SensorID='$sensor' and Type='PowerStatus'

Figure 104: Data query

Through the panel's settings different statuses (e.g. 0, 1, 2, ...) are mapped to specific names and colors as shown below. Figure 105: Color and name mappings

Device Control

Purpose: Send a command to a device(machine) when events occur. Events are configured using expressions and functions on machine data.

Precondition: Device (machine) must be configured in a gateway.

The event should be created in the Data/Events section following the steps Create new event.

Select a machine in the organization tree.

The Control tab is visible on the right side only if the machine has a gateway configured.

Figure 106: Open machine device control

Click the Control tab.

Figure 107: Device control commands page

Create new device control command

Click the New button to create a new control command.

Figure 108: Create a new device control command

Fill in command name in the Name.

Select the command from the drop-down list (for example, AdapterReadTag).

In the Trigger Events section, click the Add button.

Select one or more events from the list.

Figure 109: Configured device control command

Click the Add button.

Figure 110: Device control commands page

Execute device control command

When the configured event is fired, the device command is executed.

To check the device command execution history, select the command from the table and click the History button.

Figure 111: Device control command history

Delete device control command

Select the device control command from the list.

Figure 112: Delete device control command

Click the OK button.