KoamTac KDC100 Owner's manual

KDC100
PROGRAMMINGMANUAL
Rev2.4
A
New Wave in Auto ID

KDC100 Programming Manual
Copyright, License and Warning page
Copyright©2007, 2008 by KoamTac, Inc. All rights reserved
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 KoamTac.
The material in this manual is subject to change without notices.
KoamTac reserves the right to make changes to any product to improve reliability, function, or design.
KoamTac doesn’t assume any product liability arising out of, or in connection with, the application or use of
any product, circuit, or application described herein.
Follow all warnings and instructions marked on manual and units
Use only the power source specified in this manual or marked on the units
TO PREVENT FIRE OR SHOCK HAZARD, DO NOT EXPOSE THIS UNIT TO ANY TYPE OF MOISTURE
DO NOT LOOK DIRECTLY INTO LASER or point the laser into another person’s eyes. Exposure to the beam MAY CAUSE EYE
DAMAGE.
CAUTION
Changes or modifications not expressly approved by the manufacturer responsible for compliance could void
the user’s authority to operate the equipment
WARNING
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.
INFORMATION TO USER:
This equipment has been tested and found to comply with the limit of a Class B digital device, pursuant to Part
15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in
a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not
installed and used in accordance with the instructions, may cause harmful interference to radio communications.
However, there is no guarantee that interference will not occur in a particular installation; if this equipment does
cause harmful interference to radio or television reception, which can be determined by turning the equipment
off and on, the user is encouraged to try to correct the interference by one or more of the following measures:
1. Reorient / Relocate the receiving antenna.
2. Increase the separation between the equipment and receiver.
3. Connect the equipment into an outlet on a circuit difference from that to which the receiver is connected.
4. Consult the dealer or an experienced radio/TV technician for help
CAUTION
RISK OF EXPLOSIN IF BATTERY IS REPLACED AN INCORRECT TYPE.
DSPOSE OF USED BATTERIES ACCORDING TO THE INSTRUCTIONS

Table of Contents
Internal data buffer .................................................................................................................................... 5
Data format...........................................................................................................................................5
How many barcodes can we store?.......................................................................................................6
What happens when this buffer is full? ................................................................................................. 6
Command Set ............................................................................................................................................ 7
‘B’ command......................................................................................................................................... 8
‘C’ command......................................................................................................................................... 8
‘c’ command.......................................................................................................................................... 8
‘D’ command.........................................................................................................................................8
‘E’ command......................................................................................................................................... 9
‘F’ command......................................................................................................................................... 9
H’ command........................................................................................................................................10
‘h’ command ....................................................................................................................................... 10
‘V’ command....................................................................................................................................... 10
‘L’ command....................................................................................................................................... 10
‘l’ command ........................................................................................................................................11
‘N’ command....................................................................................................................................... 11
‘O’ command.......................................................................................................................................11
‘o’ command ....................................................................................................................................... 12
‘P’ command....................................................................................................................................... 12
‘p’ command ....................................................................................................................................... 13
‘S’ command ....................................................................................................................................... 13
‘s’ command........................................................................................................................................14
‘T’ command....................................................................................................................................... 14
‘t’ command ........................................................................................................................................14
‘U’ command.......................................................................................................................................15
‘u’ command ....................................................................................................................................... 15
‘W’ command......................................................................................................................................15
‘w’ command....................................................................................................................................... 16
‘Z’ command....................................................................................................................................... 17
‘z’ command........................................................................................................................................17
Packet Data.............................................................................................................................................. 18
HOST response to KDC100 after receiving data command ...............................................................18
Wedge mode ........................................................................................................................................ 18
Synchronization mode......................................................................................................................... 19
Miscellaneous.......................................................................................................................................... 20
KDC100 sends "?" character..............................................................................................................20
Contact Information................................................................................................................................. 21

KDC100 Programming Manual
KoamTac KDC100 command set is provided to developers who wish to control the scanner and resulting data
from within their application.
Internaldatabuffer
KDC100 has 200K bytes flash memory where it stores the read barcodes. Its capacity, in terms of number of
barcodes, depends on the size of barcodes. Barcodes are stored sequentially as they are scanned in the internal
flash memory. The maximum number of stored barcodes is 10,240 with 200K byte limitation.
Dataformat
KDC100 stores the read barcodes in the internal flash memory as the following data format:
C0 Y0 D0 T0 C1 Y1 D1 T1 . . . . Cn Yn Dn Tn
Where
C0, C1,…, Cn : Total number of each barcode data(1 byte)
Y0,Y1,…, Yn : Type of each barcode(1 byte)
D0,D1,…,Dn : Actual barcode data of each barcode(variable size)
T0, T1,…,Tn : Timestamp of each barcode(4 bytes)
Barcodes are stored sequentially as they are scanned in the internal flash memory. Since barcodes can have
different lengths, we need to keep track of length information as well. For each barcode we first store the length
of barcode plus 1 (1 byte), then the barcode type (1 byte), and then the barcode value (without the string
terminator ‘\0’).
The timestamp field has 6 sub-fields as follows:
LSB MSB
Seconds (6 bits) Minutes (6 bits) Hours (5 bits) Days (5 bits) Months (4 bits) Years (6 bits)
Note: The base year is 2000. It means the year is 2000 if Years field is 0.

Howmanybarcodescanwestore?
The number of barcodes that can be stored in these bytes depends upon the size of the barcodes
Example: If only UPCA barcodes are scanned and the check digit is not transmitted, then each barcode takes up
11 (barcode data) + 2 (length and type) + 4 (time stamp) = 17 bytes. The maximum number of UPCA barcodes
that can be saved is 204,800/17 =12,047. However, the maximum number of barcodes can be stored is 10,240.
Therefore, KDC100 can store 10,240 UPCA barcodes.
If different length barcodes are mixed, user cannot compute a priori what the maximum number of barcodes is.
Whathappenswhenthisbufferisfull?
When the internal flash memory is full, KDC100 displays buffer full message and ignores the command to scan
barcodes.

KDC100 Programming Manual
CommandSet
KDC100 has various commands and they are quite simple. They are shown in the following table.
Command Input Output Description
B None value @ Returns current battery capacity(value = 0~100)
C YMDHmS @ Setting new date and time of KDC100
c None YMDHmS @ Returns current date and time of KDC100
D None @ or ! Reading barcode
E None @ Erase all stored barcodes
F None @ Set internal options to factory default setting
H value # @ Enable/Disable handshake while transferring packet data
h None value @ Get handshake state
V None string @ Get firmware version
L value # @ or ! Set minimum barcode length
l None value @ Get minimum barcode length
N None value @ Get number of barcode stored
O value # @ or ! Set scan options and flags
o None value @ Get scan options and flags
P None data Upload whole stored barcode data
p value # data Upload Nth stored barcode
S value # @ or ! Set decoding symbologies
s None value @ Get current decoding symbologies
T value # @ or ! Set decoding timeout
t None value @ Get current barcode read timeout
U value # @ or ! Select barcode handling mode
u None value @ Get barcode handling mode selected by command 'U'
W None @ Wake up KDC100 from sleep mode
w value # @ or ! Select the data format of Wedge mode
Z value # @ or ! Set security level
z None value @ Get current security level

‘B’command
Parameters: None
Format: ‘B’
Output: ‘xxxx@’ where xxxx is the capacity of battery ( 0 – 100) in hex and @ means the end of data
Purpose: Read the battery capacity of KDC100.
‘C’command
Parameters: Date and Time value to be set in KDC100
Format: ‘CYMDHmS’ where Y is year(0 means 2000), M is month(1-12), D is day(1-31), H is hour(0-23),
m is minute(0-59) an S is second(0-59).
Output: ‘@’ all the times
Purpose: Set Date and Time of KDC100.
‘c’command
Parameters: None
Format: ‘c’
Output: ‘YMDHmS@’ where Y is year(0 means 2000), M is month(1-12), D is day(1-31), H is hour(0-23),
m is minute(0-59) an S is second(0-59).
Purpose: Read current Date and Time of KDC100.
‘D’command
Parameters: None
Format: ‘D’
Output: ‘!’ – KDC100 internal flash memory is full or Reading failure
‘@’ – Barcode reading success
Purpose: Turns the motor on, then turns the laser on and starts scanning. When a barcode is found or if
timeout occurred, it stops the motor and turns off laser.

KDC100 Programming Manual
‘E’command
Parameters: None
Format: ‘E’
Output: ‘@’ – all the times.
Purpose: Erases the internal flash memory completely. All scanned data is lost.
Remarks: Should be issued after the upload commands (‘P’ or ‘p’).
‘F’command
Parameters: None
Format: ‘F’
Output: ‘@’ – all the times.
Purpose: Set KDC100 internal options and flags to the factory default setting.
The factory default settings are:
- All symbologies are enabled.
- All options are disabled except
. UPCE_ReturnCheckDigit
. UPCA_ReturnCheckDigit
. EAN8_ReturnCheckDigit
. EAN13_ReturnCheckDigit
- Minimum barcode length is set to 4.
- Time-out is set to 2 seconds.
- Security Level is set to 2.
- Select wide scan angle.
- Sleep timeout is set to 5 seconds.
- Send the read data to HOST and save into flash when pressing scan button.
- Send PAYLOAD(only barcode) data when pressing scan button.

H’command
Parameters: 0 or 1
Format: “Hxxxx#” where xxxx is the value of parameter in hex.
Output: ‘!’ – invalid parameter.
‘@’ – all other times.
Purpose: Selects if KDC100 need(1)/doesn’t need(0) to handshake with HOST while sending packet data.
KD100 doesn’t do handshake if sending barcode only.
‘h’command
Parameters: None
Format: ‘h’
Output: ‘xxxxxxxx@’ where xxxxxxxx is the value sent to KDC100 by command ‘H’.
Purpose: Get the current setting of handshaking mode. 0 means disabled and 1 means enabled.
‘V’command
Parameters: None
Format: “V”
Output: ‘string@’ where string is a F/W version string and @ means the end of data.
Purpose: Read the F/W version of KDC100.
‘L’command
Parameters: Minimum length of barcode (valid values: 2 to 36)
Format: “Lxx#” or “lxx#” where xx is the value of parameter in hex.
Output: ‘!’ – invalid parameter.
‘@’ – all other times.
Purpose: Set the minimum length of barcodes.
Examples: To set the length to 20, send command “L14#”. “L4#” sets the minimum length to 4. If you send
“LFFF#”, then the returned value will be ‘!’ and the minimum length will be unchanged.

KDC100 Programming Manual
‘l’command
Parameters: None
Format: ‘l’
Output: ‘xxxxxxxx@’ where xxxxxxxx is the minimum length of barcodes and @ means the end of data
Purpose: Read the minimum length of barcodes
‘N’command
Parameters: None
Format: ‘N’
Output: ‘xxxxxxxx@’ where xxxxxxxx is the number of stored barcodes and @ means the end of data
Purpose: Read the number of stored barcodes in KDC100 internal flash memory
‘O’command
Parameters: The options (it is unsigned 32-bit number)
Format: ‘Oxxxxxxxx#’ where xxxxxxxx is the value of parameter in hex.
Output: ‘!’ – invalid parameter.
‘@’ – all other times.
Purpose: Enables the selected options.
Example: Sending “O0#” disables all the options.
To enable an option, set the appropriate bit to ‘1’ in the parameter.
Option bit# Option bit#
CodaBar_NoStartStopChars 0 UPCA_as_EAN13 19
ReverseDirection 4 I2of5_VerifyCheckDigit 22
UPCE_as_UPCA 9 Code39_VerifyCheckDigit 23
EAN8_as_EAN13 10 I2of5_ReturnCheckDigit 26
UPCE_as_EAN13 11 Code39_ReturnCheckDigit 27

ReturnCheckDigit 12 UPCE_ReturnCheckDigit 28
VerifyCheckDigit 13 UPCA_ReturnCheckDigit 29
WideScanAngle 14 EAN8_ReturnCheckDigit 30
HighFilterMode 15 EAN13_ReturnCheckDigit 31
‘o’command
Parameters: None
Format: ‘o’
Output: ‘xxxxxxxx@’ where xxxxxxxx is the selected barcode options and @ means the end of data
Purpose: Read the barcode options saved in KDC100. Please see the table of command ‘O’ for detail
explanation of options
‘P’command
Parameters: None.
Format: ‘P’
Output: A multi-byte string (see below).
Purpose: Read all barcodes data stored in KDC100 internal flash memory. Does not erase the stored
barcodes.
The format of the output is as follows:
N C0Y
0D 0T 0C 1Y1D 1T 1...................CnYnDnTn
Where
N : Total number of bytes to be sent(3 bytes)
C0, C1,…, Cn : Total number of each barcode data(1 byte)
Y0,Y1,…, Yn : Type of each barcode(1 byte)
D0,D1,…,Dn : Actual barcode data of each barcode(variable size)
T0, T1,…,Tn : Timestamp of each barcode(4 bytes)
The first 3 bytes specify the total number of bytes being sent. Then the entire populated contents of the internal
flash memory are sent as is.

KDC100 Programming Manual
After the 3rd byte, the message can be thought of in terms of variable size blocks with each block of bytes
representing information on a single barcode. These blocks are placed next to each other with no “empty” bytes
between them.
‘p’command
Parameters: The number which indicates the position of barcode data to be sent.
Format: ‘pxxxxxxxx#’ where xxxxxxxx is the number of barcode data stored in the internal flash to upload.
Output: A multi-byte string (see below). KDC100 sends only one barcode data at one time.
Purpose: Read the Nth barcodes data stored in KDC100 internal flash memory. Does not erase the barcode.
S N C Y D T K
Where:
S : Start byte 0x03(1 byte)
N : Total number of bytes to be sent(3 bytes)
C : Total number of each barcode data(1 byte)
Y : Type of each barcode(1 byte)
D : Actual barcode data of each barcode(variable size)
T : Timestamp of each barcode(4 bytes)
K : Check sum byte(1 byte). All sum except S should be 0.
Note: To upload all stored barcode data by using this command, it is required to call this command N times
‘S’command
Parameters: The symbology selection (it is unsigned 32-bit number)
Format: ‘Sxxxxxxxx#’ where xxxxxxxx is the value of parameter in hex.
Output: ‘!’ – invalid parameter.
‘@’ – all other times.
Purpose: Enables the selected symbologies.
Example: Sending “Sffffffff#” enables all the symbologies.

To select a symbology, set the appropriate bit to ‘1’ in the parameter.
Symbology bit# Symbology bit#
EAN13 0 EAN128 9
EAN8 1 Code93 10
UPCA 2 Code35 11
UPCE 3 BooklandEAN 12
Code39 4 EAN13withAddon 13
ITF14 5 EAN8withAddon 14
Code128 6 UPCAwithAddon 15
I2of5 7 UPCEwithAddon 16
Codabar 8 PDF417 31
‘s’command
Parameters: None
Format: ‘s’
Output: ‘xxxxxxxx@’ where xxxxxxxx is the selected symbologies and @ means the end of data
Purpose: Read the selected symbologies. Please see the table of command ‘S’ for detailed explanation of
each symbology.
‘T’command
Parameters: Time in msec. Valid range is 100msec to 10sec.
Format: “Txxxx#” where xxxx is the value of parameter in hex.
Output: ‘!’ – invalid parameter.
‘@’ – all other times.
Purpose: Set the timeout for barcode read operation.
Example: Sending “T3e8#” sets the timeout to 1sec.
‘t’command
Parameters: None

KDC100 Programming Manual
Format: ‘t’
Output: ‘xxxxxxxx@’ where xxxxxxxx is the timeout value for barcode read operation and @ means the end
of data
Purpose: Get the current read timeout setting.
‘U’command
Parameters: 0, 1,2 or 3
Format: “Uxxxx#” where xxxx is the value of parameter in hex.
Output: ‘!’ – invalid parameter.
‘@’ – all other times.
Purpose: Selects how KDC100 handles scanned barcode.
If the value xxxx is 0: KDC100 doesn’t store scanned barcode in the memory and just transmits it
to the host.
1: KDC100 stores scanned data in the memory and transmits it to the host.
2: KDC100 stores scanned data in the memory but doesn’t transmit it to the host.
3: KDC100 stores scanned data in the memory only if succeeded to send read barcode to host.
‘u’command
Parameters: None
Format: ‘u’
Output: ‘xxxxxxxx@’ where xxxxxxxx is the value sent to KDC100 by command ‘U’.
Purpose: Get the current setting of barcode handling mode.
‘W’command
Parameters: None
Format: “W”
Output: ‘@’ – all the times.
Purpose: Wake up KDC100 from sleep mode.
To ensure that KDC100 woke up from sleep, it is required to send ‘W’ command many times.

If KDC100 replied with ‘@’, then KDC100 is already woke up from sleep mode.
‘w’command
Parameters: 0 or 1
Format: ‘zxxxx#’ where xxxx is the value of parameter in hex,
Output: ‘!’ – invalid parameter.
‘@’ – all other times.
Purpose: When SCAN button is pressed, select whether KDC100 sends PAYLOAD data only or sends
PACKET
data and waiting for response from HOST.
If the value xxxx is 0: KDC100 sends only PAYLOAD to HOST
1:KDC100 sends PACKET data and wait for response(‘@’) from HOST.
If KDC100 doesn’t get response from HOST within 100msec, KDC100
sends the same data to HOST again. KDC100 will attempt 10 times until
it gets a response from HOST.
{Data Format
KDC100 supports two kind of data format when sending data to HOST as the following:
PAYLOAD only
Barcode data CR LF
Where: Barcode data is the actual read barcode data
CR is 0x0d(‘\r’)
LF is 0x0a(‘\n’)
PACKET DATA
S N C Y D T K
Where:
S : Start byte 0x03(1 byte)
N : Total number of bytes to be sent(3 bytes)

KDC100 Programming Manual
C : Total number of each barcode data(1 byte)
Y : Type of each barcode(1 byte)
D : Actual barcode data of each barcode(variable size)
T : Timestamp of each barcode(4 bytes)
K : Check sum byte(1 byte). All sum except S should be 0.
‘Z’command
Parameters: Security level (valid values: 1 to 5)
Format: “Zx#” where xis the value of parameter in hex.
Output: ‘!’ – invalid parameter.
‘@’ – all other times.
Purpose: Set the security level.
‘z’command
Parameters: None
Format: ‘z’
Output: ‘xxxxxxxx@’ where xxxxxxxx is the current security level and @ means the end of data
Purpose: Read the current security level value

PacketData
KDC100 supports user selectable two data formats:
zBarcode only and
zPacket data.
By default, KDC100 sends data with Barcode. If KDC100 is configured to send Barcode only data, KDC100
doesn’t do handshake with host application. However, if KDC100 is configured to send packet data, KDC100
needs to do handshake with host application to make sure that HOST receives read barcode correctly. There are
two cases of sending packet data to host:
zsynchronization mode and
zWedge mode
HOST response to KDC100 after receiving data command
KDC100 expects the HOST to send two kinds of response to KDC100 once HOST received packet data from
KDC100:
zSuccess response or
zFailure response.
HOST is required to send a success response if it receives a packet data successfully by sending a character ‘@’.
If HOST detected an error while receiving a packet data from KDC100, HOST should send a failure response to
KDC100 by sending a character ‘!’.
Wedge mode
If KDC100 read a barcode and configured to send packet data, KDC100 waits for 1 second to get a response
from HOST after sending a read barcode data to HOST. KDC100 goes to ready mode upon receiving either
success or failure response. KDC100 goes to ready mode if there is no response from Host in 1 second. KDC100
doesn’t resend the data either receiving failure response or 1 second time out. The following is detail steps
between HOST and KDC100.
a) HOST configures KDC100 to send packet data
b) User presses SCAN button
c) KDC100 reads barcode data
d) If reading is success, KDC100 sends a packet data leading a character 0x03 and ending with
checksum.
e) KDC100 goes to waiting state.
f) HOST receives a packet data from KDC100.
g) HOST checks if it receives a packet data without error.
h) HOST sends a success response by sending a character ‘@’ to KDC100 or a failure response by
sending a character ‘!’.

KDC100 Programming Manual
i) KDC100 exits waiting state if it receives any response from HOST. KDC100 replies to HOST with
sending ‘@’ for a success response.
j) KDC100 waits for 1 second and exits waiting state with sending a ‘!’ to HOST if there is no
response from HOST.
k) KDC100 goes to ready state.
Synchronization mode
Synchronization mode is initiated by HOST with sending a command to KDC100 to read a barcode stored in
KDC100 internal flash memory. There is no difference from HOST side handling a packet data either
Synchronization or Wedge mode. However, KDC100 sends a barcode up to 10 times repeatedly until it receives
a success response from HOST. The following is detailed steps between the HOST and KDC100.
a) HOST configures KDC100 to send packet data
b) HOST sends a command(‘P’ and index) to KDC100 to read stored barcode
c) KDC100 sends a stored barcode to HOST with packet data format
d) KDC100 goes to waiting state.
e) HOST receives a packet data from KDC100.
f) HOST checks if it receives a packet data without error.
g) HOST sends a success response by sending a character ‘@’ to KDC100 or a failure response by
sending a character ‘!’.
h) KDC100 exits waiting state with sending ‘@’ if it receives a success response and returns to ready
mode. However, if KDC100 got a failure response, it repeats to send the same barcode 10 times until
getting a success response. KDC100 sends a ‘!’ character to HOST if it couldn’t get any responses
from HOST during 1 second.

Miscellaneous
KDC100 sends "?" character.
“?” is sent by KDC100 when the device receives undefined character (command) from Host. Application would
ignore “?” character

KDC100 Programming Manual
ContactInformation
KDC Technical Support Team
116 Village Blvd. Suite 200
Princeton, NJ 08540
USA
TEL: [phone]
FAX: [phone]
Email: [email protected]
URL: www.koamtac.com