Merge pull request #1 from ArbiGunbardhi/main

First release

Author: cparata

.github/workflows/Continuous-Integration.yml

@@ -0,0 +1,71 @@
+name: X-NUCLEO-NFC08A1 Continuous Integration
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '*'
+      - '**.md'
+      - '**.txt'
+  pull_request:
+    paths-ignore:
+      - '*'
+      - '**.md'
+      - '**.txt'
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+jobs:
+  astyle_check:
+    runs-on: ubuntu-latest
+    name: AStyle check
+    steps:
+    # First of all, clone the repo using the checkout action.
+    - name: Checkout
+      uses: actions/checkout@master
+
+    - name: Astyle check
+      id: Astyle
+      uses: stm32duino/actions/astyle-check@main
+
+    # Use the output from the `Astyle` step
+    - name: Astyle Errors
+      if: failure()
+      run: |
+        cat ${{ steps.Astyle.outputs.astyle-result }}
+        exit 1
+  codespell:
+    name: Check for spelling errors
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@main
+
+    # See: https://github.com/codespell-project/actions-codespell/blob/master/README.md
+    - name: Spell check
+      uses: codespell-project/actions-codespell@master
+      with:
+        check_filenames: true
+        check_hidden: true
+        # In the event of a false positive, add the word in all lower case to this file:
+        ignore_words_file: ./extras/codespell-ignore-words-list.txt
+  lib_build:
+    runs-on: ubuntu-latest
+    name: Library compilation
+    steps:
+    # First of all, clone the repo using the checkout action.
+    - name: Checkout
+      uses: actions/checkout@master
+
+    - name: Compilation
+      id: Compile
+      uses: stm32duino/actions/compile-examples@master
+      with:
+        board-pattern: "NUCLEO_L476RG"
+        libraries: "STM32duino NFC-RFAL, STM32duino ST25R3916"
+
+    # Use the output from the `Compile` step
+    - name: Compilation Errors
+      if: failure()
+      run: |
+        cat ${{ steps.Compile.outputs.compile-result }}
+        exit 1

LICENSE

@@ -0,0 +1,80 @@
+SLA0052 - Rev3 - June 2019
+Software license agreement
+
+SOFTWARE PACKAGE LICENSE AGREEMENT ("Agreement")
+BY CLICKING ON THE "I ACCEPT" BUTTON OR BY UNZIPPING, INSTALLING, COPYING, DOWNLOADING, ACCESSING
+OR OTHERWISE USING THIS SOFTWARE PACKAGE (HEREINAFTER "SOFTWARE PACKAGE" MEANS THE RELATED
+SOFTWARE, DOCUMENTATION, OTHER MATERIALS, AND ANY PARTS, PERMITTED MODIFICATIONS, AND PERMITTED
+DERIVATIVES THEREOF) FROM STMICROELECTRONICS INTERNATIONAL N.V, SWISS BRANCH AND/OR ITS
+AFFILIATED COMPANIES ("STMICROELECTRONICS"), THE RECIPIENT, ON BEHALF OF HIMSELF OR HERSELF, OR ON
+BEHALF OF ANY ENTITY BY WHICH SUCH RECIPIENT IS EMPLOYED AND/OR ENGAGED ("YOU") AGREES TO BE
+BOUND BY THIS AGREEMENT.
+
+You represent that you have the authority to enter into this Agreement. You will comply with all laws, 
+including export laws. STMicroelectronics's failure or delay to enforce this Agreement does not waive 
+STMicroelectronics's rights. Swiss law, except conflict of laws, governs this Agreement, and the parties 
+consent to exclusive jurisdiction of courts in Switzerland for litigation of this Agreement.
+Subject to the below disclaimer, applicable Third Party Terms (defined below), and applicable Open Source Terms 
+(defined below), the redistribution, reproduction and use in source and binary forms of the software package 
+or any part thereof, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistribution of source code (modified or not) must retain any copyright notice, this list of conditions 
+and the following disclaimer.
+
+2. Redistributions in binary form, except as embedded into a microcontroller or microprocessor device or a 
+software update for such device, must reproduce any copyright notice, this list of conditions and the following 
+disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of STMicroelectronics nor the names of other contributors to this software package may be 
+used to endorse or promote products using or derived from this software package without specific written 
+permission.
+
+4. This software package must be used and execute solely and exclusively in combination with an integrated 
+circuit that is manufactured by or for STMicroelectronics and is an NFC tag, NFC dynamic tag, NFC reader, 
+or UHF reader.
+
+5. No use, reproduction or redistribution of this software package may be done in any manner that would subject 
+this software package to any Open Source Terms (as defined below).
+
+6. Some portion of the software package may contain software subject to Open Source Terms (as defined below) 
+applicable for each such portion ("Open Source Software"), as further specified in the software package. 
+Such Open Source Software is supplied under the applicable Open Source Terms and is not subject to this list 
+of conditions, but is subject to the following disclaimer. "Open Source Terms" shall mean any open source 
+license which requires as part of distribution of software that the source code of such software is distributed 
+therewith or otherwise made available, or open source license that substantially complies with the Open Source 
+definition specified at www.opensource.org and any other comparable open source license such as for example 
+GNU General Public License (GPL), Eclipse Public License (EPL), Apache Software License, BSD license and MIT 
+license.
+
+7. This software package may also include third party software as expressly specified in the software package, 
+which shall be subject to applicable third party license terms ("Third Party Terms"). Such Third Party Terms 
+may be specified in any reasonable manner, including, without limitation, by being fully set forth, referred to, 
+or hyperlinked in the software package source code, documentation, license file, or readme file. Such third 
+party software is supplied under Third Party Terms and is not subject to this list of conditions, but is subject 
+to the following disclaimer. By unzipping, installing, copying, downloading, accessing or otherwise using any 
+third party software included in this software package, the recipient agrees to be bound by the corresponding 
+Third Party Terms.
+
+8. STMicroelectronics has no obligation to provide any maintenance, support or updates for the software package.
+
+9. The software package is and will remain the exclusive property of STMicroelectronics and its licensors. 
+The recipient will not take any action that jeopardizes STMicroelectronics and its licensors' proprietary rights 
+or acquire any rights in the software package, except the limited rights specified hereunder.
+
+10. Redistribution and use of this software package partially or any part thereof other than as permitted under 
+this license is void and will automatically terminate your rights under this license.
+
+DISCLAIMER
+THIS SOFTWARE PACKAGE IS PROVIDED BY STMICROELECTRONICS AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS, IMPLIED OR STATUTORY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT OF THIRD PARTY
+INTELLECTUAL PROPERTY RIGHTS ARE DISCLAIMED TO THE FULLEST EXTENT PERMITTED BY LAW. IN NO EVENT
+SHALL STMICROELECTRONICS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE PACKAGE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.
+EXCEPT AS EXPRESSLY PERMITTED HEREUNDER, SUBJECT TO ANY APPLICABLE THIRD PARTY TERMS AND OPEN
+SOURCE TERMS, NO LICENSE OR OTHER RIGHTS, WHETHER EXPRESS OR IMPLIED, ARE GRANTED UNDER ANY
+PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS OF STMICROELECTRONICS OR ANY THIRD PARTY.

README.md

@@ -1,2 +1,31 @@
 # X-NUCLEO-NFC08A1
-Arduino library to support NFC card reader expansion board based on ST25R3916B
+
+The code has been designed for ST X-NUCLEO-NFC08A1 expansion board to show how to detect, read and write NFC tags.
+The X-NUCLEO-NFC08A1 is an NFC card reader evaluation board based on ST25R3916B to enable expansion of the STM32 Nucleo boards.
+The ST25R3916B manages frame coding and decoding in Reader mode for standard applications, such as NFC, proximity and vicinity HF RFID standards.
+The ST25R3916B supports ISO/IEC 14443 Type A and B, ISO/IEC 15693 (single Subcarrier only) and ISO/IEC 18092 communication protocols. 
+It also supports the detection, reading and writing of NFC Forum Type 1, 2, 3, 4 and 5 tags.
+
+## Examples
+
+There is one example with the X-NUCLEO-NFC08A1 library: 
+* X_NUCLEO_NFC08A1_HelloWorld: This application is to show how to detect, read and write NFC Forum Type 1, 2, 3, 4 and 5 tags.
+  Open a serial terminal with a baudrate of 115200, 8 data bits, No parity bit, 1 stop bit and follow the instructions shown by the menu.
+  Pushing the User Button, you can switch to several options like writing a text record, writing a URI record and an Android Application record, 
+  formatting an ST tag or reading the content of a tag.  
+
+# Dependencies
+
+The X-NUCLEO-NFC08A1 library requires the following STM32duino libraries:
+
+* STM32duino NFC-RFAL: https://github.com/stm32duino/NFC-RFAL
+* STM32duino ST25R3916: https://github.com/stm32duino/ST25R3916
+
+## Documentation
+
+You can find the source files at  
+https://github.com/stm32duino/X-NUCLEO-NFC08A1
+
+The ST25R3916B datasheet is available at  
+https://www.st.com/en/nfc/st25r3916b.html
+