Elo TouchSystems ES601068 User Manual

API Document

Elo Touch Solutions

®

Elo

ES601068 Rev A

Tablet

Change History

Rev.

Description of Change

Release Date

Changed By

A

Initial Release per ECO-13-0697.

09/05/2013

Cherrie Soetjipto

Elo® Tablet NFC Reader Application Note

ES601068 Rev A, Page 2 of 23

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. and its affiliates
(collectively "Elo") makes no representations or warranties with respect to the contents herein, and specifically
disclaims any implied warranties of merchantability or fitness for a particular purpose. Elo reserves the right to
revise this publication and to make changes from time to time in the content hereof without obligation of Elo to

notify any person of such revisions or changes.

Trademark Acknowledgments

AccuTouch, CarrollTouch, Elo, Elo (logo), Elo Touch, Elo Touch Solutions, Elo TouchSystems, IntelliTouch, iTouch,
SecureTouch, TouchTools and VuPoint are trademarks of Elo and its affiliates. Windows is a trademark of

Microsoft Corporation.

Elo® Tablet NFC Reader Application Note

ES601068 Rev A, Page 3 of 23

Table of Contents

Introduction ...................................................................................... 5

Application Programming Interface ............................................... 6

Battery Management ............................................................. 6

MCU ...................................................................................... 9

POS Peripheral ................................................................... 10

Sensors ............................................................................... 11

EEPROM ............................................................................. 18

Elo® Tablet NFC Reader Application Note

ES601068 Rev A, Page 4 of 23

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.com/Support/TechnicalSupport/default.asp for technical support.
Refer to the last page of this user manual for Elo contact information worldwide.

Elo® Tablet NFC Reader Application Note

ES601068 Rev A, Page 5 of 23

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. EloGetBatteryCapacityPercentage(BATTERY_LOCATION location, unsigned int
*pCapacity);

Description: Retrieve current battery capacity percentage
IN: BATTERY_LOCATION: 0 Tablet Battery 1 Docking Battery
OUT: 0 – 100 percent
Successful Return value: STATUS_OK (0)

3. EloGetBatteryChargingStrength(BATTERY_LOCATION location, unsigned int *pStrength);

Elo® Tablet NFC Reader Application Note

ES601068 Rev A, Page 6 of 23

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. EloGetBatteryLifeTime(BATTERY_LOCATION location, unsigned int *pLifeTime);
Description: Retrieve current Battery Life Time
IN: BATTERY_LOCATION: 0 Tablet Battery 1 Docking Battery
OUT: 0 – 65535
Successful Return value: STATUS_OK (0)

6. EloGetBatteryRemainingLifeTime(BATTERY_LOCATION location, unsigned short
*pLifeTime);

Description: Retrieve current Battery Remaining Life Time
IN: BATTERY_LOCATION: 0 Tablet Battery 1 Docking Battery
OUT: 0 – 65535
Successful Return value: STATUS_OK (0)

Elo® Tablet NFC Reader Application Note

ES601068 Rev A, Page 7 of 23