moonkihong / datamodel-aml-java

DataModel AML library (java)

datamodel-aml-java is a library which provides the way to present raw data(key/value based) to AutomationML(AML) standard format.

• Transform raw data to AML data(XML).
• Serialization / Deserialization AML data using protobuf.

Prerequisites

• Maven
  • Version : 3.0.5 or above
  • Where to download
  • How to install
• Protobuf
  • Version : 3.4.0(mandatory)
  • Protobuf will be installed by build option (See 'How to build')
  • Refer to the links below for manual installation.
    • Where to download
    • How to install

How to build

1. Goto: ~/datamodel-aml-java/

2. Run the script:

   ./build.sh <options>         : Native build for x86_64
   

Notes
(a) For getting help about script option: $ ./build.sh --help
(b) If you build for the first time, set install_prerequisites option true. (e.g. $./build.sh --install_prerequisites=true)
Then it will install the required libraries. In this case, script needs sudo permission for installing the libraries. In future need for sudo will be removed by installing those libraries in aml library.

How to run

Prerequisites

Built datamodel-aml-java library

Sample

1. Goto: ~/datamodel-aml-java/sample/target/
2. export LD_LIBRARY_PATH=../..
3. Run the sample:

    java -jar sample-1.0.0-Release-jar-with-dependencies.jar
   

Usage guide for datamodel-aml-java library (for microservices)

1. The microservice which wants to use aml APIs has to link following libraries:
   
   • datamodel-aml-java-1.0.0-Release-jar-with-dependencies.jar
     
   • jniaml.so
     
   • aml.so
     
2. Reference aml library APIs : doc/index.html