MAH_applicationprogrammingguide.pdf

(794 KB) Pobierz
Code Reader 3.0
Application Programming Guide
Codereader version 3.0 (CR3)
ODT-HH-MAH300
Reviewed By
Role
QA
Operation
Engineering
Management
Signature
Date
V002344_00AF_CR3_Application Programming Guide
– Preliminary Draft
2005-10-18
Page 1 of 49
Contents
Table of Contents
1
Introduction................................................................................................................ 5
1.1
1.2
1.3
1.4
Product Description ..................................................................................................... 5
Document Organization .............................................................................................. 6
Document Conventions................................................................................................ 6
Related Documents ...................................................................................................... 6
2
Programming Environment....................................................................................... 7
2.1
2.2
2.3
2.4
2.5
2.6
JavaScript ..................................................................................................................... 7
Editor ............................................................................................................................ 7
Simulator ...................................................................................................................... 7
Download Utility .......................................................................................................... 7
CR3 Configuration Utility........................................................................................... 7
Security ......................................................................................................................... 7
3
Programming Concepts ............................................................................................. 8
3.1
3.2
3.2.1
3.2.2
3.2.3
3.2.4
Simplicity ...................................................................................................................... 8
The CR3 GUI Object ................................................................................................... 9
Softkey Implementation.......................................................................................................... 9
Forms.................................................................................................................................... 10
Menus ................................................................................................................................... 11
Text....................................................................................................................................... 12
3.3
3.3.1
3.3.2
3.3.3
3.3.4
3.3.5
Event Handlers........................................................................................................... 12
Packet Event Handlers.......................................................................................................... 13
Decode Event Handler.......................................................................................................... 13
Key Event Handling ............................................................................................................. 13
Command Execution ............................................................................................................ 14
Reader Mode Change ........................................................................................................... 15
3.4
3.4.1
3.4.2
3.4.3
3.4.4
Symbol Decoding........................................................................................................ 15
Transform Data by Symbology............................................................................................. 16
Evaluate Data Format ........................................................................................................... 16
Detect Format Errors ............................................................................................................ 16
Default Processing................................................................................................................ 16
3.5
3.6
3.7
Host Communication ................................................................................................. 17
Data in CR3 Local Storage........................................................................................ 17
Reader Configuration ................................................................................................ 17
4
Class Reference ........................................................................................................ 19
4.1
4.1.1
4.1.2
4.1.3
gui ................................................................................................................................ 19
Methods ................................................................................................................................ 19
Properties.............................................................................................................................. 21
Constructors.......................................................................................................................... 22
V002344_00AF_CR3_Application Programming Guide
– Preliminary Draft
2005-10-18
Page 3 of 49
Contents
4.2
4.2.1
4.2.2
reader .......................................................................................................................... 30
Methods ................................................................................................................................ 30
Properties.............................................................................................................................. 33
4.3
4.3.1
4.3.2
storage ......................................................................................................................... 37
Methods ................................................................................................................................ 37
Properties.............................................................................................................................. 39
4.4
4.4.1
4.4.2
comm ........................................................................................................................... 40
Methods ................................................................................................................................ 40
Properties.............................................................................................................................. 41
4.5
4.5.1
4.5.2
4.5.3
Functions..................................................................................................................... 42
Dialog ................................................................................................................................... 42
Process Control..................................................................................................................... 44
Other Functions .................................................................................................................... 45
Glossary ............................................................................................................................ 46
Appendix A
A.1
A.2
A.1.1
A.1.2
Code Reader 3 Simulator......................................................................... 47
Installation .................................................................................................................. 47
Using JSE.exe ............................................................................................................. 47
Editor Window ..................................................................................................................... 47
Simulator Window................................................................................................................ 49
Table of Tables
Table 1 – Key to Event Handler Mapping ........................................................................ 14
Table of Figures
Figure 1 – Code Reader Version 3...................................................................................... 5
Figure 2 – Hello World Application ................................................................................... 9
Figure 3 – The Standard
gui
Format................................................................................. 9
Figure 4 – Form Demo Display ........................................................................................ 11
Figure 5 – Menu Demo Display........................................................................................ 12
Figure 6 – CR3 Keypad .................................................................................................... 14
Figure 7 – gui.Separator Lines.......................................................................................... 26
Figure 8 – gui.Text Example ............................................................................................ 30
Figure 9 – Prompt Example .............................................................................................. 44
V002344_00AF_CR3_Application Programming Guide
– Preliminary Draft
2005-10-18
Page 4 of 49
Programming Environment
1 Introduction
Figure 1 – Code Reader Version 3
Code Reader 3.0 (CR3) is the smallest and lightest full-featured bar
code reading terminal on the market. It combines all-symbology bar code reading with
information display and keypad entry in an ergonomic hand-held platform.
1.1 Product Description
This manual describes the application programming interface for the
Code Reader version 3.0 (CR3). The reader should have programming skills and
familiarity with the JavaScript language.
•
•
The CR3 reads code data and can be programmed to transmit the code data over a
selected communications link or to store code data in CR3 memory (batch mode).
The programming environment provides interfaces to:
−
Read and manipulate data in the CR3 memory.
−
Display information on the CR3 display screen.
−
Retrieve data from the CR3 reader hardware or the CR3 key pad.
V002344_00AF_CR3_Application Programming Guide
– Preliminary Draft
2005-10-18
Page 5 of 49
Programming Environment
−
−
−
−
Access data sent by the host.
Transmit data to a host computer via the communications link.
Select the type of communications link.
Set, change, and retrieve CR3 configuration settings.
1.2 Document Organization
This document is organized as follows:
•
•
•
•
•
Section 1, Introduction – this section.
Section 2, Programming Environment – identifies the tools used to create and
load application software into the CR3.
Section 3, Programming Concepts – discusses how to accomplish various
operations on the CR3
Section 4, Class Reference – presents the classes, object, methods, properties, and
constructors that support application programs.
Section 0, Glossary
1.3 Document Conventions
This document employs the following conventions to aid in readability:
•
•
•
Words that are part of the application development description use the
Courier New
font.
Code examples use the
bold Courier New
font.
Variable names that must be supplied by the programmer are
Courier New
font and are enclosed in relational signs, for example,
<variable_name>.
1.4 Related Documents
Code Reader 3 – User Manual
Code Reader 3 – Reader-Host Interface Specification
V002344_00AF_CR3_Application Programming Guide
– Preliminary Draft
2005-10-18
Page 6 of 49

Plik z chomika:

Inne pliki z tego folderu:

Inne foldery tego chomika:

Zgłoś jeśli naruszono regulamin