oc_knx_swu.h File Reference

software update More...

#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef void(*	oc_swu_cb_t) (size_t device, oc_separate_response_t *response, size_t binary_size, size_t block_offset, uint8_t *block_data, size_t block_len, void *data)
	Callback invoked by the stack to set the software. More...

Enumerations
enum	oc_swu_result_t {   OC_SWU_RESULT_INIT , OC_SWU_RESULT_SUCCESS , OC_SWU_RESULT_ERR_FLASH , OC_SWU_RESULT_ERR_RAM ,   OC_SWU_RESULT_ERR_CONN , OC_SWU_RESULT_ERR_ICF , OC_SWU_RESULT_ERR_UPT , OC_SWU_RESULT_ERR_URL ,   OC_SWU_RESULT_ERR_SUF , OC_SWU_RESULT_ERR_UP }
	The software result states. More...
enum	oc_swu_state_t { OC_SWU_STATE_IDLE = 0 , OC_SWU_STATE_DOWNLOADING , OC_SWU_STATE_DOWNLOADED }
	The software update states. More...

Functions
void	oc_create_knx_swu_resources (size_t device)
	Creation of the KNX software update resources. More...
void	oc_set_swu_cb (oc_swu_cb_t cb, void *data)
	Set the software update callback. More...
void	oc_swu_set_last_update (char *time)
	set the current last update time More...
void	oc_swu_set_package_bytes (int package_bytes)
	set the current amount of the bytes written More...
void	oc_swu_set_package_name (char *name)
	set the current firmware package name More...
void	oc_swu_set_package_version (int major, int minor, int minor2)
	Sets the current package version. More...
void	oc_swu_set_qurl (char *qurl)
	sets the url to be queried for downloading More...
void	oc_swu_set_result (oc_swu_result_t result)
	sets the result of the download procedure More...
void	oc_swu_set_state (oc_swu_state_t state)
	sets the current download state More...

Detailed Description

software update

Definition in file oc_knx_swu.h.

Typedef Documentation

oc_swu_cb_t

typedef void(* oc_swu_cb_t) (size_t device, oc_separate_response_t *response, size_t binary_size, size_t block_offset, uint8_t *block_data, size_t block_len, void *data)

Callback invoked by the stack to set the software.

Parameters

[in]	device	the device index
[in]	response	the instance of an internal struct that is used to track the state of the separate response
[in]	binary_size	the full size of the binary
[in]	block_offset	the offset (in the file)
[in]	block_data	the block data
[in]	block_len	the size of the block_data
[in]	data	the user supplied data

Definition at line 132 of file oc_knx_swu.h.

Enumeration Type Documentation

oc_swu_result_t

enum oc_swu_result_t

The software result states.

Enumerator
OC_SWU_RESULT_INIT	0 Initial value. Once the updating process is initiated (Download /Update), this Resource MUST be reset to Initial value.
OC_SWU_RESULT_SUCCESS	1 Software updated successfully.
OC_SWU_RESULT_ERR_FLASH	2 Not enough flash memory for the new software package.
OC_SWU_RESULT_ERR_RAM	3 Out of RAM during downloading process
OC_SWU_RESULT_ERR_CONN	4 Connection lost during downloading process.
OC_SWU_RESULT_ERR_ICF	5 Integrity check failure for new downloaded package.
OC_SWU_RESULT_ERR_UPT	6 Unsupported package type.
OC_SWU_RESULT_ERR_URL	7 Invalid URL.
OC_SWU_RESULT_ERR_SUF	8 Software update failed.
OC_SWU_RESULT_ERR_UP	9 Unsupported protocol.

Definition at line 44 of file oc_knx_swu.h.

             {
  OC_SWU_RESULT_INIT =
    0, 
  OC_SWU_RESULT_SUCCESS,   
  OC_SWU_RESULT_ERR_FLASH, 
  OC_SWU_RESULT_ERR_RAM,   
  OC_SWU_RESULT_ERR_CONN,  
  OC_SWU_RESULT_ERR_ICF,   
  OC_SWU_RESULT_ERR_UPT,   
  OC_SWU_RESULT_ERR_URL,   
  OC_SWU_RESULT_ERR_SUF,   
  OC_SWU_RESULT_ERR_UP,    
} oc_swu_result_t;

oc_swu_state_t

enum oc_swu_state_t

The software update states.

Enumerator
OC_SWU_STATE_IDLE	state is idle
OC_SWU_STATE_DOWNLOADING	state is downloading
OC_SWU_STATE_DOWNLOADED	state is downloaded

Definition at line 34 of file oc_knx_swu.h.

             {
  OC_SWU_STATE_IDLE = 0,    
  OC_SWU_STATE_DOWNLOADING, 
  OC_SWU_STATE_DOWNLOADED   
} oc_swu_state_t;

Function Documentation

oc_create_knx_swu_resources()

void oc_create_knx_swu_resources

(

size_t

device

)

Creation of the KNX software update resources.

Parameters

device

index of the device to which the resources are to be created

oc_set_swu_cb()

void oc_set_swu_cb	(	oc_swu_cb_t	cb,
		void *	data
	)

Set the software update callback.

The host name callback is called by the stack when the software update is performed

Note

oc_set_hostname_cb() must be called before oc_main_init().

Parameters

[in]	cb	oc_swu_cb_t function pointer to be called
[in]	data	context pointer that is passed to the oc_restart_cb_t the pointer must be a valid pointer till after oc_main_init() call completes.

oc_swu_set_last_update()

void oc_swu_set_last_update

(

char *

time

)

set the current last update time

Parameters

time	the update time in IETF RFC 3339

oc_swu_set_package_bytes()

void oc_swu_set_package_bytes

(

int

package_bytes

)

set the current amount of the bytes written

Parameters

package_bytes

the amount of bytes written

oc_swu_set_package_name()

void oc_swu_set_package_name

(

char *

name

)

set the current firmware package name

Parameters

name	the name of the firmware package

oc_swu_set_package_version()

void oc_swu_set_package_version	(	int	major,
		int	minor,
		int	minor2
	)

Sets the current package version.

Parameters

major	the major number e.g. 1 of [1, 2, 3]
minor	the minor number e.g. 2 of [1, 2, 3]
minor2	the minor2 number e.g. 3 of [1, 2, 3]

oc_swu_set_qurl()

void oc_swu_set_qurl

(

char *

qurl

)

sets the url to be queried for downloading

Parameters

qurl

the url

oc_swu_set_result()

void oc_swu_set_result

(

oc_swu_result_t

result

)

sets the result of the download procedure

Parameters

result

the result, including possible errors

oc_swu_set_state()

void oc_swu_set_state

(

oc_swu_state_t

state

)

sets the current download state

Parameters

state

the download state