Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

🌱 📎 Components List

Component

Description

arkosLib

Arkos Library, in the *.aar format;

Main contents <ca.amadis.arkoslib>:

  • ArkosSystem;

  • IArkosDisplayProvider;
    (CardHolder & Merchant Display interface;)

  • IArkosPersistProvider;
    (Arkos Configs Persistance)

  • IArkosTechnoPollingProvider;
    (Detect Cards, contact, contactless, mag-stripe;)

  • IArkosTransmitProvider;
    (Level 3 transmission, i.e.: RapidConnect)

  • IArkosSecurityProvider;
    (PIN entry)

olalib

OLA Library, in the *.aar format;

dw-comms

*.aarlibrary, provides Utils {DataWireInformation, DataWireConnector}

AmadisTlv

*.aar library, provides Utils {TlvTree, BuildConfig, TlvUtils}

🧐 📐 Project Structure

Code Block
.
├── AmadisTlv                           # LIBRARIES
│   ├── AmadisTlv.aar                             #
│   └── build.gradle                              #
├── arkoslib                                      #
│   ├── arkoslib.aar                              #
│   └── build.gradle                              #
├── dw-comm                                       #
│   ├── build.gradle                              #
│   └── dw-comm.aar                               #
├── RetailModule                                  #
│   ├── build.gradle                              #
│   └── RetailModule.aar                ###########
│
├── app                                 # MAIN APP
│   ├── proguard-rules.pro                       #
│   └── src                                      #
│       └── main[…]                     ##########
│
├── build.gradle                        # main gradle.build file
├── gradle […]                          # gradle-wrapper and so on (auto)
├── gradle.properties
├── gradlew
├── gradlew.bat
├── local.properties                    # paths to local SDKs
├── olalib
│   ├── build.gradle
│   └── OLA_lib_android.aar
└── settings.gradle                     # link all libraries for main gradle build

🧐 TODO

...

📐 API Documentation – Available
(see next section for a list of upcoming documents)

Code Block
JAVADOC................................................................................................

View file
namejavadoc.zip

Code Block
LIST OF MOST NOTABLE..................................................................................
[ArkosLib]
  - doPayment
  - doCylic
  [Services (callbacks)]
    + cardholderDisplay
    + merchantDisplay
    + cardholderInput
    + cardholderDisplaymerchantInput
    + cardholderChooseApplication
      + merchantDisplaycardholderInputZipCode          // Persist  +(Default)
cardholderInput    + store
       + merchantInput
       load
    + cardholderChooseApplicationdelete             + cardholderInputZipCode            // PersistSecurity
(Default)        + get_pin_block
    + storeget_ksn             + load           // Techno +polling
delete    + poll_techno
    + remove_card // Security             + get_pin_block     // Communication  (Default)
    + get_ksntransmit            // Techno polling          // Validator  + poll_techno (Default)
           + remove_card    validate_acquirer_response        // CommunicationTMSModule
(Default)    +     doConfiguration    + transmit            // Validator	(Default)Retail Module
    + start
     + validate_acquirer_response		// TMSModule
		- doConfiguration		// Retail Module
		- start
		- poll
		- signal
		- respond

📐 Additional guidance

...

Content

...

Accessibility

...

Mobile

...

Best practices

...

poll
    + signal
    + respond

📐 Documentation – Upcoming

  • Workflow UML;

  • Merchant App’s State-Machine UML;

  • Default Stub project;

📐 Current Limitations

  • Only supports RapidConnect;

  • Some card types not yet supported by ArkosLib [TODO: add details]