XModem Sender#
API and Callbacks for the XModem Sender Component.
API#
void
emberAfPluginXmodemSenderIncomingBlock(uint8_t *data, uint8_t length)
EmberStatus
emberAfPluginXmodemSenderStart(EmberAfXmodemSenderTransmitFunction *sendRoutine, EmberAfXmodemSenderGetNextBlockFunction *getNextBlockRoutine, EmberAfXmodemSenderFinishedFunction *finishedRoutine, uint8_t maxSizeOfBlock, bool waitForReady)
void
Typedefs#
typedef EmberStatus()
EmberAfXmodemSenderTransmitFunction(uint8_t *data, uint8_t length)
typedef EmberStatus()
EmberAfXmodemSenderGetNextBlockFunction(uint32_t address, uint8_t length, uint8_t *returnData, uint8_t *returnLength, bool *done)
typedef void()
EmberAfXmodemSenderFinishedFunction(bool success)
Macros#
#define
XMODEM_SOH (0x01)
#define
XMODEM_EOT (0x04)
#define
XMODEM_ACK (0x06)
#define
XMODEM_NAK (0x15)
#define
XMODEM_CANCEL (0x18)
#define
XMODEM_BLOCKOK (0x19)
#define
XMODEM_FILEDONE (0x17)
API Documentation#
emberAfPluginXmodemSenderIncomingBlock#
void emberAfPluginXmodemSenderIncomingBlock (uint8_t * data, uint8_t length)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t * | N/A | data | |
| uint8_t | N/A | length |
emberAfPluginXmodemSenderStart#
EmberStatus emberAfPluginXmodemSenderStart (EmberAfXmodemSenderTransmitFunction * sendRoutine, EmberAfXmodemSenderGetNextBlockFunction * getNextBlockRoutine, EmberAfXmodemSenderFinishedFunction * finishedRoutine, uint8_t maxSizeOfBlock, bool waitForReady)
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| EmberAfXmodemSenderTransmitFunction * | N/A | sendRoutine | |
| EmberAfXmodemSenderGetNextBlockFunction * | N/A | getNextBlockRoutine | |
| EmberAfXmodemSenderFinishedFunction * | N/A | finishedRoutine | |
| uint8_t | N/A | maxSizeOfBlock | |
| bool | N/A | waitForReady |
emberAfPluginXmodemSenderAbort#
void emberAfPluginXmodemSenderAbort (void )
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
Typedef Documentation#
EmberAfXmodemSenderTransmitFunction#
typedef EmberStatus() EmberAfXmodemSenderTransmitFunction(uint8_t *data, uint8_t length) (uint8_t *data, uint8_t length)
EmberAfXmodemSenderGetNextBlockFunction#
typedef EmberStatus() EmberAfXmodemSenderGetNextBlockFunction(uint32_t address, uint8_t length, uint8_t *returnData, uint8_t *returnLength, bool *done) (uint32_t address, uint8_t length, uint8_t *returnData, uint8_t *returnLength, bool *done)
EmberAfXmodemSenderFinishedFunction#
typedef void() EmberAfXmodemSenderFinishedFunction(bool success) (bool success)