XDK API  3.6.0
Documentation
Modules | Files | Data Structures | Typedefs | Enumerations
BLE - Bluetooth Low Energy

This component provides the integration of the Alpwise BLE Stack for the EM9301. More...

+ Collaboration diagram for BLE - Bluetooth Low Energy:

Modules

 ALPWISE BLE Services
 BLE Standard Services.
 
 BLE Peripheral
 This module provides a convenient abstraction to use a device as BLE Peripheral.
 
 Bidirectional Service
 The BCDS bidirectional communication service is a custom service, that provides a raw byte array payload communication.
 
 Sensor Services
 The Sensor Services is a set of custom services, that provides a raw byte array payload communication as well as several sensor data services.
 

Files

file  BCDS_Ble.h
 

Data Structures

struct  Ble_RemoteDeviceAddress_S
 Structure to represent the remote device address. More...
 

Typedefs

typedef struct
Ble_RemoteDeviceAddress_S 
Ble_RemoteDeviceAddress_T
 Typedef to represent the remote device addresses. More...
 

Enumerations

enum  BCDS_BLE_ModuleID_E
 BCDS_MODULE_ID for each BLE C module. More...
 
enum  Ble_Retcode_E
 Enumeration to represent the return codes of BLE module. More...
 

Detailed Description

Note
Currently support is provided only for BLE to work as a peripheral. For usage, refer to the corresponding interface.
See also
BCDS_BlePeripheral.h

Data Structure Documentation

struct Ble_RemoteDeviceAddress_S

Data Fields

uint8_t Addr [6]
 

Field Documentation

uint8_t Addr[6]

Typedef Documentation

Enumeration Type Documentation

BCDS_MODULE_ID for each BLE C module. The module ID can be retrieved from a Retcode_T returned by a function by using Retcode_GetModuleId()

usage:

#undef BCDS_MODULE_ID
#define BCDS_MODULE_ID BCDS_BLE_MODULE_ID_xxx
Enumerator
BCDS_BLE_MODULE_ID_ALPWISEPORT_BLERADIO 
BCDS_BLE_MODULE_ID_ALPWISEPORT_BLESYSTEM 
BCDS_BLE_MODULE_ID_ALPWISEPORT_BLETRANSPORT 
BCDS_BLE_MODULE_ID_ALPWISEPORT_CORESTACKCONTROLLER 
BCDS_BLE_MODULE_ID_ALPWISEPORT_EM9301CONTROLLER 
BCDS_BLE_MODULE_ID_ALPWISEPORT_GAPCONTROLLER 
BCDS_BLE_MODULE_ID_ALPWISEPORT_MEMORY 
BCDS_BLE_MODULE_ID_ALPWISEPORT_TRANSPORTADAPTER 
BCDS_BLE_MODULE_ID_PERIPHERAL_APPLICATIONSTATE 
BCDS_BLE_MODULE_ID_PERIPHERAL_BLEPERIPHERAL 
BCDS_BLE_MODULE_ID_SERVICES_BIDIRECTIONALSERVICE 
BCDS_BLE_MODULE_ID_PUBLIC_ADDRESS 
Enumerator
RETCODE_SLEEP_FAIL 

BLE sleep fail

RETCODE_DATA_SEND_FAIL 

BLE data send fail

RETCODE_DATA_RECEIVE_FAIL 

BLE data receive fail

RETCODE_NO_DEVICE_PAIRED 

No device is paired

RETCODE_STATEHANDLER_SEND_FAIL 

state handler send fail

RETCODE_SERVICE_REGISTRATION_FAIL 

registration with service fail

RETCODE_TASK_CREATE_FAIL 

task create fail

RETCODE_BLE_SEND_QUEUE_TIMEOUT 

Waiting for the send queue timed out

RETCODE_BLE_SYSTEM_INIT_FAILED 

Failed to initialize the bluetooth low energy system completely

RETCODE_PAIRING_CONFIRMATION_FAIL 

remote device pairing confirmation failed

RETCODE_PAIRING_COMPLETE_FAIL 

remote device pairing completion failed

RETCODE_SERVICE_REGISTER_NOT_DONE 

service registration is not done yet

RETCODE_REQUESTED_SLEEP_WHILE_CONNECTED 

requesting the stack to sleep while connected to a peer

RETCODE_CHIP_RESET_FAILED 

chip reset through stack failed

RETCODE_STACK_RUN_FAILED 

stack run servicing failed

RETCODE_STACK_INIT_FAILED 

stack run servicing failed

RETCODE_DISCONNECT_TRIGGER_FAILED 

remote device disconnect failed

RETCODE_DEVICE_APPEARANCE_SET_FAILED 

set operation of local device appearance failed

RETCODE_DEVICE_NAME_SET_FAILED 

set operation of device local name failed

RETCODE_DEVICE_REGISTER_FAILED 

registration of device failed

RETCODE_GENERATE_AND_SET_RANDOM_ADDR_FAILED 

generation and set of random address failed

RETCODE_MODE_SET_PENDING 

set mode replied pending and the callback is not in sync

RETCODE_MODE_SET_TRIGGER_FAILED 

set mode trigger failed

RETCODE_ALREADY_INITIALIZED 

a previously initialized module is asked to be initialized again

RETCODE_VENDOR_CMD_SEND_FAILED 

vendor specific command send failed

RETCODE_RADIO_CMD_SEND_FAILED 

radio specific command send failed

RETCODE_STACK_DEINIT_FAILED 

engine de-initialization failed

RETCODE_STACK_NO_RESOURCES 

stack has no resource

RETCODE_RX_BADPACKET 

the packet is bad-formatted while receiving

RETCODE_REWRITE_OF_ATT_FAILED 

re-write of the value of an attribute in the attribute database failed

RETCODE_ATT_INVALID_PARAM 

attribute parameter is invalid for any custom request

RETCODE_STATE_ALREADY_AS_REQUESTED 

device state is same as requested

RETCODE_PERIPHERAL_START_UPON_INIT_NOT_DONE 

device is not started, but requested to sleep / wake-up

RETCODE_PERIPHERAL_START_ALREADY_DONE 

device is requested to start from sleep / wake-up

RETCODE_INITIATE_DISCOVERY_FAILED 

device mode set to discovery failed

RETCODE_BLETRANSPORT_UNKNOWN_ERROR 

BLETRANSPORT returned an error that is unknown

RETCODE_RX_BUFFER_OVERFLOWED 

Received data is not processed in expected time. Hence it overflowed.

RETCODE_HW_ERROR 

Received an hardware error and we will re-init the stack now to its last valid device state

RETCODE_HW_ERROR_HCI_SYNC_LOST 

Received an hardware error (HCI synchronization lost) while requesting the chip to advertise

RETCODE_HW_ERROR_RF_INIT_FAILED 

Received an hardware error (RF initialization failed) while requesting the chip to advertise

RETCODE_HW_ERROR_RF_SYSTEM_ERROR 

Received an hardware error (RF system error) while requesting the chip to advertise

RETCODE_HW_ERROR_CPU_RESET_WATCHDOG 

Received an hardware error (CPU reset (watchdog)) while requesting the chip to advertise

RETCODE_HW_ERROR_CPU_RESET_BUS_ERROR 

Received an hardware error (CPU reset (bus error)) while requesting the chip to advertise

RETCODE_HW_ERROR_CRYSTAL_OSC_STARTUP 

Received an hardware error (Crystal oscillator start-up error (only version 022)) while requesting the chip to advertise

RETCODE_HW_ERROR_PROG_MODE_ENTERED 

Received an hardware error (Programming mode entered) while requesting the chip to advertise

RETCODE_HW_ERROR_UNCLASSIFIED 

Received an unclassified hardware error while requesting the chip to advertise

RETCODE_USER_MACID_IS_INVALID 

Validation of the MAC ID set by the user failed

RETCODE_SEND_NOTIFICATION_FAILED 

ATT_SERVER_SendNotification returned failure

RETCODE_GAP_DEVICE_REGISTRATION_IS_PENDING 

GAP device registration initiation returned status as pending.

RETCODE_BLE_MAX_ERROR 

Defines boundary of BLE custom error codes


All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:50 by doxygen 1.8.8