LoomCommPlat class

Abstract base of communication platform modules.

Contents

All communication platform modules inherit from this class.

Base classes

class LoomModule
Abstract root of Loom component modules inheritance hierarchy.

Derived classes

class Loom_Bluetooth
Bluetooth communication platform module.
class Loom_LoRa
LoRa communication platform module.
class Loom_nRF
Nordic Radio communication platform module.

Protected variables

uint16_t max_message_len
The maximum message length.
int16_t signal_strength
RSSI for Lora (need to determine what the other platforms use)
StaticJsonDocument<1500> messageJson
Document to read incoming data into.

RADIO IMPLEMENTATION

auto receive_blocking_impl(JsonObject json, uint max_wait_time) -> bool protected virtual
Receive, but block until packet received, or timeout reached.
auto send_impl(JsonObject json, const uint8_t destination) -> bool protected virtual
Send json to a specific address.
void broadcast_impl(JsonObject json) protected virtual
Broadcast data to all that can receive.

CONSTRUCTORS / DESTRUCTOR

LoomCommPlat(LoomManager* manager, const char* module_name, const LoomModule::Type module_type, const uint16_t max_message_len)
Constructor.
~LoomCommPlat() defaulted virtual
Destructor.

OPERATION

void package(JsonObject json) override
Package a modules measurements or state.
auto receive_blocking(JsonObject json, uint max_wait_time) -> bool
Receive, but block until packet received, or timeout reached.
auto receive(JsonObject json) -> bool
Build json from packet if any exists.
auto receive_batch() -> bool
Receive and immediately create a batch file from JSON receieved.
auto receive_batch_blocking(uint max_wait_time) -> bool
Receive, and block until packet recieved or timeout, and immediately create a batch file from JSON receieved.
auto receive() -> bool
Version of receive for use with LoomManager.
auto receive_blocking(const uint max_wait_time) -> bool
Version of receive_blocking for use with LoomManager.
auto pre_merge_receive_blocking(JsonObject json) -> JsonObject
Giving the header of the Package from the other board.
auto merge_json(JsonObject json, const uint8_t loop) -> bool
It will merge all the small packages into one big package.
auto send(JsonObject json, const uint8_t destination) -> bool
Send json to a specific address.
auto send(const uint8_t destination) -> bool
Version of send for use with LoomManager.
auto send_batch(const uint8_t destination, int delay_time) -> uint8_t
Sends all the jsons stored in the batch.
auto determine_json_size(JsonObject json) -> uint16_t
Return the size of the json to determing wether to send as split or not.
auto split_send_notification(JsonObject json, const uint8_t destination) -> bool
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.
auto split_send(JsonObject json, const uint8_t destination, const uint8_t index) -> bool
The actual processing spliting into small json.
void broadcast(JsonObject json)
Broadcast data to all that can receive.
void broadcast()
Version of send for use with LoomManager.
void broadcast_batch(int delay_time)
Broadcasts all the jsons stored in the batch.

GETTERS

auto get_address() const -> uint8_t pure virtual
Get the address of this device.
auto get_drop_rate() const -> float
Get the packet drop rate since the start of operation.
auto get_last_ten_drop_rate() const -> float
Get the packet drop rate of the last ten send() calls.

SETTERS

auto json_to_msgpack_buffer(JsonObjectConst json, char* buffer, const uint16_t max_len) const -> bool protected
Serialize a JsonObject into a MessagePack buffer.
auto msgpack_buffer_to_json(const char* buffer, JsonObject json) -> bool protected
Deserialize a MessagePack buffer into a JsonObject.
void add_packet_result(const bool did_drop) protected
Add the result of a packet to the drop_rate tracker.
void set_address(const uint8_t a) pure virtual
Set the address of this device.

Function documentation

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

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

Parameters
json out Json object to fill with incoming data
max_wait_time out Maximum number of milliseconds to block for (can be zero for non-blocking)
Returns True if packet received

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

Send json to a specific address.

Parameters
json in Json package to send
destination in Device to send to
Returns True if packet sent successfully

void LoomCommPlat::broadcast_impl(JsonObject json) virtual protected

Broadcast data to all that can receive.

Parameters
json in Json object to send

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

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

Constructor.

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

void LoomCommPlat::package(JsonObject json) override

Package a modules measurements or state.

Parameters
json out Object to put data into

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

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

Parameters
json out Json object to fill with incoming data
max_wait_time in Maximum number of milliseconds to block for
Returns True if packet received

bool LoomCommPlat::receive(JsonObject json)

Build json from packet if any exists.

Parameters
json out Json object to fill with incoming data

bool LoomCommPlat::receive_batch()

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
max_wait_time in Maximum number of milliseconds to block for
Returns True if packet was recieved and stored in batch

bool LoomCommPlat::receive()

Version of receive for use with LoomManager.

Returns True if packet received

Accesses Json from LoomManager

bool LoomCommPlat::receive_blocking(const uint max_wait_time)

Version of receive_blocking for use with LoomManager.

Parameters
max_wait_time out Maximum number of milliseconds to block for
Returns True if packet received

Accesses Json from LoomManager

JsonObject LoomCommPlat::pre_merge_receive_blocking(JsonObject json)

Giving the header of the Package from the other board.

Parameters
json in json of the headers if it came in split
Returns JsonObject it will return the headers of the package

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

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

Parameters
json in The header of the package
loop in How many small packages are coming
Returns True if all package are receive and merged, false otherwise

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

Send json to a specific address.

Parameters
json in Json package to send
destination in Device to send to
Returns True if packet sent successfully

bool LoomCommPlat::send(const uint8_t destination)

Version of send for use with LoomManager.

Parameters
destination in Address of destination device
Returns True if packet sent successfully, false otherwise

Accesses Json from LoomManager

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

Sends all the jsons stored in the batch.

Parameters
destination in Address of destination device
delay_time in The amount of time between each packet in the batch being sent
Returns true if the packet sent successfully

uint16_t LoomCommPlat::determine_json_size(JsonObject json)

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

Parameters
json in Json that will the measurement of the size
Returns uint16_t of the value of the json size

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
json in The original message pacakge
destination in Address of destination device
Returns true if able to send notification to the other board, false otherwise

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

The actual processing spliting into small json.

Parameters
json in The original message package
destination in Address of destination device
index in Json array Contents part location
Returns true if all of them send completely, false otherwise

void LoomCommPlat::broadcast(JsonObject json)

Broadcast data to all that can receive.

Parameters
json in Json object to send

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

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
delay_time in The amount of time between each packet in the batch being broadcasted

uint8_t LoomCommPlat::get_address() const pure virtual

Get the address of this device.

Returns The address of this device

Each platform may have a different addressing scheme

float LoomCommPlat::get_drop_rate() const

Get the packet drop rate since the start of operation.

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

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.

float LoomCommPlat::get_last_ten_drop_rate() const

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

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

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.

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

Serialize a JsonObject into a MessagePack buffer.

Parameters
json in JsonObject to serialize
buffer out Buffer to fill with MessagePack of json
max_len in Length of buffer
Returns True if success

Also contains buffer memsetting and print statements

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

Deserialize a MessagePack buffer into a JsonObject.

Parameters
buffer in Buffer to deserialize
json out JsonObject to deserialize into
Returns True if success

Also clears the json, contains prints and error checks.

void LoomCommPlat::add_packet_result(const bool did_drop) protected

Add the result of a packet to the drop_rate tracker.

Parameters
did_drop in Whether or not the packet dropped during transmission.

void LoomCommPlat::set_address(const uint8_t a) pure virtual

Set the address of this device.

Parameters
a in The address to set this device to

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

Variable documentation

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