OLA Python API - Revision history

Nomis52 at 00:48, 8 June 2011

2011-06-08T00:48:17Z

2011-01-20T00:45:12Z

2011-01-09T18:58:21Z

2011-01-09T18:56:26Z

2011-01-09T18:50:34Z

‎Building the Python Bindings

2009-08-03T02:16:24Z

2008-02-28T22:38:33Z

‎Building the Python Bindings

2007-12-28T20:54:56Z

‎Building the Python Bindings

2007-12-28T20:52:15Z

‎Building the Python Bindings

2007-12-28T18:38:00Z

‎Building the Python Bindings

@@ Line 51: / Line 51: @@
 == Sending DMX ==
-A simple example to send DMX:
+A simple example to send one frame of DMX data:
 <pre>
@@ Line 71: / Line 71: @@
 </pre>
 == Receiving DMX ==

← Older revision		Revision as of 00:45, 20 January 2011
Line 1:		Line 1:
	== Building the Python Bindings ==		== Building the Python Bindings ==
		+
		+	You should install readline if you haven't already:
		+
		+	<pre>
		+	sudo easy_install readline
		+	</pre>

	You need the python version of protocol buffers installed.		You need the python version of protocol buffers installed.

@@ Line 3: / Line 3: @@
 You need the python version of protocol buffers installed.
-See [[Building LLA]]  but run
+See [[Building OLA]]  but run
 <pre>

@@ Line 36: / Line 36: @@
 == Interesting Classes ==
-; LlaClient
+; ClientWrapper
-: the main connection class
+: A helper class that connects to the server and creates a new OlaClient
-; dmxBuffer
+; OlaClient
-: represents a list of DMX channel values
+: The main API
-; LlaClientObserver
-: base class to handle events
-; LlaPlugin
+The best documentation is the set of example programs in the python/examples directory.
 == Sending DMX ==
@@ Line 51: / Line 48: @@
 <pre>
-from lla import *
+import array
-import sys
+from ola.ClientWrapper import ClientWrapper
-con = LlaClient()
+def DmxSent(state):
-if con.start():
+   wrapper.Stop()
-universe = 0
+universe = 1
+data = array.array('B')
-# create a dmxBuffer for the channel values
+data.append(10)
-DMX_LEN = 512
+data.append(50)
-dmx = dmxBuffer(DMX_LEN)
+data.append(255)
-for i in range(0, DMX_LEN):
+wrapper = ClientWrapper()
-  dmx[i] = i
+client = wrapper.Client()
+client.SendDmx(universe, data, DmxSent)
-con.send_dmx(universe, dmx, DMX_LEN)
+wrapper.Run()
 </pre>
 == Receiving DMX ==
-Receiving is slightly harder, we need to setup an Observer object to handle the events:
+Here is some code to receive DMX on universe 1.
 <pre>
-from lla import *
+from ola.ClientWrapper import ClientWrapper
-con.register_uni(1, LlaClient.REGISTER)
+def NewData(data):
-while True:
+universe = 1
 </pre>

@@ Line 1: / Line 1: @@
 == Building the Python Bindings ==
-See [[Building LLA]]  but run ''./configure --enable-python-libs''
+You need the python version of protocol buffers installed.
-Note that you have to install Swig in order to build the python bindings (sudo apt-get install swig)
+See [[Building LLA]]  but run
-There is also a forgotten data in lla/python/Makefile : you have to add -I../include to the value of DEFAULT_INCLUDES at the line 70.
+<pre>
-At the end of the installation, you should run ldconfig as root in order to use the python bindings.
+Check where the modules are going to be installed:
 == Interesting Classes ==

← Older revision	Revision as of 02:16, 3 August 2009
(No difference)

← Older revision		Revision as of 20:54, 28 December 2007
Line 6:		Line 6:

	There is also a forbidden data in lla/python/Makefile : you have to add -I../include to the value of DEFAULT_INCLUDES at the line 70.		There is also a forbidden data in lla/python/Makefile : you have to add -I../include to the value of DEFAULT_INCLUDES at the line 70.
		+
		+	At the end of the installation, you should run ldconfig as root in order to use the python bindings.

	== Interesting Classes ==		== Interesting Classes ==

← Older revision		Revision as of 20:52, 28 December 2007
Line 4:		Line 4:

	Note that you have to install Swig in order to build the python bindings (sudo apt-get install swig)		Note that you have to install Swig in order to build the python bindings (sudo apt-get install swig)
		+
		+	There is also a forbidden data in lla/python/Makefile : you have to add -I../include to the value of DEFAULT_INCLUDES at the line 70.

	== Interesting Classes ==		== Interesting Classes ==

← Older revision		Revision as of 18:38, 28 December 2007
Line 2:		Line 2:

	See [[Building LLA]] but run ''./configure --enable-python-libs''		See [[Building LLA]] but run ''./configure --enable-python-libs''
		+
		+	Note that you have to install Swig in order to build the python bindings (sudo apt-get install swig)

	== Interesting Classes ==		== Interesting Classes ==