Skip to content

Commit 0ed7e90

Browse files
committed
Update readme
1 parent f9ad8a6 commit 0ed7e90

File tree

3 files changed

+25
-5
lines changed

3 files changed

+25
-5
lines changed

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,28 @@
1-
# hackAir Arduino WiFi Shield
1+
![hackAIR banner with logo](banner.png)
22

3-
## Changelog
3+
hackAIR is an EU-funded project aiming to develop an open technology platform for citizen observatories on air quality. Air pollution is an environmental issue with serious health and lifespan implications. However, it remains difficult for citizens to assess their exposure to air pollution and air quality issues in their country. Official air quality sensors are often few and far between, coverage is poor outside cities, and their data is not always easily accessible.
44

5-
### Version 2
5+
## hackAIR WiFi shield
6+
7+
The hackAIR WiFi shield is a do-it-yourself solution for adding wireless connectivity to an Arduino node on the cheap. It's based around a custom PCB and the ESP8266 WiFi module and it's supported by the hackAIR firmware. All the network-related work is done by the WiFi module that can be controlled by simple serial commands. The [hackAIR library for Arduino](https://github.com/hackair-project/hackAir-Arduino) contains helpful wrapper functions to make using the shield easy and simple.
8+
9+
![PCB render](pcb.png)
10+
11+
### Where to order
12+
13+
PCBs can be ordered directly from OSHPark [here](https://oshpark.com/shared_projects/u7Z6d8GR). The source files are included in this repository so anyone can order from their manufacturer of choice. Work is being done to make complete kits available soon.
14+
15+
### Documentation
16+
17+
Documentation for this shield is under construction [here](https://hackair-project.github.io/hackAir-Arduino/wifi/).
18+
19+
### Technicalities
20+
21+
The PCB is designed using the open source EDA called [KiCad](http://kicad-pcb.org/). The PCB render shown above is created using [PcbDraw](https://github.com/yaqwsx/PcbDraw).
22+
23+
### Changelog
24+
25+
#### Version 2
626
- [Add] Pull-down resistor for pin 2 (ESP Reset) so the user can flash the Arduino without jumpers
727
- [Add] Silkscreen markings for pin numbers
828
- [Add] Programming header for the WiFi module
@@ -14,6 +34,6 @@
1434
- [Fix] Fixed the footprint of Q1 (DSG -> DGS)
1535
- [Fix] Changed the foorprints of all non-electrolytic caps to be wider.
1636
- [Fix] Fixed the silkscreen of U1 appearing on the wrong layer.
17-
18-
### Version 1
37+
38+
#### Version 1
1939
Initial release

banner.png

51.8 KB
Loading

pcb.png

85.6 KB
Loading

0 commit comments

Comments
 (0)