Zephyr Project API 4.2.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Enumeration Management

MCUmgr Enumeration Management API. More...

Modules

 Enumeration Management Callbacks
 MCUmgr Enumeration Management Callbacks API.
 

Enumerations

enum  enum_mgmt_err_code_t {
  ENUM_MGMT_ERR_OK = 0 , ENUM_MGMT_ERR_UNKNOWN , ENUM_MGMT_ERR_TOO_MANY_GROUP_ENTRIES , ENUM_MGMT_ERR_INSUFFICIENT_HEAP_FOR_ENTRIES ,
  ENUM_MGMT_ERR_INDEX_TOO_LARGE
}
 Command result codes for enumeration management group. More...
 

Command IDs for enumeration management group.

#define ENUM_MGMT_ID_COUNT   0
 Count of supported groups.
 
#define ENUM_MGMT_ID_LIST   1
 List supported groups.
 
#define ENUM_MGMT_ID_SINGLE   2
 Fetch single group ID.
 
#define ENUM_MGMT_ID_DETAILS   3
 Details on supported groups.
 

Detailed Description

MCUmgr Enumeration Management API.

Macro Definition Documentation

◆ ENUM_MGMT_ID_COUNT

#define ENUM_MGMT_ID_COUNT   0

#include <include/zephyr/mgmt/mcumgr/grp/enum_mgmt/enum_mgmt.h>

Count of supported groups.

◆ ENUM_MGMT_ID_DETAILS

#define ENUM_MGMT_ID_DETAILS   3

#include <include/zephyr/mgmt/mcumgr/grp/enum_mgmt/enum_mgmt.h>

Details on supported groups.

◆ ENUM_MGMT_ID_LIST

#define ENUM_MGMT_ID_LIST   1

#include <include/zephyr/mgmt/mcumgr/grp/enum_mgmt/enum_mgmt.h>

List supported groups.

◆ ENUM_MGMT_ID_SINGLE

#define ENUM_MGMT_ID_SINGLE   2

#include <include/zephyr/mgmt/mcumgr/grp/enum_mgmt/enum_mgmt.h>

Fetch single group ID.

Enumeration Type Documentation

◆ enum_mgmt_err_code_t

#include <include/zephyr/mgmt/mcumgr/grp/enum_mgmt/enum_mgmt.h>

Command result codes for enumeration management group.

Enumerator
ENUM_MGMT_ERR_OK 

No error, this is implied if there is no ret value in the response.

ENUM_MGMT_ERR_UNKNOWN 

Unknown error occurred.

ENUM_MGMT_ERR_TOO_MANY_GROUP_ENTRIES 

Too many entries were provided.

ENUM_MGMT_ERR_INSUFFICIENT_HEAP_FOR_ENTRIES 

Insufficient heap memory to store entry data.

ENUM_MGMT_ERR_INDEX_TOO_LARGE 

Provided index is larger than the number of supported grouped.