@urovotest/urovosdk-docs-mcp 1.0.1

package/docs/02-reference/general/insertcardreader.md

@@ -0,0 +1,307 @@
+---
+title: InsertCardReader API
+module: InsertCardReader
+domain: general
+tags: ["general", "insertcardreader", "insertcardreader"]
+---
+# InsertCardReader
+
+共 **5** 个 API/条目，来源 `general_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [powerUp](#powerup) | `com.urovo.sdk.insertcard.InsertCardHandlerImpl` | ICReaderActivity |
+| [powerDown](#powerdown) | `com.urovo.sdk.insertcard.InsertCardHandlerImpl` | ICReaderActivity |
+| [IisCardIn](#iiscardin) | `com.urovo.sdk.insertcard.InsertCardHandlerImpl` | ICReaderActivity |
+| [exchangeApdu](#exchangeapdu) | `com.urovo.sdk.insertcard.InsertCardHandlerImpl` | ICReaderActivity |
+| [isPSAMCardExist](#ispsamcardexist) | `com.urovo.sdk.insertcard.InsertCardHandlerImpl` | ICReaderActivity |
+
+## powerUp
+
+Card power up.
+
+```java
+int powerUp(byte cardSlot,byte[] atrData)
+```
+
+- **类路径：** `com.urovo.sdk.insertcard.InsertCardHandlerImpl`
+- **Demo Activity（参考）：** ICReaderActivity
+- **源文档章节：** 9.1
+
+- Source section: `9.1`
+
+- Package/class path: `com.urovo.sdk.insertcard.InsertCardHandlerImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/ICReaderActivity.java`
+
+
+
+Purpose:
+Card power up.
+
+
+Signature/prototype:
+```java
+int powerUp(byte cardSlot,byte[] atrData)
+```
+
+
+Parameters:
+Input
+cardSlot - 0:user card ,1:psam1,2:psam2.
+Output
+None
+
+
+Return value:
+0:success, others:failed.
+
+
+Simplified example:
+```java
+byte[] atr = InsertCardHandlerImpl.getInstance().powerUp(Constant.SlotType.USER_CARD);
+```
+
+
+Source details:
+```text
+Prototype
+int powerUp(byte cardSlot,byte[] atrData)
+Description
+Card power up.
+Parameters
+Input
+cardSlot - 0:user card ,1:psam1,2:psam2.
+Output
+None
+Return
+0:success, others:failed.
+Remark
+```
+
+## powerDown
+
+Card power down.
+
+```java
+boolean powerDown(byte cardSlot)
+```
+
+- **类路径：** `com.urovo.sdk.insertcard.InsertCardHandlerImpl`
+- **Demo Activity（参考）：** ICReaderActivity
+- **源文档章节：** 9.2
+
+- Source section: `9.2`
+
+- Package/class path: `com.urovo.sdk.insertcard.InsertCardHandlerImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/ICReaderActivity.java`
+
+
+
+Purpose:
+Card power down.
+
+
+Signature/prototype:
+```java
+boolean powerDown(byte cardSlot)
+```
+
+
+Parameters:
+Input
+cardSlot -0:user card ,1:psam1,2:psam2.
+Output
+None
+
+
+Return value:
+Return true when power down successful, return false when power down failed.
+
+
+Source details:
+```text
+Prototype
+boolean powerDown(byte cardSlot)
+Description
+Card power down.
+Parameters
+Input
+cardSlot -0:user card ,1:psam1,2:psam2.
+Output
+None
+Return
+Return true when power down successful, return false when power down failed.
+Remark
+```
+
+## IisCardIn
+
+Is the card in place.
+
+```java
+boolean isCardIn()
+```
+
+- **类路径：** `com.urovo.sdk.insertcard.InsertCardHandlerImpl`
+- **Demo Activity（参考）：** ICReaderActivity
+- **源文档章节：** 9.3
+
+- Source section: `9.3`
+
+- Package/class path: `com.urovo.sdk.insertcard.InsertCardHandlerImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/ICReaderActivity.java`
+
+
+
+Purpose:
+Is the card in place.
+
+
+Signature/prototype:
+```java
+boolean isCardIn()
+```
+
+
+Parameters:
+Input
+None
+Output
+None
+
+
+Return value:
+Return true when card exist, return false when card does not exist.
+
+
+Source details:
+```text
+Prototype
+boolean isCardIn()
+Description
+Is the card in place.
+Parameters
+Input
+None
+Output
+None
+Return
+Return true when card exist, return false when card does not exist.
+Remark
+```
+
+## exchangeApdu
+
+APDU data communication.
+
+```java
+byte[] exchangeApdu(byte cardSlot, byte[] apdu)
+```
+
+- **类路径：** `com.urovo.sdk.insertcard.InsertCardHandlerImpl`
+- **Demo Activity（参考）：** ICReaderActivity
+- **源文档章节：** 9.4
+
+- Source section: `9.4`
+
+- Package/class path: `com.urovo.sdk.insertcard.InsertCardHandlerImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/ICReaderActivity.java`
+
+
+
+Purpose:
+APDU data communication.
+
+
+Signature/prototype:
+```java
+byte[] exchangeApdu(byte cardSlot, byte[] apdu)
+```
+
+
+Parameters:
+Input
+cardSlot - 0:user card ,1:psam1,2:psam2.
+apdu - apdu data.
+Output
+None
+
+
+Return value:
+Return card response data when communication successful, return null when communication failed.
+
+
+Simplified example:
+```java
+byte[] response = InsertCardHandlerImpl.getInstance().exchangeApdu(Constant.SlotType.USER_CARD, commandApdu);
+```
+
+
+Source details:
+```text
+Prototype
+byte[] exchangeApdu(byte cardSlot, byte[] apdu)
+Description
+APDU data communication.
+Parameters
+Input
+cardSlot - 0:user card ,1:psam1,2:psam2.
+apdu - apdu data.
+Output
+None
+Return
+Return card response data when communication successful, return null when communication failed.
+Remark
+```
+
+## isPSAMCardExist
+
+Is the psam card in place.
+
+```java
+boolean isPSAMCardExist(byte cardSlot)
+```
+
+- **类路径：** `com.urovo.sdk.insertcard.InsertCardHandlerImpl`
+- **Demo Activity（参考）：** ICReaderActivity
+- **源文档章节：** 9.5
+
+- Source section: `9.5`
+
+- Package/class path: `com.urovo.sdk.insertcard.InsertCardHandlerImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/ICReaderActivity.java`
+
+
+
+Purpose:
+Is the psam card in place.
+
+
+Signature/prototype:
+```java
+boolean isPSAMCardExist(byte cardSlot)
+```
+
+
+Parameters:
+Input
+cardSlot: psam card slot.
+
+
+Source details:
+```text
+Prototype
+boolean isPSAMCardExist(byte cardSlot)
+Description
+Is the psam card in place.
+Parameters
+Input
+cardSlot: psam card slot.
+```

package/docs/02-reference/general/install-manager.md

@@ -0,0 +1,202 @@
+---
+title: Install Manager API
+module: Install Manager
+domain: general
+tags: ["general", "install-manager", "install manager"]
+---
+# Install Manager
+
+共 **2** 个 API/条目，来源 `general_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [install](#install) | `com.urovo.sdk.install.InstallManagerImpl` | - |
+| [uninstall](#uninstall) | `com.urovo.sdk.install.InstallManagerImpl` | - |
+
+## install
+
+Override installation, silence.
+
+```java
+void install(String apkPath, final InstallApkListener listener)
+```
+
+- **类路径：** `com.urovo.sdk.install.InstallManagerImpl`
+- **源文档章节：** 11.1
+
+- Source section: `11.1`
+
+- Package/class path: `com.urovo.sdk.install.InstallManagerImpl`
+
+
+
+Purpose:
+Override installation, silence.
+
+
+Signature/prototype:
+```java
+void install(String apkPath, final InstallApkListener listener)
+```
+
+
+Parameters:
+Input
+apkPath - the apk file path in the device.
+listener - installation and uninstallation result callback.
+Output
+None
+
+
+Usage notes:
+/**
+* installation result callback listener interface definition
+*/
+interface InstallApkListener {
+/**
+* installation result
+* @param packageName- app package name
+* @param returnCode- result code.(Refer to the InstallAppCodeConstant).
+* @param returnMsg- result description message
+*/
+void onInstallFinished(String packageName, int returnCode, String returnMsg);
+/**
+* uninstallation result
+* @param packageName- app package name
+* @param returnCode- result code.(Refer to InstallAppCodeConstant).
+* @param returnMsg- result description message
+*/
+void onUnInstallFinished(String packageName, int returnCode, String returnMsg);
+}
+
+
+Source details:
+```text
+Prototype
+void install(String apkPath, final InstallApkListener listener)
+Description
+Override installation, silence.
+Parameters
+Input
+apkPath - the apk file path in the device.
+listener - installation and uninstallation result callback.
+Output
+None
+Return
+
+Remark
+/**
+* installation result callback listener interface definition
+*/
+interface InstallApkListener {
+/**
+* installation result
+* @param packageName- app package name
+* @param returnCode- result code.(Refer to the InstallAppCodeConstant).
+* @param returnMsg- result description message
+*/
+void onInstallFinished(String packageName, int returnCode, String returnMsg);
+/**
+* uninstallation result
+* @param packageName- app package name
+* @param returnCode- result code.(Refer to InstallAppCodeConstant).
+* @param returnMsg- result description message
+*/
+void onUnInstallFinished(String packageName, int returnCode, String returnMsg);
+}
+```
+
+## uninstall
+
+Uninstallation, silence.
+
+```java
+void uninstall(String packageName, final InstallApkListener listaner)
+```
+
+- **类路径：** `com.urovo.sdk.install.InstallManagerImpl`
+- **源文档章节：** 11.2
+
+- Source section: `11.2`
+
+- Package/class path: `com.urovo.sdk.install.InstallManagerImpl`
+
+
+
+Purpose:
+Uninstallation, silence.
+
+
+Signature/prototype:
+```java
+void uninstall(String packageName, final InstallApkListener listaner)
+```
+
+
+Parameters:
+Input
+packageName - the app package name.
+listener - installation and uninstallation result callback.
+Output
+None
+
+
+Usage notes:
+/**
+* installation result callback listener interface definition
+*/
+interface InstallApkListener {
+/**
+* installation result
+* @param packageName- app package name
+* @param returnCode- result code
+* @param returnMsg- result description message
+*/
+void onInstallFinished(String packageName, int returnCode, String returnMsg);
+/**
+* uninstallation result
+* @param packageName- app package name
+* @param returnCode- result code
+* @param returnMsg- result description message
+*/
+void onUnInstallFinished(String packageName, int returnCode, String returnMsg);
+}
+
+
+Source details:
+```text
+Prototype
+void uninstall(String packageName, final InstallApkListener listaner)
+Description
+Uninstallation, silence.
+Parameters
+Input
+packageName - the app package name.
+listener - installation and uninstallation result callback.
+Output
+None
+Return
+
+Remark
+/**
+* installation result callback listener interface definition
+*/
+interface InstallApkListener {
+/**
+* installation result
+* @param packageName- app package name
+* @param returnCode- result code
+* @param returnMsg- result description message
+*/
+void onInstallFinished(String packageName, int returnCode, String returnMsg);
+/**
+* uninstallation result
+* @param packageName- app package name
+* @param returnCode- result code
+* @param returnMsg- result description message
+*/
+void onUnInstallFinished(String packageName, int returnCode, String returnMsg);
+}
+```

package/docs/02-reference/general/led-light.md

@@ -0,0 +1,144 @@
+---
+title: LED Light API
+module: LED Light
+domain: general
+tags: ["general", "led-light", "led light"]
+---
+# LED Light
+
+共 **2** 个 API/条目，来源 `general_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [turnOn](#turnon) | `com.urovo.sdk.led.LEDDriverImpl` | LedActivity |
+| [turnOff](#turnoff) | `com.urovo.sdk.led.LEDDriverImpl` | LedActivity |
+
+## turnOn
+
+Turn on LED light
+
+```java
+void turnOn(int led)
+```
+
+- **类路径：** `com.urovo.sdk.led.LEDDriverImpl`
+- **Demo Activity（参考）：** LedActivity
+- **源文档章节：** 2.1
+
+- Source section: `2.1`
+
+- Package/class path: `com.urovo.sdk.led.LEDDriverImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/LedActivity.java`
+
+
+
+Purpose:
+Turn on LED light
+
+
+Signature/prototype:
+```java
+void turnOn(int led)
+```
+
+
+Parameters:
+Input
+led - 1: blue light, 2: yellow light, 3: green light, 4: red
+Output
+None
+
+
+Usage notes:
+Refer to Constant.Light.
+
+
+Simplified example:
+```java
+LEDDriverImpl.getInstance().turnOn(Constant.Light.BLUE);
+```
+
+
+Source details:
+```text
+Prototype
+void turnOn(int led)
+Description
+Turn on LED light
+Parameters
+Input
+led - 1: blue light, 2: yellow light, 3: green light, 4: red
+Output
+None
+Return
+
+Remark
+Refer to Constant.Light.
+```
+
+## turnOff
+
+Turn off LED light
+
+```java
+void turnOff(int led)
+```
+
+- **类路径：** `com.urovo.sdk.led.LEDDriverImpl`
+- **Demo Activity（参考）：** LedActivity
+- **源文档章节：** 2.2
+
+- Source section: `2.2`
+
+- Package/class path: `com.urovo.sdk.led.LEDDriverImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/LedActivity.java`
+
+
+
+Purpose:
+Turn off LED light
+
+
+Signature/prototype:
+```java
+void turnOff(int led)
+```
+
+
+Parameters:
+Input
+led - 1: blue light, 2: yellow light, 3: green light, 4: red.
+Output
+None
+
+
+Usage notes:
+Refer to Constant.Light.
+
+
+Simplified example:
+```java
+LEDDriverImpl.getInstance().turnOff(Constant.Light.BLUE);
+```
+
+
+Source details:
+```text
+Prototype
+void turnOff(int led)
+Description
+Turn off LED light
+Parameters
+Input
+led - 1: blue light, 2: yellow light, 3: green light, 4: red.
+Output
+None
+Return
+
+Remark
+Refer to Constant.Light.
+```