Pokitto Community Team / Pokitto_

PokittoLib with changes to lcd refresh etc.

Dependents:   Pokittris

Fork of Pokitto by Pokitto Community Team

This is a fork by user @Spinal, and is used in Pokittris for testing. Do not import this to your own program.

mbed-pokitto/api/DigitalIn.h@11:02ad9c807a21, 2017-10-15 (annotated)

Committer:
spinal
Date:
Sun Oct 15 18:03:02 2017 +0000
Revision:
11:02ad9c807a21
Parent:
5:7e5c566b1760 
fixed 4color refreshRegion code

Who changed what in which revision?

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