@urovotest/urovosdk-docs-mcp 1.0.1

package/docs/02-reference/general/serial-port-deprecated-suggest-using-module-14-serialtool.md

@@ -0,0 +1,406 @@
+---
+title: Serial Port(Deprecated, suggest using module 14.SerialTool) API
+module: Serial Port(Deprecated, suggest using module 14.SerialTool)
+domain: general
+tags: ["general", "serial-port-deprecated-suggest-using-module-14-serialtool", "serial port(deprecated, suggest using module 14.serialtool)"]
+---
+# Serial Port(Deprecated, suggest using module 14.SerialTool)
+
+共 **6** 个 API/条目，来源 `general_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [Open](#open) | `com.urovo.smartpos.device.core.SerialPortDriverImpl` | - |
+| [close](#close) | `com.urovo.smartpos.device.core.SerialPortDriverImpl` | - |
+| [read](#read) | `com.urovo.smartpos.device.core.SerialPortDriverImpl` | - |
+| [send](#send) | `com.urovo.smartpos.device.core.SerialPortDriverImpl` | - |
+| [clearInputBuffer](#clearinputbuffer) | `com.urovo.smartpos.device.core.SerialPortDriverImpl` | - |
+| [isbufferEmpty](#isbufferempty) | `com.urovo.smartpos.device.core.SerialPortDriverImpl` | - |
+
+## Open
+
+Open the serial port.
+
+```java
+boolean open(String portPath, int bps, int par, int dbs)
+```
+
+- **类路径：** `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+- **源文档章节：** 5.1
+
+- Source section: `5.1`
+
+- Package/class path: `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+
+
+
+Purpose:
+Open the serial port.
+
+
+Signature/prototype:
+```java
+boolean open(String portPath, int bps, int par, int dbs)
+```
+
+
+Parameters:
+Input
+portPath - The serial port path.
+
+bps - Baud rate
+*
+* - BPS_1200(0x01) - 1200
+* - BPS_2400(0x02) - 2400
+* - BPS_4800(0x03) - 4800
+* - BPS_9600(0x04) - 9600
+* - BPS_14400(0x05) - 14400
+* - BPS_28800(0x06) - 28800
+* - BPS_19200(0x07) - 19200
+* - BPS_57600(0x08) - 57600
+* - BPS_115200(0x09) - 115200
+* - BPS_38400(0x0A) - 38400
+*
+par - check
+*
+* - PAR_NOPAR('N')
+* - PAR_EVEN('E')
+* - PAR_ODD('O')
+*
+dbs - data bits
+*
+* - DBS_7(0x07) - 7
+* - DBS_8(0x08) - 8
+*
+Output
+None
+
+
+Return value:
+Return true when update successful, return false when update failed.
+
+
+Source details:
+```text
+Prototype
+boolean open(String portPath, int bps, int par, int dbs)
+Description
+Open the serial port.
+Parameters
+Input
+portPath - The serial port path.
+
+bps - Baud rate
+*
+* - BPS_1200(0x01) - 1200
+* - BPS_2400(0x02) - 2400
+* - BPS_4800(0x03) - 4800
+* - BPS_9600(0x04) - 9600
+* - BPS_14400(0x05) - 14400
+* - BPS_28800(0x06) - 28800
+* - BPS_19200(0x07) - 19200
+* - BPS_57600(0x08) - 57600
+* - BPS_115200(0x09) - 115200
+* - BPS_38400(0x0A) - 38400
+*
+par - check
+*
+* - PAR_NOPAR('N')
+* - PAR_EVEN('E')
+* - PAR_ODD('O')
+*
+dbs - data bits
+*
+* - DBS_7(0x07) - 7
+* - DBS_8(0x08) - 8
+*
+Output
+None
+Return
+Return true when update successful, return false when update failed.
+Remark
+```
+
+## close
+
+Stop the serial port.
+
+```java
+boolean close()
+```
+
+- **类路径：** `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+- **源文档章节：** 5.2
+
+- Source section: `5.2`
+
+- Package/class path: `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+
+
+
+Purpose:
+Stop the serial port.
+
+
+Signature/prototype:
+```java
+boolean close()
+```
+
+
+Parameters:
+Input
+None
+Output
+None
+
+
+Return value:
+None
+
+
+Usage notes:
+Return true when update successful, return false when update failed.
+
+
+Source details:
+```text
+Prototype
+boolean close()
+Description
+Stop the serial port.
+Parameters
+Input
+None
+Output
+None
+Return
+None
+Remark
+Return true when update successful, return false when update failed.
+```
+
+## read
+
+Read data from serial port.
+
+```java
+int read(out byte[] buffer, int timeout)
+```
+
+- **类路径：** `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+- **源文档章节：** 5.3
+
+- Source section: `5.3`
+
+- Package/class path: `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+
+
+
+Purpose:
+Read data from serial port.
+
+
+Signature/prototype:
+```java
+int read(out byte[] buffer, int timeout)
+```
+
+
+Parameters:
+Input
+timeout - tiem out(millisecond)
+Output
+buffer - read data buffer
+
+
+Return value:
+Return true when update successful, return false when update failed.
+
+
+Source details:
+```text
+Prototype
+int read(out byte[] buffer, int timeout)
+Description
+Read data from serial port.
+Parameters
+Input
+timeout - tiem out(millisecond)
+Output
+buffer - read data buffer
+Return
+Return true when update successful, return false when update failed.
+Remark
+```
+
+## send
+
+Send data to serial port.
+
+```java
+int write(byte[] data, int timeout)
+```
+
+- **类路径：** `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+- **源文档章节：** 5.4
+
+- Source section: `5.4`
+
+- Package/class path: `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+
+
+
+Purpose:
+Send data to serial port.
+
+
+Signature/prototype:
+```java
+int write(byte[] data, int timeout)
+```
+
+
+Parameters:
+Input
+data - data sent.
+timeout - tiem out(millisecond)
+Output
+None
+
+
+Return value:
+None
+
+
+Usage notes:
+Return the number of bytes actually sent when sent successful, return -1 when sent failed.
+
+
+Source details:
+```text
+Prototype
+int write(byte[] data, int timeout)
+Description
+Send data to serial port.
+Parameters
+Input
+data - data sent.
+timeout - tiem out(millisecond)
+Output
+None
+Return
+None
+Remark
+Return the number of bytes actually sent when sent successful, return -1 when sent failed.
+```
+
+## clearInputBuffer
+
+Empty reveive buffer.
+
+```java
+boolean clearInputBuffer()
+```
+
+- **类路径：** `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+- **源文档章节：** 5.5
+
+- Source section: `5.5`
+
+- Package/class path: `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+
+
+
+Purpose:
+Empty reveive buffer.
+
+
+Signature/prototype:
+```java
+boolean clearInputBuffer()
+```
+
+
+Parameters:
+Input
+None
+Output
+None
+
+
+Return value:
+Return true when update successful, return false when update failed.
+
+
+Source details:
+```text
+Prototype
+boolean clearInputBuffer()
+Description
+Empty reveive buffer.
+Parameters
+Input
+None
+Output
+None
+Return
+Return true when update successful, return false when update failed.
+Remark
+```
+
+## isbufferEmpty
+
+Check that the buffer is empty.
+
+```java
+boolean isBufferEmpty(boolean input)
+```
+
+- **类路径：** `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+- **源文档章节：** 5.6
+
+- Source section: `5.6`
+
+- Package/class path: `com.urovo.smartpos.device.core.SerialPortDriverImpl`
+
+
+
+Purpose:
+Check that the buffer is empty.
+
+
+Signature/prototype:
+```java
+boolean isBufferEmpty(boolean input)
+```
+
+
+Parameters:
+Input
+input - true(input buffer), false(output buff).
+Output
+None
+
+
+Return value:
+Return true when update successful, return false when update failed.
+
+
+Source details:
+```text
+Prototype
+boolean isBufferEmpty(boolean input)
+Description
+Check that the buffer is empty.
+Parameters
+Input
+input - true(input buffer), false(output buff).
+Output
+None
+Return
+Return true when update successful, return false when update failed.
+Remark
+```

package/docs/02-reference/general/serial-port.md

@@ -0,0 +1,326 @@
+---
+title: Serial Port API
+module: Serial Port
+domain: general
+tags: ["general", "serial-port", "serial port"]
+---
+# Serial Port
+
+共 **4** 个 API/条目，来源 `general_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [setOnListener](#setonlistener) | `com.urovo.serial.utils.SerialPortTool` | - |
+| [openSerialPort](#openserialport) | `com.urovo.serial.utils.SerialPortTool` | - |
+| [close](#close) | `com.urovo.serial.utils.SerialPortTool` | - |
+| [sendData](#senddata) | `com.urovo.serial.utils.SerialPortTool` | - |
+
+## setOnListener
+
+set up data receiving listener.
+
+```java
+void setOnListener(SerialPortListener listener)
+```
+
+- **类路径：** `com.urovo.serial.utils.SerialPortTool`
+- **源文档章节：** 14.1
+
+- Source section: `14.1`
+
+- Package/class path: `com.urovo.serial.utils.SerialPortTool`
+
+
+
+Purpose:
+set up data receiving listener.
+
+
+Signature/prototype:
+```java
+void setOnListener(SerialPortListener listener)
+```
+
+
+Parameters:
+Input
+listener - tiem out(millisecond)
+Output
+None
+
+
+Usage notes:
+Data receiving listener interface definition：
+interface SerialPortListener {
+/**
+* Received data successfully.
+* @param data- response data.
+*/
+void onReceive(byte[] data);
+
+* Received data failed.
+* @param code- error code.
+* @param msg- error message.
+*/
+void onFail(String code, String msg);
+}
+
+
+Source details:
+```text
+Prototype
+void setOnListener(SerialPortListener listener)
+Description
+set up data receiving listener.
+Parameters
+Input
+listener - tiem out(millisecond)
+Output
+None
+Return
+
+Remark
+Data receiving listener interface definition：
+interface SerialPortListener {
+/**
+* Received data successfully.
+* @param data- response data.
+*/
+void onReceive(byte[] data);
+
+* Received data failed.
+* @param code- error code.
+* @param msg- error message.
+*/
+void onFail(String code, String msg);
+}
+```
+
+## openSerialPort
+
+Open the serial port.
+
+```java
+int openSerialPort(List<String> pathNameList, int bps)
+```
+
+- **类路径：** `com.urovo.serial.utils.SerialPortTool`
+- **源文档章节：** 14.2
+
+- Source section: `14.2`
+
+- Package/class path: `com.urovo.serial.utils.SerialPortTool`
+
+
+
+Purpose:
+Open the serial port.
+
+
+Signature/prototype:
+```java
+int openSerialPort(List<String> pathNameList, int bps)
+```
+
+
+Parameters:
+Input
+portPath - the serial port path.
+bps - Baud rate
+*
+* - BPS_1200(0x01) - 1200
+* - BPS_2400(0x02) - 2400
+* - BPS_4800(0x03) - 4800
+* - BPS_9600(0x04) - 9600
+* - BPS_14400(0x05) - 14400
+* - BPS_28800(0x06) - 28800
+* - BPS_19200(0x07) - 19200
+* - BPS_57600(0x08) - 57600
+* - BPS_115200(0x09) - 115200
+* - BPS_38400(0x0A) - 38400
+*
+
+bps - Baud rate
+*
+* - BPS_1200(0x01) - 1200
+* - BPS_2400(0x02) - 2400
+* - BPS_4800(0x03) - 4800
+* - BPS_9600(0x04) - 9600
+* - BPS_14400(0x05) - 14400
+* - BPS_28800(0x06) - 28800
+* - BPS_19200(0x07) - 19200
+* - BPS_57600(0x08) - 57600
+* - BPS_115200(0x09) - 115200
+* - BPS_38400(0x0A) - 38400
+*
+Output
+None
+
+
+Return value:
+0:success, others:failed.
+
+
+Usage notes:
+Refer to the
+com.urovo.serial.common.GlobalConstant..getErrorMessage(int errorCode).
+
+
+Source details:
+```text
+Prototype
+int openSerialPort(List<String> pathNameList, int bps)
+Description
+Open the serial port.
+Parameters
+Input
+portPath - the serial port path.
+bps - Baud rate
+*
+* - BPS_1200(0x01) - 1200
+* - BPS_2400(0x02) - 2400
+* - BPS_4800(0x03) - 4800
+* - BPS_9600(0x04) - 9600
+* - BPS_14400(0x05) - 14400
+* - BPS_28800(0x06) - 28800
+* - BPS_19200(0x07) - 19200
+* - BPS_57600(0x08) - 57600
+* - BPS_115200(0x09) - 115200
+* - BPS_38400(0x0A) - 38400
+*
+
+bps - Baud rate
+*
+* - BPS_1200(0x01) - 1200
+* - BPS_2400(0x02) - 2400
+* - BPS_4800(0x03) - 4800
+* - BPS_9600(0x04) - 9600
+* - BPS_14400(0x05) - 14400
+* - BPS_28800(0x06) - 28800
+* - BPS_19200(0x07) - 19200
+* - BPS_57600(0x08) - 57600
+* - BPS_115200(0x09) - 115200
+* - BPS_38400(0x0A) - 38400
+*
+Output
+None
+Return
+0:success, others:failed.
+Remark
+Refer to the
+com.urovo.serial.common.GlobalConstant..getErrorMessage(int errorCode).
+```
+
+## close
+
+Stop the serila port.
+
+```java
+boolean close()
+```
+
+- **类路径：** `com.urovo.serial.utils.SerialPortTool`
+- **源文档章节：** 14.3
+
+- Source section: `14.3`
+
+- Package/class path: `com.urovo.serial.utils.SerialPortTool`
+
+
+
+Purpose:
+Stop the serila port.
+
+
+Signature/prototype:
+```java
+boolean close()
+```
+
+
+Parameters:
+Input
+None
+Output
+None
+
+
+Return value:
+None
+
+
+Source details:
+```text
+Prototype
+boolean close()
+Description
+Stop the serila port.
+Parameters
+Input
+None
+Output
+None
+Return
+None
+Remark
+```
+
+## sendData
+
+Send data to serial port.
+
+```java
+String sendData(byte[] SendBuff, int len)
+```
+
+- **类路径：** `com.urovo.serial.utils.SerialPortTool`
+- **源文档章节：** 14.4
+
+- Source section: `14.4`
+
+- Package/class path: `com.urovo.serial.utils.SerialPortTool`
+
+
+
+Purpose:
+Send data to serial port.
+
+
+Signature/prototype:
+```java
+String sendData(byte[] SendBuff, int len)
+```
+
+
+Parameters:
+Input
+data - data.
+
+len- data length.
+Output
+None
+
+
+Return value:
+null - success, others - failed.
+
+
+Source details:
+```text
+Prototype
+String sendData(byte[] SendBuff, int len)
+Description
+Send data to serial port.
+Parameters
+Input
+data - data.
+
+len- data length.
+Output
+None
+Return
+null - success, others - failed.
+Remark
+```