伊生希 小林 / Mbed 2 deprecated cansat_main_copy

temp

Dependencies:   mbed SDFileSystem MS5607 ADXL345_I2C FATFileSystem

mbed/drivers/AnalogIn.h@0:c88c3b616c00, 2020-03-16 (annotated)

Committer:
IKobayashi
Date:
Mon Mar 16 23:37:42 2020 +0900
Revision:
0:c88c3b616c00
copy

Who changed what in which revision?

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