FtdiWidget.h

/*
 * 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.
 *
 * This class is based on QLCFTDI class from
 *
 * Q Light Controller
 * qlcftdi.h
 *
 * Copyright (C) Heikki Junnila
 *
 * Only standard CPP conversion was changed and function name changed
 * to follow OLA coding standards.
 *
 * by Rui Barreiros
 */

#ifndef PLUGINS_FTDIDMX_FTDIWIDGET_H_
#define PLUGINS_FTDIDMX_FTDIWIDGET_H_

#ifdef FTD2XX
# ifdef WIN32
# include <windows.h>
# endif
# include <ftd2xx.h>
#else
# include <ftdi.h>
#endif

#include <string>
#include <vector>

#include "ola/DmxBuffer.h"

namespace ola {
namespace plugin {
namespace ftdidmx {

using std::string;

class FtdiWidgetInfo {
 public:
 FtdiWidgetInfo(const string &name, const string &serial, int unsigned id)
 : m_name(name),
 m_serial(serial),
 m_id(id) {
 }

 FtdiWidgetInfo(const FtdiWidgetInfo &info)
 : m_name(info.Name()),
 m_serial(info.Serial()),
 m_id(info.Id()) {
 }

 virtual ~FtdiWidgetInfo() {}

 string Name() const { return m_name; }
 string Serial() const { return m_serial; }
 int unsigned Id() const { return m_id; }

 string Description() const {
 return m_name + " with serial number : " + m_serial + " ";
 }

 FtdiWidgetInfo& operator=(const FtdiWidgetInfo &other) {
 if (this != &other) {
 m_name = other.Name();
 m_serial = other.Serial();
 m_id = other.Id();
 }
 return *this;
 }

 private:
 string m_name;
 string m_serial;
 int unsigned m_id;
};


class FtdiWidget {
 public:
 static const int VID = 0x0403; // FTDI Vendor ID
 static const int PID = 0x6001; // FTDI Product ID

 FtdiWidget(const string &serial, const string &name, uint32_t id = 0);

 virtual ~FtdiWidget();

 string Serial() const { return m_serial; }

 string Name() const { return m_name; }

 uint32_t Id() const { return m_id; }

 string Description() const {
 return m_name + " with serial number : " + m_serial +" ";
 }

 bool Open();

 bool Close();

 bool IsOpen() const;

 bool Reset();

 bool SetLineProperties();

 bool SetBaudRate();

 bool SetFlowControl();

 bool ClearRts();

 bool PurgeBuffers();

 bool SetBreak(bool on);

 bool Write(const ola::DmxBuffer &data);

 bool Read(unsigned char* buff, int size);

 bool SetupOutput();

 static void Widgets(std::vector<FtdiWidgetInfo> *widgets);

 private:
 string m_serial;
 string m_name;
 uint32_t m_id;

#ifdef FTD2XX
 FT_HANDLE m_handle;
#else
 struct ftdi_context m_handle;
#endif
};
} // namespace ftdidmx
} // namespace plugin
} // namespace ola
#endif // PLUGINS_FTDIDMX_FTDIWIDGET_H_