Jose Marquez / mbed-os-wiegand

This library reads Wiegand, saving it into a buffer, calling a callback function after it is full or a timeout is reached.

Dependents:   mbed-os-wiegand-example

This library reads Wiegand, saving it into a buffer, calling a callback function after it is full or a timeout is reached. Data can be extracted as :

  • Raw
  • Base 10 Integer
  • Base 10 String
  • Base 16 String

Always call reset after saving Wiegand data.

It automatically calibrates the timeout during the first reading unless specified.

Timeout can be set using setTimout, units are in milliseconds (first call stopCalibrating()).

EventQueue is required for deferring from ISR, it is possible to dispatch the EventQueue from the mainQueue or any other thread.

Diff: wiegand.h

Revision:
1:5217baef72fd
Parent:
0:4929608f96d0
Child:
2:2c72a6b13593
--- a/wiegand.h	Sat Apr 27 23:37:01 2019 +0000
+++ b/wiegand.h	Sat Apr 27 23:53:14 2019 +0000
@@ -1,18 +1,40 @@
+/* mbed Wiegand Library
+ * Copyright (c) 2017-2019, Gregorio Marquez
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+ 
 #ifndef MBED_MICIO_H
 #define MBED_MICIO_H
 
 #include "mbed.h"
 
 /*
-    This library reads Wiegand saving it into a buffer, calling a callback function after it is full or a timeout is reached.
-    It automatically calibrates the timeout during the first reading unless specified.
-    Timeout can be set using setTimout, units are in milliseconds (first call stopCalibrating()).
-    Always call reset after saving Wiegand data.
+    This library reads Wiegand, saving it into a buffer, calling a callback function after it is full or a timeout is reached.
     Data can be extracted as :
         * Raw -- For manipulation
         * Base 10 Integer 
         * Base 10 String    
         * Base 16 String
+    Always call reset after saving Wiegand data.
+    It automatically calibrates the timeout during the first reading unless specified.
+    Timeout can be set using setTimout, units are in milliseconds (first call stopCalibrating()).
     EventQueue is required for deferring from ISR, it is possible to dispatch the EventQueue from the mainQueue or any other thread. 
 */