Home | History | Annotate | Download | only in grove
      1 /*
      2  * Place-holder Header for Documentation and future API change
      3  *
      4  * Copyright (c) 2014 Intel Corporation.
      5  *
      6  * Permission is hereby granted, free of charge, to any person obtaining
      7  * a copy of this software and associated documentation files (the
      8  * "Software"), to deal in the Software without restriction, including
      9  * without limitation the rights to use, copy, modify, merge, publish,
     10  * distribute, sublicense, and/or sell copies of the Software, and to
     11  * permit persons to whom the Software is furnished to do so, subject to
     12  * the following conditions:
     13  *
     14  * The above copyright notice and this permission notice shall be
     15  * included in all copies or substantial portions of the Software.
     16  *
     17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
     18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
     19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
     20  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
     21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
     22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
     23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
     24  */
     25 
     26 /**
     27  * @library grove
     28  * @sensor groveled
     29  * @comname Grove LED
     30  * @type led
     31  * @man seeed
     32  * @con gpio
     33  * @kit gsk
     34  *
     35  * @brief API for the Grove LED
     36  *
     37  * UPM module for the Grove LED (or other similar light-emitting diodes).
     38  * An LED is a small lightbulb that emits light in
     39  * response to a small current. The longer wire of an LED connects
     40  * to the positive seat (anode); the shorter wire connects to the
     41  * negative seat (cathode). The flat side of the bulb corresponds
     42  * to the cathode, while the rounded side corresponds to the anode.
     43  *
     44  * @image html groveled.jpg
     45  * @snippet groveled.cxx Interesting
     46  * @snippet groveled-multi.cxx Interesting
     47  */
     48 
     49