Ethernet IP Datalink Attributes - Metasys - LIT-12011964 - Software Application - System Configuration Tool - 16.0

SCT: System Configuration Tool Help

Brand
Metasys
Product name
System Configuration Tool
Document type
User Guide
Document number
LIT-12011964
Version
16.0
Revision date
2023-10-02
Language
English

This object contains attributes common to many Metasys system objects. These common attributes are described in the Common Object Attributes section. This section includes attributes of the Focus/Configuration tab and the Diagnostics tab. The set of attributes varies based on the version of the network engine. For example, a network engine at Release 11.0 on a BACnet site has a set of Status and BACnet attributes that do not apply to a network engine at Release 10.1 or earlier. Attributes that are marked with a letter C are configurable and attributes marked with the letter W are writable.

Table 1. Ethernet IP Datalink Attributes - Focus/Configuration Tab

Attribute Name

Notes

Initial Value

Description

Address Length

 

6

Indicates the number of octets for the device address (Data Link Address).

APDU Length

or

Max APDU Length

C,W

1024

Indicates the maximum number of bytes that may be contained in a single, indivisible application layer protocol data unit (APDU). Units = bytes

Note: If you write the value of this attribute, you must reset the Engine for the new settings to take effect.

APDU Retries

C,W

4

Indicates the maximum number of times that an APDU is retransmitted. If the device does not perform retries, it is set to zero. If this value is greater than zero, a non-zero value appears in the APDU Timeout attribute.

APDU Segment Timeout

C,W

10000

Indicates the amount of time in milliseconds between retransmission of an APDU segment. This value is non-zero if the device supports segmentation of transmitted APDUs. Units = milliseconds

Note: At Metasys Release 10.0 and later the default value is 10,000. In earlier releases, the default value is 4,000.

APDU Timeout

C,W

10000

Indicates the amount of time in milliseconds between retransmissions of an APDU requiring acknowledgment for which no acknowledgment has been received.

Units = milliseconds

1,000–65,535

Note: At Metasys Release 10.0 and later the default value is 10,000. In earlier releases, the default value is 6,000.

BACnet IP Mode

 

BBMD IP Mode

Indicates whether the network port object is in use by the BBMD. Possible values: Normal IP Mode or BBMD IP Mode.

BACnet IP UDP Port

 

47808

Indicates the IP UDP Port number that the device uses to transmit and receive messages.

BACnet UDP Port

 

47808

Indicates the UDP Port number that the device uses to transmit and receive messages.

BBMD Accept F.D. Registrations

C,W

False

Determines whether a BBMD is allowed to register foreign devices, either True or False. If you change this value, you must activate it with the Activate Changes > Update Changes Pending Attributes Except Network Number command to the Engine. The change is updated immediately online but it is not fully applied until you activate the change.

BBMD Broadcast Distribution Table

C,W

Specifies a list of BBMDs on the building network by IP address or hostname. The hostname must be in the DNS table of the DNS server in order to be resolved. If you change this value, you must activate it with the Activate Changes > Update Changes Pending Attributes Except Network Number command to the Engine.

Note: Do not edit this table if Dynamic Broadcast Management is set to False in the Site object.

BBMD Foreign Device Table

 

Specifies a list of any foreign devices registered with the BBMD and described in the sequence of IP address, time to live, and remaining time to live.

Broadcast Address

   

Indicates the address used when sending broadcast messages. Maximum length = 6 octets

Changes Pending

 

False

Indicates whether a change to a network port object attribute has yet to be activated. Possible values: True or False. If True, issue an Activate Changes command to the network engine.

Command

 

Idle

Indicates the BACnet command specific to the network port object. Possible values: Idle (default), Discard changes, Renew foreign device registration, Restart subordinate discovery, Renew DHCP, Restart auto-negotiation, Disconnect, or Restart port. Discard Changes discards any pending changes to the network port object.

Configured Network Number

C,W

1001

Indicates the BACnet network number configured for the data link.

Device Address

   

Indicates the address of the device (Data Link Address). Maximum length = 6 octets

DNS Refresh Period

C,W

20

Specifies the time in minutes between DNS lookups to update the IP address of a BACnet Broadcast Management Device (BBMD) referenced by host name. If an IP address is changed within a DNS server, the BBMD system automatically obtains the new IP address upon the expiration of this period. A value of 0 is used to disable periodic DNS lookups.

Internode Comm Timer

C,W

120

Controls the frequency of communication with IP devices over the Ethernet. Among other communications, this attribute defines the frequency of the heartbeat to monitored devices (monitored at a rate of two times the Internode Comm Timer). Recommended settings: high sensitivity: 30 seconds; medium sensitivity: 120 seconds (default); low sensitivity: 240 seconds.

Note: If you change the value of this attribute, you must reset the network engine for the new settings to take effect.

IP Address

   

Indicates the currently assigned IP address of the network engine.

IP Default Gateway

   

Indicates the IP address of the network engine's default gateway.

IP DHCP Enable

   

Indicates whether the network engine is set for DHCP or static IP address assignment. Possible values: True or False.

IP DNS Server

C,W

 

Lists the DNS server(s) assigned to the network engine.

IP Subnet Mask

   

Indicates the currently assigned IP subnet mask address of the network engine.

JCI Network Port APDU Retries

C,W

4

Indicates the maximum number of times that an APDU is retransmitted. If the device does not perform retries, it is set to zero. If this value is greater than zero, a non-zero value appears in the APDU Timeout attribute.

JCI Network Port APDU Segment Timeout

C,W

10000

Indicates the amount of time in milliseconds between retransmission of an APDU segment. This value is non-zero if the device supports segmentation of transmitted APDUs. Units = milliseconds

JCI Network Port APDU Timeout

C,W

10000

Indicates the amount of time in milliseconds between retransmissions of an APDU requiring acknowledgment for which no acknowledgment has been received.

Units = milliseconds

1,000–65,535

JCI Network Port Type

   

Indicates the type of port in use by the network engine.

Link Speed

   

Indicates the Ethernet link speed of the network engine. Possible values: 1,000,000, 10,000,000, or 100,000,000.

MAC Address

   

Contains the unique hardware number that identifies the network engine within a network.

Network Number Quality

   

Describes how the network number was acquired. Possible values: Network Number Configured (always for NAE or SNx), Network Number Learned/Configured, Network Number Learned, Network Number Unknown.

Network Type

   

Indicates the type of network that the network engine is using. Example: BACnet/IP over IPv4

Out of Service

   

De-couples the object from the physical input. When Out of Service is True, the object decouples the Present Value and Reliability from the hardware. The Reliability is writable when Out Of Service is True. When de-coupled, the Present Value can be changed to simulate specific conditions or for test purposes.

Additionally, the Out of Service state of the Status Flags attribute is set to True and the Fault state is decoupled from the physical input when Out of Service is True.

Pending Network Number

 

1001

Indicates the BACnet network number that is currently pending for configuring the datalink object. Once you issue an Activate Changes command to the engine, the Configured Network Number is set to the Pending Network Number.

The steps to perform this update on a live engine are as follows:

  1. Under Engine object select the Network tab.
  2. Change Routing Mode to Enabled, if required.
  3. Select the Eth IP Datalink or SC Network Port object and modify the Pending Network Number to the desired value.
  4. If modified in step 2, change Routing Mode to Disabled.
  5. Select Update Changes, Pending Attributes and Restart Device to command the engine to activate changes.

Protocol Level

   

Indicates the protocol level of the engine. Example: BACnet application

Reliability

   

Indicates the current reliability of the integration. The normal state is Reliable.

Status Flags

   

Indicates the general status of the object in BACnet terms and contains one of four independent states:

In Alarm—False if the Event State attribute value is Normal; otherwise, the In Alarm flag is True. (Set only by BACnet Intrinsic Alarming.)

Fault—True (1) if the Reliability attribute is not reliable; otherwise, the Fault flag is False.

Overridden—Overridden flag is True if the Present Value is overridden from the hardware source level.

Out of Service—Out of Service flag is True if the Out of Service attribute value is True; otherwise, the Out of Service flag is False.

Table 2. Ethernet IP Datalink Attributes - Diagnostic Tab

Attribute Name

Data Type

Description

Broadcast Receives

Number

Indicates the number of broadcast messages received.

Broadcast Transmits

Number

Indicates the number of broadcast message transmissions.

Discarded Frames

Number

Indicates the count of received messages discarded due to critical low resources (that is, the System Memory Resource, Object Engine Queue Resource, or Protocol Engine Input Queue Resource).

Message Receives

Number

Indicates the number of messages received.

Message Transmits

Number

Indicates the number of message transmissions.

Reset Date

Date

Indicates the date of the last Clear Statistics command.

Reset Time

Time

Indicates the time of the last Clear Statistics command.

Retry Attempts

Number

Indicates the number of retry attempts.

Transmit Failures

Number

Indicates the number of message transmit failures.