ola::plugin::shownet Namespace Reference

Detailed Description

Code for the Strand ShowNet protocol.

Some reference info: https://code.google.com/p/open-lighting/issues/detail?id=218

Classes
struct	shownet_packet
class	ShowNetDevice
class	ShowNetInputPort
class	ShowNetNode
class	ShowNetOutputPort
class	ShowNetPlugin

Typedefs
typedef struct shownet_dmx_s	shownet_dmx
typedef struct shownet_compressed_dmx_s	shownet_compressed_dmx

Enumerations
enum	{ SHOWNET_MAC_LENGTH = ola::network::MACAddress::LENGTH }
enum	{ SHOWNET_NAME_LENGTH = 9 }
enum	{ SHOWNET_SPARE_LENGTH = 22 }
enum	{ SHOWNET_DMX_DATA_LENGTH = DMX_UNIVERSE_SIZE }
enum	{ SHOWNET_COMPRESSED_DATA_LENGTH = 1269 }
enum	ShowNetPacketType { DMX_PACKET = 0x202f, COMPRESSED_DMX_PACKET = 0x808f }

Functions
	PACK (struct shownet_dmx_s { uint16_t port;uint16_t slot_length;uint16_t pool_size;uint16_t h_slot;uint32_t sequence;uint8_t priority;uint8_t universe;uint16_t spare[SHOWNET_SPARE_LENGTH];uint8_t dmx_data[SHOWNET_DMX_DATA_LENGTH];})
	PACK (struct shownet_compressed_dmx_s { uint16_t netSlot[4];uint16_t slotSize[4];uint16_t indexBlock[5];uint16_t sequence;uint8_t priority;uint8_t universe;uint8_t pass[2];char name[SHOWNET_NAME_LENGTH];uint8_t data[SHOWNET_COMPRESSED_DATA_LENGTH];})

Variables
const char	plugin_description []

Variable Documentation

plugin_description

const char ola::plugin::shownet::plugin_description[]

Initial value:

= "Strand ShowNet Plugin\n"
"=====================\n"
"\n"
"This plugin creates a single device with 8 input and 8 output ports.\n"
"\n"
"The ports correspond to the DMX channels used in the shownet protocol. For\n"
"example the first input and output port 0 is channels 1 - 512 and the second\n"
"input and output ports are channels 513 - 1024.\n"
"\n"
"\n"
"## Config file: `ola-shownet.conf`\n"
"\n"
"`ip = [a.b.c.d|<interface_name>]`  \n"
"The IP address or interface name to bind to. If not specified it will use\n"
"the first non-loopback interface.\n"
"\n"
"`name = ola-ShowNet`  \n"
"The name of the node."