PES4 / Mbed OS Queue_02

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.

mbed-os/drivers/DigitalIn.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

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