Skip to content

Commit 06c7862

Browse files
jesserodriguez1jesserodriguez1
committed
Add license and update README
1 parent f2acb08 commit 06c7862

File tree

2 files changed

+65
-63
lines changed

2 files changed

+65
-63
lines changed

‎License.md

+55
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) 2016 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.

‎README.md

+10-63
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,25 @@
1-
SparkFun OpenLog Artemis
1+
Sparkfun RTK Surveyor
22
===========================================================
33

4-
<table class="table table-hover table-striped table-bordered">
5-
<tr align="center">
6-
<td><a href="https://www.sparkfun.com/products/16832"><img src="https://cdn.sparkfun.com//assets/parts/1/5/7/5/3/16832-SparkFun_OpenLog_Artemis-02a.jpg"></a></td>
7-
<td><a href="https://www.sparkfun.com/products/15846"><img src="https://cdn.sparkfun.com//assets/parts/1/4/4/8/0/15846-OpenLog_Artemis-04.jpg"></a></td>
8-
</tr>
9-
<tr align="center">
10-
<td><a href="https://www.sparkfun.com/products/16832">SparkFun OpenLog Artemis (DEV-16832)</a></td>
11-
<td><a href="https://www.sparkfun.com/products/15846">SparkX OpenLog Artemis (SPX-15846)</a></td>
12-
</tr>
13-
</table>
4+
![SparkFun RTK Surveyor](https://cdn.sparkfun.com/assets/parts/1/6/4/0/1/17369-GPS_RTK_Surveyor_-_Enclosed-01.jpg)
145

15-
The OpenLog Artemis is an open source datalogger that comes preprogrammed to automatically log IMU, GPS, serial data, and various pressure, humidity, and distance sensors. All without writing a single line of code! OLA automatically detects, configures, and logs Qwiic sensors. OLA is designed for users who just need to capture a bunch of data to a CSV and get back to their larger project.
16-
17-
Included on every OpenLog Artemis is an IMU for built-in logging of triple axis accelerometer, gyro, and magnetometer. Whereas the original [9DOF Razor](https://www.sparkfun.com/products/14001) used the old MPU-9250, the OpenLog Artemis uses the latest [ICM-20948](https://www.sparkfun.com/products/15335) capable of nearly 1kHz logging of all 9 axis. We then took over a decade of experience with the original [OpenLog](https://www.sparkfun.com/products/13712) and took it much farther. Simply power up OpenLog Artemis and all incoming serial data is automatically recorded to a log file. Baud rates up to 921600bps are supported! Additionally, based on feedback from users we've added an onboard RTC so that all data can be time stamped.
18-
19-
OpenLog Artemis is highly configurable over an easy to use serial interface. Simply plug in a USB C cable and open a terminal at 115200kbps. The logging output is automatically streamed to both the terminal and the microSD. Pressing any key will open the configuration menu.
20-
21-
The OpenLog Artemis automatically scans, detects, configures, and logs various Qwiic sensors plugged into the board (no soldering required!). Currently, auto-detection is supported on the following Qwiic products:
22-
23-
* uBlox GPS Modules (Lat/Long, Altitude, Velocity, SIV, Time, Date):
24-
* [ZED-F9P](https://www.sparkfun.com/products/15136) 1cm High Precision GPS
25-
* [NEO-M8P-2](https://www.sparkfun.com/products/15005) 2.5cm High Precision GPS
26-
* [SAM-M8Q](https://www.sparkfun.com/products/15210) 1.5m 72 Channel GPS
27-
* [ZOE-M8Q](https://www.sparkfun.com/products/15193) 1.5m Compact GPS
28-
* [NEO-M9N](https://www.sparkfun.com/products/15712) 1.5m GPS
29-
* [MCP9600 Thermocouple Amplifier](https://www.sparkfun.com/products/16294)
30-
* [NAU7802 Load Cell Amplifier](https://www.sparkfun.com/products/15242)
31-
* [LPS25HB Barometric Pressure Sensor](https://www.sparkfun.com/products/14767)
32-
* [BME280 Humidity and Barometric Pressure Sensor](https://www.sparkfun.com/products/15440)
33-
* [MS5637 Barometric Pressure Sensor](https://www.sparkfun.com/products/14688)
34-
* [MS8607 Pressure Humidity Temperature Sensor](https://www.sparkfun.com/products/16298)
35-
* [TMP117 High Precision Temperature Sensor](https://www.sparkfun.com/products/15805)
36-
* [AHT20 Humidity and Temperature Sensor](https://www.sparkfun.com/products/16618)
37-
* [SHTC3 Humidity and Temperature Sensor](https://www.sparkfun.com/products/16467)
38-
* [CCS811 Air Quality Sensor](https://www.sparkfun.com/products/14348)
39-
* [SGP30 Air Quality Sensor](https://www.sparkfun.com/products/16531)
40-
* [SCD30 CO<sub>2</sub> and Air Quality Sensor](https://www.sparkfun.com/products/15112)
41-
* [VEML6075 UV Sensor](https://www.sparkfun.com/products/15089)
42-
* [VCNL4040 Proximity Sensor](https://www.sparkfun.com/products/15177)
43-
* [VL53L1X LIDAR Distance Sensor](https://www.sparkfun.com/products/14722)
44-
* [ADS122C04 ADC PT100 Sensor](https://www.sparkfun.com/products/16770)
45-
* [Qwiic Mux](https://www.sparkfun.com/products/16784) allowing for the chaining of up to 64 unique buses!
46-
* More boards are being added all the time!
47-
48-
Very low power logging is supported. OpenLog Artemis can be configured to take readings at 500 times a second, or as slow as 1 reading every 24 hours. You choose! When there is more than 2 seconds between readings OLA will automatically power down itself and the sensors on the bus resulting in a sleep current of approximately 18uA. This means a normal [2Ah battery](https://www.sparkfun.com/products/13855) will enable logging for more than 4,000 days! OpenLog Artemis has built-in LiPo charging set at 450mA/hr.
49-
50-
New features are constantly being added so we’ve released an easy to use firmware upgrade tool. No need to install Arduino or a bunch of libraries, simply open the [Artemis Firmware Upload GUI](https://github.com/sparkfun/Artemis-Firmware-Upload-GUI), load the latest OLA firmware, and add features to OpenLog Artemis as they come out! Full instructions are available in [UPGRADE.md](UPGRADE.md).
51-
52-
The OLA can be tailored to many different applications and we will be releasing custom versions of the firmware for those too:
53-
54-
* [Latest OLA firmware](https://github.com/sparkfun/OpenLog_Artemis/tree/master/Binaries)
55-
* [Geophone Logger firmware](https://github.com/sparkfun/OpenLog_Artemis_Geophone_Logger) for logging seismic activity
56-
* [GNSS Logger](https://github.com/sparkfun/OpenLog_Artemis_GNSS_Logger) for advanced data logging with the uBlox F9 and M9 GNSS modules including support for RAWX and RELPOSNED
57-
58-
Artemis Firmware Uploader GUI
59-
Latest OLA firmware: v1.5
60-
Geophone Logger firmware for logging seismic activity
61-
GNSS Logger for advanced data logging with the uBlox F9 and M9 GNSS modules including support for RAWX and RELPOSNED
6+
[SparkFun RTK Surveyor](https://cdn.sparkfun.com/assets/parts/1/6/4/0/1/17369-SparkFun_RTK_Surveyor-12.jpg)
627

638
Repository Contents
649
-------------------
6510

66-
* **/Binaries** - The binary files for the different versions of the OLA firmware
67-
* **/Firmware** - The main sketch that runs OpenLog Artemis as well as a variety of sketches to test various sensor interfaces and power saving states.
11+
* **/Documents** - Documentation on hardware and 3D files for the enclosure
12+
* **/Enclosure** - gcode for enclosure milling
13+
* **/Firmware** - Arduino sketches
14+
* **/Graphics** - Sticker graphics
6815
* **/Hardware** - Eagle files
16+
* **/Programming** - Programming files
17+
* **/Testing** - Testing
6918

7019
Documentation
7120
--------------
7221

73-
* **[UPGRADE.md](UPGRADE.md)** - contains full instructions on how to upgrade the firmware on the OLA using the [Artemis Firmware Upload GUI](https://github.com/sparkfun/Artemis-Firmware-Upload-GUI)
74-
* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - OLA includes a large number of libraries that will need to be installed before compiling will work.
75-
* **[Hookup Guide](https://learn.sparkfun.com/tutorials/openlog-artemis-hookup-guide)** - Basic hookup guide for the OLA.
22+
* **[Hookup Guide](https://learn.sparkfun.com/tutorials/sparkfun-rtk-surveyor-hookup-guide)** - Hookup guide for the SparkFun RTK Surveyor.
7623

7724
License Information
7825
-------------------

0 commit comments

Comments
 (0)