Emir Sokic / mbedPAI Featured

mbed.h verzija za koristenje na predmetu PAI

DigitalOut.h@0:05aad811ea07, 2015-03-10 (annotated)

Committer:
esokic
Date:
Tue Mar 10 09:51:52 2015 +0000
Revision:
0:05aad811ea07
mbed.h verzija od marta 2014, za koristenje na predmetu PAI

Who changed what in which revision?

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