RF24Mesh.h

Go to the documentation of this file.

 
#ifndef __RF24MESH_H__
#define __RF24MESH_H__
 
#include <stdio.h>
#include <stdlib.h>
 
// Network ACK types
// None defined
 
// No Network ACK types
#define MESH_ADDR_LOOKUP  196
#define MESH_ADDR_RELEASE 197
#define MESH_ID_LOOKUP    198
 
#define MESH_BLANK_ID 65535
 
#if defined(__AVR_ATtiny85__) || defined(__AVR_ATtiny84__)
    #define RF24_TINY
#endif
 
#include "RF24Mesh_config.h"
 
#if defined(__linux) && !defined(__ARDUINO_X86__) && !defined(USE_RF24_LIB_SRC)
    #include <RF24/RF24.h>
    #include <RF24Network/RF24Network.h>
    #define RF24_LINUX
#else
    #include <RF24.h>
    #include <RF24Network.h>
    #if defined(ARDUINO_ARCH_NRF52) || defined(ARDUINO_ARCH_NRF52840)
        #include <nrf_to_nrf.h>
    #endif
#endif
 
#include <stddef.h>
#include <stdint.h>
 
class RF24;
#if defined(ARDUINO_ARCH_NRF52) || defined(ARDUINO_ARCH_NRF52840) || defined(ARDUINO_ARCH_NRF52833)
class nrf_to_nrf;
#endif
 
template<class radio_t>
class ESBNetwork;
 
template<class network_t = ESBNetwork<RF24>, class radio_t = RF24>
class ESBMesh
{
public:
    ESBMesh(radio_t& _radio, network_t& _network);
 
    bool begin(uint8_t channel = MESH_DEFAULT_CHANNEL, rf24_datarate_e data_rate = RF24_1MBPS, uint32_t timeout = MESH_RENEWAL_TIMEOUT);
 
    uint8_t update();
 
    bool write(const void* data, uint8_t msg_type, size_t size, uint8_t nodeID = 0);
 
    void setNodeID(uint8_t nodeID);
 
    uint16_t renewAddress(uint32_t timeout = MESH_RENEWAL_TIMEOUT);
 
#if !defined(MESH_NOMASTER)
    void DHCP();
 
#endif
 
    int16_t getNodeID(uint16_t address = MESH_BLANK_ID);
 
    bool checkConnection();
 
    bool releaseAddress();
 
    uint16_t mesh_address;
 
    int16_t getAddress(uint8_t nodeID);
 
    bool write(uint16_t to_node, const void* data, uint8_t msg_type, size_t size);
 
    void setChannel(uint8_t _channel);
 
    void setChild(bool allow);
 
    void setCallback(void (*meshCallback)(void));
 
#define MESH_CALLBACK \
    if (meshCallback) meshCallback();
 
    void setAddress(uint8_t nodeID, uint16_t address, bool searchBy = false);
 
#if !defined(MESH_NOMASTER)
    void saveDHCP();
 
    void loadDHCP();
 
    void setStaticAddress(uint8_t nodeID, uint16_t address);
 
#endif // !defined(MESH_NOMASTER)
    uint8_t _nodeID;
 
#if !defined(MESH_NOMASTER)
    typedef struct
    {
        uint8_t nodeID;
        uint16_t address;
    } addrListStruct;
 
    // Pointer used for dynamic memory allocation of address list
    addrListStruct* addrList;
    uint8_t addrListTop;
 
    bool releaseAddress(uint16_t address);
#endif
private:
    radio_t& radio;
    network_t& network;
 
    void (*meshCallback)(void);
 
    bool requestAddress(uint8_t level);
 
#if !defined(MESH_NOMASTER)
    bool doDHCP;
    bool addrMemAllocated;
#endif
 
    void beginDefault();
    bool meshStarted;
    uint8_t getLevel(uint16_t address);
};
 
typedef ESBMesh<ESBNetwork<RF24>, RF24> RF24Mesh;
#if defined(ARDUINO_ARCH_NRF52) || defined(ARDUINO_ARCH_NRF52840) || defined(ARDUINO_ARCH_NRF52833)
typedef ESBMesh<ESBNetwork<nrf_to_nrf>, nrf_to_nrf> RF52Mesh;
#endif
 
#endif // define __RF24MESH_H__