Welcome to libndef’s documentation!¶

Contents

Library API

ndef-lite¶

NDEF (NFC Data Exchange Format) Message library written in pure C++

About¶

This project was written due to a lack of C++ libraries providing support for the NDEF message standard. The only one that I was able to find was the NFC Tools Qt-based implementation, which is an unnecessary dependency.

This implementation is in pure C++14, aiming to provide feature parity with that library and improve on it while avoiding the Qt dependency.

More information about the NFC/NDEF standards through the NFC Forum’s website.

Installation¶

This project is built using CMake, so installation is nice and easy. Run the following commands and you’ll be all set!

mkdir build
cd build
cmake ..
make
sudo make install

Usage¶

Once the library is installed you will import the functionality via <ndef-lite/[component].hpp> and compile with the -lndef-lite flag!

Create NDEF Text Record and then serialize to byte array¶

#include <iomanip>
#include <iostream>
#include <string>
#include <vector>

#include <ndef-lite/message.hpp>
#include <ndef-lite/record.hpp>

int main() {
    // Create the text record for the message
    std::string message{"I'm sorry Dave, I'm afraid I can't do that."};

    // Create NDEF Message object
    NDEFMessage msg;

    // Record defaults to UTF-8 encoding, but UTF-16 is supported
    msg.append_record(NDEFRecord::create_text_record(message, "en-US"));

    // Serialize record
    std::vector<uint8_t> bytes = msg.as_bytes();

    // Configure cout to show hex characters
    std::cout << std::showbase << std::internal << std::setfill('0') << std::hex
                << std::setw(4);

    // Output raw bytes
    std::cout << "NDEF Record in raw bytes form:\n";
    for (uint &&val : bytes) {
        std::cout << val;
        std::cout << " ";
    }
    std::cout << std::endl;

    std::cout << "Payload message [" << msg.record(0).get_text_locale() << "]:\n";
    std::cout << NDEFRecord::get_text(msg.record(0).payload()) << std::endl;
    return 0;
}

Coverage and Tests¶

This library is currently at 95.2% test coverage according to LCOV as of 2019-06-25 15:30.

Testing is done via the doctest framework and can be executed locally by running make test.

Coverage be checked locally by running make coverage.

Library API →