Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
MCUmgr os_mgmt_client API

MCUmgr OS management client API. More...

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, size_t max_len)
 Send SMP message for Echo command.
 
int os_mgmt_client_reset (struct os_mgmt_client *client)
 Send SMP Reset command.
 

Detailed Description

MCUmgr OS management client API.

Function Documentation

◆ os_mgmt_client_echo()

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

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt_client.h>

Send SMP message for Echo command.

Parameters
clientOS mgmt client object
echo_stringEcho string
max_lenMax length of echo_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 
)

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt_client.h>

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)

#include <zephyr/mgmt/mcumgr/grp/os_mgmt/os_mgmt_client.h>

Send SMP Reset command.

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