Simple network port (NwkPortSmp)

Object type Simple network port (NwkPortSmp) represents the external visible information for a network port.

BACnet Secure Connect extension simple network port

Network number

 

 

'Network number' indicates the BACnet network number linked to the network.

  • 'Network number' can be configured to route BACnet data packets to other devices.
  • The 'Network number' is defined to allow routing between BACnet networks.
  • The network number is always unique within a BACnet Internetwork.
  • Default value: 55189
  • Value range: 1...65534

BACnet MAC address

 

 

'BACnet MAC address' indicates the BACnet MAC address used on this network.

BACnet secure connect network port:

  • 'BACnet MAC address' represents the VMAC of the secure connect node with a length of 6 octets in IEEE EUI-48 format.

BACnet routing mode

 

 

'BACnet routing mode' indicates the BACnet routing mode use for BACnet routing of NPDUs between the BACnet network ports.

  • "Routing" allows for normal routing between network ports. The network number must be configured and synchronized within the BACnet Internet network via the primary port.
  • "Hide" provides a hidden network port and allows only access to local nodes. The network number is predefined and does not need to be configured.
  • Default value: Routing.

Maximum BVLC length accepted

 

 

'Maximum BVLC length accepted' indicates the maximum size in octets of a BVLC message that the network port can receive and process.

  • Value range: 0...65535
  • Default value: 5705

Connect timeout

 

 

'Connect timeout' indicates the time in seconds that a node waits for feedback from an BVLC message when connecting to BACnet Secure Connect.

  • Default value: 10 sec
  • Value range: 5-300 sec

Disconnect timeout

 

 

'Disconnect timeout' indicates the time in seconds that a node waits for feedback from a BVLC message when disconnecting from BACnet/SC.

  • Default value: 10 sec
  • Value range: 5-300 sec

Minimum reconnect timeout

 

 

'Minimum reconnect timeout' indicates the minimum timespan in seconds after disconnecting or losing a connection until reconnecting to the secure connect hub.

  • Default value: 30 sec
  • Value range: 2-300 sec

Initiating heartbeat timeout

 

 

'Initiating heartbeat timeout' indicates the maximum timespan in seconds before a heartbeat request is triggered from the node after BVLC inactivity is established in the connection to the secure connect hub.

  • Default value: 30 sec
  • Value range: 3-300 sec

Primary hub URI

 

 

'Primary hub URI' indicates the URI for the primary hub used to connect the node.

  • The local node is connected to the local hub if the port extension is set to the BACnet Secure Connect hub function.
  • The URI indicates where to connect if the port extension is not set to the BACnet Secure Connect hub function.

Failover hub URI

 

 

'Failover hub URI' indicates the URI of the failover hub node that the node uses to connect if the connection to the primary hub is lost or does not connect.

The failover hub URI is not used and is ignored if the port extension is set to the BACnet Secure Connect hub function.

Hub connection status

 

 

'Hub connection status' indicates the status of the BACnet secure connect hub connection.

Device UUID

 

 

'Device UUID' designates the universal unique ID in binary.

  • The 'Device UUID' must have a unique 16-octet UUID before the device is used for the first time on the plant.
  • The Device UUID' must be generated on a plant prior to initial deployment (similar to initial device startup) and must be persistently saved beyond device restart and cannot change throughout the device life cycle.
Extension with hub function

The extension with hub function represents the standardized properties of a BACnet Secure Connect network port that supports Secure Connect nodes with a hub function.

The extension with hub function has the following function:

  • Configuration of secure connect hub functionality.
  • Receipt of connection from secure connect nodes.
  • Forwarding data packets between connected secure connect nodes.

Hub function enable

 

 

'Hub function enable' indicates whether this port executes the BACnet secure connect hub function.

Max. number of accepted hub connections

 

 

'Max. number of accepted hub connections' indicates the maximum number of accepted hub connections from other secure connect nodes.

Default value: 10 (default values may vary based on the performance characteristics of the different device types).

Number of active hub connections

 

 

'Number of active hub connections' indicates the number of nodes currently connected to the hub.

 

Hub listener port

 

 

'Hub listener port' specifies the receive-ready TCP port of the web socket server for the BACnet Secure Connect hub function.

  • 'Hub listener port' is ignored if 'Hub function enable' is set to false.
  • Default value: 0xBAC0
  • Range: 0...65535

Hub listener path

 

 

'Hub listener path' indicates the optional path of the web socket server for the BACnet Secure Connect hub function.

  • 'Hub listener path' is ignored if 'Hub function enable' is set to false.
  • Default value: ""

Hub function URIs

 

 

'Hub function URIs' includes an array of web socket URIs that a node may use to connect to the hub function. 'Hub function URIs' supplies a visible means for BACnet to save and depict possible secure connect hub function WebSocket URIs.

TLS mode

 

 

'TLS mode' indicates how the TLS protocol version is selected for incoming hub connections.

Currently supported TLS protocol versions: 1.2 and 1.3

Extension with failover hub

The extension with failover hub represents the standardized properties of a BACnet secure connect network port that supports the BACnet secure connect nodes with a hub function. The failover hub is used when, for example, the network is interrupted and cannot connect to the primary hub (redundancy principle).

The extension with failover hub has the same properties as the extension with hub function.

Port object model

State flag

 

 

'State flag' indicates the four states for the network port.

  • Out of service
    "Out of service" indicates whether the network port is out of service (or not).
    The 'Reliability property' is no longer updated if set to "Out of service".
  • Overridden
    Value = False
  • Fault
    "Fault" indicates whether the network port and the network are reliable (or not).
  • In alarm
    Value = False

Reliability

 

 

'Reliability' indicates whether the network port and the network are reliable. The 'Reliability' property initiates troubleshooting if the network port and the network are not reliable. In a normal case, the property 'Reliability' is set to "No fault".

Change in progress

 

 

'Change in progress' indicates whether the configuration settings on the network port object match the present configuration settings.

False

The configuration settings mirror the present port configuration information.

True

Indicates that the configuration settings were changed, but not yet enabled.

Command

 

 

'Command' permits triggering of various actions, executed by the network port object. A new command can only be written if the value of property 'Command' is inactive.

Command

Function

Inactive

Default value.

Activate

The current configuration property settings are enabled.

A new command "Enable" can only be written if the value of property 'Command' is inactive'.

The property value remains active until the activation is ended or fails.

Property 'Command' is set to inactive if the 'Change in progress' property is set to false.

'Change in progress' is set to false and property 'Command' is set to inactive if the settings are successfully activated.

Property 'Reliability' is set to "Activation failure' if the settings fail to activate. 'Change in progress' remains true and property 'Command' is set to inactive.

Discard changes.

The changed configuration property settings are discarded.

A new "Discard changes" command can only be written if the value for property 'Command' is inactive.

The changed properties return to the set of property values that existed the first time 'Change in progress' was set to true. The property 'Change in progress' is set to false and property 'Command' is set to inactive.

Restart port

The device reinitializes to restart and reconnect to the network.

A new 'Restart port' command can only be written if the value of property 'Command' is inactive.

The property 'Change in progress' is set to false and property 'Command' is set to inactive.

Out of service

 

 

'Out of service' indicates whether the network port is out of service (or not).

  • The network port is not operational if 'Out of service' is true and communication is disabled via this port. Network resources are enabled or disabled for this port based on the underlying hardware.
  • The network port is operational if 'Out of service' is false and communication is enabled via this port. All network resources are active this port.
  • Property 'Command process state' is set to true if 'Out of service' is changed. The new value for 'Out of service' enables (False) or disables (True) the network port for this object if a value for "Restart port" is written to the 'Command' property.
  • If 'Out of service' is true, then the value 'Activate' of the 'Command' property results in property error "Value out of range".
  • 'Out of service' cannot be set to true (disabled) for the first or primary network port.

Object usage

 

 

'Object usage' indicates whether the object is used (or not). Property 'Object usage' shows or hides the impacted objects and their functionality in a client and enables or disables the network port.

Network port identification

 

 

'Network port identification' selects the physical network interface on the BACnet device that is connected to this network port. The maximum number of available network interfaces depends on the actual hardware.