Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6711e020 authored by Martijn Coenen's avatar Martijn Coenen
Browse files

Improve NFC-F transceive() docs.

It wrongly said the SoD included the length;
put a sample frame in the docs to help devs.

Change-Id: I8ea74f37e7335f3e05f7df81fc303bf6195ac3cc
parent 7d72975c
Loading
Loading
Loading
Loading
+7 −2
Original line number Diff line number Diff line
@@ -98,8 +98,13 @@ public final class NfcF extends BasicTagTechnology {
    /**
     * Send raw NFC-F commands to the tag and receive the response.
     *
     * <p>Applications must not append the SoD (length) or EoD (CRC) to the payload,
     * it will be automatically calculated.
     * <p>Applications must not prefix the SoD (preamble and sync code)
     * and/or append the EoD (CRC) to the payload, it will be automatically calculated.
     *
     * <p>A typical NFC-F frame for this method looks like:
     * <pre>
     * LENGTH (1 byte) --- CMD (1 byte) -- IDm (8 bytes) -- PARAMS (LENGTH - 10 bytes)
     * </pre>
     *
     * <p>Use {@link #getMaxTransceiveLength} to retrieve the maximum amount of bytes
     * that can be sent with {@link #transceive}.