documentation
This commit is contained in:
parent
2fdef29242
commit
7802f201e0
|
|
@ -353,10 +353,12 @@ bool Widget::writeFirmware(const uint8_t *data, const size_t size)
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::MessageDataFactory
|
||||
* @param label
|
||||
* @param mode
|
||||
* @brief Create ENTTEC API messages.
|
||||
* @param label Opcode of the message.
|
||||
* @param mode USB role.
|
||||
* @return
|
||||
*
|
||||
* Some opcodes have dual meaning, depending on which side of USB this driver is operating.
|
||||
*/
|
||||
std::shared_ptr<Pro::MessageData> Widget::MessageDataFactory(Pro::MESSAGE_LABEL label,
|
||||
OperatingMode mode)
|
||||
|
|
@ -412,8 +414,10 @@ std::shared_ptr<Pro::MessageData> Widget::MessageDataFactory(Pro::MESSAGE_LABEL
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::routeRxMessage
|
||||
* @brief Route recieved Enttec API messages.
|
||||
* @param msg
|
||||
*
|
||||
* Some opcodes have dual meaning, depending on which side of USB this driver is operating.
|
||||
*/
|
||||
void Widget::routeRxMessage(std::shared_ptr<Pro::MessageData> msg)
|
||||
{
|
||||
|
|
@ -531,10 +535,10 @@ void Widget::routeRxMessage(std::shared_ptr<Pro::MessageData> msg)
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::sendMessage
|
||||
* @brief Send a message to the widget.
|
||||
* @param msg
|
||||
*
|
||||
* The base class method is to discard the message.
|
||||
* \note The base class method is to discard the message.
|
||||
*/
|
||||
void Widget::sendMessage(std::shared_ptr<Pro::MessageData> msg) const
|
||||
{
|
||||
|
|
@ -557,13 +561,14 @@ void Widget::rebootBootloader()
|
|||
}
|
||||
break;
|
||||
default:
|
||||
/// \note This method is remotely triggered by USB Hosts prior to sending a firemware upload.
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief Widget::getSerialNumber
|
||||
* @brief Request that the USB Device reply with it's serial number.
|
||||
*/
|
||||
void Widget::getSerialNumber()
|
||||
{
|
||||
|
|
@ -573,8 +578,8 @@ void Widget::getSerialNumber()
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::sendDmx
|
||||
* @param trimmed
|
||||
* @brief Request that the USB Device output the current dimmer data.
|
||||
* @param trimmed Remove trailing null slots.
|
||||
*/
|
||||
void Widget::sendDmx(bool trimmed) const
|
||||
{
|
||||
|
|
@ -605,7 +610,7 @@ void Widget::rxMsgHello()
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgReprogramFirmware
|
||||
* @brief The USB Host intents to begin sending a firmware upload.
|
||||
*/
|
||||
void Widget::rxMsgReprogramFirmware()
|
||||
{
|
||||
|
|
@ -614,7 +619,7 @@ void Widget::rxMsgReprogramFirmware()
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgProgramFlashPageRequest
|
||||
* @brief The USB Host has sent a page of a new firmware.
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgProgramFlashPageRequest(std::shared_ptr<Pro::MsgProgramFlashPageRequest> msg)
|
||||
|
|
@ -626,17 +631,18 @@ void Widget::rxMsgProgramFlashPageRequest(std::shared_ptr<Pro::MsgProgramFlashPa
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgProgramFlashPageReply
|
||||
* @brief The USB Device is reporting the status of the previous firmware page write.
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgProgramFlashPageReply(std::shared_ptr<Pro::MsgProgramFlashPageReply> msg)
|
||||
{
|
||||
(void)msg;
|
||||
/// \todo Send next firmware page.
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgGetWidgetParametersRequest
|
||||
* @brief The USB Host is request this widgets tx parameters.
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgGetWidgetParametersRequest(std::shared_ptr<Pro::MsgGetWidgetParametersRequest> msg)
|
||||
|
|
@ -656,7 +662,7 @@ void Widget::rxMsgGetWidgetParametersRequest(std::shared_ptr<Pro::MsgGetWidgetPa
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgGetWidgetParametersReply
|
||||
* @brief The USB Device has reported it's tx parameters.
|
||||
* @param msg
|
||||
*
|
||||
* No sanity checking is performed on the values in the reply.
|
||||
|
|
@ -673,7 +679,7 @@ void Widget::rxMsgGetWidgetParametersReply(std::shared_ptr<Pro::MsgGetWidgetPara
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgSetWidgetParametersRequest
|
||||
* @brief The USB Host has requested an update to the widget's tx parameters.
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgSetWidgetParametersRequest(std::shared_ptr<Pro::MsgSetWidgetParametersRequest> msg)
|
||||
|
|
@ -687,7 +693,7 @@ void Widget::rxMsgSetWidgetParametersRequest(std::shared_ptr<Pro::MsgSetWidgetPa
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgRecievedDmxPacket
|
||||
* @brief The USB Device has recieved a frame of DMX
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgRecievedDmxPacket(std::shared_ptr<Pro::MsgRecievedDmxPacket> msg)
|
||||
|
|
@ -704,7 +710,7 @@ void Widget::rxMsgRecievedDmxPacket(std::shared_ptr<Pro::MsgRecievedDmxPacket> m
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgOutputOnlySendDMX
|
||||
* @brief The USB Host has send a frame of DMX for the widget to transmit.
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgOutputOnlySendDMX(std::shared_ptr<Pro::MsgOutputOnlySendDMX> msg)
|
||||
|
|
@ -720,17 +726,18 @@ void Widget::rxMsgOutputOnlySendDMX(std::shared_ptr<Pro::MsgOutputOnlySendDMX> m
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgSendRDMData
|
||||
* @brief The USB host is requesting a half-duplex data write.
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgSendRDMData(std::shared_ptr<Pro::MsgSendRDMData> msg)
|
||||
{
|
||||
(void)msg;
|
||||
/// \todo Impliment USB Device side of sending half-duplex RDM data.
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgRecieveDMXOnChange
|
||||
* @brief The USB Host has requested to only updated about recv'd data if it has changed.
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgRecieveDMXOnChange(std::shared_ptr<Pro::MsgRecieveDMXOnChange> msg)
|
||||
|
|
@ -742,17 +749,18 @@ void Widget::rxMsgRecieveDMXOnChange(std::shared_ptr<Pro::MsgRecieveDMXOnChange>
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgRecievedDMXChanged
|
||||
* @brief The USB Device has send the portion of DMX data that has changed.
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgRecievedDMXChanged(std::shared_ptr<Pro::MsgRecievedDMXChanged> msg)
|
||||
{
|
||||
(void)msg;
|
||||
/// \todo Merge changed slots into the universe dimmer data.
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgGetWidgetSerialRequest
|
||||
* @brief The USB Host has reqested this widget's serial number.
|
||||
*/
|
||||
void Widget::rxMsgGetWidgetSerialRequest()
|
||||
{
|
||||
|
|
@ -766,7 +774,7 @@ void Widget::rxMsgGetWidgetSerialRequest()
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgGetWidgetSerialReply
|
||||
* @brief The USB Device has sent it's serial number.
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgGetWidgetSerialReply(std::shared_ptr<Pro::MsgGetWidgetSerialReply> msg)
|
||||
|
|
@ -778,12 +786,13 @@ void Widget::rxMsgGetWidgetSerialReply(std::shared_ptr<Pro::MsgGetWidgetSerialRe
|
|||
|
||||
|
||||
/**
|
||||
* @brief Widget::rxMsgSendRDMDiscovery
|
||||
* @brief The USB Host is requesting the sending of a RDM Discovery message.
|
||||
* @param msg
|
||||
*/
|
||||
void Widget::rxMsgSendRDMDiscovery(std::shared_ptr<Pro::MsgSendRDMDiscovery> msg)
|
||||
{
|
||||
(void)msg;
|
||||
/// \todo Impliment USB Device side of sending half-duplex RDM discovery data.
|
||||
}
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue