162 lines
4.8 KiB
C++
162 lines
4.8 KiB
C++
/*
|
|
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*
|
|
* ArtNetPlugin.cpp
|
|
* The ArtNet plugin for ola
|
|
* Copyright (C) 2005-2009 Simon Newton
|
|
*/
|
|
|
|
#include <stdlib.h>
|
|
#include <stdio.h>
|
|
#include <string>
|
|
|
|
#include "ola/Logging.h"
|
|
#include "olad/PluginAdaptor.h"
|
|
#include "olad/Preferences.h"
|
|
#include "plugins/artnet/ArtNetPlugin.h"
|
|
#include "plugins/artnet/ArtNetDevice.h"
|
|
|
|
|
|
/*
|
|
* Entry point to this plugin
|
|
*/
|
|
extern "C" ola::AbstractPlugin* create(const ola::PluginAdaptor *adaptor) {
|
|
return new ola::plugin::artnet::ArtNetPlugin(adaptor);
|
|
}
|
|
|
|
namespace ola {
|
|
namespace plugin {
|
|
namespace artnet {
|
|
|
|
const char ArtNetPlugin::ARTNET_LONG_NAME[] = "OLA - ArtNet node";
|
|
const char ArtNetPlugin::ARTNET_SHORT_NAME[] = "OLA - ArtNet node";
|
|
const char ArtNetPlugin::ARTNET_SUBNET[] = "0";
|
|
const char ArtNetPlugin::PLUGIN_NAME[] = "ArtNet";
|
|
const char ArtNetPlugin::PLUGIN_PREFIX[] = "artnet";
|
|
|
|
/*
|
|
* Start the plugin, for now we just have one device.
|
|
* TODO: allow multiple devices on different IPs ?
|
|
* @returns true if we started ok, false otherwise
|
|
*/
|
|
bool ArtNetPlugin::StartHook() {
|
|
m_device = new ArtNetDevice(this,
|
|
m_preferences,
|
|
m_plugin_adaptor);
|
|
|
|
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 ArtNetPlugin::StopHook() {
|
|
if (m_device) {
|
|
// stop the 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.
|
|
* @return a string description of the plugin
|
|
*/
|
|
string ArtNetPlugin::Description() const {
|
|
return
|
|
"ArtNet Plugin\n"
|
|
"----------------------------\n"
|
|
"\n"
|
|
"This plugin creates a single device with four input and four output ports.\n"
|
|
"\n"
|
|
"ArtNet limits a single device (identified by a unique IP) to four input and\n"
|
|
"four output ports, each bound to a separate ArtNet universe address. The \n"
|
|
"universe address is built from the subnet address as the upper for bits, \n"
|
|
"and the OLA universe number as the lower four bits.\n\n"
|
|
" ArtNet Subnet | Bound Universe | ArtNet Universe\n"
|
|
" 0 | 0 | 0\n"
|
|
" 0 | 1 | 1\n"
|
|
" 0 | 15 | 15\n"
|
|
" 0 | 16 | 0\n"
|
|
" 0 | 17 | 1\n"
|
|
" 1 | 0 | 16\n"
|
|
" 1 | 1 | 17\n"
|
|
" 15 | 0 | 240\n"
|
|
" 15 | 15 | 255\n\n"
|
|
"--- Config file : ola-artnet.conf ---\n"
|
|
"\n"
|
|
"ip = a.b.c.d\n"
|
|
"The ip address to bind to. If not specified it will use the first\n"
|
|
"non-loopback ip.\n"
|
|
"\n"
|
|
"long_name = ola - ArtNet node\n"
|
|
"The long name of the node.\n"
|
|
"\n"
|
|
"short_name = ola - ArtNet node\n"
|
|
"The short name of the node (first 17 chars will be used)\n"
|
|
"\n"
|
|
"subnet = 0\n"
|
|
"The ArtNet subnet to use (0-15).\n";
|
|
}
|
|
|
|
|
|
/*
|
|
* Set default preferences.
|
|
*/
|
|
bool ArtNetPlugin::SetDefaultPreferences() {
|
|
bool save = false;
|
|
|
|
if (!m_preferences)
|
|
return false;
|
|
|
|
save |= m_preferences->SetDefaultValue(ArtNetDevice::K_IP_KEY,
|
|
IPv4Validator(), "");
|
|
save |= m_preferences->SetDefaultValue(ArtNetDevice::K_SHORT_NAME_KEY,
|
|
StringValidator(),
|
|
ARTNET_SHORT_NAME);
|
|
save |= m_preferences->SetDefaultValue(ArtNetDevice::K_LONG_NAME_KEY,
|
|
StringValidator(),
|
|
ARTNET_LONG_NAME);
|
|
save |= m_preferences->SetDefaultValue(ArtNetDevice::K_SUBNET_KEY,
|
|
IntValidator(0, 15),
|
|
ARTNET_SUBNET);
|
|
|
|
if (save)
|
|
m_preferences->Save();
|
|
|
|
// check if this save correctly
|
|
// we don't want to use it if null
|
|
if (m_preferences->GetValue(ArtNetDevice::K_SHORT_NAME_KEY).empty() ||
|
|
m_preferences->GetValue(ArtNetDevice::K_LONG_NAME_KEY).empty() ||
|
|
m_preferences->GetValue(ArtNetDevice::K_SUBNET_KEY).empty())
|
|
return false;
|
|
|
|
return true;
|
|
}
|
|
} // artnet
|
|
} // plugin
|
|
} // ola
|