spinal cord / PokittoLib

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

Dependents:   Sensitive

Fork of PokittoLib by Jonne Valola

mbed-pokitto/api/DigitalIn.h@6:ea7377f3d1af, 2017-10-11 (annotated)

Committer:
Pokitto
Date:
Wed Oct 11 20:35:27 2017 +0000
Revision:
6:ea7377f3d1af
Fixed PokittoLib. Includes a working custom mbed-src

Who changed what in which revision?

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