XModem Sender#

API and Callbacks for the XModem Sender Component.

API#

void

sl_zigbee_af_xmodem_sender_incoming_block(uint8_t *data, uint8_t length)

sl_zigbee_af_xmodem_sender_start(sl_zigbee_af_xmodem_sender_transmit_function_t *sendRoutine, sl_zigbee_af_xmodem_sender_get_next_block_function_t *getNextBlockRoutine, sl_zigbee_af_xmodem_sender_finished_function_t *finishedRoutine, uint8_t maxSizeOfBlock, bool waitForReady)

void

sl_zigbee_af_xmodem_sender_abort(void)

Typedefs#

typedef sl_status_t()

sl_zigbee_af_xmodem_sender_transmit_function_t(uint8_t *data, uint8_t length)

typedef sl_status_t()

sl_zigbee_af_xmodem_sender_get_next_block_function_t(uint32_t address, uint8_t length, uint8_t *returnData, uint8_t *returnLength, bool *done)

typedef void()

sl_zigbee_af_xmodem_sender_finished_function_t(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#

sl_zigbee_af_xmodem_sender_incoming_block#

void sl_zigbee_af_xmodem_sender_incoming_block (uint8_t * data, uint8_t length)

Parameters

Type	Direction	Argument Name	Description
uint8_t *	N/A	data
uint8_t	N/A	length

sl_zigbee_af_xmodem_sender_start#

sl_status_t sl_zigbee_af_xmodem_sender_start (sl_zigbee_af_xmodem_sender_transmit_function_t * sendRoutine, sl_zigbee_af_xmodem_sender_get_next_block_function_t * getNextBlockRoutine, sl_zigbee_af_xmodem_sender_finished_function_t * finishedRoutine, uint8_t maxSizeOfBlock, bool waitForReady)

Parameters

Type	Direction	Argument Name
sl_zigbee_af_xmodem_sender_transmit_function_t *	N/A	sendRoutine
sl_zigbee_af_xmodem_sender_get_next_block_function_t *	N/A	getNextBlockRoutine
sl_zigbee_af_xmodem_sender_finished_function_t *	N/A	finishedRoutine
uint8_t	N/A	maxSizeOfBlock
bool	N/A	waitForReady

sl_zigbee_af_xmodem_sender_abort#

void sl_zigbee_af_xmodem_sender_abort (void )

Parameters

Type	Direction	Argument Name	Description
void	N/A

Typedef Documentation#

sl_zigbee_af_xmodem_sender_transmit_function_t#

typedef sl_status_t() sl_zigbee_af_xmodem_sender_transmit_function_t(uint8_t *data, uint8_t length) (uint8_t *data, uint8_t length)

sl_zigbee_af_xmodem_sender_get_next_block_function_t#

typedef sl_status_t() sl_zigbee_af_xmodem_sender_get_next_block_function_t(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)

sl_zigbee_af_xmodem_sender_finished_function_t#

typedef void() sl_zigbee_af_xmodem_sender_finished_function_t(bool success) (bool success)