C API Spec: Difference between revisions

From wizarPOS
No edit summary
No edit summary
Line 1: Line 1:
== API Overview==
== API Overview==
   This document provides an introduction to the C APIs. C API is the lowest API, it is provided by the POS driver, packags all the API implement in a so file, named "libwizarposDriver.so".
   This document provides an introduction to the C APIs. C API is the lowest API, it is provided by the POS driver, packages all the API implement in a so file, named "libwizarposDriver.so".
   The third-party app should open this so file then call this API in its' C source code according as the corresponding head file. Here get the [ftp://sdkuser:wizsdkar@ftp.wizarpos.com/device/c/apidemo_c_1.5.0.zip api demo], it includes all the device jni source code.
   The third-party app should open this so file then call this API in its' C source code according as the corresponding head file. Here get the [ftp://sdkuser:wizsdkar@ftp.wizarpos.com/device/c/apidemo_c_1.5.0.zip API demo], it includes all the device JNI source code.
=== [[API|Print]] ===  
=== [[API|Print]] ===  
   Introduces the [[API]] of the printer device. The head file name is [ftp://sdkuser:wizsdkar@ftp.wizarpos.com/device/c/printer_interface.h printer_interface.h]. The POS printer device can print text, picture and [[ESC Commands]].
   Introduces the [[API]] of the printer device. The head file name is [ftp://sdkuser:wizsdkar@ftp.wizarpos.com/device/c/printer_interface.h printer_interface.h]. The POS printer device can print text, picture and [[ESC Commands]].
Line 9: Line 9:


=== [[CashDrawer API|Cash Drawer]] ===
=== [[CashDrawer API|Cash Drawer]] ===
   Introduces the [[CashDrawer API|API]] about hwo to interaction with the external cash Drawder device. The head file name is [ftp://sdkuser:wizsdkar@ftp.wizarpos.com/device/c/moneybox_interface.h moneybox_interface.h].
   Introduces the [[CashDrawer API|API]] about how to interaction with the external cash Drawer device. The head file name is [ftp://sdkuser:wizsdkar@ftp.wizarpos.com/device/c/moneybox_interface.h moneybox_interface.h].


=== [[FingerPrint API|Fingerprint]] ===
=== [[FingerPrint API|Fingerprint]] ===
Line 24: Line 24:


=== [[Secondary display API|Second Display]] ===
=== [[Secondary display API|Second Display]] ===
  Introduces the [[Secondary display API|API]] about hwo to interaction with the external secondary display device. The head file name is [ftp://sdkuser:wizsdkar@ftp.wizarpos.com/device/c/customer_display_interface.h customer_display_interface.h].
  Introduces the [[Secondary display API|API]] about how to interaction with the external secondary display device. The head file name is [ftp://sdkuser:wizsdkar@ftp.wizarpos.com/device/c/customer_display_interface.h customer_display_interface.h].


=== [[Serial port API|Serial Port]] ===
=== [[Serial port API|Serial Port]] ===

Revision as of 03:12, 11 March 2019

API Overview

 This document provides an introduction to the C APIs. C API is the lowest API, it is provided by the POS driver, packages all the API implement in a so file, named "libwizarposDriver.so".
 The third-party app should open this so file then call this API in its' C source code according as the corresponding head file. Here get the API demo, it includes all the device JNI source code.

Print

 Introduces the API of the printer device. The head file name is printer_interface.h. The POS printer device can print text, picture and ESC Commands.

Contactless Reader

 Introduces the  API of the contactless reader device. The head file name is contactless_card_interface.h. The contactless reader supports CPU Card, Mifare Card, E-Wallet Card, and also it can support some card emulation, includes Apply Pay.

Cash Drawer

 Introduces the API about how to interaction with the external cash Drawer device. The head file name is moneybox_interface.h.

Fingerprint

 Introduces the API of the fingerprinter device. The head file name is fingerprint_interface.h.

LED

Introduces the API of the LED device. The head file name is led_service_interface.h.

MSR Reader

 Introduces the API of the MSR reader device. The head file name is msr_interface.h.

PINPAD

 Introduces the API of the PINPAD device. The head file name is pinpad_interface.h.

Second Display

Introduces the API about how to interaction with the external secondary display device. The head file name is customer_display_interface.h.

Serial Port

Introduces the API of the serial port device.The head file name is serial_port_interface.h.

Smart Card reader

 Introduces the API of the smart card reader device. The smart card reader supports IC card, PSAM card.The head file name is smart_card_interface.h.