Skip to content

Commit 6442113

Browse files
author
Toni Klopfenstein
committed
Fixing library include statements, updating README, fixing directory structure
1 parent 49786a5 commit 6442113

File tree

5 files changed

+81
-15
lines changed

5 files changed

+81
-15
lines changed

‎LICENSE.md‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
SparkFun License Information
2+
============================
3+
4+
SparkFun uses two different licenses for our files — one for hardware and one for code.
5+
6+
Hardware
7+
---------
8+
9+
**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**
10+
11+
Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).
12+
13+
You are free to:
14+
15+
Share — copy and redistribute the material in any medium or format
16+
Adapt — remix, transform, and build upon the material
17+
for any purpose, even commercially.
18+
The licensor cannot revoke these freedoms as long as you follow the license terms.
19+
Under the following terms:
20+
21+
Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
22+
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
23+
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
24+
Notices:
25+
26+
You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.
27+
No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.
28+
29+
30+
Code
31+
--------
32+
33+
**SparkFun code, firmware, and software is released under the MIT License(http://opensource.org/licenses/MIT).**
34+
35+
The MIT License (MIT)
36+
37+
Copyright (c) 2015 SparkFun Electronics
38+
39+
Permission is hereby granted, free of charge, to any person obtaining a copy
40+
of this software and associated documentation files (the "Software"), to deal
41+
in the Software without restriction, including without limitation the rights
42+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
43+
copies of the Software, and to permit persons to whom the Software is
44+
furnished to do so, subject to the following conditions:
45+
46+
The above copyright notice and this permission notice shall be included in all
47+
copies or substantial portions of the Software.
48+
49+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
50+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
51+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
52+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
53+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
54+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
55+
SOFTWARE.

‎Production Files/Weather Shield-Panel-v11.brd‎ renamed to ‎Production/Weather Shield-Panel-v11.brd‎

File renamed without changes.

‎README.md‎

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
1-
Weather Shield
2-
=======
1+
SparkFun Weather Shield
2+
========================
33

4-
[![Weather Shield](https://dlnmh9ip6v2uc.cloudfront.net/images/products/1/2/0/8/1/12081-06.jpg)
5-
*Weather Shield (DEV-12081)*](https://www.sparkfun.com/products/12081)
4+
![SparkFun Weather Shield](https://dlnmh9ip6v2uc.cloudfront.net/images/products/1/2/0/8/1/12081-06.jpg)
65

7-
Weather Shield is an Arduino shield that gathers relative humidity, barometric pressure, temperature, light intensity, as well as optional rain, wind direction, and wind speed (using optional [external weather gauges](https://www.sparkfun.com/products/8942)).
8-
9-
Weather Shield is an open source hardware project.
6+
[*SparkFun Weather Shield (DEV-12081)*](https://www.sparkfun.com/products/12081)
107

11-
**NOTE**: You will need to install additional libraries to work with the example sketch for this board. Please check the [MPL3115A2 Breakout Repo](https://github.com/sparkfun/MPL3115A2_Breakout) and the [HTU21D Breakout Repo](https://github.com/sparkfun/HTU21D_Breakout) for the required libraries.
8+
Weather Shield is an Arduino shield that gathers relative humidity, barometric pressure, temperature, light intensity, as well as optional rain, wind direction, and wind speed (using optional [external weather gauges](https://www.sparkfun.com/products/8942)).
129

1310
Repository Contents
1411
------------------
@@ -18,9 +15,23 @@ Repository Contents
1815
* **/Hardware** - All the Eagle PCB design files (.brd, .sch).
1916
* **/Production** - Test bed files and production panel files
2017

18+
Documentation
19+
--------------
20+
* **[MPL3115A2 Library](https://github.com/sparkfun/SparkFun_MPL3115A2_Breakout_Arduino_Library)** - MPL3115A2 library required for Weather Shield examples.
21+
* **[HTU21D Library](https://github.com/sparkfun/SparkFun_HTU21D_Breakout_Arduino_Library)** - HTU21D library required for Weather Shield examples.
22+
* **[Hookup Guide](https://learn.sparkfun.com/tutorials/weather-shield-hookup-guide)** - Basic hookup guide for the Weather Shield.
23+
* **[SparkFun Fritzing repo](https://github.com/sparkfun/Fritzing_Parts)** - Fritzing diagrams for SparkFun products.
24+
* **[SparkFun 3D Model repo](https://github.com/sparkfun/3D_Models)** - 3D models of SparkFun products.
25+
2126
License Information
2227
-------------------
2328

24-
The hardware design and firmware are released under [Creative Commons Share-alike 3.0](http://creativecommons.org/licenses/by-sa/3.0/).
25-
All other code is public domain but you buy me a beer if you use this and we meet someday ([Beerware license](http://en.wikipedia.org/wiki/Beerware)).
26-
29+
This product is _**open source**_!
30+
31+
Please review the LICENSE.md file for license information.
32+
33+
If you have any questions or concerns on licensing, please contact techsupport@sparkfun.com.
34+
35+
Distributed as-is; no warranty is given.
36+
37+
- Your friends at SparkFun.

‎firmware/Weather_Shield/Weather_Shield.ino‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
*/
2020

2121
#include <Wire.h> //I2C needed for sensors
22-
#include "MPL3115A2.h" //Pressure sensor
23-
#include "HTU21D.h" //Humidity sensor
22+
#include "SparkFunMPL3115A2.h" //Pressure sensor
23+
#include "SparkFunHTU21D.h" //Humidity sensor
2424

2525
MPL3115A2 myPressure; //Create an instance of the pressure sensor
2626
HTU21D myHumidity; //Create an instance of the humidity sensor

‎firmware/Weather_Shield_with_GPS/Weather_Shield_with_GPS.ino‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@
1919
*/
2020

2121
#include <Wire.h> //I2C needed for sensors
22-
#include "MPL3115A2.h" //Pressure sensor
23-
#include "HTU21D.h" //Humidity sensor
22+
#include "SparkFunMPL3115A2.h" //Pressure sensor
23+
#include "SparkFunHTU21D.h" //Humidity sensor
2424
#include <SoftwareSerial.h> //Needed for GPS
2525
#include <TinyGPS++.h> //GPS parsing
2626

0 commit comments

Comments
 (0)