Connection Manager

Provides functions for applications to configure, monitor, search Bluetooth connections.

An application calls vm_bt_cm_init() to initialize a Bluetooth module and register a callback for various connection events, and calls vm_bt_cm_exit() to exit and release resources from the Bluetooth module. The application can turn on or turn off the Bluetooth by calling vm_bt_cm_switch_on() or vm_bt_cm_switch_off(). It sets the Bluetooth visibility through vm_bt_cm_set_visibility(), so that the Bluetooth device becomes discoverable. It also can search for the Bluetooth enabled device around by calling vm_bt_cm_search().

N/A

Function	Description
vm_bt_cm_exit	Exits the Bluetooth Connection Manager and releases the resources.
vm_bt_cm_get_device_info_by_index	Gets the device info
vm_bt_cm_get_device_number	Gets the device number according to device type
vm_bt_cm_get_host_device_info	Gets the host device information.
vm_bt_cm_get_power_status	Gets the current power status of the Bluetooth.
vm_bt_cm_get_visibility	This function is to get the BT visibility
vm_bt_cm_init	Initializes the Bluetooth Connection Manager and registers the callback. The callback will be triggered when the events occur, as specified by the event_mask.
vm_bt_cm_release_all_connection	Releases all active Bluetooth connections. When it completes, the callback is invoked through the VM_BT_CM_EVENT_RELEASE_ALL_CONN event.
vm_bt_cm_search	Searches for the Bluetooth devices.The search process could trigger two events, the VM_BT_CM_EVENT_INQUIRY_IND and VM_BT_CM_EVENT_INQUIRY_COMPLETE, which in turn triggers the callback.
vm_bt_cm_search_abort	Aborts the search process. It invokes srv_bt_cm_cancel_discovery_req_hdler. A callback will be invoked by the VM_BT_CM_EVENT_INQUIRY_COMPLETE event, after the cancelling of the search procedure is complete.
vm_bt_cm_send_passkey	Processes the pairing request and sends the passkey when the VM_BT_CM_PAIR_IND event occurs.
vm_bt_cm_set_bt_pairing_type	Sets the Bluetooth pairing type. This function should be called prior to the VM_BT_CM_PAIR_IND event occurs, to properly configure the expected pairing method.
vm_bt_cm_set_host_name	Sets the host device name. It will trigger the VM_BT_CM_EVENT_SET_NAME event, after the host device name procedure is completed.
vm_bt_cm_set_visibility	Sets the Bluetooth visibility, so that other devices can detect it.
vm_bt_cm_switch_off	Switches off the Bluetooth chipset. It also deactivates the Bluetooth profiles. If there are any active connections, it will disconnect the connections before switching off the Bluetooth chipset.
vm_bt_cm_switch_on	Switches on the Bluetooth chipset. It also activates the Bluetooth profiles that are registered to the Connection Manager.

Structs, Records, Enums

Struct, Record, Enum	Description
vm_bt_cm_activate_t	Event struct for VM_BT_CM_EVENT_ACTIVATE & VM_BT_CM_EVENT_BLE_ACTIVATE.
vm_bt_cm_bt_address_t	Bluetooth address.
vm_bt_cm_deactivate_t	Event struct for VM_BT_CM_EVENT_DEACTIVATE.
VM_BT_CM_DEV_TYPE	Bluetooth device type
vm_bt_cm_device_info_t	Device info structure.
VM_BT_CM_ERROR	Error code of the Bluetooth
VM_BT_CM_EVENT	Event definitions of the Bluetooth
vm_bt_cm_inquiry_complete_t	Event struct for VM_BT_CM_EVENT_INQUIRY_COMPLETE
vm_bt_cm_inquiry_indication_t	Event struct for VM_BT_CM_EVENT_INQUIRY_IND.
vm_bt_cm_pair_indication_t	Pairing indication struct.
VM_BT_CM_PAIRING_TYPE	Pairing method.
VM_BT_CM_POWER_STATUS	The power status of the Bluetooth.
vm_bt_cm_set_name_t	Event struct for VM_BT_CM_EVENT_SET_NAME.
vm_bt_cm_set_visibility_t	Event struct for VM_BT_CM_EVENT_SET_VISIBILITY.
VM_BT_CM_VISIBILITY_TYPE	Bluetooth visibility type enum

Types

Type	Description
vm_bt_cm_callback	The prototype of the callback function for event notification from the Bluetooth Connection Manager.
VM_BT_CM_HANDLE	Bluetooth Connection Manager resource handle

Links

Topics, Functions, Structs, Records, Enums, Types

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

support@toolsfactory.com.