README
¶
Lucibus
Lucibus is a lighting control system. It arose from a feeling that the existing building blocks of lighting control are inneficient. It proposes more structure and normalization, in order to reduce repetition and increase readibility. It's main structures are:
- The patch consists of a mapping of DMX addresses to tags. For example, "warm", "upstage", "hi-side", etc. You can then make a system of lights by querying based on tags. So you could say something like "Warm Top @ 50%". This leads to readable and descriptive state. One consequence of this is that channels are no longer a first class structure. They could be implemented as a subset of tags (think "Channel 1", "Channel 2" as tags), but I am not sure what purpose they would have.
- Systems of lights are combined in order, in a stack based structure. The location in the stack determines precedence. For example if you had "USL Top Cool @ 50%" above "Top Cool @ 30%", then all the top cools would be at 30%, besides the USL top cool, which would be at 50%.
- To reuse the same stack of systems in multiple cues, you can create a look. For example, you might create a "Indoor" or "Blueout" look that can be used in multiple cues. Looks solve the same issues of re-use that tracking addresses, but it is more obvious how they work and are more descriptive. (not implemented yet #66)
Status
This project is being actively developed and is not ready for production use. If you are wondering what still needs to be done, check out the issue tracker.
We welcome all contributions, both of ideas and of code.
Hop on the the chat to ask any questions or open an issue.
Structure
Lucibus is built with web technologies. The client side code (called caido) is mostly Javascript and the server (called subicul) is Go.
Using a client-server model is unconventional for lighting control systems. Traditionally, advantages have not been large enough to offset the cost of the added latency. The web has been improving rapidly, however, and so we chose to make use of these features:
- Access from remote devices, like mobile phones or laptops.
- Multiple simultaneous users.
- Use as much existing work as possible to reduce development time. The collective mindshare working on creating open source solutions for applications on the web is much larger than that on any native platform.
- Can use any operating system as server (as long as it has drivers for the output device)
This project is separated into four distinct apps. They exist right now in one repository for ease of deployment and synchronization of commits.
Currently, the data is serialized as one large JSON tree to send it between client and server. The api subfolder holds the schema that defines the format, as well as many examples of valid states.
The application is distributed as a binary file, that will start up subicul and statically serve caido. This is built in the binary subdirectory.
Directories