@urovotest/urovosdk-docs-mcp 1.0.1

package/docs/02-reference/emv/emv-enum.md

@@ -0,0 +1,324 @@
+---
+title: EMV Enum API
+module: EMV Enum
+domain: emv
+tags: ["emv", "emv-enum", "emv enum"]
+---
+# EMV Enum
+
+共 **11** 个 API/条目，来源 `emv_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [EmvOption](#emvoption) | `-` | - |
+| [CheckCardMode](#checkcardmode) | `-` | - |
+| [CheckCardResult](#checkcardresult) | `-` | - |
+| [TransactionResult](#transactionresult) | `-` | - |
+| [DisplayText](#displaytext) | `-` | - |
+| [PinEntryResult](#pinentryresult) | `-` | - |
+| [PinEntrySource](#pinentrysource) | `-` | - |
+| [NfcTransResult](#nfctransresult) | `-` | - |
+| [NfcTipMessageID](#nfctipmessageid) | `-` | - |
+| [NfcErrMessageID](#nfcerrmessageid) | `-` | - |
+| [Operation](#operation) | `-` | - |
+
+## EmvOption
+
+- **源文档章节：** 3.01
+
+- Source section: `3.01`
+
+
+
+Purpose:
+public static enum EmvOption
+
+
+Source details:
+```text
+public static enum EmvOption
+{
+START, START_WITH_FORCE_ONLINE
+}
+```
+
+## CheckCardMode
+
+- **源文档章节：** 3.02
+
+- Source section: `3.02`
+
+
+
+Purpose:
+public static enum CheckCardMode{
+
+
+Source details:
+```text
+public static enum CheckCardMode{
+SWIPE, INSERT, TAP, SWIPE_OR_INSERT, SWIPE_OR_TAP,
+INSERT_OR_TAP,
+SWIPE_OR_INSERT_OR_TAP,
+}
+```
+
+## CheckCardResult
+
+- **源文档章节：** 3.03
+
+- Source section: `3.03`
+
+
+
+Purpose:
+public static enum CheckCardResult{
+
+
+Source details:
+```text
+public static enum CheckCardResult{
+NO_CARD INSERTED_CARD NOT_ICC BAD_SWIPE MSR USE_ICC_CARD
+, , , , , ,
+TAP_CARD_DETECTED NEED_FALLBACK TIMEOUT CANCEL DEVICE_BUSY
+, , , ,
+}
+Checkcard result Result description
+Nocardhasbeendetected,pleasecheck
+NO_CARD
+CheckCardMode
+INSERTED_CARD ICCcardhasbeeninserted
+NOT_ICC ICCcardreading failed,pleasetryto reinsertcard
+Magneticstripecardreading failed,pleasetryto
+BAD_SWIPE
+re-swipethecard
+MSR Magneticstripecardreading success
+USE_ICC_CARD Pleaseinsert ICCcard
+TAP_CARD_DETECTED Tapcardhasbeendetected
+NEED_FALLBACK PleaseTaporSwipeCard
+TIMEOUT Timeout,pleasetryto readcard again
+Cardreadinghasbeencanceled,pleasetrytoreadcard
+CANCEL
+again
+DEVICE_BUSY Cardreaderisbusy, pleasetryto read cardagain later
+MULT_CARD Multiplecardsdetected ,Please taponecard
+```
+
+## TransactionResult
+
+- **源文档章节：** 3.04
+
+- Source section: `3.04`
+
+
+
+Purpose:
+public static enum TransactionResult
+
+
+Source details:
+```text
+public static enum TransactionResult
+{
+OFFLINE_APPROVAL,ONLINE_APPROVAL, TERMINATED,
+OFFLINE_DECLINED,ONLINE_DECLINED, CANCELED, CANCELED_OR_TIMEOUT,
+CARD_BLOCKED_APP_FAIL, NO_EMV_APPS, ICC_CARD_REMOVED,
+SELECT_APP_FAIL, INVALID_ICC_DATA,
+APPLICATION_BLOCKED_APP_FAIL
+}
+Transaction result Result description
+OFFLINE_APPROVAL Offlinerequest hasbeen approved
+
+ONLINE_APPROVAL Onlinerequesthasbeenapproved
+TERMINATED Transactionhasbeenterminated
+OFFLINE_DECLINED Offlinerequest hasbeen rejected
+ONLINE_DECLINED Onlinerequesthasbeenrejected
+CANCELED Transactionhasbeencanceled
+CANCELED_OR_TIMEOUT Transactionhasbeencanceled ortimeout
+CARD_BLOCKED_APP_FAIL Cardhasbeenblocked
+NO_EMV_APPS Terminaldoesnot supportapplicationsofcard
+ICC_CARD_REMOVED ICCcardhasbeenremoved
+SELECT_APP_FAIL Terminalhasbeenfailto selectapplication ofcard
+INVALID_ICC_DATA ICCcarddataisinvalid
+APPLICATION_BLOCKED_APP_FAIL Applicationhasbeenblocked
+```
+
+## DisplayText
+
+- **源文档章节：** 3.05
+
+- Source section: `3.05`
+
+
+
+Purpose:
+public static enum DisplayText
+
+
+Source details:
+```text
+public static enum DisplayText
+{
+USE_MAG_STRIPE,
+APPROVED_PLEASE_SIGN,//if CVM is Signature
+}
+```
+
+## PinEntryResult
+
+- **源文档章节：** 3.06
+
+- Source section: `3.06`
+
+
+
+Purpose:
+public static enum PinEntryResult{
+
+
+Source details:
+```text
+public static enum PinEntryResult{
+ENTERED, CANCEL, TIMEOUT, BYPASS, WRONG_PIN_LENGTH,
+INCORRECT_PIN
+}
+```
+
+## PinEntrySource
+
+- **源文档章节：** 3.07
+
+- Source section: `3.07`
+
+
+
+Purpose:
+public static enum PinEntrySource{
+
+
+Source details:
+```text
+public static enum PinEntrySource{
+PHONE, KEYPAD
+}
+```
+
+## NfcTransResult
+
+- **源文档章节：** 3.08
+
+- Source section: `3.08`
+
+
+
+Purpose:
+public static enum NfcTransResult{
+
+
+Source details:
+```text
+public static enum NfcTransResult{
+ONLINE_APPROVAL,
+DECLINE_ONLINE,
+TERMINATE,
+OFFLINE_APPROVAL,
+OTHER_INTERFACES,
+RETRY,
+CARD_REMOVED,
+ISSUER_SCRIPT_UPDATE_SUCCESSFUL, //8
+ISSUER_SCRIPT_UPDATE_FAILED, //9
+DECLINE_OFFLINE}
+```
+
+## NfcTipMessageID
+
+- **源文档章节：** 3.09
+
+- Source section: `3.09`
+
+
+
+Purpose:
+publicstaticenumNfcTipMessageID
+
+
+Source details:
+```text
+publicstaticenumNfcTipMessageID
+{
+PLS_REMOVE_CARD,
+PLS_USE_CONTACT_IC_CARD,//1
+NEED_SIGNATURE,//2
+END_APPLICATION,//3
+SEE_PHONE_REMOVE_AND_PRESENT_CARD,//4
+DISPLAY_BALANCE,//5
+CARD_READ_OK,//6
+PLS_SECOND_TAP_CARD,//7
+APPLICATION_BLOCKED,//8
+TRY_AGAIN_RESENT_CARD,//9
+USE_MAG_STRIPE,//10
+INSERT_SWIPE_OR_TRY_ANOTHER_CARD,//11
+TERMINATE,
+CARD_ERROR,
+PROCESSING_ERROR,
+UNKNOW
+}
+```
+
+## NfcErrMessageID
+
+- **源文档章节：** 3.10
+
+- Source section: `3.10`
+
+
+
+Purpose:
+publicstaticenumNfcErrMessageID
+
+
+Source details:
+```text
+publicstaticenumNfcErrMessageID
+{
+ERR_LOAD_CALLBACK,//0
+ICS_PARAM_NOT_FIND,//needupdateterminalparamters
+KERNEL_ERR,
+ERR_PIN_LENTH,
+ERR_MULT_CARD,
+ERR_CHECK_CARD,
+AID_PARAM_NOT_FIND,
+CAPK_PARAM_NOT_FIND,
+GET_KERNEL_DATA_FAILED,
+QPBOC_APPLICATION,//9
+QPBOC_FDDA_FAILED,
+PURE_ELE_CASH_CARD_NOT_ALLOW_ONLINE_TRANS,
+UNKNOW
+}
+```
+
+## Operation
+
+- **源文档章节：** 3.11
+
+- Source section: `3.11`
+
+
+
+Purpose:
+publicstaticenumOperation
+
+
+Source details:
+```text
+publicstaticenumOperation
+{
+CLEAR, //clearcontactandcontactlessAID
+ADD,
+CLEAR_EMV_AID,//onlyclearcontactAID
+CLEAR_NFC_AID//onlyclearcontactlessAID
+}
+4.Appendix
+```

package/docs/02-reference/error-codes.md

@@ -0,0 +1,59 @@
+---
+title: 错误码
+module: reference
+tags: ["error-codes", "pinpad", "printer"]
+---
+# UrovoSDK 错误码参考
+
+## Pinpad（getLastErrorCode / getLastErrorMsg）
+
+| 码 | 说明 |
+|----|------|
+| 0x00 | Success |
+| 0x01 | Unsupported command |
+| 0x02 | Command length error |
+| 0x03 | Command separator error |
+| 0x04 | Command separator length error |
+| 0x05 | command head (CB) error |
+| 0x06 | Data crc16 error |
+| 0x07 | Message mac error |
+| 0x09 | Message format error |
+| 0x0C | Unsupported algorithm |
+| 0x0D | Unsupported format |
+| 0x0E | Unsupported mode |
+| 0x12 | Keys not ready or init |
+| 0x14 | Keys number not found |
+| 0x15 | Keys number out of range |
+| 0x16 | Keys download |
+| 0x17 | Keys not download |
+| 0x18 | Keys out of space |
+| 0x19 | Keys exists or can not be overwrite |
+| 0x1A | Keys encrypt keys not download |
+| 0x1B | Keys unsupported specified use |
+| 0x1C | Unsupported keys length |
+| 0x28 | Unsupported pinblock format |
+| 0x29 | Username length error |
+| 0x2A | Username value error |
+| 0x2B | User pinblock length error |
+| 0x2C | User pinblock value error |
+| 0x2D | Pinblock char error |
+| 100 | Parameter is null or empty |
+| 101 | Mismatch data length |
+| 102 | Invalid data length |
+| 103 | Invalid key index |
+| 104 | Invalid parameter |
+| 105 | Invalid RSA public key |
+| 106 | Runtime exception |
+
+## Printer
+
+| 码 | 说明 |
+|----|------|
+| 0x00 | Success |
+| 0xF0 | No paper |
+| 0xF3 | Over heat |
+| 0xE1 | Low voltage |
+| 0xF2 | Hardware error |
+| 0xF7 | Printer busy |
+
+详见 `02-reference/general/printer.md` 中 Printer Error Code Definition。

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

@@ -0,0 +1,160 @@
+---
+title: Beeper API
+module: Beeper
+domain: general
+tags: ["general", "beeper", "beeper"]
+---
+# Beeper
+
+共 **2** 个 API/条目，来源 `general_sdk.md`。
+
+## API 索引
+
+| 方法 | 类路径 | Demo Activity |
+|------|--------|---------------|
+| [startBeep](#startbeep) | `com.urovo.sdk.beeper.BeeperImpl` | BeeperActivity |
+| [stopBeep](#stopbeep) | `com.urovo.sdk.beeper.BeeperImpl` | BeeperActivity |
+
+## startBeep
+
+Start Beeping
+
+```java
+void startBeep(int cnts, int msec)
+```
+
+- **类路径：** `com.urovo.sdk.beeper.BeeperImpl`
+- **Demo Activity（参考）：** BeeperActivity
+- **源文档章节：** 1.1
+
+- Source section: `1.1`
+
+- Package/class path: `com.urovo.sdk.beeper.BeeperImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/BeeperActivity.java`
+
+
+
+Purpose:
+Start Beeping
+
+
+Signature/prototype:
+```java
+void startBeep(int cnts, int msec)
+```
+
+
+Parameters:
+Input
+cnts - frequency.
+cnts=1, msec=timeout.
+cnts>1, mescTime = interval time of each beep.
+
+msec- the duration of the beep, in milliseconds.
+Output
+None
+
+
+Return value:
+None
+
+
+Usage notes:
+The buzzer sounds in a non-blocking manner. After calling this function, the function returns immediately and does not block the call.
+
+
+Simplified example:
+```java
+BeeperImpl.getInstance().startBeep(1, 100); // one short beep; returns immediately
+```
+
+
+Source details:
+```text
+Prototype
+void startBeep(int cnts, int msec)
+Description
+Start Beeping
+Parameters
+Input
+cnts - frequency.
+cnts=1, msec=timeout.
+cnts>1, mescTime = interval time of each beep.
+
+msec- the duration of the beep, in milliseconds.
+Output
+None
+Return
+None
+Remark
+The buzzer sounds in a non-blocking manner. After calling this function, the function returns immediately and does not block the call.
+```
+
+## stopBeep
+
+Stop Beeping
+
+```java
+void stopBeep()
+```
+
+- **类路径：** `com.urovo.sdk.beeper.BeeperImpl`
+- **Demo Activity（参考）：** BeeperActivity
+- **源文档章节：** 1.2
+
+- Source section: `1.2`
+
+- Package/class path: `com.urovo.sdk.beeper.BeeperImpl`
+
+- Demo reference: `UrovoPosSdkDemo/app/src/main/java/com/urovo/sdk/view/BeeperActivity.java`
+
+
+
+Purpose:
+Stop Beeping
+
+
+Signature/prototype:
+```java
+void stopBeep()
+```
+
+
+Parameters:
+Input
+None
+Output
+None
+
+
+Return value:
+None
+
+
+Usage notes:
+Stop the beep immediately after calling this method.
+
+
+Simplified example:
+```java
+BeeperImpl.getInstance().stopBeep();
+```
+
+
+Source details:
+```text
+Prototype
+void stopBeep()
+Description
+Stop Beeping
+Parameters
+Input
+None
+Output
+None
+Return
+None
+Remark
+Stop the beep immediately after calling this method.
+```