Abstract base of communication platform modules. More...

#include <CommPlat.h>

Inheritance diagram for LoomCommPlat:

[legend]

Public Member Functions
CONSTRUCTORS / DESTRUCTOR
	LoomCommPlat (LoomManager manager, const char module_name, const LoomModule::Type module_type, const uint16_t max_message_len)
	Constructor. More...

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

OPERATION
virtual void	package (JsonObject json) override
	Package a modules measurements or state. More...

bool	receive_blocking (JsonObject json, uint max_wait_time)
	Receive, but block until packet received, or timeout reached. More...

bool	receive (JsonObject json)
	Build json from packet if any exists. More...

bool	receive_batch ()
	Receive and immediately create a batch file from JSON receieved. More...

bool	receive_batch_blocking (uint max_wait_time)
	Receive, and block until packet recieved or timeout, and immediately create a batch file from JSON receieved. More...

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

bool	receive_blocking (const uint max_wait_time)
	Version of receive_blocking for use with LoomManager. More...

JsonObject	pre_merge_receive_blocking (JsonObject json)
	Giving the header of the Package from the other board. More...

bool	merge_json (JsonObject json, const uint8_t loop)
	It will merge all the small packages into one big package. More...

bool	send (JsonObject json, const uint8_t destination)
	Send json to a specific address. More...

bool	send (const uint8_t destination)
	Version of send for use with LoomManager. More...

uint8_t	send_batch (const uint8_t destination, int delay_time)
	Sends all the jsons stored in the batch. More...

uint16_t	determine_json_size (JsonObject json)
	Return the size of the json to determing wether to send as split or not. More...

bool	split_send_notification (JsonObject json, const uint8_t destination)
	If the json is over 251, then it let the user the know that it will be sending small mulitple jsons with how many will it be splited into. More...

bool	split_send (JsonObject json, const uint8_t destination, const uint8_t index)
	The actual processing spliting into small json. More...

void	broadcast (JsonObject json)
	Broadcast data to all that can receive. More...

void	broadcast ()
	Version of send for use with LoomManager. More...

void	broadcast_batch (int delay_time)
	Broadcasts all the jsons stored in the batch. More...

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

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

GETTERS
virtual uint8_t	get_address () const =0
	Get the address of this device. More...

float	get_drop_rate () const
	Get the packet drop rate since the start of operation. More...

float	get_last_ten_drop_rate () const
	Get the packet drop rate of the last ten send() calls. 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	power_down ()
	Turn off any hardware. More...

virtual void	power_up ()
	Turn on any hardware. 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...

virtual void	link_device_manager (LoomManager *LM)
	Add pointer back to device manager. 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...

Protected Member Functions
RADIO IMPLEMENTATION
virtual bool	receive_blocking_impl (JsonObject json, uint max_wait_time)
	Receive, but block until packet received, or timeout reached. More...

virtual bool	send_impl (JsonObject json, const uint8_t destination)
	Send json to a specific address. More...

virtual void	broadcast_impl (JsonObject json)
	Broadcast data to all that can receive. More...

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

Protected Attributes
uint16_t	max_message_len
	The maximum message length. More...

int16_t	signal_strength
	RSSI for Lora (need to determine what the other platforms use) More...

StaticJsonDocument< 1500 >	messageJson
	Document to read incoming data into. More...

DynamicJsonDocument	mergeJson

uint32_t	total_packet_count

uint32_t	total_drop_count

bool	last_ten_dropped [10]

uint8_t	last_ten_dropped_idx

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...

SETTERS
bool	json_to_msgpack_buffer (JsonObjectConst json, char *buffer, const uint16_t max_len) const
	Serialize a JsonObject into a MessagePack buffer. More...

bool	msgpack_buffer_to_json (const char *buffer, JsonObject json)
	Deserialize a MessagePack buffer into a JsonObject. More...

void	add_packet_result (const bool did_drop)
	Add the result of a packet to the drop_rate tracker. More...

virtual void	set_address (const uint8_t a)=0
	Set the address of this device. 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...

Detailed Description

Abstract base of communication platform modules.

All communication platform modules inherit from this class.

Resources

Constructor & Destructor Documentation

LoomCommPlat::LoomCommPlat	(	LoomManager *	manager,
		const char *	module_name,
		const LoomModule::Type	module_type,
		const uint16_t	max_message_len
	)

Constructor.

Parameters

[in]	module_name	Name of the module (provided by derived classes)
[in]	module_type	Type of the module (provided by derived classes)
[in]	max_message_len	The maximum possible message length

virtual LoomCommPlat::~LoomCommPlat ( )

virtualdefault

Destructor.

Member Function Documentation

void LoomCommPlat::add_packet_result ( const bool did_drop )

protected

Add the result of a packet to the drop_rate tracker.

Parameters

[in] did_drop Whether or not the packet dropped during transmission.

void LoomCommPlat::broadcast ( JsonObject json )

inline

Broadcast data to all that can receive.

Derived classes can optionally provide an implementation for this, As supported by the radio/platform's library

Parameters

[in] json Json object to send

void LoomCommPlat::broadcast ( )

Version of send for use with LoomManager.

Accesses Json from LoomManager

void LoomCommPlat::broadcast_batch ( int delay_time )

Broadcasts all the jsons stored in the batch.

Parameters

[in] delay_time The amount of time between each packet in the batch being broadcasted

virtual void LoomCommPlat::broadcast_impl ( JsonObject json )

inlineprotectedvirtual

Broadcast data to all that can receive.

Derived classes can optionally provide an implementation for this, As supported by the radio/platform's library

Parameters

[in] json Json object to send

Reimplemented in Loom_nRF.

uint16_t LoomCommPlat::determine_json_size ( JsonObject json )

Return the size of the json to determing wether to send as split or not.

Parameters

[in] json Json that will the measurement of the size

Returns: uint16_t of the value of the json size

virtual uint8_t LoomCommPlat::get_address ( ) const

pure virtual

Get the address of this device.

Each platform may have a different addressing scheme

Returns: The address of this device

Implemented in Loom_LoRa, Loom_nRF, and Loom_Bluetooth.

float LoomCommPlat::get_drop_rate ( ) const

Get the packet drop rate since the start of operation.

Keep in mind that this drop rate will not account for retransmissions done internally by RadioHead (ex Reliable datagram), but rather will count data packets that were discarded. This rate will also ignore broadcasts, since they are nearly impossible to quantify.

Returns: The drop rate from 0 (no drops) to 100 (100% drop)

float LoomCommPlat::get_last_ten_drop_rate ( ) const

Get the packet drop rate of the last ten send() calls.

Keep in mind that this drop rate will not account for retransmissions done internally by RadioHead (ex Reliable datagram), but rather will count data packets that were discarded. This rate will also ignore broadcasts, since they are nearly impossible to quantify.

Returns: The drop rate from 0 (no drops) to 100 (100% drop)

bool LoomCommPlat::json_to_msgpack_buffer	(	JsonObjectConst	json,
		char *	buffer,
		const uint16_t	max_len
	)		const

protected

Serialize a JsonObject into a MessagePack buffer.

Also contains buffer memsetting and print statements

Parameters

[in]	json	JsonObject to serialize
[out]	buffer	Buffer to fill with MessagePack of json
[in]	max_len	Length of buffer

Returns: True if success

bool LoomCommPlat::merge_json	(	JsonObject	json,
		const uint8_t	loop
	)

It will merge all the small packages into one big package.

Parameters

[in]	json	The header of the package
[in]	loop	How many small packages are coming

Returns: True if all package are receive and merged, false otherwise

bool LoomCommPlat::msgpack_buffer_to_json	(	const char *	buffer,
		JsonObject	json
	)

protected

Deserialize a MessagePack buffer into a JsonObject.

Also clears the json, contains prints and error checks.

Parameters

[in]	buffer	Buffer to deserialize
[out]	json	JsonObject to deserialize into
[in]	max_len	Length of buffer

Returns: True if success

virtual void LoomCommPlat::package ( JsonObject json )

inlineoverridevirtual

Package a modules measurements or state.

Parameters

[out] json Object to put data into

Implements LoomModule.

JsonObject LoomCommPlat::pre_merge_receive_blocking ( JsonObject json )

Giving the header of the Package from the other board.

Parameters

[in] json json of the headers if it came in split

Returns: JsonObject it will return the headers of the package

void LoomCommPlat::print_config ( ) const

overridevirtual

Display the configuration settings of the module.

Reimplemented from LoomModule.

Reimplemented in Loom_LoRa, Loom_nRF, and Loom_Bluetooth.

void LoomCommPlat::print_state ( ) const

overridevirtual

Display current state of the module.

Reimplemented from LoomModule.

bool LoomCommPlat::receive ( JsonObject json )

inline

Build json from packet if any exists.

Parameters

[out] json Json object to fill with incoming data

bool LoomCommPlat::receive ( )

Version of receive for use with LoomManager.

Accesses Json from LoomManager

Returns: True if packet received

bool LoomCommPlat::receive_batch ( )

inline

Receive and immediately create a batch file from JSON receieved.

Returns: True if packet was recieved and stored in batch

bool LoomCommPlat::receive_batch_blocking ( uint max_wait_time )

Receive, and block until packet recieved or timeout, and immediately create a batch file from JSON receieved.

Parameters

[in] max_wait_time Maximum number of milliseconds to block for

Returns: True if packet was recieved and stored in batch

bool LoomCommPlat::receive_blocking	(	JsonObject	json,
		uint	max_wait_time
	)

Receive, but block until packet received, or timeout reached.

Parameters

[out]	json	Json object to fill with incoming data
[in]	max_wait_time	Maximum number of milliseconds to block for

Returns: True if packet received

bool LoomCommPlat::receive_blocking ( const uint max_wait_time )

Version of receive_blocking for use with LoomManager.

Accesses Json from LoomManager

Parameters

[out] max_wait_time Maximum number of milliseconds to block for

Returns: True if packet received

virtual bool LoomCommPlat::receive_blocking_impl	(	JsonObject	json,
		uint	max_wait_time
	)

inlineprotectedvirtual

Receive, but block until packet received, or timeout reached.

Parameters

[out]	json	Json object to fill with incoming data
[out]	max_wait_time	Maximum number of milliseconds to block for (can be zero for non-blocking)

Returns: True if packet received

Reimplemented in Loom_LoRa, and Loom_nRF.

bool LoomCommPlat::send	(	JsonObject	json,
		const uint8_t	destination
	)

Send json to a specific address.

Parameters

[in]	json	Json package to send
[in]	destination	Device to send to

Returns: True if packet sent successfully

bool LoomCommPlat::send ( const uint8_t destination )

Version of send for use with LoomManager.

Accesses Json from LoomManager

Parameters

[in] destination Address of destination device

Returns: True if packet sent successfully, false otherwise

uint8_t LoomCommPlat::send_batch	(	const uint8_t	destination,
		int	delay_time
	)

Sends all the jsons stored in the batch.

Parameters

[in]	destination	Address of destination device
[in]	delay_time	The amount of time between each packet in the batch being sent

Returns: true if the packet sent successfully

virtual bool LoomCommPlat::send_impl	(	JsonObject	json,
		const uint8_t	destination
	)

inlineprotectedvirtual

Send json to a specific address.

Parameters

[in]	json	Json package to send
[in]	destination	Device to send to

Returns: True if packet sent successfully

Reimplemented in Loom_LoRa, and Loom_nRF.

virtual void LoomCommPlat::set_address ( const uint8_t a )

pure virtual

Set the address of this device.

Each platform may have a different addressing scheme. Changing the device's address is not recommended.

Parameters

[in] a The address to set this device to

Implemented in Loom_LoRa, Loom_nRF, and Loom_Bluetooth.

bool LoomCommPlat::split_send	(	JsonObject	json,
		const uint8_t	destination,
		const uint8_t	index
	)

The actual processing spliting into small json.

Parameters

[in]	json	The original message package
[in]	destination	Address of destination device
[in]	index	Json array Contents part location

Returns: true if all of them send completely, false otherwise

bool LoomCommPlat::split_send_notification	(	JsonObject	json,
		const uint8_t	destination
	)

If the json is over 251, then it let the user the know that it will be sending small mulitple jsons with how many will it be splited into.

Parameters

[in]	json	The original message pacakge
[in]	destination	Address of destination device

Returns: true if able to send notification to the other board, false otherwise

Member Data Documentation

bool LoomCommPlat::last_ten_dropped[10]

protected

uint8_t LoomCommPlat::last_ten_dropped_idx

protected

uint16_t LoomCommPlat::max_message_len

protected

The maximum message length.

DynamicJsonDocument LoomCommPlat::mergeJson

protected

StaticJsonDocument<1500> LoomCommPlat::messageJson

protected

Document to read incoming data into.

CommPlatforms need their own JsonDocument because an incoming message can only be deserialized into JsonDocuments, not JsonObjects. And it seemed bad design to pass around references to the LoomManager's internal JsonDocument. Especially as the LoomManager is intended to be non-mandatory for usage of Loom

int16_t LoomCommPlat::signal_strength

protected

RSSI for Lora (need to determine what the other platforms use)

uint32_t LoomCommPlat::total_drop_count

protected

uint32_t LoomCommPlat::total_packet_count

protected

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

src/CommPlats/CommPlat.h
src/CommPlats/CommPlat.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

SETTERS

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation