SD logging platform module. More...

#include <SD.h>

Inheritance diagram for Loom_SD:

Public Member Functions
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. More...

	Loom_SD (LoomManager *manager, JsonArrayConst p)
	Constructor that takes Json Array, extracts args and delegates to regular constructor. More...

	~Loom_SD ()=default
	Destructor. More...

OPERATION
bool	log (JsonObject json) override
	Log a Json object. More...

bool	log (const char *name)
	Version of logging for use with LoomManager. More...

bool	save_json (JsonObject json, const char *name)
	Save data to SD card in CSV format. More...

void	delete_file (const char *name)
	Delete a file. More...

void	empty_file (const char *name)
	Clear a file (remove contents but not file itself) More...

void	power_up () override
	Turn on any hardware. More...

void	power_down () override
	Turn off any hardware. More...

PRINT INFORMATION
void	print_config () const override
	Display the configuration settings of the module. More...

bool	dump_file (const char *name)
	List current files on the SD card. More...

GETTERS
LoomRTC *	get_RTC_module () const
	Return pointer to the currently linked RTC object. More...

const char *	get_default_file () const
	Get the current default file to write to. More...

SETTERS
void	link_device_manager (LoomManager *LM) override
	Add pointer back to device manager. More...

void	set_RTC_module (LoomRTC *RTC_Inst)
	Set the RTC module to use for timers. More...

void	set_filename (const char *name)
	Set default file to write to. More...

Public Member Functions inherited from LoomLogPlat
	LoomLogPlat (LoomManager manager, const char module_name, const LoomModule::Type module_type, const bool enable_rate_filter=true, const uint16_t min_filter_delay=1000)
	Constructor. More...

virtual	~LoomLogPlat ()=default
	Destructor. More...

virtual void	package (JsonObject json) override
	No package necessary for logging platforms. More...

bool	log ()
	Version of log for use with LoomManager. More...

Public Member Functions inherited from LoomModule
	LoomModule (LoomManager manager, const char module_name="Unknown", const Type module_type=Type::Unknown)
	Constructor. More...

virtual	~LoomModule ()=default
	Destructor. More...

virtual void	second_stage_ctor ()
	Second stage construction. More...

virtual bool	dispatch (JsonObject json)
	Route command to driver. More...

virtual void	add_config (JsonObject json)
	Add configuration information to JsonObject. More...

Type	get_module_type () const
	Get module type. More...

LoomManager *	get_device_manager () const
	Get the device manager class if linked. More...

void	get_module_name (char *buf) const
	Copy module name into buffer. More...

const char *	get_module_name () const
	Get module name. More...

Verbosity	get_print_verbosity () const
	Get print verbosity. More...

Verbosity	get_package_verbosity () const
	Get package verbosity. More...

bool	get_active () const
	Get whether or not the module should be treated as active. More...

Category	category () const
	Get the category of the module. More...

void	set_print_verbosity (const Verbosity v)
	Set print verbosity Controlls level of detail included in debug prints. More...

void	set_package_verbosity (const Verbosity v)
	Set package verbosity. More...

void	set_active (const bool enable)
	Set whether or not the module should be treated as active. More...

virtual void	print_state () const
	Display current state of the module. More...

Protected Attributes
SdFat	sd
	File system object. More...

const byte	chip_select
	Chip select pin. More...

char	filename [13]
	String of file to write to if not filename explicitly provided (should not exceed 6 characters) More...

LoomRTC *	RTC_Inst
	Pointer to an RTC object for timestamps. More...

Protected Attributes inherited from LoomLogPlat
bool	enable_rate_filter
	Whether or not to enable a minimum delay between logging. More...

uint16_t	min_filter_delay
	Minimum delay between logging (milliseconds) More...

unsigned long	last_log_millis
	Value of millis() at last executed log time. More...

Protected Attributes inherited from LoomModule
const Type	module_type
	Module type. More...

LoomManager *	device_manager
	Pointer to manager. More...

const String	module_name_base
	The name of the module (Should have a DEFAULT but can be overriden if provided to constructor) More...

const char *	module_name

bool	active
	Whether or not the module should be treated as active. More...

Verbosity	print_verbosity
	Print verbosity. More...

Verbosity	package_verbosity
	Package verbosity. More...

Additional Inherited Members
Public Types inherited from LoomModule
enum	Type { Type::Unknown = 0, Type::Other =1000, Type::Interrupt_Manager, Type::Sleep_Manager, Type::Multiplexer, Type::NTP, Type::TempSync, Type::WarmUp_Manager, Type::Sensor =2000, Type::Analog, Type::Digital, Type::I2C =2100, Type::ADS1115, Type::AS7262, Type::AS7263, Type::AS7265X, Type::FXAS21002, Type::FXOS8700, Type::LIS3DH, Type::MB1232, Type::MMA8451, Type::MPU6050, Type::MS5803, Type::SHT31D, Type::TMP007, Type::TSL2561, Type::TSL2591, Type::ZXGesture, Type::STEMMA, Type::SDI12 =2200, Type::Decagon5TM, Type::DecagonGS3, Type::SPI =2300, Type::MAX31855, Type::MAX31856, Type::L_SERIAL =2400, Type::K30, Type::L_RTC =3000, Type::DS3231, Type::PCF8523, Type::Actuator =4000, Type::Neopixel, Type::Relay, Type::Servo, Type::Stepper, Type::LogPlat =5000, Type::OLED, Type::SDCARD, Type::BATCHSD, Type::CommPlat =6000, Type::LoRa, Type::nRF, Type::Bluetooth, Type::InternetPlat =7000, Type::Ethernet, Type::WiFi, Type::LTE, Type::PublishPlat =8000, Type::GoogleSheets, Type::MaxPub, Type::SpoolPub, Type::SubscribePlats =9000, Type::MaxSub }
	Enum to check against to when finding individual component managed by a LoomManager. More...

enum	Category { Category::Unknown =0, Category::Other =1, Category::Sensor =2, Category::L_RTC =3, Category::Actuator =4, Category::LogPlat =5, Category::CommPlat =6, Category::InternetPlat =7, Category::PublishPlat =8, Category::SubscribePlat =9 }
	Enum to classify modules. More...

Static Public Member Functions inherited from LoomModule
static const char *	enum_verbosity_string (const Verbosity v)
	Get string of name associated with verbosity enum. More...

static const char *	enum_category_string (const Category c)
	Get string of the category associated with a Category. More...

Protected Member Functions inherited from LoomLogPlat
bool	check_millis ()
	Check against millis to determine if time since last log exceeds min time. More...

Protected Member Functions inherited from LoomModule
void	print_module_label () const
	Print the module name as a label. More...

Detailed Description

SD logging platform module.

Resources

Constructor & Destructor 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

[in]	enable_rate_filter	Bool \| <true> \| {true, false} \| Whether or not to impose maximum update rate
[in]	min_filter_delay	Int \| <1000> \| [100-5000] \| Minimum update delay, if enable_rate_filter enabled
[in]	chip_select	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
[in]	default_file_base	String \| <"test"> \| null \| File to write to if none explicity provided (should be <= 6 characters, don't add extension)
[in]	number_files	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

[in] p The array of constuctor args to expand

Loom_SD::~Loom_SD ( )

default

Destructor.

Member Function Documentation

void Loom_SD::delete_file ( const char * name )

inline

Delete a file.

Parameters

[in] filename Name of file to delete

bool Loom_SD::dump_file ( const char * name )

List current files on the SD card.

Print the contents of a particular file

Parameters

[in] filename Name of file to print

void Loom_SD::empty_file ( const char * name )

Clear a file (remove contents but not file itself)

Parameters

[in] filename Name of file to empty

const char* Loom_SD::get_default_file ( ) const

inline

Get the current default file to write to.

Returns: Default file

LoomRTC* Loom_SD::get_RTC_module ( ) const

inline

Return pointer to the currently linked RTC object.

Returns: Current RTC object

void Loom_SD::link_device_manager ( LoomManager * LM )

overridevirtual

Add pointer back to device manager.

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

Parameters

[in] LM LoomManager to point to

Reimplemented from LoomModule.

bool Loom_SD::log ( JsonObject json )

inlineoverridevirtual

Log a Json object.

Parameters

[in] json Json Object to log

Implements LoomLogPlat.

bool Loom_SD::log ( const char * name )

Version of logging for use with LoomManager.

Accesses Json from LoomManager

Parameters

[in] filename Name of file to write to

void Loom_SD::power_down ( )

overridevirtual

Turn off any hardware.

Reimplemented from LoomModule.

void Loom_SD::power_up ( )

overridevirtual

Turn on any hardware.

Reimplemented from LoomModule.

void Loom_SD::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomLogPlat.

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

Save data to SD card in CSV format.

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

Parameters

[in]	json	The data to be saved
[in]	filename	The file to save to

void Loom_SD::set_filename ( const char * name )

Set default file to write to.

Parameters

[in] filename New default file (max 8 characters excluding extension)

void Loom_SD::set_RTC_module ( LoomRTC * RTC_Inst )

inline

Set the RTC module to use for timers.

Parameters

[in] RTC_Inst Pointer to the RTC object

Member Data Documentation

const byte Loom_SD::chip_select

protected

Chip select pin.

char Loom_SD::filename[13]

protected

String of file to write to if not filename explicitly provided (should not exceed 6 characters)

LoomRTC* Loom_SD::RTC_Inst

protected

Pointer to an RTC object for timestamps.

SdFat Loom_SD::sd

protected

File system object.

The documentation for this class was generated from the following files:

src/LogPlats/SD.h
src/LogPlats/SD.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation