Skip to content

Commit

Permalink
Cleanup for first official release 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
aufdenkampe committed Apr 2, 2019
1 parent 328981e commit df5fc6b
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 10 deletions.
8 changes: 4 additions & 4 deletions CITATION
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
cff-version: 0.0.1
cff-version: 0.2.0-beta
message: If you use this software, please cite it as below.
authors:
- family-names: Fisher
Expand All @@ -7,7 +7,7 @@ authors:
- family-names: Aufdenkampe
given-names: A.K.
orcid: http://orcid.org/0000-0002-5811-6458
title: Introduction to EnviroDIY Modular Sensor Library for environmental monitoring.
version: 0.0.1
title: Introduction to EnviroDIY Modular Sensor Library for Environmental Monitoring.
version: 0.2.0-beta
doi:
date-released: 2018-11-11
date-released: 2019-04-02
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Learn EnviroDIY Programming tutorial

A tutorial for learning how to program an Arduino-framework micro-controller to become an environmental data logger, available at https://envirodiy.github.io/LearnEnviroDIY.
A tutorial for learning how to program an Arduino-framework micro-controller to become an environmental data logger, available at https://envirodiy.github.io/LearnEnviroDIY.

Do-it-yourself (DIY) enthusiasts generally find rapid success at reading data from simple sensors to an Arduino board. However, it is much more challenging to program an Arduino to perform all required functions of a solar-powered station that collects data from several research-grade environmental sensors, saves to an SD card, transmits to a public server with web services, and puts the sensors to sleep to conserve energy between logging intervals. The [EnviroDIY community](https://www.envirodiy.org/) has made all of this much simpler by creating the [ModularSensors](https://github.com/EnviroDIY/ModularSensors) library, putting the power of the Internet of Things (IoT) revolution into the hands of DIYers.

Expand All @@ -10,7 +10,12 @@ We organize episodes into two parts:
- Part 1: Arduino and IoT for EnviroDIY (Episodes 1-6) introduces basic Arduino and IoT skills to prepare you for using ModularSensors.
- Part 2: Program with ModularSensors (Episodes 7-13) provides exercises to program, test and deploy a monitoring station based on the example code in the ModularSensors library.

**Get Started** at https://envirodiy.github.io/LearnEnviroDIY!
The [LearnEnviroDIYcode](https://github.com/EnviroDIY/LearnEnviroDIYcode) repository provides companion example code sketches.

## Get Started

[Get started](https://envirodiy.github.io/LearnEnviroDIY) with this hands-on tutorial at https://envirodiy.github.io/LearnEnviroDIY!


## Contributing

Expand All @@ -21,16 +26,17 @@ We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTR
the [more detailed guidelines][lesson-example] on proper formatting, ways to render the lesson locally, and even
how to write new episodes.


## Maintainer(s)

Lessons maintained by [Beth A. Fisher](https://github.com/fisherba) and [Anthony K. Aufdenkampe](https://github.com/aufdenkampe).
Lessons maintained by [Beth A. Fisher](https://github.com/fisherba) and [Anthony K. Aufdenkampe](https://github.com/aufdenkampe).

## Authors

A list of contributors to the lesson can be found in [AUTHORS](AUTHORS)
A list of contributors to the lesson can be found in [AUTHORS](AUTHORS).

## Citation

To cite this lesson, please consult with [CITATION](CITATION)
To cite this lesson, please consult with [CITATION](CITATION).

[lesson-example]: https://carpentries.github.io/lesson-example
This tutorial was created by using [The Carpentries lesson template & example](https://github.com/carpentries/lesson-example).
2 changes: 2 additions & 0 deletions _episodes/01-ArduinoBasics.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ The Arduino sketches in this episode are simple and require a minimal number of

- A note on the USB fuse on the Uno. The Mayfly does not not have this, which means that it is possible to "fry" the Mayfly more easily than the Uno. Make sure the toggle that we have labeled "12V power option" is on USB/LiPo for the tutorials and for almost everything you will do with the Mayfly. Supplying 12V power is an advanced maneuver that requires extra hardware.
- After you work through Lady Ada's software download instructions, follow the [instructions for installing the Mayfly driver](https://www.envirodiy.org/mayfly/software/).
- NOTE for Installing [Arduino Desktop IDE](https://www.arduino.cc/en/Main/Software) for Windows: If your IDE does not recognize a COM port for your board, you may need to follow these [instructions to install the board drivers](https://www.arduino.cc/en/Guide/ArduinoUno#toc3). This might happen if you installed from the Windows Zip package. If you used the Windows Installer (admin privileges required), then the drivers should have installed automatically.

- [Lesson 1: Upload your First Sketch](https://learn.adafruit.com/ladyadas-learn-arduino-lesson-number-1)
- Walks you through uploading your first program, which is called a "sketch" in Arduino.
- Select Board Type: Instead of the Ardunio Uno, select "EnviroDIY Mayfly 1284p".
Expand Down

0 comments on commit df5fc6b

Please sign in to comment.