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
|
/*
* 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.
*
* PathportPlugin.cpp
* The Pathport plugin for ola
* Copyright (C) 2005 Simon Newton
*/
#include <limits.h>
#include <string>
#include "ola/Logging.h"
#include "ola/StringUtils.h"
#include "ola/math/Random.h"
#include "olad/PluginAdaptor.h"
#include "olad/Preferences.h"
#include "plugins/pathport/PathportDevice.h"
#include "plugins/pathport/PathportPlugin.h"
namespace ola {
namespace plugin {
namespace pathport {
using std::string;
const char PathportPlugin::PLUGIN_NAME[] = "Pathport";
const char PathportPlugin::PLUGIN_PREFIX[] = "pathport";
const unsigned int PathportPlugin::DEFAULT_DSCP_VALUE = 0;
/*
* Start the plugin
* For now we just have one device.
*/
bool PathportPlugin::StartHook() {
m_device = new PathportDevice(this,
m_preferences,
m_plugin_adaptor);
if (!m_device) {
return false;
}
if (!m_device->Start()) {
delete m_device;
return false;
}
m_plugin_adaptor->RegisterDevice(m_device);
return true;
}
/*
* Stop the plugin
* @return true on success, false on failure
*/
bool PathportPlugin::StopHook() {
if (m_device) {
m_plugin_adaptor->UnregisterDevice(m_device);
bool ret = m_device->Stop();
delete m_device;
return ret;
}
return true;
}
/*
* Return the description for this plugin
*/
string PathportPlugin::Description() const {
return
"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"
"--- 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\n"
"use 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.\n"
"\n";
}
/*
* Load the plugin prefs and default to sensible values
*/
bool PathportPlugin::SetDefaultPreferences() {
bool save = false;
if (!m_preferences) {
return false;
}
save |= m_preferences->SetDefaultValue(PathportDevice::K_DSCP_KEY,
UIntValidator(0, 63),
DEFAULT_DSCP_VALUE);
save |= m_preferences->SetDefaultValue(PathportDevice::K_NODE_IP_KEY,
StringValidator(true), "");
save |= m_preferences->SetDefaultValue(PathportDevice::K_NODE_NAME_KEY,
StringValidator(),
PathportDevice::K_DEFAULT_NODE_NAME);
// Generate a new node id in case we need it
uint32_t product_id = ((OLA_MANUFACTURER_CODE << 24) +
ola::math::Random(0, (1 << 24) - 1));
save |= m_preferences->SetDefaultValue(PathportDevice::K_NODE_ID_KEY,
UIntValidator(0, UINT_MAX),
product_id);
if (save) {
m_preferences->Save();
}
if (m_preferences->GetValue(PathportDevice::K_NODE_NAME_KEY).empty() ||
m_preferences->GetValue(PathportDevice::K_NODE_ID_KEY).empty()) {
return false;
}
return true;
}
} // namespace pathport
} // namespace plugin
} // namespace ola
|
