<li><a href="#enable">Enabling and Disabling NFC</a></li>
<li><a href="#work">Working with NFC</a></li>
<li><a href="#get">Getting a Cached NFC Message</a></li>
- <li><a href="#hce">Using the HCE Feature</a></li>
+ <li><a href="#cardemulation">Using the Card_Emulation Feature</a></li>
+ <li><a href="#appcontrol">NFC Application Control</a></li>
</ul>
</li>
<li>NFC P2P bump
<p>Initialize NFC asynchronously, set the NFC tag filter, and register all necessary NFC callbacks.</p></li>
<li><a href="#get">Getting a Cached NFC Message</a>
<p>Initialize NFC synchronously and get a cached NFC message.</p></li>
- <li><a href="#hce">Using the HCE Feature</a>
- <p>Create a host-based card emulation (HCE) application.</p></li>
+ <li><a href="#cardemulation">Using the Card_Emulation Feature</a>
+ <p>Create a Card Emulation application.</p></li>
+ <li><a href="#appcontrol">NFC Application Control</a>
+ <p>Using NFC Application Control.</p></li>
</ul>
</li>
<li>NFC P2P bump
<p>In the NFC tutorial, the NFC API (in <a href="../../../../org.tizen.native.mobile.apireference/group__CAPI__NETWORK__NFC__MODULE.html">mobile</a> and <a href="../../../../org.tizen.native.wearable.apireference/group__CAPI__NETWORK__NFC__MODULE.html">wearable</a> applications) is used to write an application which initializes the NFC adapter and registers callbacks called in case of each connection scenario, so the user is able to work with NFC manually. By connecting your device to the other NFC point (tag, device, or sales terminal), you can invoke the specified callback registered earlier. The second scenario of this tutorial shows how to get the message cached by NFC.</p>
<p>To initialize NFC:</p>
-<ol><li>
-<p>To use the functions and data types of the NFC API, include the <span style="font-family: Courier New,Courier,monospace"><nfc.h></span> header file in your application:</p>
+<ol>
+<li><p>To use the functions and data types of the NFC API (in <a href="../../../../org.tizen.native.mobile.apireference/group__CAPI__NETWORK__NFC__MODULE.html">mobile</a> and <a href="../../../../org.tizen.native.wearable.apireference/group__CAPI__NETWORK__NFC__MODULE.html">wearable</a> applications), include the <span style="font-family: Courier New,Courier,monospace"><nfc.h></span> header file in your application:</p>
<pre class="prettyprint">
#include <nfc.h>
</pre></li>
<pre class="prettyprint">static void on_nfc_tag_read_completed(int error_code, nfc_ndef_message_h message, void *user_data)
{
- if (!found_error(NFC_ERROR_NONE, "nfc_manager_set_activation", error_code))
- nfc_ndef_message_read_cb(clone_message(message));
+ nfc_ndef_message_read_cb(clone_message(message));
}</pre>
<p>If there was no error (<span style="font-family: Courier New,Courier,monospace;">error_code == NFC_ERROR_NONE</span>), you can operate on the retrieved message. To present how to use other NFC API functionality, 2 additional functions have been presented. Firstly, clone the message by calling the <span style="font-family: Courier New,Courier,monospace;">clone_message()</span> function: </p>
<pre class="prettyprint">static nfc_ndef_message_h clone_message(nfc_ndef_message_h msg)
}</pre></li>
<li>Clean up at the application end.</li></ol>
- <h2 id="hce" name="hce">Using the HCE Feature</h2>
+ <h2 id="cardemulation" name="cardemulation">Using the Card Emulation Feature</h2>
-<p>To create a host-based card emulation (HCE) application:</p>
+<p>To create a Card Emulation application:</p>
-<ol><li>Initialize the HCE application:
+<ol><li>Initialize the Card Emulation application:
<ol type="a">
<li>
<p>To initialize NFC, use the <span style="font-family: Courier New,Courier,monospace;">nfc_manager_initialize()</span> function: </p>
return false;
}
</pre></li>
-<li>Specify a "AID" value for the application in the <span style="font-family: Courier New,Courier,monospace;">tizen-manifest.xml</span> file.</li>
+<li><p>Specify a "AID" value for the application. Next two step is required.</p>
+<br/>
+<p>1. To tell the platform which AIDs groups are requested by application, a metadata must be included in the manifest file.</p>
+<pre class="prettyprint"><?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns="http://tizen.org/ns/packages" api-version="2.3.1" package="org.tizen.basicuiapplication" version="1.0.0">
+ <profile name="wearable" />
+ <ui-application appid="org.tizen.basicuiapplication" exec="basicuiapplication" type="capp" multiple="false" taskmanage="true" nodisplay="false">
+ <icon>basicuiapplication.png</icon>
+ <label>basicuiapplication</label>
+ <metadata key="http://tizen.org/metadata/nfc_cardemulation" value="/shared/res/wallet.xml"/>
+ </ui-application>
+</manifest>
+</pre>
+<ul><li>The <metadata> is required to contain a <key> and <value> attribute. </li>
+<li> <key> attribute must be "http://tizen.org/metadata/nfc_cardemulation".</li>
+<li> <value> attribute contain the AID xml file path.</li>
+<p><value> attribute is a relative path starting from the app root path.</p>
+</ul>
+<br/>
+<p>2. meta-data tag points to an AID xml file. An example of this file with AID declaration is shown below :</p>
+<pre class="prettyprint"><?xml version="1.0" encoding="utf-8"?>
+ <application name = "org.tizen.basicuiapplication">
+ <wallet>
+ <aid-group category = "payment">
+ <aid aid = "325041592E5359532E4444463031" se_type = "hce" unlock = "false" power = "sleep"/>
+ </aid-group>
+ </wallet>
+ </application>
+</pre>
+<ul><li>The <application> is required to contain a <name> attribute that contains a application name.</li>
+<li>The <application> must contain one or more <wallet> tags.</li>
+<li>Each <wallet> must contain one or more <aid-group> tags. </li>
+<li>The <aid-group> is required to contain a <category> attribute that contains <payment> or <other>.</li>
+<li>Each <aid-group> must contain one or more <aid> tags, each of which contains a single AID.</li>
+<li>The<aid-group> can have as much as you want aid</li>
+<li>The <aid> is required to contain a <aid>, <se_type>, <unlock>, <power> attribute.</li>
+<li>The <se_type> must contains "hce" or "ese" or "uicc". se_type value can be added later.</li>
+<li>The <unlock> must contains "true" or "false".</li>
+<ul><li>"true" mean "Card can't work, when device is locked."</li>
+<li>"false" mean "Card can work, when device is locked."</li></ul>
+<li>The <power> must contains "on" or "off" or "sleep".</li>
+<ul><li>"on" mean "Card can work, when device is on."</li>
+<li>"off" mean "Card can work, when device is off."</li>
+<li>"sleep" mean "Card can work, when device is sleep."</li></ul>
+</li>
<li>The <span style="font-family: Courier New,Courier,monospace;">http://tizen.org/privilege/nfc.cardemulation</span> privilege is required for the HCE API. Add the privilege to the <span style="font-family: Courier New,Courier,monospace;">tizen-manifest.xml</span> file.</li></ol></li>
+<li>To create a Host based Card Emulation (HCE) application :
+<ol type="a">
<li>Define HCE event handling.
<p>The application must be able to handle an HCE event from the NFC reader. Define and register a callback that is triggered when data arrives from the NFC reader.</p>
<p>Use the <span style="font-family: Courier New,Courier,monospace;">nfc_hce_send_apdu_response()</span> function to send a response to the NFC reader. The actual data moving between the NFC reader and the application can be anything. The APDU protocol only defines as a promise between the application producer and NFC reader.</p>
return false;
}
-</pre></li>
+<p>When an application receives an app-control event, application can receive the aid value using the "data" appcontrol extra key.</p></li>
</ul></li>
<li>When HCE operations are no longer needed, deinitialize the resources:
<pre class="prettyprint">int ret = NFC_ERROR_NONE;
}
</pre></li></ol>
-<p>The following example shows the entire sample code:</p>
+<p>The following example shows the entire HCE application sample code:</p>
<pre class="prettyprint">
#include <service_app.h>
return service_app_main(argc, argv, &event_callback, ad);
}
+</pre></ol>
+
+<h2 id="appcontrol" name="appcontrol">NFC Application Control</h2>
+ <p>NFC application controls are kinds of event sent by the system to applications when NFC-based payment transaction occurs.</p>
+ <p>To receive these events, you are required to define the application control information in the <strong>Application Control</strong> tab of the manifest editor.</p>
+
+ <p> The platform supports the following application controls for NFC applications: </p>
+ <p> <span style="font-family: Courier New,Courier,monospace">http://tizen.org/appcontrol/operation/nfc/card_emulation/default_changed</span> and <span style="font-family: Courier New,Courier,monospace">http://tizen.org/appcontrol/operation/nfc/card_emulation/host_apdu_service</span> and <span style="font-family: Courier New,Courier,monospace">http://tizen.org/appcontrol/operation/nfc/card_emulation/off_host_apdu_service</span> operations.</p>
+
+<h3>default_changed operation</h3>
+ <p>The application control with <span style="font-family: Courier New,Courier,monospace">http://tizen.org/appcontrol/operation/nfc/card_emulation/default_changed</span> is sent by the system when the default wallet is changed.</p><p>For example, in <strong>Setting > NFC > Set Default Wallet App</strong>, if the default wallet is changed, an application control with this operation will be sent to the selected application (wallet).</p>
+
+ <p>You have to define the <span style="font-family: Courier New,Courier,monospace">app_control_cb()</span> callback and register it to <span style="font-family: Courier New,Courier,monospace">ui_app_lifecycle_callback::app_control</span>.</p>
+ <br/>
+
+<h3>host_apdu_service operation</h3>
+ <p>The application control with <span style="font-family: Courier New,Courier,monospace">http://tizen.org/appcontrol/operation/nfc/card_emulation/host_apdu_service</span> operation is sent by the system when HCE event occurs.</p> <p>For example, when a mobile device receives Host based apdu (HCE) event from POS terminal, an application control with this operation will be sent to NFC applications. </p>
+<p>You can get the target AID information using app_control_get_extra_data() with "data" key. </p>
+
+ <p>You have to define the <span style="font-family: Courier New,Courier,monospace">app_control_cb()</span> callback and register it to <span style="font-family: Courier New,Courier,monospace">ui_app_lifecycle_callback::app_control</span>.</p>
+
+ <p>The following table shows the information comes packaged when the <span style="font-family: Courier New,Courier,monospace">http://tizen.org/appcontrol/operation/nfc/card_emulation/host_apdu_service</span> operation is launching.</p>
+ <table border="1">
+ <caption>
+ Table: host_apdu_service extra key
+ </caption>
+
+ <tbody>
+ <tr>
+ <th style="text-align:center;margin-left:auto;margin-right:auto;">Extra key</th>
+ <th style="text-align:center;margin-left:auto;margin-right:auto;">Description</th>
+ </tr>
+ <tr>
+ <td><span style="font-family: Courier New,Courier,monospace">data</span></td>
+ <td>Target AID key</td>
+ </tr>
+ </tbody>
+ </table>
+<br/>
+<h3>off_host_apdu_service operation</h3>
+ <p>The application control with <span style="font-family: Courier New,Courier,monospace">http://tizen.org/appcontrol/operation/nfc/card_emulation/off_host_apdu_service</span> operation is sent by the system when SE transaction occurs.</p><p>For example, when a mobile device receives Off-Host apdu event from POS terminal, an application control with this operation will be sent to NFC applications.</p>
+<p>You can get the target AID information using app_control_get_extra_data() with "data" key.</p>
+
+ <p>You have to define the <span style="font-family: Courier New,Courier,monospace">app_control_cb()</span> callback and register it to <span style="font-family: Courier New,Courier,monospace">ui_app_lifecycle_callback::app_control</span>.</p>
+
+ <p>The following table shows the information comes packaged when the <span style="font-family: Courier New,Courier,monospace">http://tizen.org/appcontrol/operation/nfc/card_emulation/off_host_apdu_service</span> operation is launching.</p>
+ <table border="1">
+ <caption>
+ Table: off_host_apdu_service extra key
+ </caption>
+
+ <tbody>
+ <tr>
+ <th style="text-align:center;margin-left:auto;margin-right:auto;">Extra key</th>
+ <th style="text-align:center;margin-left:auto;margin-right:auto;">Description</th>
+ </tr>
+ <tr>
+ <td><span style="font-family: Courier New,Courier,monospace">data</span></td>
+ <td>Target AID key</td>
+ </tr>
+ </tbody>
+ </table>
+ <br/>
+<h3>Application control example</h3>
+<p>To tell the platform which application is register the opeartion, a operation must be included in the manifest file.</p>
+<pre class="prettyprint"><?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns="http://tizen.org/ns/packages" api-version="2.3.1" package="org.tizen.basicuiapplication" version="1.0.0">
+ <profile name="wearable" />
+ <ui-application appid="org.tizen.basicuiapplication" exec="basicuiapplication" type="capp" multiple="false" taskmanage="true" nodisplay="false">
+ <icon>basicuiapplication.png</icon>
+ <label>basicuiapplication</label>
+ <app-control>
+ <operation name="http://tizen.org/appcontrol/operation/nfc/card_emulation/default_changed"/>
+ <operation name="http://tizen.org/appcontrol/operation/nfc/card_emulation/host_apdu_service"/>
+ <operation name="http://tizen.org/appcontrol/operation/nfc/card_emulation/off_host_apdu_service"/>
+ </app-control>
+ </ui-application>
+</manifest>
</pre>
+<p>The code of the NFC application control is presented below: </p>
+<pre class="prettyprint">
+...
+bool service_app_control(app_control_h service, void *data)
+{
+ struct _appdata *ad = user_data;
+ char *operation, *aid;
+ int ret = 0;
+
+ app_control_get_operation(service, &operation);
+ if ((strncmp(operation, NFC_APPCONTROL_STRING, strlen(NFC_APPCONTROL_STRING)) == 0)) {
+ dlog_print(DLOG_INFO, "HCETESTAPP", "nfc appcontrol operation : [%s]", operation);
+ app_control_get_extra_data(service, "data", &aid);
+ dlog_print(DLOG_INFO, "HCETESTAPP", "nfc appcontrol uri : [%s]", aid);
+ }
+}
+...
+int main(int argc, char* argv[])
+{
+ char ad[50] = {0,};
+ service_app_event_callback_s event_callback;
+
+ event_callback.create = service_app_create;
+ event_callback.terminate = service_app_terminate;
+ event_callback.app_control = service_app_control;
+ event_callback.low_memory = service_app_low_memory_callback;
+ event_callback.low_battery = service_app_low_battery_callback;
+
+ return service_app_main(argc, argv, &event_callback, ad);
+}
+</pre>
<h2 id="init_p2p" name="init_p2p">Initializing NFC P2P</h2>
<p class="footer">Except as noted, this content - excluding the Code Examples - is licensed under <a href="http://creativecommons.org/licenses/by/3.0/legalcode" target="_blank">Creative Commons Attribution 3.0</a> and all of the Code Examples contained herein are licensed under <a href="https://www.tizen.org/bsd-3-clause-license" target="_blank">BSD-3-Clause</a>.<br/>For details, see the <a href="https://www.tizen.org/content-license" target="_blank">Content License</a>.</p>
</div>
- <script type="text/javascript">\r
-var _gaq = _gaq || [];\r
-_gaq.push(['_setAccount', 'UA-25976949-1']);\r
-_gaq.push(['_trackPageview']);\r
-(function() {\r
-var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
-ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
-var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
-})();\r
+ <script type="text/javascript">
+var _gaq = _gaq || [];
+_gaq.push(['_setAccount', 'UA-25976949-1']);
+_gaq.push(['_trackPageview']);
+(function() {
+var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+})();
</script>
</body>
-</html>
+</html>
\ No newline at end of file
projects / sdk / online-doc.git / commitdiff