embenet_node_trace.h File Reference

Table of contents Table of contents

embeNET Node Trace API More...

Data Structures
struct	EMBENET_TRACE_LinkLayerTelemetry

struct	EMBENET_NODE_TraceHandlers
	structure describing all callbacks, set to NULL to deactivate More...

Typedefs
typedef void(*	EMBENET_TRACE_Started) (uint64_t eui)
	Called immediately stack started. More...

typedef void(*	EMBENET_TRACE_Synchronized) (uint16_t panid)
	Called immediately after synchronization event. More...

typedef void(*	EMBENET_TRACE_Desynchronized) (void)
	Called immediately after desynchronization event. More...

typedef void(*	EMBENET_TRACE_PacketNoAck) (uint64_t linkLocalDestinationEui, uint64_t destinationEui, uint8_t attempt)
	Called when transmission was not successful. More...

typedef void(*	EMBENET_TRACE_ManagedPacketNoAck) (uint64_t linkLocalDestinationEui)
	Called when managed transmission was not successful. More...

typedef void(*	EMBENET_TRACE_PacketNotDelivered) (uint64_t linkLocalDestinationEui, uint64_t destinationEui)
	Called when all transmission attempts were unsuccessful and packet was discarded. More...

typedef void(*	EMBENET_TRACE_Joined) (uint64_t parentEui)
	Called after connection to target parent is established: More...

typedef void(*	EMBENET_TRACE_SyncCorrection) (int32_t us)
	Called every time node synchronizes to it's time source. More...

typedef void(*	EMBENET_TRACE_ParentSelected) (uint64_t parentEui)
	Called after parent is selected as new parent. More...

typedef void(*	EMBENET_TRACE_ParentLost) (uint64_t parentEui)
	Called after parent is considered lost: More...

typedef void(*	EMBENET_TRACE_NeighborAdded) (uint64_t neighborEui, int8_t rssi)
	Called every time a new neighbor is added to node's registry. More...

typedef void(*	EMBENET_TRACE_NeighborRemoved) (uint64_t neighborEui)
	Called every time a new neighbor is removed from node's registry. Neighbor may be removed due to long inactivity time or lack of space in registry. More...

typedef void(*	EMBENET_TRACE_RankUpdate) (uint16_t rank)
	Called every time node's rank in changed. More...

typedef void(*	EMBENET_TRACE_QueueLength) (size_t length)
	Called every time a packet count in packet buffer is changed. More...

typedef void(*	EMBENET_TRACE_EnmsStatusSent) (void)
	Called every time the ENSM Status Indication Packet was sent. More...

typedef void(*	EMBENET_TRACE_RadioActivity) (bool active)
	Called every time radio is toggled from sleep to active state. More...

typedef void(*	EMBENET_TRACE_SlotStart) (void)
	Called every time radio is toggled from sleep to active state. More...

typedef void(*	EMBENET_TRACE_LinkLayerEvent) (const EMBENET_TRACE_LinkLayerTelemetry *linkLayerTelemetry)
	Called when frame is TXed or RXed. More...

Enumerations
enum	EMBENET_TRACE_CellEvent { EMBENET_TRACE_CELL_EVENT_TX , EMBENET_TRACE_CELL_EVENT_RX }

enum	EMBENET_TRACE_CellRole { EMBENET_TRACE_CELL_ROLE_ADV , EMBENET_TRACE_CELL_ROLE_AUTO_UP , EMBENET_TRACE_CELL_ROLE_AUTO_DOWN , EMBENET_TRACE_CELL_ROLE_AUTO_UPDOWN , EMBENET_TRACE_CELL_ROLE_AUTO_MANAGED }

enum	EMBENET_TRACE_CellType { EMBENET_TRACE_CELL_TYPE_TX , EMBENET_TRACE_CELL_TYPE_RX , EMBENET_TRACE_CELL_TYPE_TXRX }

enum	EMBENET_TRACE_FrameType { EMBENET_TRACE_FRAME_TYPE_BEACON , EMBENET_TRACE_FRAME_TYPE_DATA , EMBENET_TRACE_FRAME_TYPE_ACK }