just a fork
Fork of BLE_API by
Diff: ble/GattService.h
- Revision:
- 1167:91c37c858f48
- Parent:
- 1048:efb29faf12fc
- Child:
- 1179:4ab722f8dca0
--- a/ble/GattService.h Wed Apr 06 19:15:06 2016 +0100 +++ b/ble/GattService.h Wed Apr 06 19:15:07 2016 +0100 @@ -1,86 +1,144 @@ -/* 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 __GATT_SERVICE_H__ -#define __GATT_SERVICE_H__ - -#include "UUID.h" -#include "GattCharacteristic.h" - -class GattService { -public: - enum { - UUID_ALERT_NOTIFICATION_SERVICE = 0x1811, - UUID_BATTERY_SERVICE = 0x180F, - UUID_BLOOD_PRESSURE_SERVICE = 0x1810, - UUID_CURRENT_TIME_SERVICE = 0x1805, - UUID_CYCLING_SPEED_AND_CADENCE = 0x1816, - UUID_DEVICE_INFORMATION_SERVICE = 0x180A, - UUID_ENVIRONMENTAL_SERVICE = 0x181A, - UUID_GLUCOSE_SERVICE = 0x1808, - UUID_HEALTH_THERMOMETER_SERVICE = 0x1809, - UUID_HEART_RATE_SERVICE = 0x180D, - UUID_HUMAN_INTERFACE_DEVICE_SERVICE = 0x1812, - UUID_IMMEDIATE_ALERT_SERVICE = 0x1802, - UUID_LINK_LOSS_SERVICE = 0x1803, - UUID_NEXT_DST_CHANGE_SERVICE = 0x1807, - UUID_PHONE_ALERT_STATUS_SERVICE = 0x180E, - UUID_REFERENCE_TIME_UPDATE_SERVICE = 0x1806, - UUID_RUNNING_SPEED_AND_CADENCE = 0x1814, - UUID_SCAN_PARAMETERS_SERVICE = 0x1813, - UUID_TX_POWER_SERVICE = 0x1804 - }; - -public: - /** - * @brief Creates a new GattService using the specified 16-bit - * UUID, value length, and properties. - * - * @note The UUID value must be unique and is normally >1. - * - * @param[in] uuid - * The UUID to use for this service. - * @param[in] characteristics - * A pointer to an array of characteristics to be included within this service. - * @param[in] numCharacteristics - * The number of characteristics. - */ - GattService(const UUID &uuid, GattCharacteristic *characteristics[], unsigned numCharacteristics) : - _primaryServiceID(uuid), _characteristicCount(numCharacteristics), _characteristics(characteristics), _handle(0) { - /* empty */ - } - - const UUID &getUUID(void) const {return _primaryServiceID; } - uint16_t getHandle(void) const {return _handle; } - uint8_t getCharacteristicCount(void) const {return _characteristicCount;} - void setHandle(uint16_t handle) {_handle = handle;} - - GattCharacteristic *getCharacteristic(uint8_t index) { - if (index >= _characteristicCount) { - return NULL; - } - - return _characteristics[index]; - } - -private: - UUID _primaryServiceID; - uint8_t _characteristicCount; - GattCharacteristic **_characteristics; - uint16_t _handle; -}; - -#endif // ifndef __GATT_SERVICE_H__ \ No newline at end of file +/* 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 __GATT_SERVICE_H__ +#define __GATT_SERVICE_H__ + +#include "UUID.h" +#include "GattCharacteristic.h" + +class GattService { +public: + enum { + UUID_ALERT_NOTIFICATION_SERVICE = 0x1811, + UUID_BATTERY_SERVICE = 0x180F, + UUID_BLOOD_PRESSURE_SERVICE = 0x1810, + UUID_CURRENT_TIME_SERVICE = 0x1805, + UUID_CYCLING_SPEED_AND_CADENCE = 0x1816, + UUID_DEVICE_INFORMATION_SERVICE = 0x180A, + UUID_ENVIRONMENTAL_SERVICE = 0x181A, + UUID_GLUCOSE_SERVICE = 0x1808, + UUID_HEALTH_THERMOMETER_SERVICE = 0x1809, + UUID_HEART_RATE_SERVICE = 0x180D, + UUID_HUMAN_INTERFACE_DEVICE_SERVICE = 0x1812, + UUID_IMMEDIATE_ALERT_SERVICE = 0x1802, + UUID_LINK_LOSS_SERVICE = 0x1803, + UUID_NEXT_DST_CHANGE_SERVICE = 0x1807, + UUID_PHONE_ALERT_STATUS_SERVICE = 0x180E, + UUID_REFERENCE_TIME_UPDATE_SERVICE = 0x1806, + UUID_RUNNING_SPEED_AND_CADENCE = 0x1814, + UUID_SCAN_PARAMETERS_SERVICE = 0x1813, + UUID_TX_POWER_SERVICE = 0x1804 + }; + +public: + /** + * @brief Creates a new GattService using the specified 16-bit + * UUID, value length, and properties. + * + * @note The UUID value must be unique and is normally >1. + * + * @param[in] uuid + * The UUID to use for this service. + * @param[in] characteristics + * A pointer to an array of characteristics to be included within this service. + * @param[in] numCharacteristics + * The number of characteristics. + */ + GattService(const UUID &uuid, GattCharacteristic *characteristics[], unsigned numCharacteristics) : + _primaryServiceID(uuid), + _characteristicCount(numCharacteristics), + _characteristics(characteristics), + _handle(0) { + /* empty */ + } + + /** + * Get this service's UUID. + * + * @return A reference to the service's UUID. + */ + const UUID &getUUID(void) const { + return _primaryServiceID; + } + + /** + * Get handle of the service declaration attribute in the ATT table. + * + * @return The service's handle. + */ + uint16_t getHandle(void) const { + return _handle; + } + + /** + * Get the total number of characteristics within this service. + * + * @return The total number of characteristics within this service. + */ + uint8_t getCharacteristicCount(void) const { + return _characteristicCount; + } + + /** + * Set the handle of the service declaration attribute in the ATT table. + * + * @param[in] handle + * The service's handle. + */ + void setHandle(uint16_t handle) { + _handle = handle; + } + + /** + * Get this service's characteristic at a specific index. + * + * @param[in] index + * The index of the characteristic. + * + * @return A pointer to the characterisitic at index @p index. + */ + GattCharacteristic *getCharacteristic(uint8_t index) { + if (index >= _characteristicCount) { + return NULL; + } + + return _characteristics[index]; + } + +private: + /** + * This service's UUID. + */ + UUID _primaryServiceID; + /** + * Total number of characteristics within this service. + */ + uint8_t _characteristicCount; + /** + * An array with pointers to the characteristics added to this service. + */ + GattCharacteristic **_characteristics; + /** + * Handle of the service declaration attribute in the ATT table. + * + * @note This handle is generally assigned by the underlying BLE stack when the + * service is added to the ATT table. + */ + uint16_t _handle; +}; + +#endif /* ifndef __GATT_SERVICE_H__ */ \ No newline at end of file