Kenji Arai / Mbed 2 deprecated BLE_EddystoneBeacon_w_ACC_TY51822

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   BLE_API LIS3DH mbed nRF51822 BMC050 nRF51_LowPwr nRF51_Vdd

Fork of BLE_EddystoneBeacon_Service by Bluetooth Low Energy

ZipBeaconConfigService.h@16:a7d07ea94b31, 2015-07-22 (annotated)

Committer:
mbedAustin
Date:
Wed Jul 22 18:01:20 2015 +0000
Revision:
16:a7d07ea94b31
Parent:
15:af8c24f34a9f
Child:
17:0458759c40e4
[[DEBUG]] commiting for help with Debug. Currently hardfaulting when trying to hotswap frames.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 0:c04d932e96c9 1 /* mbed Microcontroller Library
screamer 0:c04d932e96c9 2 * Copyright (c) 2006-2013 ARM Limited
screamer 0:c04d932e96c9 3 *
screamer 0:c04d932e96c9 4 * Licensed under the Apache License, Version 2.0 (the "License");
screamer 0:c04d932e96c9 5 * you may not use this file except in compliance with the License.
screamer 0:c04d932e96c9 6 * You may obtain a copy of the License at
screamer 0:c04d932e96c9 7 *
screamer 0:c04d932e96c9 8 * http://www.apache.org/licenses/LICENSE-2.0
screamer 0:c04d932e96c9 9 *
screamer 0:c04d932e96c9 10 * Unless required by applicable law or agreed to in writing, software
screamer 0:c04d932e96c9 11 * distributed under the License is distributed on an "AS IS" BASIS,
screamer 0:c04d932e96c9 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
screamer 0:c04d932e96c9 13 * See the License for the specific language governing permissions and
screamer 0:c04d932e96c9 14 * limitations under the License.
screamer 0:c04d932e96c9 15 */
screamer 0:c04d932e96c9 16
screamer 0:c04d932e96c9 17 #ifndef SERVICES_ZIPBEACONCONFIGSERVICE_H_
screamer 0:c04d932e96c9 18 #define SERVICES_ZIPBEACONCONFIGSERVICE_H_
screamer 0:c04d932e96c9 19
screamer 0:c04d932e96c9 20 #include "mbed.h"
mbedAustin 16:a7d07ea94b31 21 #include "ble/BLE.h"
mbedAustin 16:a7d07ea94b31 22
screamer 0:c04d932e96c9 23
screamer 0:c04d932e96c9 24 #define UUID_URI_BEACON(FIRST, SECOND) { \
screamer 0:c04d932e96c9 25 0xee, 0x0c, FIRST, SECOND, 0x87, 0x86, 0x40, 0xba, \
screamer 0:c04d932e96c9 26 0xab, 0x96, 0x99, 0xb9, 0x1a, 0xc9, 0x81, 0xd8, \
screamer 0:c04d932e96c9 27 }
screamer 0:c04d932e96c9 28
screamer 0:c04d932e96c9 29 static const uint8_t UUID_URI_BEACON_SERVICE[] = UUID_URI_BEACON(0x20, 0x80);
screamer 0:c04d932e96c9 30 static const uint8_t UUID_LOCK_STATE_CHAR[] = UUID_URI_BEACON(0x20, 0x81);
screamer 0:c04d932e96c9 31 static const uint8_t UUID_LOCK_CHAR[] = UUID_URI_BEACON(0x20, 0x82);
screamer 0:c04d932e96c9 32 static const uint8_t UUID_UNLOCK_CHAR[] = UUID_URI_BEACON(0x20, 0x83);
screamer 0:c04d932e96c9 33 static const uint8_t UUID_URI_DATA_CHAR[] = UUID_URI_BEACON(0x20, 0x84);
screamer 0:c04d932e96c9 34 static const uint8_t UUID_FLAGS_CHAR[] = UUID_URI_BEACON(0x20, 0x85);
screamer 0:c04d932e96c9 35 static const uint8_t UUID_ADV_POWER_LEVELS_CHAR[] = UUID_URI_BEACON(0x20, 0x86);
screamer 0:c04d932e96c9 36 static const uint8_t UUID_TX_POWER_MODE_CHAR[] = UUID_URI_BEACON(0x20, 0x87);
screamer 0:c04d932e96c9 37 static const uint8_t UUID_BEACON_PERIOD_CHAR[] = UUID_URI_BEACON(0x20, 0x88);
screamer 0:c04d932e96c9 38 static const uint8_t UUID_RESET_CHAR[] = UUID_URI_BEACON(0x20, 0x89);
mbedAustin 14:5a2a104a21a8 39 static const uint8_t BEACON_EDDYSTONE[] = {0xAA, 0xFE};
screamer 0:c04d932e96c9 40
mbedAustin 16:a7d07ea94b31 41 //Debug is disabled by default
mbedAustin 16:a7d07ea94b31 42 #if 0
mbedAustin 16:a7d07ea94b31 43 #define DBG(x, ...) printf("[EddyStone: DBG]"x" \t[%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__);
mbedAustin 16:a7d07ea94b31 44 #define WARN(x, ...) printf("[EddyStone: WARN]"x" \t[%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__);
mbedAustin 16:a7d07ea94b31 45 #define ERR(x, ...) printf("[EddyStone: ERR]"x" \t[%s,%d]\r\n", ##__VA_ARGS__,__FILE__,__LINE__);
mbedAustin 16:a7d07ea94b31 46 #else
mbedAustin 16:a7d07ea94b31 47 #define DBG(x, ...) //wait_us(10);
mbedAustin 16:a7d07ea94b31 48 #define WARN(x, ...) //wait_us(10);
mbedAustin 16:a7d07ea94b31 49 #define ERR(x, ...)
mbedAustin 16:a7d07ea94b31 50 #endif
mbedAustin 16:a7d07ea94b31 51
screamer 0:c04d932e96c9 52 /**
screamer 0:c04d932e96c9 53 * @class ZipBeaconConfigService
screamer 0:c04d932e96c9 54 * @brief ZipBeacon Configuration Service. Can be used to set URL, adjust power levels, and set flags.
screamer 0:c04d932e96c9 55 * See http://uribeacon.org
screamer 0:c04d932e96c9 56 *
screamer 0:c04d932e96c9 57 */
mbedAustin 15:af8c24f34a9f 58 class ZipBeaconConfigService
mbedAustin 15:af8c24f34a9f 59 {
mbedAustin 15:af8c24f34a9f 60 public:
screamer 0:c04d932e96c9 61 /**
screamer 0:c04d932e96c9 62 * @brief Transmission Power Modes for UriBeacon
screamer 0:c04d932e96c9 63 */
screamer 0:c04d932e96c9 64 static const uint8_t TX_POWER_MODE_LOWEST = 0; /*!< Lowest TX power mode */
screamer 0:c04d932e96c9 65 static const uint8_t TX_POWER_MODE_LOW = 1; /*!< Low TX power mode */
screamer 0:c04d932e96c9 66 static const uint8_t TX_POWER_MODE_MEDIUM = 2; /*!< Medium TX power mode */
screamer 0:c04d932e96c9 67 static const uint8_t TX_POWER_MODE_HIGH = 3; /*!< High TX power mode */
screamer 0:c04d932e96c9 68 static const unsigned int NUM_POWER_MODES = 4; /*!< Number of Power Modes defined */
screamer 0:c04d932e96c9 69
screamer 0:c04d932e96c9 70 static const int ADVERTISING_INTERVAL_MSEC = 1000; // Advertising interval for config service.
screamer 0:c04d932e96c9 71 static const int SERVICE_DATA_MAX = 31; // Maximum size of service data in ADV packets
screamer 0:c04d932e96c9 72
screamer 0:c04d932e96c9 73 typedef uint8_t Lock_t[16]; /* 128 bits */
screamer 0:c04d932e96c9 74 typedef int8_t PowerLevels_t[NUM_POWER_MODES];
screamer 0:c04d932e96c9 75
mbedAustin 15:af8c24f34a9f 76 // There are currently 3 subframes defined, URI, UID, and TLM
mbedAustin 15:af8c24f34a9f 77 #define EDDYSTONE_MAX_FRAMETYPE 3
mbedAustin 14:5a2a104a21a8 78 void (*frames[EDDYSTONE_MAX_FRAMETYPE])(uint8_t *, uint32_t);
mbedAustin 14:5a2a104a21a8 79 uint8_t frameIndex;
screamer 0:c04d932e96c9 80 static const int URI_DATA_MAX = 18;
screamer 0:c04d932e96c9 81 typedef uint8_t UriData_t[URI_DATA_MAX];
mbedAustin 15:af8c24f34a9f 82
mbedAustin 11:73ea4ef7f5a4 83 // UID Frame Type subfields
mbedAustin 10:b5d19bcf23cf 84 static const int UID_NAMESPACEID_SIZE = 10;
mbedAustin 11:73ea4ef7f5a4 85 typedef uint8_t UIDNamespaceID_t[UID_NAMESPACEID_SIZE];
mbedAustin 10:b5d19bcf23cf 86 static const int UID_INSTANCEID_SIZE = 6;
mbedAustin 11:73ea4ef7f5a4 87 typedef uint8_t UIDInstanceID_t[UID_INSTANCEID_SIZE];
screamer 0:c04d932e96c9 88
mbedAustin 11:73ea4ef7f5a4 89 // Eddystone Frame Type ID
screamer 0:c04d932e96c9 90 static const uint8_t FRAME_TYPE_UID = 0x00;
screamer 0:c04d932e96c9 91 static const uint8_t FRAME_TYPE_URL = 0x10;
screamer 0:c04d932e96c9 92 static const uint8_t FRAME_TYPE_TLM = 0x20;
mbedAustin 15:af8c24f34a9f 93
mbedAustin 11:73ea4ef7f5a4 94 static const uint8_t FRAME_SIZE_TLM = 14; // TLM frame is a constant 14Bytes
mbedAustin 11:73ea4ef7f5a4 95 static const uint8_t FRAME_SIZE_UID = 20; // includes RFU bytes
screamer 0:c04d932e96c9 96
screamer 0:c04d932e96c9 97 struct Params_t {
screamer 0:c04d932e96c9 98 Lock_t lock;
screamer 0:c04d932e96c9 99 uint8_t uriDataLength;
screamer 0:c04d932e96c9 100 UriData_t uriData;
screamer 0:c04d932e96c9 101 uint8_t flags;
screamer 0:c04d932e96c9 102 PowerLevels_t advPowerLevels; // Current value of AdvertisedPowerLevels
screamer 0:c04d932e96c9 103 uint8_t txPowerMode; // Firmware power levels used with setTxPower()
screamer 0:c04d932e96c9 104 uint16_t beaconPeriod;
mbedAustin 10:b5d19bcf23cf 105 uint8_t tlmVersion; // version of TLM packet
mbedAustin 11:73ea4ef7f5a4 106 UIDNamespaceID_t uidNamespaceID; // UUID type, Namespace ID, 10B
mbedAustin 11:73ea4ef7f5a4 107 UIDInstanceID_t uidInstanceID; // UUID type, Instance ID, 6B
screamer 0:c04d932e96c9 108 };
mbedAustin 15:af8c24f34a9f 109
screamer 0:c04d932e96c9 110 /**
screamer 0:c04d932e96c9 111 * @param[ref] ble
screamer 0:c04d932e96c9 112 * BLEDevice object for the underlying controller.
screamer 0:c04d932e96c9 113 * @param[in/out] paramsIn
screamer 0:c04d932e96c9 114 * Reference to application-visible beacon state, loaded
screamer 0:c04d932e96c9 115 * from persistent storage at startup.
screamer 0:c04d932e96c9 116 * @paramsP[in] resetToDefaultsFlag
screamer 0:c04d932e96c9 117 * Applies to the state of the 'paramsIn' parameter.
screamer 0:c04d932e96c9 118 * If true, it indicates that paramsIn is potentially
screamer 0:c04d932e96c9 119 * un-initialized, and default values should be used
screamer 0:c04d932e96c9 120 * instead. Otherwise, paramsIn overrides the defaults.
screamer 0:c04d932e96c9 121 * @param[in] defaultUriDataIn
screamer 0:c04d932e96c9 122 * Default un-encoded URI; applies only if the resetToDefaultsFlag is true.
screamer 0:c04d932e96c9 123 * @param[in] defaultAdvPowerLevelsIn
screamer 0:c04d932e96c9 124 * Default power-levels array; applies only if the resetToDefaultsFlag is true.
screamer 0:c04d932e96c9 125 */
screamer 0:c04d932e96c9 126 ZipBeaconConfigService(BLEDevice &bleIn,
screamer 0:c04d932e96c9 127 Params_t &paramsIn,
screamer 0:c04d932e96c9 128 bool resetToDefaultsFlag,
screamer 0:c04d932e96c9 129 const char *defaultURIDataIn,
screamer 0:c04d932e96c9 130 PowerLevels_t &defaultAdvPowerLevelsIn) :
screamer 0:c04d932e96c9 131 ble(bleIn),
screamer 0:c04d932e96c9 132 params(paramsIn),
screamer 0:c04d932e96c9 133 defaultUriDataLength(),
screamer 0:c04d932e96c9 134 defaultUriData(),
screamer 0:c04d932e96c9 135 defaultAdvPowerLevels(defaultAdvPowerLevelsIn),
screamer 0:c04d932e96c9 136 initSucceeded(false),
screamer 0:c04d932e96c9 137 resetFlag(),
screamer 0:c04d932e96c9 138 lockedStateChar(UUID_LOCK_STATE_CHAR, &lockedState),
screamer 0:c04d932e96c9 139 lockChar(UUID_LOCK_CHAR, &params.lock),
screamer 0:c04d932e96c9 140 uriDataChar(UUID_URI_DATA_CHAR, params.uriData, 0, URI_DATA_MAX,
screamer 0:c04d932e96c9 141 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ | GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_WRITE),
screamer 0:c04d932e96c9 142 unlockChar(UUID_UNLOCK_CHAR, &params.lock),
screamer 0:c04d932e96c9 143 flagsChar(UUID_FLAGS_CHAR, &params.flags),
screamer 0:c04d932e96c9 144 advPowerLevelsChar(UUID_ADV_POWER_LEVELS_CHAR, &params.advPowerLevels),
screamer 0:c04d932e96c9 145 txPowerModeChar(UUID_TX_POWER_MODE_CHAR, &params.txPowerMode),
screamer 0:c04d932e96c9 146 beaconPeriodChar(UUID_BEACON_PERIOD_CHAR, &params.beaconPeriod),
screamer 0:c04d932e96c9 147 resetChar(UUID_RESET_CHAR, &resetFlag) {
screamer 0:c04d932e96c9 148
mbedAustin 10:b5d19bcf23cf 149 encodeURI(defaultURIDataIn, defaultUriData, defaultUriDataLength); // encode URL to URL Formatting
screamer 0:c04d932e96c9 150 if (defaultUriDataLength > URI_DATA_MAX) {
screamer 0:c04d932e96c9 151 return;
screamer 0:c04d932e96c9 152 }
screamer 0:c04d932e96c9 153
screamer 0:c04d932e96c9 154 if (!resetToDefaultsFlag && (params.uriDataLength > URI_DATA_MAX)) {
screamer 0:c04d932e96c9 155 resetToDefaultsFlag = true;
screamer 0:c04d932e96c9 156 }
screamer 0:c04d932e96c9 157 if (resetToDefaultsFlag) {
screamer 0:c04d932e96c9 158 resetToDefaults();
screamer 0:c04d932e96c9 159 } else {
screamer 0:c04d932e96c9 160 updateCharacteristicValues();
screamer 0:c04d932e96c9 161 }
screamer 0:c04d932e96c9 162
screamer 0:c04d932e96c9 163 lockedState = isLocked();
screamer 0:c04d932e96c9 164
screamer 0:c04d932e96c9 165 lockChar.setWriteAuthorizationCallback(this, &ZipBeaconConfigService::lockAuthorizationCallback);
screamer 0:c04d932e96c9 166 unlockChar.setWriteAuthorizationCallback(this, &ZipBeaconConfigService::unlockAuthorizationCallback);
screamer 0:c04d932e96c9 167 uriDataChar.setWriteAuthorizationCallback(this, &ZipBeaconConfigService::uriDataWriteAuthorizationCallback);
screamer 0:c04d932e96c9 168 flagsChar.setWriteAuthorizationCallback(this, &ZipBeaconConfigService::basicAuthorizationCallback<uint8_t>);
screamer 0:c04d932e96c9 169 advPowerLevelsChar.setWriteAuthorizationCallback(this, &ZipBeaconConfigService::basicAuthorizationCallback<PowerLevels_t>);
screamer 0:c04d932e96c9 170 txPowerModeChar.setWriteAuthorizationCallback(this, &ZipBeaconConfigService::powerModeAuthorizationCallback);
screamer 0:c04d932e96c9 171 beaconPeriodChar.setWriteAuthorizationCallback(this, &ZipBeaconConfigService::basicAuthorizationCallback<uint16_t>);
screamer 0:c04d932e96c9 172 resetChar.setWriteAuthorizationCallback(this, &ZipBeaconConfigService::basicAuthorizationCallback<uint8_t>);
screamer 0:c04d932e96c9 173
screamer 0:c04d932e96c9 174 static GattCharacteristic *charTable[] = {
screamer 0:c04d932e96c9 175 &lockedStateChar, &lockChar, &unlockChar, &uriDataChar,
screamer 0:c04d932e96c9 176 &flagsChar, &advPowerLevelsChar, &txPowerModeChar, &beaconPeriodChar, &resetChar
screamer 0:c04d932e96c9 177 };
screamer 0:c04d932e96c9 178
screamer 0:c04d932e96c9 179 GattService configService(UUID_URI_BEACON_SERVICE, charTable, sizeof(charTable) / sizeof(GattCharacteristic *));
screamer 0:c04d932e96c9 180
screamer 0:c04d932e96c9 181 ble.addService(configService);
screamer 0:c04d932e96c9 182 ble.onDataWritten(this, &ZipBeaconConfigService::onDataWrittenCallback);
screamer 0:c04d932e96c9 183
screamer 0:c04d932e96c9 184 setupZipBeaconConfigAdvertisements(); /* Setup advertising for the configService. */
screamer 0:c04d932e96c9 185
screamer 0:c04d932e96c9 186 initSucceeded = true;
screamer 0:c04d932e96c9 187 }
screamer 0:c04d932e96c9 188
screamer 0:c04d932e96c9 189 bool configuredSuccessfully(void) const {
screamer 0:c04d932e96c9 190 return initSucceeded;
screamer 0:c04d932e96c9 191 }
screamer 0:c04d932e96c9 192
screamer 0:c04d932e96c9 193 /* Start out by advertising the configService for a limited time after
screamer 0:c04d932e96c9 194 * startup; and switch to the normal non-connectible beacon functionality
screamer 0:c04d932e96c9 195 * afterwards. */
mbedAustin 15:af8c24f34a9f 196 void setupZipBeaconConfigAdvertisements() {
mbedAustin 10:b5d19bcf23cf 197 const char DEVICE_NAME[] = "eddystone Config";
screamer 0:c04d932e96c9 198
screamer 0:c04d932e96c9 199 ble.clearAdvertisingPayload();
screamer 0:c04d932e96c9 200
screamer 0:c04d932e96c9 201 ble.accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
screamer 0:c04d932e96c9 202
screamer 0:c04d932e96c9 203 // UUID is in different order in the ADV frame (!)
screamer 0:c04d932e96c9 204 uint8_t reversedServiceUUID[sizeof(UUID_URI_BEACON_SERVICE)];
screamer 0:c04d932e96c9 205 for (unsigned int i = 0; i < sizeof(UUID_URI_BEACON_SERVICE); i++) {
screamer 0:c04d932e96c9 206 reversedServiceUUID[i] = UUID_URI_BEACON_SERVICE[sizeof(UUID_URI_BEACON_SERVICE) - i - 1];
screamer 0:c04d932e96c9 207 }
screamer 0:c04d932e96c9 208 ble.accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_128BIT_SERVICE_IDS, reversedServiceUUID, sizeof(reversedServiceUUID));
screamer 0:c04d932e96c9 209 ble.accumulateAdvertisingPayload(GapAdvertisingData::GENERIC_TAG);
screamer 0:c04d932e96c9 210 ble.accumulateScanResponse(GapAdvertisingData::COMPLETE_LOCAL_NAME, reinterpret_cast<const uint8_t *>(&DEVICE_NAME), sizeof(DEVICE_NAME));
screamer 0:c04d932e96c9 211 ble.accumulateScanResponse(
screamer 0:c04d932e96c9 212 GapAdvertisingData::TX_POWER_LEVEL,
screamer 0:c04d932e96c9 213 reinterpret_cast<uint8_t *>(&defaultAdvPowerLevels[ZipBeaconConfigService::TX_POWER_MODE_LOW]),
screamer 0:c04d932e96c9 214 sizeof(uint8_t));
screamer 0:c04d932e96c9 215
screamer 0:c04d932e96c9 216 ble.setTxPower(params.advPowerLevels[params.txPowerMode]);
screamer 0:c04d932e96c9 217 ble.setDeviceName(reinterpret_cast<const uint8_t *>(&DEVICE_NAME));
screamer 0:c04d932e96c9 218 ble.setAdvertisingType(GapAdvertisingParams::ADV_CONNECTABLE_UNDIRECTED);
screamer 0:c04d932e96c9 219 ble.setAdvertisingInterval(Gap::MSEC_TO_ADVERTISEMENT_DURATION_UNITS(ADVERTISING_INTERVAL_MSEC));
screamer 0:c04d932e96c9 220 }
mbedAustin 15:af8c24f34a9f 221
mbedAustin 10:b5d19bcf23cf 222 /*
mbedAustin 15:af8c24f34a9f 223 * Set Eddystone UID Frame information.
mbedAustin 10:b5d19bcf23cf 224 * @param[in] power TX Power in dB measured at 0 meters from the device. Range of -100 to +20 dB.
mbedAustin 10:b5d19bcf23cf 225 * @param namespaceID 10B namespace ID
mbedAustin 10:b5d19bcf23cf 226 * @param instanceID 6B instance ID
mbedAustin 15:af8c24f34a9f 227 * @param RFU 2B of RFU, initialized to 0x0000 and not broadcast, included for future reference.
mbedAustin 10:b5d19bcf23cf 228 *
mbedAustin 10:b5d19bcf23cf 229 */
mbedAustin 15:af8c24f34a9f 230 void setUIDFrameData(int8_t power, UIDNamespaceID_t namespaceID, UIDInstanceID_t instanceID, uint16_t RFU = 0x0000) {
mbedAustin 11:73ea4ef7f5a4 231 defaultUidPower = power;
mbedAustin 11:73ea4ef7f5a4 232 memcpy(defaultUidNamespaceID, namespaceID, UID_NAMESPACEID_SIZE);
mbedAustin 11:73ea4ef7f5a4 233 memcpy(defaultUidInstanceID, instanceID, UID_INSTANCEID_SIZE);
mbedAustin 15:af8c24f34a9f 234 uidRFU = (uint16_t)RFU; // this is probably bad form, but it doesnt really matter yet.
mbedAustin 11:73ea4ef7f5a4 235 return;
mbedAustin 11:73ea4ef7f5a4 236 }
mbedAustin 15:af8c24f34a9f 237
mbedAustin 11:73ea4ef7f5a4 238 /*
mbedAustin 11:73ea4ef7f5a4 239 * Construct UID frame from private variables
mbedAustin 11:73ea4ef7f5a4 240 * @param[in/out] Data pointer to array to store constructed frame in
mbedAustin 11:73ea4ef7f5a4 241 * @param[in] maxSize number of bytes left in array, effectively how much emtpy space is available to write to
mbedAustin 15:af8c24f34a9f 242 * @return number of bytes used. negative number indicates error message.
mbedAustin 11:73ea4ef7f5a4 243 */
mbedAustin 15:af8c24f34a9f 244 int constructUIDFrame(uint8_t * Data, uint8_t maxSize) {
mbedAustin 15:af8c24f34a9f 245 if(maxSize < FRAME_SIZE_UID) {
mbedAustin 15:af8c24f34a9f 246 return -1; // not enough space to encode UIDframe in advertising packet.
mbedAustin 11:73ea4ef7f5a4 247 }
mbedAustin 11:73ea4ef7f5a4 248 int index = 0;
mbedAustin 11:73ea4ef7f5a4 249 Data[index++] = FRAME_TYPE_UID; // 1B Type
mbedAustin 11:73ea4ef7f5a4 250 Data[index++] = defaultUidPower; // 1B Power @ 0meter
mbedAustin 15:af8c24f34a9f 251 for(int x = 0; x < UID_NAMESPACEID_SIZE; x++) { // 10B Namespce ID
mbedAustin 11:73ea4ef7f5a4 252 Data[index++] = defaultUidNamespaceID[x];
mbedAustin 15:af8c24f34a9f 253 }
mbedAustin 15:af8c24f34a9f 254 for(int x = 0; x< UID_INSTANCEID_SIZE; x++) { // 6B Instance ID
mbedAustin 11:73ea4ef7f5a4 255 Data[index++] = defaultUidInstanceID[x];
mbedAustin 15:af8c24f34a9f 256 }
mbedAustin 15:af8c24f34a9f 257 if(0x00 != uidRFU) { // 2B RFU, include if non-zero, otherwise ignore
mbedAustin 11:73ea4ef7f5a4 258 Data[index++] = (uint8_t)(uidRFU >> 8);
mbedAustin 11:73ea4ef7f5a4 259 Data[index++] = (uint8_t)uidRFU;
mbedAustin 11:73ea4ef7f5a4 260 }
mbedAustin 11:73ea4ef7f5a4 261 return index;
mbedAustin 10:b5d19bcf23cf 262 }
mbedAustin 15:af8c24f34a9f 263
mbedAustin 10:b5d19bcf23cf 264 /*
mbedAustin 15:af8c24f34a9f 265 * Set Eddystone URL Frame information.
mbedAustin 10:b5d19bcf23cf 266 * @param[in] power TX Power in dB measured at 0 meters from the device.
mbedAustin 15:af8c24f34a9f 267 * @param url URL to encode
mbedAustin 10:b5d19bcf23cf 268 * @return false on success, true on failure.
mbedAustin 10:b5d19bcf23cf 269 */
mbedAustin 15:af8c24f34a9f 270 bool setURLFrameData(int8_t power, const char * url) {
mbedAustin 11:73ea4ef7f5a4 271 defaultUrlPower = power;
mbedAustin 11:73ea4ef7f5a4 272 encodeURI(url, defaultUriData, defaultUriDataLength); // encode URL to URL Formatting
mbedAustin 10:b5d19bcf23cf 273 if (defaultUriDataLength > URI_DATA_MAX) {
mbedAustin 10:b5d19bcf23cf 274 return true; // error, URL is too big
mbedAustin 10:b5d19bcf23cf 275 }
mbedAustin 11:73ea4ef7f5a4 276 return false;
mbedAustin 11:73ea4ef7f5a4 277 }
mbedAustin 15:af8c24f34a9f 278
mbedAustin 11:73ea4ef7f5a4 279 /*
mbedAustin 11:73ea4ef7f5a4 280 * Construct URL frame from private variables
mbedAustin 11:73ea4ef7f5a4 281 * @param[in/out] Data pointer to array to store constructed frame in
mbedAustin 11:73ea4ef7f5a4 282 * @param[in] maxSize number of bytes left in array, effectively how much emtpy space is available to write to
mbedAustin 15:af8c24f34a9f 283 * @return number of bytes used. negative number indicates error message.
mbedAustin 11:73ea4ef7f5a4 284 */
mbedAustin 15:af8c24f34a9f 285 int constructURLFrame(uint8_t * Data, uint8_t maxSize) {
mbedAustin 15:af8c24f34a9f 286 if(maxSize < (2 + defaultUriDataLength)) {
mbedAustin 15:af8c24f34a9f 287 return -1; // not enough space to encode URL frame in advertising packet.
mbedAustin 11:73ea4ef7f5a4 288 }
mbedAustin 11:73ea4ef7f5a4 289 int index = 0;
mbedAustin 11:73ea4ef7f5a4 290 Data[index++] = FRAME_TYPE_URL; // 1B Type
mbedAustin 15:af8c24f34a9f 291 Data[index++] = params.txPowerMode; // 1B TX Power
mbedAustin 15:af8c24f34a9f 292 for(int x = 0; x < defaultUriDataLength; x++) { // 18B of URL Prefix + encoded URL
mbedAustin 11:73ea4ef7f5a4 293 Data[index++] = defaultUriData[x];
mbedAustin 11:73ea4ef7f5a4 294 }
mbedAustin 15:af8c24f34a9f 295 return index;
mbedAustin 10:b5d19bcf23cf 296 }
mbedAustin 15:af8c24f34a9f 297
mbedAustin 10:b5d19bcf23cf 298 /*
mbedAustin 15:af8c24f34a9f 299 * Set Eddystone TLM Frame information.
mbedAustin 10:b5d19bcf23cf 300 * @param[in] Version of the TLM beacon data format
mbedAustin 10:b5d19bcf23cf 301 * @param batteryVoltage in milivolts
mbedAustin 10:b5d19bcf23cf 302 * @param beaconTemp in 8.8 floating point notation
mbedAustin 10:b5d19bcf23cf 303 *
mbedAustin 10:b5d19bcf23cf 304 */
mbedAustin 15:af8c24f34a9f 305 void setTLMFrameData(uint8_t version, uint16_t batteryVoltage, uint16_t beaconTemp, uint32_t pduCount = 0, uint32_t timeSinceBoot = 0) {
mbedAustin 10:b5d19bcf23cf 306 TlmVersion = version;
mbedAustin 10:b5d19bcf23cf 307 TlmBatteryVoltage = batteryVoltage;
mbedAustin 10:b5d19bcf23cf 308 TlmBeaconTemp = beaconTemp;
mbedAustin 10:b5d19bcf23cf 309 TlmPduCount = pduCount; // reset
mbedAustin 10:b5d19bcf23cf 310 TlmTimeSinceBoot = timeSinceBoot; // reset
mbedAustin 15:af8c24f34a9f 311 return;
mbedAustin 10:b5d19bcf23cf 312 }
mbedAustin 15:af8c24f34a9f 313
mbedAustin 11:73ea4ef7f5a4 314 /*
mbedAustin 11:73ea4ef7f5a4 315 * Construct TLM frame from private variables
mbedAustin 11:73ea4ef7f5a4 316 * @param[in/out] Data pointer to array to store constructed frame in
mbedAustin 11:73ea4ef7f5a4 317 * @param[in] maxSize number of bytes left in array, effectively how much emtpy space is available to write to
mbedAustin 15:af8c24f34a9f 318 * @return number of bytes used. negative number indicates error message.
mbedAustin 11:73ea4ef7f5a4 319 */
mbedAustin 15:af8c24f34a9f 320 int constructTLMFrame(uint8_t * Data, uint8_t maxSize) {
mbedAustin 15:af8c24f34a9f 321 if(maxSize < FRAME_SIZE_TLM) { // error, not enough space to add TLM frame. 14B, every time
mbedAustin 11:73ea4ef7f5a4 322 return -1;
mbedAustin 11:73ea4ef7f5a4 323 }
mbedAustin 11:73ea4ef7f5a4 324 int index = 0;
mbedAustin 11:73ea4ef7f5a4 325 Data[index++] = FRAME_TYPE_TLM; // Eddystone frame type = Telemetry
mbedAustin 11:73ea4ef7f5a4 326 Data[index++] = TlmVersion; // TLM Version Number
mbedAustin 11:73ea4ef7f5a4 327 Data[index++] = (uint8_t)(TlmBatteryVoltage>>0); // Battery Voltage[0]
mbedAustin 11:73ea4ef7f5a4 328 Data[index++] = (uint8_t)(TlmBatteryVoltage>>8); // Battery Voltage[1]
mbedAustin 11:73ea4ef7f5a4 329 Data[index++] = (uint8_t)(TlmBeaconTemp>>0); // Beacon Temp[0]
mbedAustin 11:73ea4ef7f5a4 330 Data[index++] = (uint8_t)(TlmBeaconTemp>>8); // Beacon Temp[1]
mbedAustin 11:73ea4ef7f5a4 331 Data[index++] = (uint8_t)(TlmPduCount>>0); // PDU Count [0]
mbedAustin 11:73ea4ef7f5a4 332 Data[index++] = (uint8_t)(TlmPduCount>>8); // PDU Count [1]
mbedAustin 11:73ea4ef7f5a4 333 Data[index++] = (uint8_t)(TlmPduCount>>16); // PDU Count [2]
mbedAustin 11:73ea4ef7f5a4 334 Data[index++] = (uint8_t)(TlmPduCount>>24); // PDU Count [3]
mbedAustin 11:73ea4ef7f5a4 335 Data[index++] = (uint8_t)(TlmTimeSinceBoot>>0); // Time Since Boot [0]
mbedAustin 11:73ea4ef7f5a4 336 Data[index++] = (uint8_t)(TlmTimeSinceBoot>>8); // Time Since Boot [1]
mbedAustin 11:73ea4ef7f5a4 337 Data[index++] = (uint8_t)(TlmTimeSinceBoot>>16); // Time Since Boot [2]
mbedAustin 11:73ea4ef7f5a4 338 Data[index++] = (uint8_t)(TlmTimeSinceBoot>>24); // Time Since Boot [3]
mbedAustin 15:af8c24f34a9f 339
mbedAustin 11:73ea4ef7f5a4 340 return index;
mbedAustin 11:73ea4ef7f5a4 341 }
mbedAustin 15:af8c24f34a9f 342
mbedAustin 12:ced5e837c511 343 /*
mbedAustin 12:ced5e837c511 344 * Update the TLM frame battery voltage value
mbedAustin 12:ced5e837c511 345 * @param[in] voltagemv Voltage to update the TLM field battery voltage with (in mV)
mbedAustin 12:ced5e837c511 346 * @return nothing
mbedAustin 12:ced5e837c511 347 */
mbedAustin 15:af8c24f34a9f 348 void updateTlmBatteryVoltage(uint16_t voltagemv) {
mbedAustin 12:ced5e837c511 349 TlmBatteryVoltage = voltagemv;
mbedAustin 15:af8c24f34a9f 350 return;
mbedAustin 12:ced5e837c511 351 }
mbedAustin 15:af8c24f34a9f 352
mbedAustin 12:ced5e837c511 353 /*
mbedAustin 15:af8c24f34a9f 354 * Update the TLM frame beacon temperature
mbedAustin 12:ced5e837c511 355 * @param[in] temp Temperature of beacon (in 8.8fpn)
mbedAustin 12:ced5e837c511 356 * @return nothing
mbedAustin 12:ced5e837c511 357 */
mbedAustin 15:af8c24f34a9f 358 void updateTlmBeaconTemp(uint16_t temp) {
mbedAustin 12:ced5e837c511 359 TlmBeaconTemp = temp;
mbedAustin 15:af8c24f34a9f 360 return;
mbedAustin 12:ced5e837c511 361 }
mbedAustin 15:af8c24f34a9f 362
mbedAustin 12:ced5e837c511 363 /*
mbedAustin 12:ced5e837c511 364 * Update the TLM frame PDU Count field
mbedAustin 12:ced5e837c511 365 * @param[in] pduCount Number of Advertisiting frames sent since powerup
mbedAustin 12:ced5e837c511 366 * @return nothing
mbedAustin 12:ced5e837c511 367 */
mbedAustin 15:af8c24f34a9f 368 void updateTlmPduCount(uint32_t pduCount) {
mbedAustin 12:ced5e837c511 369 TlmPduCount = pduCount;
mbedAustin 15:af8c24f34a9f 370 return;
mbedAustin 12:ced5e837c511 371 }
mbedAustin 15:af8c24f34a9f 372
mbedAustin 12:ced5e837c511 373 /*
mbedAustin 12:ced5e837c511 374 * Update the TLM frame Time since boot in 0.1s incriments
mbedAustin 12:ced5e837c511 375 * @param[in] timeSinceBoot Time since boot in 0.1s incriments
mbedAustin 12:ced5e837c511 376 * @return nothing
mbedAustin 12:ced5e837c511 377 */
mbedAustin 15:af8c24f34a9f 378 void updateTlmTimeSinceBoot(uint32_t timeSinceBoot) {
mbedAustin 12:ced5e837c511 379 TlmTimeSinceBoot = timeSinceBoot;
mbedAustin 15:af8c24f34a9f 380 return;
mbedAustin 12:ced5e837c511 381 }
mbedAustin 15:af8c24f34a9f 382
mbedAustin 14:5a2a104a21a8 383 /*
mbedAustin 16:a7d07ea94b31 384 * callback function, called every 0.1s, incriments the TimeSinceBoot field in the TLM frame
mbedAustin 16:a7d07ea94b31 385 * @return nothing
mbedAustin 16:a7d07ea94b31 386 */
mbedAustin 16:a7d07ea94b31 387 void tsbCallback(void) {
mbedAustin 16:a7d07ea94b31 388 TlmTimeSinceBoot++;
mbedAustin 16:a7d07ea94b31 389 }
mbedAustin 16:a7d07ea94b31 390
mbedAustin 16:a7d07ea94b31 391 /*
mbedAustin 16:a7d07ea94b31 392 * Update advertising data
mbedAustin 16:a7d07ea94b31 393 * @return true on success, false on failure
mbedAustin 16:a7d07ea94b31 394 */
mbedAustin 16:a7d07ea94b31 395 bool updateAdvPacket(uint8_t serviceData[], unsigned serviceDataLen) {
mbedAustin 16:a7d07ea94b31 396 // Fields from the Service
mbedAustin 16:a7d07ea94b31 397 DBG("Updating Adv Data: %d", serviceDataLen);
mbedAustin 16:a7d07ea94b31 398
mbedAustin 16:a7d07ea94b31 399 ble.clearAdvertisingPayload();
mbedAustin 16:a7d07ea94b31 400 ble.accumulateAdvertisingPayload(GapAdvertisingData::BREDR_NOT_SUPPORTED | GapAdvertisingData::LE_GENERAL_DISCOVERABLE);
mbedAustin 16:a7d07ea94b31 401 ble.accumulateAdvertisingPayload(GapAdvertisingData::COMPLETE_LIST_16BIT_SERVICE_IDS, BEACON_EDDYSTONE, sizeof(BEACON_EDDYSTONE));
mbedAustin 16:a7d07ea94b31 402 ble.accumulateAdvertisingPayload(GapAdvertisingData::SERVICE_DATA, serviceData, serviceDataLen);
mbedAustin 16:a7d07ea94b31 403 // attach callback to count number of sent packets
mbedAustin 16:a7d07ea94b31 404
mbedAustin 16:a7d07ea94b31 405
mbedAustin 16:a7d07ea94b31 406 // printf("\r\n");
mbedAustin 16:a7d07ea94b31 407 // for(int x = 0; x<serviceDataLen; x++) {
mbedAustin 16:a7d07ea94b31 408 // printf("%2.2x:",serviceData[x]);
mbedAustin 16:a7d07ea94b31 409 // }
mbedAustin 16:a7d07ea94b31 410 // printf("\r\n");
mbedAustin 16:a7d07ea94b31 411
mbedAustin 16:a7d07ea94b31 412 ble.gap().startAdvertising();
mbedAustin 16:a7d07ea94b31 413 return true;
mbedAustin 16:a7d07ea94b31 414 }
mbedAustin 16:a7d07ea94b31 415
mbedAustin 16:a7d07ea94b31 416 /*
mbedAustin 14:5a2a104a21a8 417 * Callback from onRadioNotification(), used to update the PDUCounter and maybe other stuff eventually?
mbedAustin 14:5a2a104a21a8 418 *
mbedAustin 14:5a2a104a21a8 419 *
mbedAustin 14:5a2a104a21a8 420 */
mbedAustin 16:a7d07ea94b31 421 void radioNotificationCallback(bool radioActive) {
mbedAustin 16:a7d07ea94b31 422 DBG("RadioNotificationCallback : %d, %d",radioActive,frameIndex);
mbedAustin 14:5a2a104a21a8 423 // Update Time and PDUCount
mbedAustin 16:a7d07ea94b31 424 // True just before an frame is sent, fale just after a frame is sent
mbedAustin 16:a7d07ea94b31 425 if(radioActive) {
mbedAustin 16:a7d07ea94b31 426 // Do Nothing
mbedAustin 16:a7d07ea94b31 427 } else {
mbedAustin 16:a7d07ea94b31 428 static bool switchFlag;
mbedAustin 16:a7d07ea94b31 429 TlmPduCount++;
mbedAustin 14:5a2a104a21a8 430 frameIndex = frameIndex % EDDYSTONE_MAX_FRAMETYPE;
mbedAustin 14:5a2a104a21a8 431 uint8_t serviceData[SERVICE_DATA_MAX];
mbedAustin 14:5a2a104a21a8 432 unsigned serviceDataLen = 0;
mbedAustin 16:a7d07ea94b31 433 //hard code in the eddystone UUID
mbedAustin 14:5a2a104a21a8 434 serviceData[serviceDataLen++] = BEACON_EDDYSTONE[0];
mbedAustin 14:5a2a104a21a8 435 serviceData[serviceDataLen++] = BEACON_EDDYSTONE[1];
mbedAustin 16:a7d07ea94b31 436
mbedAustin 16:a7d07ea94b31 437 // state machine to control which packet is being sent
mbedAustin 15:af8c24f34a9f 438 switch(frameIndex) {
mbedAustin 14:5a2a104a21a8 439 case 0:
mbedAustin 16:a7d07ea94b31 440 DBG("\tconstructing TLM Frame: ");
mbedAustin 16:a7d07ea94b31 441 serviceDataLen += constructTLMFrame(serviceData+serviceDataLen,SERVICE_DATA_MAX);
mbedAustin 16:a7d07ea94b31 442 updateAdvPacket(serviceData,serviceDataLen);
mbedAustin 16:a7d07ea94b31 443 frameIndex++;
mbedAustin 16:a7d07ea94b31 444 switchFlag = true;
mbedAustin 14:5a2a104a21a8 445 break;
mbedAustin 14:5a2a104a21a8 446 case 1:
mbedAustin 16:a7d07ea94b31 447 // switch out packets
mbedAustin 16:a7d07ea94b31 448 if(switchFlag) {
mbedAustin 16:a7d07ea94b31 449 DBG("\tconstructing URL Frame: ");
mbedAustin 16:a7d07ea94b31 450 serviceDataLen += constructURLFrame(serviceData+serviceDataLen,SERVICE_DATA_MAX);
mbedAustin 16:a7d07ea94b31 451 updateAdvPacket(serviceData,serviceDataLen);
mbedAustin 16:a7d07ea94b31 452 switchFlag = false;
mbedAustin 16:a7d07ea94b31 453 } else {
mbedAustin 16:a7d07ea94b31 454 if((TlmPduCount % 10) == 0) { // every 10 adv packets switch the frame
mbedAustin 16:a7d07ea94b31 455 switchFlag = true;
mbedAustin 16:a7d07ea94b31 456 frameIndex++;
mbedAustin 16:a7d07ea94b31 457 }
mbedAustin 16:a7d07ea94b31 458 }
mbedAustin 14:5a2a104a21a8 459 break;
mbedAustin 14:5a2a104a21a8 460 case 2:
mbedAustin 16:a7d07ea94b31 461 // switch out packets
mbedAustin 16:a7d07ea94b31 462 if(switchFlag) {
mbedAustin 16:a7d07ea94b31 463 DBG("\tconstructing UID Frame: ");
mbedAustin 16:a7d07ea94b31 464 serviceDataLen += constructUIDFrame(serviceData+serviceDataLen,SERVICE_DATA_MAX);
mbedAustin 16:a7d07ea94b31 465 updateAdvPacket(serviceData,serviceDataLen);
mbedAustin 16:a7d07ea94b31 466 switchFlag = false;
mbedAustin 16:a7d07ea94b31 467 } else {
mbedAustin 16:a7d07ea94b31 468 if((TlmPduCount % 10) == 0) { // every 10 adv packets switch the frame
mbedAustin 16:a7d07ea94b31 469 switchFlag = true;
mbedAustin 16:a7d07ea94b31 470 frameIndex++;
mbedAustin 16:a7d07ea94b31 471 }
mbedAustin 16:a7d07ea94b31 472 }
mbedAustin 14:5a2a104a21a8 473 break;
mbedAustin 15:af8c24f34a9f 474 }
mbedAustin 14:5a2a104a21a8 475 }
mbedAustin 16:a7d07ea94b31 476
mbedAustin 15:af8c24f34a9f 477 return;
mbedAustin 14:5a2a104a21a8 478 }
screamer 0:c04d932e96c9 479
screamer 0:c04d932e96c9 480 /* Helper function to switch to the non-connectible normal mode for ZipBeacon. This gets called after a timeout. */
mbedAustin 15:af8c24f34a9f 481 void setupZipBeaconAdvertisements() {
mbedAustin 16:a7d07ea94b31 482 DBG("Switching Config -> adv");
screamer 0:c04d932e96c9 483 uint8_t serviceData[SERVICE_DATA_MAX];
screamer 0:c04d932e96c9 484 unsigned serviceDataLen = 0;
mbedAustin 16:a7d07ea94b31 485 unsigned beaconPeriod = params.beaconPeriod;
mbedAustin 16:a7d07ea94b31 486 unsigned txPowerMode = params.txPowerMode;
mbedAustin 16:a7d07ea94b31 487 unsigned uriDataLength = params.uriDataLength;
mbedAustin 16:a7d07ea94b31 488
mbedAustin 16:a7d07ea94b31 489 ZipBeaconConfigService::UriData_t &uriData = params.uriData;
mbedAustin 16:a7d07ea94b31 490 ZipBeaconConfigService::PowerLevels_t &advPowerLevels = params.advPowerLevels;
mbedAustin 16:a7d07ea94b31 491 uint8_t flags = params.flags;
mbedAustin 16:a7d07ea94b31 492
mbedAustin 14:5a2a104a21a8 493 // Initialize Frame transition
mbedAustin 14:5a2a104a21a8 494 frameIndex = 0;
mbedAustin 15:af8c24f34a9f 495 uidRFU = 0;
screamer 0:c04d932e96c9 496
screamer 0:c04d932e96c9 497 /* Reinitialize the BLE stack. This will clear away the existing services and advertising state. */
screamer 0:c04d932e96c9 498 ble.shutdown();
screamer 0:c04d932e96c9 499 ble.init();
screamer 0:c04d932e96c9 500 ble.setTxPower(params.advPowerLevels[params.txPowerMode]);
screamer 0:c04d932e96c9 501 ble.setAdvertisingType(GapAdvertisingParams::ADV_NON_CONNECTABLE_UNDIRECTED);
screamer 0:c04d932e96c9 502 ble.setAdvertisingInterval(beaconPeriod);
mbedAustin 16:a7d07ea94b31 503 ble.gap().onRadioNotification(this,&ZipBeaconConfigService::radioNotificationCallback);
mbedAustin 16:a7d07ea94b31 504 extern void saveURIBeaconConfigParams(const Params_t *paramsP); /* forward declaration; necessary to avoid a circular dependency. */
mbedAustin 16:a7d07ea94b31 505 saveURIBeaconConfigParams(&params);
mbedAustin 15:af8c24f34a9f 506
mbedAustin 14:5a2a104a21a8 507 setTLMFrameData(0x00,22,33,0,0); // Initialize TLM Data, for testing, remove for release
mbedAustin 14:5a2a104a21a8 508 updateTlmPduCount(0);
mbedAustin 14:5a2a104a21a8 509 updateTlmTimeSinceBoot(0);
mbedAustin 15:af8c24f34a9f 510
mbedAustin 15:af8c24f34a9f 511 // Construct TLM Frame in initial advertising.
mbedAustin 14:5a2a104a21a8 512 serviceData[serviceDataLen++] = BEACON_EDDYSTONE[0];
mbedAustin 14:5a2a104a21a8 513 serviceData[serviceDataLen++] = BEACON_EDDYSTONE[1];
mbedAustin 16:a7d07ea94b31 514 serviceDataLen += constructTLMFrame(serviceData+serviceDataLen,SERVICE_DATA_MAX);
mbedAustin 16:a7d07ea94b31 515
mbedAustin 16:a7d07ea94b31 516 updateAdvPacket(serviceData, serviceDataLen);
mbedAustin 14:5a2a104a21a8 517 // serviceData[serviceDataLen++] = FRAME_TYPE_URL | flags;
mbedAustin 14:5a2a104a21a8 518 // serviceData[serviceDataLen++] = advPowerLevels[txPowerMode];
mbedAustin 14:5a2a104a21a8 519 // for (unsigned j = 0; j < uriDataLength; j++) {
mbedAustin 14:5a2a104a21a8 520 // serviceData[serviceDataLen++] = uriData[j];
mbedAustin 14:5a2a104a21a8 521 // }
screamer 0:c04d932e96c9 522
mbedAustin 16:a7d07ea94b31 523
mbedAustin 16:a7d07ea94b31 524 //callbackTick.attach(this,&ZipBeaconConfigService::radioNotificationCallback, 0.1); // switch services every 2 seconds
mbedAustin 16:a7d07ea94b31 525 timeSinceBootTick.attach(this,&ZipBeaconConfigService::tsbCallback,0.1); // incriment the TimeSinceBoot ticker every 0.1s
mbedAustin 15:af8c24f34a9f 526 //callbackTick.attach(stupidWrapperFn,2.0);
screamer 0:c04d932e96c9 527 }
screamer 0:c04d932e96c9 528
mbedAustin 15:af8c24f34a9f 529 private:
mbedAustin 16:a7d07ea94b31 530 // True if the lock bits are non-zero
screamer 0:c04d932e96c9 531 bool isLocked() {
screamer 0:c04d932e96c9 532 Lock_t testLock;
screamer 0:c04d932e96c9 533 memset(testLock, 0, sizeof(Lock_t));
screamer 0:c04d932e96c9 534 return memcmp(params.lock, testLock, sizeof(Lock_t));
screamer 0:c04d932e96c9 535 }
screamer 0:c04d932e96c9 536
screamer 0:c04d932e96c9 537 /*
screamer 0:c04d932e96c9 538 * This callback is invoked when a GATT client attempts to modify any of the
screamer 0:c04d932e96c9 539 * characteristics of this service. Attempts to do so are also applied to
screamer 0:c04d932e96c9 540 * the internal state of this service object.
screamer 0:c04d932e96c9 541 */
rgrover1 7:e9800c45e065 542 void onDataWrittenCallback(const GattWriteCallbackParams *writeParams) {
rgrover1 7:e9800c45e065 543 uint16_t handle = writeParams->handle;
screamer 0:c04d932e96c9 544
screamer 0:c04d932e96c9 545 if (handle == lockChar.getValueHandle()) {
screamer 0:c04d932e96c9 546 // Validated earlier
screamer 0:c04d932e96c9 547 memcpy(params.lock, writeParams->data, sizeof(Lock_t));
screamer 0:c04d932e96c9 548 // use isLocked() in case bits are being set to all 0's
screamer 0:c04d932e96c9 549 lockedState = isLocked();
screamer 0:c04d932e96c9 550 } else if (handle == unlockChar.getValueHandle()) {
screamer 0:c04d932e96c9 551 // Validated earlier
screamer 0:c04d932e96c9 552 memset(params.lock, 0, sizeof(Lock_t));
screamer 0:c04d932e96c9 553 lockedState = false;
screamer 0:c04d932e96c9 554 } else if (handle == uriDataChar.getValueHandle()) {
screamer 0:c04d932e96c9 555 params.uriDataLength = writeParams->len;
screamer 0:c04d932e96c9 556 memcpy(params.uriData, writeParams->data, params.uriDataLength);
screamer 0:c04d932e96c9 557 } else if (handle == flagsChar.getValueHandle()) {
screamer 0:c04d932e96c9 558 params.flags = *(writeParams->data);
screamer 0:c04d932e96c9 559 } else if (handle == advPowerLevelsChar.getValueHandle()) {
screamer 0:c04d932e96c9 560 memcpy(params.advPowerLevels, writeParams->data, sizeof(PowerLevels_t));
screamer 0:c04d932e96c9 561 } else if (handle == txPowerModeChar.getValueHandle()) {
screamer 0:c04d932e96c9 562 params.txPowerMode = *(writeParams->data);
screamer 0:c04d932e96c9 563 } else if (handle == beaconPeriodChar.getValueHandle()) {
screamer 0:c04d932e96c9 564 params.beaconPeriod = *((uint16_t *)(writeParams->data));
rgrover1 4:4440953bde10 565
rgrover1 4:4440953bde10 566 /* Re-map beaconPeriod to within permissible bounds if necessary. */
rgrover1 4:4440953bde10 567 if (params.beaconPeriod != 0) {
rgrover1 4:4440953bde10 568 bool paramsUpdated = false;
rgrover1 4:4440953bde10 569 if (params.beaconPeriod < ble.getMinAdvertisingInterval()) {
rgrover1 4:4440953bde10 570 params.beaconPeriod = ble.getMinAdvertisingInterval();
rgrover1 4:4440953bde10 571 paramsUpdated = true;
rgrover1 4:4440953bde10 572 } else if (params.beaconPeriod > ble.getMaxAdvertisingInterval()) {
rgrover1 4:4440953bde10 573 params.beaconPeriod = ble.getMaxAdvertisingInterval();
rgrover1 4:4440953bde10 574 paramsUpdated = true;
rgrover1 4:4440953bde10 575 }
rgrover1 4:4440953bde10 576 if (paramsUpdated) {
rgrover1 4:4440953bde10 577 ble.updateCharacteristicValue(beaconPeriodChar.getValueHandle(), reinterpret_cast<uint8_t *>(&params.beaconPeriod), sizeof(uint16_t));
rgrover1 4:4440953bde10 578 }
rgrover1 4:4440953bde10 579 }
screamer 0:c04d932e96c9 580 } else if (handle == resetChar.getValueHandle()) {
screamer 0:c04d932e96c9 581 resetToDefaults();
screamer 0:c04d932e96c9 582 }
screamer 0:c04d932e96c9 583 }
screamer 0:c04d932e96c9 584
screamer 0:c04d932e96c9 585 /*
screamer 0:c04d932e96c9 586 * Reset the default values.
screamer 0:c04d932e96c9 587 */
screamer 0:c04d932e96c9 588 void resetToDefaults(void) {
screamer 0:c04d932e96c9 589 lockedState = false;
screamer 0:c04d932e96c9 590 memset(params.lock, 0, sizeof(Lock_t));
screamer 0:c04d932e96c9 591 memcpy(params.uriData, defaultUriData, URI_DATA_MAX);
screamer 0:c04d932e96c9 592 params.uriDataLength = defaultUriDataLength;
screamer 0:c04d932e96c9 593 params.flags = 0;
screamer 0:c04d932e96c9 594 memcpy(params.advPowerLevels, defaultAdvPowerLevels, sizeof(PowerLevels_t));
screamer 0:c04d932e96c9 595 params.txPowerMode = TX_POWER_MODE_LOW;
screamer 0:c04d932e96c9 596 params.beaconPeriod = 1000;
mbedAustin 10:b5d19bcf23cf 597 memcpy(params.uidNamespaceID, defaultUidNamespaceID, UID_NAMESPACEID_SIZE);
mbedAustin 10:b5d19bcf23cf 598 memcpy(params.uidInstanceID, defaultUidInstanceID, UID_INSTANCEID_SIZE);
mbedAustin 12:ced5e837c511 599 params.tlmVersion = 0;
screamer 0:c04d932e96c9 600 updateCharacteristicValues();
screamer 0:c04d932e96c9 601 }
screamer 0:c04d932e96c9 602
screamer 0:c04d932e96c9 603 /*
screamer 0:c04d932e96c9 604 * Internal helper function used to update the GATT database following any
screamer 0:c04d932e96c9 605 * change to the internal state of the service object.
screamer 0:c04d932e96c9 606 */
screamer 0:c04d932e96c9 607 void updateCharacteristicValues(void) {
screamer 0:c04d932e96c9 608 ble.updateCharacteristicValue(lockedStateChar.getValueHandle(), &lockedState, 1);
screamer 0:c04d932e96c9 609 ble.updateCharacteristicValue(uriDataChar.getValueHandle(), params.uriData, params.uriDataLength);
screamer 0:c04d932e96c9 610 ble.updateCharacteristicValue(flagsChar.getValueHandle(), &params.flags, 1);
screamer 0:c04d932e96c9 611 ble.updateCharacteristicValue(beaconPeriodChar.getValueHandle(),
screamer 0:c04d932e96c9 612 reinterpret_cast<uint8_t *>(&params.beaconPeriod), sizeof(uint16_t));
screamer 0:c04d932e96c9 613 ble.updateCharacteristicValue(txPowerModeChar.getValueHandle(), &params.txPowerMode, 1);
screamer 0:c04d932e96c9 614 ble.updateCharacteristicValue(advPowerLevelsChar.getValueHandle(),
screamer 0:c04d932e96c9 615 reinterpret_cast<uint8_t *>(params.advPowerLevels), sizeof(PowerLevels_t));
screamer 0:c04d932e96c9 616 }
screamer 0:c04d932e96c9 617
mbedAustin 15:af8c24f34a9f 618 private:
rgrover1 7:e9800c45e065 619 void lockAuthorizationCallback(GattWriteAuthCallbackParams *authParams) {
screamer 0:c04d932e96c9 620 if (lockedState) {
screamer 0:c04d932e96c9 621 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION;
screamer 0:c04d932e96c9 622 } else if (authParams->len != sizeof(Lock_t)) {
screamer 0:c04d932e96c9 623 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH;
screamer 0:c04d932e96c9 624 } else if (authParams->offset != 0) {
screamer 0:c04d932e96c9 625 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET;
screamer 0:c04d932e96c9 626 } else {
screamer 0:c04d932e96c9 627 authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
screamer 0:c04d932e96c9 628 }
screamer 0:c04d932e96c9 629 }
screamer 0:c04d932e96c9 630
screamer 0:c04d932e96c9 631
rgrover1 7:e9800c45e065 632 void unlockAuthorizationCallback(GattWriteAuthCallbackParams *authParams) {
screamer 0:c04d932e96c9 633 if (!lockedState) {
screamer 0:c04d932e96c9 634 authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
screamer 0:c04d932e96c9 635 } else if (authParams->len != sizeof(Lock_t)) {
screamer 0:c04d932e96c9 636 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH;
screamer 0:c04d932e96c9 637 } else if (authParams->offset != 0) {
screamer 0:c04d932e96c9 638 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET;
screamer 0:c04d932e96c9 639 } else if (memcmp(authParams->data, params.lock, sizeof(Lock_t)) != 0) {
screamer 0:c04d932e96c9 640 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION;
screamer 0:c04d932e96c9 641 } else {
screamer 0:c04d932e96c9 642 authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
screamer 0:c04d932e96c9 643 }
screamer 0:c04d932e96c9 644 }
screamer 0:c04d932e96c9 645
rgrover1 7:e9800c45e065 646 void uriDataWriteAuthorizationCallback(GattWriteAuthCallbackParams *authParams) {
screamer 0:c04d932e96c9 647 if (lockedState) {
screamer 0:c04d932e96c9 648 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION;
screamer 0:c04d932e96c9 649 } else if (authParams->offset != 0) {
screamer 0:c04d932e96c9 650 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET;
screamer 0:c04d932e96c9 651 } else {
screamer 0:c04d932e96c9 652 authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
screamer 0:c04d932e96c9 653 }
screamer 0:c04d932e96c9 654 }
screamer 0:c04d932e96c9 655
rgrover1 7:e9800c45e065 656 void powerModeAuthorizationCallback(GattWriteAuthCallbackParams *authParams) {
screamer 0:c04d932e96c9 657 if (lockedState) {
screamer 0:c04d932e96c9 658 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION;
screamer 0:c04d932e96c9 659 } else if (authParams->len != sizeof(uint8_t)) {
screamer 0:c04d932e96c9 660 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH;
screamer 0:c04d932e96c9 661 } else if (authParams->offset != 0) {
screamer 0:c04d932e96c9 662 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET;
screamer 0:c04d932e96c9 663 } else if (*((uint8_t *)authParams->data) >= NUM_POWER_MODES) {
screamer 0:c04d932e96c9 664 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_WRITE_NOT_PERMITTED;
screamer 0:c04d932e96c9 665 } else {
screamer 0:c04d932e96c9 666 authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
screamer 0:c04d932e96c9 667 }
screamer 0:c04d932e96c9 668 }
screamer 0:c04d932e96c9 669
screamer 0:c04d932e96c9 670 template <typename T>
rgrover1 7:e9800c45e065 671 void basicAuthorizationCallback(GattWriteAuthCallbackParams *authParams) {
screamer 0:c04d932e96c9 672 if (lockedState) {
screamer 0:c04d932e96c9 673 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INSUF_AUTHORIZATION;
screamer 0:c04d932e96c9 674 } else if (authParams->len != sizeof(T)) {
screamer 0:c04d932e96c9 675 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_ATT_VAL_LENGTH;
screamer 0:c04d932e96c9 676 } else if (authParams->offset != 0) {
screamer 0:c04d932e96c9 677 authParams->authorizationReply = AUTH_CALLBACK_REPLY_ATTERR_INVALID_OFFSET;
screamer 0:c04d932e96c9 678 } else {
screamer 0:c04d932e96c9 679 authParams->authorizationReply = AUTH_CALLBACK_REPLY_SUCCESS;
screamer 0:c04d932e96c9 680 }
screamer 0:c04d932e96c9 681 }
screamer 0:c04d932e96c9 682
mbedAustin 10:b5d19bcf23cf 683 BLEDevice &ble;
mbedAustin 10:b5d19bcf23cf 684 Params_t &params;
mbedAustin 14:5a2a104a21a8 685 Ticker callbackTick;
mbedAustin 16:a7d07ea94b31 686 Ticker timeSinceBootTick;
mbedAustin 16:a7d07ea94b31 687 // Default value that is restored on reset
mbedAustin 10:b5d19bcf23cf 688 size_t defaultUriDataLength;
mbedAustin 10:b5d19bcf23cf 689 UriData_t defaultUriData;
mbedAustin 10:b5d19bcf23cf 690 UIDNamespaceID_t defaultUidNamespaceID;
mbedAustin 10:b5d19bcf23cf 691 UIDInstanceID_t defaultUidInstanceID;
mbedAustin 11:73ea4ef7f5a4 692 int8_t defaultUidPower;
mbedAustin 11:73ea4ef7f5a4 693 int8_t defaultUrlPower;
mbedAustin 10:b5d19bcf23cf 694 uint16_t uidRFU;
mbedAustin 16:a7d07ea94b31 695 // Default value that is restored on reset
mbedAustin 10:b5d19bcf23cf 696 PowerLevels_t &defaultAdvPowerLevels;
mbedAustin 10:b5d19bcf23cf 697 uint8_t lockedState;
mbedAustin 10:b5d19bcf23cf 698 bool initSucceeded;
mbedAustin 10:b5d19bcf23cf 699 uint8_t resetFlag;
mbedAustin 15:af8c24f34a9f 700
mbedAustin 16:a7d07ea94b31 701 // Private Variables for Telemetry Data
mbedAustin 13:91c356fa928e 702 uint8_t TlmVersion;
mbedAustin 13:91c356fa928e 703 volatile uint16_t TlmBatteryVoltage;
mbedAustin 13:91c356fa928e 704 volatile uint16_t TlmBeaconTemp;
mbedAustin 13:91c356fa928e 705 volatile uint32_t TlmPduCount;
mbedAustin 13:91c356fa928e 706 volatile uint32_t TlmTimeSinceBoot;
screamer 0:c04d932e96c9 707
screamer 0:c04d932e96c9 708 ReadOnlyGattCharacteristic<uint8_t> lockedStateChar;
screamer 0:c04d932e96c9 709 WriteOnlyGattCharacteristic<Lock_t> lockChar;
screamer 0:c04d932e96c9 710 GattCharacteristic uriDataChar;
screamer 0:c04d932e96c9 711 WriteOnlyGattCharacteristic<Lock_t> unlockChar;
screamer 0:c04d932e96c9 712 ReadWriteGattCharacteristic<uint8_t> flagsChar;
screamer 0:c04d932e96c9 713 ReadWriteGattCharacteristic<PowerLevels_t> advPowerLevelsChar;
screamer 0:c04d932e96c9 714 ReadWriteGattCharacteristic<uint8_t> txPowerModeChar;
screamer 0:c04d932e96c9 715 ReadWriteGattCharacteristic<uint16_t> beaconPeriodChar;
screamer 0:c04d932e96c9 716 WriteOnlyGattCharacteristic<uint8_t> resetChar;
screamer 0:c04d932e96c9 717
mbedAustin 15:af8c24f34a9f 718 public:
screamer 0:c04d932e96c9 719 /*
screamer 0:c04d932e96c9 720 * Encode a human-readable URI into the binary format defined by URIBeacon spec (https://github.com/google/uribeacon/tree/master/specification).
screamer 0:c04d932e96c9 721 */
screamer 0:c04d932e96c9 722 static void encodeURI(const char *uriDataIn, UriData_t uriDataOut, size_t &sizeofURIDataOut) {
screamer 0:c04d932e96c9 723 const char *prefixes[] = {
screamer 0:c04d932e96c9 724 "http://www.",
screamer 0:c04d932e96c9 725 "https://www.",
screamer 0:c04d932e96c9 726 "http://",
screamer 0:c04d932e96c9 727 "https://",
screamer 0:c04d932e96c9 728 };
screamer 0:c04d932e96c9 729 const size_t NUM_PREFIXES = sizeof(prefixes) / sizeof(char *);
screamer 0:c04d932e96c9 730 const char *suffixes[] = {
screamer 0:c04d932e96c9 731 ".com/",
screamer 0:c04d932e96c9 732 ".org/",
screamer 0:c04d932e96c9 733 ".edu/",
screamer 0:c04d932e96c9 734 ".net/",
screamer 0:c04d932e96c9 735 ".info/",
screamer 0:c04d932e96c9 736 ".biz/",
screamer 0:c04d932e96c9 737 ".gov/",
screamer 0:c04d932e96c9 738 ".com",
screamer 0:c04d932e96c9 739 ".org",
screamer 0:c04d932e96c9 740 ".edu",
screamer 0:c04d932e96c9 741 ".net",
screamer 0:c04d932e96c9 742 ".info",
screamer 0:c04d932e96c9 743 ".biz",
screamer 0:c04d932e96c9 744 ".gov"
screamer 0:c04d932e96c9 745 };
screamer 0:c04d932e96c9 746 const size_t NUM_SUFFIXES = sizeof(suffixes) / sizeof(char *);
screamer 0:c04d932e96c9 747
screamer 0:c04d932e96c9 748 sizeofURIDataOut = 0;
screamer 0:c04d932e96c9 749 memset(uriDataOut, 0, sizeof(UriData_t));
screamer 0:c04d932e96c9 750
screamer 0:c04d932e96c9 751 if ((uriDataIn == NULL) || (strlen(uriDataIn) == 0)) {
screamer 0:c04d932e96c9 752 return;
screamer 0:c04d932e96c9 753 }
screamer 0:c04d932e96c9 754
screamer 0:c04d932e96c9 755 /*
screamer 0:c04d932e96c9 756 * handle prefix
screamer 0:c04d932e96c9 757 */
screamer 0:c04d932e96c9 758 for (unsigned i = 0; i < NUM_PREFIXES; i++) {
screamer 0:c04d932e96c9 759 size_t prefixLen = strlen(prefixes[i]);
screamer 0:c04d932e96c9 760 if (strncmp(uriDataIn, prefixes[i], prefixLen) == 0) {
screamer 0:c04d932e96c9 761 uriDataOut[sizeofURIDataOut++] = i;
screamer 0:c04d932e96c9 762 uriDataIn += prefixLen;
screamer 0:c04d932e96c9 763 break;
screamer 0:c04d932e96c9 764 }
screamer 0:c04d932e96c9 765 }
screamer 0:c04d932e96c9 766
screamer 0:c04d932e96c9 767 /*
screamer 0:c04d932e96c9 768 * handle suffixes
screamer 0:c04d932e96c9 769 */
screamer 0:c04d932e96c9 770 while (*uriDataIn && (sizeofURIDataOut < URI_DATA_MAX)) {
screamer 0:c04d932e96c9 771 /* check for suffix match */
screamer 0:c04d932e96c9 772 unsigned i;
screamer 0:c04d932e96c9 773 for (i = 0; i < NUM_SUFFIXES; i++) {
screamer 0:c04d932e96c9 774 size_t suffixLen = strlen(suffixes[i]);
screamer 0:c04d932e96c9 775 if (strncmp(uriDataIn, suffixes[i], suffixLen) == 0) {
screamer 0:c04d932e96c9 776 uriDataOut[sizeofURIDataOut++] = i;
screamer 0:c04d932e96c9 777 uriDataIn += suffixLen;
screamer 0:c04d932e96c9 778 break; /* from the for loop for checking against suffixes */
screamer 0:c04d932e96c9 779 }
screamer 0:c04d932e96c9 780 }
screamer 0:c04d932e96c9 781 /* This is the default case where we've got an ordinary character which doesn't match a suffix. */
screamer 0:c04d932e96c9 782 if (i == NUM_SUFFIXES) {
screamer 0:c04d932e96c9 783 uriDataOut[sizeofURIDataOut++] = *uriDataIn;
screamer 0:c04d932e96c9 784 ++uriDataIn;
screamer 0:c04d932e96c9 785 }
screamer 0:c04d932e96c9 786 }
screamer 0:c04d932e96c9 787 }
screamer 0:c04d932e96c9 788 };
screamer 0:c04d932e96c9 789
screamer 0:c04d932e96c9 790 #endif // SERVICES_ZIPBEACONCONFIGSERVICE_H_