official
/
OpenLCP
1
0
Fork 0
Code Releases 1 Activity

add new classes to listing

This commit is contained in:
Kevin Matz 2021-08-02 19:21:36 -04:00
parent af8dcc92aa
commit c6a969bd9a
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
sacn/README.md
View File

@ -8,7 +8,7 @@ Include `sacn.h` for full protocol support.
> ```#include "sacn.h"```
### Requirements
Expects the parent directory to contain the `acn` and `dmx` libraries.
Expects to also have the `acn` and `dmx` libraries in the include path.
## Logical components
@ -21,8 +21,19 @@ Expects the parent directory to contain the `acn` and `dmx` libraries.
* `universe.h`: [`SACN::Universe`] A set of up to 512 data slots identified by universe number. Note: In E1.31 there may be multiple sources for a universe.
> For protocol agnostic universe refer to the base class, `DMX::Universe`
* `receiver.h`: [`SACN::Receiver`] A receiver is the intended target of information from a source. A receiver may listen on multiple universes.
* `receiver-esp.h`: [`SACN::EspReceiver`] A referance implimention, derived from `SACN::Receiver` for use with ESP devices and Arduino.
* `receiver.h`: [`SACN::Receiver`] A receiver is the intended target of information from a source. A receiver may listen for multiple universes.
* `source.h`: [`SACN::Source`] A sACN component that assembles, formats, and transmits data to one or many receivers.
* `node.h`: [`SACN::Node`] A class that inherits from both `SACN::Source` and `SACN::Receiver`. IE. can both send and receive. The node class also manages universe discovery.
### Reference Implementations
Several reference implementations may be available in the `platform` subdirectory.
* `receiver-esp.h`: [`SACN::EspReceiver`] A reference implementation, derived from `SACN::Receiver` for use with ESP devices and Arduino.
* `qsacnnode.h`: [`SACN::QSacnNode`] An implementation that inherits from `SACN::Node`, which handles all of the mucky hardware and network with Qt.
## Usage with Arduino