Configuring Properties

<< Click to Display Table of Contents >>

 

Configuring Properties

The parameters to define the communication with Metasys system are defined at the driver configuration window.

 

clip0001

PROPERTY

DESCRIPTION

Metasys Server

DNS Name or IP Address for the Metasys Server or NAE Concentrator

User/Password

Username and Password for Login

User2/Password2

Username and Password for alternative Login in case of failure of first user account (after 2 retries)

Cache File Path

Folder name where cache files will be read and saved. There are 3 types of cache files:

- GUID File (MetasysGUID.txt): Contains the internal codes of each Metasys object, which are stored at this file to speed up the startup process.

- Command and State Cache Files (DeviceName_MetasysStateCache.txt): Contains the description of commands and states of the objects marked with N1>0, stored in a cache file per NAE controller, to speed up the startup and translation process for the numeric values 0 or 1.

- State words (MetasysState0.txt and MetasysState1.txt): contains the state names corresponding to the values 0 and 1 respectively.

If the cache file path is not informed, the files will saved at the same folder where the driver dll is located.

Force New Login After (s)

Force new login independently of the token expire time. 0 = disable

Protocol Version

V3: Uses only polling for reading

V4: Allows polling and events (subscriptions)

Read Method

Polling: performs tag readings by polling. Can be used both V3 and V4;

Events: performs tag readings by subscriptions and can be used only with V4;

ByTag(N2): Allows choosing the read method by tag at the N2 parameter (0 = polling, 1 = events). It can be used only with V4.

Subscription Renew (s)

When a tag is read by subscription/events, if its value doesn´t change during this interval (in seconds). a new subscription is requested, which forces receiving a new update. If the received value is the same as the current value, the tag timestamp will not be updated, except if the EnableDeadBand property is FALSE.

Polling Options

Options related to polling reading

Items per Read Request

Tells how many items can be added to the same read request. Minimum value is 1. This property is also used to define how many items can be subscribed in a single subscription request.

Inter-Request Delay (ms)

Informs a default delay in miliseconds between read requests for all NAE´s. This delay will be used if a NAE doesn´t have its own delay informed at the tag InterReqDelayMS.

Force New Login After Consec Errors

Force new login after a number of consecutive errors. 0 = disable

Force New Login with Read Error Rate > %

Force new login if error rate (in %) is greater than what is informed. 0 = disable

Read Ahead After Cmd - Wait Time (s)

Tempo de espera para realizar a leitura de um tag de status associado a um comando. Esta associação é feita através do arquivo MetasysReadAhead.txt

Make Parallel Requests per Device

Informs if the the driver shall send parallel requests for each NAE declared.

Full Logs

Informs if the driver logs (when enabled) will be generated with detailed information.

 

Beyond the Properties window, these configurations can also be defined in runtime at Elipse E3 or Elipse Power applications. For this, start the driver in Offline mode, i.e. execute the application with the option Start driver OFFLINE enabled, configurable at the Setup tab at Property window. The options are described below.

Config Options for Johnson Controls International Metasys Driver

ParAMETER

OFFLINE STRING PROPERTY

DATATYPE

DescriPTION

Metasys Server

Metasys.UseChecksum

Text

Metasys Server Name

User

Metasys.User

Text

User for Login

Password

Metasys.Password

Text

Password for Login

Cache File Path

Metasys.GUIDPath

Text

Cache Folder

Items per Read Request

Metasys.MaxItemsRead

Text

Max Itens per request

Protocol Version

Metasys.APIVersion

DWord

3 or 4

Read Method

Metasys.ReadConfig

DWord

0 = polling, 1 =Events, 2 = by Tag

Inter Request Delay

Metasys.InterReqDelay

Dword

Delay between readings

Force New Login after (s)

Metasys.ForceLoginTime

Dword

Force new login after x seconds

Force New Login after consec errors

Metasys.ForceLoginConsecErrors

Dword

Force new login after x consecutive errors

Force New Login with read error rate

Metasys.ForceLoginReadErrorRate

Dword

Force new login if error rate is greater than informed

Read Ahead After Cmd - Wait Time

Metasys.ReadAheadWaitTime

Dword

Wait time to read a status tag after command

Full Logs

Metasys.FullLogs

Int

Enable full logs

 

All offline properties must be configured via PLC Tags by using parameters N1 equal to -1 (minus one), N2 equal to 0 (zero), N3 equal to 0 (zero), and N4 equal to 3 (three).

 

Was this page useful?