Bluetooth Low Energy

This API provides Bluetooth GATT functionality to enable communication with Bluetooth 4.0 devices.

LinkIt ONE provides built-in Bluetooth 4.0 Generic Attribute Profile(GATT) to transmit arbitrary data between devices. The GATT profile is a general specification for sending and receiving short pieces of data known as "attributes" over a Bluetooth 4.0 link. All current Bluetooth Low Energy application profiles are based on GATT.

All the APIs in the GATT module are asynchronous, which means the functions are mere a request passing to underlying framework for execution. The execution results are then passed back from callback functions. Therefore, you can initialize the GATT server and client module by registering a set of callback functions.

Limitation

This API doesn't support multiple connections - only one-to-one connection at a time.

Functions

Function	Description
vm_bt_gatt_client_connect	Send connect remote device to GATT
vm_bt_gatt_client_deregister	De-register confirm callback
vm_bt_gatt_client_deregister_for_notification	De-registers a previous request for notifications/indications.
vm_bt_gatt_client_disconnect	Send disconnect remote device to GATT
vm_bt_gatt_client_execute_write	Send a command to server to execute a prepared write operation.
vm_bt_gatt_client_get_characteristic	Enumerates characteristics for a given service. Set start_characteristic_uuid to NULL to get the first characteristic.
vm_bt_gatt_client_get_descriptor	Enumerates descriptors for a given characteristic. Set start_descriptor_id to NULL to get the first descriptor.
vm_bt_gatt_client_get_device_type	Determines the type of the remote device (LE, BR/EDR, Dual-mode)
vm_bt_gatt_client_get_included_service	Enumerates included services for a given parent service. Set start_include_service_id to NULL to get the first included service. The result is passed back from callback vm_bt_gatt_get_included_service_callback. After receiving the included service UUID, call vm_bt_gatt_client_get_included_service again and set include_svc_uuid to the service UUID to query the next included service in the parent service.
vm_bt_gatt_client_listen	Sends listen request to listen connect indicate during disconnected state
vm_bt_gatt_client_read_characteristic	Read characteristic value, can be larger than MTU.
vm_bt_gatt_client_read_descriptor	Read characteristic descriptor value.
vm_bt_gatt_client_read_remote_rssi	Requests the RSSI for a given remote device. The result is passed from vm_bt_gatt_read_remote_rssi_callback.
vm_bt_gatt_client_register	Registers a GATT client application with the stack. The resulting client context is passed from vm_bt_gatt_register_client_callback.
vm_bt_gatt_client_register_for_notification	Register to listen the notification or indication of a certain characteristic from a connected server
vm_bt_gatt_client_scan	Starts or stops LE device scanning.
vm_bt_gatt_client_search_service	Enumerates all GATT services on a connected device. Optionally, the results can be filtered for a given UUID.
vm_bt_gatt_client_write_characteristic	Write characteristic value, can be larger than MTU.
vm_bt_gatt_client_write_descriptor	Write characteristic descriptor value.
vm_bt_gatt_server_add_characteristic	Adds a characteristic to a service.
vm_bt_gatt_server_add_descriptor	Adds a descriptor to a given service.
vm_bt_gatt_server_add_included_service	Assign an included service to it's parent service. To include multiple services to a parent service, call this function multiple times.
vm_bt_gatt_server_add_service	Creates a new service. The result and corresponding service handle is passed to vm_bt_gatt_service_added_callback for each services created. Therefore, vm_bt_gatt_service_added_callback will be invoked 5 times if num_handles is set to 5.
vm_bt_gatt_server_connect	Connect Request
vm_bt_gatt_server_delete_service	Deletes a local service.
vm_bt_gatt_server_deregister	De-register profile from GATT
vm_bt_gatt_server_disconnect	Disconnect request
vm_bt_gatt_server_listen	Send listen request to listen connect indicate during disconnect state.
vm_bt_gatt_server_read_tx_power	Queries tx power of local device. For Proximity profile. (Songmin Liao)
vm_bt_gatt_server_register	Registers a GATT server application with the stack.
vm_bt_gatt_server_send_indication	Notify/Indicate data to Client
vm_bt_gatt_server_send_response	Send response to client for write request
vm_bt_gatt_server_set_advertisement_data	Configures server advertisement behavior and packet data.
vm_bt_gatt_server_start_service	Start service(add service to ATT database)
vm_bt_gatt_server_stop_service	Stops a local service.

Macros

Macro	Description
VM_BT_GATT_ADDRESS_SIZE	GATT attribute handle
VM_BT_GATT_ATTRIBUTE_HANDLE	GATT attribute handle
VM_BT_GATT_ATTRIBUTE_MAX_VALUE_LENGTH	GATT attribute max value length
VM_BT_GATT_CLIENT_AUTH_REQ_MITM	Authenticated encryption.
VM_BT_GATT_CLIENT_AUTH_REQ_NO_MITM	Unauthenticated encryption.
VM_BT_GATT_CLIENT_AUTH_REQ_NONE	Nothing.
VM_BT_GATT_CLIENT_AUTH_REQ_SIGNED_MITM	Singed with MITM proection.
VM_BT_GATT_CLIENT_AUTH_REQ_SIGNED_NO_MITM	Signed no MITM protection.
VM_BT_GATT_CLIENT_DEV_TYPE_BR_EDR	Br edr device.
VM_BT_GATT_CLIENT_DEV_TYPE_BR_EDR_LE	Br edr low energy device.
VM_BT_GATT_CLIENT_DEV_TYPE_LE	Low energy device.
VM_BT_GATT_CLIENT_DEV_TYPE_UNKNOWN	Unknown device.
VM_BT_GATT_CLIENT_WRITE_TYPE_NO_RSP	Write with no response.
VM_BT_GATT_CLIENT_WRITE_TYPE_PREPARE	Write prepare.
VM_BT_GATT_CLIENT_WRITE_TYPE_REQUEST	Write request.
VM_BT_GATT_PERMISSION_READ	bit 0
VM_BT_GATT_PERMISSION_READ_ENC_MITM	bit 2
VM_BT_GATT_PERMISSION_READ_ENCRYPTED	bit 1
VM_BT_GATT_PERMISSION_WRITE	bit 4
VM_BT_GATT_PERMISSION_WRITE_ENC_MITM	bit 6
VM_BT_GATT_PERMISSION_WRITE_ENCRYPTED	bit 5
VM_BT_GATT_PERMISSION_WRITE_SIGNED	bit 7
VM_BT_GATT_PERMISSION_WRITE_SIGNED_MITM	bit 8

Structs, Records, Enums

Struct, Record, Enum	Description
vm_bt_gatt_address_t	GATT address
vm_bt_gatt_attribute_uuid_t	GATT attribute UUID
vm_bt_gatt_attribute_value_t	GATT attribute value
vm_bt_gatt_client_callback_t	GATT service callback function structure
vm_bt_gatt_client_characteristic_t	GATT client characteristic structure
vm_bt_gatt_client_descriptor_t	GATT client descriptor structure
vm_bt_gatt_connection_t	GATT connection handle structure
vm_bt_gatt_server_callback_t	GATT service callback function structure
vm_bt_gatt_service_info_t	GATT Service
vm_bt_uuid_with_length_t	Bluetooth UUID

Types

Type	Description
VM_BT_GATT_CHAR_PROPERTIES	GATT characteristic properties. These are bit flags
vm_bt_gatt_characteristic_added_callback	Callback invoked when a characteristic has been added to a service
VM_BT_GATT_CLIENT_AUTH_REQ	authentication requirement
VM_BT_GATT_CLIENT_DEV_TYPE	GATT client device types
VM_BT_GATT_CLIENT_WRITE_TYPE	GATT client write types
vm_bt_gatt_connection_callback	Connect confirm callback
VM_BT_GATT_CONNECTION_HANDLE	GATT connection handle
VM_BT_GATT_CONTEXT_HANDLE	GATT context handle
vm_bt_gatt_descriptor_added_callback	Callback invoked when a descriptor has been added to a characteristic
vm_bt_gatt_execute_write_callback	GATT execute prepared write callback.
vm_bt_gatt_get_characteristic_callback	Get characteristic confirm callback
vm_bt_gatt_get_descriptor_callback	GATT descriptor enumeration result callback.
vm_bt_gatt_get_device_type_callback	Callback invoked in response to get_device_type.
vm_bt_gatt_get_included_service_callback	GATT included service enumeration result callback.
vm_bt_gatt_included_service_added_callback	Callback indicating that an included service has been added to a service
vm_bt_gatt_listen_callback	Listen confirm callback
vm_bt_gatt_notify_callback	Remote device notification callback, invoked when a remote device sends a notification or indication that a client has registered.
VM_BT_GATT_PERMISSION	GATT characteristic permission
vm_bt_gatt_read_characteristic_callback	Read characteristic value confirm callback
vm_bt_gatt_read_descriptor_callback	Read characteristic descriptor value confirm callback
vm_bt_gatt_read_remote_rssi_callback	Callback invoked in response to read_remote_rssi.
vm_bt_gatt_read_tx_power_callback	Callback triggered in response to read_tx_power
vm_bt_gatt_register_client_callback	Callback invoked in response to register.
vm_bt_gatt_register_for_notification_callback	Register notification callback
vm_bt_gatt_register_server_callback	The callback for vm_bt_gatt_server_register.
vm_bt_gatt_request_exec_write_callback	Callback invoked when a previously prepared write is to be executed
vm_bt_gatt_request_read_callback	Client read characteristic request indication
vm_bt_gatt_request_write_callback	Client write characteristic request indication
vm_bt_gatt_response_confirmation_callback	Send response confirm callback
vm_bt_gatt_scan_result_callback	Callback for scan results.
vm_bt_gatt_search_complete_callback	Search complete
vm_bt_gatt_search_result_callback	Indicates the profile when finding one primary service, the profile can save it in its own field
vm_bt_gatt_service_added_callback	Callback invoked in response to create_service
vm_bt_gatt_service_deleted_callback	Callback triggered when a service has been deleted
vm_bt_gatt_service_started_callback	Start service callback
vm_bt_gatt_service_stopped_callback	Callback invoked in response to stop_service
vm_bt_gatt_set_advertisement_data_callback	Callback triggered in response to set_advertisement_data.
vm_bt_gatt_write_characteristic_callback	Write characteristic value confirm callback
vm_bt_gatt_write_descriptor_callback	Read characteristic descriptor value confirm callback

Links

Topics, Functions, Macros, 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.