Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ArtNetPort.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  * ArtNetPort.h
17  * The Art-Net plugin for ola
18  * Copyright (C) 2005 Simon Newton
19  */
20 
21 #ifndef PLUGINS_ARTNET_ARTNETPORT_H_
22 #define PLUGINS_ARTNET_ARTNETPORT_H_
23 
24 #include <string>
26 #include "olad/Port.h"
27 #include "plugins/artnet/ArtNetDevice.h"
28 #include "plugins/artnet/ArtNetNode.h"
29 
30 namespace ola {
31 namespace plugin {
32 namespace artnet {
33 
35  public:
37  unsigned int port_id,
38  class PluginAdaptor *plugin_adaptor,
39  ArtNetNode *node)
40  : BasicInputPort(parent, port_id, plugin_adaptor, true),
41  m_node(node) {}
42 
43  const DmxBuffer &ReadDMX() const { return m_buffer; }
44 
48  void PostSetUniverse(Universe *old_universe, Universe *new_universe);
49 
50  /*
51  * Respond With Tod
52  */
53  void RespondWithTod();
54 
55  std::string Description() const;
56 
57  private:
58  DmxBuffer m_buffer;
59  ArtNetNode *m_node;
60 
64  void SendTODWithUIDs(const ola::rdm::UIDSet &uids);
65 
69  void TriggerDiscovery();
70 };
71 
73  public:
75  unsigned int port_id,
76  ArtNetNode *node)
77  : BasicOutputPort(device, port_id, true, true),
78  m_node(node) {}
79 
80  bool WriteDMX(const DmxBuffer &buffer, uint8_t priority);
81 
82  /*
83  * Handle an RDMRequest
84  */
86  ola::rdm::RDMCallback *on_complete);
87 
88  /*
89  * Run the full RDM discovery process
90  */
92 
93  /*
94  * Run the incremental RDM discovery process
95  */
97 
98  /*
99  * Set the RDM handlers as appropriate
100  */
101  void PostSetUniverse(Universe *old_universe, Universe *new_universe);
102 
103  std::string Description() const;
104 
105  // only the first output port supports timecode, otherwise we send it
106  // multiple times.
107  bool SupportsTimeCode() const {
108  return PortId() == 0;
109  }
110 
111  bool SendTimeCode(const ola::timecode::TimeCode &timecode) {
112  return m_node->SendTimeCode(timecode);
113  }
114 
115  private:
116  ArtNetNode *m_node;
117 };
118 } // namespace artnet
119 } // namespace plugin
120 } // namespace ola
121 #endif // PLUGINS_ARTNET_ARTNETPORT_H_
bool SendTimeCode(const ola::timecode::TimeCode &timecode)
This is a noop for ports that don't support TimeCode.
Definition: ArtNetPort.h:111
Represents a set of RDM UIDs.
Definition: UIDSet.h:48
Definitions and Interfaces to implement an RDMController that sends a single message at a time...
Definition: Universe.h:46
void SendRDMRequest(ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *on_complete)
Handle an RDMRequest, subclasses can implement this to support RDM.
Definition: ArtNetPort.cpp:121
BasicInputPort(AbstractDevice *parent, unsigned int port_id, const PluginAdaptor *plugin_adaptor, bool supports_rdm=false)
Create a new basic input port.
Definition: Port.cpp:38
Definition: Port.h:199
RDM Commands that represent requests (GET, SET or DISCOVER).
Definition: RDMCommand.h:234
Definition: ArtNetDevice.h:47
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)
This is a noop for ports that don't support RDM.
Definition: ArtNetPort.cpp:139
Definition: TimeCode.h:33
std::string Description() const
Fetch the string description for a Port.
Definition: ArtNetPort.cpp:167
void RunFullDiscovery(ola::rdm::RDMDiscoveryCallback *callback)
This is a noop for ports that don't support RDM.
Definition: ArtNetPort.cpp:134
Definition: PluginAdaptor.h:41
The actual Art-Net Node.
Definition: ArtNetNode.h:697
void PostSetUniverse(Universe *old_universe, Universe *new_universe)
Definition: ArtNetPort.cpp:42
bool WriteDMX(const DmxBuffer &buffer, uint8_t priority)
Write DMX data to this port.
Definition: ArtNetPort.cpp:111
The base class for all 1 argument callbacks.
Definition: Callback.h:982
Definition: ArtNetPort.h:34
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
unsigned int PortId() const
Get the Port ID. This is the index within the device.
Definition: Port.h:292
Definition: Port.h:282
Definition: ArtNetPort.h:72
std::string Description() const
Fetch the string description for a Port.
Definition: ArtNetPort.cpp:89