wiki.openlighting.org - User contributions [en]

IPad ArtNet Node

2011-07-01T20:24:06Z

Tobi: Reduced section hierarchy

Written by Tobi Schäfer, September 2010.
Updated by Tobi Schäfer, July 2011.

Prerequisites: libartnet 1.1.0, Mac OS X 10.6.8, Xcode 4.0.2, iPad w/ iOS 4.3

== Using libartnet in Xcode ==

This is documentation of my first steps using libartnet and Xcode. I am still a complete newbie with all these things. However, I suceeded in running a simple program on the iPad sending and receiving Art-Net data – not without help from the excellent people of the open-ligthing ML<ref>http://groups.google.com/group/open-lighting/browse_thread/thread/e3f322613b710d9d/661d7e4babba4bf1</ref>. I tried to sum up here my experiences so far, although I am sure there are better ways to achieve the same result.

First, we download the libartnet sources and prepare them for inclusion in Xcode. We need to generate a file called <code>config.h</code> to make things work. This can be done either by downloading a tarball or checking out the sources with Git.

=== Preparing libartnet from Tarball ===

$ curl -O http://code.google.com/p/linux-lighting/downloads/detail?name=libartnet-1.1.0.tar.gz
$ tar -xzf libartnet-1.1.0.tar.gz
$ cd libartnet-1.1.0/
$ ./configure
$ cp config.h artnet/

=== Preparing libartnet from Git ===

$ git clone http://git.opendmx.net/libartnet
$ cd libartnet/
$ autoreconf -i
$ ./configure
$ cp config.h artnet/

=== Adding libartnet to Xcode ===

Create a directory called <code>Vendor/artnet</code> in the Xcode project directory – in the file system or Finder, not in the Xcode application; the latter will be done in the next step – and copy the source files from the <code>artnet</code> directory of the previous step into the new <code>Vendor/artnet</code> directory.

$ mkdir -p ~/test/Vendor/artnet
$ cp artnet/*.[ch] ~/test/Vendor/artnet

$ ls -l ~/test
total 0
drwxr-xr-x 10 tobi tobi 340 Jul 1 17:20 ArtNetTest
drwxr-xr-x 5 tobi tobi 170 Jul 1 21:17 ArtNetTest.xcodeproj
drwxr-xr-x 7 tobi tobi 238 Jul 1 15:05 ArtNetTestTests
drwxr-xr-x 4 tobi tobi 136 Jul 1 21:08 Vendor

$ ls -l ~/test/Vendor/artnet
total 352
-rw-r--r-- 1 tobi tobi 44082 Jul 1 20:52 artnet.c
-rw-r--r-- 1 tobi tobi 11580 Jul 1 20:52 artnet.h
-rw-r--r-- 1 tobi tobi 1987 Jul 1 20:52 common.h
-rw-r--r-- 1 tobi tobi 4831 Jul 1 20:52 config.h
-rw-r--r-- 1 tobi tobi 1754 Jul 1 20:52 misc.c
-rw-r--r-- 1 tobi tobi 1610 Jul 1 20:52 misc.h
-rw-r--r-- 1 tobi tobi 18941 Jul 1 20:52 network.c
-rw-r--r-- 1 tobi tobi 8495 Jul 1 20:52 packets.h
-rw-r--r-- 1 tobi tobi 13397 Jul 1 20:52 private.h
-rw-r--r-- 1 tobi tobi 27731 Jul 1 20:52 receive.c
-rw-r--r-- 1 tobi tobi 2806 Jul 1 20:52 tod.c
-rw-r--r-- 1 tobi tobi 1307 Jul 1 20:52 tod.h
-rw-r--r-- 1 tobi tobi 12364 Jul 1 20:52 transmit.c

Now drag&drop the Vendor folder to the top level of the Xcode project and choose the following options for adding files.

[[File:Screen_shot_2011-07-01_at_20.45.17.png‎]]

The structure of your project should look similar to this:

[[File:Screen_shot_2011-07-01_at_20.57.03.png‎]]

Add the path to the <code>Vendor</code> directory to the Header Search Paths in the Search Paths section of your build target and tick the recursive checkbox.<ref>http://iphone.olipion.com/cross-compilation/include-library-in-xcode-project</ref>

[[File:Screen_shot_2011-07-01_at_21.10.22.png‎]]

Finally. add the <code>HAVE_CONFIG_H</code> macro to the Preprocessor Macros section of your project’s build settings.

[[File:Screen_shot_2011-07-01_at_21.17.40.png]]

At this point your project should build and run without error – the libartnet source code will be compiled and linked automatically.

== Example Code ==

You now should be ready to build and run the following code in the Simulator as well as on the iPad. Thus, do not forget to select the corresponding setting from the Overview drop-down menu.

[[File:Screen shot 2010-09-16 at 12.12.59.png]]

The code is just a proof of concept and not ready for production – actually it is pretty bad because it abuses the <code>main</code> method instead of creating its own controller. However, it reduces complexity and simply shows the basic approach to using libartnet from within Objective-C code.

The code creates and sets up an Art-Net node, defines a handler method for incoming data and then creates an infinite loop sending Art-Net polls and checking for Art-Net input.

#import "artnet.h"
#import "packets.h"

int artnetReceiver(artnet_node node, void *pp, void *d) {
NSLog(@"Receiving Art-Net data!");
artnet_packet pack = (artnet_packet) pp;
printf("Received packet sequence %d\n", pack->data.admx.sequence);
printf("Received packet type %d\n", pack->type);
printf("Received packet data %s\n", pack->data.admx.data);
return 0;
}

int main(int argc, char *argv[]) {

char *ip_addr = NULL;

uint8_t subnet_addr = 0;
uint8_t port_addr = 1;

artnet_node *artnetNode = artnet_new(ip_addr, 1);

if (!artnetNode) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

artnet_set_long_name(artnetNode, "Art-Net Test");
artnet_set_short_name(artnetNode, "ANT");

// set the upper 4 bits of the universe address
artnet_set_subnet_addr(artnetNode, subnet_addr) ;

// enable port 0
artnet_set_port_type(artnetNode, 0, ARTNET_ENABLE_OUTPUT, ARTNET_PORT_DMX) ;

// bind port 0 to universe 1
artnet_set_port_addr(artnetNode, 0, ARTNET_OUTPUT_PORT, port_addr);

artnet_dump_config(artnetNode);

artnet_set_handler(artnetNode, ARTNET_RECV_HANDLER, artnetReceiver, NULL);

if (artnet_start(artnetNode) != 0) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

while (YES) {
artnet_send_poll(artnetNode, NULL, ARTNET_TTM_DEFAULT);
//printf("arnet_get_sd() => %i\n", artnet_get_sd(artnetNode));
printf("artnet_read() => %i\n", artnet_read(artnetNode, 1));
}

// Use this to deallocate memory
//artnet_stop(artnetNode);
//artnet_destroy(artnetNode);

return 0;
}

== Testing Data Transmission ==

If your program builds and runs without errors you now can test whether Art-Net data is sent and received. Wireshark<ref>http://www.wireshark.org</ref> is a handy tool for monitoring your network.

However, for sending Art-Net data you will need a more appropriate tool. I am using the [[OLA_Command_Line_Tools|OLA Command Line Tools]], running them from another machine with GNU/Linux (Ubuntu 10.04) as operating system.

Although I did not test it, you probably can also install OLA on the same machine you are running Xcode on.

=== Installing OLA on Mac OS X ===

Please refer to the [[OLA_on_OS_X|OLA On Mac OS X]] page.

=== Installing OLA on Ubuntu ===

Please refer to the [[OLA_on_Linux|OLA On Linux]] page.

=== Patching an Art-Net Node ===

To make the Ubuntu machine act as an Art-Net node first start the OLA daemon with a debug level of 3:

olad -l 3

Then patch the machine for Art-Net output in universe 1 on port 0:

ola_patch -d 1 -p 0 -u 1

Now start <code>ola_dmxconsole</code> for sending some Art-Net data in universe 1:

ola_dmxconsole -u 1

If you run the Art-Net project in Xcode (either with the Simulator or on the iPad) and open the Xcode console window you should see log messages according to your actions in the DMX console.

E.g. try to navigate to a channel with the left and right cursor keys and then increase or decrease the value with the scroll up/down keys.

[[File:Screenshot-tobi@acker- ~.png]]

== References ==

<references/>

IPad ArtNet Node

2011-07-01T20:20:28Z

Tobi: Moved description of known issues when compiling OLA on Linux to corresponding page

Written by Tobi Schäfer, September 2010.
Updated by Tobi Schäfer, July 2011.

Prerequisites: libartnet 1.1.0, Mac OS X 10.6.8, Xcode 4.0.2, iPad w/ iOS 4.3

== Using libartnet in Xcode ==

This is documentation of my first steps using libartnet and Xcode. I am still a complete newbie with all these things. However, I suceeded in running a simple program on the iPad sending and receiving Art-Net data – not without help from the excellent people of the open-ligthing ML<ref>http://groups.google.com/group/open-lighting/browse_thread/thread/e3f322613b710d9d/661d7e4babba4bf1</ref>. I tried to sum up here my experiences so far, although I am sure there are better ways to achieve the same result.

=== Preparing libartnet ===

First, we download the libartnet sources and prepare them for inclusion in Xcode. We need to generate a file called <code>config.h</code> to make things work.

==== Using Tarball ====

$ curl -O http://code.google.com/p/linux-lighting/downloads/detail?name=libartnet-1.1.0.tar.gz
$ tar -xzf libartnet-1.1.0.tar.gz
$ cd libartnet-1.1.0/
$ ./configure
$ cp config.h artnet/

==== Using Git ====

$ git clone http://git.opendmx.net/libartnet
$ cd libartnet/
$ autoreconf -i
$ ./configure
$ cp config.h artnet/

=== Adding libartnet to Xcode ===

Create a directory called <code>Vendor/artnet</code> in the Xcode project directory – in the file system or Finder, not in the Xcode application; the latter will be done in the next step – and copy the source files from the <code>artnet</code> directory of the previous step into the new <code>Vendor/artnet</code> directory.

$ mkdir -p ~/test/Vendor/artnet
$ cp artnet/*.[ch] ~/test/Vendor/artnet

$ ls -l ~/test
total 0
drwxr-xr-x 10 tobi tobi 340 Jul 1 17:20 ArtNetTest
drwxr-xr-x 5 tobi tobi 170 Jul 1 21:17 ArtNetTest.xcodeproj
drwxr-xr-x 7 tobi tobi 238 Jul 1 15:05 ArtNetTestTests
drwxr-xr-x 4 tobi tobi 136 Jul 1 21:08 Vendor

$ ls -l ~/test/Vendor/artnet
total 352
-rw-r--r-- 1 tobi tobi 44082 Jul 1 20:52 artnet.c
-rw-r--r-- 1 tobi tobi 11580 Jul 1 20:52 artnet.h
-rw-r--r-- 1 tobi tobi 1987 Jul 1 20:52 common.h
-rw-r--r-- 1 tobi tobi 4831 Jul 1 20:52 config.h
-rw-r--r-- 1 tobi tobi 1754 Jul 1 20:52 misc.c
-rw-r--r-- 1 tobi tobi 1610 Jul 1 20:52 misc.h
-rw-r--r-- 1 tobi tobi 18941 Jul 1 20:52 network.c
-rw-r--r-- 1 tobi tobi 8495 Jul 1 20:52 packets.h
-rw-r--r-- 1 tobi tobi 13397 Jul 1 20:52 private.h
-rw-r--r-- 1 tobi tobi 27731 Jul 1 20:52 receive.c
-rw-r--r-- 1 tobi tobi 2806 Jul 1 20:52 tod.c
-rw-r--r-- 1 tobi tobi 1307 Jul 1 20:52 tod.h
-rw-r--r-- 1 tobi tobi 12364 Jul 1 20:52 transmit.c

Now drag&drop the Vendor folder to the top level of the Xcode project and choose the following options for adding files.

[[File:Screen_shot_2011-07-01_at_20.45.17.png‎]]

The structure of your project should look similar to this:

[[File:Screen_shot_2011-07-01_at_20.57.03.png‎]]

Add the path to the <code>Vendor</code> directory to the Header Search Paths in the Search Paths section of your build target and tick the recursive checkbox.<ref>http://iphone.olipion.com/cross-compilation/include-library-in-xcode-project</ref>

[[File:Screen_shot_2011-07-01_at_21.10.22.png‎]]

Finally. add the <code>HAVE_CONFIG_H</code> macro to the Preprocessor Macros section of your project’s build settings.

[[File:Screen_shot_2011-07-01_at_21.17.40.png]]

At this point your project should build and run without error – the libartnet source code will be compiled and linked automatically.

== Example Code ==

You now should be ready to build and run the following code in the Simulator as well as on the iPad. Thus, do not forget to select the corresponding setting from the Overview drop-down menu.

[[File:Screen shot 2010-09-16 at 12.12.59.png]]

The code is just a proof of concept and not ready for production – actually it is pretty bad because it abuses the <code>main</code> method instead of creating its own controller. However, it reduces complexity and simply shows the basic approach to using libartnet from within Objective-C code.

The code creates and sets up an Art-Net node, defines a handler method for incoming data and then creates an infinite loop sending Art-Net polls and checking for Art-Net input.

#import "artnet.h"
#import "packets.h"

int artnetReceiver(artnet_node node, void *pp, void *d) {
NSLog(@"Receiving Art-Net data!");
artnet_packet pack = (artnet_packet) pp;
printf("Received packet sequence %d\n", pack->data.admx.sequence);
printf("Received packet type %d\n", pack->type);
printf("Received packet data %s\n", pack->data.admx.data);
return 0;
}

int main(int argc, char *argv[]) {

char *ip_addr = NULL;

uint8_t subnet_addr = 0;
uint8_t port_addr = 1;

artnet_node *artnetNode = artnet_new(ip_addr, 1);

if (!artnetNode) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

artnet_set_long_name(artnetNode, "Art-Net Test");
artnet_set_short_name(artnetNode, "ANT");

// set the upper 4 bits of the universe address
artnet_set_subnet_addr(artnetNode, subnet_addr) ;

// enable port 0
artnet_set_port_type(artnetNode, 0, ARTNET_ENABLE_OUTPUT, ARTNET_PORT_DMX) ;

// bind port 0 to universe 1
artnet_set_port_addr(artnetNode, 0, ARTNET_OUTPUT_PORT, port_addr);

artnet_dump_config(artnetNode);

artnet_set_handler(artnetNode, ARTNET_RECV_HANDLER, artnetReceiver, NULL);

if (artnet_start(artnetNode) != 0) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

while (YES) {
artnet_send_poll(artnetNode, NULL, ARTNET_TTM_DEFAULT);
//printf("arnet_get_sd() => %i\n", artnet_get_sd(artnetNode));
printf("artnet_read() => %i\n", artnet_read(artnetNode, 1));
}

// Use this to deallocate memory
//artnet_stop(artnetNode);
//artnet_destroy(artnetNode);

return 0;
}

== Testing Data Transmission ==

If your program builds and runs without errors you now can test whether Art-Net data is sent and received. Wireshark<ref>http://www.wireshark.org</ref> is a handy tool for monitoring your network.

However, for sending Art-Net data you will need a more appropriate tool. I am using the [[OLA_Command_Line_Tools|OLA Command Line Tools]], running them from another machine with GNU/Linux (Ubuntu 10.04) as operating system.

Although I did not test it, you probably can also install OLA on the same machine you are running Xcode on.

=== Installing OLA on Mac OS X ===

Please refer to the [[OLA_on_OS_X|OLA On Mac OS X]] page.

=== Installing OLA on Ubuntu ===

Please refer to the [[OLA_on_Linux|OLA On Linux]] page.

=== Patching an Art-Net Node ===

To make the Ubuntu machine act as an Art-Net node first start the OLA daemon with a debug level of 3:

olad -l 3

Then patch the machine for Art-Net output in universe 1 on port 0:

ola_patch -d 1 -p 0 -u 1

Now start <code>ola_dmxconsole</code> for sending some Art-Net data in universe 1:

ola_dmxconsole -u 1

If you run the Art-Net project in Xcode (either with the Simulator or on the iPad) and open the Xcode console window you should see log messages according to your actions in the DMX console.

E.g. try to navigate to a channel with the left and right cursor keys and then increase or decrease the value with the scroll up/down keys.

[[File:Screenshot-tobi@acker- ~.png]]

== References ==

<references/>

OLA on Linux

2011-07-01T20:17:58Z

Tobi: Added new section about known issues

This describes how to get [[OLA]] working on a Linux system either from the git repo or by using a [http://code.google.com/p/linux-lighting/downloads/list released tarball].

=Checkout or Download an Archive=

Either download a tarball from the releases page, or check out the git repo with the following command:

git clone http://git.opendmx.net/ola

If you don't have '''git''' yet, you'll need to install it with your distro's package manager.

=Install libraries=

You need a couple of libraries installed for everything to work correctly. Some of these are available as packages in distros but others need to be downloaded and built manually.

First up you'll need the following:
* cppunit
* uuid or ossp uuid
* pkg-config
* curses

Debian/Ubuntu users can install them with apt:

apt-get install libcppunit-dev libcppunit-1.12-1 uuid-dev pkg-config libncurses5-dev zlib1g-dev

If you're building from git you'll also need the following:

* libtool
* automake
* autoconf

apt-get install libtool autoconf automake

Next, you need '''Protocol Buffers''' [http://code.google.com/p/protobuf/ http://code.google.com/p/protobuf/] version 2.3.0 from Google (BSD license). Most likely, you'll need to download and build them yourself. Note that 2.4.0 won't work yet as some of the functionality has changed.

Debian (and Ubuntu) users can, in some cases, use the following packages (not yet in stable):
libprotobuf2 (libprotobuf3), libprotobuf-dev, protobuf-compiler

Finally, if you want to use the built in webserver, you'll need '''microhttpd'''. Note: you'll need version >= 0.4.0 of microhttpd else you will get errors:

* [ftp://ftp.gnu.org/gnu/libmicrohttpd/ ftp://ftp.gnu.org/gnu/libmicrohttpd/]

Once everything is installed, run ldconfig as root to pick up the new libraries

sudo ldconfig

=Configure=

If you checked out the sources from git, you'll need to run

autoreconf -i

After that run

./configure

=Building & Testing=

Build
make

Run the tests
make check

And install OLA
sudo make install
sudo ldconfig

=Install ola-examples=

The [[OLA Command Line Tools]] come separately. Again either download a tarball or checkout from the git repo:

git clone http://www.nomis52.net/git/lla-examples

The steps are similar to building the main package.

autoreconf -i # if you used the git repo
./configure
make
sudo make install

Note in order for ola_dmxmonitor and ola_dmxconsole to build you *must* have curses installed.

=Known Issues=

If you get an error like the following:

/bin/sh ./libtool --tag=CC --mode=compile gcc -DHAVE_CONFIG_H -I. -I/opt/local/var/macports/software/protobuf-cpp/2.0.3_0/opt/local/include/ -g -O2 -c -o ltdl.lo ltdl.c
./libtool: line 464: CDPATH: command not found
/Users/simonn/lighting/lla/libltdl/libtool: line 464: CDPATH: command not found
/Users/simonn/lighting/lla/libltdl/libtool: line 1142: func_opt_split: command not found
libtool: Version mismatch error. This is libtool 2.2.6, but the
libtool: definition of this LT_INIT comes from an older release.
libtool: You should recreate aclocal.m4 with macros from libtool 2.2.6
libtool: and run autoconf again.

Your system uses a different version of libtool. Run:

libtoolize --ltdl -c -f

and then start from the autoreconf step again.

If you should get the following error try to fix it with one of [http://groups.google.com/group/open-lighting/msg/72060f6327d30df6 two available solutions]:

Rpc.pb.cc: In copy constructor 'ola::rpc::RpcMessage::RpcMessage(const ola::rpc::RpcMessage&)':
Rpc.pb.cc:143: error: base class 'class google::protobuf::Message' should be explicitly initialized in the copy constructor

A similar error can occur when building the ola-examples package:

g++ -DHAVE_CONFIG_H -I. -I.. -Wall -Werror -I/usr/local/include/
libola -g -O2 -MT ola-dmxconsole.o -MD -MP -MF .deps/ola-
dmxconsole.Tpo -c -o ola-dmxconsole.o ola-dmxconsole.cpp
cc1plus: warnings being treated as errors
ola-dmxconsole.cpp: In function ‘void mask()’:
ola-dmxconsole.cpp:150: error: value computed is not used
ola-dmxconsole.cpp:156: error: value computed is not used
ola-dmxconsole.cpp: In function ‘void values()’:
ola-dmxconsole.cpp:184: error: value computed is not used
ola-dmxconsole.cpp:188: error: value computed is not used
ola-dmxconsole.cpp:190: error: value computed is not used
ola-dmxconsole.cpp:194: error: value computed is not used
ola-dmxconsole.cpp:197: error: value computed is not used
ola-dmxconsole.cpp:202: error: value computed is not used
ola-dmxconsole.cpp:205: error: value computed is not used
ola-dmxconsole.cpp:208: error: value computed is not used
ola-dmxconsole.cpp:215: error: value computed is not used
ola-dmxconsole.cpp:225: error: value computed is not used
ola-dmxconsole.cpp:226: error: value computed is not used
ola-dmxconsole.cpp:227: error: value computed is not used
make[2]: *** [ola-dmxconsole.o] Error 1

You should be able to prevent this by [http://groups.google.com/group/open-lighting/msg/c6d86d03dd74ed5b editing <code>./src/Makefile.am</code>], removing <code>-Werror</code> and then start from the autoreconfig step again.

Libartnet

2011-07-01T20:05:30Z

Tobi: Added link to iPad ArtNet Node page

Link: http://code.google.com/p/linux-lighting/ 
{{Features|linux=yes|osx=yes|win=yes|rdm=yes|free=yes}}

libartnet is a implementation of the [[ArtNet]] protocol for Linux,Mac & Windows and is part of the [[OLA|Open Lighting Architecture]]. The artnet-examples package provides sample programs demonstrating the use of the library. Of particular interest is artnet_usb which allows ArtNet to DMX conversion by using the Enttec [[Open DMX USB]].

Related Tutorials:
* [[Linux ArtNet Node]]
* [[Libartnet on Windows]]
* [[iPad ArtNet Node]]

Related Products:
* [[OLA]]
* [[Open DMX USB]]

[[Category:Drivers / Libraries]]

IPad ArtNet Node

2011-07-01T19:59:50Z

Tobi:

Written by Tobi Schäfer, September 2010.
Updated by Tobi Schäfer, July 2011.

Prerequisites: libartnet 1.1.0, Mac OS X 10.6.8, Xcode 4.0.2, iPad w/ iOS 4.3

== Using libartnet in Xcode ==

This is documentation of my first steps using libartnet and Xcode. I am still a complete newbie with all these things. However, I suceeded in running a simple program on the iPad sending and receiving Art-Net data – not without help from the excellent people of the open-ligthing ML<ref>http://groups.google.com/group/open-lighting/browse_thread/thread/e3f322613b710d9d/661d7e4babba4bf1</ref>. I tried to sum up here my experiences so far, although I am sure there are better ways to achieve the same result.

=== Preparing libartnet ===

First, we download the libartnet sources and prepare them for inclusion in Xcode. We need to generate a file called <code>config.h</code> to make things work.

==== Using Tarball ====

$ curl -O http://code.google.com/p/linux-lighting/downloads/detail?name=libartnet-1.1.0.tar.gz
$ tar -xzf libartnet-1.1.0.tar.gz
$ cd libartnet-1.1.0/
$ ./configure
$ cp config.h artnet/

==== Using Git ====

$ git clone http://git.opendmx.net/libartnet
$ cd libartnet/
$ autoreconf -i
$ ./configure
$ cp config.h artnet/

=== Adding libartnet to Xcode ===

Create a directory called <code>Vendor/artnet</code> in the Xcode project directory – in the file system or Finder, not in the Xcode application; the latter will be done in the next step – and copy the source files from the <code>artnet</code> directory of the previous step into the new <code>Vendor/artnet</code> directory.

$ mkdir -p ~/test/Vendor/artnet
$ cp artnet/*.[ch] ~/test/Vendor/artnet

$ ls -l ~/test
total 0
drwxr-xr-x 10 tobi tobi 340 Jul 1 17:20 ArtNetTest
drwxr-xr-x 5 tobi tobi 170 Jul 1 21:17 ArtNetTest.xcodeproj
drwxr-xr-x 7 tobi tobi 238 Jul 1 15:05 ArtNetTestTests
drwxr-xr-x 4 tobi tobi 136 Jul 1 21:08 Vendor

$ ls -l ~/test/Vendor/artnet
total 352
-rw-r--r-- 1 tobi tobi 44082 Jul 1 20:52 artnet.c
-rw-r--r-- 1 tobi tobi 11580 Jul 1 20:52 artnet.h
-rw-r--r-- 1 tobi tobi 1987 Jul 1 20:52 common.h
-rw-r--r-- 1 tobi tobi 4831 Jul 1 20:52 config.h
-rw-r--r-- 1 tobi tobi 1754 Jul 1 20:52 misc.c
-rw-r--r-- 1 tobi tobi 1610 Jul 1 20:52 misc.h
-rw-r--r-- 1 tobi tobi 18941 Jul 1 20:52 network.c
-rw-r--r-- 1 tobi tobi 8495 Jul 1 20:52 packets.h
-rw-r--r-- 1 tobi tobi 13397 Jul 1 20:52 private.h
-rw-r--r-- 1 tobi tobi 27731 Jul 1 20:52 receive.c
-rw-r--r-- 1 tobi tobi 2806 Jul 1 20:52 tod.c
-rw-r--r-- 1 tobi tobi 1307 Jul 1 20:52 tod.h
-rw-r--r-- 1 tobi tobi 12364 Jul 1 20:52 transmit.c

Now drag&drop the Vendor folder to the top level of the Xcode project and choose the following options for adding files.

[[File:Screen_shot_2011-07-01_at_20.45.17.png‎]]

The structure of your project should look similar to this:

[[File:Screen_shot_2011-07-01_at_20.57.03.png‎]]

Add the path to the <code>Vendor</code> directory to the Header Search Paths in the Search Paths section of your build target and tick the recursive checkbox.<ref>http://iphone.olipion.com/cross-compilation/include-library-in-xcode-project</ref>

[[File:Screen_shot_2011-07-01_at_21.10.22.png‎]]

Finally. add the <code>HAVE_CONFIG_H</code> macro to the Preprocessor Macros section of your project’s build settings.

[[File:Screen_shot_2011-07-01_at_21.17.40.png]]

At this point your project should build and run without error – the libartnet source code will be compiled and linked automatically.

== Example Code ==

You now should be ready to build and run the following code in the Simulator as well as on the iPad. Thus, do not forget to select the corresponding setting from the Overview drop-down menu.

[[File:Screen shot 2010-09-16 at 12.12.59.png]]

The code is just a proof of concept and not ready for production – actually it is pretty bad because it abuses the <code>main</code> method instead of creating its own controller. However, it reduces complexity and simply shows the basic approach to using libartnet from within Objective-C code.

The code creates and sets up an Art-Net node, defines a handler method for incoming data and then creates an infinite loop sending Art-Net polls and checking for Art-Net input.

#import "artnet.h"
#import "packets.h"

int artnetReceiver(artnet_node node, void *pp, void *d) {
NSLog(@"Receiving Art-Net data!");
artnet_packet pack = (artnet_packet) pp;
printf("Received packet sequence %d\n", pack->data.admx.sequence);
printf("Received packet type %d\n", pack->type);
printf("Received packet data %s\n", pack->data.admx.data);
return 0;
}

int main(int argc, char *argv[]) {

char *ip_addr = NULL;

uint8_t subnet_addr = 0;
uint8_t port_addr = 1;

artnet_node *artnetNode = artnet_new(ip_addr, 1);

if (!artnetNode) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

artnet_set_long_name(artnetNode, "Art-Net Test");
artnet_set_short_name(artnetNode, "ANT");

// set the upper 4 bits of the universe address
artnet_set_subnet_addr(artnetNode, subnet_addr) ;

// enable port 0
artnet_set_port_type(artnetNode, 0, ARTNET_ENABLE_OUTPUT, ARTNET_PORT_DMX) ;

// bind port 0 to universe 1
artnet_set_port_addr(artnetNode, 0, ARTNET_OUTPUT_PORT, port_addr);

artnet_dump_config(artnetNode);

artnet_set_handler(artnetNode, ARTNET_RECV_HANDLER, artnetReceiver, NULL);

if (artnet_start(artnetNode) != 0) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

while (YES) {
artnet_send_poll(artnetNode, NULL, ARTNET_TTM_DEFAULT);
//printf("arnet_get_sd() => %i\n", artnet_get_sd(artnetNode));
printf("artnet_read() => %i\n", artnet_read(artnetNode, 1));
}

// Use this to deallocate memory
//artnet_stop(artnetNode);
//artnet_destroy(artnetNode);

return 0;
}

== Testing Data Transmission ==

If your program builds and runs without errors you now can test whether Art-Net data is sent and received. Wireshark<ref>http://www.wireshark.org</ref> is a handy tool for monitoring your network.

However, for sending Art-Net data you will need a more appropriate tool. I am using the [[OLA_Command_Line_Tools|OLA Command Line Tools]], running them from another machine with GNU/Linux (Ubuntu 10.04) as operating system.

Although I did not test it, you probably can also install OLA on another Mac or even the same machine you are running XCode on, using the [https://trac.macports.org/browser/trunk/dports/net/ola/Portfile OLA MacPorts port] and/or following the steps of the [[OLA_on_OS_X|OLA On Mac OS X]] page.

=== Installing OLA On Ubuntu ===

Please refer to the [[OLA_on_Linux|OLA On Linux]] page.

If you should get the following error try to fix it with one of [http://groups.google.com/group/open-lighting/msg/72060f6327d30df6 two available solutions]:

Rpc.pb.cc: In copy constructor 'ola::rpc::RpcMessage::RpcMessage(const ola::rpc::RpcMessage&)':
Rpc.pb.cc:143: error: base class 'class google::protobuf::Message' should be explicitly initialized in the copy constructor

A similar error can occur when building the ola-examples package:

g++ -DHAVE_CONFIG_H -I. -I.. -Wall -Werror -I/usr/local/include/
libola -g -O2 -MT ola-dmxconsole.o -MD -MP -MF .deps/ola-
dmxconsole.Tpo -c -o ola-dmxconsole.o ola-dmxconsole.cpp
cc1plus: warnings being treated as errors
ola-dmxconsole.cpp: In function ‘void mask()’:
ola-dmxconsole.cpp:150: error: value computed is not used
ola-dmxconsole.cpp:156: error: value computed is not used
ola-dmxconsole.cpp: In function ‘void values()’:
ola-dmxconsole.cpp:184: error: value computed is not used
ola-dmxconsole.cpp:188: error: value computed is not used
ola-dmxconsole.cpp:190: error: value computed is not used
ola-dmxconsole.cpp:194: error: value computed is not used
ola-dmxconsole.cpp:197: error: value computed is not used
ola-dmxconsole.cpp:202: error: value computed is not used
ola-dmxconsole.cpp:205: error: value computed is not used
ola-dmxconsole.cpp:208: error: value computed is not used
ola-dmxconsole.cpp:215: error: value computed is not used
ola-dmxconsole.cpp:225: error: value computed is not used
ola-dmxconsole.cpp:226: error: value computed is not used
ola-dmxconsole.cpp:227: error: value computed is not used
make[2]: *** [ola-dmxconsole.o] Error 1

You should be able to prevent this by editing <code>./src/Makefile.am</code>, removing <code>-Werror</code> and then running <code>autoreconfig && ./configure</code> again.<ref>http://groups.google.com/group/open-lighting/msg/c6d86d03dd74ed5b</ref>

=== Patching An Art-Net Node ===

To make the Ubuntu machine act as an Art-Net node first start the OLA daemon with a debug level of 3:

olad -l 3

Then patch the machine for Art-Net output in universe 1 on port 0:

ola_patch -d 1 -p 0 -u 1

Now start <code>ola_dmxconsole</code> for sending some Art-Net data in universe 1:

ola_dmxconsole -u 1

If you run the Art-Net project in Xcode (either with the Simulator or on the iPad) and open the Xcode console window you should see log messages according to your actions in the DMX console.

E.g. try to navigate to a channel with the left and right cursor keys and then increase or decrease the value with the scroll up/down keys.

[[File:Screenshot-tobi@acker- ~.png]]

== Sources ==

<references/>

IPad ArtNet Node

2011-07-01T19:56:23Z

Tobi: Added listing of the project’s top-level directory

Written by Tobi Schäfer, September 2010.
Updated by Tobi Schäfer, July 2011.

Prerequisites: libartnet 1.1.0, Mac OS X 10.6.8, Xcode 4.0.2, iPad w/ iOS 4.3

== Using libartnet in the Xcode Simulator ==

This is documentation of my first steps using libartnet and Xcode. I am still a complete newbie with all these things. However, I suceeded in running a simple program on the iPad sending and receiving Art-Net data – not without help from the excellent people of the open-ligthing ML<ref>http://groups.google.com/group/open-lighting/browse_thread/thread/e3f322613b710d9d/661d7e4babba4bf1</ref>. I tried to sum up here my experiences so far, although I am sure there are better ways to achieve the same result.

=== Preparing libartnet ===

First, we download the libartnet sources and prepare them for inclusion in Xcode. We need to generate a file called <code>config.h</code> to make things work.

==== Using Tarball ====

$ curl -O http://code.google.com/p/linux-lighting/downloads/detail?name=libartnet-1.1.0.tar.gz
$ tar -xzf libartnet-1.1.0.tar.gz
$ cd libartnet-1.1.0/
$ ./configure
$ cp config.h artnet/

==== Using Git ====

$ git clone http://git.opendmx.net/libartnet
$ cd libartnet/
$ autoreconf -i
$ ./configure
$ cp config.h artnet/

=== Adding libartnet to Xcode ===

Create a directory called <code>Vendor/artnet</code> in the Xcode project directory – in the file system or Finder, not in the Xcode application; the latter will be done in the next step – and copy the source files from the <code>artnet</code> directory of the previous step into the new <code>Vendor/artnet</code> directory.

$ mkdir -p ~/test/Vendor/artnet
$ cp artnet/*.[ch] ~/test/Vendor/artnet

$ ls -l ~/test
total 0
drwxr-xr-x 10 tobi tobi 340 Jul 1 17:20 ArtNetTest
drwxr-xr-x 5 tobi tobi 170 Jul 1 21:17 ArtNetTest.xcodeproj
drwxr-xr-x 7 tobi tobi 238 Jul 1 15:05 ArtNetTestTests
drwxr-xr-x 4 tobi tobi 136 Jul 1 21:08 Vendor

$ ls -l ~/test/Vendor/artnet
total 352
-rw-r--r-- 1 tobi tobi 44082 Jul 1 20:52 artnet.c
-rw-r--r-- 1 tobi tobi 11580 Jul 1 20:52 artnet.h
-rw-r--r-- 1 tobi tobi 1987 Jul 1 20:52 common.h
-rw-r--r-- 1 tobi tobi 4831 Jul 1 20:52 config.h
-rw-r--r-- 1 tobi tobi 1754 Jul 1 20:52 misc.c
-rw-r--r-- 1 tobi tobi 1610 Jul 1 20:52 misc.h
-rw-r--r-- 1 tobi tobi 18941 Jul 1 20:52 network.c
-rw-r--r-- 1 tobi tobi 8495 Jul 1 20:52 packets.h
-rw-r--r-- 1 tobi tobi 13397 Jul 1 20:52 private.h
-rw-r--r-- 1 tobi tobi 27731 Jul 1 20:52 receive.c
-rw-r--r-- 1 tobi tobi 2806 Jul 1 20:52 tod.c
-rw-r--r-- 1 tobi tobi 1307 Jul 1 20:52 tod.h
-rw-r--r-- 1 tobi tobi 12364 Jul 1 20:52 transmit.c

Now drag&drop the Vendor folder to the top level of the Xcode project and choose the following options for adding files.

[[File:Screen_shot_2011-07-01_at_20.45.17.png‎]]

The structure of your project should look similar to this:

[[File:Screen_shot_2011-07-01_at_20.57.03.png‎]]

Add the path to the <code>Vendor</code> directory to the Header Search Paths in the Search Paths section of your build target and tick the recursive checkbox.<ref>http://iphone.olipion.com/cross-compilation/include-library-in-xcode-project</ref>

[[File:Screen_shot_2011-07-01_at_21.10.22.png‎]]

Finally. add the <code>HAVE_CONFIG_H</code> macro to the Preprocessor Macros section of your project’s build settings.

[[File:Screen_shot_2011-07-01_at_21.17.40.png]]

At this point your project should build and run without error – the libartnet source code will be compiled and linked automatically.

== Example Code ==

You now should be ready to build and run the following code in the Simulator as well as on the iPad. Thus, do not forget to select the corresponding setting from the Overview drop-down menu.

[[File:Screen shot 2010-09-16 at 12.12.59.png]]

The code is just a proof of concept and not ready for production – actually it is pretty bad because it abuses the <code>main</code> method instead of creating its own controller. However, it reduces complexity and simply shows the basic approach to using libartnet from within Objective-C code.

The code creates and sets up an Art-Net node, defines a handler method for incoming data and then creates an infinite loop sending Art-Net polls and checking for Art-Net input.

#import "artnet.h"
#import "packets.h"

int artnetReceiver(artnet_node node, void *pp, void *d) {
NSLog(@"Receiving Art-Net data!");
artnet_packet pack = (artnet_packet) pp;
printf("Received packet sequence %d\n", pack->data.admx.sequence);
printf("Received packet type %d\n", pack->type);
printf("Received packet data %s\n", pack->data.admx.data);
return 0;
}

int main(int argc, char *argv[]) {

char *ip_addr = NULL;

uint8_t subnet_addr = 0;
uint8_t port_addr = 1;

artnet_node *artnetNode = artnet_new(ip_addr, 1);

if (!artnetNode) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

artnet_set_long_name(artnetNode, "Art-Net Test");
artnet_set_short_name(artnetNode, "ANT");

// set the upper 4 bits of the universe address
artnet_set_subnet_addr(artnetNode, subnet_addr) ;

// enable port 0
artnet_set_port_type(artnetNode, 0, ARTNET_ENABLE_OUTPUT, ARTNET_PORT_DMX) ;

// bind port 0 to universe 1
artnet_set_port_addr(artnetNode, 0, ARTNET_OUTPUT_PORT, port_addr);

artnet_dump_config(artnetNode);

artnet_set_handler(artnetNode, ARTNET_RECV_HANDLER, artnetReceiver, NULL);

if (artnet_start(artnetNode) != 0) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

while (YES) {
artnet_send_poll(artnetNode, NULL, ARTNET_TTM_DEFAULT);
//printf("arnet_get_sd() => %i\n", artnet_get_sd(artnetNode));
printf("artnet_read() => %i\n", artnet_read(artnetNode, 1));
}

// Use this to deallocate memory
//artnet_stop(artnetNode);
//artnet_destroy(artnetNode);

return 0;
}

== Testing Data Transmission ==

If your program builds and runs without errors you now can test whether Art-Net data is sent and received. Wireshark<ref>http://www.wireshark.org</ref> is a handy tool for monitoring your network.

However, for sending Art-Net data you will need a more appropriate tool. I am using the [[OLA_Command_Line_Tools|OLA Command Line Tools]], running them from another machine with GNU/Linux (Ubuntu 10.04) as operating system.

Although I did not test it, you probably can also install OLA on another Mac or even the same machine you are running XCode on, using the [https://trac.macports.org/browser/trunk/dports/net/ola/Portfile OLA MacPorts port] and/or following the steps of the [[OLA_on_OS_X|OLA On Mac OS X]] page.

=== Installing OLA On Ubuntu ===

Please refer to the [[OLA_on_Linux|OLA On Linux]] page.

If you should get the following error try to fix it with one of [http://groups.google.com/group/open-lighting/msg/72060f6327d30df6 two available solutions]:

Rpc.pb.cc: In copy constructor 'ola::rpc::RpcMessage::RpcMessage(const ola::rpc::RpcMessage&)':
Rpc.pb.cc:143: error: base class 'class google::protobuf::Message' should be explicitly initialized in the copy constructor

A similar error can occur when building the ola-examples package:

g++ -DHAVE_CONFIG_H -I. -I.. -Wall -Werror -I/usr/local/include/
libola -g -O2 -MT ola-dmxconsole.o -MD -MP -MF .deps/ola-
dmxconsole.Tpo -c -o ola-dmxconsole.o ola-dmxconsole.cpp
cc1plus: warnings being treated as errors
ola-dmxconsole.cpp: In function ‘void mask()’:
ola-dmxconsole.cpp:150: error: value computed is not used
ola-dmxconsole.cpp:156: error: value computed is not used
ola-dmxconsole.cpp: In function ‘void values()’:
ola-dmxconsole.cpp:184: error: value computed is not used
ola-dmxconsole.cpp:188: error: value computed is not used
ola-dmxconsole.cpp:190: error: value computed is not used
ola-dmxconsole.cpp:194: error: value computed is not used
ola-dmxconsole.cpp:197: error: value computed is not used
ola-dmxconsole.cpp:202: error: value computed is not used
ola-dmxconsole.cpp:205: error: value computed is not used
ola-dmxconsole.cpp:208: error: value computed is not used
ola-dmxconsole.cpp:215: error: value computed is not used
ola-dmxconsole.cpp:225: error: value computed is not used
ola-dmxconsole.cpp:226: error: value computed is not used
ola-dmxconsole.cpp:227: error: value computed is not used
make[2]: *** [ola-dmxconsole.o] Error 1

You should be able to prevent this by editing <code>./src/Makefile.am</code>, removing <code>-Werror</code> and then running <code>autoreconfig && ./configure</code> again.<ref>http://groups.google.com/group/open-lighting/msg/c6d86d03dd74ed5b</ref>

=== Patching An Art-Net Node ===

To make the Ubuntu machine act as an Art-Net node first start the OLA daemon with a debug level of 3:

olad -l 3

Then patch the machine for Art-Net output in universe 1 on port 0:

ola_patch -d 1 -p 0 -u 1

Now start <code>ola_dmxconsole</code> for sending some Art-Net data in universe 1:

ola_dmxconsole -u 1

If you run the Art-Net project in Xcode (either with the Simulator or on the iPad) and open the Xcode console window you should see log messages according to your actions in the DMX console.

E.g. try to navigate to a channel with the left and right cursor keys and then increase or decrease the value with the scroll up/down keys.

[[File:Screenshot-tobi@acker- ~.png]]

== Sources ==

<references/>

IPad ArtNet Node

2011-07-01T19:38:01Z

Tobi: Completely rewrote sections about configuring and adding libartnet to Xcode

Written by Tobi Schäfer, September 2010.
Updated by Tobi Schäfer, July 2011.

Prerequisites: libartnet 1.1.0, Mac OS X 10.6.8, Xcode 4.0.2, iPad w/ iOS 4.3

== Using libartnet in the Xcode Simulator ==

This is documentation of my first steps using libartnet and Xcode. I am still a complete newbie with all these things. However, I suceeded in running a simple program on the iPad sending and receiving Art-Net data – not without help from the excellent people of the open-ligthing ML<ref>http://groups.google.com/group/open-lighting/browse_thread/thread/e3f322613b710d9d/661d7e4babba4bf1</ref>. I tried to sum up here my experiences so far, although I am sure there are better ways to achieve the same result.

=== Preparing libartnet ===

First, we download the libartnet sources and prepare them for inclusion in Xcode. We need to generate a file called <code>config.h</code> to make things work.

==== Using Tarball ====

$ curl -O http://code.google.com/p/linux-lighting/downloads/detail?name=libartnet-1.1.0.tar.gz
$ tar -xzf libartnet-1.1.0.tar.gz
$ cd libartnet-1.1.0/
$ ./configure
$ cp config.h artnet/

==== Using Git ====

$ git clone http://git.opendmx.net/libartnet
$ cd libartnet/
$ autoreconf -i
$ ./configure
$ cp config.h artnet/

=== Adding libartnet to Xcode ===

Create a directory called <code>Vendor/artnet</code> in the Xcode project directory – in the file system or Finder, not in the Xcode application; the latter will be done in the next step – and copy the source files from the <code>artnet</code> directory of the previous step into the new <code>Vendor/artnet</code> directory.

$ mkdir -p ~/test/Vendor/artnet
$ cp artnet/*.[ch] ~/test/Vendor/artnet
$ ls -l ~/test/Vendor/artnet
total 352
-rw-r--r-- 1 tobi tobi 44082 Jul 1 20:52 artnet.c
-rw-r--r-- 1 tobi tobi 11580 Jul 1 20:52 artnet.h
-rw-r--r-- 1 tobi tobi 1987 Jul 1 20:52 common.h
-rw-r--r-- 1 tobi tobi 4831 Jul 1 20:52 config.h
-rw-r--r-- 1 tobi tobi 1754 Jul 1 20:52 misc.c
-rw-r--r-- 1 tobi tobi 1610 Jul 1 20:52 misc.h
-rw-r--r-- 1 tobi tobi 18941 Jul 1 20:52 network.c
-rw-r--r-- 1 tobi tobi 8495 Jul 1 20:52 packets.h
-rw-r--r-- 1 tobi tobi 13397 Jul 1 20:52 private.h
-rw-r--r-- 1 tobi tobi 27731 Jul 1 20:52 receive.c
-rw-r--r-- 1 tobi tobi 2806 Jul 1 20:52 tod.c
-rw-r--r-- 1 tobi tobi 1307 Jul 1 20:52 tod.h
-rw-r--r-- 1 tobi tobi 12364 Jul 1 20:52 transmit.c

Now drag&drop the Vendor folder to the top level of the Xcode project and choose the following options for adding files.

[[File:Screen_shot_2011-07-01_at_20.45.17.png‎]]

The structure of your project should look similar to this:

[[File:Screen_shot_2011-07-01_at_20.57.03.png‎]]

Add the path to the <code>Vendor</code> directory to the Header Search Paths in the Search Paths section of your build target and tick the recursive checkbox.<ref>http://iphone.olipion.com/cross-compilation/include-library-in-xcode-project</ref>

[[File:Screen_shot_2011-07-01_at_21.10.22.png‎]]

Finally. add the <code>HAVE_CONFIG_H</code> macro to the Preprocessor Macros section of your project’s build settings.

[[File:Screen_shot_2011-07-01_at_21.17.40.png]]

At this point your project should build and run without error – the libartnet source code will be compiled and linked automatically.

== Example Code ==

You now should be ready to build and run the following code in the Simulator as well as on the iPad. Thus, do not forget to select the corresponding setting from the Overview drop-down menu.

[[File:Screen shot 2010-09-16 at 12.12.59.png]]

The code is just a proof of concept and not ready for production – actually it is pretty bad because it abuses the <code>main</code> method instead of creating its own controller. However, it reduces complexity and simply shows the basic approach to using libartnet from within Objective-C code.

The code creates and sets up an Art-Net node, defines a handler method for incoming data and then creates an infinite loop sending Art-Net polls and checking for Art-Net input.

#import "artnet.h"
#import "packets.h"

int artnetReceiver(artnet_node node, void *pp, void *d) {
NSLog(@"Receiving Art-Net data!");
artnet_packet pack = (artnet_packet) pp;
printf("Received packet sequence %d\n", pack->data.admx.sequence);
printf("Received packet type %d\n", pack->type);
printf("Received packet data %s\n", pack->data.admx.data);
return 0;
}

int main(int argc, char *argv[]) {

char *ip_addr = NULL;

uint8_t subnet_addr = 0;
uint8_t port_addr = 1;

artnet_node *artnetNode = artnet_new(ip_addr, 1);

if (!artnetNode) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

artnet_set_long_name(artnetNode, "Art-Net Test");
artnet_set_short_name(artnetNode, "ANT");

// set the upper 4 bits of the universe address
artnet_set_subnet_addr(artnetNode, subnet_addr) ;

// enable port 0
artnet_set_port_type(artnetNode, 0, ARTNET_ENABLE_OUTPUT, ARTNET_PORT_DMX) ;

// bind port 0 to universe 1
artnet_set_port_addr(artnetNode, 0, ARTNET_OUTPUT_PORT, port_addr);

artnet_dump_config(artnetNode);

artnet_set_handler(artnetNode, ARTNET_RECV_HANDLER, artnetReceiver, NULL);

if (artnet_start(artnetNode) != 0) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

while (YES) {
artnet_send_poll(artnetNode, NULL, ARTNET_TTM_DEFAULT);
//printf("arnet_get_sd() => %i\n", artnet_get_sd(artnetNode));
printf("artnet_read() => %i\n", artnet_read(artnetNode, 1));
}

// Use this to deallocate memory
//artnet_stop(artnetNode);
//artnet_destroy(artnetNode);

return 0;
}

== Testing Data Transmission ==

If your program builds and runs without errors you now can test whether Art-Net data is sent and received. Wireshark<ref>http://www.wireshark.org</ref> is a handy tool for monitoring your network.

However, for sending Art-Net data you will need a more appropriate tool. I am using the [[OLA_Command_Line_Tools|OLA Command Line Tools]], running them from another machine with GNU/Linux (Ubuntu 10.04) as operating system.

Although I did not test it, you probably can also install OLA on another Mac or even the same machine you are running XCode on, using the [https://trac.macports.org/browser/trunk/dports/net/ola/Portfile OLA MacPorts port] and/or following the steps of the [[OLA_on_OS_X|OLA On Mac OS X]] page.

=== Installing OLA On Ubuntu ===

Please refer to the [[OLA_on_Linux|OLA On Linux]] page.

If you should get the following error try to fix it with one of [http://groups.google.com/group/open-lighting/msg/72060f6327d30df6 two available solutions]:

Rpc.pb.cc: In copy constructor 'ola::rpc::RpcMessage::RpcMessage(const ola::rpc::RpcMessage&)':
Rpc.pb.cc:143: error: base class 'class google::protobuf::Message' should be explicitly initialized in the copy constructor

A similar error can occur when building the ola-examples package:

g++ -DHAVE_CONFIG_H -I. -I.. -Wall -Werror -I/usr/local/include/
libola -g -O2 -MT ola-dmxconsole.o -MD -MP -MF .deps/ola-
dmxconsole.Tpo -c -o ola-dmxconsole.o ola-dmxconsole.cpp
cc1plus: warnings being treated as errors
ola-dmxconsole.cpp: In function ‘void mask()’:
ola-dmxconsole.cpp:150: error: value computed is not used
ola-dmxconsole.cpp:156: error: value computed is not used
ola-dmxconsole.cpp: In function ‘void values()’:
ola-dmxconsole.cpp:184: error: value computed is not used
ola-dmxconsole.cpp:188: error: value computed is not used
ola-dmxconsole.cpp:190: error: value computed is not used
ola-dmxconsole.cpp:194: error: value computed is not used
ola-dmxconsole.cpp:197: error: value computed is not used
ola-dmxconsole.cpp:202: error: value computed is not used
ola-dmxconsole.cpp:205: error: value computed is not used
ola-dmxconsole.cpp:208: error: value computed is not used
ola-dmxconsole.cpp:215: error: value computed is not used
ola-dmxconsole.cpp:225: error: value computed is not used
ola-dmxconsole.cpp:226: error: value computed is not used
ola-dmxconsole.cpp:227: error: value computed is not used
make[2]: *** [ola-dmxconsole.o] Error 1

You should be able to prevent this by editing <code>./src/Makefile.am</code>, removing <code>-Werror</code> and then running <code>autoreconfig && ./configure</code> again.<ref>http://groups.google.com/group/open-lighting/msg/c6d86d03dd74ed5b</ref>

=== Patching An Art-Net Node ===

To make the Ubuntu machine act as an Art-Net node first start the OLA daemon with a debug level of 3:

olad -l 3

Then patch the machine for Art-Net output in universe 1 on port 0:

ola_patch -d 1 -p 0 -u 1

Now start <code>ola_dmxconsole</code> for sending some Art-Net data in universe 1:

ola_dmxconsole -u 1

If you run the Art-Net project in Xcode (either with the Simulator or on the iPad) and open the Xcode console window you should see log messages according to your actions in the DMX console.

E.g. try to navigate to a channel with the left and right cursor keys and then increase or decrease the value with the scroll up/down keys.

[[File:Screenshot-tobi@acker- ~.png]]

== Sources ==

<references/>

File:Screen shot 2010-09-16 at 12.12.59.png

2011-07-01T19:34:03Z

Tobi: uploaded a new version of "File:Screen shot 2010-09-16 at 12.12.59.png": The device selector drop down menu

Xcode Overview drop-down menu

File:Screen shot 2011-07-01 at 21.17.40.png

2011-07-01T19:20:08Z

Tobi: Adding the HAVE_CONFIG_H macro to the Preprocessor Macros

Adding the HAVE_CONFIG_H macro to the Preprocessor Macros

File:Screen shot 2011-07-01 at 21.10.22.png

2011-07-01T19:12:41Z

Tobi: Adding the Vendor directory to the Header Search Path

Adding the Vendor directory to the Header Search Path

File:Screen shot 2011-07-01 at 20.57.03.png

2011-07-01T19:00:53Z

Tobi: The project structure after adding the Artnet source files

The project structure after adding the Artnet source files

File:Screen shot 2011-07-01 at 20.45.17.png

2011-07-01T18:58:19Z

Tobi: The dialog for choosing options for adding files

The dialog for choosing options for adding files

File:Vendor-directory.png

2011-07-01T18:37:11Z

Tobi: Screenshot of the Finder window showing the Vendor directory and the artnet sources.

Screenshot of the Finder window showing the Vendor directory and the artnet sources.

Portfile for OLA

2011-06-23T11:26:34Z

Tobi: Added note about Porfile being committed to MacPorts collection

Written by Tobi Schäfer, June 2011.

''Update: [https://trac.macports.org/browser/trunk/dports/net/ola/Portfile Portfile was committed to MacPorts collection] on 21 June 2011. The following information is outdated and should only remain for historical reason.''

<pre># $Id$

PortSystem 1.0

name ola
## Latest version (0.8.9-1) currently not usable because of inconsistency in package/folder naming
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52

description An open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 b67beea9e39bee4a33bf6f0eafabf17d \
sha1 abe2e876261f272223ee1eab902319615acac744 \
rmd160 95e926cbd376b0dfd625289f6af37455dd103f99

depends_lib port:pkgconfig \
port:cppunit \
port:unittest-cpp \
port:protobuf-cpp

## This currently does not work because the -arch flag is set twice and
## the compiler runs into a problem with multiple architectures.
## Error message: g++-4.2: -E, -S, -save-temps and -M options are not allowed with multiple -arch flags
#variant i386 description {Build for 32 bit Intel architecture} {
# configure.cppflags-delete "-arch x86_64"
# configure.ldflags-delete "-arch x86_64"
# configure.cppflags-append "-arch i386"
# configure.ldflags-append "-arch i386"
#}

variant http description {Build with embedded web server} {
depends_lib-append port:libmicrohttpd
}

default_variants +http

pre-configure {
use_autoreconf yes
autoreconf.args -i
configure.args-append --disable-http
if {[variant_isset http]} {
configure.args-delete --disable-http
}
}

test {
test.run yes
test.target check
}
</pre>

Portfile for OLA Examples

2011-06-23T11:25:26Z

Tobi: Oops, this is OLA Examples, corrected update note

Written by Tobi Schäfer, June 2011.

''Update: [https://trac.macports.org/browser/trunk/dports/net/ola-examples/Portfile Portfile was committed] to MacPorts collection on 21 June 2011. The following information is outdated and should remain only for historical reason.''

<pre># $Id$

PortSystem 1.0

name ola-examples
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52

description Tools for OLA, the open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 733ed8d7ecd7950e834839f2bfb5dab7 \
sha1 3da39be1f407ffc9c3a740967b53dd419d243473 \
rmd160 ae40c16a1e441c2e718be5d37a7045c886d1b57e

depends_lib port:ola</pre>

Portfile for OLA Examples

2011-06-23T11:23:48Z

Tobi: Added note about Porfile being committed to MacPorts collection

Written by Tobi Schäfer, June 2011.

''Update: [https://trac.macports.org/browser/trunk/dports/net/ola/Portfile Portfile was committed] to MacPorts collection on 21 June 2011. The following information is outdated and should remain only for historical reason.''

<pre># $Id$

PortSystem 1.0

name ola-examples
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52

description Tools for OLA, the open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 733ed8d7ecd7950e834839f2bfb5dab7 \
sha1 3da39be1f407ffc9c3a740967b53dd419d243473 \
rmd160 ae40c16a1e441c2e718be5d37a7045c886d1b57e

depends_lib port:ola</pre>

Portfile for OLA

2011-06-21T12:38:07Z

Tobi: Removed dysfunctional variant_isset checks and settings

Written by Tobi Schäfer, June 2011.

<pre># $Id$

PortSystem 1.0

name ola
## Latest version (0.8.9-1) currently not usable because of inconsistency in package/folder naming
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52

description An open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 b67beea9e39bee4a33bf6f0eafabf17d \
sha1 abe2e876261f272223ee1eab902319615acac744 \
rmd160 95e926cbd376b0dfd625289f6af37455dd103f99

depends_lib port:pkgconfig \
port:cppunit \
port:unittest-cpp \
port:protobuf-cpp

## This currently does not work because the -arch flag is set twice and
## the compiler runs into a problem with multiple architectures.
## Error message: g++-4.2: -E, -S, -save-temps and -M options are not allowed with multiple -arch flags
#variant i386 description {Build for 32 bit Intel architecture} {
# configure.cppflags-delete "-arch x86_64"
# configure.ldflags-delete "-arch x86_64"
# configure.cppflags-append "-arch i386"
# configure.ldflags-append "-arch i386"
#}

variant http description {Build with embedded web server} {
depends_lib-append port:libmicrohttpd
}

default_variants +http

pre-configure {
use_autoreconf yes
autoreconf.args -i
configure.args-append --disable-http
if {[variant_isset http]} {
configure.args-delete --disable-http
}
}

test {
test.run yes
test.target check
}
</pre>

Portfile for OLA

2011-06-21T12:36:52Z

Tobi: Removed obsolete configure settings in comments; added checks to really disable http if desired (variant)

Written by Tobi Schäfer, June 2011.

<pre># $Id$

PortSystem 1.0

name ola
## Latest version (0.8.9-1) currently not usable because of inconsistency in package/folder naming
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52

description An open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 b67beea9e39bee4a33bf6f0eafabf17d \
sha1 abe2e876261f272223ee1eab902319615acac744 \
rmd160 95e926cbd376b0dfd625289f6af37455dd103f99

depends_lib port:pkgconfig \
port:cppunit \
port:unittest-cpp \
port:protobuf-cpp

## This currently does not work because the -arch flag is set twice and the compiler runs into a problem with
## multiple architectures (tried also with preceding -delete).
## Error message: g++-4.2: -E, -S, -save-temps and -M options are not allowed with multiple -arch flags
#variant i386 description {Build for 32 bit Intel architecture} {
# configure.cppflags-append -arch i386
# configure.ldflags-append -arch i386
#}

variant http description {Build with embedded web server} {
depends_lib-append port:libmicrohttpd
}

default_variants +http

pre-configure {
use_autoreconf yes
autoreconf.args -i
configure.args-append --disable-http
if {[variant_isset http]} {
configure.args-delete --disable-http
}
}

build {
if {[variant_isset i386]} {
configure.cppflags-append -arch i386
configure.ldflags-append -arch i386
}
}

test {
test.run yes
test.target check
if {[variant_isset i386]} {
configure.cppflags-append -arch i386
configure.ldflags-append -arch i386
}
}
</pre>

Portfile for OLA

2011-06-21T11:53:23Z

Tobi: Added http variant for compiling with libmicrohttpd support and made it the default variant

Written by Tobi Schäfer, June 2011.

<pre># $Id$

PortSystem 1.0

name ola
## Latest version (0.8.9-1) currently not usable because of inconsistency in package/folder naming
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52

description An open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 b67beea9e39bee4a33bf6f0eafabf17d \
sha1 abe2e876261f272223ee1eab902319615acac744 \
rmd160 95e926cbd376b0dfd625289f6af37455dd103f99

depends_lib port:pkgconfig \
port:cppunit \
port:unittest-cpp \
port:protobuf-cpp

## This currently does not work because the -arch flag is set twice and the compiler runs into a problem with
## multiple architectures (tried also with preceding -delete).
## Error message: g++-4.2: -E, -S, -save-temps and -M options are not allowed with multiple -arch flags
#variant i386 description {Build for 32 bit Intel architecture} {
# configure.cppflags-append -arch i386
# configure.ldflags-append -arch i386
#}

variant http description {Build with embedded web server} {
depends_lib-append port:libmicrohttpd
}

default_variants +http

pre-configure {
## Are these correct (/usr/local?) and necessary?
#configure.pkg_config_path /usr/local/lib/pkgconfig
#configure.cppflags "-I/opt/local/include/"
#configure.ldflags "-L/opt/local/lib/"
use_autoreconf yes
autoreconf.args -i
}

build {
if {[variant_isset i386]} {
configure.cppflags-append -arch i386
configure.ldflags-append -arch i386
}
}

test {
test.run yes
test.target check
if {[variant_isset i386]} {
configure.cppflags-append -arch i386
configure.ldflags-append -arch i386
}
}
</pre>

Open Lighting Projects List

2011-06-21T11:29:07Z

Tobi:

This page contains a list of projects where software from the Open Lighting project has been used. If you know of any more please add them.

[[libartnet]]

* http://www.mediaarchitecture.org/boxleds/
* D::Light http://www.nicole-banana.com

[[OLA]]

* Minoru Yasui Building, Denver, http://adamfrank.com/sunlight/sunlight.htm
* San Jose International Airport, http://01sj.org/2010/venues/sjc-airport/
* iJam from Boris Petrovsky, http://www.petrovsky.de/URBANES%20UNTERHOLZ%20MEETS%20YOU&ME-ISMS-41

Portfile for OLA

2011-06-21T09:23:01Z

Tobi: Removed my reference from maintainers

Written by Tobi Schäfer, June 2011.

<pre># $Id$

PortSystem 1.0

name ola
## Latest version (0.8.9-1) currently not usable because of inconsistency in package/folder naming
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52

description An open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 b67beea9e39bee4a33bf6f0eafabf17d \
sha1 abe2e876261f272223ee1eab902319615acac744 \
rmd160 95e926cbd376b0dfd625289f6af37455dd103f99

depends_lib port:pkgconfig \
port:cppunit \
port:unittest-cpp \
port:protobuf-cpp

## This currently does not work because the -arch flag is set twice and the compiler runs into a problem with
## multiple architectures (tried also with preceding -delete).
## Error message: g++-4.2: -E, -S, -save-temps and -M options are not allowed with multiple -arch flags
#variant i386 description {Build for 32 bit Intel architecture} {
# configure.cppflags-append -arch i386
# configure.ldflags-append -arch i386
#}

## Still missing: variants for the microhttpd dependency, with and without support for SSL
#variant http description {Build with embedded web server} {
# ...?
#}

#variant ssl description {Build with embedded web server and SSL support} {
# depends_lib-append port:libgcrypt
# ...?
#}

pre-configure {
## Are these correct (/usr/local?) and necessary?
#configure.pkg_config_path /usr/local/lib/pkgconfig
#configure.cppflags "-I/opt/local/include/"
#configure.ldflags "-L/opt/local/lib/"
use_autoreconf yes
autoreconf.args -i
}

build {
if {[variant_isset i386]} {
configure.cppflags-append -arch i386
configure.ldflags-append -arch i386
}
}

test {
test.run yes
test.target check
if {[variant_isset i386]} {
configure.cppflags-append -arch i386
configure.ldflags-append -arch i386
}
}
</pre>

Portfile for OLA Examples

2011-06-21T09:22:38Z

Tobi: Removed my reference from maintainers

Written by Tobi Schäfer, June 2011.

<pre># $Id$

PortSystem 1.0

name ola-examples
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52

description Tools for OLA, the open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 733ed8d7ecd7950e834839f2bfb5dab7 \
sha1 3da39be1f407ffc9c3a740967b53dd419d243473 \
rmd160 ae40c16a1e441c2e718be5d37a7045c886d1b57e

depends_lib port:ola</pre>

Portfile for OLA Examples

2011-06-21T09:19:54Z

Tobi: Created page with "Written by Tobi Schäfer, June 2011. <pre># $Id$ PortSystem 1.0 name ola-examples version 0.8.9 categories net comms platforms dar…"

Written by Tobi Schäfer, June 2011.

<pre># $Id$

PortSystem 1.0

name ola-examples
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52 \
p3k.org:interface

description Tools for OLA, the open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 733ed8d7ecd7950e834839f2bfb5dab7 \
sha1 3da39be1f407ffc9c3a740967b53dd419d243473 \
rmd160 ae40c16a1e441c2e718be5d37a7045c886d1b57e

depends_lib port:ola</pre>

Portfile for OLA

2011-06-21T08:58:33Z

Tobi: Fixed flags for -arch i386 and added compiler error message

Written by Tobi Schäfer, June 2011.

<pre># $Id$

PortSystem 1.0

name ola
## Latest version (0.8.9-1) currently not usable because of inconsistency in package/folder naming
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52 \
p3k.org:interface

description An open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 b67beea9e39bee4a33bf6f0eafabf17d \
sha1 abe2e876261f272223ee1eab902319615acac744 \
rmd160 95e926cbd376b0dfd625289f6af37455dd103f99

depends_lib port:pkgconfig \
port:cppunit \
port:unittest-cpp \
port:protobuf-cpp

## This currently does not work because the -arch flag is set twice and the compiler runs into a problem with
## multiple architectures (tried also with preceding -delete).
## Error message: g++-4.2: -E, -S, -save-temps and -M options are not allowed with multiple -arch flags
#variant i386 description {Build for 32 bit Intel architecture} {
# configure.cppflags-append -arch i386
# configure.ldflags-append -arch i386
#}

## Still missing: variants for the microhttpd dependency, with and without support for SSL
#variant http description {Build with embedded web server} {
# ...?
#}

#variant ssl description {Build with embedded web server and SSL support} {
# depends_lib-append port:libgcrypt
# ...?
#}

pre-configure {
## Are these correct (/usr/local?) and necessary?
#configure.pkg_config_path /usr/local/lib/pkgconfig
#configure.cppflags "-I/opt/local/include/"
#configure.ldflags "-L/opt/local/lib/"
use_autoreconf yes
autoreconf.args -i
}

build {
if {[variant_isset i386]} {
configure.cppflags-append -arch i386
configure.ldflags-append -arch i386
}
}

test {
test.run yes
test.target check
if {[variant_isset i386]} {
configure.cppflags-append -arch i386
configure.ldflags-append -arch i386
}
}
</pre>

Portfile for OLA

2011-06-21T08:49:39Z

Tobi: Created page with "Written by Tobi Schäfer, June 2011. <pre># $Id$ PortSystem 1.0 name ola ## Latest version (0.8.9-1) currently not usable because of inco…"

Written by Tobi Schäfer, June 2011.

<pre># $Id$

PortSystem 1.0

name ola
## Latest version (0.8.9-1) currently not usable because of inconsistency in package/folder naming
version 0.8.9
categories net comms
platforms darwin
license LGPL
maintainers gmail.com:nomis52 \
p3k.org:interface

description An open framework for DMX lighting control
long_description The Open Lighting Architecture (OLA) provides a plugin framework for distributing DMX512 control signals on Mac and Linux. It provides C++ and Python libraries which abstract away the underlying DMX over IP protocol or DMX interface.
homepage http://opendmx.net/index.php/OLA

master_sites http://linux-lighting.googlecode.com/files/

checksums md5 b67beea9e39bee4a33bf6f0eafabf17d \
sha1 abe2e876261f272223ee1eab902319615acac744 \
rmd160 95e926cbd376b0dfd625289f6af37455dd103f99

depends_lib port:pkgconfig \
port:cppunit \
port:unittest-cpp \
port:protobuf-cpp

## This currently does not work because the -arch flag is set twice and the compiler runs into a problem with multiple architectures
#variant i386 description {Build for 32 bit Intel architecture} {
# configure.cppflags-replace -arch i386
# configure.ldflags-repalce -arch i386
#}

## Still missing: variants for the microhttpd dependency, with and without support for SSL
#variant http description {Build with embedded web server} {
# ...?
#}

#variant ssl description {Build with embedded web server and SSL support} {
# depends_lib-append port:libgcrypt
# ...?
#}

pre-configure {
## Are these correct (/usr/local?) and necessary?
#configure.pkg_config_path /usr/local/lib/pkgconfig
#configure.cppflags "-I/opt/local/include/"
#configure.ldflags "-L/opt/local/lib/"
use_autoreconf yes
autoreconf.args -i
}

build {
if {[variant_isset i386]} {
configure.cppflags-replace -arch i386
configure.ldflags-repalce -arch i386
}
}

test {
test.run yes
test.target check
if {[variant_isset i386]} {
configure.cppflags-replace -arch i386
configure.ldflags-repalce -arch i386
}
}
</pre>

IPad ArtNet Node

2010-09-16T12:41:49Z

Tobi: Added short introduction, fixed some typos

Written by Tobi Schäfer, September 2010.

Prerequisites: libartnet 1.1.0, Mac OS X 10.6.4, Xcode 3.2.3, iPad w/ iOS 3.2

== Using libartnet in the Xcode Simulator ==

This is documentation of my first steps using Art-Net, libartnet and Xcode. I am still a complete newbie with all these things. However, I suceeded in running a simple program on the iPad sending and receiving Art-Net data – not without help from the excellent people of the open-ligthing ML<ref>http://groups.google.com/group/open-lighting/browse_thread/thread/e3f322613b710d9d/661d7e4babba4bf1</ref>. I tried to sum up here my experiences so far, although I am sure there are better ways to achieve the same result.

=== Installing libartnet ===

curl -O http://code.google.com/p/linux-lighting/downloads/detail?name=libartnet-1.1.0.tar.gz
tar xzf libartnet-1.1.0.tar.gz
cd libartnet-1.1.0
./configure CC="gcc -arch i386"
make
sudo make install

=== Adding libartnet.dylib to XCode ===

Simply drag&drop the file <code>libartnet.1.dylib</code> from the <code>/usr/local/lib</code> directory to the Frameworks group in Xcode.

''Hint:'' you can easily open hidden directories in a new window from within Terminal.app:

open /usr/local/lib

Add the path <code>/usr/local/include</code> to the Header Search Paths in the Search Paths section of your project or target and tick the recursive checkbox.<ref>http://iphone.olipion.com/cross-compilation/include-library-in-xcode-project</ref>

[[File:Screen shot 2010-09-16 at 11.59.40.png]]

== Using libartnet On The iPad ==

Getting libartnet to work on the iPad is a little bit trickier and involves cross-compiling the library for the iPad’s processor architecture.

Fortunately, there is help on the Intertubes.

=== Cross-compiling libartnet For The iPad ===

First of all, it is safer to remove already installed libartnet files if you should have built the dynamic library in a previous step. Otherwise you could follow the steps in [http://developer.apple.com/library/mac/#qa/qa2006/qa1393.html Apple’s Technical QA1393 document].

rm -rf /usr/local/lib/libartnet.*

Then clean your libartnet build directory:

make distclean

I found a [http://stackoverflow.com/questions/1602182/cross-compile-autotools-based-libraries-for-official-iphone-sdk helper script] which sets all necessary cross-compiling flag

Copy it to your Mac as <code>build.sh</code>. You probably need to modify the SDK version to your needs:

export SDKVER="3.2"

Furthermore, you should add the following line before the <code>./configure ...</code> command to prevent another error from happening:<ref>http://groups.google.com/group/open-lighting/msg/28e002886ba95ced</ref>

export ac_cv_func_malloc_0_nonnull=yes

Make the file executable and then run the script:

chmod a+x build.sh
./build.sh

If it compiles it should install the file <code>libartnet.a</code> into the directory <code>/opt/iphone-3.2/lib</code> as well as the header files into </code>/opt/iphone/include</code>.

=== Adding libartnet.a To Xcode ===

As with <code>libartnet.dylib</code> drag&drop the <code>libartnet.a</code> file to the Frameworks group in Xcode.

Similarly, add the path <code>/usr/iphone-3.2/include</code> to the Header Search Paths in the Search Paths section of your project or target and tick the recursive checkbox.

== Example Code ==

You now should be ready to build and run the following code in the Simulator as well as on the iPad. Thus, do not forget to select the corresponding setting from the Overview drop-down menu.

[[File:Screen shot 2010-09-16 at 12.12.59.png]]

The code is just a proof of concept and not ready for production. It creates and sets up an Art-Net node, defines a handler method for incoming data and then creates an infinite loop sending Art-Net polls and checking for Art-Net input.

#import "artnet.h"
#import "packets.h"

int artnetReceiver(artnet_node node, void *pp, void *d) {
NSLog(@"Receiving Art-Net data!");
artnet_packet pack = (artnet_packet) pp;
printf("Received packet sequence %d\n", pack->data.admx.sequence);
printf("Received packet type %d\n", pack->type);
printf("Received packet data %s\n", pack->data.admx.data);
return 0;
}

int main(int argc, char *argv[]) {

char *ip_addr = NULL;

uint8_t subnet_addr = 0;
uint8_t port_addr = 1;

artnet_node *artnetNode = artnet_new(ip_addr, 1);

if (!artnetNode) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

artnet_set_long_name(artnetNode, "Art-Net Test");
artnet_set_short_name(artnetNode, "ANT");

// set the upper 4 bits of the universe address
artnet_set_subnet_addr(artnetNode, subnet_addr) ;

// enable port 0
artnet_set_port_type(artnetNode, 0, ARTNET_ENABLE_OUTPUT, ARTNET_PORT_DMX) ;

// bind port 0 to universe 1
artnet_set_port_addr(artnetNode, 0, ARTNET_OUTPUT_PORT, port_addr);

artnet_dump_config(artnetNode);

artnet_set_handler(artnetNode, ARTNET_RECV_HANDLER, artnetReceiver, NULL);

if (artnet_set_dmx_handler(artnetNode, dmxHandler, NULL) != 0) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

if (artnet_start(artnetNode) != 0) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

while (YES) {
artnet_send_poll(artnetNode, NULL, ARTNET_TTM_DEFAULT);
//printf("arnet_get_sd() => %i\n", artnet_get_sd(artnetNode));
printf("artnet_read() => %i\n", artnet_read(artnetNode, 1));
}

// Use this to deallocate memory
//artnet_stop(artnetNode);
//artnet_destroy(artnetNode);

return retVal;
}

== Testing Data Transmission ==

If your program builds and runs without errors you now can test whether Art-Net data is sent and received. Wireshark<ref>http://www.wireshark.org</ref> is a handy tool for monitoring your network.

However, for sending Art-Net data you will need a more appropriate tool. I am using the [[OLA_Command_Line_Tools|OLA Command Line Tools]], running them from another machine with GNU/Linux (Ubuntu 10.04) as operating system.

Although I did not test it, you probably can also install OLA on another Mac or even the same machine you are running XCode on, using the available [http://code.google.com/p/linux-lighting/downloads/detail?name=OLA%200.8.1.dmg Installer Disk Image] and/or following the steps of the [[OLA_on_OS_X|OLA On Mac OS X]] page.

=== Installing OLA On Ubuntu ===

Please refer to the [[OLA_on_Linux|OLA On Linux]] page.

If you should get the following error try to fix it with one of [http://groups.google.com/group/open-lighting/msg/72060f6327d30df6 two available solutions]:

Rpc.pb.cc: In copy constructor 'ola::rpc::RpcMessage::RpcMessage(const ola::rpc::RpcMessage&)':
Rpc.pb.cc:143: error: base class 'class google::protobuf::Message' should be explicitly initialized in the copy constructor

A similar error can occur when building the ola-examples package:

g++ -DHAVE_CONFIG_H -I. -I.. -Wall -Werror -I/usr/local/include/
libola -g -O2 -MT ola-dmxconsole.o -MD -MP -MF .deps/ola-
dmxconsole.Tpo -c -o ola-dmxconsole.o ola-dmxconsole.cpp
cc1plus: warnings being treated as errors
ola-dmxconsole.cpp: In function ‘void mask()’:
ola-dmxconsole.cpp:150: error: value computed is not used
ola-dmxconsole.cpp:156: error: value computed is not used
ola-dmxconsole.cpp: In function ‘void values()’:
ola-dmxconsole.cpp:184: error: value computed is not used
ola-dmxconsole.cpp:188: error: value computed is not used
ola-dmxconsole.cpp:190: error: value computed is not used
ola-dmxconsole.cpp:194: error: value computed is not used
ola-dmxconsole.cpp:197: error: value computed is not used
ola-dmxconsole.cpp:202: error: value computed is not used
ola-dmxconsole.cpp:205: error: value computed is not used
ola-dmxconsole.cpp:208: error: value computed is not used
ola-dmxconsole.cpp:215: error: value computed is not used
ola-dmxconsole.cpp:225: error: value computed is not used
ola-dmxconsole.cpp:226: error: value computed is not used
ola-dmxconsole.cpp:227: error: value computed is not used
make[2]: *** [ola-dmxconsole.o] Error 1

You should be able to prevent this by editing <code>./src/Makefile.am</code>, removing <code>-Werror</code> and then running <code>autoreconfig && ./configure</code> again.<ref>http://groups.google.com/group/open-lighting/msg/c6d86d03dd74ed5b</ref>

=== Patching An Art-Net Node ===

To make the Ubuntu machine act as an Art-Net node first start the OLA daemon with a debug level of 3:

olad -l 3

Then patch the machine for Art-Net output in universe 1 on port 0:

ola_patch -d 1 -p 0 -u 1

Now start <code>ola_dmxconsole</code> for sending some Art-Net data in universe 1:

ola_dmxconsole -u 1

If you run the Art-Net project in Xcode (either with the Simulator or on the iPad) and open the Xcode console window you should see log messages according to your actions in the DMX console.

E.g. try to navigate to a channel with the left and right cursor keys and then increase or decrease the value with the scroll up/down keys.

[[File:Screenshot-tobi@acker- ~.png]]

== Sources ==

<references/>

IPad ArtNet Node

2010-09-16T11:27:06Z

Tobi: Initial draft

Written by Tobi Schäfer, September 2010.

Prerequisites: libarnet 1.1.0, Mac OS X 10.6.4, Xcode 3.2.3, iPad w/ iOS 3.2

== Using libartnet in the Xcode Simulator ==

=== Installing libartnet ===

curl -O http://code.google.com/p/linux-lighting/downloads/detail?name=libartnet-1.1.0.tar.gz
tar xzf libartnet-1.1.0.tar.gz
cd libartnet-1.1.0
./configure CC="gcc -arch i386"
make
sudo make install

=== Adding libartnet.dylib to XCode ===

Simply drag&drop the file <code>libartnet.1.dylib</code> from the <code>/usr/local/lib</code> directory to the Frameworks group in Xcode.

''Hint:'' you can easily open hidden directories in a new window from within Terminal.app:

open /usr/local/lib

Add the path <code>/usr/local/include</code> to the Header Search Paths in the Search Paths section of your project or target and tick the recursive checkbox.<ref>http://iphone.olipion.com/cross-compilation/include-library-in-xcode-project</ref>

[[File:Screen shot 2010-09-16 at 11.59.40.png]]

== Using libartnet On The iPad ==

Getting libartnet to work on the iPad is a little bit trickier and involves cross-compiling the library for the iPad’s processor architecture.

Fortunately, there is help on the Intertubes.

=== Cross-compiling libartnet For The iPad ===

First of all, it is safer to remove already installed libartnet files if you should have built the dynamic library in a previous step. Otherwise you could follow the steps in [http://developer.apple.com/library/mac/#qa/qa2006/qa1393.html Apple’s Technical QA1393 document].

rm -rf /usr/local/lib/libartnet.*

Then clean your libartnet build directory:

make distclean

I found a [http://stackoverflow.com/questions/1602182/cross-compile-autotools-based-libraries-for-official-iphone-sdk helper script] which sets all necessary cross-compiling flag

Copy it to your Mac as <code>build.sh</code>. You probably need to modify the SDK version to your needs:

export SDKVER="3.2"

Furthermore, you should add the following line before the <code>./configure ...</code> command to prevent another error from happening:<ref>http://groups.google.com/group/open-lighting/msg/28e002886ba95ced</ref>

export ac_cv_func_malloc_0_nonnull=yes

Make the file executable and then run the script:

chmod a+x build.sh
./build.sh

If it compiles it should install the file <code>libartnet.a</code> into the directory <code>/opt/iphone-3.2/lib</code> as well as the header files into </code>/opt/iphone/include</code>.

=== Adding libartnet.a To Xcode ===

As with <code>libartnet.dylib</code> drag&drop the <code>libartnet.a</code> file to the Frameworks group in Xcode.

Similarly, add the path <code>/usr/iphone-3.2/include</code> to the Header Search Paths in the Search Paths section of your project or target and tick the recursive checkbox.

== Example Code ==

You now should be ready to build and run the following code in the Simulator as well as on the iPad. Thus, do not forget to select the corresponding setting from the Overview drop-down menu.

[[File:Screen shot 2010-09-16 at 12.12.59.png]]

The code is just a proof of concept and not ready for production. It creates and sets up an Art-Net node, defines a handler method for incoming data and then creates an infinite loop sending Art-Net polls and checking for Art-Net input.

#import "artnet.h"
#import "packets.h"

int artnetReceiver(artnet_node node, void *pp, void *d) {
NSLog(@"Receiving Art-Net data!");
artnet_packet pack = (artnet_packet) pp;
printf("Received packet sequence %d\n", pack->data.admx.sequence);
printf("Received packet type %d\n", pack->type);
printf("Received packet data %s\n", pack->data.admx.data);
return 0;
}

int main(int argc, char *argv[]) {

char *ip_addr = NULL;

uint8_t subnet_addr = 0;
uint8_t port_addr = 1;

artnet_node *artnetNode = artnet_new(ip_addr, 1);

if (!artnetNode) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

artnet_set_long_name(artnetNode, "Art-Net Test");
artnet_set_short_name(artnetNode, "ANT");

// set the upper 4 bits of the universe address
artnet_set_subnet_addr(artnetNode, subnet_addr) ;

// enable port 0
artnet_set_port_type(artnetNode, 0, ARTNET_ENABLE_OUTPUT, ARTNET_PORT_DMX) ;

// bind port 0 to universe 1
artnet_set_port_addr(artnetNode, 0, ARTNET_OUTPUT_PORT, port_addr);

artnet_dump_config(artnetNode);

artnet_set_handler(artnetNode, ARTNET_RECV_HANDLER, artnetReceiver, NULL);

if (artnet_set_dmx_handler(artnetNode, dmxHandler, NULL) != 0) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

if (artnet_start(artnetNode) != 0) {
printf("Error: %s\n", artnet_strerror());
exit(-1);
}

while (YES) {
artnet_send_poll(artnetNode, NULL, ARTNET_TTM_DEFAULT);
//printf("arnet_get_sd() => %i\n", artnet_get_sd(artnetNode));
printf("artnet_read() => %i\n", artnet_read(artnetNode, 1));
}

// Use this to deallocate memory
//artnet_stop(artnetNode);
//artnet_destroy(artnetNode);

return retVal;
}

== Testing Data Transmission ==

If your program builds and runs without errors you now can test whether Art-Net data is sent and received. Wireshark<ref>http://www.wireshark.org</ref> is a handy tool for monitoring your network.

However, for sending Art-Net data you will need a more appropriate tool. I am using the [[OLA_Command_Line_Tools|OLA Command Line Tools]], running them from another machine running GNU/Linux.

Although I did not test it, you probably can also install OLA on another Mac or even the same machine you are running XCode on, using the available [http://code.google.com/p/linux-lighting/downloads/detail?name=OLA%200.8.1.dmg Installer Disk Image] and/or following the steps of the [[OLA_on_OS_X|OLA On Mac OS X]] page.

=== Installing OLA On Ubuntu ===

Please refer to the [[OLA_on_Linux|OLA On Linux]] page.

If you should get the following error try to fix it with one of [http://groups.google.com/group/open-lighting/msg/72060f6327d30df6 two available solutions]:

Rpc.pb.cc: In copy constructor 'ola::rpc::RpcMessage::RpcMessage(const ola::rpc::RpcMessage&)':
Rpc.pb.cc:143: error: base class 'class google::protobuf::Message' should be explicitly initialized in the copy constructor

A similar error can occur when building the ola-examples package:

g++ -DHAVE_CONFIG_H -I. -I.. -Wall -Werror -I/usr/local/include/
libola -g -O2 -MT ola-dmxconsole.o -MD -MP -MF .deps/ola-
dmxconsole.Tpo -c -o ola-dmxconsole.o ola-dmxconsole.cpp
cc1plus: warnings being treated as errors
ola-dmxconsole.cpp: In function ‘void mask()’:
ola-dmxconsole.cpp:150: error: value computed is not used
ola-dmxconsole.cpp:156: error: value computed is not used
ola-dmxconsole.cpp: In function ‘void values()’:
ola-dmxconsole.cpp:184: error: value computed is not used
ola-dmxconsole.cpp:188: error: value computed is not used
ola-dmxconsole.cpp:190: error: value computed is not used
ola-dmxconsole.cpp:194: error: value computed is not used
ola-dmxconsole.cpp:197: error: value computed is not used
ola-dmxconsole.cpp:202: error: value computed is not used
ola-dmxconsole.cpp:205: error: value computed is not used
ola-dmxconsole.cpp:208: error: value computed is not used
ola-dmxconsole.cpp:215: error: value computed is not used
ola-dmxconsole.cpp:225: error: value computed is not used
ola-dmxconsole.cpp:226: error: value computed is not used
ola-dmxconsole.cpp:227: error: value computed is not used
make[2]: *** [ola-dmxconsole.o] Error 1

You should be able to prevent this by editing <code>./src/Makefile.am</code>, removing <code>-Werror</code> and then running <code>autoreconfig && ./configure</code> again.<ref>http://groups.google.com/group/open-lighting/msg/c6d86d03dd74ed5b</ref>

=== Patching An Art-Net Node ===

To make the Ubuntu machine act as an Art-Net node first start the OLA daemon with a debug level of 3:

olad -l 3

Then we are patching the machine for Art-Net output in universe 1 on port 0:

ola_patch -d 1 -p 0 -u 1

Now start <code>ola_dmxconsole</code> for sending some Art-Net data in universe 1:

ola_dmxconsole -u 1

If you run the Art-Net project in Xcode (either with the Simulator or on the iPad) and open the Xcode console window you should see log messages according to your actions in the DMX console.

E.g. try to navigate to a channel with the left and right cursor keys and then increase or decrease the value with the scroll up/down keys.

[[File:Screenshot-tobi@acker- ~.png]]

== Sources ==

<references/>

File:Screenshot-tobi@acker- ~.png

2010-09-16T11:23:19Z

Tobi: The OLA DMX Console in action

The OLA DMX Console in action

File:Screen shot 2010-09-16 at 12.12.59.png

2010-09-16T11:14:25Z

Tobi: Xcode Overview drop-down menu

Xcode Overview drop-down menu

File:Screen shot 2010-09-16 at 11.59.40.png

2010-09-16T10:02:43Z

Tobi: Xcode Project Info window for setting the search path

Xcode Project Info window for setting the search path