Skip to content

Commit 847482b

Browse files
mdwoolleymdwoolley
committed
readme file dependencies updated
1 parent 6d865d9 commit 847482b

File tree

2 files changed

+134
-2
lines changed

2 files changed

+134
-2
lines changed

‎NfcTool/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0.html).
3333

3434
**Dependencies**
3535

36-
1. BlackBerry Dev Alpha Device Software **10.0.6**
37-
2. BlackBerry 10 Native SDK **10.0.6**
36+
1. BlackBerry Dev Alpha Device Software **10.0.9**
37+
2. BlackBerry 10 Native SDK **10.0.9**
3838

3939
**How to Build NfcTool**
4040

‎NfcTool/README.md.bak‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# NFC Tag Reading and Writing Sample
2+
3+
The purpose of this application is to demonstrate how to use selected
4+
BlackBerry 10 NFC APIs. The Release History section gives details of
5+
those NFC APIs which are covered.
6+
7+
The sample code for this application is Open Source under
8+
the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0.html).
9+
10+
**Applies To**
11+
12+
* [Cascades for BlackBerry 10](https://bdsc.webapps.blackberry.com/cascades/)
13+
* [BlackBerry Native SDK for Tablet OS](https://bdsc.webapps.blackberry.com/native/)
14+
15+
**Author(s)**
16+
17+
* [John Murray](https://github.com/jcmurray)
18+
* [Martin Woolley](https://github.com/mdwoolley)
19+
20+
21+
**Release History**
22+
* **V3.1** - Modified for Beta 3 release compatibility
23+
* **V3** - Added ability to emulate virtual NDEF Tags
24+
* **V3** - Added ability to emulate virtual NDEF Tags
25+
* **V2.1** - Refactored to exploit features in BlackBerry Dev Alpha Device 10.0.6
26+
* **V2** - Added transfer of vCard using SNEP
27+
* **V1** - Reading and Writing NDEF tags
28+
29+
**Known Issues**
30+
1. Reading a tag when the app is not running causes the app to be launched but the event log is not automatically switched to. Read tag with app already running
31+
and the event log is correctly shown.
32+
2. Work is in progress to add functionality relating to UICC secure element APIs. This is not yet complete and so the code is not yet connected to the UI.
33+
34+
**Dependencies**
35+
36+
1. BlackBerry Dev Alpha Device Software **10.0.6**
37+
2. BlackBerry 10 Native SDK **10.0.6**
38+
39+
**How to Build NfcTool**
40+
41+
We took the decision to distribute only the contents of the **"src/"** and **"assets/"**
42+
directories along with the **"NfcTool.pro"** file with this example.
43+
44+
We've found it to be the more reliable technique whilst the meta-data associated with
45+
an NDK project is still subject to change between versions of the NDK. You are less
46+
likely to run into issues with a project if you create it as a new empty project
47+
in your workspace and copy files into it rather than import a project with a
48+
structure from an older version of the IDE.
49+
50+
Here's what you should do:
51+
52+
* Create a new empty Cascades C++ project in your workspace called **"NfcTool"**
53+
* **File** > **New** > BlackBerry Cascades C++ Project
54+
* Enter Project Name: **NfcTool** > **Next**
55+
* Select: **Standard empty project** > **Finish**
56+
* You've now got a clean project set up appropriately for your version of the IDE
57+
* Delete the **"app.cpp"** and **"app.hpp"** files from the project's **"src/"** directory -- we don't need them
58+
* Replace contents of the **"src/"** and **"assets/"** directories in the project by the contents of **"src/"** and **"assets/"* from this repo
59+
* Replace **"NfcTool.pro"** in the project by the one in this repo
60+
* This file just ensure that the **"libnfc.so"** and **"libnfc_bps.so"** libraries are available to the build process since they're not included in the library path by default.
61+
* You'll also now have a **"bar-descriptor.xml"** which is correct for your verion of the IDE.
62+
* You need to make sure it's populated with your own **Debug Token**
63+
* Also, if you want to ensure that the application has the correct icon and startup splash screen (I'm sure you do!) open the **"bar-descriptor.xml"** file, select the **"Application"** tab and choose:
64+
* **"assets/images/generic\_tag.png"** as the **Icon image**
65+
* **"assets/images/splash\_landscape.png"** and **"assets/images/splash.png"** as the **"Landscape"** and **"Portrait"** splash screen images respectively.
66+
* In BlackBerry Dev Alpha Device Software 10.0.6 the **Invocation Framework** is now used to register an application to be notified when an NFC NDEF tag is presented to the device. You need to add this registration to your **"bar-descriptor.xml"** file. The registration that we use in this sample application is shown in the code section below.
67+
68+
Add this stanza to your **"bar-descriptor.xml"** file at the end, just before the closing **"</qnx>"** tag. The meaning of the various fields is described in the article that accompanies this code sample.
69+
70+
- - -
71+
...
72+
<invoke-target id="com.example.NfcTool">
73+
<type>APPLICATION</type>
74+
<filter>
75+
<action>bb.action.OPEN</action>
76+
<mime-type>application/vnd.rim.nfc.ndef.1.Sp</mime-type>
77+
</filter>
78+
<filter>
79+
<action>bb.action.OPEN</action>
80+
<mime-type>application/vnd.rim.nfc.ndef.1.T</mime-type>
81+
</filter>
82+
<filter>
83+
<action>bb.action.OPEN</action>
84+
<mime-type>application/vnd.rim.nfc.ndef.1.U</mime-type>
85+
</filter>
86+
</invoke-target>
87+
...
88+
- - -
89+
90+
91+
**But I don't want to build it myself**
92+
93+
If you don't want to build this sample application yourself we've included a
94+
pre-build and signed BAR files for each version. You can find them in the
95+
folder "installable-bar-files" as follows:
96+
97+
* **NfcTool-3\_0\_0\_51.bar** -- Signed BAR file for Version 3.0 (V3.0) of the application ( requires BlackBerry Dev Alpha Device Software 10.0.6 )
98+
* **NfcTool-2\_1\_0\_2.bar** -- Signed BAR file for Version 2.1 (V2.1) of the application ( requires BlackBerry Dev Alpha Device Software 10.0.6 )
99+
* **NfcTool-2\_0\_0\_1.bar** -- Signed BAR file for Version 2 (V2) of the application ( requires BlackBerry Dev Alpha Device Software 10.0.4 )
100+
* **NfcTool-1\_0\_0\_1.bar** -- Signed BAR file for Version 1 (V1) of the application ( requires BlackBerry Dev Alpha Device Software 10.0.4 )
101+
102+
**Known Issues**
103+
104+
None
105+
106+
**To contribute code to this repository you must be [signed up as an
107+
official contributor](http://blackberry.github.com/howToContribute.html).**
108+
109+
110+
## Contributing Changes
111+
112+
Please see the [README](https://github.com/blackberry/Cascades-Community-Samples/blob/master/README.md)
113+
of the Cascades-Community-Samples repository for instructions on how to add new Samples or
114+
make modifications to existing Samples.
115+
116+
117+
## Bug Reporting and Feature Requests
118+
119+
If you find a bug in a Sample, or have an enhancement request, simply file
120+
an [Issue](https://github.com/blackberry/Cascades-Community-Samples/issues) for
121+
the Sample and send a message (via github messages) to the Sample Author(s) to let
122+
them know that you have filed an [Issue](https://github.com/blackberry/Cascades-Community-Samples/issues).
123+
124+
125+
## Disclaimer
126+
127+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
128+
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
129+
AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
130+
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
131+
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
132+
OTHER DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)