Calypso SDK (Java)
Clone or download
Latest commit 8e8e03f Dec 20, 2018

README.md

Keyple Java

This is the temporary repository for the Java implementation of the 'Eclipse Keyple' API.

keyple-java repositories structure

  • Modules that are provide as artifacts
    • keyple-core: source and unit tests for the SeProxy module.
    • keyple-calypso: source and unit tests for the Calypso library.
    • keyple-plugin: source and unit tests for the different plugins: smartcard.io PC/SC, Stub, Android NFC, Android OMAPI, etc.
  • developer support, testing
    • example: source for Keyple implementation examples, generic or Calypso specific.
    • integration: source for the integration code (SDK).

Supported platforms

  • Java SE 1.6 compact2
  • Android 4.4 KitKat API level 19

JARs

When moved to the Eclipse repository, the Eclipse Keyple artifacts will be published on Maven. Pending temporary artifacts could be downloaded here:

Keyple packages' usages

The packages to import in order to implement a ticketing application, a reader plugin, or a SE library to manage a specific solution.

  • generic to any SE solution

generic packages

  • specific to Calypso

Calypso packages

Documentation

The current function specification keyple-doc is obsolete. We're rewriting it in to include the lastest evolutions of the Keyple API.

Building the examples and the Keyple components

Java components

Prerequisites

Here are the prerequisites to build the keyple components (jars) and to run the /example projects

Linux or Macos

Following commands will build all the artifacts at once. The first command is required to be executed at least once to build the gradle wrapper.

gradle wrapper --gradle-version 4.5.1
./gradlew build  --info

Windows

Following commands will build all the artifacts at once. The first command is required to be executed at least once to build the gradle wrapper.

gradle wrapper --gradle-version 4.5.1
.\gradlew.bat build  --info

Android components

If you want to build the keyple android components (aar plugins, apk example app), you need :

  • Java JDK 1.8 or newer (OMAPI app requires java 1.8)
  • Intellij 2018 community version or Android Studio 3.0
  • Android sdk 26 should be installed on your machine follow those instructions
  • Gradle (any version as we use the gradle wrapper) available here

To acknowledge where is installed you Android SDK, you need to create a file local.properties in the /android, /android/example/calypso/nfc, /android/example/calypso/omapi folders with the following content sdk.dir=absolut/path/to/where/your/android/sdk/is

For instance sdk.dir=/Users/user/Library/Android/sdk

Linux or Macos

To build the plugins, execute the following commands in the /android folder, the first command is required to be executed at least once to build the gradle wrapper.

gradle wrapper --gradle-version 4.5.1
./gradlew build

To build the example app NFC and OMAPI

./gradlew -b ./example/calypso/nfc/build.gradle assembleDebug 
./gradlew -b ./example/calypso/omapi/build.gradle assembleDebug

Windows

To build the plugins, execute the following commands in the /android folder, the first command is required to be executed at least once to build the gradle wrapper.

gradle wrapper --gradle-version 4.5.1`
.\gradlew.bat build

To build the example app NFC and OMAPI

.\gradlew.bat -b ./example/calypso/nfc/build.gradle assembleDebug 
.\gradlew.bat -b ./example/calypso/omapi/build.gradle assembleDebug