About

This document describes how to build jamod from the source package.

Invoking the build

jamod's build is based on Apache ant and requires =v1.6 to be properly installed on your system and available from the command line.

Standard JDK Builds

The build script that needs to be invoked by ant is build.xml. This is the default so if you do not pass the file parameter, this file will be used.

SNAP Builds

The build script that needs to be invoked by ant is build-snap.xml. You will need to pass it using the -f file parameter for ant. We have successfully build jamod for SNAP firmware =0.17.0

To see the build targets and the default target, you should invoke ant with the option -projecthelp

Build Properties

Build properties will be read from your home directory (.build.properties) or from the actual directory (build.properties).
These allow you to toggle flags for the building procedure (standard build.properties file):

# Compiler to be used
build.compiler=modern     

# Flag for building against the RXTX library (with gnu.io prefix)
build.serial.gnu=false
#build.serial.gnu=true

# Deprecation warnings
compile.deprecation=on

## Optimization and Debug
# Development Set
compile.optimize=off
compile.debug=on

# Production/Release set
#compile.optimize=on
#compile.debug=off

javadocs.additionalparam=-breakiterator
      

There are additional properties that need to be set for the SNAP build (also see example):

snap.firmware

the path to the directory where you have stored the SNAP firmware

preverify.bin

The path to the binary used for preverification preverify.

#SNAP has javax.comm interfaces, building for RXTX makes no sense at all
build.serial.gnu=false

snap.firmware=/Data/Resources/SNAP/snap0.17.0
preverify.bin=/usr/bin/preverify