C API Spec: Difference between revisions
No edit summary |
|||
| (5 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
== API Overview== | == API Overview== | ||
This article introduces C API. The C API is the underlying API, which is provided by the POS driver. We package all the API implementations in a so file called "libwizarposDriver.so". | This article introduces C API. The C API is the underlying API, which is provided by the POS driver. We package all the API implementations in a so file called "libwizarposDriver.so". | ||
The third party application should load the so file and then call the API in its C source code according to the corresponding header file. Here is the [ | The third party application should load the so file and then call the API in its C source code according to the corresponding header file. Here is the [http://ftp.wizarpos.com/device/c/apidemo_c_1.5.0.zip API demo], which contains all the JNI source code of the device. | ||
=== [[API|Printer]] === | === [[API|Printer]] === | ||
Introduce the [[API]] of the printer device. The head file is [ | Introduce the [[API]] of the printer device. The head file is [http://ftp.wizarpos.com/device/c/printer_interface.h printer_interface.h]. The POS printer can use [[ESC Commands]] to print text and pictures. | ||
=== [[Contactless API|Contactless Reader]] === | === [[Contactless API|Contactless Reader]] === | ||
Introduce the [[Contactless API| API]] of the contactless reader device. The head file is [ | Introduce the [[Contactless API| API]] of the contactless reader device. The head file is [http://ftp.wizarpos.com/device/c/contactless_card_interface.h contactless_card_interface.h]. The contactless card reader supports CPU card, Mifare card, E-Wallet card, and some card simulation, such as Apple Pay. | ||
=== [[CashDrawer API|Cash Drawer]] === | === [[CashDrawer API|Cash Drawer]] === | ||
Introduce the [[CashDrawer API|API]] of cash drawer device. The head file is [ | Introduce the [[CashDrawer API|API]] of cash drawer device. The head file is [http://ftp.wizarpos.com/device/c/moneybox_interface.h moneybox_interface.h]. | ||
=== [[FingerPrint API|Fingerprint]] === | === [[FingerPrint API|Fingerprint]] === | ||
Introduce the [[FingerPrint API|API]] of the fingerprinter device. The head file is [ | Introduce the [[FingerPrint API|API]] of the fingerprinter device. The head file is [http://ftp.wizarpos.com/device/c/fingerprint_interface.h fingerprint_interface.h]. | ||
=== [[LED API|LED]] === | === [[LED API|LED]] === | ||
Introduce the [[LED API|API]] of the LED device. The head file is [ | Introduce the [[LED API|API]] of the LED device. The head file is [http://ftp.wizarpos.com/device/c/led_service_interface.h led_service_interface.h]. | ||
=== [[MSR API|MSR Reader]] === | === [[MSR API|MSR Reader]] === | ||
Introduce the [[MSR API|API]] of the MSR reader device. The head file is [ | Introduce the [[MSR API|API]] of the MSR reader device. The head file is [http://ftp.wizarpos.com/device/c/msr_interface.h msr_interface.h]. | ||
=== [[PINPAD API|PINPAD]] === | === [[PINPAD API|PINPAD]] === | ||
Introduce the [[PINPAD API|API]] of the PINPAD device. The head file is [ | Introduce the [[PINPAD API|API]] of the PINPAD device. The head file is [http://ftp.wizarpos.com/device/c/pinpad_interface.h pinpad_interface.h]. | ||
=== [[Secondary display API| | === [[Secondary display API|Secondary Display]] === | ||
Introduce the [[Secondary display API|API]] | Introduce the [[Secondary display API|API]] of secondary display device. The head file is [http://ftp.wizarpos.com/device/c/customer_display_interface.h customer_display_interface.h]. | ||
=== [[Serial port API|Serial Port]] === | === [[Serial port API|Serial Port]] === | ||
Introduce the [[Serial port API|API]] of the serial port device.The head file is [ | Introduce the [[Serial port API|API]] of the serial port device. The head file is [http://ftp.wizarpos.com/device/c/serial_port_interface.h serial_port_interface.h]. | ||
=== [[Smart Card API|Smart Card reader]] === | === [[Smart Card API|Smart Card reader]] === | ||
Introduce the [[Smart Card API|API]] of the smart card reader device. The smart card reader supports IC card | Introduce the [[Smart Card API|API]] of the smart card reader device. The smart card reader supports IC card and PSAM card. The head file is [http://ftp.wizarpos.com/device/c/smart_card_interface.h smart_card_interface.h]. | ||
Latest revision as of 03:12, 22 April 2021
API Overview
This article introduces C API. The C API is the underlying API, which is provided by the POS driver. We package all the API implementations in a so file called "libwizarposDriver.so". The third party application should load the so file and then call the API in its C source code according to the corresponding header file. Here is the API demo, which contains all the JNI source code of the device.
Printer
Introduce the API of the printer device. The head file is printer_interface.h. The POS printer can use ESC Commands to print text and pictures.
Contactless Reader
Introduce the API of the contactless reader device. The head file is contactless_card_interface.h. The contactless card reader supports CPU card, Mifare card, E-Wallet card, and some card simulation, such as Apple Pay.
Cash Drawer
Introduce the API of cash drawer device. The head file is moneybox_interface.h.
Fingerprint
Introduce the API of the fingerprinter device. The head file is fingerprint_interface.h.
LED
Introduce the API of the LED device. The head file is led_service_interface.h.
MSR Reader
Introduce the API of the MSR reader device. The head file is msr_interface.h.
PINPAD
Introduce the API of the PINPAD device. The head file is pinpad_interface.h.
Secondary Display
Introduce the API of secondary display device. The head file is customer_display_interface.h.
Serial Port
Introduce the API of the serial port device. The head file is serial_port_interface.h.
Smart Card reader
Introduce the API of the smart card reader device. The smart card reader supports IC card and PSAM card. The head file is smart_card_interface.h.