DSP Book Yeditepe / mbed_f401re

mbed library sources with internal temperature sensor for nucleo f401

api/DigitalIn.h@0:7e2bd16f80af, 2015-01-17 (annotated)

Committer:
elessair
Date:
Sat Jan 17 18:03:58 2015 +0000
Revision:
0:7e2bd16f80af
nucleo f401re internal temperature added

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:7e2bd16f80af 1 /* mbed Microcontroller Library
elessair 0:7e2bd16f80af 2 * Copyright (c) 2006-2013 ARM Limited
elessair 0:7e2bd16f80af 3 *
elessair 0:7e2bd16f80af 4 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:7e2bd16f80af 5 * you may not use this file except in compliance with the License.
elessair 0:7e2bd16f80af 6 * You may obtain a copy of the License at
elessair 0:7e2bd16f80af 7 *
elessair 0:7e2bd16f80af 8 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:7e2bd16f80af 9 *
elessair 0:7e2bd16f80af 10 * Unless required by applicable law or agreed to in writing, software
elessair 0:7e2bd16f80af 11 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:7e2bd16f80af 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:7e2bd16f80af 13 * See the License for the specific language governing permissions and
elessair 0:7e2bd16f80af 14 * limitations under the License.
elessair 0:7e2bd16f80af 15 */
elessair 0:7e2bd16f80af 16 #ifndef MBED_DIGITALIN_H
elessair 0:7e2bd16f80af 17 #define MBED_DIGITALIN_H
elessair 0:7e2bd16f80af 18
elessair 0:7e2bd16f80af 19 #include "platform.h"
elessair 0:7e2bd16f80af 20
elessair 0:7e2bd16f80af 21 #include "gpio_api.h"
elessair 0:7e2bd16f80af 22
elessair 0:7e2bd16f80af 23 namespace mbed {
elessair 0:7e2bd16f80af 24
elessair 0:7e2bd16f80af 25 /** A digital input, used for reading the state of a pin
elessair 0:7e2bd16f80af 26 *
elessair 0:7e2bd16f80af 27 * Example:
elessair 0:7e2bd16f80af 28 * @code
elessair 0:7e2bd16f80af 29 * // Flash an LED while a DigitalIn is true
elessair 0:7e2bd16f80af 30 *
elessair 0:7e2bd16f80af 31 * #include "mbed.h"
elessair 0:7e2bd16f80af 32 *
elessair 0:7e2bd16f80af 33 * DigitalIn enable(p5);
elessair 0:7e2bd16f80af 34 * DigitalOut led(LED1);
elessair 0:7e2bd16f80af 35 *
elessair 0:7e2bd16f80af 36 * int main() {
elessair 0:7e2bd16f80af 37 * while(1) {
elessair 0:7e2bd16f80af 38 * if(enable) {
elessair 0:7e2bd16f80af 39 * led = !led;
elessair 0:7e2bd16f80af 40 * }
elessair 0:7e2bd16f80af 41 * wait(0.25);
elessair 0:7e2bd16f80af 42 * }
elessair 0:7e2bd16f80af 43 * }
elessair 0:7e2bd16f80af 44 * @endcode
elessair 0:7e2bd16f80af 45 */
elessair 0:7e2bd16f80af 46 class DigitalIn {
elessair 0:7e2bd16f80af 47
elessair 0:7e2bd16f80af 48 public:
elessair 0:7e2bd16f80af 49 /** Create a DigitalIn connected to the specified pin
elessair 0:7e2bd16f80af 50 *
elessair 0:7e2bd16f80af 51 * @param pin DigitalIn pin to connect to
elessair 0:7e2bd16f80af 52 */
elessair 0:7e2bd16f80af 53 DigitalIn(PinName pin) : gpio() {
elessair 0:7e2bd16f80af 54 gpio_init_in(&gpio, pin);
elessair 0:7e2bd16f80af 55 }
elessair 0:7e2bd16f80af 56
elessair 0:7e2bd16f80af 57 /** Create a DigitalIn connected to the specified pin
elessair 0:7e2bd16f80af 58 *
elessair 0:7e2bd16f80af 59 * @param pin DigitalIn pin to connect to
elessair 0:7e2bd16f80af 60 * @param mode the initial mode of the pin
elessair 0:7e2bd16f80af 61 */
elessair 0:7e2bd16f80af 62 DigitalIn(PinName pin, PinMode mode) : gpio() {
elessair 0:7e2bd16f80af 63 gpio_init_in_ex(&gpio, pin, mode);
elessair 0:7e2bd16f80af 64 }
elessair 0:7e2bd16f80af 65 /** Read the input, represented as 0 or 1 (int)
elessair 0:7e2bd16f80af 66 *
elessair 0:7e2bd16f80af 67 * @returns
elessair 0:7e2bd16f80af 68 * An integer representing the state of the input pin,
elessair 0:7e2bd16f80af 69 * 0 for logical 0, 1 for logical 1
elessair 0:7e2bd16f80af 70 */
elessair 0:7e2bd16f80af 71 int read() {
elessair 0:7e2bd16f80af 72 return gpio_read(&gpio);
elessair 0:7e2bd16f80af 73 }
elessair 0:7e2bd16f80af 74
elessair 0:7e2bd16f80af 75 /** Set the input pin mode
elessair 0:7e2bd16f80af 76 *
elessair 0:7e2bd16f80af 77 * @param mode PullUp, PullDown, PullNone, OpenDrain
elessair 0:7e2bd16f80af 78 */
elessair 0:7e2bd16f80af 79 void mode(PinMode pull) {
elessair 0:7e2bd16f80af 80 gpio_mode(&gpio, pull);
elessair 0:7e2bd16f80af 81 }
elessair 0:7e2bd16f80af 82
elessair 0:7e2bd16f80af 83 #ifdef MBED_OPERATORS
elessair 0:7e2bd16f80af 84 /** An operator shorthand for read()
elessair 0:7e2bd16f80af 85 */
elessair 0:7e2bd16f80af 86 operator int() {
elessair 0:7e2bd16f80af 87 return read();
elessair 0:7e2bd16f80af 88 }
elessair 0:7e2bd16f80af 89 #endif
elessair 0:7e2bd16f80af 90
elessair 0:7e2bd16f80af 91 protected:
elessair 0:7e2bd16f80af 92 gpio_t gpio;
elessair 0:7e2bd16f80af 93 };
elessair 0:7e2bd16f80af 94
elessair 0:7e2bd16f80af 95 } // namespace mbed
elessair 0:7e2bd16f80af 96
elessair 0:7e2bd16f80af 97 #endif