-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #26 from dramsay1996/master
added ath20 and th02 example notebooks
- Loading branch information
Showing
7 changed files
with
580 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -60,7 +60,6 @@ | |
| ] | ||
| }, | ||
| { | ||
| "attachments": {}, | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,277 @@ | ||
| { | ||
| "cells": [ | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# Displaying Sensor Data on the LED Bar\n", | ||
| "\n", | ||
| "A key concept in computers is taking an input from a sensor, processing that data in a meaningful way, and outputting that to the user in a format that is intuitive and easy to read. This concept can be found in almost every computing system. \n", | ||
| "\n", | ||
| "We are going to create this type of system with our sensor and LED bar. The end product will be a sort of \"digital thermometer\".\n", | ||
| "\n", | ||
| "### This notebook will walk you through using both the ATH20 sensor\n", | ||
| "\n", | ||
| "\n", | ||
| "As usual, apply the base overlay to the board:" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 1, | ||
| "metadata": {}, | ||
| "outputs": [ | ||
| { | ||
| "data": { | ||
| "application/javascript": [ | ||
| "\n", | ||
| "require(['notebook/js/codecell'], function(codecell) {\n", | ||
| " codecell.CodeCell.options_default.highlight_modes[\n", | ||
| " 'magic_text/x-csrc'] = {'reg':[/^%%microblaze/]};\n", | ||
| " Jupyter.notebook.events.one('kernel_ready.Kernel', function(){\n", | ||
| " Jupyter.notebook.get_cells().map(function(cell){\n", | ||
| " if (cell.cell_type == 'code'){ cell.auto_highlight(); } }) ;\n", | ||
| " });\n", | ||
| "});\n" | ||
| ] | ||
| }, | ||
| "metadata": {}, | ||
| "output_type": "display_data" | ||
| } | ||
| ], | ||
| "source": [ | ||
| "from pynq.overlays.base import BaseOverlay\n", | ||
| "base = BaseOverlay(\"base.bit\")" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# 1. Read Temperature Data" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "## ATH02 Sensor\n", | ||
| "\n", | ||
| "If your sensor looks like this, it is an ATH20. If not, you should use the TH02 notebook [here](temp_ledbar_example_TH02.ipynb).\n", | ||
| "\n", | ||
| "\n", | ||
| "\n", | ||
| "### Install Driver\n", | ||
| "\n", | ||
| "First, install the driver that will allow your board to communicate with this sensor (you may already have downloaded it, but run this cell just in case)." | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 2, | ||
| "metadata": {}, | ||
| "outputs": [ | ||
| { | ||
| "name": "stdout", | ||
| "output_type": "stream", | ||
| "text": [ | ||
| "Collecting git+https://github.com/LewisMcL/pynq_drivers\n", | ||
| " Cloning https://github.com/LewisMcL/pynq_drivers to /tmp/pip-wqhg2o6g-build\n", | ||
| " Requirement already satisfied (use --upgrade to upgrade): pmod-grove-aht20==1.0 from git+https://github.com/LewisMcL/pynq_drivers in /usr/local/lib/python3.6/dist-packages\n" | ||
| ] | ||
| } | ||
| ], | ||
| "source": [ | ||
| "!pip3 install git+https://github.com/LewisMcL/pynq_drivers --no-deps" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### Plug in your ATH20 Sensor\n", | ||
| "\n", | ||
| "Connect you ATH20 Sensor to the port labeled G3 on your PMOD to Grove Adaptor (pictured below). Plug the adaptor into the port labeled PMODB on your PYNQ Board.\n", | ||
| "\n", | ||
| "" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### Import Libraries\n", | ||
| "\n", | ||
| "Make sure your PMOD to Grove adapter is connected to the PMODB port. We are importing PMOD_GROVE_G3, because the AHT20 sensor is connected to the 3rd Grove adaptor port. If you have it plugged into G4, you will have to do `from pynq.lib.pmod import PMOD_GROVE_G4` instead. " | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 3, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "from grove import Grove_AHT20\n", | ||
| "from pynq.lib.pmod import PMOD_GROVE_G3" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### 4. Receiving Measurements\n", | ||
| "We instantiate the sensor using the Grove_ATH20 constructor. This is very similar to a function, but it returns an object that represents our sensor that we can then use to call functions like get_temp()." | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 5, | ||
| "metadata": {}, | ||
| "outputs": [ | ||
| { | ||
| "name": "stdout", | ||
| "output_type": "stream", | ||
| "text": [ | ||
| "Humidity: 33.32 %\n", | ||
| "Temperature: 27.5 °C\n" | ||
| ] | ||
| } | ||
| ], | ||
| "source": [ | ||
| "py_ht = Grove_AHT20(base.PMODB, PMOD_GROVE_G3)\n", | ||
| "\n", | ||
| "humidity = py_ht.get_humidity()\n", | ||
| "temp_c = py_ht.get_temp()\n", | ||
| "print('Humidity: ', float(\"{0:.2f}\".format(humidity)), '%')\n", | ||
| "print('Temperature: ', float(\"{0:.2f}\".format(temp_c)), '°C')" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "# 2. Display on LED bar" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### Setup:\n", | ||
| "\n", | ||
| "Attached the arduino shield to the top of your board. Connect the LED bar to the G7 port on the Arduino shield. Connect the ATH20 to port G3 on the PMOD to Grove adaptor. Run the following code to initiate connection with the LED bar:" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 30, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "from pynq.lib.arduino import Grove_LEDbar\n", | ||
| "from pynq.lib.arduino import ARDUINO_GROVE_G7\n", | ||
| "\n", | ||
| "ledbar = Grove_LEDbar(base.ARDUINO, ARDUINO_GROVE_G7)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### Reset the LED Bar\n", | ||
| "\n", | ||
| "The default state of the LED could be all sorts of things. Let's turn it fully of so we have somewhere to work from." | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 31, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "# Turn the LED bar off\n", | ||
| "ledbar.reset()" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "### Decide on Your Temperature Scale\n", | ||
| "\n", | ||
| "We want to make a visual thermometer that displays the temperature across a range that we care about. Perhaps this is simply comfortable room temperature (somewhere between 60 and 80 degrees fahrenheit), or it's the temperature of industrial equipment that cannot get above 150 degrees fahrenheit. What we will do next is establish this range and \"map\" it to the 10 bars on the LED indicator, with the red being the highest end of the range and the green being the lowest. For this example, lets the temperature we might find in a house in Colorado, 60 to 80 degrees fahrenheit, or about 15 to 25 degrees celsius (remember, our sensors read celsius, so make sure to convert when necessary)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 32, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "max_temp = 25\n", | ||
| "min_temp = 15\n", | ||
| "temp_range = max_temp - min_temp" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "markdown", | ||
| "metadata": {}, | ||
| "source": [ | ||
| "We should consider \"edge cases\" where our temperature falls above or below our range. These are always good to check before we proceed. In this situation, we will illuminate all LEDs if the temperature is above the range, and 1 LED if it is below the range.\n", | ||
| "\n", | ||
| "Once we have ruled out edge cases, we can deal with the case where our temperature falls within our allotted range. Because there are 10 bars, we can only only display the temperature in tenths of our range. Knowing what our range is, we can calculate a number between 0 and 10 to represent where within the range we fall. Note that we multiply by 10 and round to the nearest whole number to make sure we pass an integer between 0 and 10 to the function up_to().\n", | ||
| "\n", | ||
| "Because our LED bar speaks in binary, We are going to use a function \"up_to\" which produces the binary value required to light up the bars \"up to\" a certain index on the led bar, given that index. This is covered more in depth in the [LED Bar notebook](../bootcamp_sessions/3_led_bar.ipynb)." | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 33, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "def up_to(index):\n", | ||
| " return ~(2**(10 - index) - 1)" | ||
| ] | ||
| }, | ||
| { | ||
| "cell_type": "code", | ||
| "execution_count": 34, | ||
| "metadata": {}, | ||
| "outputs": [], | ||
| "source": [ | ||
| "# if temperature is above our range of measurement\n", | ||
| "if temp_c > max_temp:\n", | ||
| " ledbar.write_binary(up_to(10))\n", | ||
| "# if temperature is below our range of measurement\n", | ||
| "elif temp_c < min_temp:\n", | ||
| " ledbar.write_binary(up_to(0))\n", | ||
| "# otherwise is falls within our range\n", | ||
| "else:\n", | ||
| " temp_index = int(round(((temp_c - min_temp)/temp_range)*10))\n", | ||
| " ledbar.write_binary(up_to(temp_index))" | ||
| ] | ||
| } | ||
| ], | ||
| "metadata": { | ||
| "kernelspec": { | ||
| "display_name": "Python 3", | ||
| "language": "python", | ||
| "name": "python3" | ||
| }, | ||
| "language_info": { | ||
| "codemirror_mode": { | ||
| "name": "ipython", | ||
| "version": 3 | ||
| }, | ||
| "file_extension": ".py", | ||
| "mimetype": "text/x-python", | ||
| "name": "python", | ||
| "nbconvert_exporter": "python", | ||
| "pygments_lexer": "ipython3", | ||
| "version": "3.6.5" | ||
| } | ||
| }, | ||
| "nbformat": 4, | ||
| "nbformat_minor": 2 | ||
| } |
Oops, something went wrong.