SC Network Port Attributes - Metasys - LIT-1201793 - Software Application - Site Management Portal - 12.0.50

Metasys Site Management Portal Help

Brand
Metasys
Product name
Site Management Portal
Document type
User Guide
Document number
LIT-1201793
Version
12.0.50
Revision date
2023-06-02
Language
English
The SC Network Port object contains attributes common to many Metasys system objects. You can find a description of these common attributes in the Common Object Attributes section. This section includes attributes of the Focus/Configuration tabs.
Note: In the Notes column, attributes that are marked with a letter C are configurable, which means you set it at creation, attributes marked with the letter W are writable, which means you change it post creation, and attributes marked with the letter N indicate values not required.
Table 1. SC Network Port Attributes - Focus/Configuration Tab
Attribute Name Notes Description
Network Type   Indicates the Network Type of the Network Port.
Protocol Level  

Physical indicates if the Network Port object represents a physical network interface.

Protocol indicates if the Network Port object represents a non-BACnet protocol.

BACnet application indicates if the Network Port object represents BACnet use of the protocol. All JCI Network Port Objects have Protocol Level of BACnet application

Non BACnet application indicates if the Network Port object represents a non-BACnet use of the protocol .

SC Node Type   Indicates the type of BACnet/SC node the device represents. The value of this attribute is ultimately determined by the configuration of the device, but defaults to Primary Hub for NAE_supervisor_family and Node for all other devices, for a new device that has yet to be configured or have archived configuration values.
Configured Network Number   Indicates the Configured Network Number of the Network Port.
Network Number Quality  

Indicates how the Network Number is acquired.

Unknown if not Learned, Learned Configured, or Network Number configured. NAE and SNX devices are always be Configured, but learned devices start up as Learnedand change to Learned or Learned Configured when it receives a Network-Number-Is message.

Virtual MAC Address   Represents the Virtual MAC Address (VMAC) that identifies the device during BACnet/SC BVLC Message exchange. By default the value of this attribute is the device's MAC address.However, the device may be required to change its VMAC in the event of a VMAC Collision while attempting to connect to another device.
IP Address   Indicates the IP address of the network port.
IP Default Gateway   Indicates the IP address of the default gateway for the network.
IP Subnet Mask   Indicates the subnet mask for the network.
Network Port WebSocket URIs   Contains an array of WebSocket URIs that are the current URIs the Network Port uses.
JCI Maximum BVLC Length Accepted   65535 is the Maximum BACnet Virtual Link Control (BVLC) length accepted.
JCI Maximum NPDU Length Accepted   61327 is the Maximum Network Protocol Data Unit (NPDU) length accepted.
APDU Length   Maximum number of octets that may be contained in a single indivisible application protocol data unit sent or received on this port. Must be greater than 50. This property also indicates the maximum number of octets that may be contained in a single individual network service data unit sent or received on this port.
Link Speed   Represents the network communication rate as the number of bits per second. A value of 0 indicates an unknown communication rate.
Pending SC Node Type   Indicates the type of BACnet/SC node the device represents, based on the pending changes. If Changes Pending property is False, the value of this property is Undefined.
Changes Pending   True indicates that changes are pending.

False indicates that changes are not pending.

Pending Attributes requiring Activation   Shows attributes that require activation.
Command W BACnet Command attribute.

Statuses for this attribute can be:

Idle:

Discard changes:

Renew foreign device registration:

Restart subordinate discovery:

Renew DHCP:

Restart auto-negotiation:

Disconnect:

Restart port:

Out of Service   True indicates out of service. False indicates the port is not out of service.
Status Flags  

Represents four Boolean flags that indicate the general health of the Network.

The four status check boxes are: In Alarm, Fault, Overridden, and Out of Service.

In Alarm is checked if the Network Port is in an Alarm and does not have a value of Normal.

Fault is checked if the Network Port Object, the Network Port, and the Network connected to the port have unreliable Reliability connections.

Overridden is always False and unchecked.

Out of Service is checked if the Network Port is out of service.

Reliability   Indicates whether the Network Port Object, the network port, and the network connected to the port are reliable as far as the BACnet device can determine and, if not, why.
JCI SC Connector State  

Connected to Primary Hub indicates

No Hub Connection indicates

JCI SC Primary Hub Connection Status   Indicates the status and associated information about the Primary Hub connection initiated by the hub connector.
JCI SC Failover Hub Connection Status   Indicates the status and associated information about the Failover Hub connection initiated by the hub connector.
JCI SC Hub Function Connection Status   Indicates the status and associated information about all BACnet/SC connections accepted by the hub function.
JCI SC Direct Connect Connection Status   Indicates the status and associated information about the BACnet/SC direct connections accepted and initiated by this port.
Use Site Settings W

True indicates that the BACnet/SC Network Port Object (SC NPO) should use the configuration parameters configured at the Site Object.

False indicates that the SC NPO should not use the configuration parameters set by the Site Object.

Pending Network Number  

Specifies the network number that is assigned to the integration when the user sends the Activate Changes command to the engine.

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.
Secure Port Number   Represents the TCP port number the BACnet/SC Datalink binds to for secure websocket communication. Any change to this property updates the current URIs that the device uses to accept websocket connections.
JCI SC Primary Hub URI   Provides the URI for the Primary Hub Function. The value is a UTF-8 string containing a WebSocket URI as of RFC 6455, formatted as of RFC 3986. If no URI is configured, this property is an empty UTF-8 string.
JCI SC Failover Hub URI   Provides the URI for the Failover Hub Function. The value is a UTF-8 string containing a WebSocket URI as of RFC 6455, formatted as of RFC 3986. If no URI is configured, this property is an empty UTF-8 string.
JCI SC Hub Function Enable W

True indicates Hub Function is enabled.

False indicates Hub Function is not enabled.

JCI Hub Function Accpet URIs C

Contains an array of WebSocket URIs that represents the possible URIs a BACnet/SC hub connector device can use to connect to the hub function. Each WebSocket URI entry is UTF-8 string containing a WebSocket URI as of RFC 6455, formatted as of RFC 3986.

The value of this property is equal to the device's URI, which depends on the IP Address, Secure Port Number, and Hostname property values. Both the IP Address and Hostname URI variants are in this list. If Hub Function is not enabled, this property contains an empty list.

This attribute is required if the port supports the BACnet/SC Hub Function.

You can configure this property by the IP Address, Secure Port Number, and Hostname properties. If you modify any of these values modifies this property.

JCI Direct Connect Enable W

True indicates that the port allows initiating or accepting BACnet/SC Direct Connections.

False indicates that this port does not allow either initiating or accepting BACnet/SC Direct Connections.

This attribute is required to be present if the port supports Direct Connections.

JCI Direct Connect Accept URIs C

Contains an array of WebSocket URIs that are included in the Address-Resolution-ACK response. The array represents the possible URIs an initiating BACnet/SC direct connection device could use to directly connect to this device. Each WebSocket URI entry is a UTF-8 string containing a WebSocket URI as of RFC 6455, formatted as of RFC 3986.

The value of this property is equal to the device's URI, which depends on the IP Address, Secure Port Number, and Hostname property values. Both the IP Address and Hostname URI variants is in this list. If Direct Connect is not enabled, this property contains an empty list.

This attribute is required and you can configure it if the port supports Direct Connections.

JCI SC Minimum Reconnect Time W Specifies the minimum time in seconds between each attempt to establish a BACnet/SC connection. It represents the minimum time the initiating peer waits before initiating a connection attempt.
JCI SC Maximum Reconnect Time W Specifies the maximum time in seconds between each attempt to establish a BACnet/SC connection. It represents the maximum time the initiating peer waits before initiating a connection attempt.
JCI SC Connect Wait Timeout W Specifies the time in seconds that a node waits for a response BVLC message while it connects to BACnet/SC.
JCI SC Disconnect Wait Timeout W Specifies the time in seconds that a node waits for a response BVLC message while it disconnects to BACnet/SC.
JCI SC Initiating Heartbeat Timeout W Specifies the time in seconds of BVLC message inactivity on a BACnet/SC connection before a Heartbeat-Request message is sent by an initiating BACnet/SC node.
Maximum Direct Connection Retries W

Indicates the maximum amount of retry attempts made when trying to establish a Direct Connection with another Node. If this value is exceeded, no more attempts are made to establish the Direct Connection.

If this value is 65535, then an infinite amount of retry attempts are made until the Direct Connection is successfully established.

If this value is 0, then no retry attempts are made if the first connection attempt fails.

It is recommended that this value is significantly large to allow any network configuration issues to be resolved and still allow the Direct Connection to automatically get established. However, if the value of this property is too large, the network and Hub Function may get flooded with messages unnecessarily, such as when a device is removed from the network or a device changed its VMAC Address.

Note: This value does not include the first connection attempt. So, if this value is 99, then 100 total connection attempts are made before giving up on the Direct Connection. The Minimum or Maximum Reconnect Time values still apply between consecutive connection attempts. If the written value is smaller than the current value, any current pending Direct Connections use the newly written value in determining if another retry is attempted.
JCI Network Port APDU Timeout W

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

This value is non-zero if the APDU Retries property is non-zero.

Note: This is a proprietary version of a BACnet Standard Device Object property which you can use in the JCI Network Port Objects to allow different values for different datalinks.
JCI Network Port APDU Segment Timeout W Indicates the amount of time, in milliseconds between retransmission of an APDU segment.
Note: This is a proprietary version of a BACnet Standard Device Object property which you can use in the JCI Network Port Objects to allow different values for different datalinks.
JCI Network Port APDU Retries W Indicates the maximum number of times that an APDU is retransmitted.
Note: This is a proprietary version of a BACnet Standard Device Object property that you can use in the JCI Network Port Objects to allow different values for different datalinks.
Item Reference   Indicates the fully qualified reference information for the object.