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.

RecordType/RecordAAR.h@7:1ebd6049fa57, 2015-12-10 (annotated)

Committer:
giovannivisentini
Date:
Thu Dec 10 14:58:43 2015 +0000
Revision:
7:1ebd6049fa57
Parent:
6:739e3211749d
Child:
8:473f6e0b03df
fix bug + add operator==

Who changed what in which revision?

UserRevisionLine numberNew contents of line
giovannivisentini 6:739e3211749d 1 /**
giovannivisentini 6:739e3211749d 2 ******************************************************************************
giovannivisentini 6:739e3211749d 3 * @file RecordAAR.h
giovannivisentini 6:739e3211749d 4 * @author ST / CentralLabs
giovannivisentini 6:739e3211749d 5 * @version V1.0.0
giovannivisentini 6:739e3211749d 6 * @date 6 Nov 2015
giovannivisentini 6:739e3211749d 7 * @brief Create a record that can start an application in an Android mobile
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_RECORDTYPE_RECORDAAR_H_
giovannivisentini 0:04b82ae7aa43 39 #define NDEFLIB_RECORDTYPE_RECORDAAR_H_
giovannivisentini 0:04b82ae7aa43 40
giovannivisentini 0:04b82ae7aa43 41 #include <string>
giovannivisentini 0:04b82ae7aa43 42
giovannivisentini 0:04b82ae7aa43 43 #include "NDefLib/Record.h"
giovannivisentini 4:eaf6c49a86e4 44
giovannivisentini 0:04b82ae7aa43 45 namespace NDefLib {
giovannivisentini 0:04b82ae7aa43 46
giovannivisentini 4:eaf6c49a86e4 47 /**
giovannivisentini 4:eaf6c49a86e4 48 * create a record that can start an application in an Android mobile
giovannivisentini 4:eaf6c49a86e4 49 */
giovannivisentini 0:04b82ae7aa43 50 class RecordAAR: public Record {
giovannivisentini 0:04b82ae7aa43 51 public:
giovannivisentini 4:eaf6c49a86e4 52 /**
giovannivisentini 4:eaf6c49a86e4 53 * create an RecordAAR reading the data from the buffer
giovannivisentini 4:eaf6c49a86e4 54 * @param header record header already read
giovannivisentini 4:eaf6c49a86e4 55 * @param buffer buffer where read the data
giovannivisentini 4:eaf6c49a86e4 56 * @return an object of type recordAAR or NULL
giovannivisentini 4:eaf6c49a86e4 57 * @par free the pointer return by this function
giovannivisentini 4:eaf6c49a86e4 58 */
giovannivisentini 4:eaf6c49a86e4 59 static RecordAAR* parse(const RecordHeader &header,
giovannivisentini 4:eaf6c49a86e4 60 const uint8_t * const buffer);
giovannivisentini 1:a0eeb478a45a 61
giovannivisentini 4:eaf6c49a86e4 62 /**
giovannivisentini 4:eaf6c49a86e4 63 * build a new record
giovannivisentini 4:eaf6c49a86e4 64 * @param packageName package of the application to start
giovannivisentini 4:eaf6c49a86e4 65 */
giovannivisentini 5:f2b7efcc5b6e 66 explicit RecordAAR(const std::string &packageName);
giovannivisentini 1:a0eeb478a45a 67
giovannivisentini 0:04b82ae7aa43 68
giovannivisentini 0:04b82ae7aa43 69 virtual uint16_t write(uint8_t *buffer);
giovannivisentini 1:a0eeb478a45a 70
giovannivisentini 4:eaf6c49a86e4 71 virtual RecordType_t getType() const {
giovannivisentini 1:a0eeb478a45a 72 return TYPE_AAR;
giovannivisentini 4:eaf6c49a86e4 73 } //getType
giovannivisentini 1:a0eeb478a45a 74
giovannivisentini 4:eaf6c49a86e4 75 /**
giovannivisentini 4:eaf6c49a86e4 76 * @return get the package inside this record
giovannivisentini 4:eaf6c49a86e4 77 */
giovannivisentini 4:eaf6c49a86e4 78 const std::string& getPackage() const {
giovannivisentini 1:a0eeb478a45a 79 return mPackageName;
giovannivisentini 1:a0eeb478a45a 80 }
giovannivisentini 1:a0eeb478a45a 81
giovannivisentini 4:eaf6c49a86e4 82 /**
giovannivisentini 4:eaf6c49a86e4 83 * change the package name of this record
giovannivisentini 4:eaf6c49a86e4 84 * @param package
giovannivisentini 4:eaf6c49a86e4 85 */
giovannivisentini 4:eaf6c49a86e4 86 void setPackage(const std::string& package){
giovannivisentini 4:eaf6c49a86e4 87 mPackageName=package;
giovannivisentini 7:1ebd6049fa57 88 mRecordHeader.setPayloadLength(mPackageName.size());
giovannivisentini 4:eaf6c49a86e4 89 }
giovannivisentini 4:eaf6c49a86e4 90
giovannivisentini 4:eaf6c49a86e4 91 virtual ~RecordAAR() { };
giovannivisentini 0:04b82ae7aa43 92
giovannivisentini 7:1ebd6049fa57 93 bool operator==(const RecordAAR &other) const{
giovannivisentini 7:1ebd6049fa57 94 return (mPackageName==other.mPackageName);
giovannivisentini 7:1ebd6049fa57 95 }
giovannivisentini 7:1ebd6049fa57 96
giovannivisentini 0:04b82ae7aa43 97 private:
giovannivisentini 4:eaf6c49a86e4 98 std::string mPackageName;
giovannivisentini 0:04b82ae7aa43 99
giovannivisentini 4:eaf6c49a86e4 100 /**
giovannivisentini 4:eaf6c49a86e4 101 * string to use as record type for this record
giovannivisentini 4:eaf6c49a86e4 102 */
giovannivisentini 1:a0eeb478a45a 103 static const char sRecordType[];
giovannivisentini 0:04b82ae7aa43 104 };
giovannivisentini 0:04b82ae7aa43 105
giovannivisentini 0:04b82ae7aa43 106 } /* namespace NDefLib */
giovannivisentini 0:04b82ae7aa43 107
giovannivisentini 0:04b82ae7aa43 108 #endif /* NDEFLIB_RECORDTYPE_RECORDAAR_H_ */