wiki.openlighting.org - User contributions [en]

GSOC2014WindowsPort

2014-08-19T11:10:52Z

Lukase: /* Status */

= GSOC 2014: Windows Port =

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

== Work items ==

=== Identify POSIX-specific functionality ===
Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

=== Minimal GCC/MinGW build ===
In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

=== Documentation ===
Documentation on how to build OLA on Windows can be found on the [[Building_OLA_for_Windows|wiki]] and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

=== Unit tests ===
After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

=== Network-based plugins ===
Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

=== Example programs ===
Since the example programs use libola, they serve as a first test of the port's usability for client programs.

=== Installer ===
In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

=== MSVC support ===
Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

=== olad service ===
The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

=== Python interface ===
For this item, the Python binding will be enabled on Windows as well.

=== Device plugins ===
Depending on hardware availability, plugins for various I/O devices will be ported.

=== Testing and CI ===
In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

=== I18N issues ===
Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

== Status ==
{| class="wikitable"
! Item
! Status
! Comments
|-
| POSIX Functionality
| Done for MinGW, Visual C++ pending
|
|-
| Minimal build
| Done for MinGW, Visual C++ pending
| Current configure options:

<nowiki>./configure --enable-python-libs --disable-e131 --disable-karate --disable-milinst --disable-renard --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx --disable-uart</nowiki>
|-
| Documentation
| Done for MinGW, Visual C++ pending
|
|-
| Unit tests
| Done for MinGW, Visual C++ pending
|-
| Network-based plugins
| Done for MinGW, Visual C++ pending
|
|-
| Example programs
| Done for MinGW, Visual C++ pending
|
|-
| Installer
| not planned for MinGW, Visual C++ pending
|
|-
| MSVC support
| optional / after GSOC
|
|-
| olad service
| optional / after GSOC
|
|-
| Python interface
| Done for MinGW, Visual C++ pending
|
|-
| Device plugins
| optional / after GSOC
|
|-
| Testing and CI
| optional / after GSOC
|
|-
| I18N issues
| optional / after GSOC
|
|}

GSOC2014WindowsPort

2014-08-19T11:10:36Z

Lukase: /* Status */

= GSOC 2014: Windows Port =

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

== Work items ==

=== Identify POSIX-specific functionality ===
Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

=== Minimal GCC/MinGW build ===
In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

=== Documentation ===
Documentation on how to build OLA on Windows can be found on the [[Building_OLA_for_Windows|wiki]] and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

=== Unit tests ===
After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

=== Network-based plugins ===
Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

=== Example programs ===
Since the example programs use libola, they serve as a first test of the port's usability for client programs.

=== Installer ===
In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

=== MSVC support ===
Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

=== olad service ===
The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

=== Python interface ===
For this item, the Python binding will be enabled on Windows as well.

=== Device plugins ===
Depending on hardware availability, plugins for various I/O devices will be ported.

=== Testing and CI ===
In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

=== I18N issues ===
Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

== Status ==
{| class="wikitable"
! Item
! Status
! Comments
|-
| POSIX Functionality
| Done for MinGW, Visual C++ pending
|
|-
| Minimal build
| Done for MinGW, Visual C++ pending
| Current configure options:

<nowiki>./configure --enable-python-libs --disable-e131 --disable-karate --disable-milinst --disable-renard --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx --disable-uart</nowiki>
|-
| Documentation
| Done for MinGW, Visual C++ pending
|
|-
| Unit tests
| Done for MinGW, Visual C++ pending
|-
| Network-based plugins
| Done for MinGW, Visual C++ pending
|
|-
| Example programs
| Done for MinGW, Visual C++ pending
|
|-
| Installer
| not planned for MinGW, Visual C++ pending
|
|-
| MSVC support
| optional / after GSOC
|
|-
| olad service
| optional / after GSOC
|
|-
| Python interface
| optional / after GSOC
|
|-
| Device plugins
| Done for MinGW, Visual C++ pending
|
|-
| Testing and CI
| optional / after GSOC
|
|-
| I18N issues
| optional / after GSOC
|
|}

GSOC2014WindowsPort

2014-08-10T16:28:25Z

Lukase: /* Status */

= GSOC 2014: Windows Port =

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

== Work items ==

=== Identify POSIX-specific functionality ===
Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

=== Minimal GCC/MinGW build ===
In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

=== Documentation ===
Documentation on how to build OLA on Windows can be found on the [[Building_OLA_for_Windows|wiki]] and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

=== Unit tests ===
After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

=== Network-based plugins ===
Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

=== Example programs ===
Since the example programs use libola, they serve as a first test of the port's usability for client programs.

=== Installer ===
In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

=== MSVC support ===
Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

=== olad service ===
The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

=== Python interface ===
For this item, the Python binding will be enabled on Windows as well.

=== Device plugins ===
Depending on hardware availability, plugins for various I/O devices will be ported.

=== Testing and CI ===
In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

=== I18N issues ===
Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

== Status ==
{| class="wikitable"
! Item
! Status
! Comments
|-
| POSIX Functionality
| Done for MinGW, Visual C++ pending
|
|-
| Minimal build
| Done for MinGW, Visual C++ pending
| Current configure options:

<nowiki>./configure --enable-python-libs --disable-e131 --disable-karate --disable-milinst --disable-renard --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx --disable-uart</nowiki>
|-
| Documentation
| Done for MinGW, Visual C++ pending
|
|-
| Unit tests
| Done for MinGW, Visual C++ pending
|-
| Network-based plugins
| Done for MinGW, Visual C++ pending
|
|-
| Example programs
| Done for MinGW, Visual C++ pending
|
|-
| Installer
| not planned for MinGW, Visual C++ pending
|
|-
| MSVC support
| optional / after GSOC
|
|-
| olad service
| optional / after GSOC
|
|-
| Python interface
| optional / after GSOC
|
|-
| Device plugins
| optional / after GSOC
|
|-
| Testing and CI
| optional / after GSOC
|
|-
| I18N issues
| optional / after GSOC
|
|}

GSOC2014WindowsPort

2014-08-10T16:28:04Z

Lukase: /* Status */

= GSOC 2014: Windows Port =

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

== Work items ==

=== Identify POSIX-specific functionality ===
Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

=== Minimal GCC/MinGW build ===
In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

=== Documentation ===
Documentation on how to build OLA on Windows can be found on the [[Building_OLA_for_Windows|wiki]] and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

=== Unit tests ===
After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

=== Network-based plugins ===
Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

=== Example programs ===
Since the example programs use libola, they serve as a first test of the port's usability for client programs.

=== Installer ===
In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

=== MSVC support ===
Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

=== olad service ===
The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

=== Python interface ===
For this item, the Python binding will be enabled on Windows as well.

=== Device plugins ===
Depending on hardware availability, plugins for various I/O devices will be ported.

=== Testing and CI ===
In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

=== I18N issues ===
Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

== Status ==
{| class="wikitable"
! Item
! Status
! Comments
|-
| POSIX Functionality
| Done for MinGW, Visual C++ pending
|
|-
| Minimal build
| Done for MinGW, Visual C++ pending
| Current configure options:

<nowiki>./configure --enable-python-libs --disable-e131 --disable-karate --disable-milinst --disable-renard --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx --disable-uart</nowiki>
|-
| Documentation
| In progress
|
|-
| Unit tests
| Done for MinGW, Visual C++ pending
|-
| Network-based plugins
| Done for MinGW, Visual C++ pending
|
|-
| Example programs
| Done for MinGW, Visual C++ pending
|
|-
| Installer
| not planned for MinGW, Visual C++ pending
|
|-
| MSVC support
| optional / after GSOC
|
|-
| olad service
| optional / after GSOC
|
|-
| Python interface
| optional / after GSOC
|
|-
| Device plugins
| optional / after GSOC
|
|-
| Testing and CI
| optional / after GSOC
|
|-
| I18N issues
| optional / after GSOC
|
|}

Building OLA for Windows

2014-08-10T16:24:37Z

Lukase:

This describes how to get OLA compiled for windows, it's a work in progress so it's unlikely to work as is. This tutorial uses gcc as the compiler, other compilers have not been tested.

During [[GSOC2014WindowsPort|Google Summer of Code 2014]], this port will be worked on as one of the selected projects.

== Install Mingw, msys & build tools ==

Together MinGW & msys provide a unix-style shell environment & compiler suite for windows. Read the instructions at the [http://www.mingw.org/ MinGW] site for more info. MinGW now provides an installer to get most of the system up and running quickly. [http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/mingw-get-inst/ Download] the installer and make sure you select "C++ Compiler". "MSYS Basic System" & "MinGW Developer Toolkit" when prompted.

Once the installer has completed, open the msys shell (under Programs > MinGW) and install some additional packages:

$ mingw-get.exe install msys-coreutils mingw32-base mingw32-pthreads-w32 msys-wget

Note that some of these might already have been installed.

== Install Git ==

Git is used to checkout (and commit) the ola sources. See http://code.google.com/p/msysgit/, be sure to select "checkout as is, commit unix style" during the install otherwise you'll get autoconf errors.

Add the following line to your .bashrc file so that git can be used within msys:

PATH="$PATH:/c/Program Files/Git/bin"
alias git=git.exe

== Install pkg-config ==

Download pkg-config-lite from http://sourceforge.net/projects/pkgconfiglite/files/ (the latest binary should work) and extract it to your MinGW directory.

You also need to add

export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
CPPFLAGS="-I/usr/local/include"
LDFLAGS="-L/usr/local/lib"

to your .bashrc file.

You might also want to edit your .profile file and add <pre>[ -f ~/.bashrc ] && . ~/.bashrc</pre>

If you haven't configured your MSYS fstab yet, do that as well. See http://www.mingw.org/wiki/Getting_Started for instructions.

== Install Dependencies ==

=== pkg-config ===
* Download pkg-config-lite from http://sourceforge.net/projects/pkgconfiglite/files/
* Extract to MinGW directory

=== Python (optional) ===
* Tested version: 2.7 series
* Download and install Python for Windows from https://www.python.org/downloads/

=== msys-git ===
* Download msysgit from https://code.google.com/p/msysgit/downloads/list
* Install and make sure to select "Check-out as is, commit UNIX-style"

=== libuuid ===
* Download and extract the latest libuuid tarball from https://code.google.com/p/gnome-build-stage-1/downloads/list
* Configure, compile and install it using the MinGW MSYS shell

=== protobuf ===
* Download and extract the latest protobuf tarball from https://code.google.com/p/protobuf/downloads/list
* Configure, compile and install it using the MinGW MSYS shell
* if you want to use the OLA Python api, install the protobuf Python bindings from the 'python' subdirectory

=== cppunit ===
* Download and extract the latest cppunit tarball from http://sourceforge.net/projects/cppunit/files/cppunit/
* Configure, compile and install it using the MinGW MSYS shell

=== libmicrohttpd ===
* Download and extract the latest libmicrohttpd tarball from http://ftp.gnu.org/gnu/libmicrohttpd/
* Configure, compile and install it using the MinGW MSYS shell

=== liblo (optional) ===
* Download and extract the latest version of liblo from http://liblo.sourceforge.net/
* Configure, compile and install it using the MinGW MSYS shell

== Build OLA ==

* Do a git checkout of OLA

$ git.exe clone https://github.com/OpenLightingProject/ola.git

* Prepare autotools files
$ autoreconf -i -f

* Run ./configure
$ ./configure --enable-python-libs --disable-e131 --disable-karate --disable-milinst --disable-renard --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx --disable-uart

* Build
$ make

* Optional: Run the tests
$ make check

* Install
$ make install

== Current State / TODO ==

See the [[GSOC2014WindowsPort|GSOC project page]].

Open Lighting Architecture

2014-08-10T16:19:50Z

Lukase: Documented Windows support

[[Image:OLA-Logo-Fitted-48px.png|right]]
Link: http://www.openlighting.org/ola/ <br>
{{Features|free=yes|tx=yes|rx=yes|linux=yes|osx=yes|http=yes|rdm=yes|win=yes}}
[[Image:Ola-download.png |right|link=http://opendmx.net/index.php/Download_%26_Install_OLA]]
[[Image:Llad_home.png| thumb |200px|right|Universe Settings]]
[[Image:Ola-rdm.png|thumb|200px|right|RDM Devices Page]]
[[Image:OLA_patching.png|thumb|200px|right|Drag & Drop RDM Patching]]
[[Image:Ola-mobile.png|thumb|200px|right|Mobile UI]]

__NOTOC__
The Open Lighting Architecture (OLA) is part of the [[Open Lighting Project]] and provides applications with a mechanism to send and receive [[DMX512]] & [[RDM]] commands using hardware devices and DMX over IP protocols. This enables [[:Category:Controllers | software lighting controllers]] to communicate with hardware either via Ethernet or traditional DMX512 networks.

OLA can also convert DMX512 data sent using DMX over IP protocols from one format to another, allowing devices from different manufacturers to interact with one another. For example a [[Strand_Lighting|Strand]] Lighting Console using ShowNet can send DMX512 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 wired DMX512 networks.

==Supported Protocols==

{| border=1 cellspacing="0"
! '''Protocol'''!! Linux !! '''Mac OS X''' || '''FreeBSD''' || '''Windows'''
|-
|| [[:Category:ArtNet|ArtNet, ArtNet 2, ArtNet 3]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]][[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]][[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]]
|-
|| [[E1.31]] / [[ACN]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || Not yet
|-
|| [[:Category:ESP Net|ESP Net]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|-
|| [[KiNET]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]]
|-
|| [[OSC]] (Open Sound Control) || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ? || [[Image:Green-tick.png|center]]
|-
|| [[:Category:Pathport|Pathport]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|-
|| [[:Category:Sandnet|Sandnet]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|-
|| [[:Category:ShowNet|ShowNet]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]]
|}

==Supported Devices==

{| border=1 cellspacing="0"
! '''Device'''!! Linux !! '''Mac OS X''' || '''FreeBSD''' || '''Windows'''
|-
|| [[Anyma uDMX]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ? || no
|-
|| [[Arduino RGB Mixer]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || [[Image:Green-tick.png|center]] [[Image:Rdm.gif|center]] || ? || no
|-
|| [[DMX 4 Linux]] || [[Image:Trans.gif|center]] || || ? || no
|-
|| [[DMX USB Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || no
|-
|| [[DMX USB Pro MkII]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || no
|-
|| [[DMX-TRI]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || no
|-
|| [[DMXking USB DMX512-A]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ? || no
|-
|| [[DMXter4 RDM]] / [[MiniDMXter]] || [[Image:Rdm.gif|center]] || [[Image:Rdm.gif|center]] || ? || no
|-
|| [[Eurolite USB DMX512 PRO]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ? || no
|-
|| [[KarateLight]] || [[Image:Trans.gif|center]] || || ? || no
|-
|| [http://kmtronic.com/kmtronic-dmx-adapter.html KMtronic DMX Adapter] || [[Image:Trans.gif|center]] || || ? || no
|-
|| [[Open DMX USB]] || [[Image:Trans.gif|center]] || || ? || no
|-
|| [[Milford Instruments 1-463]] || [[Image:Trans.gif|center]] || ? || ? || no
|-
|| [[Packetheads USB_DMX Dongle]] || [[Image:Green-tick.png|center]] || [[Image:Green-tick.png|center]] || ? || no
|-
|| [[RDM USB Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ? || no
|-
|| [[RDM-TRI]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || no
|-
|| [http://www.doityourselfchristmas.com/wiki/index.php?title=Renard Renard Serial Protocol (Renard SS24, SS8, etc)] || [[Image:Trans.gif|center]] || ? || ? || no
|-
|| [[Robe Universal Interface]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || ? || no
|-
|| [[RUNIT WTX]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] [[Image:Rdm.gif|center]] || ? || no
|-
|| [[OLA_LED_Pixels|SPI control of LED pixels]] || [[Image:Trans.gif|center]] [[Image:Rdm.gif|center]] || ? || ? || no
|-
|| [[StageProfi]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] (Ethernet version only) || ? || no
|-
|| [http://machosehead.wordpress.com/2010/06/12/udmx_asp/ uDMX_asp] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ? || no
|-
|| [[ultraDMX Pro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ? || no
|-
|| [[ultraDMX Micro]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || [[Image:Trans.gif|center]] [[Image:Recv.gif|center]] || ? || no
|-
|| [[USBDMX2]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ? || no
|-
|| [http://www.soh.cz/produkty/modul-usb-dmx512 USB-DMX512] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ? || no
|-
|| [[Velleman K8062]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ? || no
|-
|| [[Velleman_K8062_Upgrade|VX8062]] || [[Image:Trans.gif|center]] || [[Image:Trans.gif|center]] || ? || no
|}

==Getting Started==

Start here if you've never used OLA before and read these in order.
* [[Download & Install OLA]]
* [[Using OLA]] - A basic introduction
* [[OLA Command Line Tools]] - Documentation for the tools in ola-examples
* [[OLA Device Specific Configuration]]
* [[OLA Tips & Tricks]]
* [[RDM with OLA]]

===Tutorials===
* [[OLA on Windows with VMWare]]
* [[OLA Live CD]], instructions on how to use the Live CD
* [[OLA Raspberry Pi]]
* [[OLA on Beaglebone]]
* [[OLAGuruPlug]] - Running OLA on a [http://www.globalscaletechnologies.com/c-4-guruplugs.aspx GuruPlug]
* [[OLA RDM Responder Testing]]
* [[OLA LED Pixels]] - Using OLA and a Pi to drive SPI LED tape
* [[OlaOutput Max External]] - Setup OlaOutput on Mac OS X to send DMX messages from Max/MSP/Jitter
* [[OlaLED]] - control RGB LED via HTTP

===Advanced Topics===
* [[OLA Merging Algorithms]]
* [[OLA DiffServ support]] (QOS settings)
* [[OLA DMX Trigger]] - Using OLA and DMX to trigger events on a computer
* [[OLA Patch persistency]]

===Developer Documentation===

The developer documentation is in the process of being re-written as doxygen comments in the src tarball. The latest generated copy of the docs is hosted at http://docs.openlighting.org/doc/latest/ versions for specific releases are hosted at http://docs.openlighting.org/doc/.

* [[OLA developer info]] - about the source code and structure
* [[doc:index|OLA Doxygen Docs]] - Generated Doxygen docs aimed at developers creating clients.
** See [[OLA_on_Linux#Doxygen_Documentation|here]] for info on generating Doxygen docs locally.
* [[code-raw:plugins/osc/README|Walkthrough of the OSC plugin code]] - good for people wanting to create new plugins
* OLA APIs
** Protobufs Based
*** [[doc:client_tutorial|OLA Client API]] - the C++ API, (also [[OLA Client API|older examples]])
*** [[OLA Python API]] - easy DMX programming
*** [[code:java|Java]] - currently a work in progress (see an example using it [https://github.com/neophob/ola-to-tpm2net here])
** Alternatives
*** [[OLA JSON API|JSON]] - Browse to /help on your OLA webserver to see the available commands (append ?help=1 to the end of a command for more info in newer versions of OLA)
*** [[OSC]] - Not technically an API, but not strictly a lighting protocol either, enable the OSC plugin and use it to communicate with OLA from a variety of software
* [[Build OLA Mac Packages]] - notes for building the .dmg images
* [[Building OLA for Windows]] - Notes on Windows support (in progress)
* [[Cross Compiling OLA]]
* [[OLA Buildbot|Buildbot]] - For continuous build and testing
* [[Using OLA with Xcode]] - on a Mac, in Objective-C++
* [[Writing RDM Responder Tests]]
* [[Port Throttling]]
* [[RDM PID Definitions]]
* [[OLA Performance Stats]]
* [[OLA TimeCode]]
* [[doc:rpc_system|RPC Protocol]] (or "How do I talk to OLA in a different language")

===Old 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

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

GSOC2014WindowsPort

2014-05-06T13:43:08Z

Lukase: /* Status */

= GSOC 2014: Windows Port =

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

== Work items ==

=== Identify POSIX-specific functionality ===
Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

=== Minimal GCC/MinGW build ===
In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

=== Documentation ===
Documentation on how to build OLA on Windows can be found on the [[Building_OLA_for_Windows|wiki]] and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

=== Unit tests ===
After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

=== Network-based plugins ===
Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

=== Example programs ===
Since the example programs use libola, they serve as a first test of the port's usability for client programs.

=== Installer ===
In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

=== MSVC support ===
Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

=== olad service ===
The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

=== Python interface ===
For this item, the Python binding will be enabled on Windows as well.

=== Device plugins ===
Depending on hardware availability, plugins for various I/O devices will be ported.

=== Testing and CI ===
In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

=== I18N issues ===
Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

== Status ==
{| class="wikitable"
! Item
! Status
! Comments
|-
| POSIX Functionality
| In progress
|
|-
| Minimal build
| In progress
| Current configure options:

<nowiki>./configure --disable-doxygen-doc --disable-examples --disable-http --disable-libftdi --disable-libusb --disable-osc --disable-root-check --disable-slp --disable-artnet --disable-dmx4linux --disable-dummy --disable-e131 --disable-espnet --disable-ftdidmx --disable-karate --disable-kinet --disable-milinst --disable-opendmx --disable-osc --disable-pathport --disable-renard --disable-sandnet --disable-shownet --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx</nowiki>

The minimal build completes, but runtime functionality is not there yet. See also "Unit tests" below
|-
| Documentation
| In progress
|
|-
| Unit tests
| In progress
| Unit tests up to (but not including) common/web pass
|-
| Network-based plugins
| pending
|
|-
| Example programs
| pending
|
|-
| Installer
| pending
|
|-
| MSVC support
| optional / after GSOC
|
|-
| olad service
| optional / after GSOC
|
|-
| Python interface
| optional / after GSOC
|
|-
| Device plugins
| optional / after GSOC
|
|-
| Testing and CI
| optional / after GSOC
|
|-
| I18N issues
| optional / after GSOC
|
|}

GSOC2014WindowsPort

2014-05-05T19:20:39Z

Lukase: /* Status */

= GSOC 2014: Windows Port =

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

== Work items ==

=== Identify POSIX-specific functionality ===
Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

=== Minimal GCC/MinGW build ===
In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

=== Documentation ===
Documentation on how to build OLA on Windows can be found on the [[Building_OLA_for_Windows|wiki]] and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

=== Unit tests ===
After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

=== Network-based plugins ===
Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

=== Example programs ===
Since the example programs use libola, they serve as a first test of the port's usability for client programs.

=== Installer ===
In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

=== MSVC support ===
Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

=== olad service ===
The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

=== Python interface ===
For this item, the Python binding will be enabled on Windows as well.

=== Device plugins ===
Depending on hardware availability, plugins for various I/O devices will be ported.

=== Testing and CI ===
In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

=== I18N issues ===
Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

== Status ==
{| class="wikitable"
! Item
! Status
! Comments
|-
| POSIX Functionality
| In progress
|
|-
| Minimal build
| In progress
| Current configure options:

<nowiki>./configure --disable-doxygen-doc --disable-examples --disable-http --disable-libftdi --disable-libusb --disable-osc --disable-root-check --disable-slp --disable-artnet --disable-dmx4linux --disable-dummy --disable-e131 --disable-espnet --disable-ftdidmx --disable-karate --disable-kinet --disable-milinst --disable-opendmx --disable-osc --disable-pathport --disable-renard --disable-sandnet --disable-shownet --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx</nowiki>

The minimal build completes, but runtime functionality is not there yet. See also "Unit tests" below
|-
| Documentation
| In progress
|
|-
| Unit tests
| In progress
| Unit tests fail
|-
| Network-based plugins
| pending
|
|-
| Example programs
| pending
|
|-
| Installer
| pending
|
|-
| MSVC support
| optional / after GSOC
|
|-
| olad service
| optional / after GSOC
|
|-
| Python interface
| optional / after GSOC
|
|-
| Device plugins
| optional / after GSOC
|
|-
| Testing and CI
| optional / after GSOC
|
|-
| I18N issues
| optional / after GSOC
|
|}

Building OLA for Windows

2014-05-05T19:19:33Z

Lukase: /* Install Dependencies */

This describes how to get OLA compiled for windows, it's a work in progress so it's unlikely to work as is. This tutorial uses gcc as the compiler, other compilers have not been tested.

During [[GSOC2014WindowsPort|Google Summer of Code 2014]], this port will be worked on as one of the selected projects.

== Install Mingw, msys & build tools ==

Together MinGW & msys provide a unix-style shell environment & compiler suite for windows. Read the instructions at the [http://www.mingw.org/ MinGW] site for more info. MinGW now provides an installer to get most of the system up and running quickly. [http://sourceforge.net/projects/mingw/files/Automated%20MinGW%20Installer/mingw-get-inst/ Download] the installer and make sure you select "C++ Compiler". "MSYS Basic System" & "MinGW Developer Toolkit" when prompted.

Once the installer has completed, open the msys shell (under Programs > MinGW) and install some additional packages:

$ mingw-get.exe install msys-coreutils

== Install Git ==

Git is used to checkout (and commit) the ola sources. See http://code.google.com/p/msysgit/, be sure to select "checkout as is, commit unix style" during the install otherwise you'll get autoconf errors.

Add the following line to your .bashrc file so that git can be used within msys:

PATH="$PATH:/c/Program Files/Git/bin"
alias git=git.exe

== Install pkg-config ==

Download pkg-config-lite from http://sourceforge.net/projects/pkgconfiglite/files/ (the latest binary should work) and extract it to your MinGW directory.

You also need to add

export PKG_CONFIG_PATH=/usr/local/lib/pkgconfig
CPPFLAGS="-I/usr/local/include"
LDFLAGS="-L/usr/local/lib"

to your .bashrc file.

You might also want to edit your .profile file and add <pre>[ -f ~/.bashrc ] && . ~/.bashrc</pre>

== Install Dependencies ==

For each of these it should be as simple as downloading the package, placing it in C:\MinGW\msys\1.0\home\USER , un-taring the package and running ./configure , make & make install.

* http://sourceforge.net/projects/cppunit/files/

=== libuuid ===

* Download and extract the latest libuuid tarball from https://code.google.com/p/gnome-build-stage-1/downloads/list
* Configure, compile and install it using the MinGW MSYS shell

=== protobuf ===

* Download and extract the latest protobuf tarball from https://code.google.com/p/protobuf/downloads/list
* Configure, compile and install it using the MinGW MSYS shell

=== cppunit ===

* Download and extract the latest cppunit tarball from http://sourceforge.net/projects/cppunit/files/cppunit/
* Configure, compile and install it using the MinGW MSYS shell

== Build OLA ==

* Do a git checkout of OLA

$ git.exe clone https://github.com/OpenLightingProject/ola.git

* Prepare autotools files
$ autoreconf -i -f

* Run ./configure
$ ./configure

* Build
$ make

== Current State / TODO ==

See the [[GSOC2014WindowsPort|GSOC project page]].

== Problems ==

GSOC2014WindowsPort

2014-05-05T00:07:29Z

Lukase: /* Status */

= GSOC 2014: Windows Port =

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

== Work items ==

=== Identify POSIX-specific functionality ===
Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

=== Minimal GCC/MinGW build ===
In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

=== Documentation ===
Documentation on how to build OLA on Windows can be found on the [[Building_OLA_for_Windows|wiki]] and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

=== Unit tests ===
After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

=== Network-based plugins ===
Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

=== Example programs ===
Since the example programs use libola, they serve as a first test of the port's usability for client programs.

=== Installer ===
In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

=== MSVC support ===
Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

=== olad service ===
The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

=== Python interface ===
For this item, the Python binding will be enabled on Windows as well.

=== Device plugins ===
Depending on hardware availability, plugins for various I/O devices will be ported.

=== Testing and CI ===
In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

=== I18N issues ===
Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

== Status ==
{| class="wikitable"
! Item
! Status
! Comments
|-
| POSIX Functionality
| In progress
|
|-
| Minimal build
| In progress
| Current configure options:

<nowiki>./configure --disable-doxygen-doc --disable-unittests --disable-examples --disable-http --disable-libftdi --disable-libusb --disable-osc --disable-root-check --disable-slp --disable-artnet --disable-dmx4linux --disable-dummy --disable-e131 --disable-espnet --disable-ftdidmx --disable-karate --disable-kinet --disable-milinst --disable-opendmx --disable-osc --disable-pathport --disable-renard --disable-sandnet --disable-shownet --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx</nowiki>

The minimal build completes, but runtime functionality is not there yet.
|-
| Documentation
| In progress
|
|-
| Unit tests
| pending
|
|-
| Network-based plugins
| pending
|
|-
| Example programs
| pending
|
|-
| Installer
| pending
|
|-
| MSVC support
| optional / after GSOC
|
|-
| olad service
| optional / after GSOC
|
|-
| Python interface
| optional / after GSOC
|
|-
| Device plugins
| optional / after GSOC
|
|-
| Testing and CI
| optional / after GSOC
|
|-
| I18N issues
| optional / after GSOC
|
|}

GSOC2014WindowsPort

2014-05-03T23:34:07Z

Lukase: /* Status */

= GSOC 2014: Windows Port =

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

== Work items ==

=== Identify POSIX-specific functionality ===
Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

=== Minimal GCC/MinGW build ===
In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

=== Documentation ===
Documentation on how to build OLA on Windows can be found on the [[Building_OLA_for_Windows|wiki]] and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

=== Unit tests ===
After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

=== Network-based plugins ===
Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

=== Example programs ===
Since the example programs use libola, they serve as a first test of the port's usability for client programs.

=== Installer ===
In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

=== MSVC support ===
Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

=== olad service ===
The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

=== Python interface ===
For this item, the Python binding will be enabled on Windows as well.

=== Device plugins ===
Depending on hardware availability, plugins for various I/O devices will be ported.

=== Testing and CI ===
In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

=== I18N issues ===
Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

== Status ==
{| class="wikitable"
! Item
! Status
! Comments
|-
| POSIX Functionality
| In progress
|
|-
| Minimal build
| In progress
| Current configure options:

<nowiki>./configure --disable-doxygen-doc --disable-unittests --disable-examples --disable-http --disable-libftdi --disable-libusb --disable-osc --disable-root-check --disable-slp --disable-artnet --disable-dmx4linux --disable-dummy --disable-e131 --disable-espnet --disable-ftdidmx --disable-karate --disable-kinet --disable-milinst --disable-opendmx --disable-osc --disable-pathport --disable-renard --disable-sandnet --disable-shownet --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx</nowiki>

Everything under common/ compiles.
|-
| Documentation
| In progress
|
|-
| Unit tests
| pending
|
|-
| Network-based plugins
| pending
|
|-
| Example programs
| pending
|
|-
| Installer
| pending
|
|-
| MSVC support
| optional / after GSOC
|
|-
| olad service
| optional / after GSOC
|
|-
| Python interface
| optional / after GSOC
|
|-
| Device plugins
| optional / after GSOC
|
|-
| Testing and CI
| optional / after GSOC
|
|-
| I18N issues
| optional / after GSOC
|
|}

GSOC2014WindowsPort

2014-05-02T18:49:46Z

Lukase: /* Status */

= GSOC 2014: Windows Port =

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

== Work items ==

=== Identify POSIX-specific functionality ===
Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

=== Minimal GCC/MinGW build ===
In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

=== Documentation ===
Documentation on how to build OLA on Windows can be found on the [[Building_OLA_for_Windows|wiki]] and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

=== Unit tests ===
After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

=== Network-based plugins ===
Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

=== Example programs ===
Since the example programs use libola, they serve as a first test of the port's usability for client programs.

=== Installer ===
In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

=== MSVC support ===
Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

=== olad service ===
The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

=== Python interface ===
For this item, the Python binding will be enabled on Windows as well.

=== Device plugins ===
Depending on hardware availability, plugins for various I/O devices will be ported.

=== Testing and CI ===
In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

=== I18N issues ===
Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

== Status ==
{| class="wikitable"
! Item
! Status
! Comments
|-
| POSIX Functionality
| In progress
|
|-
| Minimal build
| In progress
| Current configure options:

<nowiki>./configure --disable-doxygen-doc --disable-unittests --disable-examples --disable-http --disable-libftdi --disable-libusb --disable-osc --disable-root-check --disable-slp --disable-artnet --disable-dmx4linux --disable-dummy --disable-e131 --disable-espnet --disable-ftdidmx --disable-karate --disable-kinet --disable-milinst --disable-opendmx --disable-osc --disable-pathport --disable-renard --disable-sandnet --disable-shownet --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx</nowiki>
|-
| Documentation
| In progress
|
|-
| Unit tests
| pending
|
|-
| Network-based plugins
| pending
|
|-
| Example programs
| pending
|
|-
| Installer
| pending
|
|-
| MSVC support
| optional / after GSOC
|
|-
| olad service
| optional / after GSOC
|
|-
| Python interface
| optional / after GSOC
|
|-
| Device plugins
| optional / after GSOC
|
|-
| Testing and CI
| optional / after GSOC
|
|-
| I18N issues
| optional / after GSOC
|
|}

GSOC2014WindowsPort

2014-05-02T18:17:06Z

Lukase: Created page with "= GSOC 2014: Windows Port = For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items th..."

= GSOC 2014: Windows Port =

For Google's Summer Of Code 2014, the Windows port has been accepted as a project. This wiki page gives an overview of the different work items that are part of this project, and the overall progress. All development happens on github at https://github.com/lukase/ola, and progress is continually merged upstream into the main OLA repository.

== Work items ==

=== Identify POSIX-specific functionality ===
Many parts of OLA use POSIX-specific functionality that's not available on Windows, such as daemon handling, user profile handling, and a general purpose select() call. For each of these functions, equivalent functions on Windows have to be researched, or alternatives have to be designed. Currently, the biggest problem lies with the SelectServer, for which there is no equivalent solution with equal scope on Windows.

=== Minimal GCC/MinGW build ===
In order to reduce the complexity of the port, the first goal is to get a minimal build of OLA up and running (i.e. disable as much functionality as possible).

=== Documentation ===
Documentation on how to build OLA on Windows can be found on the [[Building_OLA_for_Windows|wiki]] and in the repository itself (README.mingw32). It will continually be updated to reflect the current status of the port.

=== Unit tests ===
After the minimal configuration of OLA can be built, the next step will be to re-enable the unit tests and make sure all of them pass.

=== Network-based plugins ===
Since these plugins don't rely on special hardware, network protocols are the first plugins to be re-enabled.

=== Example programs ===
Since the example programs use libola, they serve as a first test of the port's usability for client programs.

=== Installer ===
In order to simplify libola usage for Windows developers, an installer will be created that contains pre-built binaries for MinGW. Once MSVC support is available, it will be added to the installer as well.

=== MSVC support ===
Microsoft Visual C++ is the dominant compiler on Windows platforms. Once the basic MinGW port is completed, support and project files for MSVC will be added.

=== olad service ===
The Windows equivalent to daemons are services. It should therefore be possible to start olad as a Windows service.

=== Python interface ===
For this item, the Python binding will be enabled on Windows as well.

=== Device plugins ===
Depending on hardware availability, plugins for various I/O devices will be ported.

=== Testing and CI ===
In order to ensure that code changes do not break the port in the future, a Windows build-slave should be configured. This can either be a Windows VM or a wine/mingw-based Linux installation.

=== I18N issues ===
Windows uses some locale-specific paths and encodings. Codepage/encoding issues such as UTF-8/ASCII/UTF-16 conflicts should be investigated and fixed.

== Status ==
{| class="wikitable"
! Item
! Status
! Comments
|-
| POSIX Functionality
| In progress
|
|-
| Minimal build
| In progress
| Current configure options:

<nowiki>./configure --disable-doxygen-doc --disable-unittests --disable-examples --disable-http --disable-libftdi --disable-libusb --disable-osc --disable-root-check --disable-slp --disable-artnet --disable-dmx4linux --disable-dummy --disable-e131 --disable-espnet --disable-ftdidmx --disable-karate --disable-kinet --disable-milinst --disable-opendmx --disable-osc --disable-pathport --disable-renard --disable-sandnet --disable-shownet --disable-spi --disable-stageprofi --disable-usbpro --disable-usbdmx</nowiki>
|-
| Documentation
| In progress
|
|-
| Unit tests
| pending
|
|-
| Network-based plugins
| pending
|
|-
| Example programs
| pending
|
|-
| Installer
| pending
|
|-
| MSVC support
| optional
|
|-
| olad service
| optional
|
|-
| Python interface
| optional
|
|-
| Device plugins
| optional
|
|-
| Testing and CI
| optional
|
|-
| I18N issues
| optional
|
|}

Building OLA for Windows

2014-05-02T17:27:52Z

Lukase: