Nicolas Duchoud / CR95HF

CR95F X-Nucleo NFC03A1 Shield STM

Dependents:   Nucleo_NFC03A1_Demo

CR95HF.h@2:c7006765c441, 2018-08-31 (annotated)

Committer:
duchonic
Date:
Fri Aug 31 06:33:12 2018 +0000
Revision:
2:c7006765c441
Parent:
1:549e63ac990c
Child:
3:12c871b2412d
documentation added

Who changed what in which revision?

UserRevisionLine numberNew contents of line
duchonic 1:549e63ac990c 1 /**
duchonic 1:549e63ac990c 2 * @file CR95HF.h
duchonic 1:549e63ac990c 3 * @brief Driver for CR95HF
duchonic 1:549e63ac990c 4 *
duchonic 1:549e63ac990c 5 */
duchonic 0:57769c77d24e 6 #include <mbed.h>
duchonic 1:549e63ac990c 7
duchonic 0:57769c77d24e 8
duchonic 1:549e63ac990c 9 /**
duchonic 1:549e63ac990c 10 * My CR95HF class.
duchonic 1:549e63ac990c 11 *
duchonic 1:549e63ac990c 12 * Example:
duchonic 1:549e63ac990c 13 * @code
duchonic 1:549e63ac990c 14 * #include <CR95HF.h>
duchonic 1:549e63ac990c 15 *
duchonic 1:549e63ac990c 16 * CR95HF nfcChip(UART_TX, UART_RX);
duchonic 1:549e63ac990c 17 *
duchonic 1:549e63ac990c 18 * nfcChip.Init();
duchonic 1:549e63ac990c 19 *
duchonic 1:549e63ac990c 20 * while(true) {
duchonic 1:549e63ac990c 21 * nfcChip.ConfigManagerTagHunting();
duchonic 1:549e63ac990c 22 * }
duchonic 1:549e63ac990c 23 *
duchonic 2:c7006765c441 24 * @endcode
duchonic 1:549e63ac990c 25 */
duchonic 0:57769c77d24e 26 class CR95HF
duchonic 0:57769c77d24e 27 {
duchonic 0:57769c77d24e 28 public:
duchonic 0:57769c77d24e 29 /**
duchonic 0:57769c77d24e 30 * Constructor
duchonic 0:57769c77d24e 31 */
duchonic 0:57769c77d24e 32 CR95HF(PinName tx, PinName rx);
duchonic 0:57769c77d24e 33 ~CR95HF();
duchonic 2:c7006765c441 34
duchonic 2:c7006765c441 35 /**
duchonic 2:c7006765c441 36 * @brief Init the device
duchonic 2:c7006765c441 37 */
duchonic 1:549e63ac990c 38 uint8_t Init();
duchonic 2:c7006765c441 39
duchonic 2:c7006765c441 40 /**
duchonic 2:c7006765c441 41 * @brief search the ISO/IEC 15693 tag and get UID
duchonic 2:c7006765c441 42 */
duchonic 1:549e63ac990c 43 uint8_t ConfigManagerTagHunting();
duchonic 0:57769c77d24e 44
duchonic 0:57769c77d24e 45 private:
duchonic 2:c7006765c441 46 /**
duchonic 2:c7006765c441 47 * @brief the serial class
duchonic 2:c7006765c441 48 */
duchonic 1:549e63ac990c 49 Serial nfcDevice;
duchonic 2:c7006765c441 50 /**
duchonic 2:c7006765c441 51 * @brief sends the commands over uart
duchonic 2:c7006765c441 52 * @param cmd buffer with commands
duchonic 2:c7006765c441 53 * @param len length of the buffer
duchonic 2:c7006765c441 54 */
duchonic 1:549e63ac990c 55 void nfcWrite(uint8_t cmd[], uint8_t len);
duchonic 2:c7006765c441 56 /**
duchonic 2:c7006765c441 57 * @brief callback for uart rx
duchonic 2:c7006765c441 58 */
duchonic 1:549e63ac990c 59 void rxCallbackNFC();
duchonic 0:57769c77d24e 60 };