README.md

Java Robot

This is a boilerplate template for java virtual robots, under Pera-Swarm

Local Environment Setup

If you need to run this repository on your local environment, please create a file named 'mqtt.properties' in path, './src/resources/config/' as follows and provide your MQTT broker's configurations.

You can select any channel, as same as your simulation server runs on.

server=127.0.0.1
port=1883
username=user
password=pass
channel="v1"

Install the Library

• You need to setup a GitHub Token with the scope of read:packages and save it along with your GitHub UserName as environment variables as follows:

<server>
    <username>{GITHUB_USERNAME}</username>
    <password>{GITHUB_TOKEN}</password>
</server>

• Run the following command to run the mvn install

mvn -s ./settings.xml -B install --file pom.xml 

Run with commandline

• Compile the packages and assembly with all the dependencies, using mvn compile assembly:single

mvn clean compile assembly:single -s settings.xml 

• Run the code implementation using java -jar [jar_file_path]

java -jar target/java-robot-node-1.0-SNAPSHOT-jar-with-dependencies.jar 

Detailed Guide

• pera-swarm.ce.pdn.ac.lk/docs/robots/virtual/v1/java/