mirror of https://github.com/ARMmbed/mbed-os.git
Add doc for NFCTarget
parent
39879b7d9d
commit
b0f1f4304c
|
@ -26,17 +26,52 @@
|
||||||
namespace mbed {
|
namespace mbed {
|
||||||
namespace nfc {
|
namespace nfc {
|
||||||
|
|
||||||
class NFCEEPROM : public NFCTarget {
|
/**
|
||||||
|
* @addtogroup nfc
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The NFC EEPROM class represents a NFC target device connected using a wired
|
||||||
|
* link (I2C, SPI, etc).
|
||||||
|
*
|
||||||
|
* These EEPROMs essentially provide addressable memory that can be accessed
|
||||||
|
* using either a wired or NFC interface.
|
||||||
|
*
|
||||||
|
* In NFC mode these most often conform to one of the NFC tag types defined
|
||||||
|
* by the NFC Forum, therefore encoding NDEF data in these EEPROMs will
|
||||||
|
* ensure that it is understandable by a NFC reader.
|
||||||
|
*/
|
||||||
|
class NFCEEPROM : public NFCTarget {
|
||||||
public:
|
public:
|
||||||
NFCEEPROM();
|
/**
|
||||||
|
* Construct a NFCEEPROM instance.
|
||||||
|
*
|
||||||
|
* @param[in] driver a pointer to a NFCEEPROMDriver instance
|
||||||
|
*/
|
||||||
|
NFCEEPROM(NFCEEPROMDriver* driver);
|
||||||
|
|
||||||
virtual ~NFCTarget();
|
virtual ~NFCTarget();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The NFCEEPROM delegate. Users of the NFCEEPROM class need to implement this delegate's methods to receive events.
|
||||||
|
*/
|
||||||
struct Delegate : NFCTarget::Delegate {
|
struct Delegate : NFCTarget::Delegate {
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the delegate that will receive events generated by this EEPROM.
|
||||||
|
*
|
||||||
|
* @oaram[in] delegate the delegate instance to use
|
||||||
|
*/
|
||||||
void set_delegate(Delegate* delegate);
|
void set_delegate(Delegate* delegate);
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @}
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
} // namespace nfc
|
} // namespace nfc
|
||||||
} // namespace mbed
|
} // namespace mbed
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue