Eurotech Zypad WL15 Series Programmer's Reference Manual

Wearable computer
Hide thumbs Also See for Zypad WL15 Series:
Table of Contents

Advertisement

Quick Links

PROGRAMMER REFERENCE
Zypad WL15xx
Wearable Computer
Rev 2 – April 2012 – 110125-00022
www.eurotech.com

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Zypad WL15 Series and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for Eurotech Zypad WL15 Series

  • Page 1 PROGRAMMER REFERENCE Zypad WL15xx Wearable Computer Rev 2 – April 2012 – 110125-00022 www.eurotech.com...
  • Page 2: Disclaimer

    Eurotech reserves the right to make changes in specifications and other information contained within this document without prior notice, and the reader should in all cases consult Eurotech to determine whether any such changes have been made. The information in this publication does not represent a commitment on the part of Eurotech.
  • Page 3: Table Of Contents

    Table of Contents Table of Contents Disclaimer............................... 2 Trademarks ..............................2 Document Revision History ..........................2 Table of Contents ............................3 Introduction ..............................6 Related Documents ............................6 About Your System ............................7 System Block Diagram ........................... 7 Hardware Features ............................8 Processor ..............................
  • Page 4 Zypad WL15xx - Programmer Reference ZYPAD_Accelerometer_Enable ......................18 ZYPAD_Accelerometer_Calibrate ......................18 ZYPAD_GetAccelerometerAngle ......................19 ZYPAD_Accelerometer_GetData8 ......................19 ZYPAD_Accelerometer_GetData10 ....................... 19 Backlight ............................... 20 Registry Keys ............................20 ZYPAD_SetAccelerometerStatus ......................20 ZYPAD_GetAccelerometerStatus ......................20 ZYPAD_SetArmDownBacklightOnEnable ....................21 ZYPAD_GetArmDownBacklightOnEnable ..................... 21 Internal Barcode Reader ..........................22 Registry Keys ............................
  • Page 5 ZYPAD_SetBluetoothPower ........................47 ZYPAD_GetBluetoothPower ........................47 ZYPAD_SetBluetoothBootPower ......................47 ZYPAD_GetBluetoothBootPower ......................48 ZYPAD_SetBluetoothSleepPower ......................48 ZYPAD_GetBluetoothSleepPower ......................48 ZYPAD_StartBluetooth ........................... 48 ZYPAD_StopBluetooth ........................... 49 ZYPAD_ResetBluetooth ......................... 49 ZYPAD_GetBluetoothActive ........................49 ZYPAD_SetBluetoothUseHeadset ......................49 ZYPAD_GetBluetoothUseHeadset ......................50 Eurotech Worldwide Presence ........................51 110125-00022...
  • Page 6: Introduction

    Zypad WL15xx series using C/C++ languages. The level of content provided assumes that the developer is familiar with the Windows CE 6.0 operating system and the basics of the C/C++ languages. For information about customizing at the end-user level, see the Zypad WL15xx User Manual (Eurotech document #110125-0000).
  • Page 7: About Your System

    About Your System About Your System This section discusses several topics to familiarize you with the general system architecture and provides details about how to customize your Zypad WL15xx at the administrator/integrator level. System Block Diagram The following diagram illustrates the system organization of the Zypad WL15xx. Dotted lines indicate future options.
  • Page 8: Hardware Features

    Zypad WL15xx - Programmer Reference Hardware Features Processor ® • Marvell PXA320 processor Memory • 128 MB SDRAM • 128 MB flash memory Communications • Cellular with user accessible SIM card • GPS with integrated antenna • Bluetooth with integrated antenna •...
  • Page 9: Persistent Memory

    You can also update the system files using the application ADSImageUpdate. ADSImageUpdate performs an update to the flash memory of your target system at runtime. For full details about this application, see the ADSImageUpdate Specification (Eurotech document # 110025-1004). 110125-00022...
  • Page 10: Nk.bin

    Support Forum Topic 290. SYSLOAD.BMP SYSLOAD.BMP is the image used as the splash screen at boot. The default image is the Eurotech logo, but you can change this image for your specific application by updating the SYSLOAD.BMP file in on-board flash memory.
  • Page 11: Sysload.reg

    About Your System SYSLOAD.REG SYSLOAD.REG is a text file that contains updates to the image registry that will be applied at boot. It can define what drivers are available to the system at boot, as well as many other operational parameters. The settings in SYSLOAD.REG supersede the settings in the image registry.
  • Page 12: Development Environment

    • ActiveSync Version 4.5.0 or later Distribution You can download the latest release of the ZDK from the Eurotech support site (http://support.eurotech-inc.com/). The ZDK is distributed as wl11xx-wince600-xxx.zip where xxx indicates the version. The typical distribution includes the following files: •...
  • Page 13: Directory Structure

    After installation, the ZDK files are in the directory you selected during the installation procedure. The following table lists the contents of this directory. (To Be Determined) Table 2. Directory Structure ADSAPI The ADSAPI are a specific set of API functions common to several Eurotech products and supported by your Zypad WL15xx. These APIs called...
  • Page 14: Using The Zdk

    Zypad WL15xx - Programmer Reference Using the ZDK Functional Overview The ZDK provides a set of functions for accessing and controlling features specific to the Zypad WL15xx. These functions are grouped into the following categories: • System o System management o Registry management o Accelerometer o Barcode reader...
  • Page 15: Api Reference: System

    GPS receiver. System Management System management functions retrieve system information and perform an orderly shutdown of the system. Registry Keys [HKEY_LOCAL_MACHINE\Software\EuroTecH] "Release"="Standard" "OSVersion"=dword:060000 "FwVersion"=dword:000001 "NotSupported"=dword:0 "HwVersion"=dword:1500...
  • Page 16: Zypad_Getsysteminfo

    Return Value Returns a TRUE if the OS version was read from the registry key successfully or FALSE otherwise. Remarks Reads the registry key [HKEY_LOCAL_MACHINE\Software\EuroTecH] and writes Zypad version information to the ZYPAD_SYSTEM_INFO structure. To get extended error information, call GetLastError.
  • Page 17: Registry Management

    API Reference: System Registry Management Registry management functions operate on the internal registry. ZYPAD_EraseRegistry BOOL ZYPAD_EraseRegistry() Parameters None Return Value Returns TRUE if the registry is successfully set to be reset to the factory defaults on soft reset or FALSE otherwise. Remarks: Erases the HKEY_LOCAL_MACHINE registry.
  • Page 18: Accelerometer

    Zypad WL15xx - Programmer Reference Accelerometer Accelerometer functions set accelerometer control, calibrate the accelerometer, and read the current angle. Registry Keys [HKEY_LOCAL_MACHINE\Drivers\BuiltIn\Accelerometer] "Dll"="Accelerometer.dll" "Prefix"="ACC" "Order"=dword:8 "Index"=dword:1 ; ACC1 "Disabled"=dword:0 "ArmUpDownThreshold"=dword:30 "CalibDataSize"=dword:8 ; 8 = 8bit data,; 10 = 10bit data "ShowBuildDate"=dword:0 Type Definitions typedef struct _MMA7455L_AXIS_DATA...
  • Page 19: Zypad_Getaccelerometerangle

    API Reference: System ZYPAD_GetAccelerometerAngle BOOL ZYPAD_GetAccelerometerAngle(PCHAR pAngle) Parameters pAngle UCHAR pointer filled with current accelerometer angle Return Value Returns TRUE on success or FALSE otherwise. Remarks: Retrieves the current accelerometer x-axis angle (8-bit data) and writes the value pAngle. To get extended error information, call GetLastError. ZYPAD_Accelerometer_GetData8 BOOL ZYPAD_Accelerometer_GetData8(PUCHAR pXYZData) Parameters...
  • Page 20: Backlight

    Zypad WL15xx - Programmer Reference Backlight Additional accelerometer functions control the operation of the backlight based on the position of the user’s arm. Registry Keys [HKEY_LOCAL_MACHINE\Drivers\BuiltIn\LightControl] "Dll"="LightControl.dll" "Prefix"="BLC" "Order"=dword:9 "Index"=dword:1 ; BLC1 "ShowBuildDate"=dword:0 "KeypadBacklightDisable"=dword:0 ZYPAD_SetAccelerometerStatus BOOL ZYPAD_SetAccelerometerStatus(UCHAR Status) Parameters Status variable for accelerometer control setting Return Value Returns TRUE on success or FALSE otherwise.
  • Page 21: Zypad_Setarmdownbacklightonenable

    API Reference: System ZYPAD_SetArmDownBacklightOnEnable BOOL ZYPAD_SetArmDownBacklightOnEnable(UCHAR Status) Parameters Status variable for the arm down backlight on enable Return Value Returns TRUE on success or FALSE otherwise. Remarks Sets the operation of the backlight when the user’s arm is in the down position. The parameter Status can assume the following values: 0x00 Backlight will remain off and cannot be turned on by the touch screen when the user’s arm is down.
  • Page 22: Internal Barcode Reader

    Zypad WL15xx - Programmer Reference Internal Barcode Reader The barcode reader functions control the operation of the optional integrated bar code reader. Registry Keys [HKEY_LOCAL_MACHINE\Drivers\BuiltIn\OHCI] "InterfaceType"=dword:0 ; Internal "Prefix"="HCD" "Dll"="ohci2.dll" "Index"=dword:1 "Order"=dword:5 "Irq"=dword:3 "SysIntr"=dword:11 "MemBase"=dword:4C000000 "MemLen"=dword:1000 "UseExistingSettings"=dword:0 "StatusAtBoot"=dword:1 ; 0 = turn off, 1 = turn on "StatusInSuspend"=dword:0 ;...
  • Page 23: Zypad_Setscannerbootpower

    API Reference: System ZYPAD_SetScannerBootPower BOOL ZYPAD_SetScannerBootPower(BOOL Enable) Parameters Enable if TRUE, to turn on the internal barcode reader power at boot if FALSE, to turn off the internal barcode reader power at boot Return Value Returns TRUE on success or FALSE otherwise. Remarks Writes the registry key that controls the internal barcode reader power at system boot and commits the changes to persistent...
  • Page 24: Zypad_Getscannersleeppower

    Zypad WL15xx - Programmer Reference ZYPAD_GetScannerSleepPower BOOL ZYPAD_GetScannerSleepPower(PBOOL pEnabled) Parameters pEnabled pointer to a variable for the internal barcode reader power setting when the system is in Suspend mode Return Value Returns TRUE on success or FALSE otherwise. Remarks Reads the registry key that controls the internal barcode power when the system is in Suspend mode. This registry key is [HKEY_LOCAL_MACHINE\Drivers\\BuiltIn\\OHCI] "StatusInSuspend".
  • Page 25: Gps

    API Reference: System The GPS functions control the integrated GPS receiver. Registry Keys [HKEY_LOCAL_MACHINE\Drivers\BuiltIn\Serial2] "Order"=dword:4 "StatusAtBoot"=dword:1 ;0 = turn off, 1 = turn on "StatusInSuspend"=dword:0 ;0 = turn off, 1 = do not turn off ZYPAD_SetGpsPower BOOL ZYPAD_SetGpsPower(BOOL Enable) Parameters Enable if TRUE, to turn on the GPS receiver power if FALSE, to turn off the GPS receiver power...
  • Page 26: Zypad_Getgpsbootpower

    Zypad WL15xx - Programmer Reference ZYPAD_GetGpsBootPower BOOL WL1100_GetGpsBootStatus(PBOOL pEnabled) Parameters pEnabled pointer to a variable for the GPS receiver power setting when the system boots Return Value Returns TRUE on success or FALSE otherwise. Remarks Reads the registry key that controls the GPS receiver power at system boot. This registry key is [HKEY_LOCAL_MACHINE\Drivers\\BuiltIn\\Serial2] "StatusAtBoot".
  • Page 27: Api Reference: User Interface

    API Reference: User Interface API Reference: User Interface User interface functions control operations related to the keypad, display, and audio interface of the system. Keypad Using the keypad functions, you can configure the keypad buttons for your specific application. Each button can be associated with a particular key of a standard keyboard.
  • Page 28: Display And Backlight Brightness

    Zypad WL15xx - Programmer Reference Display and Backlight Brightness The display functions manage the display and the keypad backlight. An application can read the backlight attribute and use these levels to adjust the backlight. In addition, it is possible to automatically set the brightness depending on the ambient light.
  • Page 29: Zypad_Setbrightnesscontrol

    API Reference: User Interface ZYPAD_SetBrightnessControl BOOL ZYPAD_SetBrightnessControl(UCHAR Control) Parameters Control variable for control setting of display and keypad brightness Return Value Returns TRUE on success or FALSE otherwise. Remarks Sets the control of the display and keypad brightness. The parameter Control can assume the following values: 0x00 Display/keypad brightness must be set using the functions ZYPAD_SetDisplayBrightness and ZYPAD_SetKeyboardBrightness...
  • Page 30: Zypad_Getdisplaybrightness

    Zypad WL15xx - Programmer Reference ZYPAD_GetDisplayBrightness BOOL ZYPAD_GetDisplayBrightness(PUCHAR pBrightness) Parameters pBrightness pointer to a variable for the current display brightness setting Return Value Returns TRUE on success or FALSE otherwise. Remarks Retrieves the current brightness setting for the display. For valid values for Brightness, see ZYPAD_SetDisplayBrightness.
  • Page 31: Audio

    API Reference: User Interface Audio Using the audio functions, you can configure the input and output audio settings. All functions described in this section, with the exceptions of ZYPAD_EnableBluetoothAG, ZYPAD_SetBluetoothAGVolume, and ZYPAD_GetBluetoothAGVolume, use the Windows CE Waveform Audio application programming interface (API).
  • Page 32: Zypad_Setaudioprofile

    Zypad WL15xx - Programmer Reference "MasterMute"=dword:0 "HeadphoneMute"=dword:0 "MonoMute"=dword:0 "LineMute"=dword:0 "MicMute"=dword:0 "PCMMute"=dword:0 "PhoneMute"=dword:0 "RecordMute"=dword:0 ZYPAD_SetAudioProfile BOOL ZYPAD_SetAudioProfile(DWORD Profile) Parameters Profile variable for the desired audio profile Return Value Returns TRUE on success or FALSE otherwise. Remarks Configures the audio inputs and outputs. The current defined profiles are: •...
  • Page 33: Zypad_Getaudioprofilecaps

    API Reference: User Interface ZYPAD_GetAudioProfileCaps BOOL ZYPAD_GetAudioProfileCaps(PDWORD pdwCaps) Parameters pdwCaps pointer to a variable for the current audio profile capabilities Return Value Returns TRUE on success or FALSE otherwise. Remarks Retrieves the current audio profile capabilities. The defined audio profile capabilities are: •...
  • Page 34: Zypad_Setaudioinmute

    Zypad WL15xx - Programmer Reference ZYPAD_SetAudioInMute BOOL ZYPAD_SetAudioInMute(DWORD dwMute) Parameters dwMute if 0 the audio input is not muted, otherwise it is muted, High_Word|Low_Word -- Left_Mute|Right_Mute Return Value Returns TRUE on success or FALSE otherwise. Remarks Sets the input path (Left/Right) mute for the current audio profile. ZYPAD_GetAudioInMute BOOL ZYPAD_GetAudioInMute(PDWORD pdwMute, BOOL bPhysical) Parameters...
  • Page 35: Zypad_Getaudioinboost

    API Reference: User Interface ZYPAD_GetAudioInBoost BOOL ZYPAD_GetAudioInBoost(PDWORD pdwBoost) Parameters pdwBoost pointer to a variable for the audio input boost setting Return Value Returns TRUE on success or FALSE otherwise. Remarks Retrieves the input (record) boost setting for the current audio profile. For valid values of the input boost settings, YPAD_SetAudioInBoost.
  • Page 36: Zypad_Setaudiooutmute

    Zypad WL15xx - Programmer Reference ZYPAD_SetAudioOutMute BOOL ZYPAD_SetAudioOutMute(DWORD dwMute) Parameters dwMute if 0 the audio output is not muted, otherwise it is muted High_Word|Low_Word -- Left_Mute|Right_Mute Return Value Returns TRUE on success or FALSE otherwise. Remarks Sets the output path (Left/Right) mute for the current audio profile. ZYPAD_GetAudioOutMute BOOL ZYPAD_GetAudioOutMute(PDWORD pdwMute, BOOL bPhysical) Parameters...
  • Page 37: Zypad_Setbluetoothagvolume

    API Reference: User Interface ZYPAD_SetBluetoothAGVolume BOOL ZYPAD_SetBluetoothAGVolume(USHORT usDevice, USHORT usVolume) Parameters usDevice if 0, to set volume setting for the microphone if 1, to set volume setting for the speaker usVolume variable for the volume setting in the range of 0 -TBD Return Value Returns TRUE on success or FALSE otherwise.
  • Page 38: Api Reference: Communication

    Zypad WL15xx - Programmer Reference API Reference: Communication Wi-Fi Configurations of the Zypad WL15xx can include an integrated wireless module. The Wi-Fi functions control operation of this module. Registry Keys [HKEY_LOCAL_MACHINE\Drivers\BuiltIn\SDHC2] "CardDetectIRQGpioPin"=dword:68 "StatusAtBoot"=dword:1 ;0 = power off at boot, 1 = power on at boot "StatusInSuspend"=dword:0 ;0 = power off during Suspend mode, ;1 = power on during Suspend mode...
  • Page 39: Zypad_Setwifibootpower

    API Reference: Communication ZYPAD_SetWiFiBootPower BOOL ZYPAD_SetWiFiBootPower(BOOL Enable) Parameters Enable if TRUE, to turn on the Wi-Fi module power at boot if FALSE, to turn off the Wi-Fi module power at boot Return Value Returns TRUE on success or FALSE otherwise. Remarks Writes the registry key that controls the Wi-Fi module power at system boot and commits the changes to persistent storage.
  • Page 40: Zypad_Getwifisleeppower

    Zypad WL15xx - Programmer Reference ZYPAD_GetWiFiSleepPower BOOL ZYPAD_GetWiFiSleepPower(PBOOL pEnabled) Parameters pEnabled pointer to a variable for the Wi-Fi module power setting when the system is in Suspend mode Return Value Returns TRUE on success or FALSE otherwise. Remarks Reads the registry key that controls the Wi-Fi module power when the system is in Suspend mode. This registry key is [HKEY_LOCAL_MACHINE\Drivers\\BuiltIn\\SDHC2] "StatusInSuspend".
  • Page 41: Zypad_Wifisimucardremove

    API Reference: Communication ZYPAD_WiFiSimuCardRemove BOOL ZYPAD_WiFiSimuCardRemove(void) Parameters none Return Value Returns TRUE on success or FALSE otherwise. Remarks Simulates card remove action. ZYPAD_WiFiSimuCardRmvIns BOOL ZYPAD_WiFiSimuCardRmvIns(void) Parameters none Return Value Returns TRUE on success or FALSE otherwise. Remarks Simulates card insert action. 110125-00022...
  • Page 42: Cellular

    Zypad WL15xx - Programmer Reference Cellular Configurations of the Zypad WL15xx can include an integrated cellular module. The cellular functions control operation of this module. Registry Keys [HKEY_LOCAL_MACHINE\Drivers\BuiltIn\Serial] "Order"=dword:4 "StatusAtBoot"=dword:1 ;0 = turn off, 1 = turn on "StatusRunning"=dword:1 ;0 = enable, 1 = disable "StatusInSuspend"=dword:0 ;0 = turn off, 1 = do not turn off [HKEY_LOCAL_MACHINE\Drivers\BuiltIn\PMZ]...
  • Page 43: Zypad_Setcellularpower

    API Reference: Communication ZYPAD_SetCellularPower BOOL ZYPAD_SetCellularPower(BOOL Enable) Parameters Enable if TRUE, to turn on the Cellular device power if FALSE, to turn off the Cellular device power Return Value Returns TRUE Remarks: Sets an event to stop or start the Cellular device during the normal system running period. ZYPAD_GetCellularPower BOOL ZYPAD_GetCellularPower(PBOOL pEnabled) Parameters...
  • Page 44: Zypad_Setcellularbootpower

    Zypad WL15xx - Programmer Reference ZYPAD_SetCellularBootPower BOOL ZYPAD_SetCellularBootPower(BOOL Enable) Parameters Enable if TRUE, to turn on the Cellular device power at boot if FALSE, to turn off the Cellular device power at boot Return Value Returns TRUE on success or FALSE otherwise. Remarks Writes the registry key that controls the Cellular device power at system boot and commits the changes to persistent...
  • Page 45: Zypad_Getcellularsleeppower

    API Reference: Communication ZYPAD_GetCellularSleepPower BOOL ZYPAD_GetCellularSleepPower(PBOOL pEnabled) Parameters pEnabled pointer to a variable for the Cellular device power setting when the system is in Suspend mode Return Value Returns TRUE on success or FALSE otherwise. Remarks Reads the registry key that controls the Cellular device power when the system is in Suspend mode. This registry key is [HKEY_LOCAL_MACHINE\Drivers\\BuiltIn\\Serial] "StatusInSuspend".
  • Page 46: Zypad_Sendcellularatcommand

    Zypad WL15xx - Programmer Reference ZYPAD_SendCellularATCommand BOOL ZYPAD_SendCellularATCommand(LPCWSTR lpszATCommand) Parameters lpszATCommand AT command string Return Value Returns TRUE on success or FALSE otherwise. Remarks: Sends the Cellular device an AT command. The Cellular device is at COM8. 110125-00022...
  • Page 47: Bluetooth

    API Reference: Communication Bluetooth Configurations of the Zypad WL15xx can include an integrated Bluetooth module. Using the Bluetooth functions, you can enable or disable the Bluetooth module at boot and during normal system operation. Registry Keys [HKEY_LOCAL_MACHINE\Drivers\BuiltIn\Serial3] "Order"=dword:4 "StatusAtBoot"=dword:1 ;0 = turn off, 1 = turn on "StatusInSuspend"=dword:0 ;0 = turn off, 1 = do not turn off "UseHeadset"=dword:0...
  • Page 48: Zypad_Getbluetoothbootpower

    Zypad WL15xx - Programmer Reference ZYPAD_GetBluetoothBootPower BOOL ZYPAD_GetBluetoothBootPower(PBOOL pEnabled) Parameters pEnabled pointer to a variable for the Bluetooth device power setting when the system boots Return Value Returns TRUE on success or FALSE otherwise. Remarks Reads the registry key that controls the Bluetooth device power at system boot. This registry key is [HKEY_LOCAL_MACHINE\Drivers\\BuiltIn\\Serial3] "StatusAtBoot".
  • Page 49: Zypad_Stopbluetooth

    API Reference: Communication ZYPAD_StopBluetooth BOOL ZYPAD_StopBluetooth(void) Parameters none Return Value Returns TRUE on success or FALSE otherwise. Remarks: Stops the Bluetooth device and turns off the Bluetooth LED. ZYPAD_ResetBluetooth BOOL ZYPAD_ResetBluetooth(void) Parameters none Return Value Returns TRUE on success or FALSE otherwise. Remarks Toggles the signal to reset the Bluetooth device.
  • Page 50: Zypad_Getbluetoothuseheadset

    Zypad WL15xx - Programmer Reference ZYPAD_GetBluetoothUseHeadset BOOL ZYPAD_GetBluetoothUseHeadset(PBOOL pEnabled) Parameters pEnabled pointer to a variable for the Bluetooth headset use setting Return Value Returns TRUE on success or FALSE otherwise. Remarks Reads the registry key that controls the setting for using a Bluetooth headset. This registry key is [HKEY_LOCAL_MACHINE\Drivers\\BuiltIn\\Serial3] "UseHeadset".
  • Page 51: Eurotech Worldwide Presence

    E-mail: support.uk@eurotech.com Web: www.eurotech.com Web: www.parvus.com Web: www.eurotech-ltd.com France DYNATEM Tel. +1 800.543.3830 EUROTECH +1 949.770.3481 Tel. +33 04.72.89.00.90 E-mail: sales@dynatem.com +33 04.78.70.08.24 E-mail: tech@dynatem.com E-mail: sales.fr@eurotech.com Web: www.dynatem.com E-mail: support.fr@eurotech.com Web: www.eurotech.com To find your nearest contact refer to: www.eurotech.com/contacts...
  • Page 52 EUROTECH HEADQUARTERS Via Fratelli Solari 3/a 33020 Amaro (Udine) – ITALY Phone: +39 0433.485.411 Fax: +39 0433.485.499 For full contact details go to: www.eurotech.com/contacts...

Table of Contents