
Data Structures | |
| struct | gboss_comm_options_s |
| GPD Commissioning - Options field descriptor. More... | |
| struct | gboss_comm_ext_options_s |
| GPD Commissioning - Extended options field descriptor. More... | |
| struct | gboss_comm_app_info_s |
| GPD Commissioning - Application information descriptor. More... | |
| struct | gboss_device_config_s |
| Main configuration constants of a GP device. More... | |
| struct | gboss_tx_cfg_s |
| TX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions. More... | |
Typedefs | |
| typedef enum gboss_mac_sequence_number_capabilities_e | gboss_mac_sequence_number_capabilities_t |
| GP device MAC sequence number capabilities enum. More... | |
| typedef struct gboss_comm_options_s | gboss_comm_options_t |
| GPD Commissioning - Options field descriptor. More... | |
| typedef enum gboss_security_key_capabilities_e | gboss_security_key_capabilities_t |
| GPD Commissioning - Security key capabilities. More... | |
| typedef enum gboss_key_types_e | gboss_key_types_t |
| GPD Commissioning - Key types. More... | |
| typedef struct gboss_comm_ext_options_s | gboss_comm_ext_options_t |
| GPD Commissioning - Extended options field descriptor. More... | |
| typedef struct gboss_comm_app_info_s | gboss_comm_app_info_t |
| GPD Commissioning - Application information descriptor. More... | |
| typedef enum gboss_app_ids_e | gboss_app_ids_t |
| GPD Application IDs. More... | |
| typedef enum gboss_dev_id_e | gboss_dev_id_t |
| Possible ZGPD device identifiers. More... | |
| typedef struct gboss_device_config_s | gboss_device_config_t |
| Main configuration constants of a GP device. More... | |
| typedef struct gboss_tx_cfg_s | gboss_tx_cfg_t |
| TX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions. More... | |
Functions | |
| void | gboss_app_init (const zb_uint8_t *key, const gboss_device_config_t *device_config) |
| Initializes the ZGPD stack. More... | |
| void | gboss_platform_init (ARGC_ARGV_PROTO) |
| Initializes the platform layer. More... | |
| void | gboss_wait_for_button (void) |
| Waits until any button is pressed. More... | |
| zb_uint32_t | gboss_test_get_button_mask (void) |
| Gets bitmask of buttons pressed on the device boot. More... | |
| void | gboss_set_buttons_max_num (zb_uint8_t num) |
| Informs platform layer about number of supported buttons. More... | |
GP device MAC sequence number capabilities enum.
| typedef struct gboss_comm_options_s gboss_comm_options_t |
GPD Commissioning - Options field descriptor.
GPD Commissioning - Security key capabilities.
| typedef enum gboss_key_types_e gboss_key_types_t |
GPD Commissioning - Key types.
| typedef struct gboss_comm_ext_options_s gboss_comm_ext_options_t |
GPD Commissioning - Extended options field descriptor.
| typedef struct gboss_comm_app_info_s gboss_comm_app_info_t |
GPD Commissioning - Application information descriptor.
| typedef enum gboss_app_ids_e gboss_app_ids_t |
GPD Application IDs.
| typedef enum gboss_dev_id_e gboss_dev_id_t |
Possible ZGPD device identifiers.
| typedef struct gboss_device_config_s gboss_device_config_t |
Main configuration constants of a GP device.
| typedef struct gboss_tx_cfg_s gboss_tx_cfg_t |
TX configuration outlining how a transmission should proceed concerning the channels to be used and the number of repetitions.
The channel array describes list of channels that are used for frames transmission in unidirectional commissioning and frames transmission and reception in bidirectional commissioning. The channel array is logically divided by chunks of "channel_group_size".
Example: If "channels" points to channel_list as follows zb_uint8_t channel_list[9] = [11, 12, 13, 14, 15, 16, 17, 18, 19] and channel_group_size equals to 3, it will give three logical groups of channels:
The channel array size must be a multiple of channel_group_size. Group size determines channels that are used in one commissioning attempt. The interpretation of how channels are used differs depending on the device state (commissioned or commissioning in progress) and commissioning type (unidirectional or bidirectional).
Unidirectional commissioning or application command TX time - repeat "repetition" times executes the following procedure:
Bidirectional commissioning:
Bidirectional commissioning after channel is established:
TX on a single channel stored in NVM.
| enum gboss_key_types_e |
GPD Commissioning - Key types.
| enum gboss_app_ids_e |
| enum gboss_dev_id_e |
Possible ZGPD device identifiers.
| void gboss_app_init | ( | const zb_uint8_t * | key, |
| const gboss_device_config_t * | device_config | ||
| ) |
Initializes the ZGPD stack.
| key | Pointer to a 16-bytes OOB key or NULL if not used |
| device_config | GPD configuration block |
References zb_mac_init(), and zb_mac_set_tx_power().
| void gboss_platform_init | ( | ARGC_ARGV_PROTO | ) |
Initializes the platform layer.
To be called before gboss_app_init().
| void gboss_wait_for_button | ( | void | ) |
Waits until any button is pressed.
To be called before gboss_test_get_button_mask() for bidirectional battery powered device.
| zb_uint32_t gboss_test_get_button_mask | ( | void | ) |
Gets bitmask of buttons pressed on the device boot.
| void gboss_set_buttons_max_num | ( | zb_uint8_t | num | ) |
Informs platform layer about number of supported buttons.
| num | Number of supported buttons in application |