Loom_BatchSD class

Batch SD logging platform module.

Reference

Base classes

class LoomLogPlat: Abstract base of logging platforms.

Protected variables

SdFat sd: File System Object.
const byte chip_select: Chip select pin.
int batch_counter: Current batch count value.
int packet_counter: Current packet count value in a batch.
int drop_count: Current count of packets that failed to be sent.

CONSTRUCTORS / DESTRUCTOR

Loom_BatchSD(LoomManager* manager, const bool enable_rate_filter = true, const uint16_t min_filter_delay = 1000, const byte chip_select = 10): SD Module Constructor.
Loom_BatchSD(LoomManager* manager, JsonArrayConst p): Constructor that takes Json Array, extracts args.
~Loom_BatchSD() defaulted: Destructor.

OPERATION

auto log(JsonObject json) -> bool override: Log a Json object.
void clear_batch_log(): Clears all the files that are being stored in the batch on the SD card.
auto store_batch() -> bool: Accesses the internal json from Loom Manager to store to batch using store_batch_json.
auto store_batch_json(JsonObject json) -> bool: Uses JsonObject to write file as packet in the batch onto the SD Card.
void power_up() override: Turn on any hardware.
void power_down() override: Turn off any hardware.
void package(JsonObject json) virtual: No package necessary for logging platforms.

PRINT INFORMATION

void print_config() const override: Display the configuration settings of the module.
auto dump_batch(int index) -> bool: Prints the contents of a particular packet file in the batch.

GETTERS

auto get_batch_json(int index) -> JsonObject: Returns a JsonObject of the packet file (.json) in the batch from the SD card.
auto get_packet_counter() -> int: Get the current amount of packets that are being stored in the batch.
void add_drop_count(uint8_t dropped): Updates the count of packets that have failed to send.

Function documentation

Loom_BatchSD::Loom_BatchSD(LoomManager* manager, const bool enable_rate_filter = true, const uint16_t min_filter_delay = 1000, const byte chip_select = 10)

SD Module Constructor.

Parameters
manager
enable_rate_filter in	Bool \| <true> \| {true, false} \| Whether or not to impose maximum update rate
min_filter_delay in	Int \| <1000> \| [100-5000] \| Minimum update delay, if enable_rate_filter enabled
chip_select in	Set(Int) \| <10> \| {5, 6, 9, 10, 11, 12, 13, 14("A0"), 15("A1"), 16("A2"), 17("A3"), 18("A4"), 19("A5")} \| Which pin to use for chip select

Loom_BatchSD::Loom_BatchSD(LoomManager* manager, JsonArrayConst p)

Constructor that takes Json Array, extracts args.

Parameters
manager
p in	The array of constuctor args to expand

and delegates to regular constructor

bool Loom_BatchSD::log(JsonObject json) override

Log a Json object.

Parameters
json in	Json Object to log

bool Loom_BatchSD::store_batch()

Accesses the internal json from Loom Manager to store to batch using store_batch_json.

Returns	True if success

bool Loom_BatchSD::store_batch_json(JsonObject json)

Uses JsonObject to write file as packet in the batch onto the SD Card.

Parameters
json in	The data to be saved as .json file
Returns	True if success

void Loom_BatchSD::package(JsonObject json) virtual

No package necessary for logging platforms.

implement with empty body.

bool Loom_BatchSD::dump_batch(int index)

Prints the contents of a particular packet file in the batch.

Parameters
index in	The index of file in the batch to print
Returns	True if success

JsonObject Loom_BatchSD::get_batch_json(int index)

Returns a JsonObject of the packet file (.json) in the batch from the SD card.

Parameters
index in	The index of the file in the batch to retrieve
Returns	The JsonObject stored index

int Loom_BatchSD::get_packet_counter()

Get the current amount of packets that are being stored in the batch.

Returns	The current number of packets

void Loom_BatchSD::add_drop_count(uint8_t dropped)

Updates the count of packets that have failed to send.

Parameters
dropped in	The amount of packets that have been dropped during transmit