Macros
|
|
Name |
Description |
 |
COMM_INTERVAL defines communication interval in symbols of protocol services communications. An incomplete list of protocol services that use COMM_INTERVAL are FAMILY_TREE_REPORT, ROUTING_TABLE_REPORT and CHANNLE_HOPPING_REQUEST. | |
|
|
COMM_RSSI_THRESHOLD defines the minimum signal strength that is acceptable for a Coordinator to route messages through. A neighbor Coordinator that has signal strength that is higher than this threshold can be list as neighbor to be able to route message. This setting usually is related to the signal strength interpretation for the specific RF transceiver. This value is represented by BYTE with 8-bit data width, thus should be less than 256. | |
|
|
ENABLE_MIWI_PRO_ACKNOWLEDGEMENT enables the MiWi PRO stack to send back an acknowledgement packet when a MiWi PRO data packet for application is received. This process will be handled automatically in the stack without application layer involvement. MiWi PRO acknowledgement is ack in network layer. It may be sent across multiple hops and should be differiented with MAC ack. When message is sent to a sleeping device, the MiWi PRO acknowledgemnt will be received later and notified by call back function MiApp_CB_RFDAcknowledgement. Otherwise, whether receive MiWi PRO acknowledgement will be used to notify application layer if transmission is successful. | |
|
|
ENABLE_ROUTING_UPDATE enables the Coordinator capble device to periodically send out Routing Table Report to update the routing table. The interval of sending out routing table is defined as ROUTING_UPDATE_INTERVAL | |
|
|
ENABLE_BROADCAST_TO_SLEEP_DEVICE enables messages broadcast to a sleeping device. | |
|
|
FA_COMM_INTERVAL defines the time interval between broadcasting the frequency agility related message for FA_BROADCAST_TIME times. To leave granularity for the protocol runs smoothly, it is recommended to set this timeout higher than a half second. | |
|
|
FA_MAX_NOISE_THRESHOLD defines the maximum noise level that a Coordinator accepts for a channel to avoid sending out Frequency Agility Against Channel protocol service when a new channel is proposed by PAN Coordinator to hop to during frequency agility operation. This setting usually is related to the signal strength interpretation for the specific RF transceiver. This value is represented by BYTE with 8-bit data width, thus should be less than 256. | |
|
|
FA_WAIT_TIMEOUT defines the timeouts in symbols during the frequency agility process. Those timeouts include timeout for all Coordinators to start energy scan; timeout for the PAN Coordinator to receive Frequency Agility Against Channel protocol service after a channel is suggested and timeout for all devices to jump to the new channel after receiving Frequency Agility Change Channel protocol service. To leave granularity for the protocol runs smoothly, it is recommended to set this timeout higher than 1 second. | |
|
|
FAMILY_TREE_BROADCAST defines the number of broadcasts for Family Tree Report protocol service after a Coordinator joins the network. To ensure delivery of the Family Tree table, it is recommended to set this value higher than 1. | |
|
|
MIWI_PRO_ACK_TIMEOUT is the timeout period in symbols for a node to receive a MiWi PRO network layer acknowledgement. This parameter is for MiWi PRO network layer, not for MAC layer. MAC layer acknowledgement timeout is handled in MiMAC layer. | |
|
|
NUM_COORDINATOR defines the maximum number of Coordinators that the network can support. The possible numbers are 8, 16, 32 and 64. NUM_COORDINAOTR definition is closedly associated with RAM and NVM resources | |
|
|
PACKET_RECORD_SIZE is the parameter that specifies the maximum number of packet record available. Packet record is used to track the broadcast messages so that the wireless node knows if the same packet has been received before. | |
|
|
PACKET_RECORD_TIMEOUT defines the timeout in symbols for a node to expire its packet record. The packet record is used to track the received broadcast message and to prevent receiving duplicate broadcast message. This definition is only valid for a non-sleeping device. | |
|
|
RANDOM_DELAY_RANGE defines random delay range in milliseconds. When rebroadcast a message, it is recommended that a Coordinator should introduce a random delay to avoid multiple Coordinators rebroadcast and collide the messages at the same time. The actual random delay will be randomly selected between 0 and RANDOM_DELAY_RANGE. This setting is recommended to be set higher than 20. The value is represented by BYTE with 8-bit data width, thus should be less than 256. | |
|
|
ROUTING_UPDATE_INTERVAL defines the interval in symbols that the Coordinator capable device to send out Routing Table Report. This definition is only effective if ENABLE_ROUTING_UPDATE is defined. | |
|
|
ROUTING_UPDATE_EXPIRATION defines the valid link expired after times of ROUTING_UPDATE_INTERVAL without receiving Routing Table Report. If this parameter is defined as 3, a link will becomes invalid after (3 * ROUTING_UPDATE_INTERVAL) symbols if no Routing Table Report is received from the other side of the link. | |
|
|
ROUTING_TABLE_BROADCAST defines the number of broadcasts for Routing Table Report. To ensure routing table accuracy on all coordinators, it is recommended to set this value higher than 1. |