Milen Pavlov / XRange_mbed_src

Mbed SDK for XRange SX1272 LoRa module

Dependents:   XRangePingPong XRange-LoRaWAN-lmic-app lora-transceiver

SX1272 LoRa RF module

https://www.netblocks.eu/xrange-sx1272-lora-datasheet/

api/AnalogIn.h@336:1e18a06a987b, 2015-01-15 (annotated)

Committer:
dudmuck
Date:
Thu Jan 15 02:25:40 2015 +0000
Revision:
336:1e18a06a987b
updated to rev443 of official mbed-src

Who changed what in which revision?

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