joey shelton / LED_Demo2

Dependencies:   MAX44000 PWM_Tone_Library nexpaq_mdk

Fork of LED_Demo by joey shelton

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.

Data Structures

struct  fhss_configuration_s
 FHSS configuration structure. More...
struct  fhss_platform_functions_s
 FHSS Platform callbacks. More...
struct  fhss_platform_tuning_params_s
 FHSS tuning parameters. More...

Typedefs

typedef struct fhss_configuration_s fhss_configuration_s
 FHSS configuration structure.
typedef enum fhss_channel_mode_e fhss_channel_mode_e
 FHSS Channel mode.

Enumerations

enum  fhss_channel_mode_e
 

FHSS Channel mode.

More...

Functions

int8_t arm_fhss_enable (int8_t interface_id, fhss_platform_functions_s *fhss_platform_functions, const fhss_configuration_s *fhss_configuration)
 Enable FHSS mode.
int8_t arm_fhss_disable (int8_t interface_id)
 Disable FHSS mode.
int8_t arm_fhss_set_tuning_params (int8_t interface_id, const fhss_platform_tuning_params_s *fhss_tuning_params)
 Set platform tuning parameters.

Detailed Description

FHSS API.

Definition in file net_fhss.h.


Typedef Documentation

FHSS Channel mode.

FHSS configuration structure.


Enumeration Type Documentation

FHSS Channel mode.

Definition at line 79 of file net_fhss.h.


Function Documentation

int8_t arm_fhss_disable ( int8_t  interface_id )

Disable FHSS mode.

Parameters:
interface_idNetwork interface ID.
Returns:
0 on success, -1 on fail.
int8_t arm_fhss_enable ( int8_t  interface_id,
fhss_platform_functions_s fhss_platform_functions,
const fhss_configuration_s fhss_configuration 
)

Enable FHSS mode.

Note: arm_nwk_interface_configure_6lowpan_bootstrap_set() must be called before enabling FHSS.

Parameters:
interface_idNetwork interface ID.
fhss_platform_functionsPlatform functions.
fhss_configurationGiven configuration.
Returns:
0 on success.
-1 in case of invalid input parameters.
-2 if no channels are available in channel list.
-3 if the broadcast channels or TX slots are 0 in the bootstrap mode Border Router/RF access point.
-4 if the number of super frames does not work with TX slots in bootstrap mode Border Router/RF access point.
-5 if FHSS tasklet creation fails.
-6 if PHY driver mode cannot be changed.
-7 if the used bootstrap mode is not supported.
-8 if FHSS is already enabled.
-9 if memory allocation failed.
int8_t arm_fhss_set_tuning_params ( int8_t  interface_id,
const fhss_platform_tuning_params_s fhss_tuning_params 
)

Set platform tuning parameters.

Parameters:
interface_idNetwork interface ID.
fhss_tuning_paramsTuning parameters.
Returns:
0 on success, -1 on fail.