Kenji Arai / mbed-os_TYBLE16

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.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

fhss_ws_extension.h File Reference
Data Structures | Typedefs | Functions

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, const bool force_synch)
 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:
apiFHSS instance.
eui64EUI-64 address of node for which the info is requested.
Returns:
Neighbor timing/hopping schedule.

Definition at line 76 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_apiFHSS instance.
get_neighbor_infoNeighbor info function pointer.
Returns:
0 on success, -1 on fail.

Definition at line 106 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_apiFHSS instance.
eui64EUI-64 address of parent.
Returns:
0 on success, -1 on fail.

Definition at line 75 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_apiFHSS instance.
hop_countHop count to be set.
Returns:
0 on success, -1 on fail.

Definition at line 134 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,
const bool  force_synch 
)

Set parent which broadcast channels must be listened by FHSS.

Parameters:
fhss_apiFHSS instance.
eui64EUI-64 address of parent.
bc_timing_infoPointer to parent broadcast timing/hopping schedule info.
force_synchIf false, synchronization is done only if minimum (internal) synchronization interval is exceed.
Returns:
0 on success, -1 on fail.

Definition at line 66 of file fhss_configuration_interface.c.

Generated on Tue Jul 12 2022 13:55:09 by  doxygen 1.7.2