Open Lighting Architecture: plugins/ftdidmx/FtdiDmxDevice.h Source File

| Open Lighting Architecture 0.10.9

Loading...
Searching...
No Matches
FtdiDmxDevice.h
1/*
2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
6 *
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU Library General Public License for more details.
11 *
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
15 *
16 * FtdiDmxDevice.h
17 * The FTDI usb chipset DMX plugin for ola
18 * Copyright (C) 2011 Rui Barreiros
19 *
20 * Additional modifications to enable support for multiple outputs and
21 * additional device ids did change the original structure.
22 *
23 * by E.S. Rosenberg a.k.a. Keeper of the Keys 5774/2014
24 */
25
26#ifndef PLUGINS_FTDIDMX_FTDIDMXDEVICE_H_
27#define PLUGINS_FTDIDMX_FTDIDMXDEVICE_H_
28
29#include <string>
30#include <memory>
31#include "ola/DmxBuffer.h"
32#include "olad/Device.h"
33#include "olad/Preferences.h"
34#include "plugins/ftdidmx/FtdiWidget.h"
35
36namespace ola {
37namespace plugin {
38namespace ftdidmx {
39
40 class FtdiDmxDevice : public Device {
41 public:
42 FtdiDmxDevice(AbstractPlugin *owner,
43 const FtdiWidgetInfo &widget_info,
44 unsigned int frequency);
45 ~FtdiDmxDevice();
46
47 std::string DeviceId() const { return m_widget->Serial(); }
48 std::string Description() const { return m_widget_info.Description(); }
49 FtdiWidget* GetDevice() { return m_widget; }
50
51 // We can send the same universe to multiple ports, or patch port 2 before
52 // port 1
53 bool AllowMultiPortPatching() const { return true; }
54
55 protected:
56 bool StartHook();
57
58 private:
59 FtdiWidget *m_widget;
60 const FtdiWidgetInfo m_widget_info;
61 unsigned int m_frequency;
62};
63} // namespace ftdidmx
64} // namespace plugin
65} // namespace ola
66#endif // PLUGINS_FTDIDMX_FTDIDMXDEVICE_H_
DmxBuffer.h
A class used to hold a single universe of DMX data.
ola::AbstractPlugin
Definition Plugin.h:38
ola::plugin::ftdidmx::FtdiDmxDevice::DeviceId
std::string DeviceId() const
The device ID.
Definition FtdiDmxDevice.h:47
ola::plugin::ftdidmx::FtdiDmxDevice::StartHook
bool StartHook()
Called during Start().
Definition FtdiDmxDevice.cpp:56
ola::plugin::ftdidmx::FtdiWidgetInfo
This class holds information about an attached FTDI chip.
Definition FtdiWidget.h:63
ola::plugin::ftdidmx
Code for FTDI devices.
ola::plugin
Code for supported devices and protocols.
ola
The namespace containing all OLA symbols.
Definition Credentials.cpp:44