Merge pull request #1 from NoahRosa/master

Implemented the X-NUCLEO-GNSS1A1 library

Author: cparata

LICENSE.md

@@ -0,0 +1,23 @@
+COPYRIGHT(c) 2019 STMicroelectronics
+
+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.

README.md

@@ -1,2 +1,30 @@
 # X-NUCLEO-GNSS1A1
-Arduino library to support the X-NUCLEO-GNSS1A1 based on the Teseo-LIV3F module
+Arduino library to support the X-NUCLEO-GNSS1A1 expansion board using the TESEO-LIV3F module
+
+## API
+
+This device uses alternatively I2C or UART to communicate. An I2C or UART instance is required to access the device.
+  
+## Examples
+
+There are 2 examples with the  X-NUCLEO-GNSS1A1 library.
+
+* X_NUCLEO_GNSS1A1_HelloWorld_I2C: This example code provides a simple command line interface
+  to communicate with the sensor via I2C protocol
+
+* X_NUCLEO_GNSS1A1_HelloWorld_UART: This example code provides a simple command line interface
+  to communicate with the sensor via UART protocol
+
+## Note
+
+The device works only in an outdoor enviroment with a clear view of the sky.
+In order to prevent data loss the update function should be called at least 20 times per second.
+Both the examples need at least 16KB of RAM in order to work properly.
+
+## Documentation
+
+You can find the source files at  
+https://github.com/stm32duino/X-NUCLEO-GNSS1A1
+
+The TESEO-LIV3F datasheet is available at  
+https://www.st.com/content/st_com/en/products/positioning/gnss-modules/teseo-liv3f.html