Microbug / BLE_API

Fork of BLE_API by Bluetooth Low Energy

hw/Gap.h

Committer:
mbed_official
Date:
2014-04-03
Revision:
33:6d51a2c69442
Parent:
31:2c94f0501807
Child:
34:da2ea8cd6216

File content as of revision 33:6d51a2c69442:

/* 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
{
    private:
        GapEvents *m_pEventHandler;

    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;
             
				/* These functions must be defined in the sub-class */
        virtual ble_error_t setAddress(addr_type_t type, uint8_t address[6]) = 0;
				virtual ble_error_t setAdvertisingData(GapAdvertisingData &, GapAdvertisingData &) = 0;
				virtual ble_error_t startAdvertising(GapAdvertisingParams &) = 0;
				virtual ble_error_t stopAdvertising(void) = 0;
				virtual ble_error_t disconnect(void) = 0;

				/* Describes the current state of the device (more than one bit can be set) */
				typedef struct GapState_s
				{
						unsigned advertising : 1;   /**< The device is current advertising */
						unsigned connected   : 1;   /**< The peripheral is connected to a central device */
				} GapState_t;

				/* Event callback handlers */
				void setEventHandler(GapEvents *pEventHandler) {m_pEventHandler = pEventHandler;}
				void handleEvent(GapEvents::gapEvent_e type) {
						if (NULL == m_pEventHandler)
									return;
						switch(type) {
									case GapEvents::GAP_EVENT_TIMEOUT:
										    state.advertising = 0;
												m_pEventHandler->onTimeout();
												break;
									case GapEvents::GAP_EVENT_CONNECTED:
										    state.connected = 1;
												m_pEventHandler->onConnected();
												break;
									case GapEvents::GAP_EVENT_DISCONNECTED:
										    state.connected = 0;
												m_pEventHandler->onDisconnected();
												break;
						}
				}
				
				GapState_t state;
};

#endif