Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: MAX44000 PWM_Tone_Library nexpaq_mdk
Fork of LED_Demo by
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
| typedef enum fhss_channel_mode_e fhss_channel_mode_e | 
FHSS Channel mode.
| typedef struct fhss_configuration_s fhss_configuration_s | 
FHSS configuration structure.
Enumeration Type Documentation
| enum fhss_channel_mode_e | 
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_id Network 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_id Network interface ID. fhss_platform_functions Platform functions. fhss_configuration Given 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_id Network interface ID. fhss_tuning_params Tuning parameters. 
- Returns:
- 0 on success, -1 on fail.
Generated on Tue Jul 12 2022 12:29:02 by
 1.7.2
 1.7.2 
    