X-NUCLEO-NFC01A1 Dynamic NFC Tag Expansion Board Firmware Package

File content as of revision 8:5e637c71cbb3:

/**
  ******************************************************************************
  * @file       Type4NfcTagM24SR.h
  * @author  	ST Central Labs
  * @date       05 Nov 2015
  * @brief      wrapper class for use the NDefLib library for write/read ndef message
  ******************************************************************************
  *
  * COPYRIGHT(c) 2015 STMicroelectronics
  *
  * 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 NDEFNFCTAGSTM24_H_
#define NDEFNFCTAGSTM24_H_
#include <stdint.h>

#include "NDefLib/NDefNfcTag.h"

class M24SR;

/**
 * implement the abstract method for use the NDefLib */
class NDefNfcTagM24SR: public NDefLib::NDefNfcTag {

public:
	/**
	 * create the object
	 * @param device device where write the Ndef tags
	 */
	NDefNfcTagM24SR(M24SR &device) :
			mDevice(device), mMaxReadBytes(0xFF), mMaxWriteBytes(
					0xFF) {
	}

	/**
	 * open the communication with the nfc tag
	 * \par when override this method call this implementation as last action for set the session opened
	 * @param force force to open a communication
	 * @return true if success
	 */
	virtual bool openSession(bool force = false);
	
	/**
	 * close the communication with the nfc tag
	 * \par when override this method call this implementation as last action for set the session closed
	 * @return true if success
	 */
	virtual bool closeSession();

	/**
	 * close the open session
	 */
	virtual ~NDefNfcTagM24SR() {
		if(isSessionOpen())
			closeSession();
	}//~Type4NfcTagM24SR

	

protected:
	
	/**
	 * write a sequence of byte in the NDEF file
	 * @param buffer buffer to write
	 * @param length number of byte to write
	 * @param offset offset where start to write
	 * @return true if success
	 */
	virtual bool writeByte(const uint8_t *buffer, const uint16_t length, uint16_t offset);
	
	/**
	 * read a sequence of byte from the NDEF file
	 * @param byteOffset offset were start read
	 * @param byteLength number of byte to read
	 * @param[out] buffer buffer where store the data read
	 * @return true if success
	 */
	virtual bool readByte(const uint16_t byteOffset, const uint16_t byteLength,
			uint8_t *buffer);

private:

	M24SR &mDevice;

	/**
	 * max length for a read operation
	 */
	uint16_t mMaxReadBytes;

	/**
	 * max length for a write operation
	 */
	uint16_t mMaxWriteBytes;
};

#endif /* NDEFNFCTAGSTM24_H_ */