Add examples: HelloWorld and SimpleWrite

README.md

@@ -27,6 +27,30 @@ It is then possible to read/write NFC URI:
 ```
 
 
+## Examples
+
+There are 2 examples with the ST25DV library:
+* ST25DV_HelloWorld: This application writes a URI tag on the device. It records an URI.
+
+When the NFC module is started and ready, the message "Sytstem init done!" is displayed on the monitor window.
+Next, the tag is written, we wait few seconds, we read the same tag and print it on the monitor window.
+
+You can test this application by connecting it with your smartphone.
+On Android, download a NFC Tools. Then start the app, check if NFC is activated
+on your smartphone. Put your smartphone near the tag, you can read it. You can
+write a tag with this app.
+
+* ST25DV_SimpleWrite: This application writes a NDEF message, containing a URI record, to the tag.
+
+When the NFC module is started and ready, the message "System init done!" is displayed on the monitor window.
+Next, the tag is written with a URI.
+
+You can test this application by tapping the tag with your smartphone.
+On Android, check if NFC is activated on your smartphone.
+Put your smartphone near the tag to read it.
+The preferred Internet Browser is automatically opened with the provided URI.
+
+
 ## Documentation
 
 You can find the source files at

examples/ST25DV_HelloWorld/ST25DV_HelloWorld.ino

@@ -0,0 +1,130 @@
+/**
+ ******************************************************************************
+ * @file    ST25DV_HelloWorld.ino
+ * @author  STMicroelectronics
+ * @version V1.0.0
+ * @date    22 November 2017
+ * @brief   Arduino test application for the STMicrolectronics
+ *          ST25DV NFC device.
+ *          This application makes use of C++ classes obtained from the C
+ *          components' drivers.
+ ******************************************************************************
+ * @attention
+ *
+ * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *   1. Redistributions of source code must retain the above copyright notice,
+ *      this list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above 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 its contributors
+ *      may be used to endorse or promote products derived from this software
+ *      without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ ******************************************************************************
+ */
+
+/**
+******************************************************************************
+* How to use this sketch
+*
+* This sketch uses the I2C interface to communicate with the NFC device.
+* It writes an NFC tag type URI (Uniform Resource Identifier) and reads this same tag.
+* Choose the uri by changing the content of uri_write.
+*
+* When the NFC module is started and ready, the message "Sytstem init done!" is
+* displayed on the monitor window. Next, the tag is written, read and printed on
+* the monitor window.
+*
+* You can also use your smartphone to read/write a tag.
+* On Android, download a NFC Tools. Then start the app, check if NFC is activated
+* on your smartphone. Put your smartphone near the tag, you can read it. You can
+* write a tag with this app.
+******************************************************************************
+*/
+
+#include "ST25DVSensor.h"
+
+#define SerialPort      Serial
+
+#if defined(ARDUINO_B_L4S5I_IOT01A)
+// Pin definitions for board B-L4S5I_IOT01A
+#define GPO_PIN PE4
+#define LPD_PIN PE2
+#define SDA_PIN PB11
+#define SCL_PIN PB10
+
+#define WireNFC MyWire
+TwoWire MyWire(SDA_PIN, SCL_PIN);
+
+#else
+// Please define the pin and wire instance used for your board
+// #define GPO_PIN PE4
+// #define LPD_PIN PE2
+// #define SDA_PIN PB11
+// #define SCL_PIN PB10
+
+#define WireNFC Wire // Default wire instance
+
+#endif
+
+#if !defined(GPO_PIN) || !defined(LPD_PIN)
+#error define the pin and wire instance used for your board
+#endif
+
+
+void setup() {
+  const char uri_write_message[] = "st.com/st25";       // Uri message to write in the tag
+  const char uri_write_protocol[] = URI_ID_0x01_STRING; // Uri protocol to write in the tag
+  String uri_write = String(uri_write_protocol) + String(uri_write_message);
+  String uri_read;
+
+  // Initialize serial for output.
+  SerialPort.begin(115200);
+
+  // The wire instance used can be omited in case you use default Wire instance
+  if(st25dv.begin(GPO_PIN, LPD_PIN, &WireNFC) == 0) {
+    SerialPort.println("System Init done!");
+  } else {
+    SerialPort.println("System Init failed!");
+    while(1);
+  }
+
+  if(st25dv.writeURI(uri_write_protocol, uri_write_message, "")) {
+    SerialPort.println("Write failed!");
+    while(1);
+  }
+
+  delay(100);
+
+  if(st25dv.readURI(&uri_read)) {
+    SerialPort.println("Read failed!");
+    while(1);
+  }
+
+  SerialPort.println(uri_read.c_str());
+
+  if(strcmp(uri_read.c_str(), uri_write.c_str()) == 0) {
+    SerialPort.println("Successfully written and read!");
+  } else {
+    SerialPort.println("Read bad string!");
+  }
+}
+
+void loop() {  
+  //empty loop
+} 

examples/ST25DV_SimpleWrite/ST25DV_SimpleWrite.ino

@@ -0,0 +1,119 @@
+/**
+ ******************************************************************************
+ * @file    ST25DV_SimpleWrite.ino
+ * @author  STMicroelectronics
+ * @version V1.0.0
+ * @date    22 November 2017
+ * @brief   Arduino test application for the STMicrolectronics
+ *          ST25DV NFC device.
+ *          This application makes use of C++ classes obtained from the C
+ *          components' drivers.
+ ******************************************************************************
+ * @attention
+ *
+ * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *   1. Redistributions of source code must retain the above copyright notice,
+ *      this list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above 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 its contributors
+ *      may be used to endorse or promote products derived from this software
+ *      without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ ******************************************************************************
+ */
+
+/**
+******************************************************************************
+* How to use this sketch
+*
+* This sketch uses the I2C interface to communicate with the NFC device.
+* It writes an NFC tag type URI (Uniform Resource Identifier).
+* Choose the uri by changing the content of uri_write.
+*
+* When the NFC module is started and ready, the message "Sytstem init done!" is
+* displayed on the monitor window. Next, the tag is written with the content 
+* printed on the monitor window.
+*
+* You can use your smartphone to read the tag.
+* On Android, check if NFC is activated on your smartphone. 
+* Put your smartphone near the tag to natively read it. 
+* The preferred Internet Browser is automatically opened with the provided URI.
+******************************************************************************
+*/
+
+
+#include "ST25DVSensor.h"
+
+#define SerialPort      Serial
+
+#if defined(ARDUINO_B_L4S5I_IOT01A)
+// Pin definitions for board B-L4S5I_IOT01A
+#define GPO_PIN PE4
+#define LPD_PIN PE2
+#define SDA_PIN PB11
+#define SCL_PIN PB10
+
+#define WireNFC MyWire
+TwoWire MyWire(SDA_PIN, SCL_PIN);
+
+#else
+// Please define the pin and wire instance used for your board
+// #define GPO_PIN PE4
+// #define LPD_PIN PE2
+// #define SDA_PIN PB11
+// #define SCL_PIN PB10
+
+#define WireNFC Wire // Default wire instance
+
+#endif
+
+#if !defined(GPO_PIN) || !defined(LPD_PIN)
+#error define the pin and wire instance used for your board
+#endif
+
+#if !defined(GPO_PIN) || !defined(LPD_PIN)
+#error define the pin and wire instance used for your board
+#endif
+
+void setup() {
+  const char uri_write_message[] = "st.com/st25";       // Uri message to write in the tag
+  const char uri_write_protocol[] = URI_ID_0x01_STRING; // Uri protocol to write in the tag
+  String uri_write = String(uri_write_protocol) + String(uri_write_message);
+
+  // Initialize serial for output.
+  SerialPort.begin(115200);
+
+  // The wire instance used can be omited in case you use default Wire instance
+  if(st25dv.begin(GPO_PIN, LPD_PIN, &WireNFC) == 0) {
+    SerialPort.println("System Init done!");
+  } else {
+    SerialPort.println("System Init failed!");
+    while(1);
+  }
+
+  if(st25dv.writeURI(uri_write_protocol, uri_write_message, "")) {
+    SerialPort.println("Write failed!");
+    while(1);
+  }
+
+}
+
+void loop() {  
+  //empty loop
+}