nrf24network.h

Go to the documentation of this file.

#ifndef NRF24NETWORK_H
#define NRF24NETWORK_H

typedef void (*nrf24_handler_fn_t)(uint8_t * data, uint8_t len, uint8_t from);

typedef union {
    uint16_t word; 
    uint8_t b[2];
    struct {
        uint16_t to_leaf: 3;
        uint16_t to_branch: 3;
        uint16_t from_leaf: 3;
        uint16_t from_branch: 3;
        uint16_t multi_msg: 1;
        uint16_t msg_len: 3; 
    };
    struct {
        uint16_t to: 6;
        uint16_t from: 6;
        uint16_t reserved: 4;
    };
} nrfnet_address_t;

#define NRF24_CHANNEL_BRANCH_1 30
#define NRF24_CHANNEL_BRANCH_2 34
#define NRF24_CHANNEL_BRANCH_3 38
#define NRF24_CHANNEL_BRANCH_4 42
#define NRF24_CHANNEL_BRANCH_5 46
#define NRF24_CHANNEL_BRANCH_6 50

#define NRF24_ADDRESS_MASK 0x6C6C6C7800

#define NRF24_MIN_WINDOW_MS 200 //TODO change this to 4
#define NRF24_BRANCH_WINDOW_MS 100 //TODO change this to 4
#define NRF24_TICK_MS 10 //TODO change this to 1
#define NRF24_MISSING_NODE_TIMEOUT 500

// The third payload byte (after the two address bytes) will be the message ID
enum nrf24_msg_id {
    SYSTEM_MSG = 0, 
    CONTROL_MSG, 
    SENSOR_MSG, 
    CHAT_MSG, 
    CHAT_TEA_MSG, 
    CHAT_RSA_MSG, 
    ENIGMA_MSG, 
    BOMBERMAN_MSG, 
    IR_REMOTE_MSG, 
    DRUM_MSG, 
    PONG_MSG, 
    RGB_MATRIX_MSG, 
    WHEEL_LIGHT_MSG, 
    SNAKE_MSG, 
    TEST_MSG, 
    LAST_MSG_ID 
};

enum nrf24_system_msg {
    NULL_MSG = 0
};

// The fourth payload byte of control messages will be a control message sub-ID
enum nrf24_control_msg {
    ONBOARD_LED,
    LINEAR_ACTUATOR,
    COFFEE_POT,
    TOASTER,
    LAST_CONTROL_ID 
};

// The fourth payload byte of sensor messages will be a sensor message sub-ID
enum nrf24_sensor_msg {
    TEMPERATURE_SENSOR,
    SPEED_SENSOR,
    TORQUE_SENSOR,
    LAST_SENSOR_ID 
};

enum nrf24_address {
    // assign fixed node addresses
    MASTER = 0x00,
    LECAKES = 0x08,
    ALEYAN,
    AMRITKAR,
    CANDELARIA,
    CARLUCCIO,
    DONOW,
    LECAKES_ALL = 0x0F,
    BLAZEJEWSKI = 0x10,
    HAAS,
    HARRIS,
    HENSHAW,
    JACOBSEN,
    KLODNICKI,
    BLAZEJEWSKI_ALL = 0x17,
    MORRIS = 0x18,
    LABARCK,
    LIU,
    RITCHIE_III,
    RUPP,
    RUSSO,
    MORRIS_ALL = 0x1F,
    TRAFFORD = 0x20,
    WHALEN,
    WIBLE,
    MACCARONE,
    VOTTA,
    TRAFFORD_ALL = 0x27,
    MERLINO = 0x28,
    GOODMAN,
    MUHLBAIER,
    LAST_ADDRESS,
    ALL_ALL = 0x3F
};

enum nrfstate_e {
        NRFNET_INITIALIZED = 0x00,
        NRFNET_NORMAL_STATE = 0x00,
        NRFNET_WAITING_FOR_MIN_WINDOW
    };
    
enum nrfrole_e {ROLE_MASTER, ROLE_BRANCH, ROLE_LEAF};

enum pipe_status_e {
    CHILD_INITIALIZED,
    CHILD_ACTIVE,
    CHILD_MISSING
};

typedef struct {
    uint8_t length; 
    uint8_t child; // child 0xFF means unused buffer slot
    uint8_t age; // how long this msg has been on the buffer (relative, 0 is newest)
    uint8_t data[32];
} nrfnet_msg_t;

#define NRFNET_MSG_BUFFER_LENGTH 16
typedef struct nrfnet_s {
    nrf24_t radio;
    uint8_t sys_id;
    uint8_t node;
    char name[5];
    enum nrfrole_e role;
    enum nrfstate_e state;
    volatile uint8_t current_child;
    tint_t child_time[6];
    tint_t switch_to_tx_time;
    enum pipe_status_e child_status[6];
    uint8_t channel[6];
    nrfnet_msg_t msg_buf[NRFNET_MSG_BUFFER_LENGTH];
    nrf24_handler_fn_t handler[LAST_MSG_ID];
    nrf24_handler_fn_t control_handler[LAST_CONTROL_ID];
    nrf24_handler_fn_t sensor_handler[LAST_SENSOR_ID];
} nrfnet_t;

void nrf24_NetworkInit(void (*ce)(uint8_t), void (*csn)(uint8_t), uint8_t spi_channel);
void nrf24_NetworkInitN(nrfnet_t * net, void (*ce)(uint8_t), void (*csn)(uint8_t), uint8_t spi_channel, uint8_t node);

void nrf24_RegisterMsgHandler(enum nrf24_msg_id msg_id, nrf24_handler_fn_t fn_ptr);
void nrf24_RegisterMsgHandlerN(nrfnet_t * net, enum nrf24_msg_id msg_id, nrf24_handler_fn_t fn_ptr);

void nrf24_SendMsg(uint8_t to, enum nrf24_msg_id msg_id, uint8_t * data, uint8_t len);
void nrf24_SendMsgN(nrfnet_t * net, uint8_t to, enum nrf24_msg_id msg_id, uint8_t * data, uint8_t len);

void nrf24_RegisterControlHandler(enum nrf24_control_msg control_id, nrf24_handler_fn_t fn_ptr);
void nrf24_RegisterControlHandlerN(nrfnet_t * net, enum nrf24_control_msg control_id, nrf24_handler_fn_t fn_ptr);

void nrf24_RegisterSensorHandler(enum nrf24_sensor_msg sensor_id, nrf24_handler_fn_t fn_ptr);
void nrf24_RegisterSensorHandlerN(nrfnet_t * net, enum nrf24_sensor_msg sensor_id, nrf24_handler_fn_t fn_ptr);

void nrf24_NetworkISRHandler(void);
#define nrf24_NetworkISRHandlerN(net) nRF24_ISR(&net.radio)

char * NameFromAddress(uint8_t address);

uint8_t AddressFromName(char * name);

// possible additions:
// - add method to send a control message
// - add method to request sensor data
// - add method to support automatic response of sensor data request
// - add network level nack for undeliverable packets

#endif  /* NRF24NETWORK_H */