Component: Circular Buffer (8-bit) (Buffer)

Author	Matrix Ltd
Version	1.6
Category	Buffer

Circular Buffer (8-bit) component

Circular buffer component allowing easy and efficient first in first out (FIFO) style data byte storage. Useful when used with a comms component to capture data as it comes in ready for processing when we have time. Also features macros to allow you to check for specific incoming responses such as "OK" or "ERROR".

Version information

Library Version, Component Version, Date, Author, Info
1, 1.6, 04-03-25, BR, Changed console tab name to match CB handle name

Detailed description

No detailed description exists yet for this component

Examples

Basic Example

Circular Buffer Example File demonstrating the storage and retrieval of data. CircularBuffer System panel showing data in and data out of the FIFO circular buffer.

Console window showing data in the circular buffer on the first simulation run.

Console window showing data in the circular buffer on the second simulation run, note that the start location has been shifted and will eventually wrap hence the name, circular buffer.

Keypad Based Door Entry System

Each key press on the keypad is fed into the Circular Buffer component. We then poll the buffer to see if the correct characters for the password have been entered. Keypad Door Entry If the correct sequence is detected then we activate the solenoid component for 5 seconds.

Reliable Communications Data

This example takes bytes received from the Serial UART and uses the circular buffer to store the bytes as they come in using an interrupt. The main routine then forwards the bytes through to a PC using a USB serial connection. This example would work equally well for creating a bridge between several UARTs or translating Serial to SPI or I2C etc. UART to USB Serial Data Bridge

AT Command Responses

This example sends out AT commands to an AT based communications module e.g. GSM or Bluetooth. The response from the module is stored in the circular buffer and we then scan the buffer for appropriate responses from the module. The outcome of the command is then printed to the LCD to let you know if the command was accepted, caused an error or simply timed out. Reliable AT Command Response

Searching for none ASCII characters

The LookForValue and WaitForValue functions can be useful when searching for ASCII data in the circular buffer. You can also use the escape sequence \x to search for hexadecimal values in the buffer.

e.g. "ABC\xFF\x80"

Will look for the ASCII characters A,B,C followed by the byte values 255 (0xFF) and 128 (0x80).

Macro reference

FlushBuffer

	FlushBuffer
Clears the contents of the buffer and re-initialises the index locations.
- VOID	Return

GetArray

	GetArray
Reads an array of Bytes from the circular buffer.
- BYTE	Data
Data array to store the data into
- UINT	NumBytes
Number of bytes to read from the buffer
- VOID	Return

GetByte

	GetByte
Reads the next available byte from the circular buffer, Returns 255 if the buffer is empty.
- UINT	Return

GetConsoleHandle

	GetConsoleHandle
Gets the handle to the console allowing data displaying on the panel etc.
- HANDLE	Return

GetIndexedByte

	GetIndexedByte
Gets the value of a single byte at a known location in the buffer. Leaves the buffer contents and pointers untouched.
- UINT	address
- BYTE	Return

GetNumberBytes

	GetNumberBytes
Returns the number of valid data bytes currently inside the buffer.
- UINT	Return

GetSize

	GetSize
Returns the number of bytes that can be stored in the buffer. Either in total or the number of bytes remaining based on Mode.
- BOOL	Mode
0=TotalBufferSize, 1=BufferFreeSpace
- UINT	Return

GetString

	GetString
Reads a string of characters from the circular buffer.
- UINT	MaxLength
Max number of bytes the string can store including the null byte
- STRING	Return

LookForValue

	LookForValue
Scans the buffer for an array of specific values. Returns 0 if the value is not found. Returns 1 if the value is found.
- STRING	Value
Value to look for, can be a string or byte array,
- BYTE	NumChars
The number of characters you wish to try and match
- BYTE	RemoveContent
0=Leave data alone, 1=Remove data from buffer
- BYTE	ResetFind
0=Continue the find from the last operation, 1=Start again
- BYTE	Return

PeekByte

	PeekByte
Reads the next available byte from the circular buffer without advancing the current index, Returns 255/512 if the buffer is empty.
- UINT	Return

PutArray

	PutArray
Writes an array of bytes into the circular buffer.
- BYTE	Data
Byte array to write into the buffer
- UINT	NumBytes
Number of bytes to write into the buffer
- VOID	Return

PutByte

	PutByte
Add byte to the next free location inside the circular buffer. If the data goes into the buffer correctly then return 1. Otherwise the buffer is full and the return value will equal 0.
- BYTE	Data
- BYTE	Return

PutString

	PutString
Writes a string of characters into the circular buffer.
- STRING	Data
String data array to write into the buffer
- VOID	Return

WaitForValue

	WaitForValue
Waits for an array of values to appear in the circular buffer. Returns 0 to indicate a timeout. Returns 1 to indicate the data has been found.
- STRING	Value
- BYTE	NumChars
Number of characters to try and look for
- BYTE	RemoveContent
0=Leave the buffer contents untouched, 1=Remove values as you go
- UINT	Timeout
Max amount of time to wait in milliseconds before returning 0=WaitForever
- BYTE	Return

Property reference

	Properties
	Buffer Size
Sets the number of byte elements inside the circular buffer.
	Storage Type
When buffer is full this property decides what to do. Store first x values - Will retain the information inside the buffer, new data will be discarded. Store last x values - Will discard the oldest location in the buffer and overwrite with new data.
	Memory Type
	Return Type
Specifies the way the receive function indicates a timeout. 8 Bit mode - Timeout is represented by the value 255. 16 Bit mode - Timeout is represented by the value 512 allowing the value 255 to represent valid data
	Console
Decides if the contents of the buffer are shown in a console tab.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_CircularBuffer.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_CircularBuffer.fcfx