Utility library to read and write Ndef messages from/to a Type4 NFC tag
Dependents: NFC M2M_2016_STM32 MyongjiElec_capstone1 IDW01M1_Cloud_IBM ... more
Fork of NDefLib by
NDEF NFC library
This library provides an abstract API to create NDEF formatted messages and records and to read/write them from/to a Type4 NFC Tag.
Implementations
At the moment, the NDEF API is implemented by X_NUCLEO_NFC01A1 and X_NUCLEO_NFC02A1 Dynamic NFC Tag libraries respectively driving the X-NUCLEO-NFC01A1 and X-NUCLEO-NFC02A1 boards.
Message.h@12:ed4d9b8d1410, 2016-01-14 (annotated)
- Committer:
- giovannivisentini
- Date:
- Thu Jan 14 07:54:44 2016 +0000
- Revision:
- 12:ed4d9b8d1410
- Parent:
- 10:9f34b0cfefe4
- Child:
- 15:01fc5a4b8366
Update documentation 3
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
giovannivisentini | 6:739e3211749d | 1 | /** |
giovannivisentini | 6:739e3211749d | 2 | ****************************************************************************** |
giovannivisentini | 6:739e3211749d | 3 | * @file Message.h |
giovannivisentini | 8:473f6e0b03df | 4 | * @author ST / Central Labs |
giovannivisentini | 6:739e3211749d | 5 | * @version V1.0.0 |
giovannivisentini | 6:739e3211749d | 6 | * @date 6 Nov 2015 |
giovannivisentini | 6:739e3211749d | 7 | * @brief NDef Message class |
giovannivisentini | 6:739e3211749d | 8 | ****************************************************************************** |
giovannivisentini | 6:739e3211749d | 9 | * @attention |
giovannivisentini | 6:739e3211749d | 10 | * |
giovannivisentini | 6:739e3211749d | 11 | * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> |
giovannivisentini | 0:04b82ae7aa43 | 12 | * |
giovannivisentini | 6:739e3211749d | 13 | * Redistribution and use in source and binary forms, with or without modification, |
giovannivisentini | 6:739e3211749d | 14 | * are permitted provided that the following conditions are met: |
giovannivisentini | 6:739e3211749d | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
giovannivisentini | 6:739e3211749d | 16 | * this list of conditions and the following disclaimer. |
giovannivisentini | 6:739e3211749d | 17 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
giovannivisentini | 6:739e3211749d | 18 | * this list of conditions and the following disclaimer in the documentation |
giovannivisentini | 6:739e3211749d | 19 | * and/or other materials provided with the distribution. |
giovannivisentini | 6:739e3211749d | 20 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
giovannivisentini | 6:739e3211749d | 21 | * may be used to endorse or promote products derived from this software |
giovannivisentini | 6:739e3211749d | 22 | * without specific prior written permission. |
giovannivisentini | 6:739e3211749d | 23 | * |
giovannivisentini | 6:739e3211749d | 24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
giovannivisentini | 6:739e3211749d | 25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
giovannivisentini | 6:739e3211749d | 26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
giovannivisentini | 6:739e3211749d | 27 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
giovannivisentini | 6:739e3211749d | 28 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
giovannivisentini | 6:739e3211749d | 29 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
giovannivisentini | 6:739e3211749d | 30 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
giovannivisentini | 6:739e3211749d | 31 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
giovannivisentini | 6:739e3211749d | 32 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
giovannivisentini | 6:739e3211749d | 33 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
giovannivisentini | 6:739e3211749d | 34 | * |
giovannivisentini | 6:739e3211749d | 35 | ****************************************************************************** |
giovannivisentini | 0:04b82ae7aa43 | 36 | */ |
giovannivisentini | 0:04b82ae7aa43 | 37 | |
giovannivisentini | 0:04b82ae7aa43 | 38 | #ifndef NDEFLIB_MESSAGE_H_ |
giovannivisentini | 0:04b82ae7aa43 | 39 | #define NDEFLIB_MESSAGE_H_ |
giovannivisentini | 0:04b82ae7aa43 | 40 | |
giovannivisentini | 0:04b82ae7aa43 | 41 | #include <vector> |
giovannivisentini | 0:04b82ae7aa43 | 42 | |
giovannivisentini | 0:04b82ae7aa43 | 43 | #include "Record.h" |
giovannivisentini | 0:04b82ae7aa43 | 44 | |
giovannivisentini | 0:04b82ae7aa43 | 45 | namespace NDefLib { |
giovannivisentini | 0:04b82ae7aa43 | 46 | |
giovannivisentini | 4:eaf6c49a86e4 | 47 | /** |
giovannivisentini | 12:ed4d9b8d1410 | 48 | * Class containing a list of {@link Record} |
giovannivisentini | 4:eaf6c49a86e4 | 49 | */ |
giovannivisentini | 0:04b82ae7aa43 | 50 | class Message { |
giovannivisentini | 0:04b82ae7aa43 | 51 | public: |
giovannivisentini | 4:eaf6c49a86e4 | 52 | |
giovannivisentini | 4:eaf6c49a86e4 | 53 | /** |
giovannivisentini | 12:ed4d9b8d1410 | 54 | * Add a ndef record to this message. |
giovannivisentini | 12:ed4d9b8d1410 | 55 | * @param r Record to add |
giovannivisentini | 4:eaf6c49a86e4 | 56 | */ |
giovannivisentini | 4:eaf6c49a86e4 | 57 | void addRecord(Record *r) { |
giovannivisentini | 0:04b82ae7aa43 | 58 | mRecords.push_back(r); |
giovannivisentini | 0:04b82ae7aa43 | 59 | } |
giovannivisentini | 0:04b82ae7aa43 | 60 | |
giovannivisentini | 4:eaf6c49a86e4 | 61 | /** |
giovannivisentini | 12:ed4d9b8d1410 | 62 | * Add all the records in the list to this message. |
giovannivisentini | 12:ed4d9b8d1410 | 63 | * @param addList List of records to add. |
giovannivisentini | 4:eaf6c49a86e4 | 64 | */ |
giovannivisentini | 4:eaf6c49a86e4 | 65 | void addRecords(const std::vector<Record*> &addList) { |
giovannivisentini | 4:eaf6c49a86e4 | 66 | mRecords.insert(mRecords.end(), addList.begin(), addList.end()); |
giovannivisentini | 1:a0eeb478a45a | 67 | } |
giovannivisentini | 1:a0eeb478a45a | 68 | |
giovannivisentini | 4:eaf6c49a86e4 | 69 | /** |
giovannivisentini | 12:ed4d9b8d1410 | 70 | * Get the specific record contained by this message, NULL if not a valid index. |
giovannivisentini | 12:ed4d9b8d1410 | 71 | * @param index Record index. |
giovannivisentini | 12:ed4d9b8d1410 | 72 | * @return a Record object if present, otherwise NULL |
giovannivisentini | 4:eaf6c49a86e4 | 73 | */ |
giovannivisentini | 4:eaf6c49a86e4 | 74 | Record* operator[](const uint32_t index){ |
giovannivisentini | 7:1ebd6049fa57 | 75 | if (index >= mRecords.size()) |
giovannivisentini | 1:a0eeb478a45a | 76 | return NULL; |
giovannivisentini | 1:a0eeb478a45a | 77 | return mRecords[index]; |
giovannivisentini | 1:a0eeb478a45a | 78 | } |
giovannivisentini | 1:a0eeb478a45a | 79 | |
giovannivisentini | 4:eaf6c49a86e4 | 80 | /** |
giovannivisentini | 12:ed4d9b8d1410 | 81 | * Get the number of records in this message. |
giovannivisentini | 12:ed4d9b8d1410 | 82 | * @return number of records in this message |
giovannivisentini | 4:eaf6c49a86e4 | 83 | */ |
giovannivisentini | 4:eaf6c49a86e4 | 84 | uint32_t getNRecords() const { |
giovannivisentini | 1:a0eeb478a45a | 85 | return mRecords.size(); |
giovannivisentini | 1:a0eeb478a45a | 86 | } |
giovannivisentini | 1:a0eeb478a45a | 87 | |
giovannivisentini | 4:eaf6c49a86e4 | 88 | /** |
giovannivisentini | 12:ed4d9b8d1410 | 89 | * Length in bytes needed to write this message. |
giovannivisentini | 12:ed4d9b8d1410 | 90 | * @return number of bytes needed to write this message |
giovannivisentini | 4:eaf6c49a86e4 | 91 | */ |
giovannivisentini | 4:eaf6c49a86e4 | 92 | uint16_t getByteLength() const; |
giovannivisentini | 4:eaf6c49a86e4 | 93 | |
giovannivisentini | 4:eaf6c49a86e4 | 94 | /** |
giovannivisentini | 12:ed4d9b8d1410 | 95 | * Write message in the provided buffer |
giovannivisentini | 12:ed4d9b8d1410 | 96 | * @par The first 2 bytes contain the NDEF message length. |
giovannivisentini | 12:ed4d9b8d1410 | 97 | * @param[out] buffer Buffer the message must be written into. |
giovannivisentini | 12:ed4d9b8d1410 | 98 | * @return number of bytes written |
giovannivisentini | 4:eaf6c49a86e4 | 99 | */ |
giovannivisentini | 4:eaf6c49a86e4 | 100 | uint16_t write(uint8_t *buffer) const; |
giovannivisentini | 0:04b82ae7aa43 | 101 | |
giovannivisentini | 4:eaf6c49a86e4 | 102 | /** |
giovannivisentini | 12:ed4d9b8d1410 | 103 | * Create a set of records from a raw buffer adding them to a message object. |
giovannivisentini | 12:ed4d9b8d1410 | 104 | * @par Message buffer must NOT contain the buffer length in the first two bytes. |
giovannivisentini | 12:ed4d9b8d1410 | 105 | * @param buffer Buffer containing the message record. |
giovannivisentini | 12:ed4d9b8d1410 | 106 | * @param bufferLength Buffer length. |
giovannivisentini | 12:ed4d9b8d1410 | 107 | * @param[in,out] Message message that will contain the new records. |
giovannivisentini | 4:eaf6c49a86e4 | 108 | */ |
giovannivisentini | 4:eaf6c49a86e4 | 109 | static void parseMessage(const uint8_t * const buffer, |
giovannivisentini | 12:ed4d9b8d1410 | 110 | const uint16_t bufferLength, Message *message); |
giovannivisentini | 0:04b82ae7aa43 | 111 | |
giovannivisentini | 4:eaf6c49a86e4 | 112 | virtual ~Message() { |
giovannivisentini | 4:eaf6c49a86e4 | 113 | } |
giovannivisentini | 4:eaf6c49a86e4 | 114 | |
giovannivisentini | 0:04b82ae7aa43 | 115 | private: |
giovannivisentini | 4:eaf6c49a86e4 | 116 | /** |
giovannivisentini | 12:ed4d9b8d1410 | 117 | * List of records contained by this message. |
giovannivisentini | 4:eaf6c49a86e4 | 118 | */ |
giovannivisentini | 0:04b82ae7aa43 | 119 | std::vector<Record*> mRecords; |
giovannivisentini | 0:04b82ae7aa43 | 120 | }; |
giovannivisentini | 0:04b82ae7aa43 | 121 | |
giovannivisentini | 0:04b82ae7aa43 | 122 | } /* namespace NDefLib */ |
giovannivisentini | 0:04b82ae7aa43 | 123 | |
giovannivisentini | 0:04b82ae7aa43 | 124 | #endif /* NDEFLIB_MESSAGE_H_ */ |