ST / NDefLib

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 ST Expansion SW Team

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.

Record.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:
18:cf1dd5c931c2
Update documentation 3

Who changed what in which revision?

UserRevisionLine numberNew contents of line
giovannivisentini 6:739e3211749d 1 /**
giovannivisentini 6:739e3211749d 2 ******************************************************************************
giovannivisentini 6:739e3211749d 3 * @file Record.h
giovannivisentini 8:473f6e0b03df 4 * @author ST / Central Labs
giovannivisentini 6:739e3211749d 5 * @version V1.0.0
giovannivisentini 6:739e3211749d 6 * @date 30 Nov 2015
giovannivisentini 12:ed4d9b8d1410 7 * @brief Generic Record class
giovannivisentini 6:739e3211749d 8 ******************************************************************************
giovannivisentini 6:739e3211749d 9 * @attention
giovannivisentini 6:739e3211749d 10 *
giovannivisentini 6:739e3211749d 11 * <h2><center>&copy; 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_RECORD_H_
giovannivisentini 0:04b82ae7aa43 39 #define NDEFLIB_RECORD_H_
giovannivisentini 0:04b82ae7aa43 40 #include <stdint.h>
giovannivisentini 0:04b82ae7aa43 41
giovannivisentini 4:eaf6c49a86e4 42 #include "RecordHeader.h"
giovannivisentini 4:eaf6c49a86e4 43
giovannivisentini 0:04b82ae7aa43 44 namespace NDefLib {
giovannivisentini 0:04b82ae7aa43 45
giovannivisentini 4:eaf6c49a86e4 46 /**
giovannivisentini 4:eaf6c49a86e4 47 * Base class for a NDefRecord
giovannivisentini 4:eaf6c49a86e4 48 * @see NFC Data Exchange Format (NDEF) Technical Specification NDEF 1.0
giovannivisentini 4:eaf6c49a86e4 49 */
giovannivisentini 0:04b82ae7aa43 50 class Record {
giovannivisentini 0:04b82ae7aa43 51 public:
giovannivisentini 0:04b82ae7aa43 52
giovannivisentini 4:eaf6c49a86e4 53 /**
giovannivisentini 12:ed4d9b8d1410 54 * Enum used to identify the record type.
giovannivisentini 4:eaf6c49a86e4 55 */
giovannivisentini 4:eaf6c49a86e4 56 typedef enum {
giovannivisentini 4:eaf6c49a86e4 57 TYPE_UNKNOWN, //!< UNKNOWN record
giovannivisentini 4:eaf6c49a86e4 58 TYPE_TEXT, //!< TEXT
giovannivisentini 4:eaf6c49a86e4 59 TYPE_AAR, //!< Android Archive record
giovannivisentini 4:eaf6c49a86e4 60 TYPE_MIME, //!< generic MIME type
giovannivisentini 4:eaf6c49a86e4 61 TYPE_URI, //!< generic URI
giovannivisentini 4:eaf6c49a86e4 62 TYPE_URI_MAIL, //!< Email URI record
giovannivisentini 4:eaf6c49a86e4 63 TYPE_URI_SMS, //!< SMS URI record
giovannivisentini 4:eaf6c49a86e4 64 TYPE_URI_GEOLOCATION,//!< position URI record
giovannivisentini 4:eaf6c49a86e4 65 TYPE_MIME_VCARD //!< VCard record
giovannivisentini 4:eaf6c49a86e4 66 } RecordType_t;
giovannivisentini 0:04b82ae7aa43 67
giovannivisentini 4:eaf6c49a86e4 68 Record() {
giovannivisentini 4:eaf6c49a86e4 69 }
giovannivisentini 0:04b82ae7aa43 70
giovannivisentini 4:eaf6c49a86e4 71 /**
giovannivisentini 12:ed4d9b8d1410 72 * Set the record as the first record in the message.
giovannivisentini 4:eaf6c49a86e4 73 */
giovannivisentini 4:eaf6c49a86e4 74 void setAsFirstRecord() {
giovannivisentini 0:04b82ae7aa43 75 mRecordHeader.setMB(true);
giovannivisentini 0:04b82ae7aa43 76 }
giovannivisentini 0:04b82ae7aa43 77
giovannivisentini 4:eaf6c49a86e4 78 /**
giovannivisentini 12:ed4d9b8d1410 79 * Set the record as the last record in the message.
giovannivisentini 4:eaf6c49a86e4 80 */
giovannivisentini 4:eaf6c49a86e4 81 void setAsLastRecord() {
giovannivisentini 0:04b82ae7aa43 82 mRecordHeader.setME(true);
giovannivisentini 0:04b82ae7aa43 83 }
giovannivisentini 0:04b82ae7aa43 84
giovannivisentini 4:eaf6c49a86e4 85 /**
giovannivisentini 12:ed4d9b8d1410 86 * Check if it is the last record in the message.
giovannivisentini 4:eaf6c49a86e4 87 * @return true if it is the last record in the message
giovannivisentini 4:eaf6c49a86e4 88 */
giovannivisentini 4:eaf6c49a86e4 89 bool isLastRecord() const {
giovannivisentini 0:04b82ae7aa43 90 return mRecordHeader.getME();
giovannivisentini 0:04b82ae7aa43 91 }
giovannivisentini 0:04b82ae7aa43 92
giovannivisentini 4:eaf6c49a86e4 93 /**
giovannivisentini 12:ed4d9b8d1410 94 * Check if it is the first record in the message.
giovannivisentini 7:1ebd6049fa57 95 * @return true if it is the fist record in the message
giovannivisentini 7:1ebd6049fa57 96 */
giovannivisentini 7:1ebd6049fa57 97 bool isFirstRecord() const {
giovannivisentini 7:1ebd6049fa57 98 return mRecordHeader.getMB();
giovannivisentini 7:1ebd6049fa57 99 }
giovannivisentini 7:1ebd6049fa57 100
giovannivisentini 7:1ebd6049fa57 101 /**
giovannivisentini 12:ed4d9b8d1410 102 * Set the record as generic (not the first one and not the last one)
giovannivisentini 4:eaf6c49a86e4 103 */
giovannivisentini 4:eaf6c49a86e4 104 void setAsMiddleRecord() {
giovannivisentini 0:04b82ae7aa43 105 mRecordHeader.setMB(false);
giovannivisentini 0:04b82ae7aa43 106 mRecordHeader.setME(false);
giovannivisentini 0:04b82ae7aa43 107 }
giovannivisentini 0:04b82ae7aa43 108
giovannivisentini 10:9f34b0cfefe4 109 /**
giovannivisentini 12:ed4d9b8d1410 110 * Check if the record is in the middle of a chain.
giovannivisentini 10:9f34b0cfefe4 111 * @return true if is not the fist or the last one
giovannivisentini 10:9f34b0cfefe4 112 */
giovannivisentini 7:1ebd6049fa57 113 bool isMiddleRecord() const{
giovannivisentini 7:1ebd6049fa57 114 return ! (mRecordHeader.getMB() || mRecordHeader.getME());
giovannivisentini 7:1ebd6049fa57 115 }
giovannivisentini 7:1ebd6049fa57 116
giovannivisentini 4:eaf6c49a86e4 117 /**
giovannivisentini 12:ed4d9b8d1410 118 * Get tag type.
giovannivisentini 12:ed4d9b8d1410 119 * @par This method should be overridden to return a valid type.
giovannivisentini 12:ed4d9b8d1410 120 * @return tag type
giovannivisentini 4:eaf6c49a86e4 121 */
giovannivisentini 4:eaf6c49a86e4 122 virtual RecordType_t getType() const {
giovannivisentini 1:a0eeb478a45a 123 return TYPE_UNKNOWN;
giovannivisentini 4:eaf6c49a86e4 124 } //getType
giovannivisentini 1:a0eeb478a45a 125
giovannivisentini 7:1ebd6049fa57 126
giovannivisentini 7:1ebd6049fa57 127 /**
giovannivisentini 12:ed4d9b8d1410 128 * Get the record header.
giovannivisentini 12:ed4d9b8d1410 129 * @return record header
giovannivisentini 7:1ebd6049fa57 130 */
giovannivisentini 7:1ebd6049fa57 131 const RecordHeader& getHeader() const{
giovannivisentini 7:1ebd6049fa57 132 return mRecordHeader;
giovannivisentini 7:1ebd6049fa57 133 }
giovannivisentini 7:1ebd6049fa57 134
giovannivisentini 4:eaf6c49a86e4 135 /**
giovannivisentini 12:ed4d9b8d1410 136 * Number of bytes needed to store this record.
giovannivisentini 12:ed4d9b8d1410 137 * @return size of the header + size of the record content
giovannivisentini 4:eaf6c49a86e4 138 */
giovannivisentini 4:eaf6c49a86e4 139 virtual uint16_t getByteLength() {
giovannivisentini 0:04b82ae7aa43 140 return mRecordHeader.getRecordLength();
giovannivisentini 0:04b82ae7aa43 141 }
giovannivisentini 0:04b82ae7aa43 142
giovannivisentini 4:eaf6c49a86e4 143 /**
giovannivisentini 12:ed4d9b8d1410 144 * Write the record content into a buffer.
giovannivisentini 12:ed4d9b8d1410 145 * @param[out] buffer buffer to write the record content into, the buffer size
giovannivisentini 12:ed4d9b8d1410 146 * must be almost {@link Record#getByteLength} bytes.
giovannivisentini 12:ed4d9b8d1410 147 * @return number of written bytes
giovannivisentini 4:eaf6c49a86e4 148 */
giovannivisentini 0:04b82ae7aa43 149 virtual uint16_t write(uint8_t *buffer)=0;
giovannivisentini 0:04b82ae7aa43 150
giovannivisentini 4:eaf6c49a86e4 151 virtual ~Record() {
giovannivisentini 4:eaf6c49a86e4 152 };
giovannivisentini 0:04b82ae7aa43 153
giovannivisentini 0:04b82ae7aa43 154 protected:
giovannivisentini 0:04b82ae7aa43 155 RecordHeader mRecordHeader;
giovannivisentini 0:04b82ae7aa43 156 };
giovannivisentini 0:04b82ae7aa43 157
giovannivisentini 0:04b82ae7aa43 158 } /* namespace NDefLib */
giovannivisentini 0:04b82ae7aa43 159
giovannivisentini 0:04b82ae7aa43 160 #endif /* NDEFLIB_RECORD_H_ */