ID12RFID with interrupts

Fork of ID12RFID by Simon Ford

Committer:
simon
Date:
Thu Jun 03 13:24:04 2010 +0000
Revision:
0:049d572aefe1
Child:
1:f04afa911cf5

        

Who changed what in which revision?

UserRevisionLine numberNew contents of line
simon 0:049d572aefe1 1 /* mbed ID12 RFID Library
simon 0:049d572aefe1 2 * Copyright (c) 2007-2010, sford
simon 0:049d572aefe1 3 *
simon 0:049d572aefe1 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
simon 0:049d572aefe1 5 * of this software and associated documentation files (the "Software"), to deal
simon 0:049d572aefe1 6 * in the Software without restriction, including without limitation the rights
simon 0:049d572aefe1 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
simon 0:049d572aefe1 8 * copies of the Software, and to permit persons to whom the Software is
simon 0:049d572aefe1 9 * furnished to do so, subject to the following conditions:
simon 0:049d572aefe1 10 *
simon 0:049d572aefe1 11 * The above copyright notice and this permission notice shall be included in
simon 0:049d572aefe1 12 * all copies or substantial portions of the Software.
simon 0:049d572aefe1 13 *
simon 0:049d572aefe1 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
simon 0:049d572aefe1 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
simon 0:049d572aefe1 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
simon 0:049d572aefe1 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
simon 0:049d572aefe1 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
simon 0:049d572aefe1 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
simon 0:049d572aefe1 20 * THE SOFTWARE.
simon 0:049d572aefe1 21 */
simon 0:049d572aefe1 22
simon 0:049d572aefe1 23 #ifndef MBED_ID12RFID_H
simon 0:049d572aefe1 24 #define MBED_ID12RFID_H
simon 0:049d572aefe1 25
simon 0:049d572aefe1 26 #include "mbed.h"
simon 0:049d572aefe1 27
simon 0:049d572aefe1 28 /** An interface for the ID-12 RFID reader device
simon 0:049d572aefe1 29 *
simon 0:049d572aefe1 30 * @code
simon 0:049d572aefe1 31 * // Print RFID tag numbers
simon 0:049d572aefe1 32 *
simon 0:049d572aefe1 33 * #include "mbed.h"
simon 0:049d572aefe1 34 * #include "ID12RFID.h"
simon 0:049d572aefe1 35 *
simon 0:049d572aefe1 36 * ID12RFID rfid(p10); // serial rx
simon 0:049d572aefe1 37 *
simon 0:049d572aefe1 38 * int main() {
simon 0:049d572aefe1 39 * while(1) {
simon 0:049d572aefe1 40 * if(rfid.readable()) {
simon 0:049d572aefe1 41 * printf("RFID Tag number : %d\n", rfid.read());
simon 0:049d572aefe1 42 * }
simon 0:049d572aefe1 43 * }
simon 0:049d572aefe1 44 * }
simon 0:049d572aefe1 45 * @endcode
simon 0:049d572aefe1 46 */
simon 0:049d572aefe1 47 class ID12RFID {
simon 0:049d572aefe1 48
simon 0:049d572aefe1 49 public:
simon 0:049d572aefe1 50 /** Create an ID12 RFID interface, connected to the specified Serial rx port
simon 0:049d572aefe1 51 *
simon 0:049d572aefe1 52 * @param rx Recieve pin
simon 0:049d572aefe1 53 */
simon 0:049d572aefe1 54 ID12RFID(PinName rx);
simon 0:049d572aefe1 55
simon 0:049d572aefe1 56 /** Non blocking function to determine if an ID has been received
simon 0:049d572aefe1 57 *
simon 0:049d572aefe1 58 * @return Non zero value when the device is readable
simon 0:049d572aefe1 59 */
simon 0:049d572aefe1 60 int readable();
simon 0:049d572aefe1 61
simon 0:049d572aefe1 62 /** A blocking function that will return a tag ID when available
simon 0:049d572aefe1 63 *
simon 0:049d572aefe1 64 * @return The ID tag value
simon 0:049d572aefe1 65 */
simon 0:049d572aefe1 66 int read();
simon 0:049d572aefe1 67
simon 0:049d572aefe1 68 private:
simon 0:049d572aefe1 69 Serial _rfid;
simon 0:049d572aefe1 70
simon 0:049d572aefe1 71 };
simon 0:049d572aefe1 72
simon 0:049d572aefe1 73 #endif