| Download: |  |
| Mirror Download [FCC.gov] | |
| Document ID | 773122 |
| Application ID | oIFYJDGlEvIWS2b9f1hVYw== |
| Document Description | USERS MANUAL |
| Short Term Confidential | No |
| Permanent Confidential | No |
| Supercede | No |
| Document Type | User Manual |
| Display Format | Adobe Acrobat PDF - pdf |
| Filesize | 16.13kB (201587 bits) |
| Date Submitted | 2007-03-27 00:00:00 |
| Date Available | 2007-03-28 00:00:00 |
| Creation Date | 0000-00-00 00:00:00 |
| Producing Software | GNU Ghostscript 7.05 |
| Document Lastmod | 2007-03-22 14:45:46 |
| Document Title | Microsoft Word - SCCPS_3_30_00.doc |
| Document Creator | PScript5.dll Version 5.2.2 |
| Document Author: | collinl |
SmartCoupler Communication Protocol Specification
Version: 3.30.00
Save date February 8, 2007
Colder Products Company
1001 Westgate Drive
Saint Paul, Minnesota 55114
USA
Phone: 651-645-0091
Fax: 651-645-5404
www.colder.com
Company Confidential
FCC Notice: Any change or modification not expressly approved by the manufacturer could void the
users authority to operate this equipment. This device complies with part 15 of the FCC Rules.
Operation is subject to the following two conditions: (1) This device may not cause harmful
interference, and (2) this device must accept any interference received, including interference that
may cause undesired operation.
Company Confidential
Colder Products Company
1.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
Table of Contents
1.
2.
3.
4.
5.
6.
Table of Contents............................................................................................................................. 3
List of Tables .................................................................................................................................... 4
Introduction ...................................................................................................................................... 5
Scope ............................................................................................................................................... 5
System Functionality ........................................................................................................................ 5
Tag Format....................................................................................................................................... 6
6.1. Philips I-Code Tag Format......................................................................................................... 6
6.2. ISO 15693 Tag Format.............................................................................................................. 7
7. Communicating with the SmartCoupler ........................................................................................... 8
7.1. ASCII Character Set .................................................................................................................. 8
7.2. ASCII Command Format ........................................................................................................... 9
7.3. ASCII Command and Reply Sequence ................................................................................... 10
7.4. ASCII Command and Response Set ....................................................................................... 10
7.5. ASCII Parameter Set ............................................................................................................... 11
7.6. ASCII Parameters, Commands and Responses ..................................................................... 11
7.6.1.
A: Address .................................................................................................................. 11
7.6.2.
B?: Return Baud ......................................................................................................... 11
7.6.3.
BR: Baud .................................................................................................................... 12
7.6.4.
D: Data........................................................................................................................ 12
7.6.5.
ER: Error Response ................................................................................................... 13
7.6.6.
L: Length..................................................................................................................... 13
7.6.7.
M?: Read Back Modes ............................................................................................... 14
7.6.8.
MA: Multidrop Address ............................................................................................... 14
7.6.9.
MD: Mode ................................................................................................................... 15
7.6.10. PU: Power Up ............................................................................................................. 15
7.6.11. R?: Returns Continuous Read Period ........................................................................ 16
7.6.12. RD: Read Data from Tag............................................................................................ 16
7.6.13. RE: Read EEPROM ................................................................................................... 17
7.6.14. RP: Send Acknowledge.............................................................................................. 17
7.6.15. RS: Reset SmartCoupler ............................................................................................ 17
7.6.16. RT: Continuous Read Rate ........................................................................................ 18
7.6.17. SN: Get Tag Serial Number........................................................................................ 18
7.6.18. SR: Return Software Revision.................................................................................... 19
7.6.19. ST: Get SmartCoupler Serial Number........................................................................ 19
7.6.20. TI: Tag Info ................................................................................................................. 20
7.6.21. W?: Tag Write Protection ........................................................................................... 20
7.6.22. WE: Write EEPROM................................................................................................... 20
7.6.23. WK: Write Key ............................................................................................................ 21
7.6.24. WP: Set Tag Write Protection .................................................................................... 21
7.6.25. WR: Write Data to Tag ............................................................................................... 22
7.6.26. WV: Write and Verify Data to Tag .............................................................................. 22
7.7. Other ASCII Commands, Parameters & Responses............................................................... 22
8. Operating Modes............................................................................................................................ 23
8.1. Continuous Mode .................................................................................................................... 26
8.2. ASCII Mode ............................................................................................................................. 27
8.3. Interlock Mode ......................................................................................................................... 27
8.4. Sleep Inhibit Mode ................................................................................................................... 28
8.5. I-Code Protocol Mode.............................................................................................................. 28
8.6. ISO15693 Protocol Mode ........................................................................................................ 28
8.7. Quiet Mode .............................................................................................................................. 29
8.8. No Logging Mode .................................................................................................................... 29
8.9. I-Code Compatibility Mode ...................................................................................................... 30
8.10. Multidrop Addressing Mode..................................................................................................... 31
SCCPSM.doc
Company Confidential
Page 3 of 36
Colder Products Company
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
9. Revision History ............................................................................................................................. 32
10. Appendices .................................................................................................................................... 33
10.1. Binary Communication ............................................................................................................ 33
10.1.1. Changing from Binary to ASCII mode. ....................................................................... 33
10.2. Changing Non-volatile Data..................................................................................................... 34
10.3. Block Size and Address Range ............................................................................................... 35
10.3.1. Block size.................................................................................................................... 35
10.3.2. Address Range ........................................................................................................... 35
10.4. Write Protection ....................................................................................................................... 35
10.5. Writing Data to the Tag............................................................................................................ 36
10.6. Most and Least Significant Bits and Bytes .............................................................................. 36
2.
List of Tables
Table 1 I-Code Tag Format ................................................................................................................... 6
Table 2 ISO 15693 Tag Format............................................................................................................. 7
Table 3 ISO 15693 UID Format.............................................................................................................. 7
Table 4 ASCII Command and Response Set....................................................................................... 10
Table 5 ASCII Parameter Set ............................................................................................................... 11
Table 6 Operating Modes ..................................................................................................................... 24
Table 7 Revision History....................................................................................................................... 32
SCCPSM.doc
Company Confidential
Page 4 of 36
Colder Products Company
3.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
Introduction
Radio Frequency Identification, RFID, is a technology whereby data carried in transponders,
commonly known as RFID tags, is retrieved by an antenna and transceiver. The tags carry data
which may provide identification for an item in manufacture or in transit, the identity of an animal,
person, or vehicle, or any item that requires tracking or identification. A radio signal emitted by the
transceiver antenna activates the tag, allowing it to be read or written. Antennas can be packaged
together with a transceiver to become a reader and mounted in a coupling such as the Colder
Products Company SmartCoupler. The SmartCoupler connects to a system controller. The system
controller can be in the form of a PLC or any device capable of communicating with an external
device and taking action based on that communication. The way in which the system controller
communicates to the Colder Products SmartCoupler is called a communication protocol.
4.
Scope
This document defines the communications protocol between the CPC SmartCoupler and the
customer software/firmware. The protocol descriptions within this document are valid for versions of
the SmartCoupler running firmware 3.13 and higher.
5.
System Functionality
The SmartCoupler is an embedded device whose sole function is to operate as a Radio Frequency
Identification (RFID) read/write transceiver, or interrogator. RFID tags usable with the SmartCoupler
include Philips Semiconductors’ I•CODE™ tags and ISO 15693 RFID tags. Contact Colder Products
Company for details.
When the SmartCoupler is configured to communicate with the host-controller via a serial
connection, the default communication rate is 19,200 baud. Host-controller port settings must be
fixed at 8 data bits, 1 stop bit, no parity, and no flow control.
The host-controller can command the SmartCoupler to do the following:
•
Perform a read, at a user determined address, of memory bytes.
•
Write data into any or all of the bytes of RFID tag memory.
•
Select whether the SmartCoupler will continually attempt reads or operate in a polled
mode.
•
Enable the SmartCoupler to read I-Code tags or ISO-15693 tags.
•
Enable the SmartCoupler to operate as a node in a multidrop network.
•
Command the SmartCoupler to return its own product serial number and its current
firmware revision level.
Return data is automatically sent to the host-controller upon completion of the required task.
The SmartCoupler implements buffered serial communications. The application may communicate
with the SmartCoupler while it is busy processing a command or communicating with a tag. No
handshaking is implemented other than the acknowledgement received from a command.
SCCPSM.doc
Company Confidential
Page 5 of 36
Colder Products Company
6.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
Tag Format
The SmartCoupler supports tags in the Philips I-Code and ISO15693 formats.
6.1.
Philips I-Code Tag Format
The tag is organized as 64 bytes. The bytes are addressed from 0 to 3F (hexadecimal). Within this
byte address space there are special registers. The serial number is in the address range of 0 – 7.
Addresses 8 – B are the write protection block. Addresses C - F contain special functions and
reserved bits which should not be altered. The 48 bytes addressed 10 – 3F can be used for
application data.
The 8-byte serial number is assigned a unique read-only value by the factory. The serial number is
not changeable.
The 4-byte write protection block contains 16 write protection bit-pairs. Each bit-pair controls the
write protection to a 4-byte block of the tag. Bit-pairs set to “11” allow their corresponding block to be
written. Bit-pairs set to “00” protect a block from writes. Bit-pairs of “10” and “01” act like “00” and
should be avoided. Write protection bits can only change one way: cleared to “0”. Once write
protection is applied, it can not be removed. The least significant 2 bits of the lowest addressed byte
of write protection control the first 4-byte block (first 4 bytes of the serial number at address 0 - 3).
This bit-pair to block mapping continues up to the most significant 2 bits of the highest addressed
byte of write protection controlling the last 4-byte block (data at addresses 3C - 3F). The factory
setting is “11” for all 16 bit-pairs except for the 2 bit-pairs for the serial number, which are both set to
“00”. Hence, the serial number can not change. I. e. The initial factory 4-byte write protect value is
F0, FF, FF, FF at addresses 8 - B. Warning: Clearing either of the 2 bits that protect the write
protection block itself prevents any further changes to any write protection. Ensure all other write
protection bits are as desired before changing these 2 bits. The write protection block, which is at
addresses 8 – B, is has its own write protection controlled by the second most significant bit-pair at
address 8.
The 4-byte reserved location should not be written. It may have its corresponding write protection
applied. Consult CPC if a new application needs this space.
Byte
Address
(hexadecimal)
Write Protection
Byte Address
and Bit-Pair
SN (LSB)
SN
SN
SN
8 ------XX
SN
SN
SN
SN (MSB)
8 ----XX--
WP
WP
WP
WP
8 –XX----
Reserved
Reserved
Reserved
Reserved
8 XX------
10
Data
Data
Data
Data
9 ------XX
14
Data
Data
Data
Data
9 ----XX--
…
Data
Data
Data
Data
…
3C
Data
Data
Data
Data
B XX------
Table 1 I-Code Tag Format
SCCPSM.doc
Company Confidential
Page 6 of 36
Colder Products Company
6.2.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
ISO 15693 Tag Format
The data in the RFID tags are grouped into M N-byte blocks. The values of M and N can be found via
the TI command. A block size of 4 bytes for N is common. The tag’s factory assigned unique 64-bit
serial number is in a separate space. A separate space stores the write protection for the M blocks.
Write protection can only be activated once per block. Once a block is write protected, it can not
become write enabled. All M * N bytes can be used to read and write application data.
Byte
Address
…
N-1
Block
Address
Write
Protection
0*N
Data
Data
Data
Data
On/Off
1*N
Data
Data
Data
Data
On/Off
2*N
Data
Data
Data
Data
On/Off
…
Data
Data
Data
Data
…
On/Off
(M-1)*N
Data
Data
Data
Data
M-1
On/Off
Serial
Number
8-byte Serial Number
Table 2 ISO 15693 Tag Format
Example:
TI command reports 40 (hexadecimal) blocks, each 4 bytes wide for a total
of 100 (hexadecimal) or 256 (decimal) bytes. Data is byte addressed 0 to
FF (hexadecimal). Write protection is on a block basis. Thus protecting 40
(hexadecimal) blocks addressed 0 to 3F (hexadecimal).
Send
TI
Receive
TI:3F03
The 8-byte ISO 15693 tag serial number, also called the Unique Identifier or UID, has the following
format:
Byte
Significance
Data
0-5
LSByte
IC manufacturer serial number - Unique 48-bit serial number
IC Mfg code
E0
MSByte
Table 3 ISO 15693 UID Format
Note: Command SN reports the LSByte first.
SCCPSM.doc
Company Confidential
Page 7 of 36
Colder Products Company
7.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
Communicating with the SmartCoupler
Communication with the SmartCoupler occurs via ASCII commands, parameters & replies that are
sent & received over the interface. In most cases this is a serial interface. Serial port settings must
be fixed at 8 data bits, 1 stop bit, no parity, and no flow control. Serial communication rate is normally
19,200 baud.
A former depreciated method used binary commands. See 10.1 Binary Communication.
7.1.
ASCII Character Set
The SmartCoupler uses ASCII (American Standard Code for Information Interchange, byte codes 0127) characters for all ASCII communication.
Communication to the SmartCoupler:
•
Versions before 3.30: Letters: A - W.
•
Version 3.30 and after: Letters: A - Z.
•
Lower case letters are converted to upper case letters.
•
Digits: 0 - 9
•
9 punctuation marks: ,:;<=>?@`
•
Line Feed (ASCII code 10, ) and Carriage Return (ASCII code 13, )
•
Versions before 3.30: imply .
•
Version 3.30 and after: imply either one of or .
•
The printable ASCII codes, 32-126, not listed above are quietly ignored. Their usage is
reserved for future use.
•
Other ASCII codes not listed above, 0 – 31 & 127, are quietly ignored.
•
Bytes codes not in ASCII, 128-255 are quietly ignored.
Communication from the SmartCoupler:
•
All printable ASCII codes 32-126.
•
Lower case letters are only used in textual portions of messages like SR and PU:
•
Line Feed (ASCII code 10, ) and Carriage Return (ASCII 13, ).
•
Acknowledge (ASCII code 6, ).
•
Bytes codes not listed above indicate an errant ASCII response.
SCCPSM.doc
Company Confidential
Page 8 of 36
Colder Products Company
7.2.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
ASCII Command Format
The ASCII command format structure consists of two-character commands. Some commands
require 1 or 2 preceding parameters. Parameters are one-letter (A, D, L) followed by hexadecimal
data. Parameters are separated with a colon ‘:’. Commands are separated with an . See
7.1 ASCII Character Set. Commands, parameters and hexadecimal data can be entered equivalently
in upper, lower or mixed case.
Example:
Command with no parameters:
Send
SN
Receive
SN:307C7F4500000009
Example:
Mixed case command with 2 parameters (A1 & d0):
Send
A1:d0:Md
Receive
MD:
All numbers presented to and most numbers returned by the SmartCoupler are encoded as
hexadecimal numbers.
Example:
To read 1 byte from address 123 (decimal), convert the number to 7B
(hexadecimal). Notice the 7B is sent as two characters: ‘7’ and ‘B’. The
byte value read at that address is 1F (hexadecimal) or 31 (decimal):
Send
A7B:L1:RD
Receive
RD:1F
The parameters that are required need to be entered before the command and subsequent to any
previous command. Supporting parameters can be entered in any order. Extra leading zeros for
parameters are optional.
Example:
Equivalent read commands.
Send
A28:L5:RD
Send
A0028:L05:RD
Send
L05:A0028:RD
Send
L5:A28:RD
Example:
Missing A0028 parameter before the RD yields an error message.
Send
L05:RD:A0028
Receive
ER:02
The SmartCoupler will respond with a message beginning with the command mnemonic, and a colon
upon completion of each command. These response messages are always terminated by a carriage
return and a linefeed . Data being returned from the SmartCoupler is preceded by the
command mnemonic that invoked it.
The longest response from the SmartCoupler is 519 bytes.
Example:
SCCPSM.doc
Multidrop read of FF bytes of Non-volatile memory.
Send
@77:A0:LFF:RE
Receive
@77:RE:(255 pairs of hexadecimal digits)
Company Confidential
Page 9 of 36
Colder Products Company
7.3.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
ASCII Command and Reply Sequence
Communication normally begins with the application sending a command and then the SmartCoupler
responding. Commands always initiate a response. Some commands have prerequisite parameters.
An application can send multiple commands at once. The reply for each command will occur after
each command is processed. Parameters are only replied if they are in error. Communication to and
from the SmartCoupler may occur simultaneously if the serial interface allows: RS-232: yes, RS422:
yes, RS485: no. Single replies occur with commands that do not error. Single and multiple (for
commands with parameters) replies are possible if an error occurs.
The following lists the exceptional situations when the SmartCoupler will send a message without a
complete command from the application:
7.4.
•
On power-up, the power–up prompt occurs. See PU
•
If the input queue in the SmartCoupler overflows, maybe due to an excessively long
command or commands, an error message is sent. See ER. The input queue is 64
bytes long.
•
Due to a communication error, the SmartCoupler received an , thus signaling
the end of the command.
ASCII Command and Response Set
Command or
Response
B?
BR
ER
M?
MA
MD
PU
R?
RD
RE
RP
RS
RT
SN
SR
ST
TI
W?
WE
WK
WP
WR
WV
SCCPSM.doc
Function
Parameters
Return Baud
none
Baud
Dxx:
Error Response
none
Read Back Modes
none
Multidrop Address
Dxx:
Mode Byte
Axx:, Dxx:
Power Up
none
Returns continuous Read Period
none
Read Data from Tag
Axx:, Lxx:
Read EEPROM
Axx:, Lxx:
Send Acknowledge
none
Reset SmartCoupler
none
Continuous Read Rate
Dxx:
Get Tag Serial Number
none
Return Software Revision
none
Get SmartCoupler Serial Number
none
Tag Info
none
Tag Write Protection
Axx:
Write EEPROM
Axx:, Dxx:
D55AA7F4E:
Write Key
Set Tag Write Protection
Axx:
Write Data to Tag
Axx:, Dxx:
Write and Verify Data to Tag
Axx:, Dxx:
Table 4 ASCII Command and Response Set
Company Confidential
Page 10 of 36
Colder Products Company
7.5.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
ASCII Parameter Set
Parameter
Name
Description
Range (hexadecimal)
Axxxx
Address
Data address
0 – FFFF
Dxx,xx, …
Data
Defines data
0 – FF
Lxx
Length
Number of bytes to read:
0 – FF
Table 5 ASCII Parameter Set
7.6.
ASCII Parameters, Commands and Responses
7.6.1.
A: Address
Action:
Set the address parameter. The byte address or block address is defined
with hexadecimal characters. Leading 0‘s are optional.
Parameters:
NA
Result:
NA
Example:
Read tag data at address 5:
Send
A5:L1:RD
Receive
RD:1B
Example:
Read tag data at address 85 (decimal) or 55 (hexadecimal):
Send
A055:L1:RD
Receive
RD:1B
Errors:
Non-hexadecimal character:
Send
AG:
Receive
ER:01
7.6.2.
B?: Return Baud
Action:
Return selected communication rate. Note: The non-volatile memory
communication rate and current rate is returned
Parameters:
None
Result:
Command echo and communication rate selection
00 => 19,200 Baud (Factory default)
01 =>
9,600 Baud
02 =>
4,800 Baud
03 =>
2,400 Baud
Example:
Read communication rate (19,200 Baud):
Send
B?
Receive
B?:00
Errors:
See ER.
SCCPSM.doc
Company Confidential
Page 11 of 36
Colder Products Company
7.6.3.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
BR: Baud
Action:
Select communication rate. The effect is immediate once the SmartCoupler
executes this command. This change remains in effect until the next power
cycle. The communication rate setting can be re-configured in non-volatile
memory – see 10.2 Changing Non-volatile Data
Warning: This command is depreciated. New applications should not
change the communication rate from 19,200 baud.
Parameters:
Required communication rate selector
00 => 19,200 Baud (Factory default)
01 =>
9,600 Baud
02 =>
4,800 Baud
03 =>
2,400 Baud
Result:
Command echo
Example:
Change the communication rate to 19,200 baud.
Send (at present communication rate) D0:BR
Receive (at new communication rate)
BR:
Errors:
Expected parameter missing or invalid:
Send
BR
Receive
ER:02
7.6.4.
D: Data
Action:
Set the data parameter. The byte data is defined with 1 or 2 hexadecimal
characters. A leading 0 is optional. Multiple bytes of data are separated with
commas.
Parameters:
NA
Result:
NA
Example:
Write tag data DE to address 15:
Send
A15:DDE:WR
Receive
WR:
Example:
Write tag data DE to address 15 and AF to address 16:
Send
A15:DDE,AF:WR
Receive
WR:
Errors:
Non-hexadecimal character:
Send
DG:
Receive
ER:01
SCCPSM.doc
Company Confidential
Page 12 of 36
Colder Products Company
7.6.5.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
ER: Error Response
Action:
The ER is not a command but occurs as an error response to various events.
All commands may respond with 01 or 04. These 2 errors may also occur
due to communication noise. Error 05 may occur at any time indicating a
program failure. Other errors are detailed in each command in which they
may occur.
Note: Some 02 and 03 error responses produced an additional
in versions before 3.30.
Parameters:
NA
Result:
Error response and error index byte (hexadecimal).
01
Empty or illegal command.
02
Expected parameter missing or invalid.
03
CRC error in command.
04
Input buffer overflow.
05
Watchdog timeout error.
06
Verification error
Other values
Reserved for future use.
Example:
Send an illegal command.
Send
IL
Receive
ER:01
Errors
NA
7.6.6.
L: Length
Action:
Set the length parameter used in commands that respond with various
lengths of data. The length is defined with 1 or 2 hexadecimal characters. A
leading 0 is optional. Note: multiple returned bytes are not comma
separated and each byte is always 2 hexadecimal characters long.
Parameters:
NA
Result:
NA
Example:
Read 1 byte of tag data from address 15:
Send
A15:L01:RD
Receive
RD:43
Example:
Read 12 bytes of tag data from address 15:
Send
A15:L12:RD
Receive
RD:436F6C6465720000000000DEAD0000000000
Errors:
SCCPSM.doc
Non-hexadecimal character:
Send
LG:
Receive
ER:01
Company Confidential
Page 13 of 36
Colder Products Company
7.6.7.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
M?: Read Back Modes
Action:
Causes the SmartCoupler to return the mode. The current operating mode
and not the mode stored in non-volatile memory is returned. See MD
command. Warning: some versions before 3.30 of SmartCoupler software
reply with an additional .
Parameters:
None
Result:
Command echo and 4 hexadecimal characters representing the mode
settings. See 8 Operating Modes.
Example:
Get the present mode settings.
Send
M?
Receive
M?:001A
Errors
See ER.
7.6.8.
MA: Multidrop Address
Action:
Assigns an address to the SmartCoupler. The multidrop address is the
required prefix to commands and prefix to responses. The effect is
immediate upon command execution and remains until the next power cycle.
See 8.10 Multidrop Addressing Mode. To make permanent, see 10.2
Changing Non-volatile Data. The response to this command reflects the new
multidrop address. Also see 8.1 Continuous Mode
Side effects:
If non-zero multidrop address,
Enable multidrop mode.
Disable continuous mode.
If zero multidrop address
Disable multidrop mode.
Allow continuous mode to be set.
Parameters:
Required
Multidrop Address (Dxx:). Use addresses 1 to FF. Set the
address to 0 to disable SmartCoupler multidrop address mode.
Result:
Command echo with multidrop address prefix.
Example:
The SmartCoupler presently is not using a multidrop address. Set the
multidrop address to 1B:
Send
D1B:MA
Receive
@1B:MA:
Example:
The SmartCoupler presently has 1B at its multidrop address. Turn off
multidrop mode:
Send
@1B:D0:MA
Receive
MA:
Errors
Expected parameter missing or invalid:
Send
MA
Receive
ER:02
SCCPSM.doc
Company Confidential
Page 14 of 36
Colder Products Company
7.6.9.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
MD: Mode
Action:
Set the operating mode of the SmartCoupler. Various modes are selected by
address and set to various values by data, see 8 Operating Modes . The
effect is immediate upon command execution and remains until the next
power cycle. To make permanent, see 10.2 Changing Non-volatile Data.
Parameters:
Required
Required
Result:
Command echo.
Example:
Disable continuous read mode:
Send
D0:A1:MD
Receive
MD:
Example:
Disable I-Code protocol & enable ISO15693 protocol:
Send
D0:A5:MD
Receive
MD:
Send
D1:A6:MD
Receive
MD:
Errors
Expected parameter missing or invalid (pre version 3.30):
Send
MD
Receive
ER:02
Receive
Receive
ER:01
Errors
Expected parameter missing or invalid (version 3.30):
Send
MD
Receive
ER:02
7.6.10.
Address of the data’s destination (Ax:)
Data to be written (Dx:)
PU: Power Up
Action:
The PU does not occur as a command but as a response when the
SmartCoupler is powered up. It returns the power up indication,
SmartCoupler identification and software version number.
Parameters:
None.
Result:
Power up response and software version number.
Example:
Power cycle the SmartCoupler:
Receive
PU:Smart Coupler
Errors
none
SCCPSM.doc
Company Confidential
003.13
Page 15 of 36
Colder Products Company
7.6.11.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
R?: Returns Continuous Read Period
Action:
Returns the period reads occur in continuous mode.
Parameters:
None
Result:
Command echo and the time (in tenths of a second) between reads in
continuous mode.
Example:
Read the continuous read period (64 hexadecimal is 100 decimal, hence
100 tenths of seconds or 10.0 seconds):
Send
R?
Receive
R?:64
Errors
See ER.
7.6.12.
RD: Read Data from Tag
Action:
Reads data from the tag.
Parameters:
Required
Required
Result:
Command echo and the bytes read as pairs of hexadecimal digits. Notice
that data values are not separated by commas as in the WR command.
Example:
Read 1 byte from address 8:
Send
A08:L01:RD
Receive
RD:F2
Example:
Read 6 bytes from address 101:
Send
L6:A101:RD
Receive
RD:48454C4C4F00
Errors:
Expected parameter missing or invalid:
Send
RD
Receive
ER:02
SCCPSM.doc
Byte address of data to be read (Axx:)
Number of bytes to be read (Lxx:)
Company Confidential
Page 16 of 36
Colder Products Company
7.6.13.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
RE: Read EEPROM
Action:
Action:
Read the non-volatile memory of the SmartCoupler.
Parameters:
Required
Required
Address of F3 - F7.
Length of bytes to read.
Result:
Command echo and bytes read from the non-volatile memory.
Example:
Read the non-volatile memory of the SmartCoupler address F5 and F6.:
Send
AF5:L2:RE
Receive
RE:079A
Errors:
See ER.
7.6.14.
RP: Send Acknowledge
Action:
Sends a command acknowledge from the SmartCoupler
Parameters:
None
Result:
Command echo and an acknowledgement ASCII(6)
Example:
Cause the SmartCoupler to reply with an acknowledgement.
Send
RP
Receive
RP:
Errors
See ER.
7.6.15.
RS: Reset SmartCoupler
Action:
Resets SmartCoupler. Clears buffers and terminates any SmartCoupler/tag
communications. If an earlier command is in the input queue, it is discarded.
Warning: Non-volatile version of the mode is reloaded.
Parameters:
None
Result:
Command echo.
Example:
Reset SmartCoupler:
Send
RS
Receive
RS:
Errors:
See ER.
SCCPSM.doc
Company Confidential
Page 17 of 36
Colder Products Company
7.6.16.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
RT: Continuous Read Rate
Action:
Specify the time between read operations that occur automatically in
continuous mode. The effect is immediate once the SmartCoupler executes
this command. This change remains in effect until the next read period, at
which time, the non-volatile value is reloaded. The continuous read period
can be re-configured in non-volatile memory – see 10.2 Changing Nonvolatile Data.
Warning: setting the read rate to 0 results in a very short interval between
subsequent read operations. This can make subsequent period changes
difficult. New applications should not use a value of 0.
Parameters:
Required
Result:
Command echo.
Example:
Set continuous read rate to once per 6.4 seconds, 64 tenths of a second. 64
(decimal) = 40 (hexadecimal):
Send
D40:RT
Receive
RT:
Errors
Expected parameter missing or invalid:
Send
RT
Receive
ER:02
7.6.17.
Tenths of seconds (Dxx:) between reads.
SN: Get Tag Serial Number
Action:
Returns the tag’s eight byte serial number. This command returns the Least
Significant Byte (LSByte) of the serial number first.
Parameters:
None
Result:
Command echo and 8 pairs of hexadecimal digits. If no tag is present, a
serial number of 0 is returned.
Example:
Read serial number of a tag with serial number in hexadecimal format:
E0040100000329CE:
Send
SN
Receive
SN:CE290300000104E0
Example:
Attempt to read serial number with no tag nearby:
Send
SN
Receive
SN:0000000000000000
Errors:
See ER.
SCCPSM.doc
Company Confidential
Page 18 of 36
Colder Products Company
7.6.18.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
SR: Return Software Revision
Action:
Returns characters containing the revision of the SmartCoupler’s firmware.
Parameters:
None
Result:
Command echo and 5 to 8 printable ASCII characters.
Example:
Get the SmartCoupler software version (3.13):
Send
SR
Receive
SR:003.13
Errors
See ER.
7.6.19.
ST: Get SmartCoupler Serial Number
Action:
Returns the Colder Products Company serial identification found in the
SmartCoupler. The SmartCoupler serial identification, if unassigned returns
=FFFFFF. If assigned, the first 3 pairs of hexadecimal characters, in
reverse order, convert to 3 ASCII characters. The remaining 10 characters
should be interpreted as 10 decimal digits with the first one received as the
Most Significant Digit (MSDigit).
Parameters:
None
Result:
Command echo and 16 digits.
Example:
Get SmartCoupler’s serial number: (Non 10326)
Send
SR
Receive
SR:6E6F4E0000010326
Example:
Get SmartCoupler’s serial number: (Serial number not assigned)
Send
SR
Receive
SR:=FFFFFF
Errors
See ER.
SCCPSM.doc
Company Confidential
Page 19 of 36
Colder Products Company
7.6.20.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
TI: Tag Info
New for Version 3.30
Action:
Returns 2 properties of a tag.
1 - Maximum block address. See 10.3 Block Size and Address Range.
2 - Block size, in bytes minus 1.
Parameters:
None
Result:
Command echo and 2 pairs of hexadecimal digits. The first pair is the
maximum block address. The second pair is the block size minus 1. If no
tag is present, TI0000 is returned. This command ignores the I-Code
compatibility mode selection. See 8.5 I-Code Protocol.
Example:
Get tag info for an I-Code tag (I-Code maximum byte address is always 63
(3F hexadecimal), maximum block address of 15 (0F hexadecimal) and
always a block size of 4):
Send
TI
Receive
TI:0F03
Example:
Get tag info for an ISO-15693 tag (Maximum byte address of 255 (FF
hexadecimal), maximum block address of 63 (3F hexadecimal) and has a
block size of 4):
Send
TI
Receive
TI:3F03
Errors:
See ER.
7.6.21.
W?: Tag Write Protection
New for Version 3.30
Action:
Returns the Tag’s write protection per the indicated block. See 10.4 Write
Protection.
Parameters:
Required
Result:
Command echo.
Example:
Get write protection for block 5, which is not write protected:
Send
A05:W?
Receive
W?:0
Example:
Get write protection for block 0, which is write protected:
Send
A0:W?
Receive
W?:1
Errors:
See ER.
7.6.22.
Block index (Axx:)
WE: Write EEPROM
See service manual for details.
SCCPSM.doc
Company Confidential
Page 20 of 36
Colder Products Company
7.6.23.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
WK: Write Key
Action:
Allows the next command to use the key 55,AA and write to the
SmartCoupler’s non-volatile memory. Then the key is cleared after executing
the next command. 7F,4E is the CRC (cyclic redundancy check) for the
key 55,AA.
Parameters:
Required
Result:
Command echo.
Example:
Allow next command to write to non-volatile memory.:
Send
D55,AA,7F,4E:WK
Receive
WK:
Errors:
CRC error in command.
Send
D1,2,3,4:WK
Receive
ER:03
7.6.24.
4 bytes of data of 55,AA,7F,4E
WP: Set Tag Write Protection
New for Version 3.30
Action:
Set the tag’s write protection per the indicated block. It is not an error to use
this command on a block whose write protection is all ready enabled. See
10.4 Write Protection.
Warning: once a block is write protected, it can not become write enabled.
Parameters:
Required
Result:
Command echo.
Example:
Set write protection for block 15, which is not write protected:
Send
A0F:WP
Receive
WP:
Example:
Set write protection for block 11, which is all ready write protected:
Send
A0B:WP
Receive
WP:
Errors:
Expected parameter missing or invalid:
Send
WP
Receive
ER:02
SCCPSM.doc
Block index (Axx:)
Company Confidential
Page 21 of 36
Colder Products Company
7.6.25.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
WR: Write Data to Tag
Action:
Writes data to the tag
Parameters:
Required
Byte address of the data’s destination (Axx:)
Required
Data to be written (Dxx:). Notice that bytes to be written to
the tag are separated by commas, unlike the response from the RD
command. See 10.5 Writing Data to the Tag.
Result:
Command echo.
Example:
Write 5 bytes to address 10:
Send
A10:DDE,AD,BE,EF,1:WR
Receive
WR:
Example:
Write 1 byte with value C0 to address B. The address location has the value
FF in it and it is write protected. No error message occurs:
Send
DC0:A0B:WR
Receive
WR:
Errors:
Expected parameter missing or invalid:
Send
WR
Receive
ER:02
7.6.26.
WV: Write and Verify Data to Tag
New for Version 3.30
7.7.
Action:
Writes data to the tag and then verifies. This verification takes a little longer
than an unverified write WR. After the write, the data is read back. If the data
read matches the data written, this command returns a WV:. All other results
return an error. See 10.5 Writing Data to the Tag.
Parameters:
Required
Required
Result:
Command echo.
Example:
Write 5 bytes to address 10:
Send
A10:DDE,AD,BE,EF,1:WV
Receive
WV:
Example:
Write 1 byte with value CO to address 1B. The address location has the
value FF in it and is write protected:
Send
DC0:A1B:WV
Receive
ER:06
Errors:
Expected parameter missing or invalid:
Send
WV
Receive
ER:02
Byte address of the data’s destination (Axx:)
Data to be written (Dxx:)
Other ASCII Commands, Parameters & Responses
See SmartCoupler Communication Protocol Service Manual.
SCCPSM.doc
Company Confidential
Page 22 of 36
Colder Products Company
8.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
Operating Modes
The SmartCoupler allows for several user-defined modes of operation.
To read the mode, use the M? command. The 4-hexadecimal value returned is a 16-bit number. The
least significant bit maps to Mode Address 1.
Example:
Read the current mode setting of the SmartCoupler:
Send
M?
Receive
M?:009A
009A implies:
Continuous
Off
ASCII
On
Interlock
Off
Sleep Inhibit
On (Not applicable – Feature not implemented)
I-Code
On
ISO 15693
Off
Quiet
Off (Not applicable – Not in continuous mode)
No Logging
On (Not applicable – Feature always implemented)
I-Code Comp. Off (Not applicable – Not in ISO 15693 mode)
Multidrop
Off
For setting the mode, use the MD command with the Mode Address in the following table.
Mode
Address
Mode
Name
Action with mode value 0
Action with mode value 1
Factory
Default
Continuous
Non-continuous
mode.
No
special
periodic
messages
are
sent.
SmartCoupler responds
only after a command.
Continuous
mode
causes
the
SmartCoupler to periodically read the
tag
and
send
response.
Continuous mode is disabled when
multidrop mode is enabled
ASCII
Command
Binary mode. Should not
be used. See 10.1 Binary
Communication.
Not
allowed in version 3.30
Causes
the
SmartCoupler
to
communicate to the host using ASCII
characters.
Interlock
Lockout is not enabled.
Enables valve lockout on specially
equipped SmartCouplers. Otherwise
always ensure this mode is clear.
Sleep
Inhibit
The SmartCoupler will
wake up only when it
sees a special wakeup
sequence.
Not implemented. Always ensure
this mode is set.
SmartCoupler is not is low-power
sleep mode. Always ensure this
mode is set.
I-Code
Protocol
Do not communicate with
I-Code tags
Communicate with I-Code tags.
ISO15693
Protocol.
Do not communicate with
ISO15693 tags.
Communicate with ISO15693 tags.
SCCPSM.doc
Company Confidential
Page 23 of 36
Colder Products Company
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
Quiet
(No effect
in
noncontinuou
s mode)
When
running
in
continuous mode, the
SmartCoupler
returns
data (strings of zeroes)
when no tag is present.
When running in continuous mode,
the SmartCoupler returns data only
when a tag can be read. Therefore,
the SmartCoupler will remain quiet
until it sees a tag. At that time the
SmartCoupler will begin continuously
sending tag data.
No
Logging
Log serial numbers. No
longer
implemented.
Always ensure this mode
is set.
Do not log serial numbers. Always
does not log. Ensure this mode is
set.
I-Code
Compatibility
No
special
address
adjustments are made.
When communicating with a nonI-Code tag, emulate an I-Code tag.
Multidrop
Multiple drop disabled
Multiple drop enabled
Others
Reserved
for future
use
Leave at 0
Do not set
Table 6 Operating Modes
Warning: Versions before 3.30. When permanently writing the mode via the MD or MA commands,
part of the current mode would also get written.
Example:
Versions before 3.30: Temporally disable quiet mode:
Send
D1:A7:MD
Receive
MD:
Permanently enable continuous mode. This permanent mode change would
also make the temporally disabled quiet mode permanent:
Send
D55,AA,7F,4E:WK
Receive
WK:
Send
D1:A1:MD
Receive
MD:
Example:
Versions 3.30: Temporally disable quiet mode:
Send
D1:A7:MD
Receive
MD:
Permanently enable continuous mode. This permanent mode change would
not also make the temporally disabled quiet mode permanent:
Send
D55,AA,7F,4E:WK
Receive
WK:
Send
D1:A1:MD
Receive
MD:
SCCPSM.doc
Company Confidential
Page 24 of 36
Colder Products Company
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
Warning: Versions before 3.30. Writing mode address 9 or higher did not change the mode. MA
would change the mode address C though.
Note: Versions 3.30. The mode address range is 1 to 10. Changing a mode bit now only affects the
one mode addressed. Some MD commands may error as some mode combinations are prohibited. If
the write key WK precedes the MD command, indicating an attempt to make the change permanent,
these prohibitions are also tested with the permanent mode settings. Neither the mode nor the
permanent mode change when there is an error.
Prohibited Mode Combinations
•
Setting the multidrop mode when continuous mode is enabled.
•
Setting the multidrop mode when the multidrop address is 0.
•
Setting the continuous mode when multidrop mode is enabled.
•
Setting either I-Code or ISO 15693 mode when the other is all ready enabled.
•
Clearing the ASCII Command mode.
SCCPSM.doc
Company Confidential
Page 25 of 36
Colder Products Company
8.1.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
Continuous Mode
Continuous mode repeatedly reads the tag and responds without additional prompting.
originally created to continuously read the serial number or data. Also see 8.7 Quiet Mode.
It was
To read or write the continuous mode period, see R? and RT. The period is best changed when the
SmartCoupler is in non-continuous mode.
The address of data read during continuous mode depends on to the previous address used by the
RD command or on the SN command.
•
I-Code tags. The address should be on a 4-byte block boundary. Otherwise the
address of the continuous mode read is lowered to a 4-byte block boundary. Note:
Intervening commands to the SmartCoupler that communicate with the tag may disrupt
the continuous mode address and should be avoided. The SN command will also
change the address to 0.
•
ISO 15693 tags (I-Code compatible mode enabled). Any valid byte address may be
used and it is not adjusted to a 4-byte boundary. The SN command will also change
the address to 0.
•
ISO 15693 tags (I-Code compatible mode disabled). If the preceding command is
RD, any valid byte address may be used. If the preceding command is SN, the
response is the serial number preceded by SN:.
The length of data bytes read during continuous mode depends on the previous length used by the
RD command or on the SN command.
•
I-Code tags. The length of data read during continuous mode is always a multiple of a
4-byte block. The length read is moved up to a multiple of a 4-byte block from the
original RD length + 5. The length is adjusted to range from 8 to the size of the tag: 40
(hexadecimal) bytes. Intervening commands to the SmartCoupler that communicate
with the tag may disrupt the continuous mode length and should be avoided. The SN
command will change the data length to 8.
•
ISO 15693 tags. If the preceding command is RD, any valid byte length may be used.
If the preceding command is SN, the response is the serial number preceded by SN:.
The response is always preceded by RD: or SN:.
•
•
SCCPSM.doc
I-Code tags & ISO 15693 tags (I-Code compatible mode enabled). The continuous
mode response is always preceded with an RD: even when the preceding command
was SN.
ISO 15693 tags (I-Code compatible mode disabled). If the preceding command is
RD, the response is preceded by RD:. If the preceding command is SN, the response
is the serial number preceded by SN:.
Company Confidential
Page 26 of 36
Colder Products Company
8.2.
v. 3.30.00
SmartCoupler Communications Protocol
Service Manual
Example
Continuously read the data of an I-Code tag at addresses 10 – 1B:
Send
A10:L4:RD
Receive
RD:04223344
Send
A1:D1:MD
Receive
MD:
Receive
RD:04223344D1D2D34455020304
Receive
RD:04223344D1D2D34455020304
Receive
RD:04223344D1D2D34455020304
Receive
RD:04223344D1D2D34455020304
Send
A1:D0:MD
Receive
MD:
Example
Continuously read the serial number of an I-Code tag:
Send
SN
Receive
SN:307C7F4500000009
Send
A1:D1:MD
Receive
MD:
Receive
RD:307C7F4500000009
Receive
RD:307C7F4500000009
Receive
RD:307C7F4500000009