2020-07-12 20:27:56 +02:00
|
|
|
#ifndef LEDEVICEUDPARTNET_H
|
|
|
|
#define LEDEVICEUDPARTNET_H
|
2017-05-26 22:17:12 +02:00
|
|
|
|
|
|
|
// hyperion includes
|
|
|
|
#include "ProviderUdp.h"
|
|
|
|
|
|
|
|
#include <QUuid>
|
|
|
|
|
|
|
|
/**
|
|
|
|
*
|
|
|
|
* This program is provided free for you to use in any way that you wish,
|
|
|
|
* subject to the laws and regulations where you are using it. Due diligence
|
|
|
|
* is strongly suggested before using this code. Please give credit where due.
|
|
|
|
*
|
|
|
|
**/
|
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
const int DMX_MAX = 512; // 512 usable slots
|
2017-05-26 22:17:12 +02:00
|
|
|
|
|
|
|
// http://stackoverflow.com/questions/16396013/artnet-packet-structure
|
|
|
|
typedef union
|
|
|
|
{
|
2020-05-12 19:51:19 +02:00
|
|
|
#pragma pack(push, 1)
|
2017-05-26 22:17:12 +02:00
|
|
|
struct {
|
|
|
|
char ID[8]; // "Art-Net"
|
2020-07-12 20:27:56 +02:00
|
|
|
uint16_t OpCode; // See Doc. Table 1 - OpCodes e.g. 0x5000 OpOutput / OpDmx
|
2017-05-26 22:17:12 +02:00
|
|
|
uint16_t ProtVer; // 0x0e00 (aka 14)
|
|
|
|
uint8_t Sequence; // monotonic counter
|
|
|
|
uint8_t Physical; // 0x00
|
|
|
|
uint8_t SubUni; // low universe (0-255)
|
|
|
|
uint8_t Net; // high universe (not used)
|
|
|
|
uint16_t Length; // data length (2 - 512)
|
|
|
|
uint8_t Data[ DMX_MAX ]; // universe data
|
2020-05-12 19:51:19 +02:00
|
|
|
};
|
|
|
|
#pragma pack(pop)
|
2017-05-26 22:17:12 +02:00
|
|
|
|
|
|
|
uint8_t raw[ 18 + DMX_MAX ];
|
|
|
|
|
|
|
|
} artnet_packet_t;
|
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// Implementation of the LedDevice interface for sending LED colors to an Art-Net LED-device via UDP
|
2017-05-26 22:17:12 +02:00
|
|
|
///
|
|
|
|
class LedDeviceUdpArtNet : public ProviderUdp
|
|
|
|
{
|
|
|
|
public:
|
2020-07-12 20:27:56 +02:00
|
|
|
|
2017-05-26 22:17:12 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Constructs an Art-Net LED-device fed via UDP
|
2017-05-26 22:17:12 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param deviceConfig Device's configuration as JSON-Object
|
2017-05-26 22:17:12 +02:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
explicit LedDeviceUdpArtNet(const QJsonObject &deviceConfig);
|
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
///
|
|
|
|
/// @brief Constructs the LED-device
|
|
|
|
///
|
|
|
|
/// @param[in] deviceConfig Device's configuration as JSON-Object
|
|
|
|
/// @return LedDevice constructed
|
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
static LedDevice* construct(const QJsonObject &deviceConfig);
|
2017-05-26 22:17:12 +02:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
private:
|
|
|
|
|
2017-05-26 22:17:12 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Initialise the device's configuration
|
2017-05-26 22:17:12 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] deviceConfig the JSON device configuration
|
|
|
|
/// @return True, if success
|
|
|
|
///
|
2020-08-08 23:12:43 +02:00
|
|
|
bool init(const QJsonObject &deviceConfig) override;
|
2017-05-26 22:17:12 +02:00
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Writes the RGB-Color values to the LEDs.
|
2017-05-26 22:17:12 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] ledValues The RGB-color per LED
|
|
|
|
/// @return Zero on success, else negative
|
2017-05-26 22:17:12 +02:00
|
|
|
///
|
2020-08-08 23:12:43 +02:00
|
|
|
int write(const std::vector<ColorRgb> & ledValues) override;
|
2017-05-26 22:17:12 +02:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
///
|
|
|
|
/// @brief Generate Art-Net communication header
|
|
|
|
///
|
2020-08-08 13:09:15 +02:00
|
|
|
void prepare(unsigned this_universe, unsigned this_sequence, unsigned this_dmxChannelCount);
|
2017-05-26 22:17:12 +02:00
|
|
|
|
|
|
|
artnet_packet_t artnet_packet;
|
|
|
|
uint8_t _artnet_seq = 1;
|
2020-02-10 15:21:58 +01:00
|
|
|
int _artnet_channelsPerFixture = 3;
|
|
|
|
int _artnet_universe = 1;
|
2017-05-26 22:17:12 +02:00
|
|
|
};
|
2020-07-12 20:27:56 +02:00
|
|
|
|
|
|
|
#endif // LEDEVICEUDPARTNET_H
|