MacroRat / MouseCode

Mouse code for the MacroRat

Dependencies:   ITG3200 QEI

mbed-dev/drivers/DigitalIn.h@46:b156ef445742, 2017-06-03 (annotated)

Committer:
sahilmgandhi
Date:
Sat Jun 03 00:22:44 2017 +0000
Revision:
46:b156ef445742
Parent:
18:6a4db94011d3 
Final code for internal battlebot competition.

Who changed what in which revision?

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