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
N/A | data | |
N/A | length |
Definition at line
52
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
emberAfPluginXmodemSenderStart#
EmberStatus emberAfPluginXmodemSenderStart (EmberAfXmodemSenderTransmitFunction * sendRoutine, EmberAfXmodemSenderGetNextBlockFunction * getNextBlockRoutine, EmberAfXmodemSenderFinishedFunction * finishedRoutine, uint8_t maxSizeOfBlock, bool waitForReady)
Parameters
N/A | sendRoutine | |
N/A | getNextBlockRoutine | |
N/A | finishedRoutine | |
N/A | maxSizeOfBlock | |
N/A | waitForReady |
Definition at line
56
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
emberAfPluginXmodemSenderAbort#
void emberAfPluginXmodemSenderAbort (void )
Parameters
N/A |
Definition at line
62
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
Typedef Documentation#
EmberAfXmodemSenderTransmitFunction#
typedef EmberStatus() EmberAfXmodemSenderTransmitFunction(uint8_t *data, uint8_t length) (uint8_t *data, uint8_t length)
Definition at line
38
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
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)
Definition at line
40
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
EmberAfXmodemSenderFinishedFunction#
typedef void() EmberAfXmodemSenderFinishedFunction(bool success) (bool success)
Definition at line
45
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
Macro Definition Documentation#
XMODEM_SOH#
#define XMODEM_SOHValue:
(0x01)
Definition at line
30
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
XMODEM_EOT#
#define XMODEM_EOTValue:
(0x04)
Definition at line
31
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
XMODEM_ACK#
#define XMODEM_ACKValue:
(0x06)
Definition at line
32
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
XMODEM_NAK#
#define XMODEM_NAKValue:
(0x15)
Definition at line
33
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
XMODEM_CANCEL#
#define XMODEM_CANCELValue:
(0x18)
Definition at line
34
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
XMODEM_BLOCKOK#
#define XMODEM_BLOCKOKValue:
(0x19)
Definition at line
35
of file app/framework/plugin/xmodem-sender/xmodem-sender.h
XMODEM_FILEDONE#
#define XMODEM_FILEDONEValue:
(0x17)
Definition at line
36
of file app/framework/plugin/xmodem-sender/xmodem-sender.h