Serial port API - Revision history

Mahong at 05:40, 25 September 2019

2019-09-25T05:40:41Z

← Older revision		Revision as of 05:40, 25 September 2019
Line 17:		Line 17:
	** '''Q1_USB_SERIAL''' or '''USB_SERIAL''': works for USB serial port in master mode.		** '''Q1_USB_SERIAL''' or '''USB_SERIAL''': works for USB serial port in master mode.
	** '''SERIAL_EXT''': works for internal fiscal module.		** '''SERIAL_EXT''': works for internal fiscal module.
	* '''in Q1 4g and Q2 series:'''		* '''in Q1 4g and Q2, Q3, QD4/5 series:'''
	** '''USB_SLAVE_SERIAL''': works for USB serial port in slave mode.		** '''USB_SLAVE_SERIAL''': works for USB serial port in slave mode.
	** '''USB_HOST_SERIAL''' or '''USB_SERIAL''': works for USB serial port in master mode.		** '''USB_HOST_SERIAL''' or '''USB_SERIAL''': works for USB serial port in master mode.

2019-05-09T06:47:46Z

open

← Older revision		Revision as of 06:47, 9 May 2019
Line 9:		Line 9:
	! scope="row" colspan="2" \| Parameters		! scope="row" colspan="2" \| Parameters
	\|-		\|-
	\| pDeviceName \|\| The alias for serial port. Available values:<br>		\| pDeviceName \|\| The alias for serial port. Available values: DB9, GS0_01, WIZARHANDQ1, Q1_USB_SERIAL, USB_SERIAL, SERIAL_EXT, USB_SLAVE_SERIAL, USB_HOST_SERIAL<br>
	* '''in W1/W1V2:'''		* '''in W1/W1V2:'''
	** '''DB9''': works for DB9 port at the back side of the terminal.		** '''DB9''': works for DB9 port at the back side of the terminal.

2019-05-09T06:45:26Z

open

← Older revision		Revision as of 06:45, 9 May 2019
Line 10:		Line 10:
	\|-		\|-
	\| pDeviceName \|\| The alias for serial port. Available values:<br>		\| pDeviceName \|\| The alias for serial port. Available values:<br>
	* '''in W1/W1V2'''		* '''in W1/W1V2:'''
	** '''DB9''': works for DB9 port at the back side of the terminal.		** '''DB9''': works for DB9 port at the back side of the terminal.
	** '''GS0_Q1''': works for USB host port at the right side of terminal to connect with Q1 via USB cable in master mode.		** '''GS0_Q1''': works for USB host port at the right side of terminal to connect with Q1 via USB cable in master mode.
	* '''in Q1 3g'''		* '''in Q1 3g:'''
	** '''WIZARHANDQ1''': works for USB serial port in slave mode.		** '''WIZARHANDQ1''': works for USB serial port in slave mode.
	** '''Q1_USB_SERIAL''' or '''USB_SERIAL''': works for USB serial port in master mode.		** '''Q1_USB_SERIAL''' or '''USB_SERIAL''': works for USB serial port in master mode.
	** '''SERIAL_EXT''': works for internal fiscal module.		** '''SERIAL_EXT''': works for internal fiscal module.
	* '''in Q1 4g and Q2 series'''		* '''in Q1 4g and Q2 series:'''
	** '''USB_SLAVE_SERIAL''': works for USB serial port in slave mode.		** '''USB_SLAVE_SERIAL''': works for USB serial port in slave mode.
	** '''USB_HOST_SERIAL''' or '''USB_SERIAL''': works for USB serial port in master mode.		** '''USB_HOST_SERIAL''' or '''USB_SERIAL''': works for USB serial port in master mode.

2019-05-09T06:44:53Z

API Overview

← Older revision		Revision as of 06:44, 9 May 2019
Line 11:		Line 11:
	\| pDeviceName \|\| The alias for serial port. Available values:<br>		\| pDeviceName \|\| The alias for serial port. Available values:<br>
	* '''in W1/W1V2'''		* '''in W1/W1V2'''
	** '''DB9''': works for DB9 port at the back.		** '''DB9''': works for DB9 port at the back side of the terminal.
	** '''GS0_Q1''': works for USB host port ~~connecting~~ with Q1 via USB cable in master mode.		** '''GS0_Q1''': works for USB host port at the right side of terminal to connect with Q1 via USB cable in master mode.
	* '''in Q1 3g'''		* '''in Q1 3g'''
	** '''WIZARHANDQ1''': works for USB serial port in slave mode.		** '''WIZARHANDQ1''': works for USB serial port in slave mode.

2019-05-09T06:40:20Z

open

@@ Line 9: / Line 9: @@
 ! scope="row" colspan="2" | Parameters
 |-
-| pDeviceName || '''char*:''' Device name
+| pDeviceName || The alias for serial port. Available values:<br>
 |}
 {|
 |-
@@ Line 36: / Line 32: @@
 |  int || The result code, >= 0, handle of this device; <0 [[Error_code|error code]].
 |}
 === <big>close</big> ===

2019-03-11T09:42:27Z

← Older revision		Revision as of 09:42, 11 March 2019
Line 41:		Line 41:
	<syntaxhighlight lang="c">int esp_close(int nHandle)</syntaxhighlight >		<syntaxhighlight lang="c">int esp_close(int nHandle)</syntaxhighlight >
	Close the serial port opened before.		Close the serial port opened before.
	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"		{\|class="wizarpostable"
	\|-		\|-
Line 63:		Line 63:
	<syntaxhighlight lang="c">int esp_set_baudrate(int nHandle, unsigned int nBaudrate)</syntaxhighlight >		<syntaxhighlight lang="c">int esp_set_baudrate(int nHandle, unsigned int nBaudrate)</syntaxhighlight >
	Set the baud rate of the serial port so that this device can read and write in the same baud rate.		Set the baud rate of the serial port so that this device can read and write in the same baud rate.
	This ~~api~~ should be used before read and write.		This API should be used before read and write.
	{\|class="wizarpostable"		{\|class="wizarpostable"
	\|-		\|-

2018-05-03T03:19:57Z

← Older revision		Revision as of 03:19, 3 May 2018
Line 36:		Line 36:
	\| int \|\| The result code, >= 0, handle of this device; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, handle of this device; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>close</big> ===		=== <big>close</big> ===
Line 108:		Line 109:
	\| int \|\| The result code, >= 0, success, the data length of read; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, the data length of read; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>write</big>===		=== <big>write</big>===
Line 132:		Line 134:
	\| int \|\| The result code, >= 0, data length of written; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, data length of written; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>flush_io</big>===		=== <big>flush_io</big>===

2018-05-03T03:19:04Z

write

← Older revision		Revision as of 03:19, 3 May 2018
Line 130:		Line 130:
	! scope="row" colspan="2" \| Returns		! scope="row" colspan="2" \| Returns
	\|-		\|-
	\| int \|\| The result code, >= 0, ~~written~~ data length; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, data length of written; <0 [[Error_code\|error code]].
	\|}		\|}

2018-05-03T03:17:31Z

read

← Older revision		Revision as of 03:17, 3 May 2018
Line 106:		Line 106:
	! scope="row" colspan="2" \| Returns		! scope="row" colspan="2" \| Returns
	\|-		\|-
	\| int \|\| The result code, >= 0, success; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, success, the data length of read; <0 [[Error_code\|error code]].
	\|}		\|}


	=== <big>write</big>===		=== <big>write</big>===

2018-05-03T03:16:21Z

open

← Older revision		Revision as of 03:16, 3 May 2018
Line 9:		Line 9:
	! scope="row" colspan="2" \| Parameters		! scope="row" colspan="2" \| Parameters
	\|-		\|-
	\| ''pDeviceName'' \|\| '''char*:''' Device name		\| pDeviceName \|\| '''char*:''' Device name
	\|}		\|}
	'''pDeviceName'''		'''pDeviceName'''
Line 36:		Line 36:
	\| int \|\| The result code, >= 0, handle of this device; <0 [[Error_code\|error code]].		\| int \|\| The result code, >= 0, handle of this device; <0 [[Error_code\|error code]].
	\|}		\|}



	=== <big>close</big> ===		=== <big>close</big> ===