-
-
Notifications
You must be signed in to change notification settings - Fork 459
[PXCT-1073] Tutorial from library - Uno R4 Capacitor Tutorial #2559
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+150
−0
Merged
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
e5ad416
Created tutorial
pedromsousalima f108b33
Apply suggestions from code review
jhansson-ard 5ae0e30
Update content/hardware/02.hero/boards/uno-r4-wifi/tutorials/touch/co…
jhansson-ard 3e39561
Fixed with guidelines
pedromsousalima 72aa11e
Linter
pedromsousalima cd8f677
Update content.md
pedromsousalima 70c799d
Apply suggestion from @TaddyHC
pedromsousalima af36c52
Apply suggestion from @TaddyHC
pedromsousalima 84ce48f
Apply suggestion from @TaddyHC
pedromsousalima 0734280
Apply suggestion from @TaddyHC
pedromsousalima File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next
Next commit
Created tutorial
- Loading branch information
commit e5ad416898fce3d705732c5b2d00e0cf1b70074a
There are no files selected for viewing
Binary file added
BIN
+58.4 KB
...dware/02.hero/boards/uno-r4-wifi/tutorials/touch/assets/HoockupGuideExample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+187 KB
.../hardware/02.hero/boards/uno-r4-wifi/tutorials/touch/assets/Touch_Cover_001.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
130 changes: 130 additions & 0 deletions
130
content/hardware/02.hero/boards/uno-r4-wifi/tutorials/touch/content.md
This file contains hidden or 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,130 @@ | ||
--- | ||
title: Uno R4 Capacitor Tutorial | ||
description: Learn to use the built-in capacitive sensing capabilities of the Arduino® Uno R4. | ||
tags: [Arduino, Capacitive Sensing, Uno R4] | ||
author: Pedro Lima | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
--- | ||
|
||
Capacitive sensing is a technology that detects changes in capacitance to determine the presence or absence of a conductive object, such as a human finger. This principle is widely used in touch-sensitive devices. The Arduino® Uno R4, both the [WiFi](https://store.arduino.cc/products/arduino-uno-r4-wifi) and [Minima](https://store.arduino.cc/products/arduino-uno-r4-minima) versions, come equipped with built-in capacitive sensing capabilities, making it easier to integrate touch inputs into your projects. | ||
|
||
 | ||
pedromsousalima marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
TaddyHC marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## How Capacitive Sensing Works | ||
|
||
Imagine the sensor as creating an invisible electric field around itself. When a conductive object (like your finger) approaches, it's like dropping a stone into a calm pond - the field gets disturbed. The sensor detects this disturbance as a change in capacitance, which is essentially how much electrical charge the system can store. | ||
Here's the process: | ||
|
||
1. The sensor generates a small electric field | ||
2. When you touch or approach the sensor, your body acts like a conductor | ||
3. This changes the capacitance of the system | ||
4. The microcontroller measures this change and determines if it's significant enough to register as a "touch" | ||
|
||
|
||
|
||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Using Capacitive Sensing on the Uno R4 | ||
|
||
The Uno R4 features a Capacitive Touch Sensing Unit (CTSU) that allows you to use certain pins as capacitive touch inputs. To utilize these capabilities, you can use the [Arduino_CapacitiveTouch library](https://github.com/arduino-libraries/Arduino_CapacitiveTouch). | ||
|
||
### Compatible Pins | ||
|
||
For both the Uno R4 WiFi and Minima, the compatible pins for capacitive touch are listed in the [Arduino_CapacitiveTouch library documentation](https://github.com/arduino-libraries/Arduino_CapacitiveTouch?tab=readme-ov-file#compatible-pins). | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
**Arduino® UNO-R4 Minima:** | ||
| Arduino Pin | Touch Sensor Channel (TS#) | Channel Control Index (CHAC idx) | Channel Control Bit Mask (CHAC val) | | ||
|--------------|----------------------------|----------------------------------|-------------------------------------| | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| D0 | 9 | 1 | (1 << 1) | | ||
| D1 | 8 | 1 | (1 << 0) | | ||
| D2 | 34 | 4 | (1 << 2) | | ||
| D3 | 13 | 1 | (1 << 5) | | ||
| D8 | 11 | 1 | (1 << 3) | | ||
| D9 | 2 | 0 | (1 << 2) | | ||
| D11 | 10 | 1 | (1 << 2) | | ||
| D13 | 12 | 1 | (1 << 4) | | ||
| A1 (D15) | 21 | 2 | (1 << 5) | | ||
| A2 (D16) | 22 | 2 | (1 << 6) | | ||
| LOVE_BUTTON | 0 | 0 | (1 << 0) | | ||
pedromsousalima marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
**Arduino® UNO-R4 WiFi:** | ||
| Arduino Pin | Touch Sensor Channel (TS#) | Channel Control Index (CHAC idx) | Channel Control Bit Mask (CHAC val) | | ||
|--------------|----------------------------|----------------------------------|-------------------------------------| | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| D0 | 9 | 1 | (1 << 1) | | ||
| D1 | 8 | 1 | (1 << 0) | | ||
| D2 | 13 | 1 | (1 << 5) | | ||
| D3 | 34 | 4 | (1 << 2) | | ||
| D6 | 12 | 1 | (1 << 4) | | ||
| D8 | 11 | 1 | (1 << 3) | | ||
| D9 | 2 | 0 | (1 << 2) | | ||
| D11 | 7 | 0 | (1 << 7) | | ||
| D12 | 6 | 0 | (1 << 6) | | ||
| A1 (D15) | 21 | 2 | (1 << 5) | | ||
| A2 (D16) | 22 | 2 | (1 << 6) | | ||
| LOVE_BUTTON | 27 | 3 | (1 << 3) | | ||
|
||
|
||
### Library Functions | ||
|
||
The Arduino_CapacitiveTouch library provides several functions to work with capacitive touch inputs: | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- **```CapacitiveTouch(uint8_t pin)```** Constructs a capacitive touch sensor for the given pin. | ||
- **```bool begin()```** Initializes the sensor and configures the pin and hardware. | ||
- **```int read()```** Reads the raw sensor value and returns it. | ||
- **```bool isTouched()```** Checks if the sensor is touched based on the threshold. | ||
- **```void setThreshold(int threshold)```** Sets the detection threshold for touch sensitivity. | ||
- **```int getThreshold()```** Retrieves the current detection threshold. | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
For more detailed usage and examples, refer to the [CapacitiveSensor library documentation](https://docs.arduino.cc/libraries/capacitivesensor/). | ||
pedromsousalima marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Example Code | ||
|
||
Here's a simple example to get you started with capacitive sensing on the Uno R4. | ||
For this example we are connecting a single piece of any conductive material to the pin ```D0``` on the Board. | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
 | ||
pedromsousalima marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
**Note:** | ||
You will first need to install the library [Arduino_CapacitiveTouch](https://docs.arduino.cc/libraries/capacitivesensor/): | ||
```Arduino IDE: Library Manager → Search "Arduino_CapacitiveTouch" → Install``` | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
```ARDUINO | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
#include "Arduino_CapacitiveTouch.h" | ||
|
||
CapacitiveTouch touchButton = CapacitiveTouch(D0); | ||
|
||
void setup() { | ||
Serial.begin(9600); | ||
|
||
if(touchButton.begin()){ | ||
Serial.println("Capacitive touch sensor initialized."); | ||
} else { | ||
Serial.println("Failed to initialize capacitive touch sensor. Please use a supported pin."); | ||
while(true); | ||
} | ||
|
||
touchButton.setThreshold(2000); | ||
} | ||
|
||
void loop() { | ||
int sensorValue = touchButton.read(); | ||
Serial.print("Raw value: "); | ||
Serial.println(sensorValue); | ||
|
||
if (touchButton.isTouched()) { | ||
Serial.println("Button touched!"); | ||
} | ||
|
||
delay(100); | ||
} | ||
``` | ||
|
||
## Creative Project Ideas | ||
Now that you understand the basics, here are some project ideas: | ||
|
||
**Touch-Controlled Night Light -** Create a lamp that turns on/off with a touch | ||
**Capacitive Touch Piano -** Use multiple pins to create touch-sensitive keys | ||
**Smart Home Controller -** Touch different areas to control various devices | ||
**Interactive Art Installation -** Create touch-responsive visual or audio effects | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Conclusion | ||
|
||
The built-in capacitive sensing capabilities of the Arduino® Uno R4 provide an excellent way to add touch inputs to your projects. By leveraging the Arduino_CapacitiveTouch library, you can easily integrate touch-sensitive features, enhancing the interactivity and functionality of your designs. Whether you're building a simple touch interface or a more complex interactive system, the Uno R4's capacitive sensing features offer a versatile and user-friendly solution. | ||
Remember to experiment with threshold values and consider the environment where your project will be used, as factors like humidity and nearby electronics can affect sensitivity. With practice, you'll develop an intuitive understanding of how to tune these sensors for optimal performance in your specific applications. | ||
jhansson-ard marked this conversation as resolved.
Show resolved
Hide resolved
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.