Skip to content

Commit f826b0b

Browse files
author
ShawnHymel
committed
Updated README.md files with better descriptions.
1 parent 0a1885d commit f826b0b

File tree

4 files changed

+41
-6
lines changed

4 files changed

+41
-6
lines changed

Firmware/AT42QT1010_Arduino_Example/AT42QT1010_Arduino_Example.ino

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
By default, the board will light up the green LED when the pad
1919
is touched. A wire may also be connected from OUT on the
2020
breakout board to a digital input pin on an Arduino. This signal
21-
is normally LOW but goes HIGH on a touch event.
21+
is normally LOW but goes HIGH on a touch detection.
2222
2323
The "LED Enable" solder jumper may be de-soldered in order to
2424
control the LED directly from the LED pin. This is useful if you
@@ -30,11 +30,11 @@
3030
3131
+5V VDD Power supply
3232
GND GND Ground
33-
2 OUT Capacitive touch event output
33+
2 OUT Capacitive touch state output
3434
*/
3535

3636
// Constants
37-
const int TOUCH_BUTTON_PIN = 2; // Input pin for touch events
37+
const int TOUCH_BUTTON_PIN = 2; // Input pin for touch state
3838
const int LED_PIN = 13; // Pin number for LED
3939

4040
// Global Variables
@@ -55,7 +55,7 @@ void loop() {
5555
// Read the state of the capacitive touch board
5656
buttonState = digitalRead(TOUCH_BUTTON_PIN);
5757

58-
// If a touch event occurs, turn on the LED
58+
// If a touch is detected, turn on the LED
5959
if (buttonState == HIGH) {
6060
digitalWrite(LED_PIN, HIGH);
6161
} else {

Hardware/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# What Are these Files?
2+
3+
The .sch and .brd files hare are Eagle CAD schematic and PCB design files.
4+
5+
These files were created with Eagle 6.5.0, you'll need Eagle 6.5 or later to open them up. There is a free, lite, version of Eagle available from [cadsoftusa.com](cadsoftusa.com).
6+
7+
# License
8+
9+
This product is open source! These Eagle files are released under the Creative Commons Share-Alike Attribution license ([CC BY-SA 3.0](http://creativecommons.org/licenses/by-sa/3.0/us/)).
10+
11+
Please use, reuse, and modify these files as you see fit. Please maintain attribution and release anything derivative under the same license.
12+
13+
- Your friends at SparkFun.

Production Files/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
These are the production files SparkFun uses for printing PCBs, as well as the Eagle files for our test beds.

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,25 @@
1-
AT42QT1010_Capacitive_Touch_Breakout
1+
AT42QT1010 Capacitive Touch Breakout
22
====================================
33

4-
Breakout board for Atmel's QTouch AT42QT1010 single capacitive sensor.
4+
[![AT42QT1010 Capacitive Touch Breakout Board](https://dlnmh9ip6v2uc.cloudfront.net/images/products/1/2/0/4/1/12041-01.jpg)
5+
*AT42QT1010 Capacitive Touch Breakout Board (SEN-12041)*](https://www.sparkfun.com/products/12041)
6+
7+
Capacitive sense breakout board. [The datasheet can be found here.](http://www.atmel.com/Images/Atmel-9541-AT42-QTouch-BSW-AT42QT1010_Datasheet.pdf)
8+
9+
This part was created in Eagle v6.5.0. Example sketches were created in Arduino v1.0.5.
10+
11+
Repository Contents
12+
-------------------
13+
14+
* **/Firmware** - Example Arduino sketches
15+
* **/Hardware** - All Eagle design files (.brd, .sch, .STL)
16+
* **/Production** - Test bed files and production panel files
17+
18+
Version History
19+
---------------
20+
* **v1.0** Initial release
21+
22+
License Information
23+
-------------------
24+
The hardware is released under [Creative Commons Share-alike 3.0](http://creativecommons.org/licenses/by-sa/3.0/).
25+
All other code is open source so please feel free to do anything you want with it; you buy me a beer if you use this and we meet someday ([Beerware license](http://en.wikipedia.org/wiki/Beerware)).

0 commit comments

Comments
 (0)