How to Develop Serial Port for Terminals - Revision history

Mahong: Replaced content with "{{Migrating|https://smartpossdk.gitbook.io/cloudpossdk/faq/usb-serial-port/serial-port-development}}"

2024-04-07T08:23:36Z

Replaced content with "{{Migrating|https://smartpossdk.gitbook.io/cloudpossdk/faq/usb-serial-port/serial-port-development}}"

← Older revision		Revision as of 08:23, 7 April 2024
Line 1:		Line 1:
	~~== Introduction: ==~~		{{Migrating\|https://smartpossdk.gitbook.io/cloudpossdk/faq/usb-serial-port/serial-port-development}}
	This guide provides a demonstration on how to develop an application that utilizes serial ports, using both Java and C APIs. Included are sources for a serial port test tool and downloadable demo applications.
	~~== Demo and Tool Downloads: ==~~
	~~# '''SerialPortDemo Application:'''~~
	~~#* Download the [~~https://~~github~~.~~com/SmartPOSSamples/SimpleSerialportdemo~~.~~git SerialPortDemo] for practical insights into application development.~~
	~~# '''Serial Port Test Tool:'''~~
	~~#* Download the [https:~~//~~github.com~~/~~SmartPOSSamples/SerialportTestTool.git Source APP] and [http://ftp.wizarpos.com/advanceSDK/serialport_test_230918.apk APK] for a serial port testing tool.~~
	~~== API Usage: ==~~
	~~# '''Java API for Serial Port:'''~~
	~~#* When opening a serial port using the Java API, set the logic ID of the~~ serial port ~~as a parameter.~~
	~~#** SerialPortDevice.ID_USB_SLAVE_SERIAL : works for USB serial port in slave mode.~~
	~~#** SerialPortDevice.ID_USB_HOST_SERIAL : works for USB serial port in master mode.~~
	~~#** SerialPortDevice.ID_SERIAL_EXT : works for internal fiscal~~/ ~~other serial port module.~~
	~~#** SerialPortDevice.ID_USB_CDC: works for USB Communication Device Class.~~
	~~#** SerialPortDevice.ID_USB_GPRINTER: works for USB GPRINTER.~~
	~~#** SerialPortDevice.ID_USB_SLAVE_SERIAL_ACM: works for ACM without Qualcomm driver.~~
	~~# '''C API for Serial Port:'''~~
	~~#* When using the C API to open a serial port, the device name of the~~ serial port ~~must be specified as a parameter.~~
	~~'''Device Name''':~~
	~~{\|class="wizarpostable"~~
	\|-
	~~! scope="row" colspan="2" \| Parameters~~
	\|-
	~~\| device name\|\| 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:'''
	** '''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.
	* '''in Q1 3g:'''
	** '''WIZARHANDQ1''': works for USB serial port in slave mode.
	** '''Q1_USB_SERIAL''' or '''USB_SERIAL''': works for USB serial port in master mode.
	** '''SERIAL_EXT''': works for internal fiscal/other serial port module.
	* '''in Q1 4g and Q2(K2, M2, M3, QD4/5), Q3 series and others:'''
	** '''USB_SLAVE_SERIAL''': works for USB serial port in slave mode. For example, terminal use USB OTG cable connect the PC directly.
	** '''USB_HOST_SERIAL''' or '''USB_SERIAL''': works for USB serial port in master mode. For example, terminal connect an USB2Serial convertor or use UU cable.
	** '''SERIAL_EXT''': works for internal fiscal/other serial port module.
	** '''USB_CDC''': works for USB Communication Device Class.
	\|}
	~~== Cable Connection Guidelines: ==~~
	~~'''For Model Q4:'''~~
	* Refer to Picture 2 and Picture 3 for connecting using a USB to DB9 cable.
	* Alternatively, refer to Picture 4 for connection using a UU cable.
	* Please ensure all connections and API parameters are correctly set for successful communication with the serial port.
	~~'''Cable pictures:'''~~
	~~[[File:Otg_usb_1.jpg\|frameless\|left\|thumb\|OTG to USB Host TypeA Female]]~~
	~~[[File:Usb_db9_1.jpg\|frameless\|left\|thumb\|USB to Serial port cable, USB TypeA Male to DB9 Female]]~~
	~~[[File:Usb_db9_2.jpg\|frameless\|left\|thumb\|USB to Serial port cable, USB TypeA Male to DB9 Male]]~~
	~~[[File:UUCable.jpg\|frameless\|left\|thumb\|caUU cable, 2 USB Serial port cable cross connected togetherption]]~~

Mahong at 08:48, 31 January 2024

2024-01-31T08:48:50Z

← Older revision		Revision as of 08:48, 31 January 2024
Line 3:		Line 3:
	== Demo and Tool Downloads: ==		== Demo and Tool Downloads: ==
	# '''SerialPortDemo Application:'''		# '''SerialPortDemo Application:'''
	#* Download the [~~http~~://~~ftp.wizarpos~~.com/~~advanceSDK~~/~~SerialPortOpen~~.~~zip~~ SerialPortDemo] for practical insights into application development.		#* Download the [https://github.com/SmartPOSSamples/SimpleSerialportdemo.git SerialPortDemo] for practical insights into application development.
	# '''Serial Port Test Tool:'''		# '''Serial Port Test Tool:'''
	#* Download the [~~http~~://~~ftp.wizarpos~~.com/~~advanceSDK~~/~~SerialPortTest-1.6_230918~~.~~zip~~ Source APP] and [http://ftp.wizarpos.com/advanceSDK/serialport_test_230918.apk APK] for a serial port testing tool.		#* Download the [https://github.com/SmartPOSSamples/SerialportTestTool.git Source APP] and [http://ftp.wizarpos.com/advanceSDK/serialport_test_230918.apk APK] for a serial port testing tool.
	== API Usage: ==		== API Usage: ==
	# '''Java API for Serial Port:'''		# '''Java API for Serial Port:'''

Mahong at 07:55, 31 January 2024

2024-01-31T07:55:12Z

← Older revision		Revision as of 07:55, 31 January 2024
Line 41:		Line 41:
	* Alternatively, refer to Picture 4 for connection using a UU cable.		* Alternatively, refer to Picture 4 for connection using a UU cable.
	* Please ensure all connections and API parameters are correctly set for successful communication with the serial port.		* Please ensure all connections and API parameters are correctly set for successful communication with the serial port.
			'''Cable pictures:'''
	[[File:Otg_usb_1.jpg\|frameless\|left\|thumb\|OTG to USB Host TypeA Female]]		[[File:Otg_usb_1.jpg\|frameless\|left\|thumb\|OTG to USB Host TypeA Female]]
	[[File:Usb_db9_1.jpg\|frameless\|left\|thumb\|USB to Serial port cable, USB TypeA Male to DB9 Female]]		[[File:Usb_db9_1.jpg\|frameless\|left\|thumb\|USB to Serial port cable, USB TypeA Male to DB9 Female]]
	[[File:Usb_db9_2.jpg\|frameless\|left\|thumb\|USB to Serial port cable, USB TypeA Male to DB9 Male]]		[[File:Usb_db9_2.jpg\|frameless\|left\|thumb\|USB to Serial port cable, USB TypeA Male to DB9 Male]]
	[[File:UUCable.jpg\|frameless\|left\|thumb\|caUU cable, 2 USB Serial port cable cross connected togetherption]]		[[File:UUCable.jpg\|frameless\|left\|thumb\|caUU cable, 2 USB Serial port cable cross connected togetherption]]

Simon no use: Simon moved page About the development of serial port of the terminal to How to Develop Serial Port for Terminals: Normalize the title

2023-12-24T18:51:13Z

Simon moved page About the development of serial port of the terminal to How to Develop Serial Port for Terminals: Normalize the title

← Older revision

Revision as of 18:51, 24 December 2023

Simon no use at 18:48, 24 December 2023

2023-12-24T18:48:12Z

← Older revision		Revision as of 18:48, 24 December 2023
Line 1:		Line 1:
	== ~~Demo~~ ==		== Introduction: ==
	~~Here is~~ a ~~demo about~~ how to develop an ~~app~~ using Java ~~API, please download~~ [http://ftp.wizarpos.com/advanceSDK/SerialPortOpen.zip SerialPortDemo]		This guide provides a demonstration on how to develop an application that utilizes serial ports, using both Java and C APIs. Included are sources for a serial port test tool and downloadable demo applications.
			== Demo and Tool Downloads: ==
			# '''SerialPortDemo Application:'''
	~~A serial port test tool~~ [http://ftp.wizarpos.com/advanceSDK/SerialPortTest-1.6_230918.zip Source APP], and [http://ftp.wizarpos.com/advanceSDK/serialport_test_230918.apk APK]		#* Download the [http://ftp.wizarpos.com/advanceSDK/SerialPortOpen.zip SerialPortDemo] for practical insights into application development.
			# '''Serial Port Test Tool:'''
	~~== Open ==~~		#* Download the [http://ftp.wizarpos.com/advanceSDK/SerialPortTest-1.6_230918.zip Source APP] and [http://ftp.wizarpos.com/advanceSDK/serialport_test_230918.apk APK] for a serial port testing tool.
	=== ~~Java~~ API ===		== API Usage: ==
	~~When using the~~ '''Java API''' ~~to open~~ a serial port, ~~you need to~~ set the logic ID of a serial port as a parameter.		# '''Java API for Serial Port:'''
	* SerialPortDevice.ID_USB_SLAVE_SERIAL : works for USB serial port in slave mode.		#* When opening a serial port using the Java API, set the logic ID of the serial port as a parameter.
	* SerialPortDevice.ID_USB_HOST_SERIAL : works for USB serial port in master mode.		#** SerialPortDevice.ID_USB_SLAVE_SERIAL : works for USB serial port in slave mode.
	* SerialPortDevice.ID_SERIAL_EXT : works for internal fiscal/ other serial port module.		#** SerialPortDevice.ID_USB_HOST_SERIAL : works for USB serial port in master mode.
	* SerialPortDevice.ID_USB_CDC: works for USB Communication Device Class.		#** SerialPortDevice.ID_SERIAL_EXT : works for internal fiscal/ other serial port module.
	* SerialPortDevice.ID_USB_GPRINTER: works for USB GPRINTER.		#** SerialPortDevice.ID_USB_CDC: works for USB Communication Device Class.
	* SerialPortDevice.ID_USB_SLAVE_SERIAL_ACM: works for ACM without Qualcomm driver.		#** SerialPortDevice.ID_USB_GPRINTER: works for USB GPRINTER.
			#** SerialPortDevice.ID_USB_SLAVE_SERIAL_ACM: works for ACM without Qualcomm driver.
	~~===~~ C API ~~===~~		# '''C API for Serial Port:'''
	When using the ~~'''~~C API~~'''~~ to open a serial port, ~~you need to set~~ the device name of a serial port as a parameter.		#* When using the C API to open a serial port, the device name of the serial port must be specified as a parameter.

	'''Device Name''':		'''Device Name''':
	{\|class="wizarpostable"		{\|class="wizarpostable"
Line 37:		Line 36:
	** '''USB_CDC''': works for USB Communication Device Class.		** '''USB_CDC''': works for USB Communication Device Class.
	\|}		\|}
			== Cable Connection Guidelines: ==
			'''For Model Q4:'''
			* Refer to Picture 2 and Picture 3 for connecting using a USB to DB9 cable.
			* Alternatively, refer to Picture 4 for connection using a UU cable.
	== Cable Connection==		* Please ensure all connections and API parameters are correctly set for successful communication with the serial port.
	~~Please check follow pictures~~
	* ~~Q4: use picture~~ 2 and ~~picture~~ 3~~, the Usb~~ to DB9 cable ~~; or picture~~ 4 ~~the~~ UU cable

	~~<big>Cables</big>~~


	[[File:Otg_usb_1.jpg\|frameless\|left\|thumb\|OTG to USB Host TypeA Female]]		[[File:Otg_usb_1.jpg\|frameless\|left\|thumb\|OTG to USB Host TypeA Female]]

	[[File:Usb_db9_1.jpg\|frameless\|left\|thumb\|USB to Serial port cable, USB TypeA Male to DB9 Female]]		[[File:Usb_db9_1.jpg\|frameless\|left\|thumb\|USB to Serial port cable, USB TypeA Male to DB9 Female]]




	:
	[[File:Usb_db9_2.jpg\|frameless\|left\|thumb\|USB to Serial port cable, USB TypeA Male to DB9 Male]]		[[File:Usb_db9_2.jpg\|frameless\|left\|thumb\|USB to Serial port cable, USB TypeA Male to DB9 Male]]


	:
	[[File:UUCable.jpg\|frameless\|left\|thumb\|caUU cable, 2 USB Serial port cable cross connected togetherption]]		[[File:UUCable.jpg\|frameless\|left\|thumb\|caUU cable, 2 USB Serial port cable cross connected togetherption]]

Mahong: /* Java API */

2023-09-20T03:11:43Z

Java API

← Older revision		Revision as of 03:11, 20 September 2023
Line 12:		Line 12:
	* SerialPortDevice.ID_SERIAL_EXT : works for internal fiscal/ other serial port module.		* SerialPortDevice.ID_SERIAL_EXT : works for internal fiscal/ other serial port module.
	* SerialPortDevice.ID_USB_CDC: works for USB Communication Device Class.		* SerialPortDevice.ID_USB_CDC: works for USB Communication Device Class.
	* SerialPortDevice.ID_USB_SLAVE_SERIAL_ACM: works for ACM.		* SerialPortDevice.ID_USB_GPRINTER: works for USB GPRINTER.
			* SerialPortDevice.ID_USB_SLAVE_SERIAL_ACM: works for ACM without Qualcomm driver.

	=== C API ===		=== C API ===

Mahong: /* Java API */

2023-09-19T07:40:15Z

Java API

← Older revision		Revision as of 07:40, 19 September 2023
Line 12:		Line 12:
	* SerialPortDevice.ID_SERIAL_EXT : works for internal fiscal/ other serial port module.		* SerialPortDevice.ID_SERIAL_EXT : works for internal fiscal/ other serial port module.
	* SerialPortDevice.ID_USB_CDC: works for USB Communication Device Class.		* SerialPortDevice.ID_USB_CDC: works for USB Communication Device Class.
			* SerialPortDevice.ID_USB_SLAVE_SERIAL_ACM: works for ACM.

	=== C API ===		=== C API ===

Mahong: /* Demo */

2023-09-18T02:29:14Z

Demo

← Older revision		Revision as of 02:29, 18 September 2023
Line 3:		Line 3:


	A serial port test tool [http://ftp.wizarpos.com/advanceSDK/SerialPortTest-1.~~6-20230815~~.zip Source APP], and [http://ftp.wizarpos.com/advanceSDK/~~20230815_serialport1.6_1.5.4.75aar_app-release_nogetflowcontrol~~.apk APK]		A serial port test tool [http://ftp.wizarpos.com/advanceSDK/SerialPortTest-1.6_230918.zip Source APP], and [http://ftp.wizarpos.com/advanceSDK/serialport_test_230918.apk APK]

	== Open ==		== Open ==

Mahong: /* Demo */

2023-08-15T07:49:50Z

Demo

← Older revision		Revision as of 07:49, 15 August 2023
Line 3:		Line 3:


	A serial port test tool [http://ftp.wizarpos.com/advanceSDK/SerialPortTest-1.6.zip Source APP], and [http://ftp.wizarpos.com/advanceSDK/20230815_serialport1.6_1.5.4.75aar_app-release_nogetflowcontrol.apk APK]		A serial port test tool [http://ftp.wizarpos.com/advanceSDK/SerialPortTest-1.6-20230815.zip Source APP], and [http://ftp.wizarpos.com/advanceSDK/20230815_serialport1.6_1.5.4.75aar_app-release_nogetflowcontrol.apk APK]

	== Open ==		== Open ==

Mahong: /* Demo */

2023-08-15T07:43:55Z

Demo

← Older revision		Revision as of 07:43, 15 August 2023
Line 3:		Line 3:


	A serial port test tool [http://ftp.wizarpos.com/advanceSDK/SerialPortTest-1.6.zip Source APP], and [http://ftp.wizarpos.com/advanceSDK/~~SerialPortTest-1~~.~~6-showHex-sign~~-~~wrf~~.apk APK]		A serial port test tool [http://ftp.wizarpos.com/advanceSDK/SerialPortTest-1.6.zip Source APP], and [http://ftp.wizarpos.com/advanceSDK/20230815_serialport1.6_1.5.4.75aar_app-release_nogetflowcontrol.apk APK]

	== Open ==		== Open ==
	=== Java API ===		=== Java API ===