Adding ovdmx support for ola

common/protocol/Ola.proto

@@ -68,6 +68,7 @@ enum PluginIds {
   OLA_PLUGIN_GPIO = 22;
   OLA_PLUGIN_SPIDMX = 23;
   OLA_PLUGIN_NANOLEAF = 24;
+  OLA_PLUGIN_OVDMX = 10050;
 
   /*
    * To obtain a new plugin ID, open a ticket at

configure.ac

@@ -916,6 +916,7 @@ PLUGIN_SUPPORT(stageprofi, USE_STAGEPROFI)
 PLUGIN_SUPPORT(uartdmx, USE_UART, [$have_uart])
 PLUGIN_SUPPORT(usbdmx, USE_LIBUSB, [$have_libusb])
 PLUGIN_SUPPORT(usbpro, USE_USBPRO)
+PLUGIN_SUPPORT(ovdmx, USE_OVDMX)
 
 # Finally build a list of the required plugin libs.
 PLUGIN_LIBS=''

olad/DynamicPluginLoader.cpp

@@ -123,6 +123,10 @@
 #include "plugins/dmx4linux/Dmx4LinuxPlugin.h"
 #endif  // USE_DMX4LINUX
 
+#ifdef USE_OVDMX
+#include "plugins/ovdmx/OVDmxPlugin.h"
+#endif
+
 namespace ola {
 
 using std::vector;
@@ -253,7 +257,12 @@ void DynamicPluginLoader::PopulatePlugins() {
 #ifdef USE_UART
   m_plugins.push_back(
       new ola::plugin::uartdmx::UartDmxPlugin(m_plugin_adaptor));
-#endif  // USE_UART
+#endif
+
+#ifdef USE_OVDMX
+  m_plugins.push_back(
+      new ola::plugin::ovdmx::OVDmxPlugin(m_plugin_adaptor));
+#endif
 }
 
 void DynamicPluginLoader::UnloadPlugins() {

plugins/Makefile.mk

@@ -18,6 +18,7 @@ include plugins/spi/Makefile.mk
 include plugins/spidmx/Makefile.mk
 include plugins/stageprofi/Makefile.mk
 include plugins/usbdmx/Makefile.mk
+include plugins/ovdmx/Makefile.mk
 
 if !USING_WIN32
 include plugins/usbpro/Makefile.mk

plugins/ovdmx/Makefile.mk

@@ -0,0 +1,16 @@
+# LIBRARIES
+##################################################
+if USE_OVDMX
+lib_LTLIBRARIES += plugins/ovdmx/libolaovdmx.la
+plugins_ovdmx_libolaovdmx_la_SOURCES = \
+    plugins/ovdmx/OVDmxDevice.cpp \
+    plugins/ovdmx/OVDmxDevice.h \
+    plugins/ovdmx/OVDmxPlugin.cpp \
+    plugins/ovdmx/OVDmxPlugin.h \
+    plugins/ovdmx/OVDmxPort.h \
+    plugins/ovdmx/OVDmxThread.cpp \
+    plugins/ovdmx/OVDmxThread.h
+plugins_ovdmx_libolaovdmx_la_LIBADD = \
+    common/libolacommon.la \
+    olad/plugin_api/libolaserverplugininterface.la
+endif

plugins/ovdmx/OVDmxDevice.cpp

@@ -0,0 +1,46 @@
+#include <stdlib.h>
+#include <stdio.h>
+#include <string.h>
+#include <iostream>
+#include <string>
+
+#include "plugins/ovdmx/OVDmxDevice.h"
+#include "plugins/ovdmx/OVDmxPort.h"
+
+namespace ola {
+namespace plugin {
+namespace ovdmx {
+
+using ola::Device;
+using std::string;
+
+
+/*
+ * Create a new device
+ * @param owner
+ * @param name
+ * @param path to device
+ */
+OVDmxDevice::OVDmxDevice(AbstractPlugin *owner,
+                             const string &name,
+                             const string &path,
+                             unsigned int device_id)
+    : Device(owner, name),
+      m_path(path) {
+  std::ostringstream str;
+  str << device_id;
+  m_device_id = str.str();
+}
+
+
+
+/*
+ * Start this device
+ */
+bool OVDmxDevice::StartHook() {
+  AddPort(new OVDmxOutputPort(this, 0, m_path));
+  return true;
+}
+}  // namespace ovdmx
+}  // namespace plugin
+}  // namespace ola

plugins/ovdmx/OVDmxDevice.h

@@ -0,0 +1,31 @@
+#ifndef PLUGINS_OVDMX_OVDMXDEVICE_H_
+#define PLUGINS_OVDMX_OVDMXDEVICE_H_
+
+#include <string>
+#include "olad/Device.h"
+
+namespace ola {
+namespace plugin {
+namespace ovdmx {
+
+class OVDmxDevice: public ola::Device {
+ public:
+    OVDmxDevice(ola::AbstractPlugin *owner,
+                  const std::string &name,
+                  const std::string &path,
+                  unsigned int device_id);
+
+    // we only support one widget for now
+    std::string DeviceId() const { return m_device_id; }
+
+ protected:
+    bool StartHook();
+
+ private:
+    std::string m_path;
+    std::string m_device_id;
+};
+}  // namespace ovdmx
+}  // namespace plugin
+}  // namespace ola
+#endif  // PLUGINS_OVDMX_OVDMXDEVICE_H_

plugins/ovdmx/OVDmxPlugin.cpp

@@ -0,0 +1,115 @@
+#include <errno.h>
+#include <fcntl.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <string>
+#include <vector>
+
+#include "ola/Logging.h"
+#include "ola/io/IOUtils.h"
+#include "olad/PluginAdaptor.h"
+#include "olad/Preferences.h"
+#include "plugins/ovdmx/OVDmxDevice.h"
+#include "plugins/ovdmx/OVDmxPlugin.h"
+
+namespace ola {
+namespace plugin {
+namespace ovdmx {
+
+using ola::PluginAdaptor;
+using std::string;
+using std::vector;
+
+const char OVDmxPlugin::OVDMX_DEVICE_PATH[] = "/dev/ttyACM0";
+const char OVDmxPlugin::OVDMX_DEVICE_NAME[] = "OVDmx USB Device";
+const char OVDmxPlugin::PLUGIN_NAME[] = "Omega Verksted DMX";
+const char OVDmxPlugin::PLUGIN_PREFIX[] = "ovdmx";
+const char OVDmxPlugin::DEVICE_KEY[] = "device";
+
+
+/*
+ * Start the plugin
+ * TODO: scan /dev for devices?
+ */
+bool OVDmxPlugin::StartHook() {
+  vector<string> devices = m_preferences->GetMultipleValue(DEVICE_KEY);
+  vector<string>::const_iterator iter = devices.begin();
+
+  // start counting device ids from 0
+  unsigned int device_id = 0;
+
+  for (; iter != devices.end(); ++iter) {
+    // first check if it's there
+    int fd;
+    if (ola::io::Open(*iter, O_WRONLY, &fd)) {
+      close(fd);
+      OVDmxDevice *device = new OVDmxDevice(
+          this,
+          OVDMX_DEVICE_NAME,
+          *iter,
+          device_id++);
+      if (device->Start()) {
+        m_devices.push_back(device);
+        m_plugin_adaptor->RegisterDevice(device);
+      } else {
+        OLA_WARN << "Failed to start OVDmxDevice for " << *iter;
+        delete device;
+      }
+    } else {
+      OLA_WARN << "Could not open " << *iter << " " << strerror(errno);
+    }
+  }
+  return true;
+}
+
+
+/*
+ * Stop the plugin
+ * @return true on success, false on failure
+ */
+bool OVDmxPlugin::StopHook() {
+  bool ret = true;
+  DeviceList::iterator iter = m_devices.begin();
+  for (; iter != m_devices.end(); ++iter) {
+    m_plugin_adaptor->UnregisterDevice(*iter);
+    ret &= (*iter)->Stop();
+    delete *iter;
+  }
+  m_devices.clear();
+  return ret;
+}
+
+
+/*
+ * Return the description for this plugin
+ */
+string OVDmxPlugin::Description() const {
+    return "OVDMX is awesome";
+}
+
+
+/*
+ * Set default preferences.
+ */
+bool OVDmxPlugin::SetDefaultPreferences() {
+  if (!m_preferences) {
+    return false;
+  }
+
+  if (m_preferences->SetDefaultValue(DEVICE_KEY, StringValidator(),
+                                     OVDMX_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;
+}
+}  // namespace ovdmx
+}  // namespace plugin
+}  // namespace ola

plugins/ovdmx/OVDmxPlugin.h

@@ -0,0 +1,43 @@
+#ifndef PLUGINS_OVDMX_OVDMXPLUGIN_H_
+#define PLUGINS_OVDMX_OVDMXPLUGIN_H_
+
+#include <string>
+#include <vector>
+#include "olad/Plugin.h"
+#include "ola/plugin_id.h"
+
+namespace ola {
+namespace plugin {
+namespace ovdmx {
+
+class OVDmxDevice;
+
+class OVDmxPlugin: public Plugin {
+ public:
+    explicit OVDmxPlugin(PluginAdaptor *plugin_adaptor):
+      Plugin(plugin_adaptor) {
+    }
+
+    std::string Name() const { return PLUGIN_NAME; }
+    std::string Description() const;
+    ola_plugin_id Id() const { return OLA_PLUGIN_OVDMX; }
+    std::string PluginPrefix() const { return PLUGIN_PREFIX; }
+
+ private:
+    bool StartHook();
+    bool StopHook();
+    bool SetDefaultPreferences();
+
+    typedef std::vector<OVDmxDevice*> DeviceList;
+    DeviceList m_devices;
+    static const char PLUGIN_NAME[];
+    static const char PLUGIN_PREFIX[];
+    static const char OVDMX_DEVICE_PATH[];
+    static const char OVDMX_DEVICE_NAME[];
+    static const char DEVICE_KEY[];
+};
+}  // namespace ovdmx
+}  // namespace plugin
+}  // namespace ola
+
+#endif  // PLUGINS_OVDMX_OVDMXPLUGIN_H_

plugins/ovdmx/OVDmxPort.h

@@ -0,0 +1,62 @@
+/*
+ * 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.
+ *
+ * OVDmxPort.h
+ * The Open DMX plugin for ola
+ * Copyright (C) 2005 Simon Newton
+ */
+
+#ifndef PLUGINS_OVDMX_OVDMXPORT_H_
+#define PLUGINS_OVDMX_OVDMXPORT_H_
+
+#include <string>
+#include "ola/DmxBuffer.h"
+#include "olad/Port.h"
+#include "plugins/ovdmx/OVDmxDevice.h"
+#include "plugins/ovdmx/OVDmxThread.h"
+
+namespace ola {
+namespace plugin {
+namespace ovdmx {
+
+class OVDmxOutputPort: public BasicOutputPort {
+ public:
+  OVDmxOutputPort(OVDmxDevice *parent,
+                    unsigned int id,
+                    const std::string &path)
+        : BasicOutputPort(parent, id),
+        m_thread(path),
+        m_path(path) {
+        m_thread.Start();
+}
+
+  ~OVDmxOutputPort() {
+  }
+
+  std::string Description() const { return "OVDMX at " + m_path; }
+
+  bool WriteDMX(OLA_UNUSED const DmxBuffer &buffer, OLA_UNUSED uint8_t priority) {
+    return m_thread.WriteDmx(buffer);
+  }
+
+ private:
+  OVDmxThread m_thread;
+  std::string m_path;
+
+};
+}  // namespace ovdmx
+}  // namespace plugin
+}  // namespace ola
+#endif  // PLUGINS_OVDMX_OVDMXPORT_H_