Loom_SD class

SD logging platform module.

Contents

Base classes

class LoomLogPlat
Abstract base of logging platforms.

Protected variables

SdFat sd
File system object.
const byte chip_select
Chip select pin.
char filename
String of file to write to if not filename explicitly provided (should not exceed 6 characters)
LoomRTC* RTC_Inst
Pointer to an RTC object for timestamps.

CONSTRUCTORS / DESTRUCTOR

Loom_SD(LoomManager* manager, const bool enable_rate_filter = true, const uint16_t min_filter_delay = 1000, const byte chip_select = 10, const char* default_file = "test", const bool number_files = true)
SD Module Constructor.
Loom_SD(LoomManager* manager, JsonArrayConst p)
Constructor that takes Json Array, extracts args and delegates to regular constructor.
~Loom_SD() defaulted
Destructor.

OPERATION

auto log(JsonObject json) -> bool override
Log a Json object.
auto log(const char* name) -> bool
Version of logging for use with LoomManager.
auto save_json(JsonObject json, const char* name) -> bool
Save data to SD card in CSV format.
void delete_file(const char* name)
Delete a file.
void empty_file(const char* name)
Clear a file (remove contents but not file itself)
void power_up() override
Turn on any hardware.
void power_down() override
Turn off any hardware.

GETTERS

auto get_RTC_module() const -> LoomRTC*
Return pointer to the currently linked RTC object.
auto get_default_file() const -> const char*
Get the current default file to write to.

SETTERS

void link_device_manager(LoomManager* LM) override
Add pointer back to device manager.
void set_RTC_module(LoomRTC* RTC_Inst)
Set the RTC module to use for timers.
void set_filename(const char* name)
Set default file to write to.

Function documentation

Loom_SD::Loom_SD(LoomManager* manager, const bool enable_rate_filter = true, const uint16_t min_filter_delay = 1000, const byte chip_select = 10, const char* default_file = "test", const bool number_files = true)

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
default_file
number_files in Bool | <true> | {true, false} | True to number files with run number, false to not.

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

Constructor that takes Json Array, extracts args and delegates to regular constructor.

Parameters
manager
p in The array of constuctor args to expand

bool Loom_SD::log(JsonObject json) override

Log a Json object.

Parameters
json in Json Object to log

bool Loom_SD::log(const char* name)

Version of logging for use with LoomManager.

Accesses Json from LoomManager

bool Loom_SD::save_json(JsonObject json, const char* name)

Save data to SD card in CSV format.

Parameters
json in The data to be saved
name

Format: Identification Date Time ModuleA key1 val1 key2 val2 ... ModuleB key1 val1 ...

bool Loom_SD::dump_file(const char* name)

List current files on the SD card.

Print the contents of a particular file

LoomRTC* Loom_SD::get_RTC_module() const

Return pointer to the currently linked RTC object.

Returns Current RTC object

const char* Loom_SD::get_default_file() const

Get the current default file to write to.

Returns Default file

void Loom_SD::link_device_manager(LoomManager* LM) override

Add pointer back to device manager.

Parameters
LM in LoomManager to point to

Generally only called when device manager links module to provide pointer both directions

void Loom_SD::set_RTC_module(LoomRTC* RTC_Inst)

Set the RTC module to use for timers.

Parameters
RTC_Inst in Pointer to the RTC object