Pokitto Community Team / Pokitto_

PokittoLib with changes to lcd refresh etc.

Dependents:   Pokittris

Fork of Pokitto by Pokitto Community Team

This is a fork by user @Spinal, and is used in Pokittris for testing. Do not import this to your own program.

mbed-pokitto/api/AnalogIn.h@11:02ad9c807a21, 2017-10-15 (annotated)

Committer:
spinal
Date:
Sun Oct 15 18:03:02 2017 +0000
Revision:
11:02ad9c807a21
Parent:
5:7e5c566b1760 
fixed 4color refreshRegion code

Who changed what in which revision?

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