Yihui Xiong / mbed-src-nrf51822

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Grove_Node Potentiometer BLE_Beacon I2C_Scanner

api/DigitalIn.h@0:700cadd8b708, 2014-11-04 (annotated)

Committer:
yihui
Date:
Tue Nov 04 07:38:53 2014 +0000
Revision:
0:700cadd8b708
customized mbed-src library for nrf51822

Who changed what in which revision?

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