..
 #############################################################
 # This file was automatically generated on 2015-05-08.      #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################


:breadcrumbs: <a href="../../index.html">Home</a> / <a href="../../index.html#software-matlab">Software</a> / MATLAB/Octave - NFC/RFID Bricklet

.. |device_identifier_constant| replace:: There is also a :ref:`constant <nfc_rfid_bricklet_matlab_constants>` for the device identifier of this Bricklet.

.. _nfc_rfid_bricklet_matlab:

MATLAB/Octave - NFC/RFID Bricklet
=================================

This is the description of the :ref:`MATLAB/Octave API bindings <api_bindings_matlab>` for the :ref:`NFC/RFID Bricklet <nfc_rfid_bricklet>`. General information and technical
specifications for the NFC/RFID Bricklet are summarized in its :ref:`hardware description
<nfc_rfid_bricklet_description>`.

An :ref:`installation guide <api_bindings_matlab_install>` for the MATLAB/Octave API
bindings is part of their general description.

.. _nfc_rfid_bricklet_matlab_examples:


Examples
--------

The example code below is `Public Domain (CC0 1.0)
<http://creativecommons.org/publicdomain/zero/1.0/>`__.

Write Read Type2 (MATLAB)
^^^^^^^^^^^^^^^^^^^^^^^^^

`Download (matlab_example_write_read_type2.m) <https://github.com/Tinkerforge/nfc-rfid-bricklet/raw/master/software/examples/matlab/matlab_example_write_read_type2.m>`__

.. literalinclude:: NFCRFID_Bricklet_MATLAB_matlab_example_write_read_type2.m
 :language: matlab
 :linenos:
 :tab-width: 4

Scan For Tags (MATLAB)
^^^^^^^^^^^^^^^^^^^^^^

`Download (matlab_example_scan_for_tags.m) <https://github.com/Tinkerforge/nfc-rfid-bricklet/raw/master/software/examples/matlab/matlab_example_scan_for_tags.m>`__

.. literalinclude:: NFCRFID_Bricklet_MATLAB_matlab_example_scan_for_tags.m
 :language: matlab
 :linenos:
 :tab-width: 4

Scan For Tags (Octave)
^^^^^^^^^^^^^^^^^^^^^^

`Download (octave_example_scan_for_tags.m) <https://github.com/Tinkerforge/nfc-rfid-bricklet/raw/master/software/examples/matlab/octave_example_scan_for_tags.m>`__

.. literalinclude:: NFCRFID_Bricklet_MATLAB_octave_example_scan_for_tags.m
 :language: octave_fixed
 :linenos:
 :tab-width: 4

Write Read Type2 (Octave)
^^^^^^^^^^^^^^^^^^^^^^^^^

`Download (octave_example_write_read_type2.m) <https://github.com/Tinkerforge/nfc-rfid-bricklet/raw/master/software/examples/matlab/octave_example_write_read_type2.m>`__

.. literalinclude:: NFCRFID_Bricklet_MATLAB_octave_example_write_read_type2.m
 :language: octave_fixed
 :linenos:
 :tab-width: 4

.. _nfc_rfid_bricklet_matlab_api:

API
---

Generally, every method of the MATLAB bindings that returns a value can
throw a ``TimeoutException``. This exception gets thrown if the
device did not respond. If a cable based connection is used, it is
unlikely that this exception gets thrown (assuming nobody unplugs the
device). However, if a wireless connection is used, timeouts will occur
if the distance to the device gets too big.

Beside the ``TimeoutException`` there is also a ``NotConnectedException`` that
is thrown if a method needs to communicate with the device while the
IP Connection is not connected.

Since the MATLAB bindings are based on Java and Java does not support multiple
return values and return by reference is not possible for primitive types, we
use small classes that only consist of member variables. The member variables
of the returned objects are described in the corresponding method descriptions.

The package for all Brick/Bricklet bindings and the IP Connection is
``com.tinkerforge.*``

All methods listed below are thread-safe.




Basic Functions
^^^^^^^^^^^^^^^


.. matlab:function:: class BrickletNFCRFID(String uid, IPConnection ipcon)

 Creates an object with the unique device ID ``uid``.

 In MATLAB:

 .. code-block:: matlab

  import com.tinkerforge.BrickletNFCRFID;

  nfcRFID = BrickletNFCRFID('YOUR_DEVICE_UID', ipcon);

 In Octave:

 .. code-block:: octave_fixed

  nfcRFID = java_new("com.tinkerforge.BrickletNFCRFID", "YOUR_DEVICE_UID", ipcon);

 This object can then be used after the IP Connection is connected
 (see examples :ref:`above <nfc_rfid_bricklet_matlab_examples>`).


.. matlab:function:: public void BrickletNFCRFID::requestTagID(short tagType)

 To read or write a tag that is in proximity of the NFC/RFID Bricklet you 
 first have to call this function with the expected tag type as parameter.
 It is no problem if you don't know the tag type. You can cycle through 
 the available tag types until the tag gives an answer to the request.
 
 Current the following tag types are supported:
 
 * Mifare Classic (``tag_type`` = 0)
 * NFC Forum Type 1 (``tag_type`` = 1)
 * NFC Forum Type 2 (``tag_type`` = 2)
 
 After you call :matlab:func:`requestTagID() <BrickletNFCRFID::requestTagID>` the NFC/RFID Bricklet will try to read 
 the tag ID from the tag. After this process is done the state will change.
 You can either register the :matlab:member:`StateChangedCallback <BrickletNFCRFID.StateChangedCallback>` callback or you can poll
 :matlab:func:`getState() <BrickletNFCRFID::getState>` to find out about the state change.
 
 If the state changes to *RequestTagIDError* it means that either there was 
 no tag present or that the tag is of an incompatible type. If the state 
 changes to *RequestTagIDReady* it means that a compatible tag was found 
 and that the tag ID could be read out. You can now get the tag ID by
 calling :matlab:func:`getTagID() <BrickletNFCRFID::getTagID>`.
 
 If two tags are in the proximity of the NFC/RFID Bricklet, this
 function will cycle through the tags. To select a specific tag you have
 to call :matlab:func:`requestTagID() <BrickletNFCRFID::requestTagID>` until the correct tag id is found.
 
 In case of any *Error* state the selection is lost and you have to
 start again by calling :matlab:func:`requestTagID() <BrickletNFCRFID::requestTagID>`.
 
 The following constants are available for this function:
 
 * BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC = 0
 * BrickletNFCRFID.TAG_TYPE_TYPE1 = 1
 * BrickletNFCRFID.TAG_TYPE_TYPE2 = 2
 
.. matlab:function:: public BrickletNFCRFID.TagID BrickletNFCRFID::getTagID()

 Returns the tag type, tag ID and the length of the tag ID 
 (4 or 7 bytes are possible length). This function can only be called if the
 NFC/RFID is currently in one of the *Ready* states. The returned ID
 is the ID that was saved through the last call of :matlab:func:`requestTagID() <BrickletNFCRFID::requestTagID>`.
 
 To get the tag ID of a tag the approach is as follows:
 
 1. Call :matlab:func:`requestTagID() <BrickletNFCRFID::requestTagID>`
 2. Wait for state to change to *RequestTagIDReady* (see :matlab:func:`getState() <BrickletNFCRFID::getState>` or
    :matlab:member:`StateChangedCallback <BrickletNFCRFID.StateChangedCallback>`)
 3. Call :matlab:func:`getTagID() <BrickletNFCRFID::getTagID>`
 
 The following constants are available for this function:
 
 * BrickletNFCRFID.TAG_TYPE_MIFARE_CLASSIC = 0
 * BrickletNFCRFID.TAG_TYPE_TYPE1 = 1
 * BrickletNFCRFID.TAG_TYPE_TYPE2 = 2
 
 The returned object has the public member variables ``short tagType``, ``short tidLength`` and ``short[] tid``.

.. matlab:function:: public BrickletNFCRFID.State BrickletNFCRFID::getState()

 Returns the current state of the NFC/RFID Bricklet.
 
 On startup the Bricklet will be in the *Initialization* state. The
 initialization will only take about 20ms. After that it changes to *Idle*.
 
 The functions of this Bricklet can be called in the *Idle* state and all of
 the *Ready* and *Error* states.
 
 Example: If you call :matlab:func:`requestPage() <BrickletNFCRFID::requestPage>`, the state will change to 
 *RequestPage* until the reading of the page is finished. Then it will change
 to either *RequestPageReady* if it worked or to *RequestPageError* if it
 didn't. If the request worked you can get the page by calling :matlab:func:`getPage() <BrickletNFCRFID::getPage>`.
 
 The same approach is used analogously for the other API functions.
 
 Possible states are:
 
 * Initialization = 0
 * Idle = 128
 * Error = 192
 * RequestTagID = 2
 * RequestTagIDReady = 130
 * RequestTagIDError = 194
 * AuthenticatingMifareClassicPage = 3
 * AuthenticatingMifareClassicPageReady = 131
 * AuthenticatingMifareClassicPageError = 195
 * WritePage = 4
 * WritePageReady = 132
 * WritePageError = 196
 * RequestPage = 5
 * RequestPageReady = 133
 * RequestPageError = 197
 
 The following constants are available for this function:
 
 * BrickletNFCRFID.STATE_INITIALIZATION = 0
 * BrickletNFCRFID.STATE_IDLE = 128
 * BrickletNFCRFID.STATE_ERROR = 192
 * BrickletNFCRFID.STATE_REQUEST_TAG_ID = 2
 * BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY = 130
 * BrickletNFCRFID.STATE_REQUEST_TAG_ID_ERROR = 194
 * BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
 * BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
 * BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
 * BrickletNFCRFID.STATE_WRITE_PAGE = 4
 * BrickletNFCRFID.STATE_WRITE_PAGE_READY = 132
 * BrickletNFCRFID.STATE_WRITE_PAGE_ERROR = 196
 * BrickletNFCRFID.STATE_REQUEST_PAGE = 5
 * BrickletNFCRFID.STATE_REQUEST_PAGE_READY = 133
 * BrickletNFCRFID.STATE_REQUEST_PAGE_ERROR = 197
 
 The returned object has the public member variables ``short state`` and ``boolean idle``.

.. matlab:function:: public void BrickletNFCRFID::authenticateMifareClassicPage(int page, short keyNumber, short[] key)

 Mifare Classic tags use authentication. If you want to read from or write to
 a Mifare Classic page you have to authenticate it beforehand.
 Each page can be authenticated with two keys: A (``key_number`` = 0) and B
 (``key_number`` = 1). A new Mifare Classic
 tag that has not yet been written to can can be accessed with key A
 and the default key ``[0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF]``.
 
 The approach to read or write a Mifare Classic page is as follows:
 
 1. Call :matlab:func:`requestTagID() <BrickletNFCRFID::requestTagID>`
 2. Wait for state to change to *RequestTagIDReady* (see :matlab:func:`getState() <BrickletNFCRFID::getState>`
    or :matlab:member:`StateChangedCallback <BrickletNFCRFID.StateChangedCallback>`)
 3. If looking for a specific tag then call :matlab:func:`getTagID() <BrickletNFCRFID::getTagID>` and check if the
    expected tag was found, if it was not found got back to step 1
 4. Call :matlab:func:`authenticateMifareClassicPage() <BrickletNFCRFID::authenticateMifareClassicPage>` with page and key for the page
 5. Wait for state to change to *AuthenticatingMifareClassicPageReady* (see
    :matlab:func:`getState() <BrickletNFCRFID::getState>` or :matlab:member:`StateChangedCallback <BrickletNFCRFID.StateChangedCallback>`)
 6. Call :matlab:func:`requestPage() <BrickletNFCRFID::requestPage>` or :matlab:func:`writePage() <BrickletNFCRFID::writePage>` to read/write page
 
 The following constants are available for this function:
 
 * BrickletNFCRFID.KEY_A = 0
 * BrickletNFCRFID.KEY_B = 1
 
.. matlab:function:: public void BrickletNFCRFID::writePage(int page, short[] data)

 Writes 16 bytes starting from the given page. How many pages are written
 depends on the tag type. The page sizes are as follows:
 
 * Mifare Classic page size: 16 byte (one page is written)
 * NFC Forum Type 1 page size: 8 byte (two pages are written)
 * NFC Forum Type 2 page size: 4 byte (four pages are written)
 
 The general approach for writing to a tag is as follows:
 
 1. Call :matlab:func:`requestTagID() <BrickletNFCRFID::requestTagID>`
 2. Wait for state to change to *RequestTagIDReady* (see :matlab:func:`getState() <BrickletNFCRFID::getState>` or
    :matlab:member:`StateChangedCallback <BrickletNFCRFID.StateChangedCallback>`)
 3. If looking for a specific tag then call :matlab:func:`getTagID() <BrickletNFCRFID::getTagID>` and check if the
    expected tag was found, if it was not found got back to step 1
 4. Call :matlab:func:`writePage() <BrickletNFCRFID::writePage>` with page number and data
 5. Wait for state to change to *WritePageReady* (see :matlab:func:`getState() <BrickletNFCRFID::getState>` or
    :matlab:member:`StateChangedCallback <BrickletNFCRFID.StateChangedCallback>`)
 
 If you use a Mifare Classic tag you have to authenticate a page before you
 can write to it. See :matlab:func:`authenticateMifareClassicPage() <BrickletNFCRFID::authenticateMifareClassicPage>`.
 
.. matlab:function:: public void BrickletNFCRFID::requestPage(int page)

 Reads 16 bytes starting from the given page and stores them into a buffer. 
 The buffer can then be read out with :matlab:func:`getPage() <BrickletNFCRFID::getPage>`.
 How many pages are read depends on the tag type. The page sizes are 
 as follows:
 
 * Mifare Classic page size: 16 byte (one page is read)
 * NFC Forum Type 1 page size: 8 byte (two pages are read)
 * NFC Forum Type 2 page size: 4 byte (four pages are read)
 
 The general approach for reading a tag is as follows:
 
 1. Call :matlab:func:`requestTagID() <BrickletNFCRFID::requestTagID>`
 2. Wait for state to change to *RequestTagIDReady* (see :matlab:func:`getState() <BrickletNFCRFID::getState>`
    or :matlab:member:`StateChangedCallback <BrickletNFCRFID.StateChangedCallback>`)
 3. If looking for a specific tag then call :matlab:func:`getTagID() <BrickletNFCRFID::getTagID>` and check if the
    expected tag was found, if it was not found got back to step 1
 4. Call :matlab:func:`requestPage() <BrickletNFCRFID::requestPage>` with page number
 5. Wait for state to change to *RequestPageReady* (see :matlab:func:`getState() <BrickletNFCRFID::getState>`
    or :matlab:member:`StateChangedCallback <BrickletNFCRFID.StateChangedCallback>`)
 6. Call :matlab:func:`getPage() <BrickletNFCRFID::getPage>` to retrieve the page from the buffer
 
 If you use a Mifare Classic tag you have to authenticate a page before you
 can read it. See :matlab:func:`authenticateMifareClassicPage() <BrickletNFCRFID::authenticateMifareClassicPage>`.
 
.. matlab:function:: public short[] BrickletNFCRFID::getPage()

 Returns 16 bytes of data from an internal buffer. To fill the buffer
 with specific pages you have to call :matlab:func:`requestPage() <BrickletNFCRFID::requestPage>` beforehand.
 


Advanced Functions
^^^^^^^^^^^^^^^^^^

.. matlab:function:: public short[] BrickletNFCRFID::getAPIVersion()

 Returns the version of the API definition (major, minor, revision) implemented
 by this API bindings. This is neither the release version of this API bindings
 nor does it tell you anything about the represented Brick or Bricklet.
 
.. matlab:function:: public boolean BrickletNFCRFID::getResponseExpected(short functionId)

 Returns the response expected flag for the function specified by the function
 ID parameter. It is *true* if the function is expected to send a response,
 *false* otherwise.
 
 For getter functions this is enabled by default and cannot be disabled,
 because those functions will always send a response. For callback configuration
 functions it is enabled by default too, but can be disabled by
 :matlab:func:`setResponseExpected() <BrickletNFCRFID::setResponseExpected>`. For setter functions it is disabled by default
 and can be enabled.
 
 Enabling the response expected flag for a setter function allows to detect
 timeouts and other error conditions calls of this setter as well. The
 device will then send a response for this purpose. If this flag is disabled for
 a setter function then no response is send and errors are silently ignored,
 because they cannot be detected.
 
 See :matlab:func:`setResponseExpected() <BrickletNFCRFID::setResponseExpected>`
 for the list of function ID constants available for this function.
 
.. matlab:function:: public void BrickletNFCRFID::setResponseExpected(short functionId, boolean responseExpected)

 Changes the response expected flag of the function specified by the
 function ID parameter. This flag can only be changed for setter (default value:
 *false*) and callback configuration functions (default value: *true*). For
 getter functions it is always enabled and callbacks it is always disabled.
 
 Enabling the response expected flag for a setter function allows to detect
 timeouts and other error conditions calls of this setter as well. The
 device will then send a response for this purpose. If this flag is disabled for
 a setter function then no response is send and errors are silently ignored,
 because they cannot be detected.
 
 The following function ID constants are available for this function:
 
 * BrickletNFCRFID.FUNCTION_REQUEST_TAG_ID = 1
 * BrickletNFCRFID.FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE = 4
 * BrickletNFCRFID.FUNCTION_WRITE_PAGE = 5
 * BrickletNFCRFID.FUNCTION_REQUEST_PAGE = 6
 
.. matlab:function:: public void BrickletNFCRFID::setResponseExpectedAll(boolean responseExpected)

 Changes the response expected flag for all setter and callback configuration
 functions of this device at once.
 
.. matlab:function:: public BrickletNFCRFID.Identity BrickletNFCRFID::getIdentity()

 Returns the UID, the UID where the Bricklet is connected to, 
 the position, the hardware and firmware version as well as the
 device identifier.
 
 The position can be 'a', 'b', 'c' or 'd'.
 
 The device identifier numbers can be found :ref:`here <device_identifier>`.
 |device_identifier_constant|
 
 The returned object has the public member variables ``String uid``, ``String connectedUid``, ``char position``, ``short[] hardwareVersion``, ``short[] firmwareVersion`` and ``int deviceIdentifier``.



.. _nfc_rfid_bricklet_matlab_callbacks:

Callbacks
^^^^^^^^^

Callbacks can be registered to receive time critical or recurring data from
the device. The registration is done with "set" function of MATLAB. The
parameters consist of the IP Connection object, the callback name and the
callback function. For example, it looks like this in MATLAB:

.. code-block:: matlab

    function cb_example(e)
        fprintf('Parameter: %s\n', e.param);
    end

    set(device, 'ExampleCallback', @(h, e) cb_example(e));

Due to a difference in the Octave Java support the "set" function cannot be
used in Octave. The registration is done with "add*Callback" functions of the
device object. It looks like this in Octave:

.. code-block:: octave_fixed

    function cb_example(e)
        fprintf("Parameter: %s\n", e.param);
    end

    device.addExampleCallback(@cb_example);

It is possible to add several callbacks and to remove them with the
corresponding "remove*Callback" function.

The parameters of the callback are passed to the callback function as fields of
the structure ``e``, which is derived from the ``java.util.EventObject`` class.
The available callback names with corresponding structure fields are described
below.

.. note::
 Using callbacks for recurring events is *always* preferred
 compared to using getters. It will use less USB bandwidth and the latency
 will be a lot better, since there is no round trip time.



.. matlab:member:: public callback BrickletNFCRFID.StateChangedCallback

 :param state: short
 :param idle: boolean


 This callback is called if the state of the NFC/RFID Bricklet changes.
 See :matlab:func:`getState() <BrickletNFCRFID::getState>` for more information about the possible states.
 
 The following constants are available for this function:
 
 * BrickletNFCRFID.STATE_INITIALIZATION = 0
 * BrickletNFCRFID.STATE_IDLE = 128
 * BrickletNFCRFID.STATE_ERROR = 192
 * BrickletNFCRFID.STATE_REQUEST_TAG_ID = 2
 * BrickletNFCRFID.STATE_REQUEST_TAG_ID_READY = 130
 * BrickletNFCRFID.STATE_REQUEST_TAG_ID_ERROR = 194
 * BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE = 3
 * BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_READY = 131
 * BrickletNFCRFID.STATE_AUTHENTICATING_MIFARE_CLASSIC_PAGE_ERROR = 195
 * BrickletNFCRFID.STATE_WRITE_PAGE = 4
 * BrickletNFCRFID.STATE_WRITE_PAGE_READY = 132
 * BrickletNFCRFID.STATE_WRITE_PAGE_ERROR = 196
 * BrickletNFCRFID.STATE_REQUEST_PAGE = 5
 * BrickletNFCRFID.STATE_REQUEST_PAGE_READY = 133
 * BrickletNFCRFID.STATE_REQUEST_PAGE_ERROR = 197
 

 In MATLAB the ``set()`` function can be used to register a callback function
 to this callback.

 In Octave a callback function can be added to this callback using the
 ``addStateChangedCallback()`` function. An added callback function can be removed with
 the ``removeStateChangedCallback()`` function.



.. _nfc_rfid_bricklet_matlab_constants:

Constants
^^^^^^^^^

.. matlab:member:: public static final int BrickletNFCRFID.DEVICE_IDENTIFIER

 This constant is used to identify a NFC/RFID Bricklet.

 The :matlab:func:`getIdentity() <BrickletNFCRFID::getIdentity>` function and the
 :matlab:member:`EnumerateCallback <IPConnection.EnumerateCallback>`
 callback of the IP Connection have a ``deviceIdentifier`` parameter to specify
 the Brick's or Bricklet's type.

