Loom_nRF class

Nordic Radio communication platform module.

Contents

Base classes

class LoomCommPlat
Abstract base of communication platform modules.

Protected variables

RF24 radio
Underlying nRF24L01(+) radio object.
RF24Network* network
Network layer manager for radio.
uint8_t address
Device Address (should this be part of LoomCommPlat? – maybe not as each platform handles addresses differently)
uint8_t data_rate
Data rate.
uint8_t power_level
Power level to send at.
uint8_t retry_count
Number of transmission retries allowed.
uint16_t retry_timeout
Delay between transmission retries (in milliseconds)
uint8_t multicast_level
Which level(s) of the network to broadcast to.

RADIO IMPLEMENTATION

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

CONSTRUCTORS / DESTRUCTOR

Loom_nRF(LoomManager* manager, const uint16_t max_message_len = 120, const uint8_t address = 0, const uint8_t data_rate = 1, const uint8_t power_level = 0, const uint8_t retry_count = 3, const uint16_t retry_timeout = 200, const uint8_t multicast_level = 1)
nRF module constructor
Loom_nRF(LoomManager* manager, JsonArrayConst p)
Constructor that takes Json Array, extracts args and delegates to regular constructor.
~Loom_nRF()
Destructor.

OPERATION

void add_config(JsonObject json) override
Add configuration information to JsonObject.

GETTERS

auto get_address() const -> uint8_t override
Get the address of this device.
auto get_multicast_level() const -> uint8_t
Get multicast(broadcast) level.

SETTERS

void set_address(const uint8_t a) override
Set the address of this device.
void set_multicast_level(const uint8_t level)
Set multicast(broadcast) level.

Function documentation

bool Loom_nRF::receive_blocking_impl(JsonObject json, uint max_wait_time) override protected

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 (can be zero for non-blocking)
Returns True if packet received

bool Loom_nRF::send_impl(JsonObject json, const uint8_t destination) override 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 Loom_nRF::broadcast_impl(JsonObject json) override 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

Loom_nRF::Loom_nRF(LoomManager* manager, const uint16_t max_message_len = 120, const uint8_t address = 0, const uint8_t data_rate = 1, const uint8_t power_level = 0, const uint8_t retry_count = 3, const uint16_t retry_timeout = 200, const uint8_t multicast_level = 1)

nRF module constructor

Parameters
manager
max_message_len in Set(Int) | <120> | {120("Max length")} | The maximum possible message length
address in Int | <01> | [0-99] | This device's nRF address
data_rate in Set(Int) | <0> | {0("Default"), 1("250KBPS"), 2("1MBPS"), 3("2MBPS")} | Transmission data rate
power_level in Set(Int) | <0> | {0("Default"), 1("Min"), 2("Low"), 3("High"), 4("Max")} | Transmission ower level
retry_count in Int | <3> | [0-15] | Max number of transmission retries
retry_timeout in Int | <200> | [20-500] | Delay between retransmissions (ms)
multicast_level in Int | <1> | [1-3] | How many levels to propogate message through heirarchy

Loom_nRF::Loom_nRF(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

void Loom_nRF::add_config(JsonObject json) override

Add configuration information to JsonObject.

Parameters
json in Json configuration object to add to

LoomManager iterates over modules to build complete configuration

uint8_t Loom_nRF::get_address() const override

Get the address of this device.

Returns The address of this device

Each platform may have a different addressing scheme

uint8_t Loom_nRF::get_multicast_level() const

Get multicast(broadcast) level.

Returns Multicast level

nRF has varying degrees of broadcast corresponding to depth to broadcast through network tree

void Loom_nRF::set_address(const uint8_t a) override

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.

void Loom_nRF::set_multicast_level(const uint8_t level)

Set multicast(broadcast) level.

Parameters
level in Multicast level to set to

nRF has varying degrees of broadcast corresponding to depth to broadcast through network tree