Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
MCUmgr enum_mgmt API

MCUmgr enum_mgmt API . More...

Macros

#define ENUM_MGMT_ID_COUNT   0
 Command IDs for enumeration management group.
 
#define ENUM_MGMT_ID_LIST   1
 
#define ENUM_MGMT_ID_SINGLE   2
 
#define ENUM_MGMT_ID_DETAILS   3
 

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...
 

Detailed Description

MCUmgr enum_mgmt API .

Macro Definition Documentation

◆ ENUM_MGMT_ID_COUNT

#define ENUM_MGMT_ID_COUNT   0

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

Command IDs for enumeration management group.

◆ ENUM_MGMT_ID_DETAILS

#define ENUM_MGMT_ID_DETAILS   3

◆ ENUM_MGMT_ID_LIST

#define ENUM_MGMT_ID_LIST   1

◆ ENUM_MGMT_ID_SINGLE

#define ENUM_MGMT_ID_SINGLE   2

Enumeration Type Documentation

◆ enum_mgmt_err_code_t

#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.