Chapter 1. Getting Started

Table of Contents

Introduction
Downloading Sources
Configuring, Adapting and Building OpenACN
Feed Back your Fixes and Improvements

Introduction

OpenACN is designed to be customized for a wide range of platforms and uses. At present, there are no pre-built binaries, and no releases of source. There is just source code maintained in a version controlled repository using Subversion, a popular open source version control application. To build ACN for your application you must check-out the source code, configure it for your particular application, then compile and install it.

Downloading Sources

First you need a Subversion client (see Subversion). Once this is intalled OK you should navigate in a suitable command line shell to the place you want to built openACN. You then checkout the source code using the subversion command - svn. If all works properly, Subversion will download all sources and install them into a new openacn directory.

Example 1.1. Checking out the source

$ cd acn_develop
~/acn_develop
$ svn co https://openacn.svn.sourceforge.net/svnroot/openacn/trunk openacn
A    openacn/test
A    openacn/test/main.c
 ...

A    openacn/slp/slp.c
Checked out revision 118.
$ 

This can be any place where you want to do your development.

The main openacn code is called trunk in the repository. There may be other development branches in https://openacn.svn.sourceforge.net/svnroot/openacn/branches/

This is the name of the directory that the source will be installed into. If you omit it, it will simply be called trunk which is probably not what you want. In other places in this documentation the symbolic name ACNROOT is used to indicate this direcory (it is not a good idea to use the literal name ACNROOT in practice).


If openACN is subsequently updated to fix bugs or introduce features, you can update your source.

Example 1.2. Updating your source

~ $ cd acn_develop/openacn
~/acn_develop/openacn $ svn update

Do this with extreme caution since there may be incomplete fixes in development, new bugs or changes to APIs you are using. To check on these you can use Subversion's status, log and diff commands. For more information refer to the excellent and definitive book Version Control with Subversion.

Configuring, Adapting and Building OpenACN

This is covered more fully in Chapter 2, Building and Using openACN.

Feed Back your Fixes and Improvements

The openACN licence places no obligation on you to make public any changes you make at all, however, if you find something which needs fixing and work out how to fix it, then it builds the strength and reliability, not just of your own products, but of those yours will connect to if you report back what you have done. ACN is an interoperability standard and if the equipment you connect to has bugs, there is no guarantee that the service calls will go to them and not to you!

The best way to report your changes, is to submit a patch generated using the diff command. If you cannot do this, then please send a simple report of what you have found to the development mailing list.

SourceForge.net Logo