2020-07-12 20:27:56 +02:00
|
|
|
#ifndef LEDEVICEUDPE131_H
|
|
|
|
#define LEDEVICEUDPE131_H
|
2016-08-19 17:14:52 +02:00
|
|
|
|
|
|
|
// hyperion includes
|
2016-08-28 07:12:48 +02:00
|
|
|
#include "ProviderUdp.h"
|
2016-08-19 17:14:52 +02:00
|
|
|
|
2016-08-28 10:45:18 +02:00
|
|
|
#include <QUuid>
|
|
|
|
|
2016-09-23 08:49:22 +02:00
|
|
|
/**
|
|
|
|
*
|
|
|
|
* https://raw.githubusercontent.com/forkineye/ESPixelStick/master/_E131.h
|
|
|
|
* Project: E131 - E.131 (sACN) library for Arduino
|
|
|
|
* Copyright (c) 2015 Shelby Merrick
|
|
|
|
* http://www.forkineye.com
|
|
|
|
*
|
|
|
|
* 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.
|
|
|
|
*
|
|
|
|
**/
|
2016-08-19 17:14:52 +02:00
|
|
|
|
|
|
|
/* E1.31 Packet Offsets */
|
2020-07-12 20:27:56 +02:00
|
|
|
//#define E131_ROOT_PREAMBLE_SIZE 0
|
|
|
|
//#define E131_ROOT_POSTAMBLE_SIZE 2
|
|
|
|
//#define E131_ROOT_ID 4
|
|
|
|
//#define E131_ROOT_FLENGTH 16
|
|
|
|
//#define E131_ROOT_VECTOR 18
|
|
|
|
//#define E131_ROOT_CID 22
|
|
|
|
|
|
|
|
//#define E131_FRAME_FLENGTH 38
|
|
|
|
//#define E131_FRAME_VECTOR 40
|
|
|
|
//#define E131_FRAME_SOURCE 44
|
|
|
|
//#define E131_FRAME_PRIORITY 108
|
|
|
|
//#define E131_FRAME_RESERVED 109
|
|
|
|
//#define E131_FRAME_SEQ 111
|
|
|
|
//#define E131_FRAME_OPT 112
|
|
|
|
//#define E131_FRAME_UNIVERSE 113
|
|
|
|
|
|
|
|
//#define E131_DMP_FLENGTH 115
|
|
|
|
//#define E131_DMP_VECTOR 117
|
|
|
|
//#define E131_DMP_TYPE 118
|
|
|
|
//#define E131_DMP_ADDR_FIRST 119
|
|
|
|
//#define E131_DMP_ADDR_INC 121
|
|
|
|
//#define E131_DMP_COUNT 123
|
|
|
|
const unsigned int E131_DMP_DATA=125;
|
2016-08-19 17:14:52 +02:00
|
|
|
|
|
|
|
/* E1.31 Packet Structure */
|
2016-09-23 08:49:22 +02:00
|
|
|
typedef union
|
|
|
|
{
|
2020-05-12 19:51:19 +02:00
|
|
|
#pragma pack(push, 1)
|
2016-09-23 08:49:22 +02:00
|
|
|
struct
|
|
|
|
{
|
|
|
|
/* Root Layer */
|
|
|
|
uint16_t preamble_size;
|
|
|
|
uint16_t postamble_size;
|
|
|
|
uint8_t acn_id[12];
|
|
|
|
uint16_t root_flength;
|
|
|
|
uint32_t root_vector;
|
|
|
|
char cid[16];
|
|
|
|
|
|
|
|
/* Frame Layer */
|
|
|
|
uint16_t frame_flength;
|
|
|
|
uint32_t frame_vector;
|
|
|
|
char source_name[64];
|
|
|
|
uint8_t priority;
|
|
|
|
uint16_t reserved;
|
|
|
|
uint8_t sequence_number;
|
|
|
|
uint8_t options;
|
|
|
|
uint16_t universe;
|
|
|
|
|
|
|
|
/* DMP Layer */
|
|
|
|
uint16_t dmp_flength;
|
|
|
|
uint8_t dmp_vector;
|
|
|
|
uint8_t type;
|
|
|
|
uint16_t first_address;
|
|
|
|
uint16_t address_increment;
|
|
|
|
uint16_t property_value_count;
|
|
|
|
uint8_t property_values[513];
|
2020-05-12 19:51:19 +02:00
|
|
|
};
|
|
|
|
#pragma pack(pop)
|
2016-09-23 08:49:22 +02:00
|
|
|
|
|
|
|
uint8_t raw[638];
|
2016-08-19 17:14:52 +02:00
|
|
|
} e131_packet_t;
|
|
|
|
|
|
|
|
///
|
|
|
|
/// Implementation of the LedDevice interface for sending led colors via udp/E1.31 packets
|
|
|
|
///
|
2016-08-28 07:12:48 +02:00
|
|
|
class LedDeviceUdpE131 : public ProviderUdp
|
2016-08-19 17:14:52 +02:00
|
|
|
{
|
|
|
|
public:
|
2020-07-12 20:27:56 +02:00
|
|
|
|
2016-08-19 17:14:52 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Constructs an E1.31 LED-device fed via UDP
|
2016-08-19 17:14:52 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param deviceConfig Device's configuration as JSON-Object
|
2016-08-19 17:14:52 +02:00
|
|
|
///
|
2020-02-10 15:21:58 +01:00
|
|
|
explicit LedDeviceUdpE131(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);
|
2016-08-19 17:14:52 +02:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
private:
|
|
|
|
|
|
|
|
///
|
|
|
|
/// @brief Initialise the device's configuration
|
2016-08-23 20:07:12 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] deviceConfig the JSON device configuration
|
|
|
|
/// @return True, if success
|
2016-08-23 20:07:12 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
virtual bool init(const QJsonObject &deviceConfig) override;
|
2016-08-19 17:14:52 +02:00
|
|
|
|
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @brief Writes the RGB-Color values to the LEDs.
|
2016-08-19 17:14:52 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
/// @param[in] ledValues The RGB-color per LED
|
|
|
|
/// @return Zero on success, else negative
|
2016-08-19 17:14:52 +02:00
|
|
|
///
|
2020-07-12 20:27:56 +02:00
|
|
|
virtual int write(const std::vector<ColorRgb> & ledValues) override;
|
2016-08-19 17:14:52 +02:00
|
|
|
|
2020-07-12 20:27:56 +02:00
|
|
|
///
|
|
|
|
/// @brief Generate E1.31 communication header
|
|
|
|
///
|
2020-08-08 13:09:15 +02:00
|
|
|
void prepare(unsigned this_universe, unsigned this_dmxChannelCount);
|
2016-08-20 22:39:21 +02:00
|
|
|
|
2016-08-19 17:14:52 +02:00
|
|
|
e131_packet_t e131_packet;
|
2016-09-22 09:19:31 +02:00
|
|
|
uint8_t _e131_seq = 0;
|
|
|
|
uint8_t _e131_universe = 1;
|
|
|
|
uint8_t _acn_id[12] = {0x41, 0x53, 0x43, 0x2d, 0x45, 0x31, 0x2e, 0x31, 0x37, 0x00, 0x00, 0x00 };
|
2017-03-04 22:17:42 +01:00
|
|
|
QString _e131_source_name;
|
2016-08-28 10:45:18 +02:00
|
|
|
QUuid _e131_cid;
|
2016-08-19 17:14:52 +02:00
|
|
|
};
|
2020-07-12 20:27:56 +02:00
|
|
|
|
|
|
|
#endif // LEDEVICEUDPE131_H
|