BLE lib
Fork of Nucleo_BLE_API by
public/Gap.h
- Committer:
- sjallouli
- Date:
- 2014-12-19
- Revision:
- 0:289fd2dae405
File content as of revision 0:289fd2dae405:
/* mbed Microcontroller Library * Copyright (c) 2006-2013 ARM Limited * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef __GAP_H__ #define __GAP_H__ #include "mbed.h" #include "blecommon.h" #include "GapAdvertisingData.h" #include "GapAdvertisingParams.h" #include "GapEvents.h" /**************************************************************************/ /*! \brief The base class used to abstract GAP functionality to a specific radio transceiver, SOC or BLE Stack. */ /**************************************************************************/ class Gap { public: typedef enum addr_type_e { ADDR_TYPE_PUBLIC = 0, ADDR_TYPE_RANDOM_STATIC, ADDR_TYPE_RANDOM_PRIVATE_RESOLVABLE, ADDR_TYPE_RANDOM_PRIVATE_NON_RESOLVABLE } addr_type_t; /** * enumeration for disconnection reasons. The values for these reasons are * derived from Nordic's implementation; but the reasons are meant to be * independent of the transport. If you are returned a reason which is not * covered by this enumeration, then please refer to the underlying * transport library. */ enum DisconnectionReason_t { REMOTE_USER_TERMINATED_CONNECTION = 0x13, LOCAL_HOST_TERMINATED_CONNECTION = 0x16, CONN_INTERVAL_UNACCEPTABLE = 0x3B, }; /* Describes the current state of the device (more than one bit can be set) */ typedef struct GapState_s { unsigned advertising : 1; /**< peripheral is currently advertising */ unsigned connected : 1; /**< peripheral is connected to a central */ } GapState_t; typedef uint16_t Handle_t; typedef struct { uint16_t minConnectionInterval; /**< Minimum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/ uint16_t maxConnectionInterval; /**< Maximum Connection Interval in 1.25 ms units, see @ref BLE_GAP_CP_LIMITS.*/ uint16_t slaveLatency; /**< Slave Latency in number of connection events, see @ref BLE_GAP_CP_LIMITS.*/ uint16_t connectionSupervisionTimeout; /**< Connection Supervision Timeout in 10 ms units, see @ref BLE_GAP_CP_LIMITS.*/ } ConnectionParams_t; public: /* These functions must be defined in the sub-class */ virtual ble_error_t setAddress(addr_type_t type, const uint8_t address[6]) = 0; virtual ble_error_t setAdvertisingData(const GapAdvertisingData &, const GapAdvertisingData &) = 0; virtual ble_error_t startAdvertising(const GapAdvertisingParams &) = 0; virtual ble_error_t stopAdvertising(void) = 0; virtual ble_error_t disconnect(DisconnectionReason_t reason) = 0; virtual ble_error_t getPreferredConnectionParams(ConnectionParams_t *params) = 0; virtual ble_error_t setPreferredConnectionParams(const ConnectionParams_t *params) = 0; virtual ble_error_t updateConnectionParams(Handle_t handle, const ConnectionParams_t *params) = 0; virtual ble_error_t setDeviceName(const uint8_t *deviceName) = 0; virtual ble_error_t getDeviceName(uint8_t *deviceName, unsigned *lengthP) = 0; virtual ble_error_t setAppearance(uint16_t appearance) = 0; virtual ble_error_t getAppearance(uint16_t *appearanceP) = 0; typedef void (*EventCallback_t)(void); typedef void (*ConnectionEventCallback_t)(Handle_t, const ConnectionParams_t *); typedef void (*DisconnectionEventCallback_t)(Handle_t, DisconnectionReason_t); /* Event callback handlers */ void setOnTimeout(EventCallback_t callback) { onTimeout = callback; } void setOnConnection(ConnectionEventCallback_t callback) { onConnection = callback; } void setOnDisconnection(DisconnectionEventCallback_t callback) { onDisconnection = callback; } void processConnectionEvent(Handle_t handle, const ConnectionParams_t *params) { state.connected = 1; if (onConnection) { onConnection(handle, params); } } void processDisconnectionEvent(Handle_t handle, DisconnectionReason_t reason) { state.connected = 0; if (onDisconnection) { onDisconnection(handle, reason); } } void processEvent(GapEvents::gapEvent_e type) { switch (type) { case GapEvents::GAP_EVENT_TIMEOUT: state.advertising = 0; if (onTimeout) { onTimeout(); } break; } } GapState_t getState(void) const { return state; } protected: Gap() : state(), onTimeout(NULL), onConnection(NULL), onDisconnection(NULL) { /* empty */ } protected: GapState_t state; private: EventCallback_t onTimeout; ConnectionEventCallback_t onConnection; DisconnectionEventCallback_t onDisconnection; }; #endif // ifndef __GAP_H__