Skip to content

Commit

Permalink
More readable, with placeholders for tutorial information
Browse files Browse the repository at this point in the history
  • Loading branch information
awickert committed May 31, 2017
1 parent 4e7fdfa commit 946ba82
Showing 1 changed file with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,38 @@
ALog
======
# ALog

"ALog" holds the "Logger" data logger library for the Arduino-based ALog (http://northernwidget.com/alog/) developed by Andy Wickert and Chad Sandell at Northern Widget LLC and the University of Minnesota.
**ALog** holds the **Logger** data logger library designed for the Arduino-based ALog (http://northernwidget.com/alog/), but that will also work with any standard Arduino-Uno-based system that is outfitted with a SD card and a DS3231 real-time clock.

While it is developed to work specifically with the ALog, it will also work with a standard Arduino that is outfitted with a SD card and a DS3231 real-time clock.
This library is optimized to:
1. handle all of the basic file, system, and power management behind-the-scenes, including power consumption reduction to minimal levels through the use of the sleep functions
2. include and expose sensor functions as single-line calls, with a template for the addition of new sensors.

"Logger" is optimized to handle all of the basic file, system, and power management behind-the-scenes, and to reduce power consumption to minimal levels through the use of the sleep functions. It exposes sensor functions as single-line calls, and includes a template for the addition of new sensors.
If you use the ALog library (and/or data logger) in a publication, please cite:

For questions related to the Logger library, please send a message to us at info@northernwidget.com.
**Wickert, A. D. (2014), [The ALog: Inexpensive, Open-Source, Automated Data Collection in the Field](http://onlinelibrary.wiley.com/wol1/doi/10.1890/0012-9623-95.2.68/full), *Bull. Ecol. Soc. Am.*, *95*(2), 68–78, doi:10.1890/0012-9623-95.2.68.**

## Using the ALog library

### With an ALog data logger

```
Example code here
```

### With an ALog shield or another system

```
Example code here
```

## Adding support for new sensors

```
Example code here
```

## Main Developers and Contact

The ALog has been developed by Andy Wickert and Chad Sandell at Northern Widget LLC and the University of Minnesota.

For questions related to the Logger library, please send a message to us at info@northernwidget.com.

0 comments on commit 946ba82

Please sign in to comment.