DLR Object (Class Code: 0x47)

Overview

The Device Level Ring (DLR) Object provides the configuration and status information interface for the DLR protocol. The DLR protocol is a layer 2 protocol that enables the use of an Ethernet ring topology. The DLR protocol is fully specified in Chapter 9. The DLR Object provides the CIP application-level interface to the protocol.

The DLR Object shall be implemented in all multi-port EtherNet/IP devices that support the DLR protocol.

Devices shall implement one instance of the DLR Object for each pair of DLR ring ports supported.

Instance attributes with application access

Attribute ID	Access Rule	NV	Name	Data Type	Value	Description
4	Get, Set	NV	Ring Supervisor Config	STRUCT of:	—	Ring Supervisor configuration parameters The Ring Supervisor Config attribute contains the configuration parameters needed for ring operation: Supervisor Precedence, Beacon Interval, Beacon Timeout, VLAN ID, Supervisor Enable/Disable.
			Ring Supervisor Enable	BOOL	Default: FALSE	Ring supervisor enable flag TRUE indicates the device is configured as a ring supervisor. FALSE indicates device is configured as a normal ring node.
			Ring Supervisor Precedence	USINT	Default: 0	Precedence of a ring supervisor in network with multiple ring supervisors Numerically higher value indicates higher precedence. Value range is 0-255.
			Beacon Interval	UDINT	Default: 400us	Duration of ring beacon interval Beacon interval in microseconds. Value range is 100us - 400ms.
			Beacon Timeout	UDINT	Default: 1960us	Duration of ring beacon timeout Beacon timeout in microseconds. Value range is 800us - 500ms.
			DLR VLAN ID	UINT	Default: 0	VLAN ID to use in ring protocol messages Value range is 0-4094.
12	Get	NV	Capability Flags	DWORD	<Capability Flags>	Describes the DLR capabilities of the device

Table Footnotes:

NOTE:

The DLR Supervisor feature is part of premium SDK. In case you are using standard and need premium, please contact your regional TI sales representative for additional details.

Functions
uint32_t	EI_API_ADP_setDlrSupervisorSupported (T *pAdp_p)
	Enable DLR Supervisor support.
uint32_t	EI_API_ADP_getDlrSupervisorSupported (T *pAdp_p, bool *pDlrSupSupported_p)
	Provides information whether DLR Supervisor is supported.
uint32_t	EI_API_ADP_getDlrSupervisorEnabled (T *pAdp_p, bool *pDlrSupervisorEnabled_p)
	Get the current adapter DLR Supervisor state (Instance Attribute ID: 4).
uint32_t	EI_API_ADP_setDlrSupervisorEnabled (T *pAdp_p, bool dlrSupervisorEnabled_p)
	Set the current adapter DLR Supervisor state (Instance Attribute ID: 4).
uint32_t	EI_API_ADP_getDlrSupervisorConfig (T *pAdp_p, EI_API_ADP_DLR_SupervisorConfig_t *pDlrSupConfig_p)
	Get attribute values of DLR Object (ID 0x47).
uint32_t	EI_API_ADP_setDlrSupervisorConfig (T *pAdp_p, EI_API_ADP_DLR_SupervisorConfig_t *pDlrSupConfig_p)
	Set attribute values in DLR Object (ID 0x47).