CashDrawer API: Difference between revisions

From wizarPOS
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Interface Overview ==
== Interface Overview ==
The calling sequence is [[#open|open]]>[[#kick_out|kick_out]]>[[#close|close ]]
The calling sequence is [[#open|open]]>[[#kick_out|kick_out]]>[[#close|close ]]
=== open ===
=== <big>open</big> ===
  <syntaxhighlight lang="c">int moneybox_open()</syntaxhighlight >
  <syntaxhighlight lang="c">int moneybox_open()</syntaxhighlight >
Open the cash drawer device.
Open the cash drawer device.
This operation should be used before other operations.
This operation should be used before other operations.


{|
{|class="wizarpostable"
|-
|-
!  scope="row" colspan="2" style="text-align:left;background-color: #78909c;" width="800"| '''Returns'''
!  scope="row" colspan="2"| Returns
|-
|-
| style="text-align:left;background-color: #edf1f2; " width="100"| '''int''' || style="text-align:left;background-color: #f8f9fa;| The result code, >= 0, success; <0 [[Error_code|error code]].
| int || The result code, >= 0, success; <0 [[Error_code|error code]].
|}
|}
   
   
=== close ===
 
=== <big>close</big> ===
   <syntaxhighlight lang="c">int moneybox_close()</syntaxhighlight >
   <syntaxhighlight lang="c">int moneybox_close()</syntaxhighlight >
Close the cash drawer device.
Close the cash drawer device.
The open and close apis are pair operations. If you don’t want to use this device, you should call the close api to release this device.
The open and close API are pair operations. If you don’t want to use this device, you should call the close API to release this device.


{|
{|class="wizarpostable"
|-
|-
!  scope="row" colspan="2" style="text-align:left;background-color: #78909c;" width="800"| '''Returns'''
!  scope="row" colspan="2" | Returns
|-
|-
| style="text-align:left;background-color: #edf1f2; " width="100"| '''int''' || style="text-align:left;background-color: #f8f9fa;| The result code, >= 0, success; <0 [[Error_code|error code]].
| int || The result code, >= 0, success; <0 [[Error_code|error code]].
|}
|}
   
   
=== kick_out ===
 
=== <big>kick_out</big> ===
   <syntaxhighlight lang="c">int moneybox_ctrl()</syntaxhighlight >
   <syntaxhighlight lang="c">int moneybox_ctrl()</syntaxhighlight >
Kick out the cash drawer.
Kick out the cash drawer.


{|
{|class="wizarpostable"
|-
|-
!  scope="row" colspan="2" style="text-align:left;background-color: #78909c;" width="800"| '''Returns'''
!  scope="row" colspan="2" | Returns
|-
|-
| style="text-align:left;background-color: #edf1f2; " width="100"| '''int''' || style="text-align:left;background-color: #f8f9fa;| The result code, >= 0, success; <0 [[Error_code|error code]].
| style="text-align:left;background-color: #edf1f2; " width="100"| '''int''' || style="text-align:left;background-color: #f8f9fa;| The result code, >= 0, success; <0 [[Error_code|error code]].
|}
|}
   
   
=== setEnable ===
 
=== <big>setEnable</big> ===
   <syntaxhighlight lang="c">int moneybox_setEnable(unsigned int nEnable)</syntaxhighlight >
   <syntaxhighlight lang="c">int moneybox_setEnable(unsigned int nEnable)</syntaxhighlight >
Enable or disable hardware
Enable or disable hardware


{|
{|class="wizarpostable"
|-
|-
! scope="row" colspan="2" style="text-align:left;background-color: #78909c; " width="800"| '''Parameters'''
! scope="row" colspan="2" | Parameters
|-
|-
| style="text-align:left;background-color: #edf1f2; " width="100"| nEnable || style="text-align:left;background-color: #f8f9fa; |'''unsigned int:''' 1 - enable, 0 - disable.
| nEnable || '''unsigned int:''' 1 - enable, 0 - disable.
|}
|}
{|
{|
|-
|-
!  scope="row" colspan="2" style="text-align:left;background-color: #78909c;" width="800"| '''Returns'''
|}
{|class="wizarpostable"
|-
!  scope="row" colspan="2" | Returns
|-
|-
| style="text-align:left;background-color: #edf1f2; " width="100"| '''int''' || style="text-align:left;background-color: #f8f9fa;| The result code, >= 0, success; <0 [[Error_code|error code]].
| int || The result code, >= 0, success; <0 [[Error_code|error code]].
|}
|}

Latest revision as of 09:32, 11 March 2019

Interface Overview

The calling sequence is open>kick_out>close

open

int moneybox_open()

Open the cash drawer device. This operation should be used before other operations.

Returns
int The result code, >= 0, success; <0 error code.


close

int moneybox_close()

Close the cash drawer device. The open and close API are pair operations. If you don’t want to use this device, you should call the close API to release this device.

Returns
int The result code, >= 0, success; <0 error code.


kick_out

int moneybox_ctrl()

Kick out the cash drawer.

Returns
int The result code, >= 0, success; <0 error code.


setEnable

int moneybox_setEnable(unsigned int nEnable)

Enable or disable hardware

Parameters
nEnable unsigned int: 1 - enable, 0 - disable.
Returns
int The result code, >= 0, success; <0 error code.