Zniffer#

Modules#

Enumerations#

enum

transport_type_t {

TRANSPORT_TYPE_UART

TRANSPORT_TYPE_SPI

TRANSPORT_TYPE_ETHERNET

TRANSPORT_TYPE_UART

TRANSPORT_TYPE_SPI

TRANSPORT_TYPE_ETHERNET

}

enum

comm_interface_parse_result_t {

PARSE_IDLE

PARSE_FRAME_RECEIVED

PARSE_FRAME_SENT

PARSE_FRAME_ERROR

PARSE_RX_TIMEOUT

PARSE_TX_TIMEOUT

PARSE_IDLE

PARSE_FRAME_RECEIVED

PARSE_FRAME_SENT

PARSE_FRAME_ERROR

PARSE_RX_TIMEOUT

PARSE_TX_TIMEOUT

}

Typedefs#

typedef void *

transport_handle_t

typedef void(*

transmit_done_cb_t)(transport_handle_t transport)

typedef struct _transport_t

transport_t

Variables#

comm_interface_frame_ptr const

serial_frame

Functions#

uint8_t

frame_payload_len(const comm_interface_frame_ptr frame)

void

comm_interface_transmit_frame(uint8_t cmd, uint8_t type, const uint8_t *payload, uint8_t len, transmit_done_cb_t cb)

void

comm_interface_wait_transmit_done(void)

void

comm_interface_init(void)

uint32_t

comm_interface_get_byte_timeout_ms(void)

void

comm_interface_set_byte_timeout_ms(uint32_t t)

comm_interface_parse_result_t

comm_interface_parse_data()

Macros#

#define

SOF '#'

#define

SODF '!'

#define

SODM 0x3

#define

SOWU 0x2

#define

CMD_FRAME 0x00

#define

DATA_FRAME 0x01

#define

BEAM_FRAME 0x02

#define

BEAM_START 0x04

#define

BEAM_STOP 0x05

#define

RECEIVE_BUFFER_SIZE 180

Enumeration Documentation#

transport_type_t#

transport_type_t

Enumerator
TRANSPORT_TYPE_UART
TRANSPORT_TYPE_SPI
TRANSPORT_TYPE_ETHERNET
TRANSPORT_TYPE_UART
TRANSPORT_TYPE_SPI
TRANSPORT_TYPE_ETHERNET

comm_interface_parse_result_t#

comm_interface_parse_result_t

Enumerator
PARSE_IDLE
PARSE_FRAME_RECEIVED
PARSE_FRAME_SENT
PARSE_FRAME_ERROR
PARSE_RX_TIMEOUT
PARSE_TX_TIMEOUT
PARSE_IDLE
PARSE_FRAME_RECEIVED
PARSE_FRAME_SENT
PARSE_FRAME_ERROR
PARSE_RX_TIMEOUT
PARSE_TX_TIMEOUT

Typedef Documentation#

transport_handle_t#

typedef void* transport_handle_t

transmit_done_cb_t#

typedef void(* transmit_done_cb_t) (transport_handle_t transport) )(transport_handle_t transport)

transport_t#

typedef struct _transport_t transport_t

Variable Documentation#

serial_frame#

comm_interface_frame_ptr const serial_frame

Function Documentation#

frame_payload_len#

static uint8_t frame_payload_len (const comm_interface_frame_ptr frame)

Parameters

Type	Direction	Argument Name	Description
const comm_interface_frame_ptr	N/A	frame

comm_interface_transmit_frame#

void comm_interface_transmit_frame (uint8_t cmd, uint8_t type, const uint8_t * payload, uint8_t len, transmit_done_cb_t cb)

Parameters

Type	Direction	Argument Name
uint8_t	N/A	cmd
uint8_t	N/A	type
const uint8_t *	N/A	payload
uint8_t	N/A	len
transmit_done_cb_t	N/A	cb

comm_interface_wait_transmit_done#

void comm_interface_wait_transmit_done (void )

Parameters

Type	Direction	Argument Name	Description
void	N/A

comm_interface_init#

void comm_interface_init (void )

Parameters

Type	Direction	Argument Name	Description
void	N/A

comm_interface_get_byte_timeout_ms#

uint32_t comm_interface_get_byte_timeout_ms (void )

Parameters

Type	Direction	Argument Name	Description
void	N/A

comm_interface_set_byte_timeout_ms#

void comm_interface_set_byte_timeout_ms (uint32_t t)

Parameters

Type	Direction	Argument Name	Description
uint32_t	N/A	t

comm_interface_parse_data#

comm_interface_parse_result_t comm_interface_parse_data ()