Zephyr API Documentation 4.0.0-rc2
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
hawkBit configuration API

hawkBit configuration API. More...

Data Structures

struct  hawkbit_runtime_config
 hawkBit configuration structure. More...
 

Functions

int hawkbit_set_config (struct hawkbit_runtime_config *config)
 Set the hawkBit server configuration settings.
 
struct hawkbit_runtime_config hawkbit_get_config (void)
 Get the hawkBit server configuration settings.
 
static int hawkbit_set_server_addr (char *addr_str)
 Set the hawkBit server address.
 
static int hawkbit_set_server_port (uint16_t port)
 Set the hawkBit server port.
 
static int hawkbit_set_ddi_security_token (char *token)
 Set the hawkBit security token.
 
static int hawkbit_set_tls_tag (sec_tag_t tag)
 Set the hawkBit TLS tag.
 
static char * hawkbit_get_server_addr (void)
 Get the hawkBit server address.
 
static uint16_t hawkbit_get_server_port (void)
 Get the hawkBit server port.
 
static char * hawkbit_get_ddi_security_token (void)
 Get the hawkBit security token.
 
static sec_tag_t hawkbit_get_tls_tag (void)
 Get the hawkBit TLS tag.
 
int32_t hawkbit_get_action_id (void)
 Get the hawkBit action id.
 
uint32_t hawkbit_get_poll_interval (void)
 Get the hawkBit poll interval.
 

Detailed Description

hawkBit configuration API.

Function Documentation

◆ hawkbit_get_action_id()

int32_t hawkbit_get_action_id ( void )

#include <zephyr/mgmt/hawkbit/config.h>

Get the hawkBit action id.

Returns
Action id.

◆ hawkbit_get_config()

struct hawkbit_runtime_config hawkbit_get_config ( void )

#include <zephyr/mgmt/hawkbit/config.h>

Get the hawkBit server configuration settings.

Returns
Configuration settings.

◆ hawkbit_get_ddi_security_token()

static char * hawkbit_get_ddi_security_token ( void )
inlinestatic

#include <zephyr/mgmt/hawkbit/config.h>

Get the hawkBit security token.

Returns
Security token.

◆ hawkbit_get_poll_interval()

uint32_t hawkbit_get_poll_interval ( void )

#include <zephyr/mgmt/hawkbit/config.h>

Get the hawkBit poll interval.

Returns
Poll interval.

◆ hawkbit_get_server_addr()

static char * hawkbit_get_server_addr ( void )
inlinestatic

#include <zephyr/mgmt/hawkbit/config.h>

Get the hawkBit server address.

Returns
Server address.

◆ hawkbit_get_server_port()

static uint16_t hawkbit_get_server_port ( void )
inlinestatic

#include <zephyr/mgmt/hawkbit/config.h>

Get the hawkBit server port.

Returns
Server port.

◆ hawkbit_get_tls_tag()

static sec_tag_t hawkbit_get_tls_tag ( void )
inlinestatic

#include <zephyr/mgmt/hawkbit/config.h>

Get the hawkBit TLS tag.

Returns
TLS tag.

◆ hawkbit_set_config()

int hawkbit_set_config ( struct hawkbit_runtime_config * config)

#include <zephyr/mgmt/hawkbit/config.h>

Set the hawkBit server configuration settings.

Parameters
configConfiguration settings to set.
Return values
0on success.
-EAGAINif probe is currently running.

◆ hawkbit_set_ddi_security_token()

static int hawkbit_set_ddi_security_token ( char * token)
inlinestatic

#include <zephyr/mgmt/hawkbit/config.h>

Set the hawkBit security token.

Parameters
tokenSecurity token to set.
Return values
0on success.
-EAGAINif probe is currently running.

◆ hawkbit_set_server_addr()

static int hawkbit_set_server_addr ( char * addr_str)
inlinestatic

#include <zephyr/mgmt/hawkbit/config.h>

Set the hawkBit server address.

Parameters
addr_strServer address to set.
Return values
0on success.
-EAGAINif probe is currently running.

◆ hawkbit_set_server_port()

static int hawkbit_set_server_port ( uint16_t port)
inlinestatic

#include <zephyr/mgmt/hawkbit/config.h>

Set the hawkBit server port.

Parameters
portServer port to set.
Return values
0on success.
-EAGAINif probe is currently running.

◆ hawkbit_set_tls_tag()

static int hawkbit_set_tls_tag ( sec_tag_t tag)
inlinestatic

#include <zephyr/mgmt/hawkbit/config.h>

Set the hawkBit TLS tag.

Parameters
tagTLS tag to set.
Return values
0on success.
-EAGAINif probe is currently running.