Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

net_fhss.h File Reference

net_fhss.h File Reference

FHSS API. More...

Go to the source code of this file.

Functions

fhss_api_tns_fhss_create (const fhss_configuration_t *fhss_configuration, const fhss_timer_t *fhss_timer, fhss_statistics_t *fhss_statistics)
 Creates FHSS API instance which will be registered to software MAC.
fhss_api_tns_fhss_ws_create (const fhss_ws_configuration_t *fhss_configuration, const fhss_timer_t *fhss_timer)
 Creates FHSS WS API instance which will be registered to software MAC.
int ns_fhss_configuration_set (fhss_api_t *fhss_api, const fhss_synch_configuration_t *fhss_synch_configuration)
 Set synchronization time configuration for FHSS network.
const fhss_ws_configuration_tns_fhss_ws_configuration_get (const fhss_api_t *fhss_api)
 Get WS configuration.
int ns_fhss_ws_configuration_set (const fhss_api_t *fhss_api, const fhss_ws_configuration_t *fhss_configuration)
 Set WS configuration.
int ns_fhss_delete (fhss_api_t *fhss_api)
 Deletes a FHSS API instance and removes it from software MAC.
int ns_fhss_statistics_start (const fhss_api_t *fhss_api, fhss_statistics_t *fhss_statistics)
 Starts collecting FHSS statistics.

Detailed Description

FHSS API.

Definition in file net_fhss.h.


Function Documentation

int ns_fhss_configuration_set ( fhss_api_t fhss_api,
const fhss_synch_configuration_t fhss_synch_configuration 
)

Set synchronization time configuration for FHSS network.

Should be only called from Border router.

Parameters:
fhss_apiFHSS instance.
fhss_synch_configurationFHSS synchronization time configuration.
Returns:
0 on success, -1 on fail.

Definition at line 97 of file fhss_configuration_interface.c.

fhss_api_t* ns_fhss_create ( const fhss_configuration_t fhss_configuration,
const fhss_timer_t fhss_timer,
fhss_statistics_t fhss_statistics 
)

Creates FHSS API instance which will be registered to software MAC.

Parameters:
fhss_configurationBasic FHSS configuration.
fhss_timerFHSS platform timer interface and configuration.
fhss_statisticsFHSS statistics storage.
Returns:
New FHSS instance if successful, NULL otherwise.

Definition at line 32 of file fhss_configuration_interface.c.

int ns_fhss_delete ( fhss_api_t fhss_api )

Deletes a FHSS API instance and removes it from software MAC.

Parameters:
fhss_apiFHSS instance.
Returns:
0 on success, -1 on fail.

Definition at line 84 of file fhss_configuration_interface.c.

int ns_fhss_statistics_start ( const fhss_api_t fhss_api,
fhss_statistics_t fhss_statistics 
)

Starts collecting FHSS statistics.

Parameters:
fhss_apiFHSS instance.
fhss_statisticsPointer to stored statistics.
Returns:
0 on success, -1 on fail.

Definition at line 143 of file fhss_configuration_interface.c.

const fhss_ws_configuration_t* ns_fhss_ws_configuration_get ( const fhss_api_t fhss_api )

Get WS configuration.

Parameters:
fhss_apiFHSS instance.
Returns:
WS configuration.

Definition at line 116 of file fhss_configuration_interface.c.

int ns_fhss_ws_configuration_set ( const fhss_api_t fhss_api,
const fhss_ws_configuration_t fhss_configuration 
)

Set WS configuration.

Parameters:
fhss_apiFHSS instance.
fhss_configurationBasic FHSS configuration.
Returns:
0 on success, -1 on fail.

Definition at line 125 of file fhss_configuration_interface.c.

fhss_api_t* ns_fhss_ws_create ( const fhss_ws_configuration_t fhss_configuration,
const fhss_timer_t fhss_timer 
)

Creates FHSS WS API instance which will be registered to software MAC.

Parameters:
fhss_configurationBasic FHSS configuration.
fhss_timerFHSS platform timer interface and configuration.
Returns:
New FHSS instance if successful, NULL otherwise.

Definition at line 49 of file fhss_configuration_interface.c.