mesh.h

Go to the documentation of this file.

/*
 *     SocialLedge.com - Copyright (C) 2013
 *
 *     This file is part of free software framework for embedded processors.
 *     You can use it and/or distribute it as long as this copyright header
 *     remains unmodified.  The code is free for personal use and requires
 *     permission to use in a commercial product.
 *
 *      THIS SOFTWARE IS PROVIDED "AS IS".  NO WARRANTIES, WHETHER EXPRESS, IMPLIED
 *      OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 *      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
 *      I SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL, OR
 *      CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 *
 *     You can reach the author of this software at :
 *          p r e e t . w i k i @ g m a i l . c o m
 */

#ifndef MESH_NET_H__
#define MESH_NET_H__
#ifdef __cplusplus
extern "C"
{
#endif
#include "mesh_typedefs.h"



bool mesh_init(const uint8_t local_node_id, const bool is_mesh_node, const char *node_name,
               const mesh_driver_t driver,  const bool discovery);

bool mesh_set_node_address(const uint8_t local_node_id);
uint8_t mesh_get_node_address(void); 

void mesh_set_retry_count(const uint8_t count);

void mesh_service(void);

bool mesh_send(const uint8_t dst, const mesh_protocol_t type,
               const void* pData, const uint8_t len,
               const uint8_t hop_count_max);

bool mesh_form_pkt(mesh_packet_t *pkt, const uint8_t dst,
                   const mesh_protocol_t type, const uint8_t hop_count_max,
                   uint8_t num_ptrs, ...);

bool mesh_send_formed_pkt(mesh_packet_t *pkt);

bool mesh_deform_pkt(mesh_packet_t *pkt, uint8_t num_ptrs, ...);


static inline bool mesh_is_ack_required(const mesh_packet_t* pPacket)
{
    return (mesh_pkt_ack_app == pPacket->info.pkt_type);
}

static inline bool mesh_is_ack_ok(const mesh_packet_t* pRxPkt, const uint8_t sentDstAddr)
{
    return (mesh_pkt_ack_rsp == pRxPkt->info.pkt_type && pRxPkt->nwk.src == sentDstAddr);
}

static inline bool mesh_send_ack(char* pData, uint8_t len, const mesh_packet_t* p_orig_pkt)
{
    /* Response needs to be NACK otherwise loop of ACKs will occur */
    return mesh_send(p_orig_pkt->nwk.src, mesh_pkt_ack_rsp, pData, len, p_orig_pkt->info.hop_count_max);
}

const mesh_rte_table_t* mesh_get_routing_entry(const uint8_t route_num);

uint8_t mesh_get_num_routing_entries(void);

bool mesh_is_route_known(const uint8_t addr);

uint8_t mesh_get_pnd_pkt_count(void);

uint32_t mesh_get_expected_ack_time(uint8_t node_addr);

uint32_t mesh_get_max_timeout_before_packet_fails(uint8_t node_addr);

mesh_error_mask_t mesh_get_error_mask(void); 
void mesh_reset_error_mask(void);            

#if MESH_USE_STATISTICS

mesh_stats_t mesh_get_stats(void);
#endif



#ifdef __cplusplus
}
#endif
#endif /* MESH_NET_H__ */