Mark Turner / Mbed 2 deprecated lightsense_kl46z_basic_v1

Basic fading in and out of leds with light sensor.

Dependencies:   mbed

mbed/AnalogIn.h@0:cf7af2656659, 2016-09-19 (annotated)

Committer:
mturner5
Date:
Mon Sep 19 03:24:58 2016 +0000
Revision:
0:cf7af2656659
Basic v1

Who changed what in which revision?

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