Zebra EP10 Mobile Devices Developers Guide (en)

Download

MOBILE DEVICES

DEVELOPERS GUIDE

MOBILE DEVICES

DEVELOPERS GUIDE

8000271-001

Rev. A

April 2015

ii Mobile Devices Developers 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 photocopying, 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 noted below, such licens may not be assigned, sublicensed, or otherwise transferred by the 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 form or portion of a licensed program with other program material, create a derivative work from a licensed program, or use a licensed 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 authorized copies it makes, 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 any product, circuit, or application described herein.

No license is granted, either expressly or by implication, estoppel, or otherwise under any Zebra, intellectual property products.

rights. An implied license only exists for equipment, circuits, and subsystems contained in Zebra

arising out of, or in connection with, the application or use of

iii

iv Mobile Devices Developers Guide

Revision History

Changes to the original guide are listed below:

Change Date Description

Rev A 4/2012 Initial release. Rev. B 11/2013 Update

-001 Rev

. A

4/2015 Zebra re-branding.

vi Mobile Devices Developers Guide

Table of Conte n ts

About this Guide .............................................................................................................................xix

Text Conventions............................................................................................................................ xx

Command Syntax...........................................................................................................................xxi

Non-Psion Computers..................................................................................................................... xxi

Other Documentation for Application Development........................................................................ xxi

Chapter 1: Backlight

Backlighting.....................................................................................................................................1-3

Omnii and EP10 .............................................................................................................................1-3

Thresholds......................................................................................................................................1-3

Timeouts.........................................................................................................................................1-3

Backlight Configuration Parameters............................................................................................... 1-5

Mobile Devices SDK Version 5.4 and Later...................................................................................1-6

Mobile Devices SDK Version 5.3 and Earlier.................................................................................1-6

Getting Started with Backlights.......................................................................................................1-10

Code Samples for Backlights..........................................................................................................1-10

Backlight API Elements................................................................................................................... 1-10

Chapter 2: Batteries and Power Management

Suspend Timeout............................................................................................................................2-3

Psion Power States.........................................................................................................................2-4

Suspend/resume Cycle..................................................................................................................2-4

Comparison of Power S t ates..........................................................................................................2-4

Fully on ..................................................................................................................................... 2-4

Standby Mode (Unattended Mode)...........................................................................................2-4

Suspend Mode.......................................................................................................................... 2-4

Suspend with Radio Off Mode (Shutdown Mode)..........................................................................2-5

Power Off........................................................................................................................................2-5

Manual Initiation of Standby and Suspend......................................................................................2-5

Wake up from Suspend Mode, or Suspend With Radio Off Mode..................................................2-8

EP10 Power Options Registry Settings ..........................................................................................2-9

viii Mobile Devices Developers Guide

Programmatic Control of the Suspend/resume Cycle..................................................................... 2-10

Initiation of Suspend ................................................................................................................. 2-10

Selection of Wakeup Sources................................................................................................... 2-10

Accelerometer and Gyroscope.......................................................................................................2-11

Wake up that Stops in Standby Mode.......................................................................................2-11

Setting a Time Until Wakeup..........................................................................................................2-11

Getting Started with the Suspend/resume Cycle............................................................................ 2-11

Code Samples for the Suspend/resume Cycle...............................................................................2-11

Suspend API Elements................................................................................................................... 2-11

Power Management........................................................................................................................2-12

Events.......................................................................................................................................2-12

Battery Information ......................................................................................................................... 2-13

Battery Suspend Threshold ......................................................................................................2-13

Main Battery and Backup Battery Lifetimes and Remaining Charge........................................ 2-13

Smart Batteries.........................................................................................................................2-13

Smart Battery Registry Settings......................................................................................................2-14

Getting Started with Power Management and Smart Batteries ...................................................... 2-15

Code Samples for Power Management and Smart Batteries......................................................... 2-15

Power Management and Battery API Elements ............................................................................. 2-15

Chapter 3: Reset

Reset Types and Effects................................................................................................................. 3-3

Manual Initiation of Resets .............................................................................................................3-5

Programmatic Initiation of Resets................................................................................................... 3-11

Controlling Keyboard Resets..........................................................................................................3-12

Detecting and Identifying Resets.............................................................................................. 3-12

Getting Started with Resets............................................................................................................ 3-12

Code Samples for Resets............................................................................................................... 3-12

Reset API Elements........................................................................................................................3-12

Chapter 4: Display

Display............................................................................................................................................ 4-3

Getting Started with the Display .....................................................................................................4-5

Code Samples for the Display........................................................................................................ 4-5

Display API Elements..................................................................................................................... 4-5

Chapter 5: Indicators

Indicators........................................................................................................................................5-3

Using LED Colours......................................................................................................................... 5-3

Controlling Pulses........................................................................................................................... 5-4

Controlling Illumination Patterns..................................................................................................... 5-4

Getting Started with Indicators........................................................................................................5-5

Code Samples for Indicators ..........................................................................................................5-5

Indicator API Elements................................................................................................................... 5-5

Table of Contents ix

Chapter 6: Keyboard and Keyboard Remapping

Keyboard.........................................................................................................................................6-3

Supported Keyboards.....................................................................................................................6-3

Disabling The Keyboard.................................................................................................................6-5

Getting Started with Keyboards................................................................................................ 6-5

Code Samples for Keyboards...................................................................................................6-5

Keyboard API Elements.......................................................................................................... ..6-5

Keyboard Remapping..................................................................................................................... 6-5

ORANGE Key and SYM Key.........................................................................................................6-7

Keyboard Remapping Functions on Psion Computers..................................................................6-7

Unicode Values for Psion Proprietary Keys...................................................................................6-11

Windows Mobile, and Windows CE, Virtual Keys..........................................................................6-15

Windows Mobile Virtual Keys on Psion Computers..................................................................6-15

Getting Started with Key Remapping........................................................................................6-15

Code Samples for Key Remapping...........................................................................................6-16

Keyboard Remapping API Elements .............................................................................................6-16

Key Insertion...................................................................................................................................6-16

Getting Started with Key Insertion ............................................................................................6-17

Code Samples for Key Insertion............................................................................................... 6-17

Key Insertion API Elements............................................................................................................6-17

Chapter 7: Peripherals

Overview.........................................................................................................................................7-3

Definition of Terms..........................................................................................................................7-3

Events............................................................................................................................................. 7-3

Docking Station...............................................................................................................................7-4

Tether Ports..................................................................................................................................... 7-4

Getting Started with Peripherals.....................................................................................................7-5

Code Samples for Peripherals........................................................................................................7-5

Peripheral API Elements in the Mobile Devices SDK..................................................................... 7-5

Peripheral API Elements in the Hardware Development Kits (HDK).............................................. 7-5

Chapter 8: Card Slots

Card Slots.......................................................................................................................................8-3

Controlling Power to the Card Slots................................................................................................ 8-5

Controlling Power Through the GUI..........................................................................................8-5

Controlling Power Through the SDK.........................................................................................8-5

Getting Started with Card Slots....................................................................................................... 8-6

Code Samples for Card Slots .........................................................................................................8-7

Card Slot Control API Elements...................................................................................................... 8-7

Chapter 9: Serial Ports

Overview.........................................................................................................................................9-3

Workabout Pro Serial Port Assignments.........................................................................................9-3

7530, 7535, 8525, and 8530 Serial Port Assignments.................................................................... 9-4

8515 Serial Port Assignments.........................................................................................................9-5

Ikôn Serial Port Assignments..........................................................................................................9-5

x Mobile Devices Developers Guide

NEO Serial Port Assignments.........................................................................................................9-5

Omnii XT10 (7545XV), Omnii XT15 (7545XA), Omnii RT15 (7545XC) Serial Port Assignments... 9-6

EP10 (7515) Serial Port Assignments............................................................................................ 9-7

VH10 Serial Port Assignments .......................................................................................................9-7

Java................................................................................................................................................9-8

Getting Started with Serial Ports.....................................................................................................9-8

Code Samples for Serial Ports .......................................................................................................9-8

Serial Port API Elements................................................................................................................ 9-8

Chapter 10: Permanent Storage

Permanent Storage.........................................................................................................................10-3

Locking Permanent Storage........................................................................................................... 10-3

Getting Started with Permanent Storage........................................................................................ 10-3

Code Samples for Permanent Storage...........................................................................................10-3

Permanent Storage API Elements.................................................................................................. 10-4

Chapter 11: RAS (Remote Access Service)

Overview......................................................................................................................................... 11-3

Support for RAS and Windows Connection Manager on Psion Computers................................... 11-3

RAS Architecture............................................................................................................................ 11-4

RAS on Windows Mobile (Connection Manager) ........................................................................... 11-4

Getting Started with RAS................................................................................................................ 11-5

Code Samples for RAS...................................................................................................................11-5

RAS API Elements..........................................................................................................................11-5

Chapter 12: Scanners

Types Of Scanners......................................................................................................................... 12-3

External Scanners ..........................................................................................................................12-3

Scanner connected to a USB port..................................................................................................12-4

Scanner connected to a serial port.................................................................................................12-4

Scanner Connected to the Tether Port by a Scanner Cable..........................................................12-4

Scanner Connected to the Tether Port by a Tether Cable .............................................................12-5

Querying an External Scanner.......................................................................................................12-6

Internal Scanners............................................................................................................................ 12-6

Symbologies................................................................................................................................... 12-8

Configuring Scanners..................................................................................................................... 12-10

Configuring Through the GUI.........................................................................................................12-10

Configuring Using an SDK Application...........................................................................................12-10

Configuring by Scanning Configuration Bar Codes.......................................................................12-1 1

Configuring Scanners Through the Mobile Devices SDK............................................................... 12-12

Configuring Scanner Properties.....................................................................................................12-14

Code 39 Settings............................................................................................................................12-21

Trioptic Code Settings....................................................................................................................12-24

Code 128 Settings..........................................................................................................................12-25

EAN 13 Settings.............................................................................................................................12-28

EAN 8 Settings...............................................................................................................................12-30

Table of Contents xi

UPC A Settings...............................................................................................................................12-32

UPC E Settings...............................................................................................................................12-35

UPC/EAN Shared Settings.............................................................................................................12-38

Codabar Settings............................................................................................................................12-41

Code 93 Settings............................................................................................................................12-44

Code 1 1 Settings............................................................................................................................12-46

Interleaved 2 of 5 Settings..............................................................................................................12-48

MSI Plessey Settings .....................................................................................................................12-51

Matrix 2 of 5 Settings......................................................................................................................12-53

Discrete 2 of 5 Settings..................................................................................................................12-55

IATA 2 of 5 Settings........................................................................................................................12-57

Telepen Settings.............................................................................................................................12-58

RSS Code Settings & GS1 DataBar Settings................................................................................12-59

PosiCode Settings..........................................................................................................................12-62

Composite Codes...........................................................................................................................12-63

TLC-39 Settings..............................................................................................................................12-65

PDF417 Settings............................................................................................................................12-66

Micro PDF-417 Settings.................................................................................................................12-68

Macro PDF417...............................................................................................................................12-70

Macro Micro PDF417 .....................................................................................................................12-70

Code 16K Settings .........................................................................................................................12-71

Code 49 Settings............................................................................................................................12-71

Codablock Settings ........................................................................................................................12-72

2D Data Matrix Settings .................................................................................................................12-73

2D QR Code Settings.....................................................................................................................12-74

2D MaxiCode Settings....................................................................................................................12-75

2D Aztec Settings...........................................................................................................................12-77

Postal - PlaNET Settings................................................................................................................12-78

Postal - PostNET Settings..............................................................................................................12-79

Postal - Australian Settings............................................................................................................12-80

Postal - Canadian Settings.............................................................................................................12-81

Postal - Japanese Settings.............................................................................................................12-82

Postal - Kix Settings .......................................................................................................................12-83

Postal - Korean Settings.................................................................................................................12-84

Postal - Royal Settings...................................................................................................................12-85

Postal - China Settings...................................................................................................................12-86

Reading Bar Codes.........................................................................................................................12-88

Initiating a Bar Code Scan..............................................................................................................12-88

Controlling a Bar Code Scan..........................................................................................................12-88

Scanner Events............................................................................................................................... 12-90

Chapter 13: Audio

Sound Hardware.............................................................................................................................13-3

Playing Beeps Using the Mobile Devices SDK...............................................................................13-3

xii Mobile Devices Developers Guide

Playing WAV Audio Format Files Using the Mobile Devices SDK.................................................. 13-4

Getting Started with the Beeper and WAV Files ............................................................................. 13-4

Code Samples for the Beeper and WAV Files................................................................................ 13-5

Sound API Elements.......................................................................................................................13-5

Microphone..................................................................................................................................... 13-5

Audio Input...................................................................................................................................... 13-6

Muting the Microphone During Voice Telephone Calls ..................................................................13-6

Controlling Microphone Gain..........................................................................................................13-6

Audio Input API Elements............................................................................................................... 13-6

Chapter 14: System Information

System Information......................................................................................................................... 14-3

Machine Type .................................................................................................................................14-3

Model.............................................................................................................................................. 14-3

Unique Machine Identifier............................................................................................................... 14-4

Psion Build Codes ..........................................................................................................................14-4

Psion Version Numbers.................................................................................................................. 14-4

Setting the Ratio of Program Memory to Storage Memory............................................................. 14-5

Getting Started with System Information........................................................................................ 14-5

Code Samples for System Information........................................................................................... 14-5

System Information API Elements.................................................................................................. 14-6

Chapter 15: Windows Shell

Windows Shell................................................................................................................................ 15-3

Setting Windows Security...............................................................................................................15-3

Enabling and Disabling the Windows Shell .................................................................................... 15-3

Security Level Change Event .........................................................................................................15-4

System Security API Elements....................................................................................................... 15-4

Chapter 16: Trigger Control

Overview......................................................................................................................................... 16-3

Definition Of Terms ......................................................................................................................... 16-3

Trigger Consumer Registration.......................................................................................................16-3

Trigger Source IDs..........................................................................................................................16-3

Virtual Key Codes...........................................................................................................................16-4

Trigger Associations....................................................................................................................... 16-4

Trigger Control Flags......................................................................................................................16-4

Double-Clicks..................................................................................................................................16-5

Events............................................................................................................................................. 16-5

Simulated Events............................................................................................................................16-6

Single-Click Events and Double-Click Events................................................................................16-6

Getting Started with Trigger Control................................................................................................ 16-6

Code Samples for Trigger Control.................................................................................................. 16-6

Trigger Control API Elements......................................................................................................... 16-7

Table of Contents xiii

Chapter 17: Wireless Local-Area Networking

Wireless Local-Area Networking (WLAN)....................................................................................... 17-3

Supplicants ..................................................................................................................................... 17-3

Namespaces...................................................................................................................................17-4

Configuring WLAN Radios..............................................................................................................17-5

Authentication Modes .....................................................................................................................17-6

Extensible Authentication Protocol (EAP).......................................................................................17-6

Extensible Authentication Protocol (EAP) Modes..........................................................................17-6

EAP Authentication - Certificates And Passwords.........................................................................17-7

Encryption for Data Transmission...................................................................................................17-8

Wired Equivalent Privacy (WEP) Keys ..........................................................................................17-8

Encryption Modes...........................................................................................................................17-8

Using WLANEx to Obtain Network Information ..............................................................................17-8

Summit Radio Features..................................................................................................................17-9

Configuring WLAN Through the User Interface..............................................................................17-9

Ad hoc Networks.............................................................................................................................17-10

Getting Started................................................................................................................................17-10

Code Samples ................................................................................................................................ 17-11

WLAN API Elements.......................................................................................................................17-11

Chapter 18: Wireless Wide-Area Networking

Wireless Wide-Area Networking (WWAN)...................................................................................... 18-3

WWAN on Devices Supported by the Mobile Devices SDK ...........................................................18-3

WWAN on Devices not Supported by the Mobile Devices SDK..................................................... 18-4

Supported WWAN Modems............................................................................................................18-4

Multiplexing.....................................................................................................................................18-5

Virtual Serial Port............................................................................................................................18-5

Using the Virtual Serial Port................................................................................................ 18-5

Configuration.......................................................................................................................18-5

AT Commands ....................................................................................................................18-5

Entering AT Commands in Windows CE.............................................................................18-6

Dial-up Data Connections ..............................................................................................................18-6

Dial-up Data in GSM Networks........................................................................................... 18-6

Dial-up Data in UMTS Networks......................................................................................... 18-7

Dial-up Data in CDMA Networks.........................................................................................18-7

Dial-up Data in iDEN Networks........................................................................................... 18-7

Packet Data....................................................................................................................................18-7

Summary Of Modem Differences...................................................................................................18-8

GSM Power Driver .........................................................................................................................18-8

Initializing WWAN ........................................................................................................................... 18-9

Checking the Initialization Status of the WWAN Driver..................................................................18-9

WWAN Driver Status Flags ............................................................................................................18-9

Initializing the WWAN Driver..........................................................................................................18-1 1

Closing WWAN...............................................................................................................................18-15

Connecting to the Internet............................................................................................................... 18-15

Windows Embedded CE 5.0, Windows Embedded CE 6.0, Windows Mobile 2003 SE,

and Windows CE .NET 4.2 ............................................................................................................18-16

xiv Mobile Devices Developers Guide

Windows Mobile and Windows Embedded Hand-Held.................................................................18-18

Disconnecting from Connection Manager........................................................................... 18-19

The DbGprs.csv File.......................................................................................................................18-19

Checking Packet Data S t atus.........................................................................................................18-19

Roaming .........................................................................................................................................18-20

Connecting Manually to a WWAN Network....................................................................................18-20

Selecting an Access Point Name (APN)........................................................................................18-20

Connecting to a VPN......................................................................................................................18-21

Access Flags ..................................................................................................................................18-21

Controlling the Interaction with the GUI .........................................................................................18-22

RSSI (Received Signal Strength Indicator)..................................................................................... 18-23

WWAN API Elements..................................................................................................................... 18-24

Using SMS (Short Message Service)............................................................................................. 18-24

SMS API Elements.........................................................................................................................18-25

WWAN Supplementary Services....................................................................................................18-25

Voice Service States.......................................................................................................................18-25

Voice Calls on a WWAN ................................................................................................................. 18-26

Initializing WWAN...........................................................................................................................18-26

Initializing Voice Over WWAN ........................................................................................................18-26

Closing Voice Over WWAN............................................................................................................18-28

Making a Phone Call ......................................................................................................................18-29

Voice Call States.............................................................................................................................18-30

Receiving a Phone Call..................................................................................................................18-32

Processing Voice Calls...................................................................................................................18-33

Terminating Voice Calls..................................................................................................................18-34

Call Forwarding...............................................................................................................................18-35

Dual-Tone Multifrequency (DTMF).................................................................................................18-35

Blocking Inbound and Outbound Calls...........................................................................................18-35

Blocking Caller ID on Outgoing Calls.............................................................................................18-36

Audio for Voice Over WWAN..........................................................................................................18-36

Voice Over WWAN Events............................................................................................................18-37

Voice Call Status Changed Event...................................................................................... 18-37

Voice Call Manager Incoming Call Event............................................................................ 18-37

Voice Over WWAN API Elements..................................................................................................18-37

Phone Books .................................................................................................................................. 18-37

Data Coding Schemes for Phone Book Entries.............................................................................18-38

Phone Book Types.........................................................................................................................18-39

Phone Book API Elements.............................................................................................................18-40

Resource Materials......................................................................................................................... 18-40

Chapter 19: Registry-based WWAN API

Overview......................................................................................................................................... 19-3

Phone State Registry Settings........................................................................................................ 19-3

General St atus................................................................................................................................19-3

Phone St ate Bitmask in Numerical Order.......................................................................................19-5

Table of Contents xv

Network St atus...............................................................................................................................19-6

Packet Data S t atus.........................................................................................................................19-6

Voice Call Status.............................................................................................................................19-7

Phone State Registry Settings in Alphabetical Order......................................................................19-8

System Properties Registry Settings .............................................................................................. 19-9

Sample Source Code......................................................................................................................19-9

Chapter 20: GPS

Support for GPS on Psion Computers............................................................................................ 20-3

Built-in GPS....................................................................................................................................20-3

End-cap GPS..................................................................................................................................20-3

External GPS..................................................................................................................................20-3

Mobile Devices SDK Support for GPS............................................................................................ 20-3

GPS Configuration.......................................................................................................................... 20-4

Processing GPS Data.....................................................................................................................20-4

Getting Started with GPS................................................................................................................20-4

Code Samples for GPS................................................................................................................... 20-5

GPS API Elements.......................................................................................................................... 20-5

Chapter 21: Sensors

Introduction..................................................................................................................................... 21-3

Accelerometer.................................................................................................................................21-3

Getting Started with the Accelerometer..........................................................................................21-3

Code Samples for the Accelerometer............................................................................................21-3

Accelerometer API Elements.........................................................................................................21-3

Gyroscope....................................................................................................................................... 21-4

Getting Started with the Gyroscope...............................................................................................21-4

Code Samples for the Gyroscope..................................................................................................21-4

Gyroscope API Elements...............................................................................................................21-4

Digital Compass (Magnetometer)...................................................................................................21-4

Getting Started with the Magnetometer.........................................................................................21-5

Code Samples for the Magnetometer............................................................................................21-5

Magnetometer API Elements.........................................................................................................21-5

Light Sensor....................................................................................................................................21-5

Getting Started with the Light Sensor.............................................................................................21-5

Code Samples for the Light Sensor...............................................................................................21-6

Light Sensor API Elements ............................................................................................................21-6

Proximity Sensor.............................................................................................................................21-6

Getting Started with the Proximity Sensor ......................................................................................21-7

Code Samples for the Proximity Sensor........................................................................................21-7

Proximity Sensor API Elements.....................................................................................................21-7

xvi Mobile Devices Developers Guide

Chapter 22: Other Features

Vibration.......................................................................................................................................... 22-3

Getting Started................................................................................................................................22-3

Code Samples................................................................................................................................22-3

Vibration API Elements...................................................................................................................22-3

Disabling Modules and Components on the EP10......................................................................... 22-3

PsionVU.......................................................................................................................................... 22-4

Availability of PsionVU....................................................................................................................22-4

Downloading PsionVU Settings with Total Recall..........................................................................22-4

Downloading only PsionVU Settings..............................................................................................22-4

Appendices

Appendix A: Resources

Manuals and URLs......................................................................................................................... A-1

Appendix B: Registry Keys

Workabout Pro Registry Keys......................................................................................................... B-1

Registry Settings For Serial Ports.............................................................................................B-2

Registry Settings For Psion Device Drivers.............................................................................. B-2

Registry Settings For Non-Psion Device Drivers...................................................................... B-3

Index........................................ ................................................................. .. Index-1

ABOUT THIS GUIDE

About this Guide..............................................xix

Text Conventions.............................................xx

Command Syntax........................................xxi

Non-Psion Computers ..........................................xxi

Other Documentation for Application Development...........................xxi

About this Guide

This manual provides guidance on creating applications for devices running Microsoft Windows® CE, or Windows Mobile, operating systems.

Chapter 1: Backlight

describes how to control the backlights on Psion computers.

Chapter 2: Batteries and Power Management

describes how to control battery and external power supplies.

Chapter 3: Reset

describes how to reset Psion computers.

Chapter 4: Display

describes the processes for obtaining display screen information.

Chapter 5: Indicators

About this Guide xix

describes how to manipulate the LEDs.

Chapter 6: Keyboard and Keyboard Remapping

describes how to disable the keyboard and how to remap scan codes.

Chapter 7: Peripherals

describes how to detect and control tether ports and docking stations.

Chapter 8: Card Slots

describes how to control the power to card slots.

Chapter 9: Serial Ports

describes how to detect serial ports and serial port change events .

Chapter 10: Permanent Storage

describes how to access and use permanent storage.

Chapter 11: RAS (Remote Access Service)

describes how to use the Remote Access Service (RAS).

Chapter 12: Scanners

describes the configuration of scanners and bar code symbologies.

Chapter 13: Audio

describes how to control the beeper and how to play WAV files.

Chapter 14: System Information

describes how to control the Windows security and how to obtain hardware and software information.

xx Mobile Devices Developers Guide

Chapter 15: Windows Shell

describes how to set security levels and control access to the Windows shell.

Chapter 16: Trigger Control

describes how to control the trigger sources on a Psion computer.

Chapter 17: Wireless Local-Area Networking

describes how to implement WLAN.

Chapter 18: Wireless Wide-Area Networking

describes how to implement WWAN.

Chapter 19: Registry-based WWAN API

describes how to query properties of thr WWAN modem and WWAN network.

Chapter 20: GPS

describes how use the GPS.

Chapter 21: Sensors

describes how to use the built-in sensors.

Chapter 22: Other Features

describes the vibration feature and PsionVU.

Appendix A: Resources

lists other documents and web sites where you can find information related to developing with the Mobile Devices SDK.

Appendix B: Registry Keys

lists and describes certain Workab outPro registry keys which may be useful when developing applications on Psion computers.

Text Conventions

The following conventions and syntax are follo wed thr ougho ut this documen t, with the exception of when re ferencing API commands (see Command Syntax on page xxi):

• Instructions to press specific keys on the keypad are indicated with the na me or symbol of the ke y betwee squ

are brackets.

e.g. [SPACE], [TAB], [BLUE], [A], [.], etc.

• Instructions to press buttons with dedicated functions are given with the name or function of the button in bold type. e.g. Power, Scan, etc.

• Instructions to type a specific string of text are given between quotation marks. e.g. Type “exit”, and press [ENTER].

NOTE Notes highlight additional helpful information.

IMPORTANT These statements provide important instructions or additional information that is critical

WARNING These statements provide important information that may prevent injury, damage to

An arrow next to field description information (usually in tables) indicates a recommended or suggested configuration setting.

Command Syntax

When commands are described in text the following conventions are used in the manual:

• Elements that must be typed exactly as shown in the text are in bold.

• Elements that are placeholders are in italic. The general form of a command is as follows:

About this Guide xxi

to the operation of the computer or other equipment.

the equipment, or loss of data.

sample {+r | -r} argument ... [option]

Where:

Element Meaning

sample Indicates the name of the command or utility. { } Surrounds a set of choices from which you must choose one. | Separates two mutually exclusive choices in a syntax line. Type one of these choices, not

the symbol.

argument Specifies a variable name or other information that you must provide, such as a path and

file name.

... Indicates that you can type multiple arguments of the same type. Type only the

information, not the ellipsis (…).

[ ] Indicates one or more optional items. Type only the information within the brackets, not the

brackets themselves.

Non-Psion Computers

The Mobile Devices SDK cannot be used on computers other than those made by Psion. Attempts to load a Psion DLL file on a non-Psion computer fail with an error message.

CHAPTER 1 BACKLIGHT

BACKLIGHT 1

Backlighting................................................1-3

Omnii and EP10.........................................1-3

Thresholds............................................1-3

Timeouts.............................................1-3

Backlight Configuration Parameters...................................1-5

Mobile Devices SDK Version 5.4 and Later ..........................1-6

Mobile Devices SDK Version 5.3 and Earlier.........................1-6

Getting Started with Backlights.....................................1-10

Code Samples for Backlights......................................1-10

Backlight API Elements.........................................1-10

Backlighting

Full intensity

(on-time)

Half intensity

(dim-time)

Off

Last device activity

Time

The Mobile Devices SDK provides functions that control the display and keyboard backlights. The intensity of the backlight and the conditions under which it is activated can be queried and set using the SDK.

To conserve battery power, you can configure the backlights to switch off, or dim to half intensity, after the computer has been inactive for a selected length of time. The following diagram shows how these times are related:

Backlight 1 - 3

The last device activity is one of the following:

• A key is pressed on the keyboard.

• The touchscreen is pressed.

• The scanner trigger is pressed.

• Data is received from the host. If the computer is operating with external power, you can configure the backlights to remain on at all times.

Omnii and EP10

These computers have light sensors. For information see Light Sensor on page 21-5.

Thresholds

On computers with ambient light sensors, the re is a thre sh old valu e that sp ecifies the light level at which the backlights will turn on. The values for the display and keyboard backlight thresholds are configured independently.

Threshold values are integers between 0 (zero) and 100. A value of 0 ensures that the selected backlight is always off. A value of 100 ensures that the backlight can turn on at all lighting levels. Intermediate values control the level of ambient light at which the backlight turns on. The lower the value, the darker it must be before the keyboard backlight can turn on. Regardless of the thr eshold settings, the backlig ht s only come on if there is activity to trigger it, such as a keyboard, or a touch screen, event.

Timeouts

Using the Mobile Devices SDK, the backlight on-times and dim-times can be set to any positive integer within the range of the parameter (typically 0 to 2147483647, measured in milliseconds). However, when setting the values using the GUI, the choices are limited to sever al pr ed e ter m ine d value s pr es en te d in a dr op -d o wn list.

If a backlight timeout is set to one of the selectable values shown in the list, then the GUI applet displays the correct value for that timeout. On the other hand if a backlight timeout is set, using the Mobile Devices SDK, to

1 - 4 Mobile Devices Developers Guide

a value that is not on the list of selectable values, then the GUI applet displays an empty box for that timeout setting.

For all computers that have backlights, the following tables list the on-time, and dim-time, values that are available in the GUI.

Windows CE-based computers

On Windows CE-based computers, the Display, and Keyboard, Backlight On-time values determine how long the display and keyboard backlights remain on. An y user interaction (key press, touch scree n press, scan, etc.) resets both timeout counters back to the beginning. If there has been no user interaction by the end of the keyboard on-time duration, the keyboard backlight turns off. At the end of the display on-time duration, the display backlight dims to half intensity. If there is still no user interaction by the end of the display dim-time duration, then the display backlight turns off completely.

Display

Time (milliseconds)

0 No Ye s No 5000 Yes Ye s Yes 10000 Yes Ye s Yes 15000 Yes Ye s Yes 30000 Yes Ye s Yes 60000 Yes Ye s Yes 120000 Yes Ye s Yes 180000 No No No 240000 No No No 300000 Yes Ye s Yes 360000 No No No 420000 No No No 480000 No No No

Backlight On-time

Display Backlight Dim-time

Keyboard Backlight On-time

540000 No No No 600000 No No No 2147483647 (Always On, maximum value) Ye s No Ye s

Windows Mobile-based computers

On Windows Mobile-based Psion computers, the display, and keyboard, backlight timeouts are not controlled independently: Both are controlled by a single timeout value. However, there are still two timeout values which may be set; one for when the computer is running on battery power, and on e for wh en it is connected to a constant external power source.

Backlight 1 - 5

Time (milliseconds)

0 No No 5000 No No 10000 Yes No 15000 No No 30000 Yes No 60000 Yes Ye s 120000 Yes Ye s 180000 Yes Ye s 240000 Yes Ye s 300000 Yes Ye s 360000 No Ye s 420000 No Ye s 480000 No Ye s

Battery Power Backlight On-time

External Power Backlight On-time

540000 No Ye s 600000 No Ye s 2147483647 (Always On, maximum

value)

The setting for Always On is controlled by a checkbox that enables/disables the On-time parameter. If the

checkbox is disabled, the On-time value is ignored and the backlight remains on.

Backlight Configuration Parameters

The following universal methods are available in all development languages for getting and setting backlight configuration values—see the API Reference Manuals for the name of the method in each development environment:

• Get a boolean setting.

• Get an integer setting

• Set a boolean setting.

• Set an integer setting

1 - 6 Mobile Devices Developers Guide

Mobile Devices SDK Version 5.4 and Later

For all computers the following apply:

Parameter Range Of Values Default Value

Display threshold (% of maximum)

Display intensity (% of maximum)

Display timeout (% of maximum)

Display dimtime (% of maximum)

Display always on for external power (boolean)

Keyboard threshold (% of maximum)

Keyboard intensity (% of maximum)

Keyboard timeout (ms) 0 to 100 50 Keyboard dimtime

(% of maximum) Keyboard always on for

external power (boolean)

0 to 100 50

True / False True

0 to 100 50

True / False False

Mobile Devices SDK Version 5.3 and Earlier

The following table lists the ranges of values and the default values available for each Psion computer:

Parameter Computer Range Of Values Default Value

Display threshold (%) 753x 0 to 100 71

8515 N/A 8525/8530 N/A Ikôn Windows CE N/A Ikôn Windows Mobile N/A NEO N/A Workabout Pro Windows CE N/A Workabout Pro Windows Mobile

2003 SE

Display intensity 753x 0 to 100 80

N/A

+ 310 hidden pages