143 lines
5.0 KiB
C++
143 lines
5.0 KiB
C++
/*
|
|
widget.h
|
|
|
|
Copyright (c) 2023 Kevin Matz (kevin.matz@gmail.com)
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
*/
|
|
#pragma once
|
|
|
|
#include "pro.h"
|
|
|
|
#include <cstring>
|
|
#include <future>
|
|
#include <mutex>
|
|
#include <universe.h>
|
|
#include <vector>
|
|
|
|
namespace ENTTEC {
|
|
|
|
/**
|
|
* @brief The Widget class
|
|
*
|
|
* Operates on either the USB Host side (computer) or USB Device side (DMX USB Pro impersonator).
|
|
*/
|
|
class Widget
|
|
: public DMX::Universe
|
|
{
|
|
public:
|
|
explicit Widget();
|
|
virtual ~Widget();
|
|
|
|
virtual void init(); //!< USB Device start
|
|
virtual void halt(); //!< USB Device stop
|
|
virtual void open(); //!< USB Host start
|
|
virtual void close(); //!< USB Host stop
|
|
/**
|
|
* @brief isConnected
|
|
* @return
|
|
*/
|
|
bool isConnected() const { return usb_mode != USBunknown; }
|
|
|
|
virtual void setModeController();
|
|
virtual void setModeBridge(Pro::DMX_RX_MODE = Pro::RxNotifyAlways);
|
|
|
|
uint32_t serialNumber() const;
|
|
uint16_t firmwareVersion() const;
|
|
|
|
double txBreakTime() const;
|
|
void setTxBreakTime(double);
|
|
void setTxBreakIntervals(uint8_t);
|
|
|
|
double txMabTime() const;
|
|
void setTxMabTime(double);
|
|
void setTxMabIntervals(uint8_t);
|
|
|
|
uint8_t txRate() const;
|
|
void setTxRate(uint8_t);
|
|
|
|
bool writeFirmware(const uint8_t *, const size_t);
|
|
|
|
/// @brief The OperatingMode enum
|
|
enum OperatingMode {
|
|
USBunknown,
|
|
USBhost,
|
|
USBdevice
|
|
};
|
|
|
|
static std::shared_ptr<Pro::MessageData> MessageDataFactory(Pro::MESSAGE_LABEL, OperatingMode);
|
|
|
|
protected:
|
|
void routeRxMessage(std::shared_ptr<Pro::MessageData>);
|
|
|
|
// USB Host operations
|
|
virtual void sendMessage(std::shared_ptr<Pro::MessageData>) const;
|
|
virtual void rebootBootloader();
|
|
bool getParameters(size_t user_length = 0, int timeout = 0);
|
|
void setParameters() const;
|
|
bool getSerialNumber(int timeout = 0);
|
|
void sendDmx(bool trimmed = true) const;
|
|
|
|
/**
|
|
* @brief writeFwPage
|
|
* @return
|
|
*
|
|
* Reimpliment in super class to process the page. Base implimentation is to return false.
|
|
*/
|
|
virtual bool writeFwPage(uint8_t*) { return false; }
|
|
|
|
uint32_t serial_number; //!< BCD serial number
|
|
uint16_t firmware_version; //!< Firmware version number
|
|
uint8_t tx_break_intervals; //!< DMX_BREAK_INTERVAL count of the DMX BREAK
|
|
uint8_t tx_mab_intervals; //!< DMX_MAB_INTERVAL count of the DMX MARK AFTER BREAK
|
|
uint8_t tx_rate; //!< DMX packet transmit Rate
|
|
std::vector<uint8_t> user_configuration; //!< User defined configuration data.
|
|
OperatingMode usb_mode; //!< The side of the USB the widget is acting on.
|
|
|
|
private:
|
|
void rxMsgHello(std::shared_ptr<Pro::MessageData>);
|
|
void rxMsgReprogramFirmware(std::shared_ptr<Pro::MsgReprogramFirmware>);
|
|
void rxMsgProgramFlashPageRequest(std::shared_ptr<Pro::MsgProgramFlashPageRequest>);
|
|
void rxMsgProgramFlashPageReply(std::shared_ptr<Pro::MsgProgramFlashPageReply>);
|
|
void rxMsgGetWidgetParametersRequest(std::shared_ptr<Pro::MsgGetWidgetParametersRequest>);
|
|
void rxMsgGetWidgetParametersReply(std::shared_ptr<Pro::MsgGetWidgetParametersReply>);
|
|
void rxMsgSetWidgetParametersRequest(std::shared_ptr<Pro::MsgSetWidgetParametersRequest>);
|
|
void rxMsgRecievedDmxPacket(std::shared_ptr<Pro::MsgRecievedDmxPacket>);
|
|
void rxMsgOutputOnlySendDMX(std::shared_ptr<Pro::MsgOutputOnlySendDMX>);
|
|
void rxMsgSendRDMData(std::shared_ptr<Pro::MsgSendRDMData>);
|
|
void rxMsgRecieveDMXOnChange(std::shared_ptr<Pro::MsgRecieveDMXOnChange>);
|
|
void rxMsgRecievedDMXChanged(std::shared_ptr<Pro::MsgRecievedDMXChanged>);
|
|
void rxMsgGetWidgetSerialRequest(std::shared_ptr<Pro::MsgGetWidgetSerialRequest>);
|
|
void rxMsgGetWidgetSerialReply(std::shared_ptr<Pro::MsgGetWidgetSerialReply>);
|
|
void rxMsgSendRDMDiscovery(std::shared_ptr<Pro::MsgSendRDMDiscovery>);
|
|
|
|
Pro::DMX_RX_MODE rx_update_mode_;
|
|
|
|
mutable std::mutex mtx_metadata_;
|
|
std::shared_ptr<void> token_data_changed_;
|
|
std::promise<bool> reply_hello_;
|
|
std::promise<bool> reply_firmwarePage_;
|
|
std::promise<bool> reply_parameters_;
|
|
std::promise<bool> reply_serialNumber_;
|
|
};
|
|
|
|
} // namespace ENTTEC
|
|
|
|
|