1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Library General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* SandnetPackets.h
* Datagram definitions for Sandnet
* Copyright (C) 2005 Simon Newton
*/
#ifndef PLUGINS_SANDNET_SANDNETPACKETS_H_
#define PLUGINS_SANDNET_SANDNETPACKETS_H_
#include <sys/types.h>
#include <stdint.h>
#include <netinet/in.h>
#include <ola/BaseTypes.h>
#include "ola/network/IPV4Address.h"
#include "ola/network/MACAddress.h"
#include "plugins/sandnet/SandNetCommon.h"
namespace ola {
namespace plugin {
namespace sandnet {
enum { SANDNET_NAME_LENGTH = 31};
/*
* Sandnet opcodes.
* These are transmitted as little-endian which why they appear strange.
*/
enum packet_type_e {
SANDNET_ADVERTISMENT = 0x0100,
SANDNET_CONTROL = 0x0200,
SANDNET_DMX = 0x0300,
SANDNET_NAME = 0x0400,
SANDNET_IDENTIFY = 0x0500,
SANDNET_PROG = 0x0600,
SANDNET_LED = 0x0700,
SANDNET_COMPRESSED_DMX = 0x0a00,
}__attribute__((packed));
typedef enum packet_type_e packet_type_t;
enum protocol_id_e {
SANDNET_SANDNET = 0x02,
SANDNET_ARTNET = 0x04,
SANDNET_COMPULIGHT = 0x06,
SANDNET_SHOWNET = 0x09,
SANDNET_IPX = 0x0d,
SANDNET_ACN = 0x0e,
}__attribute__((packed));
typedef enum protocol_id_e protocol_id_t;
struct sandnet_packet_advertisement_port_s {
protocol_id_t protocol; // protocol
uint8_t mode; // mode
uint8_t term; // terminate
uint8_t b; // ??
uint8_t group; // group
uint8_t universe; // universe
uint8_t crap[53]; // ??
}__attribute__((packed));
/*
* A Sandnet Advertisment
*/
struct sandnet_advertisement_s {
uint8_t mac[ola::network::MACAddress::LENGTH]; // mac address
uint32_t firmware; // firmware version
struct sandnet_packet_advertisement_port_s ports[SANDNET_MAX_PORTS]; // ports
uint8_t nlen; // length of the name field
char name[SANDNET_NAME_LENGTH]; // name field (null terminated)
uint8_t magic3[9]; // magic numbers
uint8_t led; // flash the led
uint8_t magic4; // ??
uint8_t zero4[64]; // null
}__attribute__((packed));
typedef struct sandnet_advertisement_s sandnet_advertisement;
/*
* The first of the DMX packets
*/
struct sandnet_dmx_s {
uint8_t group; // group
uint8_t universe; // universe
uint8_t port; // physical port number
uint8_t dmx[DMX_UNIVERSE_SIZE]; // dmx buffer
}__attribute__((packed));
typedef struct sandnet_dmx_s sandnet_dmx;
/*
* Changes the port attributes
*/
struct sandnet_port_control_s {
uint8_t mac[ola::network::MACAddress::LENGTH]; // mac address
uint8_t magic[4]; // ?? seems to change
struct sandnet_packet_advertisement_port_s ports[SANDNET_MAX_PORTS]; // ports
}__attribute__((packed));
typedef struct sandnet_port_control_s sandnet_port_control;
/*
* Sets the name of the sandnet node
*/
struct sandnet_name_s {
uint8_t mac[ola::network::MACAddress::LENGTH]; // mac address
uint8_t name_length; // length of the name field
uint8_t name[SANDNET_NAME_LENGTH]; // name field
}__attribute__((packed));
typedef struct sandnet_name_s sandnet_name;
/*
* identify packet
* (presumably this flashes the leds or something)
*/
struct sandnet_identify_s {
uint8_t mac[ola::network::MACAddress::LENGTH]; // mac address
}__attribute__((packed));
typedef struct sandnet_identify_s sandnet_identify;
/*
* ip program packet
* sets the node's networking parameters
*/
struct sandnet_program_s {
uint8_t mac[ola::network::MACAddress::LENGTH]; // mac address
uint8_t ip[ola::network::IPV4Address::LENGTH];
uint8_t dhcp;
uint8_t netmask[ola::network::IPV4Address::LENGTH];
}__attribute__((packed));
typedef struct sandnet_program_s sandnet_program;
/*
* Turns the led on and off
*/
struct sandnet_led_s {
uint8_t mac[ola::network::MACAddress::LENGTH]; // mac address
uint8_t led; // 0x00 off, 0xff on
}__attribute__((packed));
typedef struct sandnet_led_s sandnet_led;
/*
* DMX data
*/
struct sandnet_compressed_dmx_s {
uint8_t group; // group
uint8_t universe; // universe
uint8_t port; // physical port number
uint8_t zero1[4]; // could be the offset
uint8_t two; // 0x02
uint16_t length; // length of data
uint8_t dmx[DMX_UNIVERSE_SIZE];
} __attribute__((packed));
typedef struct sandnet_compressed_dmx_s sandnet_compressed_dmx;
// A generic Sandnet packet containing the union of all possible packets
struct sandnet_packet {
uint16_t opcode;
union {
sandnet_advertisement advertisement;
sandnet_port_control port_control;
sandnet_dmx dmx;
sandnet_name name;
sandnet_identify id;
sandnet_program program;
sandnet_led led;
sandnet_compressed_dmx compressed_dmx;
} contents;
} __attribute__((packed));
} // namespace sandnet
} // namespace plugin
} // namespace ola
#endif // PLUGINS_SANDNET_SANDNETPACKETS_H_
|
