syndilights/open-lighting-architecture/ola-0.8.4/plugins/opendmx/OpenDmxPlugin.cpp

138 lines
3.5 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.
*
* OpenDmxPlugin.cpp
* The Open DMX plugin for ola
* Copyright (C) 2005-2008 Simon Newton
*/
#include <errno.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <string>
#include "ola/Logging.h"
#include "olad/PluginAdaptor.h"
#include "olad/Preferences.h"
#include "plugins/opendmx/OpenDmxDevice.h"
#include "plugins/opendmx/OpenDmxPlugin.h"
namespace ola {
namespace plugin {
namespace opendmx {
using ola::PluginAdaptor;
const char OpenDmxPlugin::OPENDMX_DEVICE_PATH[] = "/dev/dmx0";
const char OpenDmxPlugin::OPENDMX_DEVICE_NAME[] = "OpenDmx USB Device";
const char OpenDmxPlugin::PLUGIN_NAME[] = "Enttec Open DMX";
const char OpenDmxPlugin::PLUGIN_PREFIX[] = "opendmx";
const char OpenDmxPlugin::DEVICE_KEY[] = "device";
/*
* Entry point to this plugin
*/
extern "C" ola::AbstractPlugin* create(const PluginAdaptor *plugin_adaptor) {
return new OpenDmxPlugin(plugin_adaptor);
}
/*
* Start the plugin
* For now we just have one device.
* TODO: scan /dev for devices?
* Need to get multi-device support working first :)
* Remember to fix DeviceId() when multiple devices are supported
*/
bool OpenDmxPlugin::StartHook() {
int fd;
/* create new ola device */
// first check if it's there
string device_path = m_preferences->GetValue(DEVICE_KEY);
fd = open(device_path.data(), O_WRONLY);
if (fd >= 0) {
close(fd);
m_device = new OpenDmxDevice(this, OPENDMX_DEVICE_NAME,
device_path);
m_device->Start();
m_plugin_adaptor->RegisterDevice(m_device);
} else {
OLA_WARN << "Could not open " << device_path << " " << strerror(errno);
}
return true;
}
/*
* Stop the plugin
* @return true on success, false on failure
*/
bool OpenDmxPlugin::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 OpenDmxPlugin::Description() const {
return
"Enttec Open DMX Plugin\n"
"----------------------------\n"
"\n"
"The plugin creates a single device with one output port using the Enttec\n"
"Open DMX USB widget.\n\n"
"--- Config file : ola-opendmx.conf ---\n"
"\n"
"device = /dev/dmx0\n"
"The path to the open dmx usb device.\n";
}
/*
* Set default preferences.
*/
bool OpenDmxPlugin::SetDefaultPreferences() {
if (!m_preferences)
return false;
if (m_preferences->SetDefaultValue(DEVICE_KEY, StringValidator(),
OPENDMX_DEVICE_PATH))
m_preferences->Save();
// check if this save correctly
// we don't want to use it if null
if (m_preferences->GetValue(DEVICE_KEY).empty())
return false;
return true;
}
} // opendmx
} // plugins
} // ola