Open Lighting Architecture  0.10.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
SPIOutput.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  * SPIOutput.h
17  * An RDM-controllable SPI device. Takes up to one universe of DMX.
18  * Copyright (C) 2013 Simon Newton
19  */
20 
21 #ifndef PLUGINS_SPI_SPIOUTPUT_H_
22 #define PLUGINS_SPI_SPIOUTPUT_H_
23 
24 #include <memory>
25 #include <string>
26 #include "common/rdm/NetworkManager.h"
27 #include "ola/DmxBuffer.h"
28 #include "ola/rdm/RDMControllerInterface.h"
29 #include "ola/rdm/UID.h"
30 #include "ola/stl/STLUtils.h"
31 #include "ola/rdm/ResponderOps.h"
32 #include "ola/rdm/ResponderPersonality.h"
33 #include "ola/rdm/ResponderSensor.h"
34 
35 namespace ola {
36 namespace plugin {
37 namespace spi {
38 
39 class SPIOutput: public ola::rdm::DiscoverableRDMControllerInterface {
40  public:
41  struct Options {
42  std::string device_label;
43  uint8_t pixel_count;
44  uint8_t output_number;
45 
46  explicit Options(uint8_t output_number, const std::string &spi_device_name)
47  : device_label("SPI Device - " + spi_device_name),
48  pixel_count(25), // For the https://www.adafruit.com/products/738
49  output_number(output_number) {
50  }
51  };
52 
53  SPIOutput(const ola::rdm::UID &uid,
54  class SPIBackendInterface *backend,
55  const Options &options);
56  ~SPIOutput();
57 
58  std::string GetDeviceLabel() const;
59  bool SetDeviceLabel(const std::string &device_label);
60  uint8_t GetPersonality() const;
61  bool SetPersonality(uint16_t personality);
62  uint16_t GetStartAddress() const;
63  bool SetStartAddress(uint16_t start_address);
64  unsigned int PixelCount() const { return m_pixel_count; }
65 
66  std::string Description() const;
67  bool WriteDMX(const DmxBuffer &buffer);
68 
69  void RunFullDiscovery(ola::rdm::RDMDiscoveryCallback *callback);
70  void RunIncrementalDiscovery(ola::rdm::RDMDiscoveryCallback *callback);
71  void SendRDMRequest(ola::rdm::RDMRequest *request,
72  ola::rdm::RDMCallback *callback);
73 
74  private:
78  class RDMOps : public ola::rdm::ResponderOps<SPIOutput> {
79  public:
80  static RDMOps *Instance() {
81  if (!instance)
82  instance = new RDMOps();
83  return instance;
84  }
85 
86  private:
87  RDMOps() : ola::rdm::ResponderOps<SPIOutput>(PARAM_HANDLERS) {}
88 
89  static RDMOps *instance;
90  };
91 
92  class SPIBackendInterface *m_backend;
93  const uint8_t m_output_number;
94  std::string m_spi_device_name;
95  const ola::rdm::UID m_uid;
96  const unsigned int m_pixel_count;
97  std::string m_device_label;
98  uint16_t m_start_address; // starts from 1
99  bool m_identify_mode;
100  std::auto_ptr<ola::rdm::PersonalityCollection> m_personality_collection;
101  std::auto_ptr<ola::rdm::PersonalityManager> m_personality_manager;
102  ola::rdm::Sensors m_sensors;
103  std::auto_ptr<ola::rdm::NetworkManagerInterface> m_network_manager;
104 
105  // DMX methods
106  bool InternalWriteDMX(const DmxBuffer &buffer);
107 
108  void IndividualWS2801Control(const DmxBuffer &buffer);
109  void CombinedWS2801Control(const DmxBuffer &buffer);
110  void IndividualLPD8806Control(const DmxBuffer &buffer);
111  void CombinedLPD8806Control(const DmxBuffer &buffer);
112  void IndividualP9813Control(const DmxBuffer &buffer);
113  void CombinedP9813Control(const DmxBuffer &buffer);
114  void IndividualAPA102Control(const DmxBuffer &buffer);
115  void CombinedAPA102Control(const DmxBuffer &buffer);
116 
117  unsigned int LPD8806BufferSize() const;
118  void WriteSPIData(const uint8_t *data, unsigned int length);
119 
120  // RDM methods
121  ola::rdm::RDMResponse *GetDeviceInfo(
122  const ola::rdm::RDMRequest *request);
123  ola::rdm::RDMResponse *GetProductDetailList(
124  const ola::rdm::RDMRequest *request);
125  ola::rdm::RDMResponse *GetDeviceModelDescription(
126  const ola::rdm::RDMRequest *request);
127  ola::rdm::RDMResponse *GetManufacturerLabel(
128  const ola::rdm::RDMRequest *request);
129  ola::rdm::RDMResponse *GetDeviceLabel(
130  const ola::rdm::RDMRequest *request);
131  ola::rdm::RDMResponse *SetDeviceLabel(
132  const ola::rdm::RDMRequest *request);
133  ola::rdm::RDMResponse *GetSoftwareVersionLabel(
134  const ola::rdm::RDMRequest *request);
135  ola::rdm::RDMResponse *GetDmxPersonality(
136  const ola::rdm::RDMRequest *request);
137  ola::rdm::RDMResponse *SetDmxPersonality(
138  const ola::rdm::RDMRequest *request);
139  ola::rdm::RDMResponse *GetPersonalityDescription(
140  const ola::rdm::RDMRequest *request);
141  ola::rdm::RDMResponse *GetDmxStartAddress(
142  const ola::rdm::RDMRequest *request);
143  ola::rdm::RDMResponse *SetDmxStartAddress(
144  const ola::rdm::RDMRequest *request);
145  ola::rdm::RDMResponse *GetIdentify(
146  const ola::rdm::RDMRequest *request);
147  ola::rdm::RDMResponse *SetIdentify(
148  const ola::rdm::RDMRequest *request);
149  ola::rdm::RDMResponse *GetSensorDefinition(
150  const ola::rdm::RDMRequest *request);
151  ola::rdm::RDMResponse *GetSensorValue(
152  const ola::rdm::RDMRequest *request);
153  ola::rdm::RDMResponse *SetSensorValue(
154  const ola::rdm::RDMRequest *request);
155  ola::rdm::RDMResponse *RecordSensor(
156  const ola::rdm::RDMRequest *request);
157  ola::rdm::RDMResponse *GetListInterfaces(
158  const ola::rdm::RDMRequest *request);
159  ola::rdm::RDMResponse *GetInterfaceLabel(
160  const ola::rdm::RDMRequest *request);
161  ola::rdm::RDMResponse *GetInterfaceHardwareAddressType1(
162  const ola::rdm::RDMRequest *request);
163  ola::rdm::RDMResponse *GetIPV4CurrentAddress(
164  const ola::rdm::RDMRequest *request);
165  ola::rdm::RDMResponse *GetIPV4DefaultRoute(
166  const ola::rdm::RDMRequest *request);
167  ola::rdm::RDMResponse *GetDNSHostname(
168  const ola::rdm::RDMRequest *request);
169  ola::rdm::RDMResponse *GetDNSDomainName(
170  const ola::rdm::RDMRequest *request);
171  ola::rdm::RDMResponse *GetDNSNameServer(
172  const ola::rdm::RDMRequest *request);
173 
174  // Helpers
175  uint8_t P9813CreateFlag(uint8_t red, uint8_t green, uint8_t blue);
176  static uint8_t CalculateAPA102LatchBytes(uint16_t pixel_count);
177 
178  static const uint8_t SPI_MODE;
179  static const uint8_t SPI_BITS_PER_WORD;
180  static const uint16_t SPI_DELAY;
181  static const uint32_t SPI_SPEED;
182  static const uint16_t WS2801_SLOTS_PER_PIXEL;
183  static const uint16_t LPD8806_SLOTS_PER_PIXEL;
184  static const uint16_t P9813_SLOTS_PER_PIXEL;
185  static const uint16_t P9813_SPI_BYTES_PER_PIXEL;
186  static const uint16_t APA102_SLOTS_PER_PIXEL;
187  static const uint16_t APA102_SPI_BYTES_PER_PIXEL;
188  static const uint16_t APA102_START_FRAME_BYTES;
189 
190  static const ola::rdm::ResponderOps<SPIOutput>::ParamHandler
191  PARAM_HANDLERS[];
192 };
193 } // namespace spi
194 } // namespace plugin
195 } // namespace ola
196 #endif // PLUGINS_SPI_SPIOUTPUT_H_
RDMControllerInterface.h
Definitions and Interfaces to implement an RDMController that sends a single message at a time...
ola::rdm::RDMResponse
An RDM Command that represents responses (GET, SET or DISCOVER).
Definition: RDMCommand.h:456
ola::plugin::spi::SPIOutput::Options
Definition: SPIOutput.h:41
ola::plugin::spi::SPIOutput::RunIncrementalDiscovery
void RunIncrementalDiscovery(ola::rdm::RDMDiscoveryCallback *callback)
Start an incremental discovery operation.
Definition: SPIOutput.cpp:279
ola::rdm::DiscoverableRDMControllerInterface
The interface that can send RDM commands, as well as perform discovery operations.
Definition: RDMControllerInterface.h:104
ola::rdm::RDMRequest
RDM Commands that represent requests (GET, SET or DISCOVER).
Definition: RDMCommand.h:233
ola::DmxBuffer
Used to hold a single universe of DMX data.
Definition: DmxBuffer.h:49
UID.h
A RDM unique identifier (UID).
ResponderSensor.h
Holds the information about a sensor.
DmxBuffer.h
A class used to hold a single universe of DMX data.
ola::rdm::ResponderOps::ParamHandler
the structure that defines the behaviour for a specific PID.o
Definition: ResponderOps.h:76
ola::rdm::ResponderOps
A class which dispatches RDM requests to registered PID handlers.
Definition: ResponderOps.h:60
ola::plugin::spi::SPIOutput::RunFullDiscovery
void RunFullDiscovery(ola::rdm::RDMDiscoveryCallback *callback)
Start a full discovery operation.
Definition: SPIOutput.cpp:272
ola::plugin::spi::SPIOutput
Definition: SPIOutput.h:39
ola::BaseCallback1
The base class for all 1 argument callbacks.
Definition: Callback.h:982
STLUtils.h
Helper functions for STL classes.
ResponderOps.h
A framework for building RDM responders.
ola::rdm::UID
Represents a RDM UID.
Definition: UID.h:57
ola::plugin::spi::SPIBackendInterface
Definition: SPIBackend.h:40
ola
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
ola::plugin::spi::SPIOutput::SendRDMRequest
void SendRDMRequest(ola::rdm::RDMRequest *request, ola::rdm::RDMCallback *callback)
Send a RDM command.
Definition: SPIOutput.cpp:287
NetworkManager.h
Gets/sets real config about a network.
Generated on Sat Jun 10 2017 07:10:12 for Open Lighting Architecture by   doxygen 1.8.8