Bluetooth LE Profile API document
Bluetooth LE Profile API document Rev.1.00 [May 22, 2020]

Detailed Description

Enumerations

enum  e_r_ble_vs_evt_t {
  BLE_VS_EVENT_SET_TX_POWER = 0x8001,
  BLE_VS_EVENT_GET_TX_POWER = 0x8002,
  BLE_VS_EVENT_TX_TEST_START = 0x8003,
  BLE_VS_EVENT_TX_TEST_TERM = 0x8004,
  BLE_VS_EVENT_RX_TEST_START = 0x8005,
  BLE_VS_EVENT_TEST_END = 0x8006,
  BLE_VS_EVENT_SET_CODING_SCHEME_COMP = 0x8007,
  BLE_VS_EVENT_RF_CONTROL_COMP = 0x8008,
  BLE_VS_EVENT_SET_ADDR_COMP = 0x8009,
  BLE_VS_EVENT_GET_ADDR_COMP = 0x800A,
  BLE_VS_EVENT_GET_RAND = 0x800B,
  BLE_VS_EVENT_TX_FLOW_STATE_CHG = 0x800C,
  BLE_VS_EVENT_FAIL_DETECT = 0x800D,
  BLE_VS_EVENT_INVALID = 0x80FF
}
 Vendor Specific Event Identifier. More...
 

Enumeration Type Documentation

◆ e_r_ble_vs_evt_t

Vendor Specific Event Identifier.

Enumerator
BLE_VS_EVENT_SET_TX_POWER 

This event notifies that the tx power has been set by R_BLE_VS_SetTxPower().

Event Code: 0x8001

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The tx_power parameter specified by R_BLE_VS_SetTxPower() is out of range.
BLE_ERR_INVALID_HDL(0x000E) The link identified with the conn_hdl specified by R_BLE_VS_SetTxPower() is not found.

Event Data:

st_ble_vs_set_tx_pwr_comp_evt_t

BLE_VS_EVENT_GET_TX_POWER 

This event notifies that the tx power has been acquired by R_BLE_VS_GetTxPower().

Event Code: 0x8002

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_HDL(0x000E) The link identified with the conn_hdl specified by R_BLE_VS_GetTxPower() is not found.

Event Data:

st_ble_vs_get_tx_pwr_comp_evt_t

BLE_VS_EVENT_TX_TEST_START 

This event notifies that the extended transmitter test has been started by R_BLE_VS_StartTxTest().

Event Code: 0x8003

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The parameter specified by R_BLE_VS_StartTxTest() is out of range.

Event Data:

none

BLE_VS_EVENT_TX_TEST_TERM 

This event notifies that the number specified by R_BLE_VS_StartTxTest() of packets has been sent.

Event Code: 0x8004

result:

BLE_SUCCESS(0x0000) Success

Event Data:

none

BLE_VS_EVENT_RX_TEST_START 

This event notifies that the extended receiver test has been started by R_BLE_VS_StartRxTest().

Event Code: 0x8005

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The parameter specified by R_BLE_VS_StartRxTest() is out of range.

Event Data:

none

BLE_VS_EVENT_TEST_END 

This event notifies that the extended test has been terminated by R_BLE_VS_EndTest().

Event Code: 0x8006

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_vs_test_end_evt_t

BLE_VS_EVENT_SET_CODING_SCHEME_COMP 

This event notifies that the coding scheme has been configured by R_BLE_VS_SetCodingScheme().

Event Code: 0x8007

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The coding_scheme parameter specified by R_BLE_VS_SetCodingScheme() is out of range.

Event Data:

none

BLE_VS_EVENT_RF_CONTROL_COMP 

This event notifies that the RF has been configured by R_BLE_VS_SetRfControl().

Event Code: 0x8008

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The parameter specified by R_BLE_VS_SetRfControl() is out of range.
BLE_ERR_INVALID_OPERATION(0x0009) During the power on or the power off, the same power state is specified by R_BLE_VS_SetRfControl().

Event Data:

st_ble_vs_set_rf_ctrl_comp_evt_t

BLE_VS_EVENT_SET_ADDR_COMP 

This event notifies that public/random address has been set by R_BLE_VS_SetBdAddr().

Event Code: 0x8009

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The area parameter or the type field in the p_addr parameter specified by R_BLE_VS_SetBdAddr() is out of range.

Event Data:

none

BLE_VS_EVENT_GET_ADDR_COMP 

This event notifies that public/random address has been acquired by R_BLE_VS_GetBdAddr().

Event Code: 0x800A

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The area parameter or the type field in the p_addr parameter specified by R_BLE_VS_GetBdAddr() is out of range.

Event Data:

st_ble_vs_get_bd_addr_comp_evt_t

BLE_VS_EVENT_GET_RAND 

This event notifies the application layer that random number has been generated by R_BLE_VS_GetRand().

Event Code: 0x800B

result:

BLE_SUCCESS(0x0000) Success
BLE_ERR_INVALID_ARG(0x0003) The rand_size parameter specified by R_BLE_VS_GetRand() is out of range.

Event Data:

st_ble_vs_get_rand_comp_evt_t

BLE_VS_EVENT_TX_FLOW_STATE_CHG 

This event notifies the application layer of the state transition of TxFlow.

Event Code: 0x800C

result:

BLE_SUCCESS(0x0000) Success

Event Data:

st_ble_vs_tx_flow_chg_evt_t

BLE_VS_EVENT_FAIL_DETECT 

This event notifies a failure occurs in RF. After receiving the event, reset MCU or RF.

Event Code: 0x800D

result:

BLE_SUCCESS(0x0000) Success

Event Data:

None

BLE_VS_EVENT_INVALID 

Invalid VS Event.

Event Code: 0x80FF

result:

BLE_SUCCESS(0x0000) Success

Event Data:

none