-
Notifications
You must be signed in to change notification settings - Fork 0
Packetizer Structures
Ryan Summers edited this page Sep 7, 2015
·
5 revisions
This page contains information about the structure definitions used within the packetizer functions. Please refer to the following list to be redirected to the appropriate documentation.
Definition
typedef struct PACKETIZER_CONFIG {
Data_Channel which_channel;
uint8 control_byte;
void (*callback) (uint8* data, uint8 data_size);
UART_Config uart_config;
}Packetizer_Config;Description
This structure is used for the initialization of the packetizer module of SUBLIBinal.
Parameters
- which_channel: This parameter specifies which channel the packetizer is to be configured for.
- control_byte: The control byte is an ASCII byte of data to specify the beginning of a packet.
- callback: The callback function for packetizer is used in the packetizer background process for processing of received packets. The callback function should accept a data pointer and a data size parameter so that the callback function has access to the received data. The callback function is crucial for receiving data on the packetizer.
- uart_config: This parameter is a completely filled out and initialized UART configuration structure. The UART should be configured before being handed to the packetizer.
Description
The Packetizer_Data structure is an internal structure for use by SUBLIBinal. Please refer to the technical documentation for more information.
SUBLIBinal was created by the Palouse Robosub Club.