Skip to content

Latest commit

 

History

History
executable file
·
133 lines (81 loc) · 5.77 KB

README.md

File metadata and controls

executable file
·
133 lines (81 loc) · 5.77 KB
Raw

This is a sample code showing how to use MyLaps X2 SDK with Kotlin language. The example binds SDK's native libs, creates SDK instance, calls its methods and handle events from X2 Appliance with excellent performance.

The Kotlin Native is used to bind local libs (not JVM version). Gradle is used to build the app with Kotlin multi-platform plugin.

MYLAPS is not responsible for this code and cannot provide support or warranty on it If you ned any help, contact author of the repo.

This sample connects to MyLaps X2 server, not decoders. A direct connection to decoder is not supported by MyLaps anymore. Also the app does not support connection to legacy decoders like AMBrc Decoder, MYLAPS RC4 Decoder, AMBmx3 Decoder, TranX3 Decoder, ChipX/ProChip Decoder, BIB Decoder, AMBrc, AMB20, AMB130, TranX-2 / TranX2, TranXPro, Activ or PegaSys. If you need help with those decoders, see https://ammconverter.eu.

Supported platforms

The project can natively run on LinuxX64 or Windows X64 platforms. It also runs on MacOSX or others using Docker. There is additional platform dependency on Intel X64.

Note: MyLaps provides X2 SDK binaries compiled for Intel 64bit and 32 it HW platforms only. Anyway, this example app support the 64 bit platform as this is commonly used today.

Pre-installation

  • Contact MyLaps to download X2 SDK. Copy it to the root directory sdk-master, version min 4.1+
  • Java/JDK 64 must be installed and present on PATH or JAVA_HOME
  • the ZeroMQ is not necessary as binaries are part of the repo in zmq/linux|windows
  • make sure you have X2 appliance available on network, have it hostname, username and password
  • if dockerized version required, install Docker and Docker-compose

Compiling example

On Linux X64

The gradle build will download gradle building tool and all related dependencies.

Compiling example project using gradle:

./gradlew build

On Windows X64

The gradle build will download gradle building tool and all related dependencies.

Compiling example project using gradle:

gradlew.bat build

*Note: the build task will build Windows and Linux binaries

On Mac OSX X64

Make sure Docker for Mac is install and run building process inside the docker container (using docker-compose) See all details inside the docker-compose.yml:

docker-compose run app-build

Running example app on Linux

export LD_LIBRARY_PATH=sdk-master/lib/linux/x86-64:zmq/linux
./build/bin/linuxX64/debugExecutable/x2.kexe <hostname> <username> <password>

Running example app on Windows

Copy all files from sdk-master/lib/windows/x64 and zmq/windows into the same directory where x2.exe is located and run:

./build/bin/mingwX64/debugExecutable/x2.exe <hostname> <username> <password>

Running example app on Mac OSX

docker-compose run x2 <x2hostname> <username> <password>

Example output on console

Passing example output on console

[MDP_NOTIFY_INSERT] Transponder 5530258 -> 69
[MDP_NOTIFY_INSERT] Transponder 5530259 -> 66
[MDP_NOTIFY_INSERT] Passing trigger 1
[MDP_NOTIFY_INSERT] Passing trigger type FirstContact id: 9812391 LoopId: 39 Transponder: 99_M TimeUTC 9:36:23.0213 Time: 9:36:23.0213 isResend: false
[MDP_NOTIFY_INSERT] Passing trigger 1
[MDP_NOTIFY_INSERT] Passing trigger type FirstContact id: 9812392 LoopId: 89 Transponder: 66_M TimeUTC 9:36:22.9320 Time: 9:36:22.9320 isResend: false

Intellij IDEA support

If running Intellij Idea on Linux or Windows, it understands the Kotlin multi-platform project and its libraries (klib). This provides smart code completion and static type checking calling native code. This is very convenient and productive way of working with MyLaps X2 SDK in Kotlin.

MyLaps support

Thank you MyLaps for supporting this project!

ZeroMQ usage

Usage of ZeroMQ demonstrates how MyLaps SDK passes context to custom handlers. The context is ZeroMQ connection/context used in handler to send Passing JSON to the ZMQ publisher queue. To listen on ZeroMQ messages, use a simple client zmq/sub.py

An example message in ZMQ:

{u'transponderId': u'5781475', u'utcTime': u'7:39:20.6878', u'localTime': u'9:39:20.6878', u'transponder': u'54_M', u'passingId': 5531526}

Future work TBD

  • covering more events from X2 appliance, like manual event, resend example, time sync etc
  • more code sharing between Windows and Linux
  • unit testing, if multiplatform plugin will support it

Known issues

  • Memory leaking

Yes, it happens. The sample project has memory leak runing over time. This is caused b Kotlin Native vs using native callbacks. We have to wait for Kotlin native authors to fix this

  • This issue is caused by Java 32bit platform used for compilation. Download and install 64bit Java/JDK version to fix

    Task :cinteropMylapsLinuxX64 FAILED Error occurred during initialization of VM Could not reserve enough space for 3145728KB object heap

    Task :cinteropMylapsMingwX64 FAILED Error occurred during initialization of VM Could not reserve enough space for 3145728KB object heap

  • strcpy issue

If running into the issue with strcpy, there is workaround to fix this:

Exception in thread "main" java.lang.Error: C:\Users\adams\.konan\dependencies\msys2-mingw-w64-x86_64-gcc-7.3.0-clang-llvm-lld-6.0.1\x86_64-w64-mingw32\include\sec_api/string_s.h:39:27: error: conflicting types for 'strncpy'

Edit sdk-master/include/TTPlatform.h and comment out all additional functions definition in section "Defines to make gcc compatible with Visual Studio 2005"