NTCIP Gateway Internal Datapoints

Datapoint Element	Data Type	Description
Configuration.Address	string	DMS host address
Configuration.SNMPVersion	uint	DMS SNMP version 1 = SNMP v1 3 = SNMP v3
Configuration.v1ReadCommunity	string	DMS Read Community (when SNMP v1 is used)
Configuration.v1WriteCommunity	string	DMS Write Community (when SNMP v1 is used)
Configuration.v3SecurityName	string	DMS Security Name (when SNMP v3 is used)
Configuration.v3ContextName	string	DMS Context Name (when SNMP v3 is used)
Configuration.v3AuthenticationMode	uint	DMS Authentication Mode (when SNMP v3 is used) 0 = noAuthNoPriv 1 = authNoPriv 2 = authPriv
Configuration.v3AuthenticationProtocol	uint	DMS Authentication Protocol (when SNMP v3 is used) 0 = none 1 = MD5
Configuration.v3AuthenticationSecret	string	DMS Authentication Password (when SNMP v3 is used)
Configuration.v3PrivacyProtocol	uint	DMS Privacy Protocol (when SNMP v3 is used) 0 = none 1 = DES 2 = 3DES
Configuration.v3PrivacySecret	string	DMS Privacy Password (when SNMP v3 is used)
SystemInformation.SystemDescription	string	Shows the full name and version identification of the system's hardware type.
SystemInformation.SystemOID	string	Identifies the network management subsystem contained in the entity
SystemInformation.SystemContact	string	Contains the textual identification of the contact person for this managed node.
SystemInformation.SystemName	string	System name is an administratively assigned name for this managed node.
SystemInformation.SystemLocation	string	Shows the physical location of the node.
SystemInformation.PixelWidth	uint	Provide information about the logical display width of the DMS.
SystemInformation.PixelHeight	uint	Provide information about the logical display height of the DMS.
Command.EnableCommunication	bool	Enable or disable >communication between NTCIP Gateway and DMS.
Command.RefreshFontList	bool	Polls the NTCIP MIB dmsFontTable object of the DMS.
Command.RefreshBitmapList	bool	Polls the NTCIP MIB dmsGraphicTable object of the DMS.
Command.RefreshMessageList	bool	Polls the NTCIP MIB dmsMessageTable object of the DMS.
Command.BlankSign	bool	By activating this command, the currently displayed message will be replaced by the "blank" message.
Command.ActivateMessage	bool	Command for activating a message. Note: First the MemoryType, Number, ActivationPriority and Duration from the Content.ActivateMessage subtree has to be defined.
Command.Reset	bool	Restart the DMS controller.
Command.DefineMessage	bool	Command for defining a new message. All data of the DefineMessage DPEs must be set.
Command.DeleteMessage	bool	Delete an existing message.
Command.RefreshBrightnessTable	bool	Polls the NTCIP MIB dmsIllumBrightnessValues object of the DMS
Command.GetMessageDetails	bool	Get content of current message from the DMS.
State.PartnerActive	bool	Indicates if partner is active.
State.ShortErrorStatus	int	Shows short error state.
State.ShortErrorStatusText	string	Shows short error state text.
State.PixelFailureMap	blob	Shows status of each pixel.
State.DoorOpen	int	Shows status of door open.
State.WatchdogFailureCount	uint	Shows failure count of watchdog.
State.ControllerErrorStatus	int	Shows controller error state.
Resources.Fonts	dyn_string	Contain a textual representation of the resources available on the DMS. They cannot be changed with the NTCIP Gateway.
Resources.Bitmaps	dyn_string	Contain a textual representation of the resources available on the DMS. They cannot be changed with the NTCIP Gateway.
Content.AvailableMessage	dyn_string	List of all currently defined messages on the DMS
Content.MaxChangeableMessages	uint	Maximum number of changeable messages.
Content.MaxVolatileMessages	uint	Maximum number of volatile messages.
Content.FreeChangeableMemory	uint	Indicates the number of bytes available within changeable memory.
Content.FreeVolatileMemory	uint	Indicates the number of bytes available within volatile memory.
Content.ValidationStatus.LastValidationError	int	Contains a possible error. 1 = other 2 = none 3 = beacons 4 = pixelService 5 = syntaxMULTI
Content.ValidationStatus.LastMultiSyntaxError	int	Contains multi error information. 1 = other: An error other than one of those listed. 2 = none: No error detected. 3 = unsupportedTag: The tag is not supported by this device. 4 = unsupportedTagValue: The tag value is not supported by this device. 5 = textTooBig: Too many characters on a line, too many lines for a page, or font is too large for the display. 6 = fontNotDefined: The font is not defined in this device. 7 = characterNotDefined: The character is not defined in the selected font. 8 = fieldDeviceNotExist: The field device does not exist / is not connected to this device. 9 = fieldDeviceError: This device is not receiving input from the referenced field device and/or the field device has a fault. 10 = flashRegionError: The flashing region cannot be flashed by this device. 11 = tagConflict: The message cannot be displayed with the combination of tags and/or tag implementation cannot be resolved. 12 = tooManyPages: Too many pages of text exist in the message. 13 = fontVersionID: The fontVersionID contained in the MULTI tag does not match the fontVersionID for the fontNumber indicated. 14 = graphicID: The dmsGraphicID contained in the MULTI tag does not match the dmsGraphicID for the dmsGraphicIndex indicated. 15 = graphicNotDefined: The graphic is not defined in this device.
Content.ValidationStatus.LastMultiSyntaxErrorPosition	int	Contains further error information.
Content.ValidationStatus.LastOtherErrorDescription	string	Contains further error information.
Content.ActivationStatus.LastActivationError	int	Last error on activating a message.
Content.ActivationStatus.LastActivationState	int	Last state on activating a message.
Content.CurrentMessage.MemoryType	int	Memory type of current message. 2 = permanent 3 = changeable 4 = volatile 7 = blank
Content.CurrentMessage.Number	int	Number of current message.
Content.CurrentMessage.MultiString	string	Multi string of current message.
Content.CurrentMessage.TimeRemaining	int	Remaining display time in minutes of current message. If time is set to 65535 display time is infinite.
Content.CurrentMessage.Priority	int	Runtime priority (1 - 255) of current message.
Content.CurrentMessage.Status	int	Status of current message.
Content.CurrentMessage.Owner	string	Owner of current message.
Content.CurrentMessage.ControllerMode	int	Controller Mode of current message.
Content.CurrentMessage.SourceMode	int	Indicates the reason why this message was activated. 1 = other: the currently displayed message was activated based on a condition other than the ones defined below. This would include any auxiliary devices. 2 = local: the currently displayed message was activated at the sign controller using either an onboard terminal or a local interface. 3 = external: the currently displayed message was activated from a locally connected device using serial (or other type of) connection to the sign controller such as a laptop or a PDA. 8 = central: the currently displayed message was activated from the central computer. 9 = timebasedScheduler: the currently displayed message was activated from the time based scheduler as configured within the sign controller. 10 = powerRecovery: the currently displayed message was activated based on the DMS settings for power recovery. 11 = reset: the currently displayed message was activated based on the DMS settings for the reset message. 12 = commLoss: the currently displayed message was activated based on the DMS settings for communication loss. 13 = powerLoss: the currently displayed message was activated based on the DMS settings for power loss. This state might be used for motor driven signs which have a defined power loss position. 14 = endDuration: the currently displayed message was activated based on the DMS settings for the end of duration of a message (e.g., default message, typically blank).
Content.CurrentMessage.Requester	string	Requester of current message.
Content.CurrentMessage.MsgTableSource	string	Message table source (message ID used to generate current display).
Content.ActivateMessage.MemoryType	int	Memory type of next message to be activated. 2 = permanent 3 = changeable 4 = volatile 7 = blank
Content.ActivateMessage.Number	int	Number of next message to be activated.
Content.ActivateMessage.ActivationPriority	int	Activation priority of next message (must be higher than runtime priority of current message to activate next message).
Content.ActivateMessage.Duration	int	Display duration in minutes. If time is set to 65535 display time is infinite.
Content.ActivateMessage.MessagePriority	int	Runtime priority (1 - 255) of next message.
Content.ActivateMessage.MultiString	string	Multi string of next message.
Content.ActivateMessage.Owner	string	Owner of next message.
Content.ActivateMessage.PixelService	bool	Define pixel service of next message.
Content.ActivateMessage.Beacon	bool	Define beacon of next message.
Content.ActivateMessage.CRC	int	Define CRC of next message.
Content.ActivateMessage.Status	int	Define message status of next message. 1 = notUsed 4 = valid 5 = error
Content.DefineMessage.MemoryType	int	Memory type of message for defining new message. 3 = changeable 4 = volatile
Content.DefineMessage.Number	int	Number of message for defining new message.
Content.DefineMessage.Priority	int	Runtime priority (1 - 255) of message for defining new message.
Content.DefineMessage.MultiString	string	Multi string of message for defining new message.
Content.DefineMessage.Owner	string	Owner of message for defining new message.
Content.DefineMessage.PixelService	bool	Pixel service of message for defining new message.
Content.DefineMessage.Beacon	bool	Beacon of message for defining new message.
Illumination.MaxPhotocellLevel	int	Provides the maximum value which can be reached by the PhotocellLevelStatus DPE. The value range is 0 ... 65535.
Illumination.PhotocellLevelStatus	int	Shows the current photocell value.
Illumination.BrightnessLevelStatus	int	Shows the current brightness level of the device.
Illumination.LightOutputStatus	int	Represents the physical light output level ranging from 0 (darkest) to 65535 (maximum).
Illumination.ControlType	int	Indicates the method used to select the brightness level. 1 = other: indicates that the Brightness Level is based on a mechanism not defined by this standard; see manufacturer documentation. 2 = photocell: indicates that the Brightness Level is based on photocell status. 3 = timer: indicates that the Brightness Level is set by an internal timer. The details of this timer are not defined by this standard. 4 = manual: (deprecated) indicates that the Brightness Level must be changed via the manual level settings. 5 = manualDirect: indicates that a user can change the brightness output to any of the brightness levels supported by the sign. This is not the same as the number of brightness levels defined within the brightness table. 6 = manualIndexed: indicates that a user can change the brightness output to any of the rows defined within the brightness table. A DMS might not support all the defined values.
Illumination.ManualLevel	int	Indicates the desired value of the Brightness Level as a value ranging from 0 to the value of MaxBrightnessLevels when under manual control.
Illumination.MaxBrightnessLevel	int	Provides the maximum value of selectable brightness level the DMS supports. This is not the number of entries in the brightness table. The value ranges from 0 (off) to 255 (maximum).
Illumination.BrightnessValuesTable	dyn_int	Provides a value collection, where the index represents the level, and the value represents the lightOutput setting of this level. Index 0 means "dark", and the highest index usually means "full light". This table cannot be redefined with the NTCIP gateway.

Configuration.Address

string

DMS host address

Configuration.SNMPVersion

uint

DMS SNMP version

1 = SNMP v1
3 = SNMP v3

Configuration.v1ReadCommunity

string

DMS Read Community (when SNMP v1 is used)

Configuration.v1WriteCommunity

string

DMS Write Community (when SNMP v1 is used)

Configuration.v3SecurityName

string

DMS Security Name (when SNMP v3 is used)

Configuration.v3ContextName

string

DMS Context Name (when SNMP v3 is used)

Configuration.v3AuthenticationMode

uint

DMS Authentication Mode (when SNMP v3 is used)

0 = noAuthNoPriv
1 = authNoPriv
2 = authPriv

Configuration.v3AuthenticationProtocol

uint

DMS Authentication Protocol (when SNMP v3 is used)

0 = none
1 = MD5

Configuration.v3AuthenticationSecret

string

DMS Authentication Password (when SNMP v3 is used)

Configuration.v3PrivacyProtocol

uint

DMS Privacy Protocol (when SNMP v3 is used)

0 = none
1 = DES
2 = 3DES

Configuration.v3PrivacySecret

string

DMS Privacy Password (when SNMP v3 is used)

SystemInformation.SystemDescription

string

Shows the full name and version identification of the system's hardware type.

SystemInformation.SystemOID

string

Identifies the network management subsystem contained in the entity

SystemInformation.SystemContact

string

Contains the textual identification of the contact person for this managed node.

SystemInformation.SystemName

string

System name is an administratively assigned name for this managed node.

SystemInformation.SystemLocation

string

Shows the physical location of the node.

SystemInformation.PixelWidth

uint

Provide information about the logical display width of the DMS.

SystemInformation.PixelHeight

uint

Provide information about the logical display height of the DMS.

Command.EnableCommunication

bool

Enable or disable >communication between NTCIP Gateway and DMS.

Command.RefreshFontList

bool

Polls the NTCIP MIB dmsFontTable object of the DMS.

Command.RefreshBitmapList

bool

Polls the NTCIP MIB dmsGraphicTable object of the DMS.

Command.RefreshMessageList

bool

Polls the NTCIP MIB dmsMessageTable object of the DMS.

Command.BlankSign

bool

By activating this command, the currently displayed message will be replaced by the "blank" message.

Command.ActivateMessage

bool

Command for activating a message.

Note:

First the MemoryType, Number, ActivationPriority and Duration from the Content.ActivateMessage subtree has to be defined.

Command.Reset

bool

Restart the DMS controller.

Command.DefineMessage

bool

Command for defining a new message. All data of the DefineMessage DPEs must be set.

Command.DeleteMessage

bool

Delete an existing message.

Command.RefreshBrightnessTable

bool

Polls the NTCIP MIB dmsIllumBrightnessValues object of the DMS

Command.GetMessageDetails

bool

Get content of current message from the DMS.

State.PartnerActive

bool

Indicates if partner is active.

State.ShortErrorStatus

int

Shows short error state.

State.ShortErrorStatusText

string

Shows short error state text.

State.PixelFailureMap

blob

Shows status of each pixel.

State.DoorOpen

int

Shows status of door open.

State.WatchdogFailureCount

uint

Shows failure count of watchdog.

State.ControllerErrorStatus

int

Shows controller error state.

Resources.Fonts

dyn_string

Contain a textual representation of the resources available on the DMS. They cannot be changed with the NTCIP Gateway.

Resources.Bitmaps

dyn_string

Contain a textual representation of the resources available on the DMS. They cannot be changed with the NTCIP Gateway.

Content.AvailableMessage

dyn_string

List of all currently defined messages on the DMS

Content.MaxChangeableMessages

uint

Maximum number of changeable messages.

Content.MaxVolatileMessages

uint

Maximum number of volatile messages.

Content.FreeChangeableMemory

uint

Indicates the number of bytes available within changeable memory.

Content.FreeVolatileMemory

uint

Indicates the number of bytes available within volatile memory.

Content.ValidationStatus.LastValidationError

int

Contains a possible error.

1 = other
2 = none
3 = beacons
4 = pixelService
5 = syntaxMULTI

Content.ValidationStatus.LastMultiSyntaxError

int

Contains multi error information.

1 = other: An error other than one of those listed.
2 = none: No error detected.
3 = unsupportedTag: The tag is not supported by this device.
4 = unsupportedTagValue: The tag value is not supported by this device.
5 = textTooBig: Too many characters on a line, too many lines for a page, or font is too large for the display.
6 = fontNotDefined: The font is not defined in this device.
7 = characterNotDefined: The character is not defined in the selected font.
8 = fieldDeviceNotExist: The field device does not exist / is not connected to this device.
9 = fieldDeviceError: This device is not receiving input from the referenced field device and/or the field device has a fault.
10 = flashRegionError: The flashing region cannot be flashed by this device.
11 = tagConflict: The message cannot be displayed with the combination of tags and/or tag implementation cannot be resolved.
12 = tooManyPages: Too many pages of text exist in the message.
13 = fontVersionID: The fontVersionID contained in the MULTI tag does not match the fontVersionID for the fontNumber indicated.
14 = graphicID: The dmsGraphicID contained in the MULTI tag does not match the dmsGraphicID for the dmsGraphicIndex indicated.
15 = graphicNotDefined: The graphic is not defined in this device.

Content.ValidationStatus.LastMultiSyntaxErrorPosition

int

Contains further error information.

Content.ValidationStatus.LastOtherErrorDescription

string

Contains further error information.

Content.ActivationStatus.LastActivationError

int

Last error on activating a message.

Content.ActivationStatus.LastActivationState

int

Last state on activating a message.

Content.CurrentMessage.MemoryType

int

Memory type of current message.

2 = permanent
3 = changeable
4 = volatile
7 = blank

Content.CurrentMessage.Number

int

Number of current message.

Content.CurrentMessage.MultiString

string

Multi string of current message.

Content.CurrentMessage.TimeRemaining

int

Remaining display time in minutes of current message. If time is set to 65535 display time is infinite.

Content.CurrentMessage.Priority

int

Runtime priority (1 - 255) of current message.

Content.CurrentMessage.Status

int

Status of current message.

Content.CurrentMessage.Owner

string

Owner of current message.

Content.CurrentMessage.ControllerMode

int

Controller Mode of current message.

Content.CurrentMessage.SourceMode

int

Indicates the reason why this message was activated.

1 = other: the currently displayed message was activated based on a condition other than the ones defined below. This would include any auxiliary devices.
2 = local: the currently displayed message was activated at the sign controller using either an onboard terminal or a local interface.
3 = external: the currently displayed message was activated from a locally connected device using serial (or other type of) connection to the sign controller such as a laptop or a PDA.
8 = central: the currently displayed message was activated from the central computer.
9 = timebasedScheduler: the currently displayed message was activated from the time based scheduler as configured within the sign controller.
10 = powerRecovery: the currently displayed message was activated based on the DMS settings for power recovery.
11 = reset: the currently displayed message was activated based on the DMS settings for the reset message.
12 = commLoss: the currently displayed message was activated based on the DMS settings for communication loss.
13 = powerLoss: the currently displayed message was activated based on the DMS settings for power loss. This state might be used for motor driven signs which have a defined power loss position.
14 = endDuration: the currently displayed message was activated based on the DMS settings for the end of duration of a message (e.g., default message, typically blank).

Content.CurrentMessage.Requester

string

Requester of current message.

Content.CurrentMessage.MsgTableSource

string

Message table source (message ID used to generate current display).

Content.ActivateMessage.MemoryType

int

Memory type of next message to be activated.

2 = permanent
3 = changeable
4 = volatile
7 = blank

Content.ActivateMessage.Number

int

Number of next message to be activated.

Content.ActivateMessage.ActivationPriority

int

Activation priority of next message (must be higher than runtime priority of current message to activate next message).

Content.ActivateMessage.Duration

int

Display duration in minutes. If time is set to 65535 display time is infinite.

Content.ActivateMessage.MessagePriority

int

Runtime priority (1 - 255) of next message.

Content.ActivateMessage.MultiString

string

Multi string of next message.

Content.ActivateMessage.Owner

string

Owner of next message.

Content.ActivateMessage.PixelService

bool

Define pixel service of next message.

Content.ActivateMessage.Beacon

bool

Define beacon of next message.

Content.ActivateMessage.CRC

int

Define CRC of next message.

Content.ActivateMessage.Status

int

Define message status of next message.

1 = notUsed
4 = valid
5 = error

Content.DefineMessage.MemoryType

int

Memory type of message for defining new message.

3 = changeable
4 = volatile

Content.DefineMessage.Number

int

Number of message for defining new message.

Content.DefineMessage.Priority

int

Runtime priority (1 - 255) of message for defining new message.

Content.DefineMessage.MultiString

string

Multi string of message for defining new message.

Content.DefineMessage.Owner

string

Owner of message for defining new message.

Content.DefineMessage.PixelService

bool

Pixel service of message for defining new message.

Content.DefineMessage.Beacon

bool

Beacon of message for defining new message.

Illumination.MaxPhotocellLevel

int

Provides the maximum value which can be reached by the PhotocellLevelStatus DPE. The value range is 0 ... 65535.

Illumination.PhotocellLevelStatus

int

Shows the current photocell value.

Illumination.BrightnessLevelStatus

int

Shows the current brightness level of the device.

Illumination.LightOutputStatus

int

Represents the physical light output level ranging from 0 (darkest) to 65535 (maximum).

Illumination.ControlType

int

Indicates the method used to select the brightness level.

1 = other: indicates that the Brightness Level is based on a mechanism not defined by this standard; see manufacturer documentation.
2 = photocell: indicates that the Brightness Level is based on photocell status.
3 = timer: indicates that the Brightness Level is set by an internal timer. The details of this timer are not defined by this standard.
4 = manual: (deprecated) indicates that the Brightness Level must be changed via the manual level settings.
5 = manualDirect: indicates that a user can change the brightness output to any of the brightness levels supported by the sign. This is not the same as the number of brightness levels defined within the brightness table.
6 = manualIndexed: indicates that a user can change the brightness output to any of the rows defined within the brightness table. A DMS might not support all the defined values.

Illumination.ManualLevel

int

Indicates the desired value of the Brightness Level as a value ranging from 0 to the value of MaxBrightnessLevels when under manual control.

Illumination.MaxBrightnessLevel

int

Provides the maximum value of selectable brightness level the DMS supports. This is not the number of entries in the brightness table. The value ranges from 0 (off) to 255 (maximum).

Illumination.BrightnessValuesTable

dyn_int

Provides a value collection, where the index represents the level, and the value represents the lightOutput setting of this level. Index 0 means "dark", and the highest index usually means "full light". This table cannot be redefined with the NTCIP gateway.

NTCIP Gateway Internal Datapoints

_NTCIP_DMS