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.
Record.h
- Committer:
- giovannivisentini
- Date:
- 2015-12-03
- Revision:
- 6:739e3211749d
- Parent:
- 4:eaf6c49a86e4
- Child:
- 7:1ebd6049fa57
File content as of revision 6:739e3211749d:
/** ****************************************************************************** * @file Record.h * @author ST / CentralLabs * @version V1.0.0 * @date 30 Nov 2015 * @brief generic Record class ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************** */ #ifndef NDEFLIB_RECORD_H_ #define NDEFLIB_RECORD_H_ #include <stdint.h> #include "RecordHeader.h" namespace NDefLib { /** * Base class for a NDefRecord * @see NFC Data Exchange Format (NDEF) Technical Specification NDEF 1.0 */ class Record { public: /** * enum used for identify the record type */ typedef enum { TYPE_UNKNOWN, //!< UNKNOWN record TYPE_TEXT, //!< TEXT TYPE_AAR, //!< Android Archive record TYPE_MIME, //!< generic MIME type TYPE_URI, //!< generic URI TYPE_URI_MAIL, //!< Email URI record TYPE_URI_SMS, //!< SMS URI record TYPE_URI_GEOLOCATION,//!< position URI record TYPE_MIME_VCARD //!< VCard record } RecordType_t; Record() { } /** * set the record as the first record in the message */ void setAsFirstRecord() { mRecordHeader.setMB(true); } /** * set the record as the last record in the message */ void setAsLastRecord() { mRecordHeader.setME(true); } /** * @return true if it is the last record in the message */ bool isLastRecord() const { return mRecordHeader.getME(); } /** * set the record as generic */ void setAsMiddleRecord() { mRecordHeader.setMB(false); mRecordHeader.setME(false); } /** * get tag type * @return tag type if not overwrite it return TYPE_UNKNOWN */ virtual RecordType_t getType() const { return TYPE_UNKNOWN; } //getType /** * number of byte needed for store this record * @return size header + size record content */ virtual uint16_t getByteLength() { return mRecordHeader.getRecordLength(); } /** * write the record content into a buffer * @param[out] buffer buffer where write the record content, the buffer size must be almost getByteLength() bytes * @return number of write bytes */ virtual uint16_t write(uint8_t *buffer)=0; virtual ~Record() { }; protected: RecordHeader mRecordHeader; }; } /* namespace NDefLib */ #endif /* NDEFLIB_RECORD_H_ */