Custom Models for Downstream Modbus Devices (Universal and Advanced Models) - EcoStruxure Panel Server Cybersecurity Guide

Presentation

NOTICE
BACKWARD Compatibility with existing custom models after firmware update After updating the Panel Server firmware, if devices associated with a custom model display erroneous data, or cannot be imported, update the custom model using EcoStruxure Power Commission and import it again into the Panel Server. Perform a Switch versions and update action for the custom model. Failure to follow these instructions can result in erroneous data.

NOTICE

BACKWARD Compatibility with existing custom models after firmware update

After updating the Panel Server firmware, if devices associated with a custom model display erroneous data, or cannot be imported, update the custom model using EcoStruxure Power Commission and import it again into the Panel Server. Perform a Switch versions and update action for the custom model.

Failure to follow these instructions can result in erroneous data.

The Panel Server supports the use of custom models for downstream Modbus devices. A custom model can be created to manage a Modbus device that is not natively managed by the Panel Server built-in models or when a different model than the built-in one is desired.

Custom models are only dedicated to support EcoStruxure Asset Advisor EcoStruxure Resource Advisor, and EcoStruxure Energy Hub applications and Panel Server Advanced energy server functions. On other applications, custom models can be used, but only allow the visualization of device data on the monitoring screen.

Custom models are created or modified in the EcoStruxure Power Commission web portal tool (EPC Web tool). EPC Web tool contains context help to guide you.

New and modified custom models are imported in the Panel Server by using the Panel Server webpages. For more information about discovering Modbus devices automatically or manually, see Addition and Removal of Modbus Devices.

Availability

This function is available on Panel Server Universal and Advanced.

Setting the Parameters

Custom models are available on the Panel Server webpages at Settings > Modbus Devices > Custom models.

Creating a Custom Model

Create the custom model by using the EcoStruxure Power Commission web portal tool (EPC Web tool).

The custom model contains the list of measurements and alarms supported by the Modbus device connected to the Panel Server.

The custom device model must contain the following content. It cannot be imported into the Panel Server webpages if it does not follow these rules:

modelingInformation
productIdentification
measure
modbusMapping
modbusDataModel

Custom models can now include the Modbus discovery rules, which allows the Panel Server to use custom models in addition to built-in models to discover Modbus devices. For more information about the rules, refer to the EPC Web tool.

The custom units in the custom device model must comply with the following syntax rules:

Maximum number of characters: 16
Use only characters from the following table.

Characters	Description
Alphanumeric characters	All upper case letters from A to Z All lower case letters form a to z All numbers from 0 to 9
/	forward slash
*	star (multiply)
-	minus
+	plus
%	percent
(	left parenthesis
)	right parenthesis
.	point
Ω	omega (ohm)
μ	mu (micro)
‘space’	the space character
°	degrees, for example °C
superscript characters	All numbers from 0 to 9 Plus and minus characters

Export the custom model to a zip file.

Importing a Custom Device Model

To import a custom device model previously created and exported in a zip file, follow this procedure:

From the Panel Server webpages, navigate to Settings > Modbus Devices > Custom models.
Click Import. You can import:
- A new custom model. This is a custom model which is not currently imported to the Panel Server.
- A modified custom model. This is a modification of a custom model which is already imported and used by connected Modbus devices.
Select a custom device model stored locally in a zip file.

The zip file can contain both new and modified custom models. You can have a maximum of two different versions with the same custom model name. Only one version is used by Modbus devices.

NOTE: An error message is displayed if the custom model does not comply with the syntax rules (see Creating a Custom Model).

When the custom model is successfully imported, it is listed in the custom models table. A maximum of 50 custom models can be imported to the Panel Server.

A new custom model is automatically instantiated so that new Modbus devices can be added using that custom model. It is displayed as the current version in the custom models table.

For modified custom models, the new version is available for use in the custom models table. It is not automatically instantiated. Select Switch versions and update devices to apply the new version to selected Modbus devices. See the following table for more information.

Custom Models Table

The custom models table displays the following information and allows you to perform version updates, and delete custom models:

Column	Description
Model name	Name of imported custom model.
Current version	Current version of the custom model, used by associated Modbus devices. A maximum of 50 custom models can be imported.
Includes discovery rules	True/False Indicates if the current version of the custom device model contains Modbus discovery rules. If True is displayed, the current version of the model can be selected by the Panel Server to automatically discover Modbus devices.
Model modification date	Indicates the last date that the current custom model was modified.
Available version	An alternative version of the custom model available to be applied on associated Modbus devices.
Associated devices	The number of Modbus devices associated with the current version of the custom model. This number is updated when new Modbus devices are discovered manually or automatically.
(Contextual menu)	Click this icon to open a contextual menu. The items displayed depend on the device: Switch versions and update devices: Click to switch the current version to the available version. Switching the model to a more recent version automatically updates all associated devices with the new features of the updated version, for example, new measurements. NOTE: After updating to a new version, the original version appears in the Available version column and can be reinstated to the associated devices by switching the versions again. Remove unused version(s): Click to delete the available version (if any), and the current version if no devices are associated with the model (0 in Associated devices column).

Supported Functions

Modbus functions are described in the appendix:

Checking Association between Custom Device Model and Modbus Device

To check which custom device model (if any) is associated with your device, navigate to Settings > Modbus devices and select your device in the list. In the Custom device model information section, the following information is displayed:

Custom device model name
Custom device model version