VnUartPacketFinder Struct Reference

Data structure holding current parsing status of data received from a VectorNav sensor. More...

`#include <upackf.h>`

## Data Fields

VnUartPacketFinder_PacketFoundHandler | packetFoundHandler
| Callback for when a packet has been found and validated.
void * | packetFoundHandlerUserData
| User data for callbacks on the packetFoundHandler.
size_t | runningDataIndex
| Used for correlating the position in the received raw data stream where packets are found.
bool | asciiCurrentlyBuildingPacket
| Indicates if an ASCII packet is currently being built.
size_t | asciiPossibleStartOfPacketIndex
| Indicates a suspected start of an ASCII packet.
size_t | asciiRunningDataIndexOfStart
| Index of start of ASCII packet in total running index.
bool | asciiEndChar1Found
| Indicates if the first ending character has been found.
bool | binaryCurrentlyBuildingBinaryPacket
| Indicates if we are currently building a binary packet.
size_t | binaryRunningDataIndexOfStart
| Index of start of binary packet in total running index.
size_t | bufferSize
| Holds the size of the receive buffer.
size_t | bufferAppendLocation
| The current location to append data into the buffer.
bool | binaryGroupsPresentFound
| Indicates if we have found the groups present data field for a binary packet we are building.
uint8_t | binaryGroupsPresent
| The groups present found from a binary packet.
uint8_t | binaryNumOfBytesRemainingToHaveAllGroupFields
| Indicates the number of bytes remaining to have all group fields for a binary data packet we are processing.
size_t | binaryPossibleStartIndex
| Start index of a possible binary packet.
size_t | binaryNumberOfBytesRemainingForCompletePacket
| Keeps track of the number of bytes remaining for a complete binary packet.
uint8_t | receiveBuffer [VNUART_PROTOCOL_BUFFER_SIZE]
| The receive buffer.

## Detailed Description

Data structure holding current parsing status of data received from a VectorNav sensor.

This structure contains a buffer which will hold bytes that are currently being processed. The size of this buffer can be adjusted by defining the size using the preprocesser. For example, the size can be adjusted to use 1024 bytes by defining VNUART_PROTOCOL_BUFFER_SIZE=1024.

Examples:
  getting_started/main.c.

The documentation for this struct was generated from the following file:

- upackf.h