forked from OpenLightingProject/ola
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
81 lines (56 loc) · 3.59 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# Open Lighting Architecture - OLA
[www.openlighting.org/ola](https://www.openlighting.org/ola)
[](https://github.com/OpenLightingProject/ola/actions/workflows/build.yaml) [](https://github.com/OpenLightingProject/ola/actions/workflows/debian.yml) [](https://github.com/OpenLightingProject/ola/actions/workflows/lint.yaml) [](https://scan.coverity.com/projects/3514) [](https://coveralls.io/github/OpenLightingProject/ola?branch=master)
The Open Lighting Architecture (OLA) is a framework for controlling
entertainment lighting equipment. Within the entertainment lighting industry,
the [Digital Multiplex protocol](https://en.wikipedia.org/wiki/DMX512)
(DMX-512) and IP variants such as [Streaming
ACN](https://en.wikipedia.org/wiki/Architecture_for_Control_Networks#External_Extensions)
(sACN) are used to control lighting fixtures.
OLA provides the distribution layer that abstracts away the various protocols
used. This allows authors of lighting control software to focus on generating
the control information, rather than having to implement support for different
hardware devices & network protocols. OLA runs on Linux & Mac OS X, some
features will also work on Windows.
OLA can also be used to convert between different network protocols. With the
use of a USB to DMX512 device, OLA can act as a DMX-over-IP to DMX512 gateway.
OLA consists of three parts, the daemon olad, the olad plugins and the client
library, libola.
Documentation on OLA, including examples on how to get started, are
provided on the [Open Lighting Architecture
Docs](https://docs.openlighting.org/ola/doc/latest/)
site. The pages are
automatically updated from the git repository.
## Downloading OLA
OLA is distributed in a number of formats, including
[Debian](https://www.debian.org/) / [Ubuntu](http://www.ubuntu.com/) Packages
and [MacPorts](https://www.macports.org/). The [OLA
Downloads](https://www.openlighting.org/ola/getting-started/downloads/)
page has more information.
Tagged releases in the git repository are signed. To import the public key, run:
$ git cat-file blob simon-pubkey | gpg --import
and then to verify the release:
$ git tag -v 0.9.6
## Support
Support for OLA is provided via the mailing list and IRC channel. The
[Getting Help](https://www.openlighting.org/ola/get-help/) page has more
details.
## Components
### Plugins
The OLA plugins are located in ./plugins. For a walkthrough of an example see
plugins/osc/README.developer.md.
### C++ Library
The C++ Client is in ./ola. The [C++ DMX Client API
Tutorial](https://docs.openlighting.org/ola/doc/latest/dmx_cpp_client_tutorial.html)
has various examples on how one can use the client.
### Python Module
The Python module can be built by running configure with
--enable-python-libs. There are examples on how to use the Python API in
python/examples.
### Java Library
There is an experimental Java library which can be built by running configure
with --enable-java-libs.
## Credits
The AUTHORS files contains a list of code contributors. A [full list of
supporters](https://www.openlighting.org/openlightingproject/about/supporters/)
is published on the website.