CircularBufferSpiFlashRK (community library)

Summary

Name	Value
Name	CircularBufferSpiFlashRK
Version	0.0.1
Installs
License	MIT
Author	rickkas7@rickkas7.com
URL	https://github.com/rickkas7/CircularBufferSpiFlashRK
Repository	https://github.com/rickkas7/CircularBufferSpiFlashRK.git
Download	.tar.gz

Particle library for Allegro ACS37800 power monitor IC

Example Build Testing

Device OS Version:

This table is generated from an automated build. Success only indicates that the code compiled successfully.

Library Read Me

This content is provided by the library maintainer and has not been validated or approved.

CircularBufferSpiFlashRK

Circular buffer storage in external SPI flash chips for Particle devices

This library is designed to hold a circular buffer of variable-sized records in a FIFO queue stored in SPI NOR flash memory. It can only be used with external SPI flash chips; it cannot be used with the built-in SPI flash on Particle Gen 3 and Gen 4 devices.

It works with SPI flash chips that are compatible with SpiFlashRK including most from Winbond, Macronix, and ISSI. It supports all sizes of devices, including those that require 4-byte addressing (larger than 16 Mbyte). It requires 4096 byte sectors, however.

It can use any portion, divided at a sector boundary, or the entire chip.

It limited to 16-bit sector numbers within the circular buffer, so the maximum size circular buffer is 256 Mbyte but the chip can be larger than that.

A chip can contain multiple separate buffers if desired by instantiating multiple CircularBufferSpiFlashRK objects sharing a single SpiFlash object. You can also use other portions of the flash for other purposes as long as the other uses properly lock the SPI bus or access it using the shared SpiFlash object.

The main advantage of this library is that it does not require a file system, like LittleFS or SPIFFS. It takes advantage of the natural circularity of the buffer to wear level across all sectors.

It can store text or binary data, up to the sector size of 4096 bytes minus overhead of 10 bytes. Multiple records will be packed into a sector, but records won't span sector boundaries, so certain sizes, such as exactly 2048 byte records, will be inefficient because they do not efficiently pack into sectors.

One use case of this library is PublishQueueSpiFlashRK which uses the circular buffer to store events when offline.

Version history

0.0.1 (2024-07-26)

Initial version.