wiki.openlighting.org - User contributions [en]

Using OLA with Xcode

2010-01-26T14:30:56Z

Chatchavan: /* Example code */

You can use OLA to implement your application in Objective-C++, a bridge between Objective-C and C++. This page explains how to integrate OLA client into your program. The content of this page is based on [http://linux-lighting.googlecode.com/files/OLA%200.6.0.dmg OLA 0.6.0 Universal Mac Binaries]

==What you'll need==
* Xcode
* [http://linux-lighting.googlecode.com/files/OLA%200.6.0.dmg OLA 0.6.0 Universal Mac Binaries] installed

==Configure your project==
# Select menu: "Project" -> "Edit Project Settings". All settings below are referred in a "Build" tab
# Set "Architectures" to 32-bit Universal
# Set "Header Search Paths" to
/usr/local/include

==Add dylib==
# In your project tree, right-click on a group that contain frameworks (e.g. "External Frameworks and Libraries", "Fromeworks/Linked Frameworks"), select "Add" -> "Existing Frameworks"
# Select following frameworks:
#* libprotobuf.dylib
#* libola.dylib
#* libolacommon.dylib

==Example code==
The following code sends value 255 to channel 0 in universe 0. First, it creates a client from a SimpleClient object. Then, it creates a DMX data array and pack the array to a buffer. In the end, it sends the buffer to a server.

#import <Foundation/Foundation.h>
#include <errno.h>
#import <ola/DmxBuffer.h>
#import <ola/SimpleClient.h>

// define type for DMX message
typedef unsigned char dmx_t ;

// maximum number of channels
int MAXCHANNELS=512;

int main (int argc, const char * argv[]) {
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

// get a client
ola::SimpleClient simpleClient;
if (!simpleClient.Setup()) {
NSLog(@"Client setup failed %s", strerror(errno));
return -1;
}

ola::OlaClient *client = simpleClient.GetClient();

// prepare data
int channel = 0;
dmx_t *dmx = (dmx_t *)calloc(MAXCHANNELS + 10, sizeof(dmx_t));
dmx[channel] = 255;
ola::DmxBuffer buffer(dmx, MAXCHANNELS);

// send DMX message
int universe = 0;
if (!client->SendDmx(universe, buffer)) {
NSLog(@"Sending DMX failed %s", strerror(errno));
}

[pool drain];
return 0;
}

Notice that DMX API is changed since the last documented [http://opendmx.net/index.php/OLA_Client_API client API]. You can find more information by browsing the source file of [http://linux-lighting.googlecode.com/files/ola-examples-0.6.0.tar.gz DMX example]. For me, the src/ola-client.cpp is quite useful.

Here is another example that create OlaServer and communicate with a pipe socket.

#import <Foundation/Foundation.h>
#include <errno.h>
#import <ola/DmxBuffer.h>
#import <ola/OlaClient.h>
#import <ola/network/SelectServer.h>
#import <ola/network/Socket.h>

using ola::network::PipeSocket;

// define type for DMX message
typedef unsigned char dmx_t ;

// maximum number of channels
int MAXCHANNELS=512;

int main (int argc, const char * argv[]) {
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

// create a server
ola::network::SelectServer server;

// create a select server
ola::network::SelectServer server;

// create pipe socket
PipeSocket *socket = new PipeSocket();
if (!socket->Init())
{
NSLog(@"Cannot create pipe socket");
return -1;
}

// add socket to select server
server.AddSocket(socket, true);

// create server daemon
// *** see: olad/Olad.cpp for more detail ***

// get a client
ola::OlaClient client(socket);
if (!client.Setup()) {
NSLog(@"Client setup failed %s", strerror(errno));
return -1;
}

// prepare data
int channel = 0;
dmx_t *dmx = (dmx_t *)calloc(MAXCHANNELS + 10, sizeof(dmx_t));
dmx[channel] = 255;
ola::DmxBuffer buffer(dmx, MAXCHANNELS);

// send DMX message
int universe = 0;
if (!client.SendDmx(universe, buffer)) {
NSLog(@"Sending DMX failed %s", strerror(errno));
}

// cleanup
free(dmx);

[pool drain];
return 0;
}

Using OLA with Xcode

2010-01-26T14:23:25Z

Chatchavan: /* Example code */

Using OLA with Xcode

2010-01-26T13:08:56Z

Chatchavan: /* Example code */

You can use OLA to implement your application in Objective-C++, a bridge between Objective-C and C++. This page explains how to integrate OLA client into your program. The content of this page is based on [http://linux-lighting.googlecode.com/files/OLA%200.6.0.dmg OLA 0.6.0 Universal Mac Binaries]

==What you'll need==
* Xcode
* [http://linux-lighting.googlecode.com/files/OLA%200.6.0.dmg OLA 0.6.0 Universal Mac Binaries] installed

==Configure your project==
# Select menu: "Project" -> "Edit Project Settings". All settings below are referred in a "Build" tab
# Set "Architectures" to 32-bit Universal
# Set "Header Search Paths" to
/usr/local/include

==Add dylib==
# In your project tree, right-click on a group that contain frameworks (e.g. "External Frameworks and Libraries", "Fromeworks/Linked Frameworks"), select "Add" -> "Existing Frameworks"
# Select following frameworks:
#* libprotobuf.dylib
#* libola.dylib
#* libolacommon.dylib

==Example code==
The following code sends value 255 to channel 0 in universe 0. First, it creates a client from a SimpleClient object. Then, it creates a DMX data array and pack the array to a buffer. In the end, it sends the buffer to a server.

#import <Foundation/Foundation.h>
#include <errno.h>
#import <ola/DmxBuffer.h>
#import <ola/SimpleClient.h>

// define type for DMX message
typedef unsigned char dmx_t ;

// maximum number of channels
int MAXCHANNELS=512;

int main (int argc, const char * argv[]) {
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

// get a client
ola::SimpleClient simpleClient;
if (!simpleClient.Setup()) {
NSLog(@"Client setup failed %s", strerror(errno));
return -1;
}

ola::OlaClient *client = simpleClient.GetClient();

// prepare data
int channel = 0;
dmx_t *dmx = (dmx_t *)calloc(MAXCHANNELS + 10, sizeof(dmx_t));
dmx[channel] = 255;
ola::DmxBuffer buffer(dmx, MAXCHANNELS);

// send DMX message
int universe = 0;
if (!client->SendDmx(universe, buffer)) {
NSLog(@"Sending DMX failed %s", strerror(errno));
}

[pool drain];
return 0;
}

Notice that DMX API is changed since the last documented [http://opendmx.net/index.php/OLA_Client_API client API]. You can find more information by browsing the source file of [http://linux-lighting.googlecode.com/files/ola-examples-0.6.0.tar.gz DMX example]. For me, the src/ola-client.cpp is quite useful.

Here is another example that create OlaServer and communicate with a pipe socket.

#import <Foundation/Foundation.h>
#include <errno.h>
#import <ola/DmxBuffer.h>
#import <ola/OlaClient.h>
#import <ola/network/SelectServer.h>
#import <ola/network/Socket.h>

using ola::network::PipeSocket;

// define type for DMX message
typedef unsigned char dmx_t ;

// maximum number of channels
int MAXCHANNELS=512;

int main (int argc, const char * argv[]) {
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];

// create a server
ola::network::SelectServer server;

// create pipe socket
PipeSocket *socket = new PipeSocket();
if (!socket->Init())
{
NSLog(@"Cannot create pipe socket");
return -1;
}

// add socket to server
server.AddSocket(socket, true);

// get a client
ola::OlaClient client(socket);
if (!client.Setup()) {
NSLog(@"Client setup failed %s", strerror(errno));
return -1;
}

// prepare data
int channel = 0;
dmx_t *dmx = (dmx_t *)calloc(MAXCHANNELS + 10, sizeof(dmx_t));
dmx[channel] = 255;
ola::DmxBuffer buffer(dmx, MAXCHANNELS);

// send DMX message
int universe = 0;
if (!client.SendDmx(universe, buffer)) {
NSLog(@"Sending DMX failed %s", strerror(errno));
}

// cleanup
free(dmx);

[pool drain];
return 0;
}

Using OLA with Xcode

2010-01-26T12:34:03Z

Chatchavan: /* Configure your project */ corrected library search path

Using OLA with Xcode

2010-01-26T11:25:33Z

Chatchavan: /* Example code */ add channel variable

Using OLA with Xcode

2010-01-26T11:24:02Z

Chatchavan: Created page with 'You can use OLA to implement your application in Objective-C++, a bridge between Objective-C and C++. This page explains how to integrate OLA client into your program. The conten…'

Open Lighting Architecture

2010-01-26T11:04:28Z

Chatchavan: added link: using OLA with XCode

Link: http://code.google.com/p/linux-lighting/ 
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes}}
[[Image:Llad_home.png|right]]

OLA (Open Lighting Architecture) is a framework that allows applications to send and receive DMX, using various hardware devices and 'DMX over IP' protocols. It enables [[:Category:Controllers | software controllers]] talk to DMX hardware.

OLA allows DMX sent using various DMX over IP protocols to be converted from one format to another. This enables devices from different manufacturers to talk to each another (for example a [[Strand_Lighting|Strand]] Console can send DMX to an [[Enttec]] [[DmxEtherGate MKII|EtherGate]]). When combined with a physical DMX interface such as the [[DMX USB Pro]], OLA can send and receive data from traditional wired DMX networks.

OLA can run on Linux and on Mac OS X. A port to Windows is feasible if someone wants to add the necessary platform-dependent code for plug-ins and create an installer.

Bugs: Check the bug tracker at http://code.google.com/p/linux-lighting/issues/list

Questions: See the news group at http://groups.google.com/group/open-lighting

Supported Devices/Protocols:

{| border=1
! '''Driver'''!! Linux !! '''Mac OS X'''
|-
|| [[:Category:ArtNet|ArtNet]] || Yes || Yes
|-
|| [[:Category:ShowNet|ShowNet]] || Yes || Yes
|-
|| [[:Category:ESP Net|ESP Net]] || Yes || Yes
|-
|| [[:Category:Sandnet|Sandnet]] || Yes || Yes
|-
|| [[E1.31]] / [[ACN]] || Yes || Yes
|-
|| [[DMX USB Pro]] || Yes || Yes
|-
|| [[Open DMX USB]] || Yes || -
|-
|| [[StageProfi]] || Yes || Ethernet version only
|-
|| [[:Category:Pathport|Pathport]] || Yes || Yes
|-
|| [[DMX 4 Linux]] || Yes || -
|}

Getting Started

Start here if you've never used OLA before and read these in order.
* [[Download OLA]]
* [[OLA on OS X]] or [[OLA on Linux]] - How to get it compiled.
* [[Using OLA]] - A basic introduction
* [[OLA Command Line Tools]] - Documentation for the tools in ola-examples
* [[OLA Device Specific Configuration]]
* [[OLA Tips & Tricks]]
* [[OLA Merging Algorithms]]

Developer Documentation:
* [[OLA developer info]] - about the source code and structure
* [[OLA Client API]] - the C++ API
* [[OLA Python API]] - easy DMX programming
* [[Build OLA Mac Packages]] - notes for building the .dmg images
* [[Using OLA with Xcode]] - on a Mac, in Objective-C++

Tutorials, these refer to the previous release but parts of them are still relevant.
* [[LLA Sandnet Tutorial]] - Setup Horizon using Sandnet and LLA
* [[LLA and Q Light Controller Ubuntu Tutorial]] - Setup LLA on Ubuntu/Debian-type distro with QLC
* [[LLA and Q Light Controller OSX Tutorial]] - Setup LLA on Mac OS X with QLC

Deprecated Documentation
* [[OLA 0.3]] - Release Notes

OLA can also run on a wireless access point. [http://nomis52.net/?section=projects&sect2=artnet&page=node]

There is a project underway to build packages for OpenWrt. See http://lists.culturebase.org/cgi-bin/mailman/listinfo/lla-openwrt for more details.

[[Category:ArtNet]]
[[Category:ESP Net]]
[[Category:E1.31]]
[[Category:Sandnet]]
[[Category:ShowNet]]
[[Category:Utilities]]