RM0x Wireless Module – API Documentation

Header image

Main page


Data Structures | Macros | Typedefs | Enumerations
BtLib data structures, constants and enums

Data Structures

struct  BtDevice
 Information about a remote Bluetooth device. More...
 

Macros

#define BT_MAX_NAME_LENGTH   248
 Maximum length of a Bluetooth device name. More...
 

Typedefs

typedef unsigned long(* BtPasskeyCallback) (const char *deviceName)
 Pairing passkey callback function. More...
 
typedef BOOL(* BtConfirmationCallback) (const char *deviceName, unsigned long passkey)
 Pairing confirmation callback function. More...
 

Enumerations

enum  BtCallback {
  BT_CALLBACK_PASSKEY = 0,
  BT_CALLBACK_CONFIRMATION = 1
}
 Type of pairing callback that the user registers via the btRegisterCallback API function. More...
 
enum  BtIoCapability {
  BT_IO_CAPABILITY_DISPLAYONLY = 0,
  BT_IO_CAPABILITY_DISPLAYYESNO = 1,
  BT_IO_CAPABILITY_KEYBOARDONLY = 2,
  BT_IO_CAPABILITY_NOINPUTNOOUTPUT = 3,
  BT_IO_CAPABILITY_KEYBOARDDISPLAY = 4
}
 IO capability of the device that the Bluetooth module is deployed on, in accordance with the Bluetooth core specification. The user may set the IO capability by calling the btSetIoCapability API function. More...
 
enum  BtPanRole {
  BT_PAN_ROLE_PANU = 0,
  BT_PAN_ROLE_NAP = 1,
  BT_PAN_ROLE_GN = 2
}
 Role of a Bluetooth device that establishes a network connection via the PAN profile. More...
 
enum  BtErrorCode {
  BT_ERROR_NO = 0,
  BT_ERROR_BAD_PARAMETERS = -1,
  BT_ERROR_SEMAPHORE = -2,
  BT_ERROR_HARDWARE = -3,
  BT_ERROR_OUT_OF_RESOURCES = -4,
  BT_ERROR_DEVICE_NOT_FOUND = -5,
  BT_ERROR_OPERATION_FAILED = -6
}
 Possible error codes returned by the API functions. More...
 

Detailed Description






Top of page | Main page

Copyright © 2019 Beck IPC GmbH
Generated by Doxygen 1.8.15