The latest development version of this page may be more current than this released 3.7.0 version.

Frame statistic

The frame statistic API allows monitoring the number of received frames over different interfaces, and the number of planned and succeeded transmission and relaying attempts.

The API helps the user to estimate the efficiency of the advertiser configuration parameters and the scanning ability of the device. The number of the monitored parameters can be easily extended by customer values.

An application can read out and clean up statistics at any time.

API reference

group bt_mesh_stat

Statistic.

Functions

void bt_mesh_stat_get(struct bt_mesh_statistic *st)

Get mesh frame handling statistic.

Parameters:
  • st – BLE mesh statistic.

void bt_mesh_stat_reset(void)

Reset mesh frame handling statistic.

struct bt_mesh_statistic
#include <statistic.h>

The structure that keeps statistics of mesh frames handling.

Public Members

uint32_t rx_adv

All received frames passed basic validation and decryption.

Received frames over advertiser.

uint32_t rx_loopback

Received frames over loopback.

uint32_t rx_proxy

Received frames over proxy.

uint32_t rx_uknown

Received over unknown interface.

uint32_t tx_adv_relay_planned

Counter of frames that were initiated to relay over advertiser bearer.

uint32_t tx_adv_relay_succeeded

Counter of frames that succeeded relaying over advertiser bearer.

uint32_t tx_local_planned

Counter of frames that were initiated to send over advertiser bearer locally.

uint32_t tx_local_succeeded

Counter of frames that succeeded to send over advertiser bearer locally.

uint32_t tx_friend_planned

Counter of frames that were initiated to send over friend bearer.

uint32_t tx_friend_succeeded

Counter of frames that succeeded to send over friend bearer.