User manual

ManualsBrandsElo TouchSystems ManualsOtherGraphics Tablet ES601068 Rev A

API Document

Elo Touch Solutions

Elo

Tablet

ES601068 Rev A

Summary of content (23 pages)

PAGE 1
API Document Elo Touch Solutions ® Elo Tablet ES601068 Rev A
PAGE 2
Change History Rev. A Description of Change Initial Release per ECO-13-0697.
PAGE 3
Copyright © 2013 Elo Touch Solutions, Inc. All Rights Reserved. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language or computer language, in any form or by any means, including, but not limited to, electronic, magnetic, optical, chemical, manual, or otherwise without prior written permission of Elo Touch Solutions, Inc. Disclaimer The information in this document is subject to change without notice. Elo Touch Solutions, Inc.
PAGE 4
Table of Contents Introduction ...................................................................................... 5 Application Programming Interface ............................................... 6 Battery Management ............................................................. 6 MCU ...................................................................................... 9 POS Peripheral ................................................................... 10 Sensors ......................................
PAGE 5
Introduction The following Application Programming Interfaces (APIs) are used to communicate with the Elo Tablet. It will be released as Dynamic Link Library (DLL). The user of the API will need to import the DLL and call the corresponding function listed below. The APIs are classified into 5 sections: Battery Management, MCU, POS peripherals, Sensors and EEPROM. For further information on Tablet APIs, please contact an Elo Touch technical representative or customer service. Visit http://www.elotouch.
PAGE 6
Application Programming Interface Battery Management 1. EloGetBatteryStatus(unsigned char *pStatus); Description: Retrieve Battery Information OUT: 1 byte of Battery Information Bit 7 - main battery present Bit 6 - main battery charging Bit 5 - main battery discharging Bit 4 - main battery fully charged Bit 3- docking battery present Bit 2 - docking battery charging Bit 1 - docking battery discharging Bit 0 -docking battery fully charge Successful Return value: STATUS_OK (0) 2.
PAGE 7
Description: Retrieve current battery charging Strength Percentage IN: BATTERY_LOCATION: 0 Tablet Battery 1 Docking Battery OUT: 0 – 100 percent Successful Return value: STATUS_OK (0) 4. EloGetBatteryChargingThreshold(BATTERY_LOCATION location, unsigned char *pPerCent); Description: Retrieve current Battery charging threshold IN: BATTERY_LOCATION: 0 Tablet Battery 1 Docking Battery OUT: 0 – 100 percent Successful Return value: STATUS_OK (0) 5.
PAGE 8
7. EloGetBatteryVoltageCurrent(BATTERY_LOCATION location, short *pVoltage, short *pCurrent); Description: Retrieve the battery voltage and current IN: BATTERY_LOCATION: 0 Tablet Battery 1 Docking Battery OUT: 0 – 65536 for Voltage, -32768 – 32767 for Current Successful Return value: STATUS_OK (0) 8.
PAGE 9
MCU 1. EloGetECVersion(unsigned int *pECVer); Description: Get Tablet EC version OUT: 2 Bytes, LSB: Version LSB, MSB: Version MSB Output format: MSB.LSB Successful Return value: STATUS_OK (0) 2. EloGetDECVersion(unsigned int *pECVer); Description: Get Docking EC version OUT: 2 Bytes, LSB: Version LSB, MSB: Version MSB Output format: MSB.LSB Successful Return value: STATUS_OK (0) 3.
PAGE 10
POS Peripheral 1. EloGetMSRControl(unsigned char *pData); Description: Get the MSR output device OUT: 0 keyboard 1 Virtual COM port Successful Return value: STATUS_OK (0) 2. EloEnableNFCDevice(unsigned char Data); Description: Turn ON/OFF the NFC device IN: 0 OFF 1 ON Successful Return value: STATUS_OK (0) 3. EloEnableSCRDevice(unsigned char Data); Description: Turn ON/OFF the NFC device IN: 0 OFF 1 ON Successful Return value: STATUS_OK (0) 4.
PAGE 11
Sensors 1. EloEnableLightSensor(unsigned char Data); Description: This API is obsolete 2. EloGetLightSensorData(unsigned int *pLightSensorData); Description: Retrieve the light sensor data OUT: raw data 0 – 65535 Successful Return value: STATUS_OK (0) 3. EloEnableAccelerometer(unsigned int enable); Description: This API is obsolete 4.
PAGE 12
Description: Set the Accelerometer sampling period IN: Raw data 0 – 255 units, 1 unit is 10ms Successful Return value: STATUS_OK (0) 7. EloGetAccelerometerGSetting(unsigned char *pData); Description: Retrieve the G setting OUT: Bit 0 and Bit 1 of the Byte pData valid 0: 2G 1: 4G 2: 8G Successful Return value: STATUS_OK (0) 8. EloSetAccelerometerGSetting(unsigned char Data); Description: Set the G setting IN: 0: 2G, 1: 4G, and 2: 8G Successful Return value: STATUS_OK (0) 9.
PAGE 13
0x02 - landscape right 0x03 - landscape left Successful Return value: STATUS_OK (0) 10. EloOnBacklight(unsigned int on); Description: This API is obsolete 11. EloGetBacklight(unsigned int *pPercentage); Description: This API is obsolete 12. EloSetBacklight(unsigned int percentage); Description: This API is obsolete 13.
PAGE 14
0: Power 2: Payment Amber 4: WiFi 6: Charge Amber 8: Payment Green 10: Charge Green 12: Bluetooth 14: LightBeam 16: Docking Power 18: Docking Charge Green 20: Docking Charge Amber 22: LAN OUT: Bit details of the pData are as following: bit 0 ~ bit 3 0 - Off 1 -blink in 200ms 2 -blin k in 500ms 3 -blink in 1s 4 -blink in 2s 5 - blink in 4s 6 - blink in 8s 7 - full on 8 - undefined 9 - fade away in step of 100ms Elo® Tablet NFC Reader Application Note ES601068 Rev A, Page 14 of 23
PAGE 15
10 - fade away in step of 200ms 11 - fade away in step of 300ms 12 - fade away in step of 400ms 13 ~ 15 - undefined bit 4 ~ bit 6 – brightness 0 - off 1 - 7 different level, 7 is the brightest Successful Return value: STATUS_OK (0) 15.
PAGE 16
OUT: Bit details of the byte are as following: bit 0 ~ bit 3 0 – Off 1 -blink in 200ms 2 -blink in 500ms 3 -blink in 1s 4 -blink in 2s 5 - blink in 4s 6 - blink in 8s 7 - full on 8 – undefined 9 - fade away in step of 100ms 10 - fade away in step of 200ms 11 - fade away in step of 300ms 12 - fade away in step of 400ms 13 ~ 15 - undefined bit 4 ~ bit 6 - brightness 0 - off 1 - 7 different level, 7 is the brightest Successful Return value: STATUS_OK (0) 16.
PAGE 17
Description: This API is obsolete. 18. EloSetCameraFlashStrength(unsigned int strength); Description: This API is obsolete. 19.
PAGE 18
EEPROM 1. EloWriteEpr(unsigned int Data); Description: Write 1 byte to 1 location of 1 specific segment IN: Byte0 of Data is segment Byte1 of Data is offset Byte2 of Data is byte of data Successful Return value: STATUS_OK (0) 2. EloPreReadEpr(unsigned short Data); Description: Tell EC the detailed EEPROM location to read data out. This API has to be called together with the following API EloReadEpr. IN: Byte0 of Data is segment Byte1 of Data is offset Successful Return value: STATUS_OK (0) 3.
PAGE 19
5. EloGetMotherBoardSerialNumber_DW1(unsigned int *pSerialNumDw1); Description: Retrieve the MotherBoard serial number higher 4 bytes. OUT: The higher 4 bytes will be saved in pSerialNumDw1. Successful Return value: STATUS_OK (0) 6. EloGetTabletSerialNumber_DW0(unsigned int *pSerialNumDw0); Description: Retrieve the Tablet serial number lower 4 bytes. OUT: The lower 4 bytes will be saved in pSerialNumDw0. Successful Return value: STATUS_OK (0) 7.
PAGE 20
Successful Return value: STATUS_OK (0) 10. EloGetUUID_DW2(unsigned int *pUUID2); Description: Retrieve UUID higher 4 bytes. OUT: The higher 4 bytes will be saved in pUUID2. Successful Return value: STATUS_OK (0) 11. EloGetUUID_DW3(unsigned int *pUUID3); Description: Retrieve UUID highest 4 bytes. OUT: The highest 4 bytes will be saved in pUUID3. Successful Return value: STATUS_OK (0) 12.
PAGE 21
IN: The data to be set Successful Return value: STATUS_OK (0) 15. EloSetTabletSerialNumber_DW1(unsigned int SerialNumDw1); Description: Set the Tablet Serial Number higher 4 bytes IN: The data to be set Successful Return value: STATUS_OK (0) 16. EloSetUUID_DW0(unsigned int UUID0); Description: Set the UUID lowest 4 bytes IN: The data to be set Successful Return value: STATUS_OK (0) 17.
PAGE 22
Description: Set the UUID highest 4 bytes IN: The data to be set Successful Return value: STATUS_OK (0) Elo® Tablet NFC Reader Application Note ES601068 Rev A, Page 22 of 23
PAGE 23
Check out Our Website www.elotouch.com Get the latest...  Product Information  Specifications  Upcoming events  Press releases  Software drivers Getting in Touch with us To find out more about the extensive range of Elo touch solutions, visit our website at www.elotouch.com, or simply call the office nearest you: North America Elo Touch Solutions 1033 McCarthy Blvd Milpitas, CA 95035 Tel 800-ELO-TOUCH Tel 1-408-597-8000 Fax 1-408-597-8050 customerservice@elotouch.