NTCIP Tags

<< Click to Display Table of Contents >>

 

NTCIP Tags

The next table contains the description of Tags supported by this Driver for the DMS profile of NTCIP protocol.

Supported Tags for the DMS profile of NTCIP protocol

ParamDevice

ParamItem

Operation

Description

Name of an Agent, such as "device-001"

NTCIP.DMS.GetCurrentMessage

Read-only

Retrieves the current message displayed on a panel. This Block Tag contains 6 (six) Elements. These Elements are Element 1: Text displayed in MULTI String format, Element 2: Remaining time, in minutes (the value 65535 indicates that there is no time limit), Element 3: Priority, between 1 (one) and 255, Element 4: Status. Possible values are 1: Not used, 2: Modifying, 3: Validating, 4: Valid, 5: Error, 6: ModifyReq, 7: ValidateReq, or 8: NotUsedReq, Element 5: Name of the user who added a message, and Element 6: Source of a message. Possible values are 1: SourceModeOther, 2: SourceModeLocal, 3: SourceModeExternal, 8: SourceModeCentral, 9: SourceModeTimeBasedScheduler, 10: SourceModePowerRecovery, 11: SourceModeReset, 12: SourceModeCommLoss, 13: SourceModePowerLoss, or 14: SourceModeEndDuration

Same as previous

NTCIP.DMS.GetMessage

Read-only

Retrieves any message, in which the B1 parameter is the type of memory and the B2 parameter is an index, between 1 (one) and 255. The available types of memory are 2: MemoryTypePermanent, 3: MemoryTypeChangeable, 4: MemoryTypeVolatile, 5: emoryTypeCurrentBuffer, 6: MemoryTypeSchedule, or 7: MemoryTypeBlank. This Block Tag contains 4 (four) Elements. These Elements are Element 1: Text displayed in MULTI String format, Element 2: Priority, between 1 (one) and 255, Element 3: Status. Possible values are 1: Not Used, 2: Modifying, 3: Validating, 4: Valid, 5: Error, 6: ModifyReq, 7: ValidateReq, or 8: NotUsedReq, and Element 4: Name of the user who added a message

Same as previous

NTCIP.DMS.DefineMessage

Write-only

Defines a message that later can be activated. This Block Tag contains 7 (seven) Elements. These Elements are Element 1: Type of memory. Possible values are 2: MemoryTypePermanent, 3: MemoryTypeChangeable, or 4: MemoryTypeVolatile, Element 2: Index of a message, between 1 (one) and 255, Element 3: Text displayed in MULTI String format, Element 4: Priority, between 1 (one) amd 255, Element 5: Name of the user who added a message, Element 6: Indicates whether beacons are triggered or not. Possible values are 0 (zero, does not trigger) or 1 (one, triggers), Element 7: Indicates whether the pixel service is triggered or not. Possible values are 0 (zero, does not trigger) or 1 (one, triggers)

Same as previous

NTCIP.DMS.ActivateMessage

Write-only

Activates an already existing message. This Block Tag contains 4 (four) Elements. These Elements are Element 1: Type of memory. Possible values are 2: MemoryTypePermanent, 3: MemoryTypeChangeable, or 4: MemoryTypeVolatile, Element 2: Index of a message, between 1 (one) and 255, Element 3: Priority, between 1 (one) and 255, and Element 4: Duration, in minutes (use the value 65535 for a permanent message)

Same as previous

NTCIP.DMS.LongPowerMessage

Reading or writing

Allows reading or defining a message activated after a power failure. The N1 and N2 parameters are used only when writing, in which the N1 parameter is the type of memory and the N2 parameter is an index between 1 (one) and 255. Possible values for memory types are 2: MemoryTypePermanent, 3: MemoryTypeChangeable, or 4: MemoryTypeVolatile. When writing, this Tag accepts any value to start a writing operation. When reading, this Tag returns a value in the format MMXXXXCCCC, in which MM is a type of memory with 8 (eight) bits, XXXX is the memory index with 16 bits, and CCCC is a CRC (Cyclic Redundancy Code) code of a message

Same as previous

NTCIP.DMS.CommLostMessage

Reading or writing

Allows reading or defining which message is activated after a communication failure. The N1 and N2 parameters are used only when writing, in which the N1 parameter is a type of memory and the N2 parameter is an index between 1 (one) and 255. Possible values for memory types are 2: MemoryTypePermanent, 3: MemoryTypeChangeable, or 4: MemoryTypeVolatile. When writing, this Tag accepts any value to start a writing operation. When reading, this Tag returns a value in the format MMXXXXCCCC, in which MM is a type of memory with 8 (eight) bits, XXXX is the memory index with 16 bits, and CCCC is a CRC (Cyclic Redundancy Code) code of a message

Was this page useful?