George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/AnalogIn.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

UserRevisionLine numberNew contents of line
gkroussos 0:dd0fea342ad2 1 /* mbed Microcontroller Library
gkroussos 0:dd0fea342ad2 2 * Copyright (c) 2006-2013 ARM Limited
gkroussos 0:dd0fea342ad2 3 *
gkroussos 0:dd0fea342ad2 4 * Licensed under the Apache License, Version 2.0 (the "License");
gkroussos 0:dd0fea342ad2 5 * you may not use this file except in compliance with the License.
gkroussos 0:dd0fea342ad2 6 * You may obtain a copy of the License at
gkroussos 0:dd0fea342ad2 7 *
gkroussos 0:dd0fea342ad2 8 * http://www.apache.org/licenses/LICENSE-2.0
gkroussos 0:dd0fea342ad2 9 *
gkroussos 0:dd0fea342ad2 10 * Unless required by applicable law or agreed to in writing, software
gkroussos 0:dd0fea342ad2 11 * distributed under the License is distributed on an "AS IS" BASIS,
gkroussos 0:dd0fea342ad2 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
gkroussos 0:dd0fea342ad2 13 * See the License for the specific language governing permissions and
gkroussos 0:dd0fea342ad2 14 * limitations under the License.
gkroussos 0:dd0fea342ad2 15 */
gkroussos 0:dd0fea342ad2 16 #ifndef MBED_ANALOGIN_H
gkroussos 0:dd0fea342ad2 17 #define MBED_ANALOGIN_H
gkroussos 0:dd0fea342ad2 18
gkroussos 0:dd0fea342ad2 19 #include "platform.h"
gkroussos 0:dd0fea342ad2 20
gkroussos 0:dd0fea342ad2 21 #if DEVICE_ANALOGIN
gkroussos 0:dd0fea342ad2 22
gkroussos 0:dd0fea342ad2 23 #include "analogin_api.h"
gkroussos 0:dd0fea342ad2 24
gkroussos 0:dd0fea342ad2 25 namespace mbed {
gkroussos 0:dd0fea342ad2 26
gkroussos 0:dd0fea342ad2 27 /** An analog input, used for reading the voltage on a pin
gkroussos 0:dd0fea342ad2 28 *
gkroussos 0:dd0fea342ad2 29 * Example:
gkroussos 0:dd0fea342ad2 30 * @code
gkroussos 0:dd0fea342ad2 31 * // Print messages when the AnalogIn is greater than 50%
gkroussos 0:dd0fea342ad2 32 *
gkroussos 0:dd0fea342ad2 33 * #include "mbed.h"
gkroussos 0:dd0fea342ad2 34 *
gkroussos 0:dd0fea342ad2 35 * AnalogIn temperature(p20);
gkroussos 0:dd0fea342ad2 36 *
gkroussos 0:dd0fea342ad2 37 * int main() {
gkroussos 0:dd0fea342ad2 38 * while(1) {
gkroussos 0:dd0fea342ad2 39 * if(temperature > 0.5) {
gkroussos 0:dd0fea342ad2 40 * printf("Too hot! (%f)", temperature.read());
gkroussos 0:dd0fea342ad2 41 * }
gkroussos 0:dd0fea342ad2 42 * }
gkroussos 0:dd0fea342ad2 43 * }
gkroussos 0:dd0fea342ad2 44 * @endcode
gkroussos 0:dd0fea342ad2 45 */
gkroussos 0:dd0fea342ad2 46 class AnalogIn {
gkroussos 0:dd0fea342ad2 47
gkroussos 0:dd0fea342ad2 48 public:
gkroussos 0:dd0fea342ad2 49
gkroussos 0:dd0fea342ad2 50 /** Create an AnalogIn, connected to the specified pin
gkroussos 0:dd0fea342ad2 51 *
gkroussos 0:dd0fea342ad2 52 * @param pin AnalogIn pin to connect to
gkroussos 0:dd0fea342ad2 53 * @param name (optional) A string to identify the object
gkroussos 0:dd0fea342ad2 54 */
gkroussos 0:dd0fea342ad2 55 AnalogIn(PinName pin) {
gkroussos 0:dd0fea342ad2 56 analogin_init(&_adc, pin);
gkroussos 0:dd0fea342ad2 57 }
gkroussos 0:dd0fea342ad2 58
gkroussos 0:dd0fea342ad2 59 /** Read the input voltage, represented as a float in the range [0.0, 1.0]
gkroussos 0:dd0fea342ad2 60 *
gkroussos 0:dd0fea342ad2 61 * @returns A floating-point value representing the current input voltage, measured as a percentage
gkroussos 0:dd0fea342ad2 62 */
gkroussos 0:dd0fea342ad2 63 float read() {
gkroussos 0:dd0fea342ad2 64 return analogin_read(&_adc);
gkroussos 0:dd0fea342ad2 65 }
gkroussos 0:dd0fea342ad2 66
gkroussos 0:dd0fea342ad2 67 /** Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]
gkroussos 0:dd0fea342ad2 68 *
gkroussos 0:dd0fea342ad2 69 * @returns
gkroussos 0:dd0fea342ad2 70 * 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value
gkroussos 0:dd0fea342ad2 71 */
gkroussos 0:dd0fea342ad2 72 unsigned short read_u16() {
gkroussos 0:dd0fea342ad2 73 return analogin_read_u16(&_adc);
gkroussos 0:dd0fea342ad2 74 }
gkroussos 0:dd0fea342ad2 75
gkroussos 0:dd0fea342ad2 76 #ifdef MBED_OPERATORS
gkroussos 0:dd0fea342ad2 77 /** An operator shorthand for read()
gkroussos 0:dd0fea342ad2 78 *
gkroussos 0:dd0fea342ad2 79 * The float() operator can be used as a shorthand for read() to simplify common code sequences
gkroussos 0:dd0fea342ad2 80 *
gkroussos 0:dd0fea342ad2 81 * Example:
gkroussos 0:dd0fea342ad2 82 * @code
gkroussos 0:dd0fea342ad2 83 * float x = volume.read();
gkroussos 0:dd0fea342ad2 84 * float x = volume;
gkroussos 0:dd0fea342ad2 85 *
gkroussos 0:dd0fea342ad2 86 * if(volume.read() > 0.25) { ... }
gkroussos 0:dd0fea342ad2 87 * if(volume > 0.25) { ... }
gkroussos 0:dd0fea342ad2 88 * @endcode
gkroussos 0:dd0fea342ad2 89 */
gkroussos 0:dd0fea342ad2 90 operator float() {
gkroussos 0:dd0fea342ad2 91 return read();
gkroussos 0:dd0fea342ad2 92 }
gkroussos 0:dd0fea342ad2 93 #endif
gkroussos 0:dd0fea342ad2 94
gkroussos 0:dd0fea342ad2 95 protected:
gkroussos 0:dd0fea342ad2 96 analogin_t _adc;
gkroussos 0:dd0fea342ad2 97 };
gkroussos 0:dd0fea342ad2 98
gkroussos 0:dd0fea342ad2 99 } // namespace mbed
gkroussos 0:dd0fea342ad2 100
gkroussos 0:dd0fea342ad2 101 #endif
gkroussos 0:dd0fea342ad2 102
gkroussos 0:dd0fea342ad2 103 #endif