meshConfig.h

Go to the documentation of this file.

 
#ifndef INC_MESHCONFIG_H_
#define INC_MESHCONFIG_H_
 
#ifndef SIMULATION
    #include <wirish.h>
    #include <Stream.h>
    #define NO_ITOA_S
    #define ITOA _itoa_s
#else
    #include "Simulation.h"
    #define ITOA _itoa_s
#endif
#include <HardwareCRC.h>
#include <ThreadLock.h>
 
#define MESHNET_VERSION (MeshVersion(1,0,0))
 
#define MESHNET_VERSION_txt "1.0.0"
 
// Streams macros - BEGIN
#ifndef ISTREAM
#define ISTREAM Stream                      //Input debug stream
#endif
 
#ifndef OSTREAM
#define OSTREAM Print                       //Output debug stream
#endif
// Streams macros - END
 
// Addresses macros - BEGIN
#define BROADCAST_MESH_ADDRESS (255)
 
#define INVALID_MESH_ADDRESS (254)
 
#define UNKNOWN_MESH_ADDRESS (253)
 
#define MESH_GATEWAY_MAX_ADDRESS (2)
 
#define MAX_MESH_ADDRESS (250)
#define MAX_MESH_ADDRESS_txt "250"              //Text form of MAX_MNODE_ADDRESS
 
#define IS_VALID_MESH_ADDRESS(address) ((address) <= MAX_MESH_ADDRESS && (address) >= 0)
 
#define IS_VALID_MESH_SRC_ADDRESS(address) (IS_VALID_MESH_ADDRESS(address) || (address) == UNKNOWN_MESH_ADDRESS)
 
#define IS_VALID_MESH_DEST_ADDRESS(address) (IS_VALID_MESH_SRC_ADDRESS(address) || (address) == BROADCAST_MESH_ADDRESS)
 
#define IS_VALID_MESH_FROM_ADDRESS(address) (IS_VALID_MESH_SRC_ADDRESS(address))
 
#define IS_VALID_MESH_TO_ADDRESS(address) (IS_VALID_MESH_SRC_ADDRESS(address))
// Addresses macros - END
 
 
// Size macros - BEGIN
#define MESH_PACKET_PAYLOAD_SIZE_LIMIT (512)
#define MESH_PACKET_PAYLOAD_SIZE_LIMIT_txt "512"
 
#define MESH_PING_PAYLOAD_SIZE_LIMIT (MESH_PACKET_PAYLOAD_SIZE_LIMIT-12)
#define MESH_PING_PAYLOAD_SIZE_LIMIT_txt "500"
 
#define MESH_FRAME_SIZE_LIMIT (128)
 
#define MESH_FRAME_SIZE_MIN_LIMIT (24)
// Size macros - END
 
 
// Buffers macros - BEGIN
#define DHCPTABLE_SIZE (MAX_MESH_ADDRESS+1)     //Size of DHCP table has to be same as maximum address value + 1, because index of this table is node address
#define DHCPTABLE_SIZE_txt "251"                //Size of DHCP table in text form. TODO this has to be evaluated each time DHCPTABLE_SIZE or MAX_MESH_ADDRESS is changed
#define DHCPTABLE_VALID_ROW_LIFETIME (86400000UL)       //Time, until DHCPTable row is valid. After this time, it is invalid, but still reserved.
#define DHCPTABLE_ROW_RAW_LIFETIME_RESERVED (127)   //If DHCP tables's row raw life time is under this value (raw lifetime can be from 0 to 255), record will be no longer valid.
                                                    //This settings helps to prevent assign address, which was unassigned a moment ago, to be assigned to another node,
                                                    //because some nodes in network may not know if this address was unassigned from node.
#define DHCPTABLE_ROW_LIFETIME (DHCPTABLE_VALID_ROW_LIFETIME + (DHCPTABLE_VALID_ROW_LIFETIME*(255ULL - DHCPTABLE_ROW_RAW_LIFETIME_RESERVED))/DHCPTABLE_ROW_RAW_LIFETIME_RESERVED)   //MAX Lifetime of each row in RouteTable in milliseconds.
 
#define ROUTETABLE_SIZE (64)                    //Maximum number of routes (including routes to neighbors and gateways)
#define ROUTETABLE_SIZE_txt "64"                //Size of route table in text form.
#define ROUTETABLE_MAX_IND_txt "63"             //Maximum index in route table
#define ROUTETABLE_ROW_LIFETIME (30UL * 60UL * 1000UL)  //MAX Lifetime of each row in RouteTable in milliseconds.
 
#define IDTABLE_SIZE (64)                       //Size of ID table.
#define IDTABLE_SIZE_txt "64"                   //Size of ID table in text form.
#define IDTABLE_MAX_IND_txt "63"                //Maximum index in ID table
#define IDTABLE_ROW_LIFETIME (5UL * 60UL * 1000UL)      //MAX Lifetime of each row in ID table in milliseconds.
 
#define FIDTABLE_SIZE (8)                       //Size of FID table.
#define FIDTABLE_SIZE_txt "8"                   //Size of FID table in text form.
#define FIDTABLE_MAX_IND_txt "7"                //Maximum index in FID table
#define FIDTABLE_ROW_LIFETIME (5UL * 60UL * 1000UL)     //MAX Lifetime of each row in FID table in milliseconds.
 
#define OIDTABLE_SIZE (64)                      //Size of output ID table.
#define OIDTABLE_SIZE_txt "64"                  //Size of output ID table in text form.
#define OIDTABLE_MAX_IND_txt "63"               //Maximum index in OID table
#define OIDTABLE_ROW_LIFETIME (127500UL)        //MAX Lifetime of each row in output ID table in milliseconds.
 
#define MESH_OFIFO_HIGH_SIZE (3)                //Size of output packet FIFO buffer with high priority.
#define MESH_OFIFO_LOW_SIZE (4)                 //Size of output packet FIFO buffer with low priority.
#define MESH_WFIFO_SIZE (8)                     //Size of waiting packet FIFO buffer.
 
#ifdef SIMULATION
#define MESH_INST_ARRAY_SIZE instArrSize
#else
#define MESH_INST_ARRAY_SIZE (2)                //Size of instance array. This array stores all created instances of current class. Number of created instances of MeshNet in this program cannot exceed this number.
#endif //SIMULATION
 
// Buffers macros - END
 
 
// Timing macros - BEGIN
#define MESH_NEXT_FRAME_TIMEOUT (40)
 
#define MESH_ROUTE_RETR_TIME (50)
 
#define MESH_FRAME_SEND_DELAY (15)
 
#define MESH_ACK_CTS_TIME (15000)
 
#define MESH_FRAME_CTS_TIME (20000)
 
#define MESH_RANDOM_ROUTED_CTS_TIME (5000)
 
#define MESH_RANDOM_UNROUTED_CTS_TIME (10000)
 
#define MESH_PATH_DISC_TIMEOUT (5000)
// Timing macros - END
 
 
 
// Settings macros - BEGIN
#define MESH_HOP_RELAY_LIMIT (25)
 
#define MESH_ROUTE_RETR_CNT (4)
 
#define MESH_FLOOD_RETR_CNT (1)
 
#define MESH_RSSI_THRESHOLD (-70)
 
#define MESH_PROCESS_RECV_FRAMES_AT_ONCE_MAX_LIMIT (3)
 
#if !defined(SIMULATION)
 
#define MESH_IMPL_CONSOLE_ITEM (1)
#else
#define MESH_IMPL_CONSOLE_ITEM (0) //Disabled in simulation
#endif // !SIMULATION
 
//#define MESH_NO_STATISTICS
 
// Settings macros - END
 
 
// Connect settings macros - BEGIN
 
#define MESH_SYS_NET_SCAN_TIMEOUT (1500)
 
#define MESH_CONNECT_TIMEOUT (7500)
 
#define MESH_DISCONNECT_TIMEOUT (5000)
 
#define MESH_REQ_DISCONNECT_TIMEOUT (7500)
 
#define MESH_CONNECT_REQ_TIMEOUT (MESH_CONNECT_TIMEOUT - MESH_SYS_NET_SCAN_TIMEOUT)
 
// Connect setting macros - END
 
#endif /* INC_MESHCONFIG_H_ */