Vipin Ranka / MGAS_GR_Peach

This is the final version of Mini Gateway for Automation and Security desgined for Renesas GR Peach Design Contest

Dependencies:   GR-PEACH_video GraphicsFramework HTTPServer R_BSP mbed-rpc mbed-rtos Socket lwip-eth lwip-sys lwip FATFileSystem

Fork of mbed-os-example-mbed5-blinky by mbed-os-examples

mbed-dev/drivers/AnalogIn.h@12:9a20164dcc47, 2017-01-11 (annotated)

Committer:
vipinranka
Date:
Wed Jan 11 11:41:30 2017 +0000
Revision:
12:9a20164dcc47
This is the final version MGAS Project for Renesas GR Peach Design Contest

Who changed what in which revision?

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