Appendix A: ViewMarq ASCII Command
Contents
1. 2 VEWMARG User Manual 15 Ed Rev MD USER M ED MESSAGE DISPLAY Appendix A ViewMarq ASCII Command Specifications eT ASCII String Commands The ViewMarg LED message display utilizes ASCII Strings The ASCII String contains text to be displayed and commands and parameters that determine how the text will be formatted such as the Character Set Size Color Scrolling Blinking etc The format of the text commands and parameters are described in this section The receives these ASCII strings from an external device such as a PC or a PLC through one of the serial ports or the Ethernet port External Device The is a slave device It does not request data from other devices it only receives it So when a properly formatted string is detected on one of the communication ports and the lt 10 gt of the message matches the ID of the particular display then the message in the ASCII String that follows will be displayed as formatted by the ASCII String ASCII String format In order for ViewMarg message display to understand the ASCII String it must formatted as described below One line format The one line format is the way the string is sent to the ViewMarq The order of the formatting commands does not matter so long as they precede the text or variable lt T gt STR DEC commands lt ID g2. Effects The Effect commands determine how the text will be aligned in the display and or how it will enter the display area The default is Left Justified lt LJ gt NOTE Each Window can have only one scrolling effect Format lt LJ gt Left Justify lt CJ gt Center Justify lt RJ gt Right Justify lt SL gt Scroll Left lt SL LJ gt Left and Pause for seconds Left Justified lt SL CJ gt Left and Pause for seconds Center Justified lt SL RJ gt Left and Pause for seconds Right Justified lt SR gt Scroll Right lt SR LJ gt Scroll Right and Pause for seconds Left Justified lt SR CJ gt Scroll Right and Pause for seconds Center Justified lt SR RJ gt Scroll Right and Pause for seconds Right Justified lt SU gt Scroll Up lt SU TOP gt Scroll Up and Pause for seconds Top Justified lt SU BOT gt Scroll Up and Pause for seconds Bottom Justified lt SD gt Scroll Down lt SD TOP gt Scroll Down and Pause for seconds Top Justified lt SD BOT gt Scroll Down and Pause for seconds Bottom Justified Required No Default lt LJ gt Usage gt lt CLR gt lt LJ gt lt T gt Message to Display lt T gt CR LED MESSAGE DISPLAY A 14 VIEWMARG User Manual 1st Ed Rev MD USER M Appendix A ViewMarq ASCII Command Specifications Example Display the text Hello Center Justified on line 1 and the text World scrolling left
3. ViewMaro ASCII COMMAND SPECIFICATIONS PENDIX In This Appendix ViewMarg COMMANGS 2 ASCII String Commands A 3 ASCI SUING TOMAC ir E RS A 3 COMMANA E ANE E A 5 Empedacd Variables 42 4424 6240205006 64 Cia ee E EEEE A 16 Commands eens oe dean 18 Display Commands 2 eens be A 19 Display Commands 3444085000049 Se 20 Appendix A ASCII Command Specifications eee ViewMarq Commands ViewMarg Commands eID gt Specifies the SystemID of the displays that should process the command always first command in a command string lt CLR gt Clear display Text Display Cause information to be displayed lt T gt Text lt T gt Put Text on the display at the current position lt STR N L gt Put String Variable N on the display L characters wide Put Numeric Variable N on the display using L digits with implied decimal place DP digits lt DEC N L DP gt with leading spaces Put Numeric Variable N on the display using L digits with implied decimal place DP digits lt DECZ N L DP gt with leading zeros Text Parameters Changes the way Text is displayed lt WIN oy sx sy gt window position and size lt POS x y gt Set Position to X Y from Upper Le
4. lt ID gt lt CLR gt CR Example 1 To clear a single display designate a single panel with the ID command lt ID 1 gt lt CLR gt Example 2 To clear all signs use the ID broadcast lt ID gt lt gt NOTE If the CLR command is not used the display buffer will eventually fill and no new message will be displayed If Display Syntax Error is enabled a syntax error E6 will be displayed Text T The Text commands are used to define the text for the string Everything between the begin text and end text commands will be displayed on the message display Format Begin Text lt T gt End Text lt T gt Required Yes Usage lt ID gt lt T gt Message to Display lt T gt CR Example 1 Display the text Hello World on 1 x 12 character display lt ID 1 gt lt CLR gt lt T gt Hello World lt T gt Attention lt T gt is a display command There is a maximum of 31 display commands that can be used on the ViewMarg display at one time More than 31 display commands will result in an error E6 Additional display commands are listed on Page A 19 LED MESSAGE DISPLAY A 6 VIEWMARG User Manual 1st Ed Rev MD USER M Appendix A ViewMarq ASCII Command Specifications eT Window WIN The WIN command defines the display area of the text blocks that follow The WIN command may be used to create multiple display areas on the message display The Window corners are designated in pixels or
5. 987 lt SETV 1 987 gt NOTE The display format options such as color or character set for variables is set in the static text string where the lt DEC gt and lt STR gt commands are used that is color or character set commands do not work with lt SETS gt or lt SETV gt commands LED MESSAGE DISPLAY VIEWMARG User Manual 1st Ed Rev MD USER M A 17 Appendix A ASCII Command Specifications ee Advanced Commands Maintenance MTN The Maintenance Command is used to test the LEDs on the display The four different commands give you the ability to run four different test patterns Format lt ID gt lt MTN N gt CR 0 Display Test Green 1 Display Test Red 2 Display Test Amber 3 Advanced Test Pattern Turn off by using the CLR command Advanced format gt lt MTN X Y SizeX SizeY gt Display test in a portion of the display starting at X Y SizeX wide and SizeY High Error If an invalid option is selected the Command Status Invalid Option must be 0 3 will be returned Serial Diagnostics DIAG Format lt ID gt lt DIAG N gt CR If N is 1 it will toggle the lower left LED each time a string it received as an ASCII command via Serial or Modbus LED MESSAGE DISPLAY A 18 VIEWMARG User Manual 1st Ed Rev MD USER M Appendix A ViewMarq ASCII Command Specifications Display Commands The following commands do not display text messages designed
6. LED s In the example below of a 2 x 12 character display OX 0 OY 0 EX 71 EY 15 0 71 0 0 15 71 15 Format lt WIN OY EX EY gt Required No Default lt WIN 0 0 X Y gt X and Y are the extreme End of Line and Bottom of the display respectively When EX and EY are set to 31 and 287 respectively the display will use the extreme far right edge and bottom respectively In this way a string meant to cover the entire display will work with any size message display without changing the string Usage lt ID gt lt WIN OX OY EX EY gt lt POS X Y gt lt T gt Message to Display lt T gt CR LED MESSAGE DISPLAY VIEWMARG User Manual Ist Ed Rev B MD USER M 7 Appendix A ASCII Command Specifications Ss Single Window Example 1 Display the text Hello World in a Window that covers the entire display area Note that because the EX and EY are set to extreme values this will work with any size message display lt ID 1 gt lt CLR gt lt WIN 0 0 287 31 gt lt POS 0 0 gt lt LJ gt lt BL N gt lt CS 0 gt lt GRN gt lt T gt Hello World lt T gt 0 71 0 0 15 71 15 Window for each line Example 2 Display the text Line One on Line 1 Scrolling Right and the text Line Two on Line 2 Scrolling Left This is accomplished in the ViewMarq Software NOTE A window may contain only one scrolling Effect Scroll Left lt SL gt S
7. by the user on the display They display other information on the display that may be helpful to the user Version Display VER Format lt VER gt Usage gt lt CLR gt lt VER gt CR Display the Firmware Version String on the display Display Name NAME Format lt NAME gt Usage lt ID gt lt CLR gt lt NAME gt CR Display the Display Name String on the display The display name is set using the ViewMarg Software IP Address IPADDR Format lt IPADDR gt Usage lt ID gt lt CLR gt lt IPADDR gt CR This will display the current IP Address of the display or Acquiring IP if DHCP is actively attempting to obtain an IP address NO LINK if no network cable is inserted Port Parameters PORTPAR Format lt PORTPAR gt 1 RS232 Port 2 RS485 Port Display the serial port parameters for port 1 RS232 or port 2 RS485 Usage gt lt CLR gt lt PORTPAR gt CR The displayed string will be in the form 38400 8N1 for 38 4k baud 8 bits no parity and 1 stop bit Example 1 Display the Version Display Name IP Address and both Serial Ports Parameters all Scrolling Slow across the display lt ID gt lt CLR gt lt SL gt lt S S gt lt VER gt lt NAME gt lt IPADDR gt lt PORTPAR 1 gt lt PORTPAR 2 gt Attention There is a maximum of 31 display commands that be used the ViewMarg display one time More than 31 display commands will result in an error E6 lt
8. on line 2 pausing center justified for 5 seconds on a 2 line x 12 character display lt ID 1 gt lt CLR gt lt WIN 0 0 287 7 gt lt POS 0 0 gt lt CJ gt lt BL N gt lt CS 0 gt A lt GRN gt lt T gt Hello lt T gt lt WIN 8 287 31 gt lt POS 0 8 gt lt SL CJ 5 gt lt S S gt lt BL N gt lt CS 0 gt lt GRN gt lt T gt World lt T gt Notice the two Windows to support the two different effects Pause There is no specific Pause command It is an implied command when a Justification command is added to a Scroll Command Along with the Justification Command is a time to pause in seconds Specifying 0 will cause the scroll to pause indefinitely LJ CJ and RJ are used with the Scroll Left and Scroll Right Commands TOP and BOT are used with the Scroll Up and Scroll Down Commands Format lt SL LJ gt Usage gt lt CLR gt lt SU TOP 5 gt lt T gt Message to Display lt T gt CR Scroll Speed lt S gt The Scroll Speed command is used in conjunction with the Scroll commands The default speed is Medium 5 Slow M Medium default Fast Format lt S gt Usage gt lt CLR gt lt SL gt lt S gt lt T gt Message to Display lt T gt CR NOTE Only one scroll speed is effective on the display at one time It is not possible to have two windows scrolling at two different speeds The last lt S gt command received by the display will be the speed that is used LED MESSAGE DISPLAY VIEWMARG User M
9. that is color or character set commands do not work with lt SETS gt or lt SETV gt commands LED MESSAGE DISPLAY A 16 VIEWMARG User Manual 1st Ed Rev MD USER M Appendix A ViewMarq ASCII Command Specifications l Decimal Variables DEC and DECZ The DEC and DECZ commands are used to display a decimal variable that is easily updated A with the SETV command The Decimal variable has three parameters Decimal Number Decimal Length and Decimal Place DEC Format with Leading Spaces A 4 digit variable with 2 decimal places that is set to zero will be displayed as 0 00 Format with Leading Zeros A 4 digit variable with 2 decimal places that is set to zero will be displayed as 00 00 There can be up to 32 variables of 16 digits each Format lt DEC N L DP gt lt DECZ N L DP gt N String Number 1 32 L Number of Digits to Display 1 11 DP Decimal Place 0 10 Usage gt lt CLR gt lt T gt Message to Display lt T gt lt DEC N L DP gt CR Set String SETV The SETV command is used to set the value of a Decimal variable Format lt SETV N decimals gt N Decimal Number Example 1 Display the text Temp C followed by the value of Decimal 1 Reserve 4 characters for Decimal 1 with an implied decimal place of 1 lt 1 gt lt CLR gt lt T gt Temp C lt T gt lt DEC 1 4 15 Set Decimal 1 5678 lt SETV 1 5678 gt Set Decimal 1 to
10. MD USER M 11 Appendix A ASCII Command Specifications eee Character Set CS The Character Set command is used to select any of 11 character sets that are loaded in the display The default character sets loaded are all English in each size as shown below 2 inch 1 line 2 inch 1 line Full Line 1 1 4 inch Compact 4 inch 2 line Narrow 4 inch 2 line 4 inch 2 line Full Line 6 inch 3 line Narrow 6 inch 3 line 8 inch Narrow 8 inch 4 line 8 inch 4 line Full Line 1 amp amp GC P SS Format lt CS gt Required No Default lt CS 0 gt Usage gt lt CLR gt lt CS gt lt T gt Message to Display lt T gt CR The Character Set is retentive within one ID command across multiple Text Blocks until changed In order to have a different font used within the same string it must be specified Example Display the text Hello World in two different fonts on a 2 line x 12 character display lt ID 1 gt lt CLR gt lt CS_3 gt lt T gt Hello lt T gt lt CS_0 gt lt T gt World lt T gt 12 VEWMARG User Manual 1st Ed Rev B MD USER M LED MESSAGE DISPLAY Appendix A ViewMarq ASCII Command Specifications eT Color The Color command is used to select one of three colors for the text to be displayed The default color is green Format lt GRN gt lt RED gt lt AMB gt Required No D
11. T gt is also a display command LED MESSAGE DISPLAY VIEWMARG User Manual 1st Ed Rev MD USER M 19 Appendix A ASCII Command Specifications ee Non Display Commands The following commands do not cause any text to be displayed on the message display They cause data to be transmitted out the serial port on which they were received Command Status lt STATUS gt Format lt STATUS gt If issued via a serial port the reply will be the reply that was generated due to the previous command that was processed This can be used at any time but most likely to be used after a command is sent to many displays to make sure it was received correctly The reply on the Serial Port will be NULL or NO MESSAGE if the Command Status buffer is empty or the Command Status will be sent etc Firmware Version lt VERSION gt Format lt VERSION gt This command will cause the current Version String to be sent out on the serial port if the request came in on the serial port LED MESSAGE DISPLAY 20 VIEWMARG User Manual 1st Ed Rev MD USER M
12. anual 1st Ed Rev MD USER M 15 Appendix A ASCII Command Specifications eee Embedded Variables Embedded variables are used to update data on the display without having to send an entire message wo different variables are available the String variable and the Numeric variable The Variable values are volatile and are cleared when the display is powered off String Variables STR The STR command is used to display a string variable that is easily updated with the SETS command The String variable has two parameters String Number and Length There can be up to 16 strings of up to 100 characters each Format lt STR N L gt N String Number L Field Length in characters Left Justified Usage gt lt CLR gt lt T gt Message to Display lt T gt lt STR N L gt CR Set String SETS The SETS command is used to set the value of a String variable Format lt SETS N gt string lt SETS gt N String Number Example 1 Display the text Hello followed by the value of String 1 Reserve 12 characters for String 1 lt ID 1 gt lt CLR gt lt T gt Hello lt T gt lt STR 1 12 gt Set String 1 to World lt SETS 1 gt World lt SETS gt Set String 1 to Dolly lt SETS 1 gt Dolly lt SETS gt NOTE The display format options such as color or character set for variables is set in the static text string where the lt DEC gt and lt STR gt commands are used
13. cifications eee Position POS The Position command is used to assign the starting point of the Text Block on the display The position is designated in pixels or LED s Below is an example of the LED positions on a 1 x 12 character display O O 9 07 71 7 The default position if XY is not specified is 0 0 Notice this is the physical upper left corner of the display Also characters are anchored at their upper left corner Format lt POS X Y gt Required No Default 5 0 05 Usage gt lt POS X Y gt lt T gt Message to Display lt T gt CR Example 1 Display the text Hello World 12 pixels to the right of 0 on a 1 x 12 character display lt 10 1 gt lt gt lt 12 0 gt lt T gt Hello World lt T gt Example 2 Display the text Hello World 12 pixels to the right of 0 and 4 pixels down from 0 a2 x 12 character display lt ID 1 gt lt CLR gt lt POS 12 4 gt lt T gt Hello World lt T gt Negative XY values The X and Y values may be negative in order to position a text block off the edge of the display This would be handy when used with scrolling text Example Display the text Hello World 2 pixels up from 0 on a 1 x 12 character display lt 10 1 gt lt CLR gt lt POS_ 0 2 gt lt T gt Hello World lt T gt LED MESSAGE DISPLAY A 10 VIEWMARG User Manual 1st Ed Rev MD USER M Appendix A ViewMarq ASCII Command Specifications CT Multip
14. croll Right lt SR gt Scroll Up lt SU gt Scroll Down lt SD gt To have two different effects for the two different lines they must reside in two different Windows lt ID 1 gt lt CLR gt lt WIN_O 0 287 7 gt lt 0 0 gt lt SR gt lt S S gt lt BL N gt lt CS 0 gt lt GRN gt lt T gt Line One lt T gt lt WIN 0 8 287 15 gt lt POS 0 8 gt lt SL gt lt S S gt lt BL N gt lt CS 0 gt lt GRN gt lt T gt Line Two lt T gt 71 0 71 15 A 8 VIEWMARG User Manual 1st Ed Rev MD USER M Appendix A ViewMarq ASCII Command Specifications Windows side by side Example 3 Display the text Right Scrolling Right in a display window that covers the left A half of the display and the text Left Scrolling Left in a display window that covers the right half of the display NOTE A window may contain only one scrolling Effect i e Scroll Left lt SL gt Scroll Right lt SR gt B Scroll Up lt SU gt Scroll Down lt SD gt have two different effects for the two different lines they must reside in two different Windows lt ID 1 gt lt CLR gt lt WIN 0 0 35 31 gt lt POS 0 0 gt lt SR gt lt S S gt lt BL N gt lt CS 3 gt lt GRN gt lt T gt Right lt T gt lt WIN 36 0 287 31 gt lt POS 32 0 gt lt SL gt lt S S gt lt BL N gt lt CS 3 gt lt GRN gt lt T gt Left lt T gt VIEWMARG User Manual 1st Ed Rev MD USER 9 Appendix A ASCII Command Spe
15. d is used to identify the display that the ASCII string is targeting If the string is received by a display that has an ID different from what is in the ID command that display will ignore the string until it another ID command Multiple displays may be specified by listing multiple ID s Format gt lt ID gt Required Yes Usage gt lt T gt Message to Display lt T gt CR Single Display Example Send Hello World to Display with ID 1 lt ID_1 gt lt CLR gt lt T gt Hello World lt T gt Multiple Displays Example Send Hello World to displays with ID 1 3 8 9 10 NOTE The ID numbers be in any order lt 1 1 3 8 9 10 gt lt CLR gt lt T gt Hello World lt T gt Or send Hello World to a range of displays 1 through 10 NOTE Ascending order only lt ID 1 10 gt lt CLR gt lt T gt Hello World lt T gt Broadcast to all displays Example Send Hello World to all displays on the network use ID 0 lt ID_0 gt lt CLR gt lt T gt Hello World lt T gt NOTE This is only useful using the ASCII protocol over RS 485 LED MESSAGE DISPLAY VIEWMARG User Manual 1st Ed Rev MD USER M 5 Appendix A ASCII Command Specifications Ss Clear CLR A It is good practice to clear the display first to prevent overlapping text The Clear command is used to clear an entire display Format lt CLR gt Required No Usage
16. efault lt GRN gt Usage gt lt CLR gt lt RED gt lt T gt Message to Display lt T gt CR The Color is retentive within one ID command across multiple Text Blocks until changed In order to have a different color used within the same string it must be specified Example Display the text Hello World in two colors on a 1 x 12 character display lt ID 1 gt lt CLR gt lt RED gt lt T gt Hello lt T gt lt GRN gt lt T gt World lt T gt Blink BL The Blink command can be used to attract attention to the displayed message It is used to cause the text to blink or not and also to select the rate at which it blinks The default is None N None 5 Blink Slow M Blink Medium Blink Fast Format lt BL gt Required No Default lt BL N gt Usage gt lt CLR gt lt BL gt lt T gt Message to Display lt T gt CR Like Font and Color Blink is retentive within one ID command across multiple Text Blocks until changed In order to have a portion of the text blinking and the following text not the Blink must be turned off Example Display the text Hello World with Hello blinking slow and World not blinking on a 1 x 12 character display lt ID 1 gt lt CLR gt lt BL S gt lt T gt Hello lt T gt lt BL N gt lt T gt World lt T gt LED MESSAGE DISPLAY VIEWMARG User Manual 1st Ed Rev MD USER M 13 Appendix A ASCII Command Specifications
17. ft Corner of display lt OFF x y gt Set Position to X Y from Upper Left Corner of window lt CS n gt Select Character Set n 0 9 lt GRN gt Set color to Green lt RED gt Set color to Red lt AMB gt Set color to Amber lt BL x gt Blink Rate x S Slow M Medium F Fast N None lt S X gt Scroll Speed S Slow M Medium F Fast lt LJ gt Text Effect Left Justify lt CJ gt Text Effect Center Justify lt RJ gt Text Effect Right Justify lt SL gt Text Effect Scroll Left lt SR gt Text Effect Scroll Right lt SU gt Text Effect Scroll Up lt SD gt Text Effect Scroll Down lt SE PP n gt SE Scroll Direction PP Pause Position n Pause time Example lt SL LJ 1 gt Scroll Left and Pause Left Justified for 1 sec Variable Update lt SETS n gt value lt SETS gt Set String Variable N to value lt SETV n value gt Set Numeric Variable N to value Advanced Commands lt VER gt Put FirmwareVersion on display at current position lt NAME gt Put Display Name on display at current position lt IPADDR gt Put Ethernet Port IP Address on display at current position lt PORTPAR n gt Put Serial Port Paramters for Port n on display at current position lt STATUS gt Return the status of the last command executed on the current Port lt VERSION gt Return current Version String on the current Port lt n gt Used to Test LEDs n 0 Green 1 Red 2 Amber 3 Pattern
18. le POS commands Multiple POS commands within a ID block are used to make multiline messages Example 1 Display the two lines of text Hello and World 2 12 character display 1 gt lt CLR gt lt POS 0 0 gt lt T gt Hello lt T gt lt POS 0 8 gt lt T gt World lt T gt Or lt 10 1 gt lt CLR gt lt T gt Hello lt T gt lt POS_ 0 8 gt lt T gt World lt T gt Example 2 Display the two lines of text Hello and World a 1 x 12 character display 1 gt lt CLR gt lt POS 0 0 gt lt T gt Hello lt T gt lt POS 36 0 gt lt T gt World lt T gt Offset OFF The Offset command is very similar to the Position command It is the relative starting point of the Text Block in a Window designated by the WIN command The upper left corner of the window serves as the origin instead of the upper left corner of the physical display The offset is designated in pixels or LED s The default position if XY is not specified is 0 0 Format lt OFF X Y gt Required No Default lt OFF 0 05 Usage lt ID gt lt WIN 0 0 71 31 gt lt X Y gt lt T gt Message to Display lt T gt CR Example Display the text Hello World on a 2 x 12 character display in window 2 3 71 31 with an offset of 2 2 The text is positioned at 4 5 2 2 3 2 lt ID 1 gt lt CLR gt lt WIN 2 3 71 31 gt lt 2 2 gt lt T gt Hello World lt T gt LED MESSAGE DISPLAY VIEWMARG User Manual 1st Ed Rev
19. t lt CLR gt lt WIN OX OY EX EY gt lt POS X Y gt lt LJ gt lt BL gt lt CS gt lt GRN gt lt T gt Message to Display lt T gt CRBreakdown lt ID gt Display ID lt CLR gt Clear Display lt WIN OX OY EX EY gt Display Window lt POS X Y gt Position lt LJ gt Effect lt BL gt Blink speed lt gt Character Set lt GRN gt Color lt T gt Message to Display lt T gt Text Block CR 0x0D Carriage Return LED MESSAGE DISPLAY VIEWMARG User Manual 1st Ed Rev MD USER M 3 Appendix A ASCII Command Specifications Ss Defaults Each command or parameter has an implied default Every String must have at least the lt ID gt and text lt T gt lt T gt or set variable lt gt lt SETS gt commands There is no default for lt CLR gt Window lt WIN 00 287 31 gt Position lt POS 0 05 Effect lt LJ gt Blink lt BL N gt Character Set lt CS 05 Color lt GRN gt Short Format with implied defaults The two command strings below will display the same message lt ID gt lt CLR gt lt WIN 0 0 287 31 gt lt POS 0 0 gt lt LJ gt lt BL N gt lt CS O0 gt lt GRN gt lt T gt Message to Display lt T gt lt ID gt lt CLR gt lt T gt Message to Display lt T gt LED MESSAGE DISPLAY A 4 VIEWMARQ User Manual 1st Ed Rev MD USER M Appendix A ViewMarq ASCII Command Specifications eT Basic Commands Module ID ID The Module ID comman
Download Pdf Manuals
Related Search