BGAPI headers

BGAPI headers

Name Type Payload Length* Class Message ID
Coexistence Interface
cmd_coex_get_counters 0x20 0x01 0x20 0x01
rsp_coex_get_counters 0x20 0x03 0x20 0x01
cmd_coex_set_directional_priority_pulse 0x20 0x01 0x20 0x03
rsp_coex_set_directional_priority_pulse 0x20 0x02 0x20 0x03
cmd_coex_set_options 0x20 0x08 0x20 0x00
rsp_coex_set_options 0x20 0x02 0x20 0x00
cmd_coex_set_parameters 0x20 0x04 0x20 0x02
rsp_coex_set_parameters 0x20 0x02 0x20 0x02
CTE Receiver
cmd_cte_receiver_clear_dtm_parameters 0x20 0x00 0x45 0x06
rsp_cte_receiver_clear_dtm_parameters 0x20 0x02 0x45 0x06
cmd_cte_receiver_set_dtm_parameters 0x20 0x04 0x45 0x05
rsp_cte_receiver_set_dtm_parameters 0x20 0x02 0x45 0x05
cmd_cte_receiver_start_iq_sampling 0x20 0x07 0x45 0x01
rsp_cte_receiver_start_iq_sampling 0x20 0x02 0x45 0x01
cmd_cte_receiver_stop_iq_sampling 0x20 0x01 0x45 0x02
rsp_cte_receiver_stop_iq_sampling 0x20 0x02 0x45 0x02
evt_cte_receiver_iq_report 0xa0 0x0e 0x45 0x00
CTE Transmitter
cmd_cte_transmitter_clear_dtm_parameters 0x20 0x00 0x44 0x05
rsp_cte_transmitter_clear_dtm_parameters 0x20 0x02 0x44 0x05
cmd_cte_transmitter_disable_cte_response 0x20 0x01 0x44 0x01
rsp_cte_transmitter_disable_cte_response 0x20 0x02 0x44 0x01
cmd_cte_transmitter_enable_cte_response 0x20 0x03 0x44 0x00
rsp_cte_transmitter_enable_cte_response 0x20 0x02 0x44 0x00
cmd_cte_transmitter_set_dtm_parameters 0x20 0x03 0x44 0x04
rsp_cte_transmitter_set_dtm_parameters 0x20 0x02 0x44 0x04
Device Firmware Upgrade
cmd_dfu_flash_set_address 0x20 0x04 0x00 0x01
rsp_dfu_flash_set_address 0x20 0x02 0x00 0x01
cmd_dfu_flash_upload 0x20 0x01 0x00 0x02
rsp_dfu_flash_upload 0x20 0x02 0x00 0x02
cmd_dfu_flash_upload_finish 0x20 0x00 0x00 0x03
rsp_dfu_flash_upload_finish 0x20 0x02 0x00 0x03
cmd_dfu_reset 0x20 0x01 0x00 0x00
rsp_dfu_reset 0x20 0x00 0x00 0x00
evt_dfu_boot 0xa0 0x04 0x00 0x00
evt_dfu_boot_failure 0xa0 0x02 0x00 0x01
Persistent Store
cmd_flash_ps_erase 0x20 0x02 0x0d 0x04
rsp_flash_ps_erase 0x20 0x02 0x0d 0x04
cmd_flash_ps_erase_all 0x20 0x00 0x0d 0x01
rsp_flash_ps_erase_all 0x20 0x02 0x0d 0x01
cmd_flash_ps_load 0x20 0x02 0x0d 0x03
rsp_flash_ps_load 0x20 0x03 0x0d 0x03
cmd_flash_ps_save 0x20 0x03 0x0d 0x02
rsp_flash_ps_save 0x20 0x02 0x0d 0x02
Generic Attribute Profile
cmd_gatt_discover_characteristics 0x20 0x05 0x09 0x03
rsp_gatt_discover_characteristics 0x20 0x02 0x09 0x03
cmd_gatt_discover_characteristics_by_uuid 0x20 0x06 0x09 0x04
rsp_gatt_discover_characteristics_by_uuid 0x20 0x02 0x09 0x04
cmd_gatt_discover_descriptors 0x20 0x03 0x09 0x06
rsp_gatt_discover_descriptors 0x20 0x02 0x09 0x06
cmd_gatt_discover_primary_services 0x20 0x01 0x09 0x01
rsp_gatt_discover_primary_services 0x20 0x02 0x09 0x01
cmd_gatt_discover_primary_services_by_uuid 0x20 0x02 0x09 0x02
rsp_gatt_discover_primary_services_by_uuid 0x20 0x02 0x09 0x02
cmd_gatt_execute_characteristic_value_write 0x20 0x02 0x09 0x0c
rsp_gatt_execute_characteristic_value_write 0x20 0x02 0x09 0x0c
cmd_gatt_find_included_services 0x20 0x05 0x09 0x10
rsp_gatt_find_included_services 0x20 0x02 0x09 0x10
cmd_gatt_prepare_characteristic_value_reliable_write 0x20 0x06 0x09 0x13
rsp_gatt_prepare_characteristic_value_reliable_write 0x20 0x04 0x09 0x13
cmd_gatt_prepare_characteristic_value_write 0x20 0x06 0x09 0x0b
rsp_gatt_prepare_characteristic_value_write 0x20 0x04 0x09 0x0b
cmd_gatt_read_characteristic_value 0x20 0x03 0x09 0x07
rsp_gatt_read_characteristic_value 0x20 0x02 0x09 0x07
cmd_gatt_read_characteristic_value_by_uuid 0x20 0x06 0x09 0x08
rsp_gatt_read_characteristic_value_by_uuid 0x20 0x02 0x09 0x08
cmd_gatt_read_characteristic_value_from_offset 0x20 0x07 0x09 0x12
rsp_gatt_read_characteristic_value_from_offset 0x20 0x02 0x09 0x12
cmd_gatt_read_descriptor_value 0x20 0x03 0x09 0x0e
rsp_gatt_read_descriptor_value 0x20 0x02 0x09 0x0e
cmd_gatt_read_multiple_characteristic_values 0x20 0x02 0x09 0x11
rsp_gatt_read_multiple_characteristic_values 0x20 0x02 0x09 0x11
cmd_gatt_send_characteristic_confirmation 0x20 0x01 0x09 0x0d
rsp_gatt_send_characteristic_confirmation 0x20 0x02 0x09 0x0d
cmd_gatt_set_characteristic_notification 0x20 0x04 0x09 0x05
rsp_gatt_set_characteristic_notification 0x20 0x02 0x09 0x05
cmd_gatt_set_max_mtu 0x20 0x02 0x09 0x00
rsp_gatt_set_max_mtu 0x20 0x04 0x09 0x00
cmd_gatt_write_characteristic_value 0x20 0x04 0x09 0x09
rsp_gatt_write_characteristic_value 0x20 0x02 0x09 0x09
cmd_gatt_write_characteristic_value_without_response 0x20 0x04 0x09 0x0a
rsp_gatt_write_characteristic_value_without_response 0x20 0x04 0x09 0x0a
cmd_gatt_write_descriptor_value 0x20 0x04 0x09 0x0f
rsp_gatt_write_descriptor_value 0x20 0x02 0x09 0x0f
evt_gatt_mtu_exchanged 0xa0 0x03 0x09 0x00
evt_gatt_service 0xa0 0x06 0x09 0x01
evt_gatt_characteristic 0xa0 0x05 0x09 0x02
evt_gatt_descriptor 0xa0 0x04 0x09 0x03
evt_gatt_characteristic_value 0xa0 0x07 0x09 0x04
evt_gatt_descriptor_value 0xa0 0x06 0x09 0x05
evt_gatt_procedure_completed 0xa0 0x03 0x09 0x06
Generic Attribute Profile Server
cmd_gatt_server_find_attribute 0x20 0x03 0x0a 0x06
rsp_gatt_server_find_attribute 0x20 0x04 0x0a 0x06
cmd_gatt_server_get_mtu 0x20 0x01 0x0a 0x0b
rsp_gatt_server_get_mtu 0x20 0x04 0x0a 0x0b
cmd_gatt_server_read_attribute_type 0x20 0x02 0x0a 0x01
rsp_gatt_server_read_attribute_type 0x20 0x03 0x0a 0x01
cmd_gatt_server_read_attribute_value 0x20 0x04 0x0a 0x00
rsp_gatt_server_read_attribute_value 0x20 0x03 0x0a 0x00
cmd_gatt_server_send_characteristic_notification 0x20 0x04 0x0a 0x05
rsp_gatt_server_send_characteristic_notification 0x20 0x04 0x0a 0x05
cmd_gatt_server_send_user_read_response 0x20 0x05 0x0a 0x03
rsp_gatt_server_send_user_read_response 0x20 0x04 0x0a 0x03
cmd_gatt_server_send_user_write_response 0x20 0x04 0x0a 0x04
rsp_gatt_server_send_user_write_response 0x20 0x02 0x0a 0x04
cmd_gatt_server_set_capabilities 0x20 0x08 0x0a 0x08
rsp_gatt_server_set_capabilities 0x20 0x02 0x0a 0x08
cmd_gatt_server_set_max_mtu 0x20 0x02 0x0a 0x0a
rsp_gatt_server_set_max_mtu 0x20 0x04 0x0a 0x0a
cmd_gatt_server_write_attribute_value 0x20 0x05 0x0a 0x02
rsp_gatt_server_write_attribute_value 0x20 0x02 0x0a 0x02
evt_gatt_server_attribute_value 0xa0 0x07 0x0a 0x00
evt_gatt_server_user_read_request 0xa0 0x06 0x0a 0x01
evt_gatt_server_user_write_request 0xa0 0x07 0x0a 0x02
evt_gatt_server_characteristic_status 0xa0 0x06 0x0a 0x03
evt_gatt_server_execute_write_completed 0xa0 0x03 0x0a 0x04
Hardware
cmd_hardware_get_time 0x20 0x00 0x0c 0x0b
rsp_hardware_get_time 0x20 0x06 0x0c 0x0b
cmd_hardware_set_lazy_soft_timer 0x20 0x0a 0x0c 0x0c
rsp_hardware_set_lazy_soft_timer 0x20 0x02 0x0c 0x0c
cmd_hardware_set_soft_timer 0x20 0x06 0x0c 0x00
rsp_hardware_set_soft_timer 0x20 0x02 0x0c 0x00
evt_hardware_soft_timer 0xa0 0x01 0x0c 0x00
Connection Management
cmd_le_connection_close 0x20 0x01 0x08 0x04
rsp_le_connection_close 0x20 0x02 0x08 0x04
cmd_le_connection_disable_slave_latency 0x20 0x02 0x08 0x02
rsp_le_connection_disable_slave_latency 0x20 0x02 0x08 0x02
cmd_le_connection_get_rssi 0x20 0x01 0x08 0x01
rsp_le_connection_get_rssi 0x20 0x02 0x08 0x01
cmd_le_connection_read_channel_map 0x20 0x01 0x08 0x06
rsp_le_connection_read_channel_map 0x20 0x03 0x08 0x06
cmd_le_connection_set_parameters 0x20 0x09 0x08 0x00
rsp_le_connection_set_parameters 0x20 0x02 0x08 0x00
cmd_le_connection_set_phy 0x20 0x02 0x08 0x03
rsp_le_connection_set_phy 0x20 0x02 0x08 0x03
cmd_le_connection_set_preferred_phy 0x20 0x03 0x08 0x07
rsp_le_connection_set_preferred_phy 0x20 0x02 0x08 0x07
cmd_le_connection_set_timing_parameters 0x20 0x0d 0x08 0x05
rsp_le_connection_set_timing_parameters 0x20 0x02 0x08 0x05
evt_le_connection_opened 0xa0 0x0b 0x08 0x00
evt_le_connection_closed 0xa0 0x03 0x08 0x01
evt_le_connection_parameters 0xa0 0x0a 0x08 0x02
evt_le_connection_rssi 0xa0 0x03 0x08 0x03
evt_le_connection_phy_status 0xa0 0x02 0x08 0x04
Generic Access Profile
cmd_le_gap_bt5_set_adv_data 0x20 0x03 0x03 0x0c
rsp_le_gap_bt5_set_adv_data 0x20 0x02 0x03 0x0c
cmd_le_gap_bt5_set_adv_parameters 0x20 0x07 0x03 0x0b
rsp_le_gap_bt5_set_adv_parameters 0x20 0x02 0x03 0x0b
cmd_le_gap_bt5_set_mode 0x20 0x06 0x03 0x0a
rsp_le_gap_bt5_set_mode 0x20 0x02 0x03 0x0a
cmd_le_gap_clear_advertise_configuration 0x20 0x05 0x03 0x13
rsp_le_gap_clear_advertise_configuration 0x20 0x02 0x03 0x13
cmd_le_gap_clear_advertise_random_address 0x20 0x01 0x03 0x26
rsp_le_gap_clear_advertise_random_address 0x20 0x02 0x03 0x26
cmd_le_gap_connect 0x20 0x08 0x03 0x1a
rsp_le_gap_connect 0x20 0x03 0x03 0x1a
cmd_le_gap_discover 0x20 0x01 0x03 0x02
rsp_le_gap_discover 0x20 0x02 0x03 0x02
cmd_le_gap_enable_whitelisting 0x20 0x01 0x03 0x21
rsp_le_gap_enable_whitelisting 0x20 0x02 0x03 0x21
cmd_le_gap_end_procedure 0x20 0x00 0x03 0x03
rsp_le_gap_end_procedure 0x20 0x02 0x03 0x03
cmd_le_gap_open 0x20 0x07 0x03 0x00
rsp_le_gap_open 0x20 0x03 0x03 0x00
cmd_le_gap_set_adv_data 0x20 0x02 0x03 0x07
rsp_le_gap_set_adv_data 0x20 0x02 0x03 0x07
cmd_le_gap_set_adv_parameters 0x20 0x05 0x03 0x04
rsp_le_gap_set_adv_parameters 0x20 0x02 0x03 0x04
cmd_le_gap_set_adv_timeout 0x20 0x01 0x03 0x08
rsp_le_gap_set_adv_timeout 0x20 0x02 0x03 0x08
cmd_le_gap_set_advertise_channel_map 0x20 0x02 0x03 0x0f
rsp_le_gap_set_advertise_channel_map 0x20 0x02 0x03 0x0f
cmd_le_gap_set_advertise_configuration 0x20 0x05 0x03 0x12
rsp_le_gap_set_advertise_configuration 0x20 0x02 0x03 0x12
cmd_le_gap_set_advertise_phy 0x20 0x03 0x03 0x11
rsp_le_gap_set_advertise_phy 0x20 0x02 0x03 0x11
cmd_le_gap_set_advertise_random_address 0x20 0x08 0x03 0x25
rsp_le_gap_set_advertise_random_address 0x20 0x08 0x03 0x25
cmd_le_gap_set_advertise_report_scan_request 0x20 0x02 0x03 0x10
rsp_le_gap_set_advertise_report_scan_request 0x20 0x02 0x03 0x10
cmd_le_gap_set_advertise_timing 0x20 0x0c 0x03 0x0e
rsp_le_gap_set_advertise_timing 0x20 0x02 0x03 0x0e
cmd_le_gap_set_advertise_tx_power 0x20 0x03 0x03 0x1b
rsp_le_gap_set_advertise_tx_power 0x20 0x04 0x03 0x1b
cmd_le_gap_set_conn_parameters 0x20 0x08 0x03 0x05
rsp_le_gap_set_conn_parameters 0x20 0x02 0x03 0x05
cmd_le_gap_set_conn_phy 0x20 0x02 0x03 0x09
rsp_le_gap_set_conn_phy 0x20 0x02 0x03 0x09
cmd_le_gap_set_conn_timing_parameters 0x20 0x0c 0x03 0x22
rsp_le_gap_set_conn_timing_parameters 0x20 0x02 0x03 0x22
cmd_le_gap_set_data_channel_classification 0x20 0x01 0x03 0x19
rsp_le_gap_set_data_channel_classification 0x20 0x02 0x03 0x19
cmd_le_gap_set_discovery_extended_scan_response 0x20 0x01 0x03 0x1c
rsp_le_gap_set_discovery_extended_scan_response 0x20 0x02 0x03 0x1c
cmd_le_gap_set_discovery_timing 0x20 0x05 0x03 0x16
rsp_le_gap_set_discovery_timing 0x20 0x02 0x03 0x16
cmd_le_gap_set_discovery_type 0x20 0x02 0x03 0x17
rsp_le_gap_set_discovery_type 0x20 0x02 0x03 0x17
cmd_le_gap_set_long_advertising_data 0x20 0x02 0x03 0x20
rsp_le_gap_set_long_advertising_data 0x20 0x02 0x03 0x20
cmd_le_gap_set_mode 0x20 0x02 0x03 0x01
rsp_le_gap_set_mode 0x20 0x02 0x03 0x01
cmd_le_gap_set_privacy_mode 0x20 0x02 0x03 0x0d
rsp_le_gap_set_privacy_mode 0x20 0x02 0x03 0x0d
cmd_le_gap_set_scan_parameters 0x20 0x05 0x03 0x06
rsp_le_gap_set_scan_parameters 0x20 0x02 0x03 0x06
cmd_le_gap_start_advertising 0x20 0x03 0x03 0x14
rsp_le_gap_start_advertising 0x20 0x02 0x03 0x14
cmd_le_gap_start_discovery 0x20 0x02 0x03 0x18
rsp_le_gap_start_discovery 0x20 0x02 0x03 0x18
cmd_le_gap_start_periodic_advertising 0x20 0x09 0x03 0x1d
rsp_le_gap_start_periodic_advertising 0x20 0x02 0x03 0x1d
cmd_le_gap_stop_advertising 0x20 0x01 0x03 0x15
rsp_le_gap_stop_advertising 0x20 0x02 0x03 0x15
cmd_le_gap_stop_periodic_advertising 0x20 0x01 0x03 0x1f
rsp_le_gap_stop_periodic_advertising 0x20 0x02 0x03 0x1f
evt_le_gap_scan_response 0xa0 0x0b 0x03 0x00
evt_le_gap_adv_timeout 0xa0 0x01 0x03 0x01
evt_le_gap_scan_request 0xa0 0x09 0x03 0x02
evt_le_gap_extended_scan_response 0xa0 0x12 0x03 0x04
Security Manager
cmd_sm_add_to_whitelist 0x20 0x07 0x0f 0x13
rsp_sm_add_to_whitelist 0x20 0x02 0x0f 0x13
cmd_sm_bonding_confirm 0x20 0x02 0x0f 0x0e
rsp_sm_bonding_confirm 0x20 0x02 0x0f 0x0e
cmd_sm_configure 0x20 0x02 0x0f 0x01
rsp_sm_configure 0x20 0x02 0x0f 0x01
cmd_sm_delete_bonding 0x20 0x01 0x0f 0x06
rsp_sm_delete_bonding 0x20 0x02 0x0f 0x06
cmd_sm_delete_bondings 0x20 0x00 0x0f 0x07
rsp_sm_delete_bondings 0x20 0x02 0x0f 0x07
cmd_sm_enter_passkey 0x20 0x05 0x0f 0x08
rsp_sm_enter_passkey 0x20 0x02 0x0f 0x08
cmd_sm_increase_security 0x20 0x01 0x0f 0x04
rsp_sm_increase_security 0x20 0x02 0x0f 0x04
cmd_sm_list_all_bondings 0x20 0x00 0x0f 0x0b
rsp_sm_list_all_bondings 0x20 0x02 0x0f 0x0b
cmd_sm_passkey_confirm 0x20 0x02 0x0f 0x09
rsp_sm_passkey_confirm 0x20 0x02 0x0f 0x09
cmd_sm_set_bondable_mode 0x20 0x01 0x0f 0x00
rsp_sm_set_bondable_mode 0x20 0x02 0x0f 0x00
cmd_sm_set_debug_mode 0x20 0x00 0x0f 0x0f
rsp_sm_set_debug_mode 0x20 0x02 0x0f 0x0f
cmd_sm_set_minimum_key_size 0x20 0x01 0x0f 0x14
rsp_sm_set_minimum_key_size 0x20 0x02 0x0f 0x14
cmd_sm_set_oob_data 0x20 0x01 0x0f 0x0a
rsp_sm_set_oob_data 0x20 0x02 0x0f 0x0a
cmd_sm_set_passkey 0x20 0x04 0x0f 0x10
rsp_sm_set_passkey 0x20 0x02 0x0f 0x10
cmd_sm_set_sc_remote_oob_data 0x20 0x01 0x0f 0x12
rsp_sm_set_sc_remote_oob_data 0x20 0x02 0x0f 0x12
cmd_sm_store_bonding_configuration 0x20 0x02 0x0f 0x02
rsp_sm_store_bonding_configuration 0x20 0x02 0x0f 0x02
cmd_sm_use_sc_oob 0x20 0x01 0x0f 0x11
rsp_sm_use_sc_oob 0x20 0x03 0x0f 0x11
evt_sm_passkey_display 0xa0 0x05 0x0f 0x00
evt_sm_passkey_request 0xa0 0x01 0x0f 0x01
evt_sm_confirm_passkey 0xa0 0x05 0x0f 0x02
evt_sm_bonded 0xa0 0x02 0x0f 0x03
evt_sm_bonding_failed 0xa0 0x03 0x0f 0x04
evt_sm_list_bonding_entry 0xa0 0x08 0x0f 0x05
evt_sm_list_all_bondings_complete 0xa0 0x00 0x0f 0x06
evt_sm_confirm_bonding 0xa0 0x02 0x0f 0x09
Periodic Advertising Synchronization
cmd_sync_close 0x20 0x01 0x42 0x01
rsp_sync_close 0x20 0x02 0x42 0x01
cmd_sync_open 0x20 0x0c 0x42 0x00
rsp_sync_open 0x20 0x03 0x42 0x00
evt_sync_opened 0xa0 0x0e 0x42 0x00
evt_sync_closed 0xa0 0x03 0x42 0x01
evt_sync_data 0xa0 0x05 0x42 0x02
System
cmd_system_data_buffer_clear 0x20 0x00 0x01 0x14
rsp_system_data_buffer_clear 0x20 0x02 0x01 0x14
cmd_system_data_buffer_write 0x20 0x01 0x01 0x12
rsp_system_data_buffer_write 0x20 0x02 0x01 0x12
cmd_system_get_bt_address 0x20 0x00 0x01 0x03
rsp_system_get_bt_address 0x20 0x06 0x01 0x03
cmd_system_get_counters 0x20 0x01 0x01 0x0f
rsp_system_get_counters 0x20 0x0a 0x01 0x0f
cmd_system_get_random_data 0x20 0x01 0x01 0x0b
rsp_system_get_random_data 0x20 0x03 0x01 0x0b
cmd_system_halt 0x20 0x01 0x01 0x0c
rsp_system_halt 0x20 0x02 0x01 0x0c
cmd_system_hello 0x20 0x00 0x01 0x00
rsp_system_hello 0x20 0x02 0x01 0x00
cmd_system_linklayer_configure 0x20 0x02 0x01 0x0e
rsp_system_linklayer_configure 0x20 0x02 0x01 0x0e
cmd_system_reset 0x20 0x01 0x01 0x01
rsp_system_reset 0x20 0x00 0x01 0x01
cmd_system_set_bt_address 0x20 0x06 0x01 0x04
rsp_system_set_bt_address 0x20 0x02 0x01 0x04
cmd_system_set_device_name 0x20 0x02 0x01 0x0d
rsp_system_set_device_name 0x20 0x02 0x01 0x0d
cmd_system_set_identity_address 0x20 0x07 0x01 0x13
rsp_system_set_identity_address 0x20 0x02 0x01 0x13
cmd_system_set_tx_power 0x20 0x02 0x01 0x0a
rsp_system_set_tx_power 0x20 0x02 0x01 0x0a
evt_system_boot 0xa0 0x12 0x01 0x00
evt_system_external_signal 0xa0 0x04 0x01 0x03
evt_system_awake 0xa0 0x00 0x01 0x04
evt_system_hardware_error 0xa0 0x02 0x01 0x05
evt_system_error 0xa0 0x03 0x01 0x06
Testing Commands
cmd_test_dtm_end 0x20 0x00 0x0e 0x02
rsp_test_dtm_end 0x20 0x02 0x0e 0x02
cmd_test_dtm_rx 0x20 0x02 0x0e 0x01
rsp_test_dtm_rx 0x20 0x02 0x0e 0x01
cmd_test_dtm_tx 0x20 0x04 0x0e 0x00
rsp_test_dtm_tx 0x20 0x02 0x0e 0x00
evt_test_dtm_completed 0xa0 0x04 0x0e 0x00
User Messaging
cmd_user_message_to_target 0x20 0x01 0xff 0x00
rsp_user_message_to_target 0x20 0x03 0xff 0x00
evt_user_message_to_host 0xa0 0x01 0xff 0x00
* Length does not include the array length in case parameters contain array.