Skip to content
develop
Switch branches/tags
Go to file
Code

Latest commit

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
doc
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

myrobotlab

Open Source Framework for Robotics and Creative Machine Control

Project Website: http://www.myrobotlab.org (Stop by and say hello in the shoutbox!)

Base Requirements

You will need Java 8 or newer. If you are only running MyRobotLab you need the JRE (Java Runtime Environment.) If you are going to be building from source, you'll need the JDK (Java Development Kit)

Download the myrobotlab.jar

Download

latest Nixie 1.1.X

stable Manticore 1.0.2693

Installing Dependencies

After downloading the myrobtlab.jar into a new folder, dependencies for all services can be installed with the following command

Manticore

java -jar myrobotlab.jar -install

Nixie

java -jar myrobotlab.jar --install

Running MyRobotLab

Make sure java is in your path. open a terminal window and change to the directory where you've downloaded the myroblab.jar

To start MyRobotLab you can do so by running

java -jar myrobotlab.jar

If you want to start MyRobotLab and execute a python script on startup, you can use the following command:

java -jar myrobotlab.jar -service runtime Runtime python Python gui SwingGui -invoke python execFile MyScript.py

To pass additional arguments to the JVM on startup (such as increasing the java memory / heap size you can use the -jvm arg :

java -jar myrobotlab.jar -jvm "-Xmx512m -Xms512m"

To start a list of named services on startup, you can use the -service command line arg with a list of service name/type pairs.

java -jar myrobotlab.jar --service runtime Runtime python Python gui SwingGui wegbui WebGui

The above would start runtime, python, the swing gui and lastly the webgui.

Building Project

MyRobotLab core is written in Java. Its web ui is written in AngularJs and html.
And a few services (e.g. InMoov2) are in a different repo. The can be developed seperately so 3 build instruction sets are described.

All development environments require git and cloning the source.

Cloning Repo

create a directory to clone the repositories in (assuming you're on windows and cloning to the c:\dev directory)

mkdir c:\dev
cd dev
git clone https://github.com/MyRobotLab/myrobotlab.git
cd c:\dev\myrobotlab

Java Core

If you want to be making core changes, you will need to install a Java developement environment

Install Java 8

https://www.oracle.com/java/technologies/javase-jdk8-downloads.html

Building with Eclipse

Download Eclipse for Java Developers At: https://www.eclipse.org/downloads/packages/

Building with Maven

MyRobotLab builds using the Apache Maven java build system.

Download Maven At: https://maven.apache.org/download.cgi

To compile and build a myrobotlab.jar first : ensure that "mvn" (maven version 3.3+ is installed and in the path)

mvn clean install

This should produce a local build for you "myrobotlab.jar" file will be located at

myrobotlab/target/myrobotlab.jar

If you want to compile and skip the tests, you can use the standard maven approach

mvn clean install -DskipTests

Contributing

All development is done on the develop branch. To contribute code, the typical approach is to create an issue about the feature/bug you're working on.

From Github create a branch based off the "develop" branch with a descriptive name (and associated Issue number if available) Locally switch to the new branch Make code changes Commit & Push (frequently!) When code is ready, submit a pull request to the develop branch! Enjoy the code review, address issues and concern in the code review Reviewer merges pull request to develop. Reviewer deletes branch.