Skip to content

Commit

Permalink
Repo cleanup, readme cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
Toni Klopfenstein committed Apr 7, 2016
1 parent 01b66aa commit d4cff21
Show file tree
Hide file tree
Showing 131 changed files with 112 additions and 24 deletions.
22 changes: 22 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Auto detect text files and perform LF normalization
* text=auto

# Custom for Visual Studio
*.cs diff=csharp
*.sln merge=union
*.csproj merge=union
*.vbproj merge=union
*.fsproj merge=union
*.dbproj merge=union

# Standard to msysgit
*.doc diff=astextplain
*.DOC diff=astextplain
*.docx diff=astextplain
*.DOCX diff=astextplain
*.dot diff=astextplain
*.DOT diff=astextplain
*.pdf diff=astextplain
*.PDF diff=astextplain
*.rtf diff=astextplain
*.RTF diff=astextplain
File renamed without changes
File renamed without changes
File renamed without changes
56 changes: 56 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
SparkFun License Information
============================

SparkFun uses two different licenses for our files — one for hardware and one for code.

Hardware
---------

**SparkFun hardware is released under [Creative Commons Share-alike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/).**

Note: This is a human-readable summary of (and not a substitute for) the [license](http://creativecommons.org/licenses/by-sa/4.0/legalcode).

You are free to:

Share — copy and redistribute the material in any medium or format
Adapt — remix, transform, and build upon the material
for any purpose, even commercially.
The licensor cannot revoke these freedoms as long as you follow the license terms.
Under the following terms:

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.
ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
Notices:

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.
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.


Code
--------
OpenLog uses SdFatLib-beta(https://github.com/greiman/SdFat-beta) and SerialPort(https://github.com/greiman/SerialPort) written by Bill Greiman and is released under [GPL v3](http://www.gnu.org/licenses/gpl-3.0.html).

**SparkFun OpenLog firmware is released under the MIT License(http://opensource.org/licenses/MIT).**

The MIT License (MIT)

Copyright (c) 2016 SparkFun Electronics

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file removed OpenLog-Dimensional Drawing.png
Binary file not shown.
48 changes: 29 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,43 @@
OpenLog
=======
SparkFun OpenLog
================

[![OpenLog](https://dlnmh9ip6v2uc.cloudfront.net/images/products/9/5/3/0/09530-01_i_ma.jpg)
*OpenLog (DEV-09530)*](https://www.sparkfun.com/products/9530)
![OpenLog](https://dlnmh9ip6v2uc.cloudfront.net/images/products/9/5/3/0/09530-01_i_ma.jpg)

[*OpenLog (DEV-09530)*](https://www.sparkfun.com/products/9530)

OpenLog is an open source data logger that works over a simple serial connection and supports microSD cards up to 64GB.


Repository Contents
-------------------
* **/Documentation** - Data sheets, additional product information
* **/Firmware** - Example sketches for the OpenLog, and for an Arduino connected to the OpenLog.
* **/Hardware** - Hardware design files for the OpenLog PCB. These files were designed in Eagle CAD.
* **/Libraries** - Libraries for use with the OpenLog.
* **/Production** - Production panel files (.brd)

Documentation
--------------
* **[Hookup Guide](https://learn.sparkfun.com/tutorials/openlog-hookup-guide)** - Basic hookup guide for the OpenLog.
* **[SparkFun Fritzing repo](https://github.com/sparkfun/Fritzing_Parts)** - Fritzing diagrams for SparkFun products.
* **[SparkFun 3D Model repo](https://github.com/sparkfun/3D_Models)** - 3D models of SparkFun products.
* **[SparkFun Graphical Datasheets](https://github.com/sparkfun/Graphical_Datasheets)** -Graphical Datasheets for various SparkFun products.


License Information
-------------------

The hardware design and firmware are released under [Creative Commons Share-alike 3.0](http://creativecommons.org/licenses/by-sa/3.0/).
The FAT16/FAT32 firmware was originally designed by Roland Riegel and is released under [GPL v2](http://www.gnu.org/licenses/gpl-2.0.html).
This product is _**open source**_!

Feel free to use, distribute, and sell varients of OpenLog. All we ask is that you include attribution of 'Based on OpenLog by SparkFun'.
Please review the LICENSE.md file for license information.

OpenLog v2.0 and above uses sdfatlib written by Bill Greiman and is released under [GPL v3](http://www.gnu.org/licenses/gpl-3.0.html).
If you have any questions or concerns on licensing, please contact techsupport@sparkfun.com.

The OpenLog firmware was created by SparkFun Electronics, and is open source so please feel free to do anything you want with it;
you buy me a beer if you use this and we meet someday ([Beerware license](http://en.wikipedia.org/wiki/Beerware)).
Distributed as-is; no warranty is given.

Repository Contents
-------------------
* **/Firmware**
* OpenLog - Firmware that ships with OpenLog. '?' command will show the version loaded onto a unit.
* OpenLog_Light - Used for high-speed logging. By removing the menu and command mode the receive buffer is increased.
* OpenLog_Minimal - Highest speed logging. Baud rate must be set in code and uploaded. Hardest, most advanced, and best at high-speed logging.
* Examples - Example Arduino code for controlling and testing OpenLog
* **/Fritzing** - Fritzing image showing the connections between the OpenLog and an FTDI Basic
* **/Hardware** - Hardware design files for the OpenLog PCB. These files were designed in Eagle CAD.
- Your friends at SparkFun.

_SDFatLib-beta and SerialPort are written by Bill Greiman, and released under GPLv3._

Version History
---------------
Expand Down
Binary file removed hardware/OpenLog-Dimensional.pdf
Binary file not shown.
Binary file removed hardware/OpenLog-Schematic.pdf
Binary file not shown.
10 changes: 5 additions & 5 deletions hardware/OpenLog.sch
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE eagle SYSTEM "eagle.dtd">
<eagle version="7.3.0">
<eagle version="7.5.0">
<drawing>
<settings>
<setting alwaysvectorfont="no"/>
Expand Down Expand Up @@ -152,7 +152,7 @@
<layer number="254" name="cooling" color="7" fill="1" visible="yes" active="yes"/>
<layer number="255" name="routoute" color="7" fill="1" visible="no" active="yes"/>
</layers>
<schematic xreflabel="%F%N/%S" xrefpart="/%S.%C%R">
<schematic xreflabel="%F%N/%S" xrefpart="/%S">
<libraries>
<library name="SparkFun">
<packages>
Expand Down Expand Up @@ -10129,7 +10129,7 @@ You are welcome to use this library for commercial purposes. For attribution, we
<text x="2.54" y="5.08" size="1.778" layer="97">To connect OpenLog to an FTDI basic, you will need to swap
TX and RX lines between boards.</text>
<text x="238.76" y="7.62" size="2.54" layer="94">V15</text>
<text x="165.354" y="11.43" size="2.54" layer="94">N. Seidle</text>
<text x="170.434" y="11.43" size="2.54" layer="94">N. Seidle</text>
<text x="148.844" y="7.112" size="2.54" layer="94">Revised by: Patrick Alberts, Pete Lewis</text>
<text x="2.54" y="28.702" size="1.778" layer="97">0.8mm Thin PCB</text>
<text x="2.54" y="177.8" size="2.54" layer="97">Power Circuit:</text>
Expand Down Expand Up @@ -10193,14 +10193,14 @@ You are welcome to use this library for commercial purposes. For attribution, we
<instance part="P+2" gate="G$1" x="33.02" y="88.9"/>
<instance part="GND3" gate="1" x="33.02" y="53.34"/>
<instance part="U1" gate="U$1" x="203.2" y="114.3"/>
<instance part="LOGO1" gate="G$1" x="121.92" y="12.7"/>
<instance part="LOGO1" gate="G$1" x="137.16" y="2.54"/>
<instance part="FID1" gate="G$1" x="246.38" y="33.02"/>
<instance part="FID2" gate="G$1" x="241.3" y="33.02"/>
<instance part="GND6" gate="1" x="121.92" y="60.96"/>
<instance part="TP1" gate="G$1" x="66.04" y="157.48" smashed="yes">
<attribute name="NAME" x="66.04" y="159.512" size="1.778" layer="95"/>
</instance>
<instance part="LOGO2" gate="G$1" x="106.68" y="20.32"/>
<instance part="LOGO2" gate="G$1" x="124.46" y="10.16"/>
<instance part="FID3" gate="G$1" x="246.38" y="27.94"/>
<instance part="FID4" gate="G$1" x="241.3" y="27.94"/>
<instance part="TP2" gate="G$1" x="116.84" y="152.4" smashed="yes" rot="R180">
Expand Down
Binary file added hardware/OpenLogDimensionalDrawing.pdf
Binary file not shown.
Binary file added hardware/OpenLogSchematic.pdf
Binary file not shown.

0 comments on commit d4cff21

Please sign in to comment.