Skip to main content

NDEF (NFC Data Exchange Format) parser and verifier

Project description

Release v0.2 – January 7th, 2020

The ndef modules provides methods for encoding and decoding messages and records in the NDEF format according to NFC Forum technical specification. Its main purpose is to provide comprehensive verification of raw NDEF messages. It can be used to verify messages before writing them to an actual tag.

Available on PyPI.


Valid Message

>>> import ndef
>>> message_data = 'D1010F5402656E48656C6C6F20776F726C6421'.decode('hex')
>>> message = ndef.NdefMessage(message_data)
>>> record = message.records[0]
>>> record.tnf
>>> record.type
>>> record.payload
'\x02enHello world!'

Invalid Message

>>> import ndef
>>> message_data = '9901050155610123456761'.decode('hex')
>>> message = ndef.NdefMessage(message_data)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "ndef\", line 274, in __init__
  File "ndef\", line 278, in verify
  File "ndef\", line 296, in _verify_begin_end
    raise InvalidNdefMessage("last record's ME flag is off")
ndef.ndef.InvalidNdefMessage: last record's ME flag is off

Create Message

>>> import ndef
>>> text_record = (ndef.TNF_WELL_KNOWN, ndef.RTD_TEXT, 'id', 'hello world')
>>> text_message = ndef.new_message(text_record)
>>> text_raw_ndef = text_message.to_buffer()
>>> text_raw_ndef.encode('hex')



Copyright (c) 2014 Amir Szekely

This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.

Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:

   1. The origin of this software must not be misrepresented; you must not
   claim that you wrote the original software. If you use this software
   in a product, an acknowledgment in the product documentation would be
   appreciated but is not required.

   2. Altered source versions must be plainly marked as such, and must not be
   misrepresented as being the original software.

   3. This notice may not be removed or altered from any source

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ndef-0.2.tar.gz (5.7 kB view hashes)

Uploaded source

Built Distribution

ndef-0.2-py2.py3-none-any.whl (6.7 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page