Tiny protocol
0.7.0
Tiny communication protocol for microcontrollers
|
Functions | |
int | tiny_init (STinyData *handle, write_block_cb_t write_func, read_block_cb_t read_func, void *pdata) |
int | tiny_close (STinyData *handle) |
int | tiny_send (STinyData *handle, uint16_t *uid, uint8_t *pbuf, int len, uint8_t flags) |
sends frame with user payload to communication channel More... | |
int | tiny_read (STinyData *handle, uint16_t *uid, uint8_t *pbuf, int len, uint8_t flags) |
int | tiny_simple_send (STinyData *handle, uint8_t *pbuf, int len) |
sends frame with user payload to communication channel in blocking mode More... | |
int | tiny_simple_read (STinyData *handle, uint8_t *pbuf, int len) |
reads frame from the channel in blocking mode. More... | |
int tiny_close | ( | STinyData * | handle | ) |
The function closes channel.
handle | - pointer to Tiny data. |
int tiny_init | ( | STinyData * | handle, |
write_block_cb_t | write_func, | ||
read_block_cb_t | read_func, | ||
void * | pdata | ||
) |
The function initializes internal structures for Tiny channel and return handle to be used with all Tiny and IPC functions.
handle | - pointer to Tiny data |
write_func | - pointer to write data function (to communication channel). |
read_func | - pointer to read function (from communication channel). read_func is not required and should be NULL, if event-based API of Tiny Protocol is used. For event-based API please, refer to tiny_on_rx_byte(). |
pdata | - pointer to a user private data. This pointer is passed to write_func/read_func. |
int tiny_read | ( | STinyData * | handle, |
uint16_t * | uid, | ||
uint8_t * | pbuf, | ||
int | len, | ||
uint8_t | flags | ||
) |
The function reads data from communication channel frame format: 0x7E, data..., FCS, 0x7E.
handle | - pointer to Tiny data. |
uid | - pointer to 16-bit uid variable to fill with packet info, can be NULL. |
pbuf | a const pointer to unsigned char - buffer with data to send |
len | an integer argument - length of data to send |
flags | - TINY_FLAG_NO_WAIT |
int tiny_send | ( | STinyData * | handle, |
uint16_t * | uid, | ||
uint8_t * | pbuf, | ||
int | len, | ||
uint8_t | flags | ||
) |
sends frame with user payload to communication channel
The function sends data to communication channel in the following frame format: 0x7E, data..., FCS, 0x7E.
handle | - pointer to Tiny data. |
uid | - pointer to 16-bit variable containing packet uid, can be NULL. uid value must be spelled in network order bytes. |
pbuf | - a const pointer to unsigned char - buffer with data to send |
len | - an integer argument - length of data to send |
flags | - TINY_FLAG_NO_WAIT, TINY_FLAG_WAIT_FOREVER, TINY_FLAG_LOCK_SEND |
Returns negative value in case of error length of sent data
int tiny_simple_read | ( | STinyData * | handle, |
uint8_t * | pbuf, | ||
int | len | ||
) |
reads frame from the channel in blocking mode.
The function reads user data from communication channel
handle | - pointer to Tiny data. |
pbuf | a const pointer to unsigned char - buffer with data to send |
len | an integer argument - length of data to send |
int tiny_simple_send | ( | STinyData * | handle, |
uint8_t * | pbuf, | ||
int | len | ||
) |
sends frame with user payload to communication channel in blocking mode
The function sends data to communication channel. Unlike tiny_send(), the function works in blocking mode, i.e. it returns control only if user data are successfully sent, or in case of error.
handle | - pointer to Tiny data. |
pbuf | - a const pointer to unsigned char - buffer with data to send |
len | - an integer argument - length of data to send |