CORDLESS SSI
PROGRAMMER’S GUIDE
CORDLESS SSI
PROGRAMMER’S GUIDE
MN001667A02EN
Revision A
January 2021
ii Cordless SSI Programmer’s Guide
No part of this publication may be reproduced or used in any form, or by any electrical or mechanical means,
without permission in writing from Zebra. This includes electronic or mechanical means, such as photo copying,
recording, or information storage and retrieval systems. The material in this manual is subject to change
without notice.
The software is provided strictly on an “as is” basis. All software, including firmware, furnished to the user is on
a licensed basis. Zebra grants to the user a non-transferable and non-exclusive license to use each software
or firmware program delivered hereunder (licensed program) . Except as n oted below, such licen se may not b e
assigned, sublicensed, or otherwise tran sfe rr e d by th e user without prior written consent of Zebra. No right to
copy a licensed program in whole or in part is granted, except as permitted under copyright law. The user shall
not modify , merge, or incorporate any for m or portion of a licensed program with other pro gram material, create
a derivative work from a licensed program , or us e a li censed program in a network without written permission
from Zebra. The user agrees to maintain Zebra’s copyright notice on the licensed programs delivered
hereunder , and to include the same on any au thorized copies it m akes, in whole or in part. The user agrees not
to decompile, disassemble, decode, or reverse engineer any licensed program delivered to the user or any
portion thereof.
Zebra reserves the right to make changes to any software or product to improve reliability, function, or design.
Zebra does not assume any product liability arising out of, or in connection with, the application or use of any
product, circuit, or application described herein.
No license is granted, either expressly or by implication, estoppel, or otherwise under any Zebra Technologies
Corporation, intellectual property rights. An implied license only exists for equipment, circuits, and su bsystems
contained in Zebra products.
Revision History
Changes to the original manual are listed below:
Change Date Description
-01 Rev. A 5/2015 Initial Release.
-02EN Rev. A 1/2021 Added to ’Code Types and Identifiers’ and ’Code Types by SSI ID’ tables:
iii
GS1 QR
Mailmark
Dotcode
Multicode
UK Plessey
Grid Matrix
Telepen
UDI Parsed Code
Updated:
UPCA to UPC-A
UPCE to UPC-E
UPCE1 Change to UPC-E1
UPCA + 2 UPC-A + 2
UPC-E + 2 to UPC-E + 2
UPCA + 5 UPC-A + 5
UPCE + 5 to UPC-E + 5
UPCE1 + 5 - Change to UPC-E1 + 5
D25 to Discrete 2 of 5
ITF to Interleaved 2 of 5
C 2 of 5 to Chinese 2 of 5
Removed:
UPCD
Parameter (FNC3)
Decode Data from Custom Defaults
iv Cordless SSI Programmer’s Guide
Table of Contents
Revision History............................................................................................................. iii
About This Guide
Introduction.................................................................................................................... i
Chapter Descriptions..................................................................................................... i
Notational Conventions.................................................................................................. ii
Chapter 1: Introduction
SDK Overview .............................................................................................................. 1-1
Supported OS ............................................................................................................... 1-1
Supported Scanners ..................................................................................................... 1-1
Chapter 2: Programming and Configuration Recommendations
Programming - Opening a Virtual Com Port over a Bluetooth Connection ................... 2-1
Device Configuration - Host Device (PC/Tablet/Phone) ......................................... 2-1
Device Configuration - Scanner .............................................................................. 2-1
Chapter 3: Introduction to Simple Serial Interface
Using SSI ...................................................................................................................... 3-1
Software Handshaking .................................................................................................. 3-1
Transfer of Decode Data .............................................................................................. 3-1
Expected Responses .................................................................................................... 3-2
Message Packets .................................................................................................... 3-3
Multipacketing ......................................................................................................... 3-4
Packet Format ......................................................................................................... 3-4
Chapter 4: SSI Commands
Introduction ................................................................................................................... 4-1
SSI Command Lists ...................................................................................................... 4-1
vi Cordless SSI Programmer’s Guide
ABORT_MACRO_PDF ........................................................................................... 4-6
AIM_OFF ................................................................................................................ 4-7
AIM_ON .................................................................................................................. 4-8
BEEP ...................................................................................................................... 4-10
CAPABILITIES_REQUEST .................................................................................... 4-13
CAPABILITIES_REPLY .......................................................................................... 4-14
BATCH_DATA ........................................................................................................ 4-17
Bar Code String ................................................................................................ 4-17
BATCH_REQUEST ................................................................................................ 4-18
CHANGE_ALL_CODE_TYPES .............................................................................. 4-19
CMD_ACK .............................................................................................................. 4-20
CMD_ACK_ACTION ............................................................................................... 4-22
CMD_NAK .............................................................................................................. 4-24
CUSTOM_DEFAULTS ............................................................................................ 4-27
DECODE_DATA ..................................................................................................... 4-28
EVENT .................................................................................................................... 4-41
FLUSH_MACRO_PDF ............................................................................................ 4-43
FLUSH_QUEUE ..................................................................................................... 4-44
ILLUMINATION_OFF .............................................................................................. 4-45
ILLUMINATION_ON ............................................................................................... 4-46
IMAGE_DATA ......................................................................................................... 4-47
IMAGER_MODE ..................................................................................................... 4-49
LED_OFF ................................................................................................................ 4-50
LED_ON .................................................................................................................. 4-51
PAGER_MOTOR_ACTIVATION ............................................................................ 4-52
PARAM_DEFAULTS .............................................................................................. 4-53
PARAM_REQUEST ................................................................................................ 4-54
PARAM_SEND ....................................................................................................... 4-57
REPLY_REVISION ................................................................................................. 4-59
REQUEST_REVISION ........................................................................................... 4-60
SCAN_DISABLE ..................................................................................................... 4-61
SCAN_ENABLE ...................................................................................................... 4-62
SLEEP .................................................................................................................... 4-63
SSI_MGMT_COMMAND ........................................................................................ 4-64
START_SESSION .................................................................................................. 4-65
STOP_SESSION .................................................................................................... 4-66
VIDEO_DATA ......................................................................................................... 4-67
WAKEUP ................................................................................................................ 4-69
Appendix A: Model Specific Details
CS4070 Details ............................................................................................................. A-1
Appendix B: Using Scan-To-Connect with an SSI Application
Appendix C: Code Samples
Code Samples .............................................................................................................. C-1
Calculating a Checksum ............................................................................................... C-1
Index
Table of Contents vii
viii Cordless SSI Programmer’s Guide
About This Guide
Introduction
The Cordless SSI Developers Guide provides information about opening a virtual com port over a Bluetooth®
connection.
Chapter Descriptions
Topics covered in this guide are as follows:
•
Chapter 1, Introduction gives an overview of the contents of this guide.
•
Chapter 2, Programming and Configuration Recommendations provides information for opening a virtual
com port over a Bluetooth connection, and device configuration.
•
Chapter 3, Introduction to Simple Serial Interface provides an overview of SSI.
•
Chapter 4, Cordless SSI Commands describes each available SSI command, including field descriptions
and host and cordless scanner requirements.
•
Appendix A, Model Specific Details includes CS4070 specific commands.
•
Appendix B, Using Scan-To-Connect with an SSI Application describes the cordless Scan-To-Connect
application.
1 - ii Cordless SSI Programmer’s Guide
Notational Conventions
The following conventions are used in this document:
•
“User” refers to anyone using an SSI product.
•
“You” refers to the End User, System Administrator or Programmer using this manual as a reference for
SSI.
•
Italics are used to highlight the following:
• Chapters and sections in this and related documents
• Dialog box, window and screen names
• Drop -d o wn list an d list bo x na mes
• Check box and radio button names
• Icons on a screen.
•
Bold text is used to highlight the following:
• Key names on a keypad
• Button names on a screen or window.
•
bullets (•) indicate:
• Action items
• Lists of alter na tiv es
• Lists of req uir ed step s th at ar e not nece ssa r ily seque nt ial
•
Sequential lists (e.g., those that describe step-by-step procedures) appear as numbered lists.
NOTE This symbol indicates something of special interest or importance to the reader. Failure to read the note
will not result in physical harm to the reader, equipment or data.
CAUTION This symbol indicates that if this information is ignored, the possibility of data or material damage may
occur.
WARNING! This symbol indicates that if this information is ignored the possibility that serious personal
injury may occur.
CHAPTER 1 INTRODUCTION
SDK Overview
The Cordless SSI Programmer’s Guide allows a programmer to open a virtual com port over a Bluetooth
connection and issue commands that control a cordless scanner. This solution utilizes the pre-existing
Bluetooth driver of the host OS to establish communication between the scanner and host.
NOTE For information about how to open a virtual com port over a Bluetooth connection consult a search engine,
such as Google. The answer is operating system and programming language specific.
Application functionality can include:
•
Receiving bar code data.
•
Command and control
• Get/Set symbologies
• Control Beeper/LED
• Enable/disable the vibrator
• Scanning control (enable/disable scanning and host applications initiated triggering).
Supported OS
•
Windows
•
Linux
•
Android.
Supported Scanners
All cordless Made For iOS (MFi) enabled scanners, such as the CS4070 scanner.
NOTE For product specifics, such as any SSI/product limitations, see Appendix A, Model Specific Details.
1 - 2 Cordless SSI Programmer’s Guide
CHAPTER 2 PROGRAMMING AND
CONFIGURATION
RECOMMENDATIONS
Programming - Opening a Virtual Com Port over a Bluetooth Connection
For information about how to open a virtual com port over a Bluetooth connection consult a search engine,
such as Google. The web guidance is operating system and programming language specific.
NOTE The host PC/tablet/phone is configured for Bluetooth SPP communication, while the scanner is configured
for Bluetooth SSI communication.
Device Configuration - Host Device (PC/Tablet/Phone)
Confirm your PC/tablet/phone host supports Bluetooth Serial Port Profile (SPP). Your application issues
cordless SSI commands over the Bluetooth SPP connection.
Device Configuration - Scanner
A user must scan the SSI or cradle host parameter bar code to set the scanner's communication protocol.
When the scanner pairs to the host device, it sends data in an SSI format to the virtual com port over the
Bluetooth SPP connection.
2 - 2 Cordless SSI Programmer’s Guide
CHAPTER 3 INTRODUCTION TO SIMPLE
SERIAL INTERFACE
Using SSI
Before attempting to use SSI, it is important to understand the following information about SSI.
•
The SSI interface provides a means for the host application to control the cordless scanner.
•
SSI is a half-duplex communication protocol.
•
SSI is transaction-based. The host application commands and the cordless scanner responds. For
example, the host application commands beep the beeper and the cordless scanner both beeps and
ACKs as a response. Acknowle dgments are vital for maintaining synchronization.
Software Handshaking
Software handshaking provides an ACK/NAK response for commands that do not h ave a natural response. For
example, the command tell me your parameters is followed by the response my parameters are X. However the
command start a decode session has no natural response. Therefore, software handshaking provides an
ACK/NAK response.
NOTE Hardware handshaking is not used for Cordless SSI.
Transfer of Decode Data
The cordless scanner sends a DECODE_DA T A me ssage after a successful decode. The cordless scanner waits
for 30 seconds time-out for a CMD_ACK response. If it does not receive the response, the cordless scanner
tries to send two more times before issuing a host transmission error. If the cordless scanner receives a
CMD_NAK from the host, it may attempt a retry depending on the cause field of the CMD_NAK message.
3 - 2 Cordless SSI Programmer’s Guide
Expected Responses
T able 3-1, Table 3-2 o n page 3-3 and Table 3-3 on page 3-4 list allowable cordless scanner and host application
responses.
Table 3-1
AIM_OFF
AIM_ON
BATCH_REQUEST
BEEP
CAPABILITIES_REQUEST
CHANGE_ALL_CODE_TYPES CMD_ACK/CMD_NAK
CMD_ACK
CMD_ACK_ACTION None
CMD_NAK
CUSTOM_DEFAULTS CMD_ACK / CMD_NAK
FLUSH_QUEUE
ILLUMINATION_OFF CMD_ACK / CMD_NAK
ILLUMINATION_ON CMD_ACK / CMD_NAK
Cordless Scanner Responses to Host Ap plication Transmission
Host Transmission Allowable Decoder Responses
CMD_ACK / CMD_NAK
CMD_ACK / CMD_NAK
BATCH_DATA / CMD_NAK
CMD_ACK / CMD_NAK
CAPABILITIES_REPLY
None
None
CMD_ACK / CMD_NAK
IMAGER_MODE
LED_OFF
LED_ON
PAGER_MOTOR_ACTIVATION CMD_ACK / CMD_NAK
PARAM_DEFAULTS
PARAM_REQUEST
PARAM_SEND
REQUEST_REVISION
SCAN_DISABLE
SCAN_ENABLE
SLEEP
SSI_MGMT_COMMAND SSI_MGMT_COMMAND or CMD_NAK
CMD_ACK / CMD_NAK
CMD_ACK / CMD_NAK
CMD_ACK / CMD_NAK
CMD_ACK / CMD_NAK
PARAM_SEND
CMD_ACK / CMD_NAK
REPLY_REVISION
CMD_ACK / CMD_NAK
CMD_ACK / CMD_NAK
CMD_ACK / CMD_NAK
Introduction to Simple Serial Interface 3 - 3
Table 3-1
START_SESSION
STOP_SESSION
WAKEUP
Table 3-2
CAPABILITIES_REPLY
CMD_ACK
CMD_NAK
DECODE_DATA
EVENT
Cordless Scanner Responses to Host Application Transmission (Continued)
Host Transmission Allowable Decoder Responses
Host Application Responses to Cordless Scanner Transmission
Decoder Transmission Allowable Host Responses
CMD_ACK / CMD_NAK
Note that once the decoder gathers the
appropriate data, it sends this data
unsolicited.
CMD_ACK / CMD_NAK
None
None
None
None
CMD_ACK / CMD_NAK *
CMD_ACK / CMD_NAK *
IMAGE_DATA
PARAM_SEND
REPLY_REVISION
VIDEO_DATA
* Multipacketed data; the host may ACK/NAK only the last packet of a
multi-packeted message. Intermediate packets get no response.
Intermediate packets always have the continuation bit set (1). The last
packet has the continuation bit cleared (0). See
multi-packeting options.
CMD_ACK / CMD_NAK *
None
None
CMD_ACK / CMD_NAK
Multipacketing on page 3-4
for
Message Packets
All communications between the host application and the cordless scanner are exchanged in the form of
packets. A packet is a collection of bytes framed by the proper SSI protocol formatting bytes. The maximum
length of a packet is 257 bytes, consisting of a checksum (two bytes), a header (four bytes), and up to 251
characters of data. Note that the length field in the header does NOT include the length of the checksum, but
DOES include the length of the header itself.
3 - 4 Cordless SSI Programmer’s Guide
Multipacketing
SSI supports multiple packets for one message for cases when size is insufficient to transfer a complete
message. Bit 1 of the status byte in the message header is set to one for all packets except the last to indicate
another packet follows. In the last packet, this bit is set to zero. The host application must re-assemble these
packets into one message.
The cordless scanner sends each packet in order.
The host application ACK/NAKs each packet in a strict transaction-based method. If a CMD_NAK checksum
message occurs, the cordless scanner retransmits the packet that was NAKd.
Packet Format
The general packet format for SSI messages is as follows:
Length Opcode Message Source Status Data... Checksum
Table 3-3
Field Name Format Sub-Field Meaning
Length 1 Byte Length Length of message not including the check
Opcode 1 Byte See command list on
Message Source 1 Byte 0 = Cordless Scanner
Status Bit 0 Retransmit 0 = First time packet is sent
Field Descriptions
Bit 1 Continuation 0 = Last frame of a multipacket message
Bit 2 Reserved Always set to zero
Bit 3 3 Change Type (applies
page
Table 4-2 on page
4-3
.
04 = Host
to parameters)
sum bytes.
Maximum value is 0xFF.
Identifies the type of packet data sent
Identifies where the message is coming from
1 = Subsequent transmission attempts
1 =Intermediate packet of a multipacket
message
0 = Temporary change
1 = Permanent change
Bits 4 - 7 Unused bits must be set to 0
Data… Variable
number of
bytes
Checksum 2 Bytes 2s complement sum of
Note: The checksum is a 2 byte checksum and must be sent as HIGH BYTE followed by LOW BYTE.
See individual sections
for details.
message contents
excluding checksum.
Checksum of message formatted as HIGH
BYTE LOW BYTE
Chapter 4 SSI Commands
Introduction
This chapter describes each available SSI command, including field descriptions and host and decoder
requirements.
SSI Command Lists
The following table lists the available SSI commands alphabetically.
Table 4-1
ABORT_MACRO_PDF
AIM_OFF
AIM_ON
BATCH_DATA
BATCH_REQUEST
BEEP
CAPABILITIES_REQUEST
CAPABILITIES_REPLY
CHANGE_ALL_CODE_TYPES H 0xC9 Enables / Disables all code types.
CMD_ACK
Note: D = Decoder, H = Host, H/D = Host/Decoder
SSI Commands
Name Type Opcode Description Page
H 0x11 Terminates MacroPDF sequence and discards
segments.
H 0xC4 Deactivates aim pattern.
H 0xC5 Activates aim pattern.
D 0xD6 Transmits stored decode data.
H 0xD5 Requests stored decode data.
H 0xE6 Sounds the beeper.
H 0xD3 Requests commands which decoder will perform.
D 0xD4 Lists commands which decoder will perform.
H/D 0xD0 Positive acknowledgment of received packet.
4-6
4-7
4-8
4-10
4-10
4-10
4-13
4-14
4-19
4-20
4 - 2 Cordless SSI Programmer’s Guide
Table 4-1
SSI Commands (Continued)
Name Type Opcode Description Page
CMD_ACK_ACTION H 0xD8 This is a positive acknowledgment of a received
packet and can be used in place of the CMD_ACK
command to allow users to control the beeper,
pager motor (i.e., vibration feedback) and LEDs
after receiving decoded data or any other SSI
command.
Note: This command in not supported by all
scanners.
CMD_NAK
H/D 0xD1 Negative acknowledgment of received packet.
CUSTOM_DEFAULTS H 0x12 Host command to update Custom Defaults Buffer.
DECODE_DATA
EVENT
FLUSH_MACRO_PDF
D 0xF3 Decode data in SSI packet format.
D 0xF6 Event indicated by associated event code.
H 0x10 Terminates MacroPDF sequence and transmits
captured segments.
FLUSH_QUEUE
H 0xD2 Tells the decoder to eliminate all packets in its
transmission queue.
4-22
4-24
4-27
4-28
4-41
4-43
4-44
ILLUMINATION_OFF H 0xC0 Deactivates Illumination
ILLUMINATION_ON H 0xC1 Activates Illumination.
IMAGE_DATA
IMAGER_MODE
LED_OFF
LED_ON
PAGER_MOTOR_ACTIVATION
PARAM_DEFAULTS
PARAM_REQUEST
PARAM_SEND
REPLY_REVISION
D 0xB1 Data comprising the image.
H 0xF7 Commands imager into operational modes.
H 0xE8 Extinguishes LEDs.
H 0xE7 Activates LED output.
H
0xCA Actuates the vibration feedback.
H 0xC8 Sets parameter default values.
H 0xC7 Requests values of certain parameters.
H/D 0xC6 Sends parameter values.
D 0xA4 Replies to REQUEST_REVISION with decoder's
software/hardware configuration.
REQUEST_REVISION
SCAN_DISABLE
SCAN_ENABLE
H 0xA3 Requests the decoder's configuration.
H 0xEA Prevents the operator from scanning bar codes.
H 0xE9 Permits bar code scanning.
4-45
4-46
4-47
4-49
4-50
4-51
4-52
4-53
4-54
4-57
4-59
4-60
4-61
4-62
SLEEP
H 0xEB Requests to place the decoder into low power.
Note: D = Decoder, H = Host, H/D = Host/Decoder
4-63
SSI Commands 4 - 3
Table 4-1
SSI Commands (Continued)
Name Type Opcode Description Page
SSI_MGMT_COMMAND
START_SESSION
STOP_SESSION
VIDEO_DATA
WAKEUP
H/D
H 0xE4 Tells decoder to attempt to decode a bar code.
H 0xE5 Tells decoder to abort a decode attempt.
D 0xB4 Data comprising the video.
H N/A Wakes up decoder after it's been powered down.
Note: D = Decoder, H = Host, H/D = Host/Decoder
0x80 RSM command to read/set some scanner
attributes.
4-64
4-65
4-66
4-67
4-69
4 - 4 Cordless SSI Programmer’s Guide
Table 4-2 lists the SSI commands by Opcode.
Table 4-2
Opcode Name
0x10
0x11
0x12
0x80
0xA3
0xA4
0xB0
0xB1
0xB4
0xC0
0xC1
0xC4
0xC5
SSI Commands by Opcode
FLUSH_MACRO_PDF
ABORT_MACRO_PDF
CUSTOM_DEFAULTS
SSI_MGMT_COMMAND
REQUEST_REVISION
REPLY_REVISION
Reserved
IMAGE_DATA
VIDEO_DATA
ILLUMINATION_OFF
ILLUMINATION_ON
AIM_OFF
AIM_ON
0xC6
0xC7
0xC8
0xC9
0xCA
0xD0
0xD1
0xD2
0xD3
0xD4
0xD5
0xD6
0xD8
0xE4
0xE5
PARAM_SEND
PARAM_REQUEST
PARAM_DEFAULTS
CHANGE_ALL_CODE_TYPES
PAGER_MOTOR_ACTIVATION
CMD_ACK
CMD_NAK
FLUSH_QUEUE
CAPABILITIES_REQUEST
CAPABILITIES_REPLY
BATCH_REQUEST
BATCH_DATA
CMD_ACK_ACTION
START_SESSION
STOP_SESSION
0xE6
BEEP
SSI Commands 4 - 5
Table 4-2
Opcode Name
0xE7
0xE8
0xE9
0xEA
0xEB
0xF3
0xF6
0xF7
N/A
SSI Commands by Opcode (Continued)
LED_ON
LED_OFF
SCAN_ENABLE
SCAN_DISABLE
SLEEP
DECODE_DATA
EVENT
IMAGER_MODE
WAKEUP
4 - 6 Cordless SSI Programmer’s Guide
ABORT_MACRO_PDF
Description
Terminates MacroPDF sequence and discards all captured segments.
Table 4-3
Length Opcode
04h 11h 04h
Table 4-4
Field Name Format Size Description
Length
Opcode
Message
Source
Status
Field Descriptions - ABORT_MACRO_PDF
Packet Format - ABORT_MACRO_PDF
Message
Source
Length of message (not including checksum). 1 Byte Length Field
11h 1 Byte Identifies this Opcode type.
4 = Host 1 Byte Identifies where the message is coming from.
Status Checksum
1 Byte
Bit 0: Retransmit
0 = First transmission
1 = Subsequent transmission
Bit 1: Continuation
0 = Last packet of a multipacket message
1 = Intermediate packet
Bit 2: Reserved
Always 0
Bit 3: Parameter Change Type
(for parameters)
0 = Temporary change
1 = Permanent change
Checksum
Host Requirements
None.
Decoder Requirements
The decoder terminates the current MacroPDF sequence and discards all captured MacroPDF segments.
2's complement sum of message contents
excluding checksum.
2 Bytes Checksum of message.
AIM_OFF
Description
Turns off aiming pattern.
SSI Commands 4 - 7
Table 4-5
Length Opcode
04h C4h 04h
Table 4-6
Field Name Format Size Description
Length
Opcode
Message
Source
Status
Field Descriptions - AIM_OFF
Packet Format - AIM_OFF
Message
Source
Length of message (not including checksum). 1 Byte Length Field
C4h 1 Byte Identifies this Opcode type.
4 = Host 1 Byte Identifies where the message is coming
Status Checksum
1 Byte
from.
Bit 0: Retransmit
0 = First transmission
1 = Subsequent transmission
Bit 1: Continuation
0 = Last packet of a multipacket message
1 = Intermediate packet
Bit 2: Reserved
Always 0
Bit 3: Parameter Change Type
(for parameters)
0 = Temporary change
1 = Permanent change
Checksum
Host Requirements
This command applies only to decoders that support an aim pattern.
Decoder Requirements
The decoder turns off the aim pattern, and responds with a CMD_ACK (if ACK/NAK handshaking is enabled).
If the aim pattern is not supported, the decoder responds with NAK_DENIED (if ACK/NAK handshaking is
enabled).
2's complement sum of message contents
excluding checksum.
2 Bytes Checksum of message.
4 - 8 Cordless SSI Programmer’s Guide
AIM_ON
Description
Turns on aiming pattern.
Table 4-7
Length Opcode
04h C5h 04h
Table 4-8
Field Name Format Size Description
Length
Opcode
Message
Source
Status
Field Descriptions - AIM_ON
Packet Format - AIM_ON
Message
Source
Length of message (not including checksum). 1 Byte Length Field
C5h 1 Byte Identifies this Opcode type.
4 = Host 1 Byte Identifies where the message is coming
Status Checksum
1 Byte
from.
Bit 0: Retransmit
0 = First transmission
1 = Subsequent transmission
Bit 1: Continuation
0 = Last packet of a multipacket message
1 = Intermediate packet
Bit 2: Reserved
Always 0
Bit 3: Parameter Change Type
(for parameters)
0 = Temporary change
1 = Permanent change
Checksum
Host Requirements
This command applies only to decoders which support an aim pattern.
Decoder Requirements
The decoder turns on the aim pattern, and responds with a CMD_ACK (if ACK/NAK handshaking is enabled).
If the aim pattern is not supported, the decoder responds with NAK_DENIED (if ACK/NAK handshaking is
enabled).
2's complement sum of message contents
excluding checksum.
2 Bytes Checksum of message.
SSI Commands 4 - 9
The Aim Duration para meter controls the amoun t of time the aiming pattern sta ys on during a trigger pull. The valid
values for this parameter are 0 - 99, which equal 0.1 to 9.9 seconds in 100 msec increments. Table 4-9 lists Aim
mode behavior in various situations.
Table 4-9
Command Sequence Action Performed Aim Duration Parameters
AIM_ON
AIM_OFF
AIM_ON,
START_DECODE
AIM_ON,AIM_OFF,
START_DECODE
START_DECODE
Aim Mode
Turns on the aiming pattern indefinitely. aim duration = 0
Turns off the aiming pattern. aim duration = 0
Turns on the aiming pattern, when
START_DECODE received turns on scan
pattern and begins decoding.
Turns on aiming pattern, turns off aiming
pattern, turns on scan pattern and begins
decoding.
Turns on aiming pattern for aim duration
time, turns on scan pattern and begins
decoding.
aim duration = 0
aim duration = 0
aim duration > 0
4 - 10 Cordless SSI Programmer’s Guide
BEEP
Description
Sounds the beeper.
Table 4-10
Length Opcode
05h E6h 04h
Table 4-11
Field Name Format Size Description
Length
Opcode
Message
Source
Status
Field Descriptions - BEEP
Packet Format - BEEP
Message
Source
Length of message (not including checksum). 1 Byte Length Field
E6h 1 Byte Identifies this Opcode type.
4 = Host 1 Byte Identifies where the message is coming from.
Status
Beep
Code
1 Byte
Checksum
Bit 0: Retransmit
0 = First transmission
1 = Subsequent transmission
Bit 1: Continuation
0 = Last packet of a multipacket message
1 = Intermediate packet
Bit 2: Reserved
Always 0
Bit 3: Parameter Change Type
(for parameters)
0 = Temporary change
1 = Permanent change
Beep Code
Checksum
This Opcode instructs the receiver to sound the beep sequence indicated by the Beep Code field.
See Table 4-12. 1 Byte Number that identifies a beep sequence.
2's complement sum of message contents
excluding checksum.
2 Bytes Checksum of message.
Loading...