apis-web

Introduction

apis-web is a software program that provides power interchange-related information to Web services (such as a visualization service) for the development, operation, and maintenance of power interchange. To get information from apis-main installed in multiple nodes connected on a communication lines such as Ethernet, apis-web forms a cluster by using Vert.x and Hazelcast framework functions. From Grid Master in the cluster, it gets hardware information such as the DC/DC converter and battery RSoC information of all nodes and power interchange information from any node. apis-web also has functions to generate power interchange and errors for debugging purposes.

Refer to the apis-web_specification for more information.

Installation

Here is how to install apis-web individually.
git, maven, groovy and JDK must be installed in advance.

$ git clone https://github.com/SonyCSL/apis-bom.git
$ cd apis-bom
$ mvn install
$ cd ../
$ git clone https://github.com/SonyCSL/apis-common.git
$ cd apis-common
$ mvn install
$ cd ../
$ git cone https://github.com/SonyCSL/apis-web.git
$ cd apis-web
$ mvn package

Running

Here is how to run apis-web individually.

$ cd exe
$ bash start.sh

Stopping

Here is how to stop apis-web individually.

$ cd exe
$ bash stop.sh

Parameter Setting

Set the following file parameters in the exe folder as necessary.
Refer to "Chapter 7, About Configuration Files" in the apis-web_specification for more information.

 config.json
   - communityId  (default : oss_communityId)
   - clusterId  (default : oss_clusterId)

 cluster.xml
   - <member>  (default : 127.0.0.1)
   - <interface>  (default : 127.0.0.1)

 start.sh
   -conf   (default : ./config.json)
   -cluster-host   (default : 127.0.0.1)

Documentation

 apis-web_specification(EN)
 apis-web_specification(JP)

API Specification

An example of creating an API specification using the Javadoc command is shown below.
(For Ubuntu18.04)

$ export JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64/  
$ cd apis-web  
$ mvn javadoc:javadoc  

The API specification is created in apis-web/target/site/apidocs/.

License

 Apache License Version 2.0

Notice

 Notice