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

Detailed Description

Code for the ESPNet protocol.

Classes

struct  espnet_node_config_s
 
union  espnet_packet_union_t
 
class  EspNetDevice
 
class  EspNetInputPort
 
class  EspNetNode
 
class  EspNetOutputPort
 
class  EspNetPlugin
 
class  EspNetPortHelper
 
class  RunLengthDecoder
 

Typedefs

typedef enum espnet_packet_type_e espnet_packet_type_t
 
typedef struct espnet_poll_s espnet_poll_t
 
typedef struct espnet_node_config_s espnet_node_config_t
 
typedef struct espnet_poll_reply_s espnet_poll_reply_t
 
typedef struct espnet_ack_s espnet_ack_t
 
typedef struct espnet_data_s espnet_data_t
 

Enumerations

enum  espnet_node_type {
  ESPNET_NODE_TYPE_SINGLE_OUT = 0x0001, ESPNET_NODE_TYPE_SINGLE_IN = 0x0002, ESPNET_NODE_TYPE_RS232 = 0x0060, ESPNET_NODE_TYPE_IO = 0x0061,
  ESPNET_NODE_TYPE_LONWORKS = 0x0100
}
 
enum  { ESPNET_MAX_UNIVERSES = 512 }
 
enum  { ESPNET_NAME_LENGTH = 10 }
 
enum  { ESPNET_DATA_LENGTH = 200 }
 
enum  espnet_packet_type_e { ESPNET_POLL = 'E' << 24 | 'S' << 16 | 'P' << 8 | 'P', ESPNET_REPLY = 'E' << 24 | 'S' << 16 | 'P' << 8 | 'R', ESPNET_DMX = 'E' << 24 | 'S' << 16 | 'D' << 8 | 'D', ESPNET_ACK = 'E' << 24 | 'S' << 16 | 'A' << 8 | 'P' }
 
enum  { PORTS_PER_DEVICE = 5 }
 

Functions

enum
ola::plugin::espnet::espnet_packet_type_e 
__attribute__ ((packed))
 
 PACK (struct espnet_poll_s{uint32_t head;uint8_t type;})
 
 PACK (struct espnet_poll_reply_s{uint32_t head;uint8_t mac[ola::network::MACAddress::LENGTH];uint16_t type;uint8_t version;uint8_t sw;uint8_t name[ESPNET_NAME_LENGTH];uint8_t option;uint8_t tos;uint8_t ttl;espnet_node_config_t config;})
 
 PACK (struct espnet_ack_s{uint32_t head;uint8_t status;uint8_t crc;})
 
 PACK (struct espnet_data_s{uint32_t head;uint8_t universe;uint8_t start;uint8_t type;uint16_t size;uint8_t data[DMX_UNIVERSE_SIZE];})
 

Variables

struct
ola::plugin::espnet::espnet_node_config_s 
__attribute__
 
const char plugin_description []
 

Variable Documentation

const char ola::plugin::espnet::plugin_description[]
Initial value:
= "Enttec ESP Net Plugin\n"
"=====================\n"
"\n"
"This plugin creates a single device with five input and five output ports.\n"
"\n"
"ESP supports up to 255 universes. As ESP has no notion of ports, we provide\n"
"a fixed number of ports which can be patched to any universe. When sending\n"
"data from a port, the data is addressed to the universe the port is patched\n"
"to. For example if port 0 is patched to universe 10, the data will be sent\n"
"to ESP universe 10.\n"
"\n"
"\n"
"## Config file: `ola-espnet.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-EspNet` \n"
"The name of the node."