nfc

nfc#

class platypush.message.event.nfc.NFCDeviceConnectedEvent(reader=None, *args, **kwargs)[source]#

Bases: NFCEvent

Event triggered when an NFC reader/writer devices is connected

__init__(reader=None, *args, **kwargs)[source]#
Parameters:

reader (str) – Name or address of the reader that fired the event

as_dict()#

Converts the event into a dictionary

classmethod build(msg)#

Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#

If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:

msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:

msg – Message object

class platypush.message.event.nfc.NFCDeviceDisconnectedEvent(reader=None, *args, **kwargs)[source]#

Bases: NFCEvent

Event triggered when an NFC reader/writer devices is disconnected

__init__(reader=None, *args, **kwargs)[source]#
Parameters:

reader (str) – Name or address of the reader that fired the event

as_dict()#

Converts the event into a dictionary

classmethod build(msg)#

Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#

If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:

msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:

msg – Message object

class platypush.message.event.nfc.NFCEvent(reader=None, tag_id=None, *args, **kwargs)[source]#

Bases: Event

Generic class for NFC events

__init__(reader=None, tag_id=None, *args, **kwargs)[source]#
Parameters:

  • target (str) – Target node

  • origin (str) – Origin node (default: current node)

  • id (str) – Event ID (default: auto-generated)

  • timestamp (float) – Event timestamp (default: current time)

  • logging_level – Logging level for this event (default: logging.INFO)

  • disable_web_clients_notification – Don’t send a notification of this event to the websocket clients

  • kwargs – Additional arguments for the event

as_dict()#

Converts the event into a dictionary

classmethod build(msg)#

Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#

If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:

msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:

msg – Message object

class platypush.message.event.nfc.NFCTagDetectedEvent(reader=None, tag_id=None, records=None, *args, **kwargs)[source]#

Bases: NFCEvent

Event triggered when an NFC tag is connected

__init__(reader=None, tag_id=None, records=None, *args, **kwargs)[source]#
Parameters:

  • reader (str) – Name or address of the reader that fired the event

  • tag_id (str) – ID of the NFC tag

  • records (str, bytes or JSON-serializable object) – Optional, list of records read from the tag. If the tag contains JSON-serializable data then it will be cast by the backend into the appropriate object

as_dict()#

Converts the event into a dictionary

classmethod build(msg)#

Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#

If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:

msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:

msg – Message object

class platypush.message.event.nfc.NFCTagRemovedEvent(reader=None, tag_id=None, *args, **kwargs)[source]#

Bases: NFCEvent

Event triggered when a NFC card is removed/disconnected

__init__(reader=None, tag_id=None, *args, **kwargs)[source]#
Parameters:

  • reader (str) – Name or address of the reader that fired the event

  • tag_id (str) – ID of the NFC tag

as_dict()#

Converts the event into a dictionary

classmethod build(msg)#

Builds an event message from a JSON UTF-8 string/bytearray, a dictionary, or another Event

matches_condition(condition)#

If the event matches an event condition, it will return an EventMatchResult :param condition: The platypush.event.hook.EventCondition object

classmethod parse(msg)#

Parse a generic message into a key-value dictionary

Parameters:

msg – Original message. It can be a dictionary, a Message, or a string/bytearray, as long as it’s valid UTF-8 JSON

classmethod to_dict(msg)#

Converts a Message object into a dictionary

Parameters:

msg – Message object

Platypush documentation