Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Enumerations | Variables
ola::plugin::openpixelcontrol Namespace Reference

Detailed Description

The Open Pixel Control (OPC) plugin.

Classes

class  OPCClient
 An Open Pixel Control client. More...
 
class  OPCClientDevice
 
class  OPCInputPort
 An InputPort for the OPC plugin. More...
 
class  OPCOutputPort
 An OutputPort for the OPC plugin. More...
 
class  OPCPlugin
 
class  OPCServer
 An Open Pixel Control server. More...
 
class  OPCServerDevice
 

Enumerations

enum  { OPC_HEADER_SIZE = 4, OPC_FRAME_SIZE = DMX_UNIVERSE_SIZE + OPC_HEADER_SIZE }
 

Variables

static const uint8_t SET_PIXEL_COMMAND = 0
 The set-pixel command.
 
const char plugin_description []
 

Enumeration Type Documentation

anonymous enum
Enumerator
OPC_HEADER_SIZE 

The size of the OPC frame header.

OPC_FRAME_SIZE 

The size of an OPC frame with DMX512 data.

Variable Documentation

const char ola::plugin::openpixelcontrol::plugin_description[]
Initial value:
= "OPC Plugin\n"
"==========\n"
"\n"
"This plugin creates OPC Client and/or OPC Server Devices.\n"
"\n"
"\n"
"## Config file: `ola-opc.conf`\n"
"\n"
"`target = <IP>:<port>` \n"
"Create a Open Pixel Control client, connected to the `IP:port`. Multiple\n"
"targets can be specified and a device will be created for each.\n"
"\n"
"`listen = <IP>:<port>` \n"
"Create an Open Pixel Control server, listening on `IP:port`. To listen on\n"
"any address use `listen = 0.0.0.0`. Multiple listen keys can be specified\n"
"and a device will be created for each.\n"
"\n"
"`target_<IP>:<port>_channel = <channel>` \n"
"The Open Pixel Control channels to use for the specified device. Multiple\n"
"channels can be specified and an output port will be created for each.\n"
"\n"
"`listen_<IP>:<port>_channel = <channel>` \n"
"The Open Pixel Control channels to use for the specified device. Multiple\n"
"channels can be specified and an input port will be created for each."