ola::plugin::pathport Namespace Reference

Detailed Description

Code for the Pathport protocol.

Classes
struct	pathport_pdu_getrep_alv_s
class	PathportDevice
class	PathportInputPort
class	PathportNode
class	PathportOutputPort
class	PathportPlugin
class	PathportPortHelper

Typedefs
typedef enum pathport_packet_type_e	pathport_packet_type_t
typedef struct pathport_pdu_data_s	pathport_pdu_data
typedef struct pathport_pdu_get_s	pathport_pdu_get
typedef struct pathport_pdu_getrep_s	pathport_pdu_getrep
typedef struct pathport_pdu_getrep_alv_s	pathport_pdu_getrep_alv
typedef struct pathport_pdu_arp_reply_s	pathport_pdu_arp_reply
typedef struct pathport_pdu_header_s	pathport_pdu_header
typedef struct pathport_packet_pdu_s	pathport_packet_pdu
typedef struct pathport_packet_header_s	pathport_packet_header

Enumerations
enum	pathport_packet_type_e {   PATHPORT_DATA = 0x0100, PATHPORT_PATCH = 0x0200, PATHPORT_PATCHREP = 0x0210, PATHPORT_GET = 0x0222,   PATHPORT_GET_REPLY = 0x0223, PATHPORT_ARP_REQUEST = 0x0301, PATHPORT_ARP_REPLY = 0x0302, PATHPORT_SET = 0x0400 }

Functions
enum ola::plugin::pathport::pathport_packet_type_e	__attribute__ ((packed))
	PACK (struct pathport_pdu_data_s { uint16_t type;uint16_t channel_count;uint8_t universe;uint8_t start_code;uint16_t offset;uint8_t data[0];})
	PACK (struct pathport_pdu_get_s { uint16_t params[0];})
	PACK (struct pathport_pdu_getrep_s { uint8_t params[0];})
	PACK (struct pathport_pdu_arp_reply_s { uint32_t id;uint8_t ip[ola::network::IPV4Address::LENGTH];uint8_t manufacturer_code;uint8_t device_class;uint8_t device_type;uint8_t component_count;})
	PACK (struct pathport_pdu_header_s { uint16_t type;uint16_t len;})
	PACK (struct pathport_packet_pdu_s { pathport_pdu_header head;union { pathport_pdu_data data;pathport_pdu_get get;pathport_pdu_getrep getrep;pathport_pdu_arp_reply arp_reply;} d;})
	PACK (struct pathport_packet_header_s { uint16_t protocol;uint8_t version_major;uint8_t version_minor;uint16_t sequence;uint8_t reserved[6];uint32_t source;uint32_t destination;})
	PACK (struct pathport_packet_s { pathport_packet_header header;union { uint8_t data[1480];pathport_packet_pdu pdu;} d;})

Variables
struct ola::plugin::pathport::pathport_pdu_getrep_alv_s	__attribute__
const char	plugin_description []

Variable Documentation

plugin_description

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

Initial value:

= "Pathway Pathport Plugin\n"
"=======================\n"
"\n"
"This plugin creates a single device with 5 input and 5 output ports.\n"
"\n"
"The universe the port is patched to corresponds with the DMX channels used\n"
"in the PathPort protocol. For example universe 0 is xDMX channels 0 - 511,\n"
"universe 1 is xDMX channels 512 - 1023.\n"
"\n"
"\n"
"## Config file: `ola-pathport.conf`\n"
"\n"
"`dscp = <int>`  \n"
"Set the DSCP value for the packets. Range is 0-63.\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-Pathport`  \n"
"The name of the node.\n"
"\n"
"`node-id = <int>`  \n"
"The pathport id of the node."