Emilio Monti / mbed-KL25Z

mbed libraries for KL25Z

Dependents:   FRDM_RGBLED

DigitalIn.h@9:663789d7729f, 2013-02-18 (annotated)

Committer:
emilmont
Date:
Mon Feb 18 09:41:56 2013 +0000
Revision:
9:663789d7729f
Parent:
8:c14af7958ef5 
Update mbed-KL25Z to latest build

Who changed what in which revision?

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