George Roussos / BLE_iBeacon_Exercise

Birkbeck College Mobile and Ubiquitous Computing IoT Lab Exercise 2

Dependencies:   BLE_API_Native_blog

mbed/DigitalOut.h@0:e8fdba0ed044, 2015-03-07 (annotated)

Committer:
gkroussos
Date:
Sat Mar 07 16:34:53 2015 +0000
Revision:
0:e8fdba0ed044
MUC IoT Workshop v1.0

Who changed what in which revision?

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