Skip to content

Commit

Permalink
polishing edits
Browse files Browse the repository at this point in the history
  • Loading branch information
fisherba committed Dec 13, 2018
1 parent 36d4e14 commit eb8ba85
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 14 deletions.
7 changes: 5 additions & 2 deletions _episodes/03-GitHubUser.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,14 @@ The operative word for our use of GitHub is collaborative! It can be a place whe
- ["Sign Up" for GitHub (create your own user account).](https://github.com/)
- In most cases we will be using code that others have contributed to GitHub, but you will need to create an account to be a GitHub user. As you create your account, consider using an email address that you will continue to use beyond this project. (If you need to change it some day, GitHub handles redirects well.)

- [GitHub activity: Hello World.](https://guides.github.com/activities/hello-world/)
- Your first GitHub activity will acquaint you with some of the jargon and functionality of GitHub by creating your own repository.

- [Download and install GitHub Desktop.](https://desktop.github.com/)
- This software is a graphical user interface (GUI) to help you manage the files that you get from (pull) or send to (push) GitHub repositories. Having a Git Client will allow you to (mostly) avoid command line interaction with GitHub. There are other Git Clients available, and you are welcome to explore and use them. Our tutorials will be from the perspective of GitHub Desktop simply because that is what was available when the authors started. Sign in to GitHub desktop so it will be prepared to track your contributions.

- [GitHub activity: Hello World.](https://guides.github.com/activities/hello-world/)
- Your first GitHub activity will acquaint you with some of the jargon and functionality of GitHub by creating your own repository.
- FIXME Add activity to commit files from your repo using GitHub desktop to GitHub.


> ## For your reference
> GitHub is full of jargon. [Here's a glossary for GitHub.](https://help.github.com/articles/github-glossary/)
Expand Down
3 changes: 2 additions & 1 deletion _episodes/04-GetPlatformIO.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ teaching: 0
exercises: 45
questions:
- "How will I manage extensive Arduino libraries?"
- "What are the benefits of a code text editor? How can I easily compare two codes files?"
- "What are the benefits of a code text editor?"
- "How can I easily compare two codes files?"
- "Which buttons do I push in PlatformIO?"
objectives:
- "Download PlatformIO and Atom. Test PlatformIO."
Expand Down
4 changes: 2 additions & 2 deletions _episodes/08-DataLogging.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ A datalogger needs to carefully keep track of time for a wide variety of purpose
- Sometimes it is useful for a single datalogger to log different measurements at different intervals.
- **Sensor warm up time**, before it can start sending data or receiving commands after it is powered up.
- **Sensor stabilization time**, before it can start providing reliably stable or precise data after it is powered up.
- **Sensor measurement time**, or or ***scan interval***, is how long the sensor takes to make a single measurement before it can make another.
- **Sensor measurement time**, or ***scan interval***, is how long the sensor takes to make a single measurement before it can make another.
- **Sensor number of readings**, which is how many individual measurements get made, one after another, to then be averaged for the recorded result for that logging interval.
- Most sensors benefit from averaging multiple readings, to reduce signal noise. Many commercial sensors with built-in dataloggers, do this by default.
- **Sensor time averaging**, or ***time support***, is the product of measurement time and number of readings.
- **Sensor averaging time**, or ***time support***, is the product of measurement time and number of readings.
- Sometimes it is useful to average over a long-enough time to average-out the effects of higher-frequency environmental variability than what you are studying, such as the pulses of turbidity that go up and down every 3-10 seconds with passing eddies and vortices.

<img src="https://envirodiy.github.io/LearnEnviroDIY/fig/TimeScaleTriplet-Horsburg.png" width="800">
Expand Down
4 changes: 2 additions & 2 deletions _episodes/11-TelemetryIntro.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ Telemetry is the automated communication of measurements and other data from a r

**Communication Protocols for Telemetry** include familiar internet protocols and also more modern protocols designed specifically for IoT, such as:
- FTP
- HTTP SOAP web services
- HTTP REST web services
- HTTP SOAP web services api
- HTTP REST web services api
- Message Queuing Telemetry Transport (MQTT)
- UDP CoAP
NOTE: both the client (your station or device) and the server BOTH need to be configured to use the same protocol.
Expand Down
15 changes: 8 additions & 7 deletions _episodes/13-LoggingToEnviroDIYsketch.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,14 @@ Set up *logging_to_EnviroDIY.ino* to run BME280 and DS18 sensors.
```
2. Copy and paste the tokens and UUIDs from your data.EnviroDIY.org site.
This task is very tedious. I recommend pasting this information in the ReadMe.md file in (~/Arduino/deployments/tutorials/logging_to_EnviroDIY/). With *logging_to_EnviroDIY.ino* and *ReadMe.md* open, right click on the tab that is not active and select **Split Left** (or right or up or down). This is my preferred method for pasting UUIDs into a sketch.
3. Set up the platformio.ini file in the root directory of your repository. Save the ini file.
<img src="https://envirodiy.github.io/LearnEnviroDIY/fig/simple_logging_ini.png" width="600">
4. Connect the BME280 to the Mayfly, connect the Mayfly to your computer using the USB cable, and turn it on. (Note: Modular Sensors sketches will not run if the SD card is missing.)
5. Build/compile and upload your sketch.
6. View your sensor using the serial monitor (note: `serialBaud = 115200`). After the logger is set up, push the round, black button near the SD card on the Mayfly to enter sensor testing mode.
7. Your serial monitor will now include information about your modem signal strength. Sometimes the first few logging intervals have low strength, so watch give the modem a warm up period.
8. If your modem displays a non-zero signal strength, press the reset button (small, white rectangle near the coin battery and lipo connectors). This will restart the sketch, which allows logging mode to resume. Do not go into sensor testing mode. Wait for logging to begin. If the server response is **201**, you have successfully logged to a data repository!
3. Change the apn to match your SIM provider: `const char *apn = "hologram";`
4. Set up the platformio.ini file in the root directory of your repository. Save the ini file.
<img src="https://envirodiy.github.io/LearnEnviroDIY/fig/simple_logging_ini.png" width="600">
5. Connect the BME280 to the Mayfly, connect the Mayfly to your computer using the USB cable, and turn it on. (Note: Modular Sensors sketches will not run if the SD card is missing.)
6. Build/compile and upload your sketch.
7. View your sensor using the serial monitor (note: `serialBaud = 115200`). After the logger is set up, push the round, black button near the SD card on the Mayfly to enter sensor testing mode.
8. Your serial monitor will now include information about your modem signal strength. Sometimes the first few logging intervals have low strength, so watch give the modem a warm up period.
9. If your modem displays a non-zero signal strength, press the reset button (small, white rectangle near the coin battery and lipo connectors). This will restart the sketch, which allows logging mode to resume. Do not go into sensor testing mode. Wait for logging to begin. If the server response is **201**, you have successfully logged to a data repository!


{% include links.md %}

0 comments on commit eb8ba85

Please sign in to comment.