Maxim Integrated / Mbed 2 deprecated MAXWSNENV_demo Featured

BTLE demo for MAXWSNENV.

Dependencies:   BLE_API BMP180 Si7020 mbed MaximBLE

ReferenceTimeInfoChar.h@2:6f76d6160601, 2016-08-18 (annotated)

Committer:
enginerd
Date:
Thu Aug 18 21:09:13 2016 +0000
Revision:
2:6f76d6160601
Parent:
0:f71931ae3db1 
Updated library versions.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kgills 0:f71931ae3db1 1 /*******************************************************************************
kgills 0:f71931ae3db1 2 * Copyright (C) 2015 Maxim Integrated Products, Inc., All Rights Reserved.
kgills 0:f71931ae3db1 3 *
kgills 0:f71931ae3db1 4 * Permission is hereby granted, free of charge, to any person obtaining a
kgills 0:f71931ae3db1 5 * copy of this software and associated documentation files (the "Software"),
kgills 0:f71931ae3db1 6 * to deal in the Software without restriction, including without limitation
kgills 0:f71931ae3db1 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
kgills 0:f71931ae3db1 8 * and/or sell copies of the Software, and to permit persons to whom the
kgills 0:f71931ae3db1 9 * Software is furnished to do so, subject to the following conditions:
kgills 0:f71931ae3db1 10 *
kgills 0:f71931ae3db1 11 * The above copyright notice and this permission notice shall be included
kgills 0:f71931ae3db1 12 * in all copies or substantial portions of the Software.
kgills 0:f71931ae3db1 13 *
kgills 0:f71931ae3db1 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
kgills 0:f71931ae3db1 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
kgills 0:f71931ae3db1 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
kgills 0:f71931ae3db1 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
kgills 0:f71931ae3db1 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
kgills 0:f71931ae3db1 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
kgills 0:f71931ae3db1 20 * OTHER DEALINGS IN THE SOFTWARE.
kgills 0:f71931ae3db1 21 *
kgills 0:f71931ae3db1 22 * Except as contained in this notice, the name of Maxim Integrated
kgills 0:f71931ae3db1 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
kgills 0:f71931ae3db1 24 * Products, Inc. Branding Policy.
kgills 0:f71931ae3db1 25 *
kgills 0:f71931ae3db1 26 * The mere transfer of this software does not imply any licenses
kgills 0:f71931ae3db1 27 * of trade secrets, proprietary technology, copyrights, patents,
kgills 0:f71931ae3db1 28 * trademarks, maskwork rights, or any other form of intellectual
kgills 0:f71931ae3db1 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
kgills 0:f71931ae3db1 30 * ownership rights.
kgills 0:f71931ae3db1 31 *******************************************************************************
kgills 0:f71931ae3db1 32 */
kgills 0:f71931ae3db1 33
kgills 0:f71931ae3db1 34 #ifndef __BLE_REFERENCETIMEINFOCHAR_H__
kgills 0:f71931ae3db1 35 #define __BLE_REFERENCETIMEINFOCHAR_H__
kgills 0:f71931ae3db1 36
kgills 0:f71931ae3db1 37 #include "mbed.h"
kgills 0:f71931ae3db1 38 #include "Characteristic.h"
kgills 0:f71931ae3db1 39
kgills 0:f71931ae3db1 40 /**
kgills 0:f71931ae3db1 41 * @class ReferenceTimeInfoChar
kgills 0:f71931ae3db1 42 * @brief ReferenceTimeInfoChar characteristic class.
kgills 0:f71931ae3db1 43 * @details Sub class from the characteristic class.
kgills 0:f71931ae3db1 44 */
kgills 0:f71931ae3db1 45
kgills 0:f71931ae3db1 46 class ReferenceTimeInfoChar : public Characteristic
kgills 0:f71931ae3db1 47 {
kgills 0:f71931ae3db1 48 public:
kgills 0:f71931ae3db1 49
kgills 0:f71931ae3db1 50 typedef enum {
kgills 0:f71931ae3db1 51 unknown = 0,
kgills 0:f71931ae3db1 52 network_time,
kgills 0:f71931ae3db1 53 gps,
kgills 0:f71931ae3db1 54 radio_time,
kgills 0:f71931ae3db1 55 manual,
kgills 0:f71931ae3db1 56 atomic_clock,
kgills 0:f71931ae3db1 57 cellular_network
kgills 0:f71931ae3db1 58 } source_t;
kgills 0:f71931ae3db1 59
kgills 0:f71931ae3db1 60 static const unsigned OFFSET_OF_SOURCE = 0;
kgills 0:f71931ae3db1 61 static const unsigned OFFSET_OF_ACCURACY = OFFSET_OF_SOURCE + 1;
kgills 0:f71931ae3db1 62 static const unsigned OFFSET_OF_DAYS = OFFSET_OF_ACCURACY + 1;
kgills 0:f71931ae3db1 63 static const unsigned OFFSET_OF_HOURS = OFFSET_OF_DAYS + 1;
kgills 0:f71931ae3db1 64
kgills 0:f71931ae3db1 65 static const unsigned CHAR_BYTES = OFFSET_OF_HOURS + 1;
kgills 0:f71931ae3db1 66
kgills 0:f71931ae3db1 67 static const unsigned ACCURACY_OUT_OF_RANGE = 254;
kgills 0:f71931ae3db1 68 static const unsigned ACCURACY_UNKNOWN = 255;
kgills 0:f71931ae3db1 69
kgills 0:f71931ae3db1 70 ReferenceTimeInfoChar() :
kgills 0:f71931ae3db1 71 gattChar(GattCharacteristic::UUID_REFERENCE_TIME_INFORMATION_CHAR, bytes,
kgills 0:f71931ae3db1 72 CHAR_BYTES, CHAR_BYTES,
kgills 0:f71931ae3db1 73 GattCharacteristic::BLE_GATT_CHAR_PROPERTIES_READ)
kgills 0:f71931ae3db1 74 {
kgills 0:f71931ae3db1 75 memset(bytes, 0x0, CHAR_BYTES);
kgills 0:f71931ae3db1 76 bytes[OFFSET_OF_ACCURACY] = ACCURACY_UNKNOWN;
kgills 0:f71931ae3db1 77 last_update = time(NULL);
kgills 0:f71931ae3db1 78 }
kgills 0:f71931ae3db1 79
kgills 0:f71931ae3db1 80 ~ReferenceTimeInfoChar() {}
kgills 0:f71931ae3db1 81
kgills 0:f71931ae3db1 82 virtual GattCharacteristic *getChar(void)
kgills 0:f71931ae3db1 83 {
kgills 0:f71931ae3db1 84 return &gattChar;
kgills 0:f71931ae3db1 85 }
kgills 0:f71931ae3db1 86
kgills 0:f71931ae3db1 87 virtual uint8_t getNumBytes(void)
kgills 0:f71931ae3db1 88 {
kgills 0:f71931ae3db1 89 return CHAR_BYTES;
kgills 0:f71931ae3db1 90 }
kgills 0:f71931ae3db1 91
kgills 0:f71931ae3db1 92 virtual uint8_t *getBytes(void)
kgills 0:f71931ae3db1 93 {
kgills 0:f71931ae3db1 94 return bytes;
kgills 0:f71931ae3db1 95 }
kgills 0:f71931ae3db1 96
kgills 0:f71931ae3db1 97 // Update the characteristic value for reference source
kgills 0:f71931ae3db1 98 void updateSource(source_t source)
kgills 0:f71931ae3db1 99 {
kgills 0:f71931ae3db1 100 bytes[OFFSET_OF_SOURCE] = source;
kgills 0:f71931ae3db1 101 }
kgills 0:f71931ae3db1 102
kgills 0:f71931ae3db1 103 // Update the characteristic value for time accuracy
kgills 0:f71931ae3db1 104 void updateAccuracy(uint8_t accuracy)
kgills 0:f71931ae3db1 105 {
kgills 0:f71931ae3db1 106 bytes[OFFSET_OF_ACCURACY] = accuracy;
kgills 0:f71931ae3db1 107 }
kgills 0:f71931ae3db1 108
kgills 0:f71931ae3db1 109 // Update the characteristic value for time zone
kgills 0:f71931ae3db1 110 void updateUpdateTime()
kgills 0:f71931ae3db1 111 {
kgills 0:f71931ae3db1 112 // Calculate how many hours since last update
kgills 0:f71931ae3db1 113 uint32_t hours = (time(NULL)-last_update)/360;
kgills 0:f71931ae3db1 114
kgills 0:f71931ae3db1 115 // Days is zero
kgills 0:f71931ae3db1 116 if(hours < 24) {
kgills 0:f71931ae3db1 117 bytes[OFFSET_OF_HOURS] = hours;
kgills 0:f71931ae3db1 118 bytes[OFFSET_OF_DAYS] = 0;
kgills 0:f71931ae3db1 119 return;
kgills 0:f71931ae3db1 120 }
kgills 0:f71931ae3db1 121
kgills 0:f71931ae3db1 122 uint16_t days = hours/24;
kgills 0:f71931ae3db1 123
kgills 0:f71931ae3db1 124 // Days overflow
kgills 0:f71931ae3db1 125 if(days > 255) {
kgills 0:f71931ae3db1 126 bytes[OFFSET_OF_DAYS] = 255;
kgills 0:f71931ae3db1 127 bytes[OFFSET_OF_HOURS] = 255;
kgills 0:f71931ae3db1 128 return;
kgills 0:f71931ae3db1 129 }
kgills 0:f71931ae3db1 130
kgills 0:f71931ae3db1 131 // Days and hours since update
kgills 0:f71931ae3db1 132 hours -= (days*24);
kgills 0:f71931ae3db1 133 bytes[OFFSET_OF_DAYS] = days;
kgills 0:f71931ae3db1 134 bytes[OFFSET_OF_HOURS] = hours;
kgills 0:f71931ae3db1 135 }
kgills 0:f71931ae3db1 136
kgills 0:f71931ae3db1 137 void resetUpdateTime()
kgills 0:f71931ae3db1 138 {
kgills 0:f71931ae3db1 139 last_update = time(NULL);
kgills 0:f71931ae3db1 140 bytes[OFFSET_OF_DAYS] = 0;
kgills 0:f71931ae3db1 141 bytes[OFFSET_OF_HOURS] = 0;
kgills 0:f71931ae3db1 142 }
kgills 0:f71931ae3db1 143
kgills 0:f71931ae3db1 144 private:
kgills 0:f71931ae3db1 145 GattCharacteristic gattChar;
kgills 0:f71931ae3db1 146 uint8_t bytes[CHAR_BYTES];
kgills 0:f71931ae3db1 147 time_t last_update;
kgills 0:f71931ae3db1 148 };
kgills 0:f71931ae3db1 149
kgills 0:f71931ae3db1 150 #endif /* #ifndef __BLE_REFERENCETIMEINFOCHAR_H__*/