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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 {

class FtdiWidgetInfo {
 public:
    FtdiWidgetInfo(const std::string &name,
                   const std::string &serial,
                   unsigned int 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() {}

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

    std::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:
    std::string m_name;
    std::string m_serial;
    unsigned int m_id;
};


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

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

    virtual ~FtdiWidget();

    std::string Serial() const { return m_serial; }

    std::string Name() const { return m_name; }

    uint32_t Id() const { return m_id; }

    std::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:
    std::string m_serial;
    std::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_