ESMAMonitoringApi

Overview

Type:

Global variables

Available as of:

V1.0.0.0

Description

This global variable list contains variables which are used in the context of the communication with the EcoStruxure Machine Advisor monitoring application interface.

Global Variables

Editable Variable

Data Type

Value

Description

G_xUseCustomParam

BOOL

FALSE

If this is TRUE, the customizable variables are used for the creation of the client credentials. Otherwise, the predefined constants are used.

G_sResourcePrefixCustom(1)

STRING[80]

'devices/’

Prefix to be added to the client ID to build the resource (HTTP) of the topic name (MQTT).

G_sResourceSuffixCustom(1)

STRING[80]

‘/messages/events/’

Suffix to be added to the client ID to build the resource (HTTP) of the topic name (MQTT).

G_sHttpApiVersionParamCustom(1)

STRING[80]

'api-version=2016-11-14'

Parameter application interface version which is added to HTTP resource.

Gc_sResourcePrefixDefault(2)

STRING[80]

'devices/’

Default prefix to be added to the client ID to build the resource (HTTP) or the topic name (MQTT).

Gc_sResourceSuffixDefault(2)

STRING[80]

‘/messages/events/’

Default suffix to be added to the client ID to build the resource (HTTP) or the topic name (MQTT).

Gc_sHttpApiVersionParamDefault(2)

STRING[80]

'api-version=2016-11-14'

Default value for the parameter application interface version which is added to HTTP resource.

Gc_uiServerPortHttpsDefault

UINT

443

Default server port which is used for HTTP protocol.

Gc_uiServerPortMqttsDefault

UINT

8883

Default server port which is used for MQTT protocol.

Gc_uiLengthVarNameUtf16

UINT

50

Maximum length in unicode characters of the variable name, which is processed by the FB_ESMADataAcquisition.

Gc_uiLengthVarNameUtf8

UINT

150

Maximum length in bytes of the variable name in utf-8 format, which is processed by the FB_ESMADataAcquisition.

Gc_uiLengthAssetNameUtf16

UINT

50

Maximum length in unicode characters of the asset name, which is processed by the FB_ESMADataAcquisition.

Gc_uiLengthAssetNameUtf8

UINT

150

Maximum length in bytes of the asset name in utf-8 format, which is processed by the FB_ESMADataAcquisition.

(1) These parameters are considered for the creation of the HTTP resource or MQTT topic name only if the parameter G_xUseCustomParam is set to TRUE.

(2) These parameters are considered for the creation of the HTTP resource or MQTT topic name only if the parameter G_xUseCustomParam is set to FALSE.