Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
DmxterDevice.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  * DmxterDevice.h
17  * The Goddard Design Dmxter RDM and miniDmxter
18  * Copyright (C) 2010 Simon Newton
19  */
20 
21 #ifndef PLUGINS_USBPRO_DMXTERDEVICE_H_
22 #define PLUGINS_USBPRO_DMXTERDEVICE_H_
23 
24 #include <string>
25 #include "ola/DmxBuffer.h"
26 #include "plugins/usbpro/DmxterWidget.h"
27 #include "plugins/usbpro/UsbSerialDevice.h"
28 
29 namespace ola {
30 namespace plugin {
31 namespace usbpro {
32 
33 /*
34  * An DMXter Device
35  */
37  public:
39  const std::string &name,
40  DmxterWidget *widget,
41  uint16_t esta_id,
42  uint16_t device_id,
43  uint32_t serial);
44  std::string DeviceId() const { return m_device_id; }
45 
46  private:
47  std::string m_device_id;
48 };
49 
50 
51 /*
52  * A single Output port per device
53  */
55  public:
57  : BasicOutputPort(parent, 0, true, true),
58  m_widget(widget) {}
59 
60  bool WriteDMX(OLA_UNUSED const DmxBuffer &buffer,
61  OLA_UNUSED uint8_t priority) {
62  // this device can't output DMX
63  return true;
64  }
65 
67  ola::rdm::RDMCallback *callback) {
68  m_widget->SendRDMRequest(request, callback);
69  }
70 
72  m_widget->RunFullDiscovery(on_complete);
73  }
74 
76  m_widget->RunIncrementalDiscovery(on_complete);
77  }
78 
79  std::string Description() const { return "RDM Only"; }
80 
81  private:
82  DmxterWidget *m_widget;
83 };
84 } // namespace usbpro
85 } // namespace plugin
86 } // namespace ola
87 #endif // PLUGINS_USBPRO_DMXTERDEVICE_H_
void RunFullDiscovery(ola::rdm::RDMDiscoveryCallback *callback)
Start a full discovery operation.
Definition: DmxterWidget.h:146
void RunFullDiscovery(ola::rdm::RDMDiscoveryCallback *on_complete)
This is a noop for ports that don't support RDM.
Definition: DmxterDevice.h:71
void RunIncrementalDiscovery(ola::rdm::RDMDiscoveryCallback *on_complete)
This is a noop for ports that don't support RDM.
Definition: DmxterDevice.h:75
void SendRDMRequest(ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
Handle an RDMRequest, subclasses can implement this to support RDM.
Definition: DmxterDevice.h:66
RDM Commands that represent requests (GET, SET or DISCOVER).
Definition: RDMCommand.h:234
Used to hold a single universe of DMX data.
Definition: DmxBuffer.h:49
BasicOutputPort(AbstractDevice *parent, unsigned int port_id, bool start_rdm_discovery_on_patch=false, bool supports_rdm=false)
Create a new BasicOutputPort.
Definition: Port.cpp:120
void RunIncrementalDiscovery(ola::rdm::RDMDiscoveryCallback *callback)
Start an incremental discovery operation.
Definition: DmxterWidget.h:150
A class used to hold a single universe of DMX data.
bool WriteDMX(const DmxBuffer &buffer, uint8_t priority)
Write DMX data to this port.
Definition: DmxterDevice.h:60
Definition: DmxterDevice.h:36
void SendRDMRequest(ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *on_complete)
Send a RDM command.
Definition: DmxterWidget.h:141
#define OLA_UNUSED
Mark unused arguments & types.
Definition: Macro.h:62
std::string DeviceId() const
The device ID.
Definition: DmxterDevice.h:44
Definition: DmxterWidget.h:130
Definition: UsbSerialDevice.h:36
The base class for all 1 argument callbacks.
Definition: Callback.h:982
std::string Description() const
Fetch the string description for a Port.
Definition: DmxterDevice.h:79
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
Definition: Port.h:282
Definition: Plugin.h:38
Definition: DmxterDevice.h:54