CNI RM85x User manual

RM85x Hand-
held Terminals User
Manual
H5834D0003ING
V. 01
CNI Engineering
Via Carpanelli, 24
40011 Anzola dell’Emilia (Bo) Italy
Tel. [phone]
Fax [phone]
[email protected]
www.cnicnc.com
Serial Communication
Protocols
DESCRIPTION
The RM85x family of hand-held terminals communicate with a remote controller over an EIA standard
RS-232 serial row at a baud rate of 57.6, 38.4, 19.2 or 9.6 Kb.
RM85x terminals can use two communication protocols: VT100 and CNI proprietary.

Publication Information
Code Date Approval Author ctg
H5834D0003ING 05-10-2007- - UD CNI D
Update List
Revision Added Deleted Modified
V. 01
CNI Engineering S.r.l.
No part of this manual may be reproduced or transmitted in any form or by any means, electronic or
mechanic, including photocopying, without the express written permission of CNI.

MANUAL ISSUED BY:
Technical Documentation Dept.
CNI Engineering S.r.l.
Via Carpanelli, 24 - 40011 Anzola dell’ Emilia (Bo) Italy
Tel. [phone]
Fax [phone]
[email protected]
www.cnicnc.com
Document code:
Document revision:
Document issue:
H5834D0003ING
V. 01
05-10-2007

TABLE OF CONTENTS
05-10-2007 CNI Engineering S.r.l. i
TABLE OF CONTENTS
1 Installation....................................................................................................................................... 1
2 Serial communication...................................................................................................................... 1
2.1 VT100 protocol........................................................................................................................ 1
2.2 CNI proprietary protocol .......................................................................................................... 1
2.2.1 Control characters........................................................................................................... 1
2.2.2 Packet checksum (8 bit CRC)......................................................................................... 2
2.2.3 Packet length................................................................................................................... 2
2.2.4 Node address .................................................................................................................. 2
3 VT100 protocol commands ............................................................................................................. 2
3.1 Cursor control commands ....................................................................................................... 2
3.1.1 Cursor on......................................................................................................................... 3
3.1.2 Cursor off......................................................................................................................... 3
3.1.3 Cursor home (Carriage return)........................................................................................ 3
3.1.4 Cursor down and home................................................................................................... 4
3.1.5 Cursor down with scroll ................................................................................................... 4
3.1.6 Cursor up with scroll........................................................................................................ 4
3.1.7 Cursor down without scroll .............................................................................................. 5
3.1.8 Cursor up without scroll................................................................................................... 5
3.1.9 Cursor right...................................................................................................................... 6
3.1.10 Cursor left........................................................................................................................ 6
3.1.11 Backspace....................................................................................................................... 6
3.1.12 Position cursor................................................................................................................. 7
3.1.13 Tab................................................................................................................................... 7
3.1.14 Save cursor ..................................................................................................................... 7
3.1.15 Restore cursor................................................................................................................. 8
3.2 Editor commands..................................................................................................................... 8
3.2.1 Send characters to terminal ............................................................................................ 8
3.2.2 Scroll area ..................................................................................................................... 10
3.2.3 Clear screen (Form feed) .............................................................................................. 10
3.2.4 Display fixed characters ................................................................................................ 10
3.2.5 Display blinking characters............................................................................................ 11
3.2.6 Reset character blinking................................................................................................ 11
3.2.7 Insert characters............................................................................................................ 11
3.2.8 Insert rows..................................................................................................................... 12
3.3 Character delete commands................................................................................................. 12
3.3.1 Delete n characters ....................................................................................................... 12
3.3.2 Delete to end of row ...................................................................................................... 13
3.3.3 Delete from start of row................................................................................................. 13
3.3.4 Delete row ..................................................................................................................... 13

TABLE OF CONTENTS
05-10-2007 CNI Engineering S.r.l. ii
3.3.5 Delete to end of display .................................................................................................14
3.3.6 Delete from start of display............................................................................................14
3.3.7 Delete all rows ...............................................................................................................14
3.3.8 Delete n rows.................................................................................................................15
3.4 Information request commands.............................................................................................15
3.4.1 Request firmware version..............................................................................................15
3.4.2 Request cursor position.................................................................................................16
3.4.3 Request communication parameters.............................................................................16
3.4.4 Request terminal attributes............................................................................................17
3.5 Terminal status commands....................................................................................................18
3.5.1 Reset terminal................................................................................................................18
3.5.2 Cancel escape sequence ..............................................................................................18
3.5.3 Self test..........................................................................................................................18
3.5.4 Exit VT100 protocol .......................................................................................................19
3.6 I/O commands .......................................................................................................................19
3.6.1 Switch LEDs...................................................................................................................19
3.6.2 Monitor keys...................................................................................................................20
3.6.3 Monitor knob..................................................................................................................21
3.6.4 Monitor overrides...........................................................................................................22
4 CNI proprietary protocol commands..............................................................................................23
4.1.1 Position cursor...............................................................................................................23
4.1.2 Write string.....................................................................................................................24
4.1.3 Delete rows....................................................................................................................25
4.1.4 Scroll..............................................................................................................................26
4.1.5 Read I/O command........................................................................................................27
4.1.6 Read message...............................................................................................................28
4.1.7 Read character ..............................................................................................................29
4.1.8 Read version..................................................................................................................30
4.1.9 Read type.......................................................................................................................31
4.1.10 Change parameter.........................................................................................................32
4.1.11 Read parameter.............................................................................................................33
4.1.12 Restart VT100................................................................................................................34
4.1.13 Save parameters to flash memory.................................................................................35
4.1.14 Read flash memory........................................................................................................35
4.1.15 Sample variable.............................................................................................................36
4.1.16 Sample address.............................................................................................................36
4.1.17 Read samples................................................................................................................37
A Parameters....................................................................................................................................38
B Error messages .............................................................................................................................42
C Status bits......................................................................................................................................43

Installation
05-10-2007 CNI Engineering S.r.l. iii
D Invalid command response ........................................................................................................... 43
E I/O.................................................................................................................................................. 44
E.1 The RM851 hand-held terminal............................................................................................. 44
E.1.1 Numbering of keys......................................................................................................... 44
E.1.2 Numbering of LEDs....................................................................................................... 44
E.1.3 The knob........................................................................................................................ 44
E.2 The RM850 hand held terminal............................................................................................. 45
E.2.1 Numbering of keys......................................................................................................... 45
E.2.2 Numbering of LEDs....................................................................................................... 45
E.2.3 Numbering of overrides................................................................................................. 45
F Calculating the 16 bit CRC............................................................................................................ 46
F.1 MODULE CRC16.H............................................................................................................... 46
F.2 MODULE CRC16.C............................................................................................................... 47

TABLE OF CONTENTS
05-10-2007 CNI Engineering S.r.l. iv

Installation
05-10-2007 CNI Engineering S.r.l. 1
1 Installation
Make the settings specified in the relevant User Manual – Technical Specifications and
Connections to ensure correct installation of the RM85x family of hand-held terminals.
2 Serial communication
The minimum size for a transmitted data packet size is 10 bits. These comprise
1 start bit
8 data bits
1 stop bit
Start Data Stop
0 lsb Msb 1
Packet format is as follows:
1 start bit, 8 data bits, no parity, 1 stop bit
2.1 VT100 protocol
RM85x hand-held terminals support a sub-set of commands from the standard VT100 protocol as well
as customised commands for I/O control.
VT100 protocol includes the necessary XON/XOFF communication control. The terminal has a FIFO
buffer in reception and transmission comprising 64 characters.
If the content of the reception buffer reaches more than 48 characters, the terminal sends an XOFF
character (0x13) to the master to request it to stop transmitting as quickly as possible.
Once an XOFF character has been sent and the reception buffer has dropped below 16 characters
again, the terminal sends an XON character (0x11) to tell the master that it can start transmitting
again.
In the same way the master can also send the terminal an XOFF character when so required by its
own control logic. In this case, the terminal stops transmitting as quickly as possible and waits to
receive an XON character before restarting.
For further details on VT100 protocol, visit the following site: http://vt100.net
2.2 CNI proprietary protocol
2.2.1 Control characters
RM85x hand-held terminals send the remote controller commands and data requests in packets
containing a number of characters. Each packet starts with the STX control character and ends with
the ETX control character.
Packets do not normally contain other STX or ETX characters. If STX, ETX, ESC, XON or XOFF
characters have to be transmitted, these must first be split into two characters according to the
following table.

RM85x Hand-held Terminals User Manual
2CNI Engineering S.r.l. 05-10-2007
Character to transmit Characters transmitted
STX (0x02) ESC (0x1B) 0xFF XOR STX (0xFD)
ETX (0x03) ESC (0x1B) 0xFF XOR ETX (0xFC)
ESC (0x1B) ESC (0x1B) 0xFF XOR ESC (0xE4)
XON (0x11) ESC (0x1B) 0xFF XOR XON (0xEE)
XOFF (0x13) ESC (0x1B) 0xFF XOR XOFF (0xEC)
2.2.2 Packet checksum (8 bit CRC)
Each packet also contains a checksum character (CRC), calculated as follows.
STX Datum1 … DatumN CRC ETX
CRC = 0xFF XOR Datum1 XOR … XOR DatumN
N.B.: CRC is calculated on the basis of the bytes in the packet before control characters
are added. This is because control characters must also mask the CRC.
2.2.3 Packet length
The maximum number of data characters that can be transmitted is 68. This number does not include
the control characters in the packet.
2.2.4 Node address
The second byte of each command identifies the target terminal’s node address, as configured on the
terminal’s DIP-switch. If RM85x hand-held terminals communicate over an RS232 connection, this
address must be set to 0x00 to ensure correct functioning. All the switches on the configuration DIP
must be OFF for this setting.
3 VT100 protocol commands
6 groups of VT100 protocol commands are available:
Cursor control commands
Editor commands
Character delete commands
Information request commands
Terminal status commands
I/O commands
3.1 Cursor control commands
This group of command lets you control the position and the characteristics of the cursor.
Whenever the terminal is switched on or reset, the cursor is set off and is positioned at the first column
of the first row of the display.