hawkBit Firmware Over-the-Air

hawkBit Firmware Over-the-Air for Zephyr Project. More...

Macros
#define	HAWKBIT_JSON_URL   "/default/controller/v1"

Enumerations
enum	hawkbit_response {   HAWKBIT_NETWORKING_ERROR , HAWKBIT_UNCONFIRMED_IMAGE , HAWKBIT_METADATA_ERROR , HAWKBIT_DOWNLOAD_ERROR ,   HAWKBIT_OK , HAWKBIT_UPDATE_INSTALLED , HAWKBIT_NO_UPDATE , HAWKBIT_CANCEL_UPDATE ,   HAWKBIT_PROBE_IN_PROGRESS }
	Response message from hawkBit. More...

Functions
int	hawkbit_init (void)
	Init the flash partition.
void	hawkbit_autohandler (void)
	Runs hawkBit probe and hawkBit update automatically.
enum hawkbit_response	hawkbit_probe (void)
	The hawkBit probe verify if there is some update to be performed.

Detailed Description

hawkBit Firmware Over-the-Air for Zephyr Project.

Macro Definition Documentation

HAWKBIT_JSON_URL

#define HAWKBIT_JSON_URL   "/default/controller/v1"

#include <zephyr/mgmt/hawkbit.h>

Enumeration Type Documentation

hawkbit_response

enum hawkbit_response

#include <zephyr/mgmt/hawkbit.h>

Response message from hawkBit.

These messages are used to inform the server and the user about the process status of the hawkBit and also used to standardize the errors that may occur.

Enumerator
HAWKBIT_NETWORKING_ERROR
HAWKBIT_UNCONFIRMED_IMAGE
HAWKBIT_METADATA_ERROR
HAWKBIT_DOWNLOAD_ERROR
HAWKBIT_OK
HAWKBIT_UPDATE_INSTALLED
HAWKBIT_NO_UPDATE
HAWKBIT_CANCEL_UPDATE
HAWKBIT_PROBE_IN_PROGRESS

Function Documentation

hawkbit_autohandler()

void hawkbit_autohandler

(

void

)

#include <zephyr/mgmt/hawkbit.h>

Runs hawkBit probe and hawkBit update automatically.

The hawkbit_autohandler handles the whole process in pre-determined time intervals.

hawkbit_init()

int hawkbit_init

(

void

)

#include <zephyr/mgmt/hawkbit.h>

Init the flash partition.

Returns

0 on success, negative on error.

hawkbit_probe()

enum hawkbit_response hawkbit_probe

(

void

)

#include <zephyr/mgmt/hawkbit.h>

The hawkBit probe verify if there is some update to be performed.

Returns

HAWKBIT_UPDATE_INSTALLED has an update available.

HAWKBIT_NO_UPDATE no update available.

HAWKBIT_NETWORKING_ERROR fail to connect to the hawkBit server.

HAWKBIT_METADATA_ERROR fail to parse or to encode the metadata.

HAWKBIT_OK if success.

HAWKBIT_DOWNLOAD_ERROR fail while downloading the update package.