# README
godms
🚧 Godms 🚀 Under construction... 🚧
About  |  Features  |  Starting  |  License  |  Author
About
GoDMS is a libary fully written in Go. It is written following NTCIP1203 version-v03 (https://www.ntcip.org/file/2018/11/NTCIP1203v03f.pdf) logical interface. It provides the standardized dialogs that fulfill various requirements.
Features
GoDMS has the Following functions for NTCIP-DMS Diaglogs.
- Calculating the Checksum Value
Managing the DMS Configuration
- Retrieving a Font Definition
- Configuring a Font
- Validating a Font
- Retrieving a Graphic Definition
- Storing a Graphic Definition
- Deleting a Graphic
- Validating a Graphic
- Configuring Light Output Algorithm
Controlling the DMS
- Activating a Message
- Defining a Message
- Retrieving a Message
- Manually Controlling Sign Brightness
- Manage the Exercise of Pixels
- Activating a Message with Status
Monitoring the Status of the DMS
- Executing Lamp Testing
- Activating Pixel Testing
- Executing Climate-Control Equipment Testing
- Monitoring Power Error Details
- Monitoring Lamp Error Details
- Monitoring Pixel Error Details
- Monitoring Light Sensor Error Details
- Monitoring Message Activation Error Details
- Monitoring Climate-Control System Error Details
- Monitoring Sign Housing Humidity
- Monitoring Control Cabinet Humidity
- Monitoring Drum Sign Rotor Error Details
- Monitoring Attached Devices
- Monitoring the Current Message
- Monitoring Dynamic Field Values
Starting
go get github.com/jacobleehei/godms
Made with :heart: by Jacob Lee
Â
# Packages
No description provided by the author
# Functions
Simple function for formatting the result to human readable format.
No description provided by the author
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
Note: Version 1 Compatibility: Version 1 of this standard defined the bits as ON (foreground color) or OFF (background color).
Indicates the binary value associated with this character of this font.
Indicates the width of this character in pixels.
Indicates the color of the background shown on the sign for the 'colorClassic' scheme (see the dmsColorScheme object).
Indicates the color of the background shown on the sign if not changed by the ‘Page Background Color’ MULTI tag or the ‘Color Rectangle’ MULTI tag.
Indicates the value of defaultBackgroundRGB at activation of the currently active message for the purpose of determining what the value was at the time of activation.
Indicates the default number of bits used to define a single character in a MULTI string.
Indicates the default flash off time, in tenths of a second, for flashing text.
Indicates the value of defaultFlashOff at activation of the currently active message for the purpose of determining what the value was at the time of activation.
Indicates the default flash on time, in tenths of a second, for flashing text.
Indicates the value of defaultFlashOn at activation of the currently active message for the purpose of determining what the value was at the time of activation.
Indicates the default font number (fontNumber-object) for a message.
Indicates the value of defaultFont at activation of the currently active message for the purpose of determining what the value was at the time of activation.
Indicates the color of the foreground (the actual text) shown on the sign for the 'colorClassic' scheme (see the dmsColorScheme object).
Indicates the color of the foreground shown on the sign unless changed by the ‘Color Foreground’ MULTI tag.
Indicates the value of defaultForegroundRGB at activation of the currently active message for the purpose of determining what the value was at the time of activation.
Indicates the default line justification for a message.
Indicates the value of defaultJustificationLine at activation of the currently active message for the purpose of determining what the value was at the time of activation.
Indicates the default page justification for a message.
Indicates the value of defaultJustificationPage at activation of the currently active message for the purpose of determining what the value was at the time of activation.
Indicates the default page off time, in tenths (1/10) of a second.
Indicates the value of defaultPageOffTime at activation of the currently active message for the purpose of determining what the value was at the time of activation.
Indicates the default page on time, in tenths (1/10) of a second.
Indicates the value of defaultPageOnTime at activation of the currently active message for the purpose of determining what the value was at the time of activation.
Indicates the MessageActivationCode that resulted in the current value of the dmsActivateMsgError object.
A 'criticalTemperature' alarm shall have no effect on the 'activation' of a message, it will only affect the display of the active message.
With a slow activation sign there are two opportunities to detect an error.
A 'criticalTemperature' alarm shall have no effect on the 'activation' of a message, it only effects the display of the active message.
Indicates the configuration of the type, numbers and flashing patterns of beacons on a sign.
Indicates the color scheme supported by the DMS.
Indicates the message that shall be activated when the time since the last communications from a management station exceeds the dmsTimeCommLoss time (see dmsActivateMessage).
A value indicating the mode that is currently controlling the sign.
If the end duration message does not activate because this object is an invalid value, the sign shall blank with the default value of this object.
Indicates the number of bytes available within non-volatile, changeable memory.
Indicates the number of bytes available within volatile, changeable memory.
Indicates the minimum border distance, in millimeters, that exists on the left and right sides of the sign.
Indicates the current Brightness Level of the device, ranging from 0 (OFF) to the maximum value given by the dmsIllumNumBrightLevels- object (Brightest).
If the sign does not support photocell and the dmsIllumControl object value is set to 'manualIndexed', then the values for the 'photocellLevelDown' and 'photocellLevelUp' still need to be entered that the table does not cause any errors as defined in the dmsIllumBrightnessValuesError object.
Indicates the error encountered when the brightness table was SET.
No description provided by the author
Indicates the current physical light output value ranging from 0 (darkest) to 65535 (maximum output).
Indicates the desired value of the Brightness Level as a value ranging from 0 to the value of the dmsIllumNumBrightLevels-object when under manual control.
Indicates the maximum value given by the dmsIllumPhotocellLevelStatus-object.
Indicates the number of individually selectable Brightness Levels supported by the device, excluding the OFF level (=value of zero [0]).
Indicates the level of Ambient Light as a value ranging from 0 (darkest) to the value of dmsIllumMaxPhotocellLevel object (brightest), based on the photocell detection.
Indicates if a Legend is shown on the sign.
Indicates the message that shall be activated after a power recovery following a long power loss affecting the device (see dmsActivateMessage).
Indicates the maximum number of Messages that the sign can store in non-volatile, changeable memory.
Indicates the maximum number of bytes allowed within the dmsMessageMultiString.
Indicates the maximum number of pages allowed in the dmsMessageMultiString.
Indicates the maximum number of Messages that the sign can store in volatile, changeable memory.
clearVolatileMessages (4): the controller shall set dmsMessageStatus for all volatile messages to notUsed (1), and release all memory associated with volatile messages.
Indicates if connected beacon(s) are to be activated when the associated message is displayed.
Indicates the CRC-16 (polynomial defined in ISO/IEC 3309) value created using the values of the dmsMessageMultiString (MULTI-Message), the dmsMessageBeacon, and the dmsMessagePixelService objects in the order listed, not including the OER type or length fields.
The definitions of the enumerated values are: other - any other type of memory type that is not listed within one of the values below, refer to device manual; permanent - non-volatile and non-changeable; changeable - non-volatile and changeable; volatile - volatile and changeable; currentBuffer - contains the information regarding the currently displayed message (basically a copy of the message table row contents of the message that was successfully activated).
Contains the message written in MULTI-language as defined in Section 6 and as subranged by the restrictions defined by dmsMaxMultiStringLength and dmsSupportedMultiTags.
Enumerated listing of row entries within the value of the primary index to this table (dmsMessageMemoryType -object).
Indicates the owner or author of this row.
Indicates whether pixel service shall be enabled (1) or disabled (0) while this message is active.
Indicates the run time priority assigned to a particular message.
No description provided by the author
A SET operation on this object shall allow a Central Computer to extend or shorten the duration of the message.
A copy of the source-address field from the dmsActivateMessage-object used to activate the current message.
Indicates the source that initiated the currently displayed message.
Identifies the message number used to generate the currently displayed message.
Indicates vendor-specified error message descriptions.
This is an error code used to identify the first detected syntax error within the MULTI message.
This is the offset from the first character (e.g.
Indicates the current number of valid Messages stored in non-volatile, changeable memory.
Indicates the current number of Messages stored in non-volatile, non-changeable memory (e.g., EPROM).
Indicates the current number of valid Messages stored in volatile, changeable memory.
Note: Not all technologies support the means to display a message while the power is off.
Indicates the message that shall be activated after a Reset (either software or hardware) of the device (see dmsActivateMessage).
Indicates the time, in seconds, from the start of power loss to the threshold where a short power loss becomes a long power loss.
Indicates the message that shall be activated after a power recovery following a short power loss affecting the device (see dmsActivateMessage).
Indicates the access method to the sign.
Indicates the sign height in millimeters including the border (dmsVerticalBorder).
Indicates the utilized technology in a bitmap format (Hybrids will have to set the bits for all technologies that the sign utilizes).
Indicates the type of sign.
Indicates the sign width in millimeters including the border (dmsHorizontalBorder).
An indication of the MULTI Tags supported by the device.
A software interface to initiate a controller reset.
The countdown timer associated with this parameter shall be suspended while the sign control parameter has a value of 'local (2)', e.g., the sign is in local control.
This is an error code used to identify why a message was not validated.
Indicates the minimum border distance, in millimeters, that exists on the top and bottom of the sign.
Indicates the default horizontal spacing (in pixels) between each of the characters within the font.
No description provided by the author
Indicates the height of the font in pixels.
Indicates the row number of the entry.
Indicates the default vertical spacing (in pixels) between each of the lines within the font for Full Matrix VMS.
An indication of the maximum size, in bytes, that the DMS supports for each character's characterBitmap object.
Indicates the name of the font.
A unique, user-specified number for a particular font which can be different from the value of the fontIndex-object.
This object defines a state machine allowing to manage fonts stored within a DMS.
011110 110011 110011 111111 110011 110011 110011.
No description provided by the author
Indicates the maximum number of rows in the character table that can exist for any given font.
No description provided by the author
Indicates the color supported by a monochrome sign.
No description provided by the author
Indicates the maximum number of fonts that the sign can store.
A bitmap of summary errors.
*******************************************************************
Sign Configuration and Capability Objects
dmsSignCfg OBJECT IDENTIFIER ::= { dms 1 }
-- This node is an identifier used to group all objects for DMS sign
-- configurations that are common to all DMS devices.
No description provided by the author
Indicates the height of a single character in Pixels.
Indicates the width of a single character in Pixels.
No description provided by the author
Indicates the horizontal distance from the center of one pixel to the center of the neighboring pixel in millimeters.
Indicates the number of seconds to perform pixel service on an entire sign.
Indicates the pixel service cycle time (period) in minutes.
Indicates the base time at which the first pixel service shall occur.
Indicates the number of rows of pixels for the entire sign.
Indicates the number of columns of pixels for the entire sign.
Indicates the vertical distance from the center of one pixel to the center of the neighboring pixel in millimeters.