BM_StatTypeDef enumeration reference

BMAPI 1.14.0.42 · bm_usb_def.h

Definition

typedef enum
{
    BM_STAT_NONE = 0U,
    BM_STAT_TX_MESSAGE,
    BM_STAT_RX_MESSAGE,
    BM_STAT_TX_BYTE,
    BM_STAT_RX_BYTE,
    BM_STAT_TX_ERROR,
    BM_STAT_RX_ERROR,
    BM_STAT_TOTAL_STORAGE_SIZE_KB,
    BM_STAT_FREE_STORAGE_SIZE_KB,
    BM_STAT_TXQ_BYTE,
    BM_STAT_RXQ_BYTE,
    BM_STAT_REPLAYQ_BYTE,
    BM_STAT_LOGGINGQ_BYTE,
    BM_STAT_REPLAYFILE_BYTE,
    BM_STAT_LOGGINGFILE_BYTE,
    BM_STAT_TXQ_MAXSIZE_BYTE,
    BM_STAT_RXQ_MAXSIZE_BYTE,
    BM_STAT_REPLAYQ_MAXSIZE_BYTE,
    BM_STAT_LOGGINGQ_MAXSIZE_BYTE,
    BM_STAT_REPLAYFILE_MAXSIZE_BYTE,
    BM_STAT_LOGGINGFILE_MAXSIZE_BYTE,
    BM_STAT_CAP = 0x40U,
    BM_STAT_MAX_RXFILTER,
    BM_STAT_MAX_TXTASK,
    BM_STAT_MAX_MESSAGE_INFO,
    BM_STAT_MAX_SIGNAL_INFO,
    BM_STAT_MAX_E2E_INFO,
    BM_STAT_MAX_ROUTE,
    BM_STAT_SUPPORT_OFFLINE = 0x60U,
    BM_STAT_SUPPORT_ROUTE,
    BM_STAT_SUPPORT_LOGGING,
    BM_STAT_SUPPORT_REPLAY,
    BM_SUPPORT_BUFFER_API,
    BM_SUPPORT_FATFS_API,
} BM_StatTypeDef;

CAN runtime statistics item IDs, used in BM_GetStat().

Enumeration values

Name	Value expression	Description
BM_STAT_NONE	0U	Invalid statistics item
BM_STAT_TX_MESSAGE	Implicit increment; see definition	Number of TX messages
BM_STAT_RX_MESSAGE	Implicit increment; see definition	Number of RX messages
BM_STAT_TX_BYTE	Implicit increment; see definition	Number of TX bytes
BM_STAT_RX_BYTE	Implicit increment; see definition	Number of RX bytes
BM_STAT_TX_ERROR	Implicit increment; see definition	Number of TX errors
BM_STAT_RX_ERROR	Implicit increment; see definition	Number of RX errors
BM_STAT_TOTAL_STORAGE_SIZE_KB	Implicit increment; see definition	Offline storage total size (kB)
BM_STAT_FREE_STORAGE_SIZE_KB	Implicit increment; see definition	Offline storage free size (kB)
BM_STAT_TXQ_BYTE	Implicit increment; see definition	Current used size of TXQ, in bytes
BM_STAT_RXQ_BYTE	Implicit increment; see definition	Current used size of RXQ, in bytes
BM_STAT_REPLAYQ_BYTE	Implicit increment; see definition	Current used size of REPLAYQ, in bytes
BM_STAT_LOGGINGQ_BYTE	Implicit increment; see definition	Current used size of LOGGINGQ, in bytes
BM_STAT_REPLAYFILE_BYTE	Implicit increment; see definition	Current size of replay file, in bytes
BM_STAT_LOGGINGFILE_BYTE	Implicit increment; see definition	Current size of logging file, in bytes
BM_STAT_TXQ_MAXSIZE_BYTE	Implicit increment; see definition	Max acceptable size of TXQ, in bytes
BM_STAT_RXQ_MAXSIZE_BYTE	Implicit increment; see definition	Max acceptable size of RXQ, in bytes
BM_STAT_REPLAYQ_MAXSIZE_BYTE	Implicit increment; see definition	Max acceptable size of REPLAYQ, in bytes
BM_STAT_LOGGINGQ_MAXSIZE_BYTE	Implicit increment; see definition	Max acceptable size of LOGGINGQ, in bytes
BM_STAT_REPLAYFILE_MAXSIZE_BYTE	Implicit increment; see definition	Max acceptable size of replay file, in bytes
BM_STAT_LOGGINGFILE_MAXSIZE_BYTE	Implicit increment; see definition	Max acceptable size of logging file, in bytes
BM_STAT_CAP	0x40U	No description in the source documentation.
BM_STAT_MAX_RXFILTER	Implicit increment; see definition	Max allowed RX filter count
BM_STAT_MAX_TXTASK	Implicit increment; see definition	Max allowed TX Task count
BM_STAT_MAX_MESSAGE_INFO	Implicit increment; see definition	Max allowed Router message count
BM_STAT_MAX_SIGNAL_INFO	Implicit increment; see definition	Max allowed Router signal count
BM_STAT_MAX_E2E_INFO	Implicit increment; see definition	Max allowed Router E2E count
BM_STAT_MAX_ROUTE	Implicit increment; see definition	Max allowed Router route count
BM_STAT_SUPPORT_OFFLINE	0x60U	This device supports offline storage of configuration info
BM_STAT_SUPPORT_ROUTE	Implicit increment; see definition	This device supports message route
BM_STAT_SUPPORT_LOGGING	Implicit increment; see definition	This device supports logging CAN traffic into offline storage
BM_STAT_SUPPORT_REPLAY	Implicit increment; see definition	This device supports replaying CAN traffic from offline storage
BM_SUPPORT_BUFFER_API	Implicit increment; see definition	No description in the source documentation.
BM_SUPPORT_FATFS_API	Implicit increment; see definition	No description in the source documentation.

---

Source: BMAPI 1.14.0.42 released Doxygen documentation. The headers and help files bundled with an installed SDK define its version-specific contract.