www.beck-ipc.com

BtLib V2.02 - C API Documentation


These are the BT0x API functions, listed in several functionality groups.

Important notes:
  • All functions are in general not reentrant and threadsafe.
  • Several API functions must be called with a parameter named storeInStartupDatabase. If these functions are called with value BT_STORE_IN_STARTUP_BT01_DATABASE, the settings are stored at a non-volatile storage inside of the BT0x module and become restored after every startup of the BT0x.
    This is not recommended. Parameter storeInStartupDatabase should be set to BT_VALID_FOR_CURRENT_POWER_CYCLE, which means, that the settings are only valid for this power cycle.



Status / Initialization

Functions needed for initialization, status information, or mode changes

btInit
btDeInit
btSetMode
btIsConnected
btGetPort
btGetMajorDeviceClass
btReadLocalBDAddr
btReadLocalVersionInformation
btSendAT
btGetATLineWithTimeout
btGetATLine


GAP

Functions supported by the generic access profile to discover devices, get information about them, set password and device name etc.

btReadDiscoverabilityMode
btWriteDiscoverabilityMode
btReadConnectabilityMode
btWriteConnectabilityMode
btReadPairingMode
btWritePairingMode
btReadSecurityMode
btWriteSecurityMode
btNameDiscovery
btDeviceDiscovery
btInquiry
btUnBond
btReadBondedDevices
btReadFixedPIN
btWriteFixedPIN
btReadLocalName
btWriteLocalName
btReadLocalCOD
btWriteLocalCOD
btReadMasterSlaveRolePolicy
btWriteMasterSlaveRolePolicy


Connection Handling

Functions for connecting to or listening for connections from other devices

btServiceSearch
btConnectToSerialServiceDataMode
btCloseSerialConnectionDataMode
btReadDefaultClientProfile
btWriteDefaultClientProfile
btReadDefaultServerProfile
btWriteDefaultServerProfile
btReadNoOfRemotePeers
btWriteNoOfRemotePeers
btReadDefaultRemotePeer
btWriteDefaultRemotePeer
btConnectWithDSR_PIO
btDisconnectWithDSR_PIO


Extended Data Mode (EDM)

Functions for data transmission via Extended Data Mode

btEdmInit
btEdmDeinit
btEdmSendData
btEdmRecvData
btEdmPeekData
btEdmPurgeInputData
btEdmFlushOutputData


Miscellaneous

Functions which don't belong to other groups

btReadRS232Settings
btWriteRS232Settings
btReadAllowConfigurationOverBluetooth
btWriteAllowConfigurationOverBluetooth
btReadControllerPowerSaveMode
btWriteControllerPowerSaveMode
btReadMaxOutputPower
btWriteMaxOutputPower
btReadEscSequenceTiming
btWriteEscSequenceTiming
btWriteEscChar
btReadWatchdogSettings
btWriteWatchdogSettings
btResetDevice
btReadDtrDsrSettings
btWriteDtrDsrSettings
btReadLinkPolicy
btWriteLinkPolicy
btReadFeatureMask
btWriteFeatureMask
btReadChannelMap
btWriteChannelMap


Helping types

These enums containing possible values for different parameters in btlib functions. For easy mapping of enum and corresponding parameter name the enum name has a "bt" before the parameter name and the first letter of the parameter name becomes a capital.
for example: enum btDiscoverabilityMode contains possible values for parameter discoverabilityMode

btStoreInStartupDatabase
btDiscoverabilityMode
btConnectabilityMode
btPairingMode
btSecurityMode
btInquiryType
btRolePolicy
btRoleAndProfile
btBaudRate
btDataBits
btStopBits
btParity
btFlowControl
btSerialInterfaceType
btPowerSaveMode
btDtrConfig
btDsrConfig
btMajorDeviceClass


Data structures, chip.ini configuration and error codes.

BluetoothDevice
BluetoothService
BluetoothVersion
BtEdmConnCb


Return values


End of document