George Roussos / BLE_Temperature_Exercise

BLE Temperature Service Mobile and Ubiquitous Computing Module Birkbeck College

Dependencies:   DS1820

mbed/DigitalIn.h@0:dd0fea342ad2, 2015-03-08 (annotated)

Committer:
gkroussos
Date:
Sun Mar 08 19:42:20 2015 +0000
Revision:
0:dd0fea342ad2
BLE Temperature Service ; Mobile and Ubiquitous Computing Module; Birkbeck College

Who changed what in which revision?

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