Example application for the STMicroelectronics X-NUCLEO-NFC05A1

Dependencies:   RFAL ST25R3911 BSP05

Files at this revision

API Documentation at this revision

Comitter:
DiegoOstuni
Date:
Thu Nov 14 14:45:52 2019 +0000
Parent:
1:86504e1ac6b1
Commit message:
Update library references and readme

Changed in this revision

BSP05.lib Show annotated file Show diff for this revision Revisions of this file
README.md Show annotated file Show diff for this revision Revisions of this file
RFAL.lib Show annotated file Show diff for this revision Revisions of this file
ST25R3911.lib Show annotated file Show diff for this revision Revisions of this file
--- a/BSP05.lib	Thu Nov 14 14:30:59 2019 +0000
+++ b/BSP05.lib	Thu Nov 14 14:45:52 2019 +0000
@@ -1,1 +1,1 @@
-https://github.com/DiegoOst/BSP05.git/#6df9fa27a4702b817fd42275574e0ca98d77b615
+https://os.mbed.com/users/DiegoOstuni/code/BSP05/#8e1d760507b5
--- a/README.md	Thu Nov 14 14:30:59 2019 +0000
+++ b/README.md	Thu Nov 14 14:45:52 2019 +0000
@@ -1,64 +1,23 @@
-![](./resources/official_armmbed_example_badge.png)
-# Blinky Mbed OS example
-
-The example project is part of the [Arm Mbed OS Official Examples](https://os.mbed.com/code/) and is the [getting started example for Mbed OS](https://os.mbed.com/docs/mbed-os/v5.14/quick-start/index.html). It contains an application that repeatedly blinks an LED on supported [Mbed boards](https://os.mbed.com/platforms/).
-
-You can build the project with all supported [Mbed OS build tools](https://os.mbed.com/docs/mbed-os/latest/tools/index.html). However, this example project specifically refers to the command-line interface tool [Arm Mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
-(Note: To see a rendered example you can import into the Arm Online Compiler, please see our [import quick start](https://os.mbed.com/docs/mbed-os/latest/quick-start/online-with-the-online-compiler.html#importing-the-code).)
-
-1. [Install Mbed CLI](https://os.mbed.com/docs/mbed-os/latest/quick-start/offline-with-mbed-cli.html).
-
-1. Clone this repository on your system, and change the current directory to where the project was cloned:
+# mbed-os-nfc05a1
+mbed-os-nfc05a1 is the the demo application for the STMicroelectronics X-NUCLEO-NFC05A1 expansion board.
+# Overview
+This repository include some files and libraries useful to communicate with the X-NUCLEO-NFC05A1.
+The following libraries have been used:
 
-    ```bash
-    $ git clone git@github.com:armmbed/mbed-os-example-blinky && cd mbed-os-example-blinky
-    ```
-
-    Alternatively, you can download the example project with Arm Mbed CLI using the `import` subcommand:
+- BSP05
+- RFAL
+- ST25R3911
 
-    ```bash
-    $ mbed import mbed-os-example-blinky && cd mbed-os-example-blinky
-    ```
-
-
-## Application functionality
-
-The `main()` function is the single thread in the application. It toggles the state of a digital output connected to an LED on the board.
-
-## Building and running
+Furthermore the package includes some feature:
 
-1. Connect a USB cable between the USB port on the board and the host computer.
-2. <a name="build_cmd"></a> Run the following command to build the example project and program the microcontroller flash memory:
-    ```bash
-    $ mbed compile -m <TARGET> -t <TOOLCHAIN> --flash
-    ```
-The binary is located at `./BUILD/<TARGET>/<TOOLCHAIN>/mbed-os-example-blinky.bin`.
-
-Alternatively, you can manually copy the binary to the board, which you mount on the host computer over USB.
-
-Depending on the target, you can build the example project with the `GCC_ARM`, `ARM` or `IAR` toolchain. After installing Arm Mbed CLI, run the command below to determine which toolchain supports your target:
-
-```bash
-$ mbed compile -S
-```
-
-## Expected output
-The LED on your target turns on and off every 500 milliseconds.
-
-
-## Troubleshooting
-If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.
-
-## Related Links
-
-* [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html).
-* [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html).
-* [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html).
-* [Mbed OS bare metal](https://os.mbed.com/docs/mbed-os/latest/reference/mbed-os-bare-metal.html).
-* [Mbed boards](https://os.mbed.com/platforms/).
-
-### License and contributions
-
-The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see contributing.md for more info.
-
-This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.
+- NFC05A1 class containing methods to turn ON and OFF the expansion board LEDs
+- Initialization of the SPI and the RFAL Analog Configuration Settings
+  
+# Tested Platforms
+This firmware has been tested on STM32 NUCLEO-F401RE
+# Example Application
+mbed-os-nfc05a1 program gives the user the possibility
+ to read the URI information written on the expansion board. The LEDs will blink for few seconds 
+ to indicate that the board is initializing. 
+ As soon as it finishes, the device is ready to communicate with
+ external NFC devices. LED6 will blink until an NFC device is close to it and ready to read the URI value.
\ No newline at end of file
--- a/RFAL.lib	Thu Nov 14 14:30:59 2019 +0000
+++ b/RFAL.lib	Thu Nov 14 14:45:52 2019 +0000
@@ -1,1 +1,1 @@
-https://github.com/DiegoOst/RFAL.git/#4d050bf2084f1c89746f4ad4a51542c64d555193
+https://os.mbed.com/users/DiegoOstuni/code/RFAL/#75fc82583a41
--- a/ST25R3911.lib	Thu Nov 14 14:30:59 2019 +0000
+++ b/ST25R3911.lib	Thu Nov 14 14:45:52 2019 +0000
@@ -1,1 +1,1 @@
-https://github.com/DiegoOst/ST25R3911/#8617391c1606b9e3a65345e9cc60c67197075724
+https://os.mbed.com/users/DiegoOstuni/code/ST25R3911/#98fcd1266df0