Bluetooth module operations. More...

#include <bluetooth/artik_bluetooth.h>

Data Fields
artik_error(*	start_scan )()
	Starts the device discovery. More...

artik_error(*	stop_scan )()
	Stops the device discovery. More...

artik_error(*	get_device )(const char addr, artik_bt_device device)
	Get device properties. More...

artik_error(*	get_devices )(artik_bt_device_type device_type, artik_bt_device *devices, int num_devices)
	Get devices list. More...

artik_error(*	start_bond )(const char *addr)
	Create a bond with a remote Bluetooth device, asynchronously. More...

artik_error(*	stop_bond )(const char *addr)
	Cancel the bonding process. More...

artik_error(*	connect )(const char *addr)
	Connect to the device. More...

artik_error(*	disconnect )(const char *addr)
	Disconnect to the device. More...

artik_error(*	free_device )(artik_bt_device *device)
	Free the memory used by the remote device. More...

artik_error(*	free_devices )(artik_bt_device **device_list, int count)
	Free devices list. More...

artik_error(*	init )(void)
	initialize Bluetooth APIs to be ready to use More...

artik_error(*	deinit )(void)
	deinitialize Bluetooth APIs. This should be called when APIs are no longer used. More...

artik_error(*	set_callback )(artik_bt_event event, artik_bt_callback user_callback, void *user_data)
	Register a callback function to be invoked when the device discovery state changes. More...

artik_error(*	set_callbacks )(artik_bt_callback_property *user_callbacks, unsigned int size)
	Register callbacks function to be invoked when the device discovery state changes. More...

artik_error(*	unset_callback )(artik_bt_event event)
	Unregister the callback function. More...

artik_error(*	remove_unpaired_devices )()
	Remove unpaired device in list, synchronously.

artik_error(*	remove_device )(const char *addr)
	Destroy the bond, asynchronously. More...

artik_error(*	set_scan_filter )(artik_bt_scan_filter *filter)
	Set the device discovery filter. More...

artik_error(*	set_alias )(const char *alias)
	Set the bluetooth friendly name. More...

artik_error(*	set_discoverable )(bool discoverable)
	Switch the bluetooth adapter on or off. More...

artik_error(*	set_pairable )(bool pairable)
	Switch an adapter to pairable or non-pairable. More...

artik_error(*	set_pairableTimeout )(unsigned int timeout)
	Set the pairable timeout. More...

artik_error(*	set_discoverableTimeout )(unsigned int timeout)
	Set the discoverable timeout. More...

bool(*	is_scanning )(void)
	Indicate that a device discovery procedure is active. More...

artik_error(*	get_adapter_info )(artik_bt_adapter *adapter)
	Get the adapter information. More...

artik_error(*	remove_devices )(void)
	Remove all discovred devices. More...

artik_error(*	connect_profile )(const char addr, const char uuid)
	Connect a specific profile of a remote device. More...

artik_error(*	set_trust )(const char *addr)
	Seen the remote device as trusted. More...

artik_error(*	unset_trust )(const char *addr)
	Seen the remote device as untrusted. More...

artik_error(*	set_block )(const char *addr)
	Reject any incomming connections from the remote device. More...

artik_error(*	unset_block )(const char *addr)
	Accept all incoming connections from the remote device. More...

bool(*	is_paired )(const char *addr)
	Indicate if the remote device is paired. More...

bool(*	is_connected )(const char *addr)
	Indicate if the remote device is connected. More...

bool(*	is_trusted )(const char *addr)
	Indicate if the remote device is trusted. More...

bool(*	is_blocked )(const char *addr)
	Indicate if the remote device is blocked. More...

artik_error(*	gatt_add_service )(artik_bt_gatt_service svc, int *id)
	Add a new GATT service. More...

artik_error(*	gatt_add_characteristic )(int svc_id, artik_bt_gatt_chr chr, int *id)
	Add a new GATT characteristic. More...

artik_error(*	gatt_add_descriptor )(int service_id, int char_id, artik_bt_gatt_desc desc, int *id)

artik_error(*	gatt_remove_service )(int sid)

artik_error(*	gatt_remove_characteristic )(int sid, int cid)

artik_error(*	gatt_remove_descriptor )(int sid, int cid, int did)

artik_error(*	gatt_set_char_on_read_request )(int svc_id, int char_id, artik_bt_gatt_req_read callback, void *user_data)
	Set callback for handle read request of a GATT characteristic. More...

artik_error(*	gatt_set_char_on_write_request )(int svc_id, int char_id, artik_bt_gatt_req_write callback, void *user_data)
	Set callback for handle write request of a GATT characteristic. More...

artik_error(*	gatt_set_char_on_notify_request )(int svc_id, int char_id, artik_bt_gatt_req_notify callback, void *user_data)
	Set callback for handle notify request of a GATT characteristic. More...

artik_error(*	gatt_set_desc_on_read_request )(int svc_id, int char_id, int desc_id, artik_bt_gatt_req_read callback, void *user_data)
	Set callback for handle read request of a GATT descriptor. More...

artik_error(*	gatt_set_desc_on_write_request )(int svc_id, int char_id, int desc_id, artik_bt_gatt_req_write callback, void *user_data)
	Set callback for handle write request of a GATT descriptor. More...

artik_error(*	gatt_register_service )(int id)
	Register a local GATT services hierarchy. More...

artik_error(*	gatt_unregister_service )(int id)
	Unregister the service that has been previously registred with gatt_register_service. More...

artik_error(*	gatt_get_service_list )(const char addr, artik_bt_uuid uuid_list, int len)
	List the service of a remote device. More...

artik_error(*	gatt_get_characteristic_list )(const char addr, const char srv_uuid, artik_bt_uuid *uuid_list, int len)
	List the characteristic of a remote GATT service. More...

artik_error(*	gatt_get_descriptor_list )(const char addr, const char srv_uuid, const char char_uuid, artik_bt_uuid uuid_list, int len)
	List the descriptors of a remote GATT characteristic. More...

artik_error(*	gatt_char_read_value )(const char addr, const char srv_uuid, const char char_uuid, unsigned char byte, int byte_len)
	Read the value of a remote GATT characteristic. More...

artik_error(*	gatt_char_write_value )(const char addr, const char srv_uuid, const char *char_uuid, const unsigned char byte[], int byte_len)
	Write the value contains in byte in a remote GATT characteristic. More...

artik_error(*	gatt_desc_read_value )(const char addr, const char srv_uuid, const char char_uuid, const char desc_uuid, unsigned char *byte, int byte_len)
	Read the value of a remote GATT descriptor. More...

artik_error(*	gatt_desc_write_value )(const char addr, const char srv_uuid, const char char_uuid, const char desc_uuid, const unsigned char byte[], int byte_len)
	Write the value contains in byte in a remote GATT characteristic. More...

artik_error(*	gatt_start_notify )(const char addr, const char srv_uuid, const char *char_uuid)
	Start a notification session from a remote GATT characteristic. More...

artik_error(*	gatt_stop_notify )(const char addr, const char srv_uuid, const char *char_uuid)
	Stop a notification session from a remote GATT characteristic. More...

artik_error(*	gatt_get_char_properties )(const char addr, const char srv_uuid, const char char_uuid, artik_bt_gatt_char_properties properties)
	Get the properties of a remote GATT characteristic. More...

artik_error(*	register_advertisement )(artik_bt_advertisement user_adv, int id)
	Register an advertisement object to sent over the LE advertising chanel. More...

artik_error(*	unregister_advertisement )(int id)
	Unregister an advertisement object. More...

artik_error(*	gatt_req_set_value )(artik_bt_gatt_req req, int len, const unsigned char *value)
	Send a response to a read request. More...

artik_error(*	gatt_req_set_result )(artik_bt_gatt_req req, artik_bt_gatt_req_state_type state, const char *err_msg)
	Send a status to a request. More...

artik_error(*	gatt_notify )(int svc_id, int char_id, unsigned char *byte, int len)
	Send a characteristic value notification or indication. More...

artik_error(*	avrcp_controller_change_folder )(int index)
	Change to the specified folder. Index 0 to change to now playing folder. Returned index from list item to change to other folders. More...

artik_error(*	avrcp_controller_list_item )(int start_item, int end_item, artik_bt_avrcp_item **item_list)
	List the items of the folder. More...

artik_error(*	avrcp_controller_free_items )(artik_bt_avrcp_item **item_list)
	Free the item list returned by avrcp_controller_list_item. More...

artik_error(*	avrcp_controller_get_repeat_mode )(artik_bt_avrcp_repeat_mode *repeat_mode)
	Get the repeat mode of the player. More...

artik_error(*	avrcp_controller_set_repeat_mode )(artik_bt_avrcp_repeat_mode repeat_mode)
	Change the repeat mode of the player. More...

bool(*	avrcp_controller_is_connected )(void)
	Whether an AVRCP target is connected with current device. More...

artik_error(*	avrcp_controller_resume_play )(void)
	Control remote AVRCP target to resume play. More...

artik_error(*	avrcp_controller_pause )(void)
	Control remote AVRCP target to pause play. More...

artik_error(*	avrcp_controller_stop )(void)
	Control remote AVRCP target to stop play. More...

artik_error(*	avrcp_controller_next )(void)
	Control remote AVRCP target to play the next item. More...

artik_error(*	avrcp_controller_previous )(void)
	Control remote AVRCP target to play the previous item. More...

artik_error(*	avrcp_controller_fast_forward )(void)
	Control remote AVRCP target to fast forward current item. More...

artik_error(*	avrcp_controller_rewind )(void)
	Control remote AVRCP target to rewind current item. More...

artik_error(*	avrcp_controller_get_property )(int index, artik_bt_avrcp_item_property **properties)
	Get the item property. More...

artik_error(*	avrcp_controller_free_property )(artik_bt_avrcp_item_property **properties)
	Free an item property. More...

artik_error(*	avrcp_controller_play_item )(int index)
	Play the item. More...

artik_error(*	avrcp_controller_add_to_playing )(int index)
	Add the item to the playing list. More...

artik_error(*	avrcp_controller_get_name )(char **name)
	Get a player name from an AVRCP target . More...

artik_error(*	avrcp_controller_get_status )(char **status)
	Get a player status from an AVRCP target . More...

artik_error(*	avrcp_controller_get_subtype )(char **subtype)
	Get a player subtype from an AVRCP target . More...

artik_error(*	avrcp_controller_get_type )(char **type)
	Get a player type from an AVRCP target . More...

bool(*	avrcp_controller_is_browsable )(void)
	Whether the player is browsable. More...

artik_error(*	avrcp_controller_get_position )(unsigned int *position)
	Get a playback position from an AVRCP target . More...

artik_error(*	avrcp_controller_get_metadata )(artik_bt_avrcp_track_metadata **data)
	Get current track metadata from an AVRCP target. More...

artik_error(*	avrcp_controller_free_metadata )(artik_bt_avrcp_track_metadata **data)
	Free a metadata. More...

artik_error(*	pan_register )(const char uuid, const char bridge)
	register the pan services. More...

artik_error(*	pan_unregister )(const char *uuid)
	unregister the pan services. More...

artik_error(*	pan_connect )(const char mac_addr, const char uuid, char **network_interface)
	connect the pan services to another. More...

artik_error(*	pan_disconnect )(void)
	disconnect the pan services. More...

bool(*	pan_is_connected )(void)
	get the status of the connection. More...

artik_error(*	pan_get_interface )(char **_interface)
	get the connection interface of the connection. More...

artik_error(*	pan_get_UUID )(char **uuid)
	get the device uuid. More...

artik_error(*	spp_register_profile )(artik_bt_spp_profile_option *opt)
	spp register profile. More...

artik_error(*	spp_unregister_profile )()
	spp unregister profile. More...

artik_error(*	ftp_create_session )(char *dest_addr)
	create ftp session with FTP server. More...

artik_error(*	ftp_remove_session )(void)
	remove ftp session. More...

artik_error(*	ftp_change_folder )(char *folder)
	ftp browse change folder. More...

artik_error(*	ftp_create_folder )(char *folder)
	ftp create folder. More...

artik_error(*	ftp_delete_file )(char *file)
	ftp delete file. More...

artik_error(*	ftp_list_folder )(artik_bt_ftp_file **file_list)
	ftp list the folders/files. More...

artik_error(*	ftp_free_list )(artik_bt_ftp_file **file_list)
	free the memory of ftp list. More...

artik_error(*	ftp_get_file )(char target_file, char source_file)
	ftp download file. More...

artik_error(*	ftp_put_file )(char source_file, char target_file)
	ftp upload file. More...

artik_error(*	ftp_resume_transfer )(void)
	ftp resume transfer file. More...

artik_error(*	ftp_suspend_transfer )(void)
	ftp suspend transfer file. More...

artik_error(*	agent_register_capability )(artik_bt_agent_capability e)
	Register agent with capability. More...

artik_error(*	agent_set_default )(void)
	Set the registered agent as default agent. More...

artik_error(*	agent_unregister )(void)
	Unregisters the agent that has been registered. More...

artik_error(*	agent_send_pincode )(artik_bt_agent_request_handle handle, char *pincode)
	Send the pincode to the bluetooth service. More...

artik_error(*	agent_send_passkey )(artik_bt_agent_request_handle handle, unsigned int passkey)
	Send the passkey to the bluetooth service. More...

artik_error(*	agent_send_error )(artik_bt_agent_request_handle handle, artik_bt_agent_request_error e, const char *err_msg)
	Send an error to the bluetooth service. More...

artik_error(*	agent_send_empty_response )(artik_bt_agent_request_handle handle)
	Send an empty response to the bluetooth service. More...

artik_error(*	a2dp_source_get_state )(char **state)
	Get the state of A2DP media streaming transport. More...

Detailed Description

Structure containing all the operations exposed by the Bluetooth module.

Examples:: bluetooth_test/artik_bluetooth_test.c, bluetooth_test/artik_bluetooth_test_advertiser.c, bluetooth_test/artik_bluetooth_test_agent.c, bluetooth_test/artik_bluetooth_test_avrcp.c, bluetooth_test/artik_bluetooth_test_ftp.c, bluetooth_test/artik_bluetooth_test_gatt_client.c, bluetooth_test/artik_bluetooth_test_gatt_server.c, bluetooth_test/artik_bluetooth_test_nap.c, bluetooth_test/artik_bluetooth_test_panu.c, bluetooth_test/artik_bluetooth_test_spp.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1004 of file artik_bluetooth.h.

Field Documentation

artik_error(* artik_bluetooth_module::a2dp_source_get_state) (char **state)

Parameters

[out] state of A2DP media transport, possible values : "idle": not streaming "pending": streaming but not acquired "active": streaming and acquired

Returns: S_OK on success, otherwise a negative error value.

Definition at line 2090 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::agent_register_capability) (artik_bt_agent_capability e)

Parameters

[in] e The capability which reflects the input and output capabilities of the agent

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_agent.c, bluetooth_test/artik_bluetooth_test_gatt_server.c, and bluetooth_test/artik_bluetooth_test_spp.c.

Definition at line 2021 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::agent_send_empty_response) (artik_bt_agent_request_handle handle)

After a call to this function handle becomes an invalid value.

Parameters

[in] handle Handle tied to a bluetooth service request

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_agent.c, bluetooth_test/artik_bluetooth_test_gatt_server.c, and bluetooth_test/artik_bluetooth_test_spp.c.

Definition at line 2079 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::agent_send_error) (artik_bt_agent_request_handle handle, artik_bt_agent_request_error e, const char *err_msg)

After a call to this function handle becomes an invalid value.

Parameters

[in]	handle	Handle tied to a bluetooth service request
[in]	e	The error sends to the bluetooth service

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_agent.c, and bluetooth_test/artik_bluetooth_test_spp.c.

Definition at line 2068 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::agent_send_passkey) (artik_bt_agent_request_handle handle, unsigned int passkey)

After a call to this function handle becomes an invalid value.

Parameters

[in]	handle	Handle tied to a bluetooth service request
[in]	passkey	Numeric value containing the passkey sends to the bluetooth service. The passkey shoule be a numeric value between 0-999999

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_agent.c, and bluetooth_test/artik_bluetooth_test_spp.c.

Definition at line 2057 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::agent_send_pincode) (artik_bt_agent_request_handle handle, char *pincode)

Parameters

[in]	handle	Handle tied to a bluetooth service request
[in]	pincode	String containing the pincode sends to the bluetooth service The pincode should be an alphanumeric string of 1-16 characters.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_agent.c, and bluetooth_test/artik_bluetooth_test_spp.c.

Definition at line 2045 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::agent_set_default) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_agent.c, bluetooth_test/artik_bluetooth_test_gatt_server.c, and bluetooth_test/artik_bluetooth_test_spp.c.

Definition at line 2028 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::agent_unregister) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_agent.c, bluetooth_test/artik_bluetooth_test_gatt_server.c, and bluetooth_test/artik_bluetooth_test_spp.c.

Definition at line 2035 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_add_to_playing) (int index)

Parameters

[in] index To be add to the playing list

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1759 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_change_folder) (int index)

Parameters

[in] index The index of folder it will be changed to.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1621 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_fast_forward) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1713 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_free_items) (artik_bt_avrcp_item **item_list)

Parameters

[in] item_list The item list

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1644 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_free_metadata) (artik_bt_avrcp_track_metadata **data)

Parameters

[in] metadata needed to be free artik_bt_avrcp_track_metadata

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1835 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_free_property) (artik_bt_avrcp_item_property **properties)

Parameters

[in] Item property needed to be free artik_bt_avrcp_item_property

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1740 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_get_metadata) (artik_bt_avrcp_track_metadata **data)

Parameters

[out] metadata got from an AVRCP target artik_bt_avrcp_track_metadata

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1825 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_get_name) (char **name)

Parameters

[out] name The player name got from an AVRCP target.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1768 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_get_position) (unsigned int *position)

Parameters

[out] position The player position got from an AVRCP target.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1816 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_get_property) (int index, artik_bt_avrcp_item_property **properties)

Parameters

[in]	index	to be get property
[out]	properties	index's property be sorted artik_bt_avrcp_item_property

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1730 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_get_repeat_mode) (artik_bt_avrcp_repeat_mode *repeat_mode)

Parameters

[out] repeat_mode The repeat mode of the player

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1654 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_get_status) (char **status)

Parameters

[out] status The player status got from an AVRCP target. Possible values: "playing", "stopped", "paused", "forward-seek", "reverse-seek" or "error"

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1779 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_get_subtype) (char **subtype)

Parameters

[out] subtype The player subtype got from an AVRCP target. Possible values: "Audio Book", "Podcast"

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1789 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_get_type) (char **type)

Parameters

[out] type The player type got from an AVRCP target. Possible values: "Audio", "Video", "Audio Broadcasting", "Video Broadcasting"

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1800 of file artik_bluetooth.h.

bool(* artik_bluetooth_module::avrcp_controller_is_browsable) (void)

Returns: True if the player is browsable, false otherwise.

Definition at line 1807 of file artik_bluetooth.h.

bool(* artik_bluetooth_module::avrcp_controller_is_connected) (void)

Returns: True if an AVRCP target is connected, false otherwise.

Definition at line 1671 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_list_item) (int start_item, int end_item, artik_bt_avrcp_item **item_list)

Parameters

[in]	start_item	The start index of the item
[in]	end_item	The end index of the item
[out]	item_list	The item list

Returns: S_OK on success, otherwise a negative error value. E_NOT_SUPPORTED when this request is not supported by player.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1634 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_next) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1699 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_pause) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1685 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_play_item) (int index)

Parameters

[in] index To be played index

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1750 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_previous) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1706 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_resume_play) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1678 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_rewind) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1720 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_set_repeat_mode) (artik_bt_avrcp_repeat_mode repeat_mode)

Parameters

[in] repeat_mode The repeat mode of the player

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1664 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::avrcp_controller_stop) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1692 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::connect) (const char *addr)

Parameters

[in] addr The address of the remote Bluetooth device to unbond with.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, bluetooth_test/artik_bluetooth_test_avrcp.c, bluetooth_test/artik_bluetooth_test_gatt_client.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1066 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::connect_profile) (const char *addr, const char *uuid)

Parameters

[in]	addr	The bluetooth address of the remote device
[in]	uuid	The UUID of the remote profile

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1259 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::deinit) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, bluetooth_test/artik_bluetooth_test_advertiser.c, bluetooth_test/artik_bluetooth_test_agent.c, bluetooth_test/artik_bluetooth_test_avrcp.c, bluetooth_test/artik_bluetooth_test_ftp.c, bluetooth_test/artik_bluetooth_test_gatt_client.c, bluetooth_test/artik_bluetooth_test_gatt_server.c, bluetooth_test/artik_bluetooth_test_panu.c, bluetooth_test/artik_bluetooth_test_spp.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1109 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::disconnect) (const char *addr)

Parameters

[in] addr The address of the remote Bluetooth device to disconnect from.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, bluetooth_test/artik_bluetooth_test_avrcp.c, bluetooth_test/artik_bluetooth_test_gatt_client.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1076 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::free_device) (artik_bt_device *device)

Parameters

[in] device The remote device

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1084 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::free_devices) (artik_bt_device **device_list, int count)

Parameters

[in]	device_list	artik_bt_device array to free
[in]	count	Number of artik_bt_device objects contained in the array.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, and bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1094 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_change_folder) (char *folder)

Parameters

[in] folder The folder will change to.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 1941 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_create_folder) (char *folder)

Parameters

[in] folder The folder to be created.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 1950 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_create_session) (char *dest_addr)

Parameters

[in] dest_addr The BT MAC address of FTP server.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 1925 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_delete_file) (char *file)

Parameters

[in] file The file to be deleted.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 1959 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_free_list) (artik_bt_ftp_file **file_list)

Parameters

[in] file_list The list of folders/files.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 1977 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_get_file) (char *target_file, char *source_file)

Parameters

[in]	target_file	The saved file name.
[in]	source_file	The file to be downloaded.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 1987 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_list_folder) (artik_bt_ftp_file **file_list)

Parameters

[out] file_list The list of folders/files.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 1968 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_put_file) (char *source_file, char *target_file)

Parameters

[in]	source_file	The file to be uploaded.
[in]	target_file	The uploaded file name.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 1997 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_remove_session) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 1932 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_resume_transfer) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 2004 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::ftp_suspend_transfer) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c.

Definition at line 2011 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_add_characteristic) (int svc_id, artik_bt_gatt_chr chr, int *id)

Parameters

[in]	svc_id	The internal id of the GATT service to which the characteristic belongs to
[in]	chr	The characteristic properties
[out]	id	The internal id of the characteristic.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1341 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_add_service) (artik_bt_gatt_service svc, int *id)

Parameters

[in]	svc	The service properties.
[out]	id	The internal id of the service.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1331 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_char_read_value) (const char *addr, const char *srv_uuid, const char *char_uuid, unsigned char **byte, int *byte_len)

Parameters

[in]	addr	The bluetooth address of the remote device
[in]	srv_uuid	UUID of the remote GATT service
[in]	char_uuid	UUID of the remote GATT characteristic
[out]	byte	The characteristic's value
[out]	byte_len	Size of byte

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_client.c.

Definition at line 1491 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_char_write_value) (const char *addr, const char *srv_uuid, const char *char_uuid, const unsigned char byte[], int byte_len)

Parameters

[in]	addr	The bluetooth address of the remote device
[in]	srv_uuid	UUID of the remote GATT service
[in]	char_uuid	UUID of the remote GATT characteristic
[in]	byte	The characteristic's value
[in]	byte_len	Size of byte

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_client.c.

Definition at line 1503 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_desc_read_value) (const char *addr, const char *srv_uuid, const char *char_uuid, const char *desc_uuid, unsigned char **byte, int *byte_len)

Parameters

[in]	addr	The bluetooth address of the remote device
[in]	srv_uuid	UUID of the remote GATT service
[in]	char_uuid	UUID of the remote GATT characteristic
[in]	desc_uuid	UUID of the remote GATT descriptor
[out]	byte	The descriptor's value
[out]	byte_len	Size of byte

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_client.c.

Definition at line 1516 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_desc_write_value) (const char *addr, const char *srv_uuid, const char *char_uuid, const char *desc_uuid, const unsigned char byte[], int byte_len)

Parameters

[in]	addr	The bluetooth address of the remote device
[in]	srv_uuid	UUID of the remote GATT service
[in]	char_uuid	UUID of the remote GATT characteristic
[in]	desc_uuid	UUID of the remote GATT descriptor
[out]	byte	The descriptor's value
[out]	byte_len	Size of byte

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1530 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_get_char_properties) (const char *addr, const char *srv_uuid, const char *char_uuid, artik_bt_gatt_char_properties *properties)

Parameters

[in]	addr	The bluetooth address of the remote device
[in]	srv_uuid	UUID of the remote GATT service
[in]	char_uuid	UUID of the remote GATT characteristic
[out]	properties	The characteristic's properties

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_client.c.

Definition at line 1562 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_get_characteristic_list) (const char *addr, const char *srv_uuid, artik_bt_uuid **uuid_list, int *len)

Parameters

[in]	addr	The bluetooth address of the remote device
[in]	srv_uuid	UUID of the remote GATT service
[out]	uuid_list	The list of characteristic UUID
[out]	len	The size of uuid_list

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1467 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_get_descriptor_list) (const char *addr, const char *srv_uuid, const char *char_uuid, artik_bt_uuid **uuid_list, int *len)

Parameters

[in]	addr	The bluetooth address of the remote device
[in]	srv_uuid	UUID of the remote GATT service
[in]	char_uuid	UUID of the remote GATT characteristic
[out]	uuid_list	The list of descriptor UUID
[out]	len	The size of uuid_list

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1479 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_get_service_list) (const char *addr, artik_bt_uuid **uuid_list, int *len)

Parameters

[in]	addr	The bluetooth address of the remote device
[out]	uuid_list	The list of service UUID
[out]	len	The size of uuid_list

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1456 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_notify) (int svc_id, int char_id, unsigned char *byte, int len)

Parameters

[in]	svc_id	The internal service id
[in]	char_id	The internal characteristic id
[in]	byte	The new value of the characteristic
[in]	len	Size of bytes

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1609 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_register_service) (int id)

Parameters

[in] id The internal id of the GATT service

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1440 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_req_set_result) (artik_bt_gatt_req req, artik_bt_gatt_req_state_type state, const char *err_msg)

Parameters

[in]	req	Handle tied to the request.
[in]	state	The status of the request.
[in]	err_msg	An err_msg (can be NULL)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1598 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_req_set_value) (artik_bt_gatt_req req, int len, const unsigned char *value)

Parameters

[in]	req	Handle tied to the read request
[in]	len	The size of value
[in]	value	The response

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1588 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_set_char_on_notify_request) (int svc_id, int char_id, artik_bt_gatt_req_notify callback, void *user_data)

Parameters

[in]	svc_id	The internal id of the GATT service
[in]	char_id	The internal id of the GATT characteristic
[in]	callback	The handler of notify request
[in]	user_data	The user data to be passed to the callback functions.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1408 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_set_char_on_read_request) (int svc_id, int char_id, artik_bt_gatt_req_read callback, void *user_data)

Parameters

[in]	svc_id	The internal id of the GATT service
[in]	char_id	The internal id of the GATT characteristic
[in]	callback	The handler of read request
[in]	user_data	The user data to be passed to the callback functions.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1390 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_set_char_on_write_request) (int svc_id, int char_id, artik_bt_gatt_req_write callback, void *user_data)

Parameters

[in]	svc_id	The internal id of the GATT service
[in]	char_id	The internal id of the GATT characteristic
[in]	callback	The handler of write request
[in]	user_data	The user data to be passed to the callback functions.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1399 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_set_desc_on_read_request) (int svc_id, int char_id, int desc_id, artik_bt_gatt_req_read callback, void *user_data)

Parameters

[in]	svc_id	The internal id of the GATT service
[in]	char_id	The internal id of the GATT characteristic
[in]	desc_id	The internal id of the GATT descriptor
[in]	callback	The handler of read request
[in]	user_data	The user data to be passed to the callback functions.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1420 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_set_desc_on_write_request) (int svc_id, int char_id, int desc_id, artik_bt_gatt_req_write callback, void *user_data)

Parameters

[in]	svc_id	The internal id of the GATT service
[in]	char_id	The internal id of the GATT characteristic
[in]	desc_id	The internal id of the GATT descriptor
[in]	callback	The handler of write request
[in]	user_data	The user data to be passed to the callback functions.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1432 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_start_notify) (const char *addr, const char *srv_uuid, const char *char_uuid)

Parameters

[in]	addr	The bluetooth address of the remote device
[in]	srv_uuid	UUID of the remote GATT service
[in]	char_uuid	UUID of the remote GATT characteristic

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_client.c.

Definition at line 1541 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_stop_notify) (const char *addr, const char *srv_uuid, const char *char_uuid)

Parameters

[in]	addr	The bluetooth address of the remote device
[in]	srv_uuid	UUID of the remote GATT service
[in]	char_uuid	UUID of the remote GATT characteristic

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_client.c.

Definition at line 1551 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::gatt_unregister_service) (int id)

Parameters

[in] id The internal id of the GATT service

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1447 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::get_adapter_info) (artik_bt_adapter *adapter)

Parameters

[out] adapter The bluetooth adapter information

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1244 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::get_device) (const char *addr, artik_bt_device *device)

Parameters

[in]	addr	The address of the remote Bluetooth device
[out]	device	This will be filled with device properties and caller must free this.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1027 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::get_devices) (artik_bt_device_type device_type, artik_bt_device **devices, int *num_devices)

Parameters

[in]	devices_type	The type of the devices list.
[out]	devices	t Device list
[out]	num_devices	Number of devices

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, and bluetooth_test/artik_bluetooth_test_avrcp.c.

Definition at line 1038 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::init) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, bluetooth_test/artik_bluetooth_test_advertiser.c, bluetooth_test/artik_bluetooth_test_agent.c, bluetooth_test/artik_bluetooth_test_avrcp.c, bluetooth_test/artik_bluetooth_test_ftp.c, bluetooth_test/artik_bluetooth_test_gatt_client.c, bluetooth_test/artik_bluetooth_test_gatt_server.c, bluetooth_test/artik_bluetooth_test_panu.c, bluetooth_test/artik_bluetooth_test_spp.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1101 of file artik_bluetooth.h.

bool(* artik_bluetooth_module::is_blocked) (const char *addr)

Parameters

[in] addr The bluetooth address of the remote device

Returns: True if the remote device is trusted; false otherwise.

Definition at line 1323 of file artik_bluetooth.h.

bool(* artik_bluetooth_module::is_connected) (const char *addr)

Parameters

[in] addr The bluetooth address of the remote device

Returns: True if the remote device is connected; false otherwise.

Definition at line 1307 of file artik_bluetooth.h.

bool(* artik_bluetooth_module::is_paired) (const char *addr)

Parameters

[in] addr The bluetooth address of the remote device

Returns: True if the remote device is paired; false otherwise.

Definition at line 1299 of file artik_bluetooth.h.

bool(* artik_bluetooth_module::is_scanning) (void)

Returns: True when a device discovery procedure is active, false otherwise.

Definition at line 1236 of file artik_bluetooth.h.

bool(* artik_bluetooth_module::is_trusted) (const char *addr)

Parameters

[in] addr The bluetooth address of the remote device

Returns: True if the remote device is trusted; false otherwise.

Definition at line 1315 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::pan_connect) (const char *mac_addr, const char *uuid, char **network_interface)

Parameters

[in]	mac_addr	To be connect target device mac address.
[in]	uuid	target device uuid.
[out]	network_interface	The interface of the connection.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_panu.c.

Definition at line 1867 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::pan_disconnect) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_panu.c.

Definition at line 1875 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::pan_get_interface) (char **_interface)

Parameters

[out] _interface The connection interface.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_panu.c.

Definition at line 1891 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::pan_get_UUID) (char **uuid)

Parameters

[out] uuid The device uuid.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1900 of file artik_bluetooth.h.

bool(* artik_bluetooth_module::pan_is_connected) (void)

Returns: True when a pan is connected, false otherwise.

Definition at line 1882 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::pan_register) (const char *uuid, const char *bridge)

Parameters

[in]	uuid	To be register service uuid.
[in]	bridge	To be register bridge.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1846 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::pan_unregister) (const char *uuid)

Parameters

[in] uuid To be unregistered.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1855 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::register_advertisement) (artik_bt_advertisement *user_adv, int *id)

Parameters

[in]	user_adv	The advertisement object
[out]	id	The internal id of the advertisement

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_advertiser.c, and bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1572 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::remove_device) (const char *addr)

Parameters

[in] addr The address of the remote Bluetooth device to remove.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c.

Definition at line 1158 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::remove_devices) (void)

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_ftp.c, bluetooth_test/artik_bluetooth_test_panu.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1250 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::set_alias) (const char *alias)

In case no alias is set, the bluetooth friendly name is the system provided name. Setting an empty string as alias and the system provided name is used as bluetooth friendly name.

Parameters

[in] alias The bluetooth friendly name you want to set.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1178 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::set_block) (const char *addr)

Parameters

[in] addr The bluetooth address of the remote device

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1283 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::set_callback) (artik_bt_event event, artik_bt_callback user_callback, void *user_data)

Parameters

[in]	event	The event to register
[in]	callback	The callback function to register
[in]	user_data	The user data to be passed to the callback function

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, bluetooth_test/artik_bluetooth_test_avrcp.c, bluetooth_test/artik_bluetooth_test_ftp.c, bluetooth_test/artik_bluetooth_test_gatt_client.c, and bluetooth_test/artik_bluetooth_test_panu.c.

Definition at line 1121 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::set_callbacks) (artik_bt_callback_property *user_callbacks, unsigned int size)

Parameters

[in]	user_callbacks	The callback list to register
[in]	size	The number of callbacks in the list

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_agent.c, bluetooth_test/artik_bluetooth_test_gatt_server.c, bluetooth_test/artik_bluetooth_test_spp.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1133 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::set_discoverable) (bool discoverable)

The value is not persistent. After restart the adapter it will reset back to the default value.

Parameters

[in] powered If powered is true the bluetooth adapter is switched on, otherwise it is switched off.

Returns: S_OK on success, otherwise a negative error value.

Switch the bluetooth adapter to discoverable or non-discoverable to either make it visible or hide it.

Parameters

[in] discoverable If discoverable is true, sets the bluetooth adapter to discoverable; otherwise the non-discoverable mode is used

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_agent.c, bluetooth_test/artik_bluetooth_test_gatt_server.c, and bluetooth_test/artik_bluetooth_test_spp.c.

Definition at line 1199 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::set_discoverableTimeout) (unsigned int timeout)

When tie discoverable timeout expired the bluetooth adapter switchs to non-discoverable.

Parameters

[in] timeout Discoverable timeout in seconds. A value of zero disabled the timer.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_spp.c.

Definition at line 1230 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::set_pairable) (bool pairable)

This property only affects incoming pairing.

Parameters

[in] pairable If pairable is true, sets the bluetooth adapter to pairable; otherwise the non-pairable mode is used.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1210 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::set_pairableTimeout) (unsigned int timeout)

When the pairable timeout expired the bluetooth adapter switchs to non-pairable

Parameters

[in] timeout Pairable timeout in seconds. A value of zero disabled the timer.

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1220 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::set_scan_filter) (artik_bt_scan_filter *filter)

Parameters

[in] filter The filter to apply

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_gatt_client.c.

Definition at line 1166 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::set_trust) (const char *addr)

Parameters

[in] addr The bluetooth address of the remote device

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1267 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::spp_register_profile) (artik_bt_spp_profile_option *opt)

Parameters

[in] artik_bt_spp_profile_option The option of the profile.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_spp.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1909 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::spp_unregister_profile) ()

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_spp.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1916 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::start_bond) (const char *addr)

Parameters

[in] addr The address of the remote Bluetooth device with which the bond should be created.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, bluetooth_test/artik_bluetooth_test_ftp.c, bluetooth_test/artik_bluetooth_test_panu.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1049 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::start_scan) ()

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, bluetooth_test/artik_bluetooth_test_avrcp.c, bluetooth_test/artik_bluetooth_test_ftp.c, bluetooth_test/artik_bluetooth_test_gatt_client.c, bluetooth_test/artik_bluetooth_test_panu.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1010 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::stop_bond) (const char *addr)

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1056 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::stop_scan) ()

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, bluetooth_test/artik_bluetooth_test_avrcp.c, bluetooth_test/artik_bluetooth_test_ftp.c, bluetooth_test/artik_bluetooth_test_gatt_client.c, bluetooth_test/artik_bluetooth_test_panu.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1016 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::unregister_advertisement) (int id)

Parameters

[in] id The internal id of the advertisement object.

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test_advertiser.c, and bluetooth_test/artik_bluetooth_test_gatt_server.c.

Definition at line 1579 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::unset_block) (const char *addr)

Parameters

[in] addr The bluetooth address of the remote device

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1291 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::unset_callback) (artik_bt_event event)

Parameters

[in] event The event to unregister

Returns: S_OK on success, otherwise a negative error value.

Examples:: bluetooth_test/artik_bluetooth_test.c, bluetooth_test/artik_bluetooth_test_avrcp.c, bluetooth_test/artik_bluetooth_test_ftp.c, and bluetooth_test/artik_bluetooth_test_spp_client.c.

Definition at line 1143 of file artik_bluetooth.h.

artik_error(* artik_bluetooth_module::unset_trust) (const char *addr)

Parameters

[in] addr The bluetooth address of the remote device

Returns: S_OK on success, otherwise a negative error value.

Definition at line 1275 of file artik_bluetooth.h.

The documentation for this struct was generated from the following file:

inc/bluetooth/artik_bluetooth.h

Filter results by

Older Versions

Data Fields

Detailed Description

Field Documentation