Zephyr API Documentation  3.5.0
A Scalable Open Source RTOS
3.5.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
os_mgmt_client.h File Reference

Go to the source code of this file.

Data Structures

struct  os_mgmt_client
 OS mgmt client object. More...
 

Functions

void os_mgmt_client_init (struct os_mgmt_client *client, struct smp_client_object *smp_client)
 Initialize OS management client.
 
int os_mgmt_client_echo (struct os_mgmt_client *client, const char *echo_string)
 Send SMP message for Echo command.
 
int os_mgmt_client_reset (struct os_mgmt_client *client)
 Send SMP Reset command.
 

Function Documentation

◆ os_mgmt_client_echo()

int os_mgmt_client_echo ( struct os_mgmt_client client,
const char *  echo_string 
)

Send SMP message for Echo command.

Parameters
clientOS mgmt client object
echo_stringEcho string
Returns
0 on success.
mcumgr_err_t code on failure.

◆ os_mgmt_client_init()

void os_mgmt_client_init ( struct os_mgmt_client client,
struct smp_client_object smp_client 
)

Initialize OS management client.

Parameters
clientOS mgmt client object
smp_clientSMP client object

◆ os_mgmt_client_reset()

int os_mgmt_client_reset ( struct os_mgmt_client client)

Send SMP Reset command.

Parameters
clientOS mgmt client object
Returns
0 on success.
mcumgr_err_t code on failure.