Shruti Rawool / pir-motion-sensor

PIR grove sensor that sends the sensed data to Thingspeak.com through the wifi module ESP 8266

Dependencies:   mbed

esp_attemp3/mbed/drivers/DigitalIn.h@0:3954a906acc2, 2016-12-05 (annotated)

Committer:
skrawool
Date:
Mon Dec 05 16:39:27 2016 +0000
Revision:
0:3954a906acc2
PIR grove sensor that sends the sensed data to thingspeak through the wifi module ESP 8266

Who changed what in which revision?

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