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_domain (char *domain_str)
	Set the hawkBit server hostname.
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 char *	hawkbit_get_server_domain (void)
	Get the hawkBit server hostname.
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()

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()

char * hawkbit_get_server_addr ( void )

inlinestatic

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

Get the hawkBit server address.

Returns

Server address.

hawkbit_get_server_domain()

char * hawkbit_get_server_domain ( void )

inlinestatic

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

Get the hawkBit server hostname.

Returns

Server hostname.

hawkbit_get_server_port()

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()

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

config

Configuration settings to set.

Return values

0	on success.
-EAGAIN	if probe is currently running.
-EINVAL	if config parameters are invalid.

hawkbit_set_ddi_security_token()

int hawkbit_set_ddi_security_token ( char * token )

inlinestatic

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

Set the hawkBit security token.

Parameters

token

Security token to set.

Return values

0	on success.
-EAGAIN	if probe is currently running.

hawkbit_set_server_addr()

int hawkbit_set_server_addr ( char * addr_str )

inlinestatic

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

Set the hawkBit server address.

Parameters

addr_str

Server address to set.

Return values

0	on success.
-EAGAIN	if probe is currently running.
-EINVAL	if config parameters are invalid.

hawkbit_set_server_domain()

int hawkbit_set_server_domain ( char * domain_str )

inlinestatic

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

Set the hawkBit server hostname.

Parameters

domain_str

Server hostname to set.

Return values

0	on success.
-EINVAL	if string length mismatch for server_domain
-EAGAIN	if probe is currently running.

hawkbit_set_server_port()

int hawkbit_set_server_port ( uint16_t port )

inlinestatic

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

Set the hawkBit server port.

Parameters

port	Server port to set.

Return values

0	on success.
-EAGAIN	if probe is currently running.

hawkbit_set_tls_tag()

int hawkbit_set_tls_tag ( sec_tag_t tag )

inlinestatic

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

Set the hawkBit TLS tag.

Parameters

tag	TLS tag to set.

Return values

0	on success.
-EAGAIN	if probe is currently running.