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.
fhss_ws_extension.h File Reference
Go to the source code of this file.
| Data Structures | |
| struct | unicast_timing_info | 
| unicast_timing_info Unicast timing/hopping schedule information structure.  More... | |
| struct | broadcast_timing_info | 
| broadcast_timing_info Broadcast timing/hopping schedule information structure.  More... | |
| struct | fhss_ws_neighbor_timing_info | 
| fhss_ws_neighbor_timing_info Neighbor timing/hopping schedule information structure.  More... | |
| Typedefs | |
| typedef struct unicast_timing_info | unicast_timing_info_t | 
| unicast_timing_info Unicast timing/hopping schedule information structure. | |
| typedef struct broadcast_timing_info | broadcast_timing_info_t | 
| broadcast_timing_info Broadcast timing/hopping schedule information structure. | |
| typedef struct fhss_ws_neighbor_timing_info | fhss_ws_neighbor_timing_info_t | 
| fhss_ws_neighbor_timing_info Neighbor timing/hopping schedule information structure. | |
| typedef fhss_ws_neighbor_timing_info_t * | fhss_get_neighbor_info (const fhss_api_t *api, uint8_t eui64[8]) | 
| Get neighbor timing/hopping schedule. | |
| Functions | |
| int | ns_fhss_ws_set_parent (const fhss_api_t *fhss_api, const uint8_t eui64[8], const broadcast_timing_info_t *bc_timing_info) | 
| Set parent which broadcast channels must be listened by FHSS. | |
| int | ns_fhss_ws_remove_parent (const fhss_api_t *fhss_api, const uint8_t eui64[8]) | 
| Remove parent which was set by ns_fhss_ws_set_parent function. | |
| int | ns_fhss_set_neighbor_info_fp (const fhss_api_t *fhss_api, fhss_get_neighbor_info *get_neighbor_info) | 
| Set neighbor timing/hopping schedule request function. | |
| int | ns_fhss_ws_set_hop_count (const fhss_api_t *fhss_api, const uint8_t hop_count) | 
| Set node hop count. | |
Detailed Description
Definition in file fhss_ws_extension.h.
Typedef Documentation
| typedef struct broadcast_timing_info broadcast_timing_info_t | 
broadcast_timing_info Broadcast timing/hopping schedule information structure.
| typedef fhss_ws_neighbor_timing_info_t* fhss_get_neighbor_info(const fhss_api_t *api, uint8_t eui64[8]) | 
Get neighbor timing/hopping schedule.
- Parameters:
- 
  api FHSS instance. eui64 EUI-64 address of node for which the info is requested. 
- Returns:
- Neighbor timing/hopping schedule.
Definition at line 74 of file fhss_ws_extension.h.
| typedef struct fhss_ws_neighbor_timing_info fhss_ws_neighbor_timing_info_t | 
fhss_ws_neighbor_timing_info Neighbor timing/hopping schedule information structure.
| typedef struct unicast_timing_info unicast_timing_info_t | 
unicast_timing_info Unicast timing/hopping schedule information structure.
Function Documentation
| int ns_fhss_set_neighbor_info_fp | ( | const fhss_api_t * | fhss_api, | 
| fhss_get_neighbor_info * | get_neighbor_info | ||
| ) | 
Set neighbor timing/hopping schedule request function.
- Parameters:
- 
  fhss_api FHSS instance. get_neighbor_info Neighbor info function pointer. 
- Returns:
- 0 on success, -1 on fail.
Definition at line 105 of file fhss_configuration_interface.c.
| int ns_fhss_ws_remove_parent | ( | const fhss_api_t * | fhss_api, | 
| const uint8_t | eui64[8] | ||
| ) | 
Remove parent which was set by ns_fhss_ws_set_parent function.
- Parameters:
- 
  fhss_api FHSS instance. eui64 EUI-64 address of parent. 
- Returns:
- 0 on success, -1 on fail.
Definition at line 74 of file fhss_configuration_interface.c.
| int ns_fhss_ws_set_hop_count | ( | const fhss_api_t * | fhss_api, | 
| const uint8_t | hop_count | ||
| ) | 
Set node hop count.
Hop count is used to specify TX/RX slot. When hop count is set to 0xFF, TX/RX slots are ignored.
- Parameters:
- 
  fhss_api FHSS instance. hop_count Hop count to be set. 
- Returns:
- 0 on success, -1 on fail.
Definition at line 133 of file fhss_configuration_interface.c.
| int ns_fhss_ws_set_parent | ( | const fhss_api_t * | fhss_api, | 
| const uint8_t | eui64[8], | ||
| const broadcast_timing_info_t * | bc_timing_info | ||
| ) | 
Set parent which broadcast channels must be listened by FHSS.
- Parameters:
- 
  fhss_api FHSS instance. eui64 EUI-64 address of parent. bc_timing_info Pointer to parent broadcast timing/hopping schedule info. 
- Returns:
- 0 on success, -1 on fail.
Definition at line 65 of file fhss_configuration_interface.c.
Generated on Tue Aug 9 2022 00:37:26 by
 1.7.2
 1.7.2