[PXCT-1073] Tutorial from library - Uno R4 Capacitor Tutorial #2559
Conversation
Preview Deployment🚀 Preview this PR: https://68668065e403a30b6360e1ea--docs-content.netlify.app |
There was a problem hiding this comment.
Hey @pedromsousalima , I have left some observations for the tutorial 🙂 Please check them out, I think they should be worth looking into. With the observations applied, I think it should be ready for next step.
| @@ -0,0 +1,130 @@ | |||
| --- | |||
| title: Uno R4 Capacitor Tutorial | |||
There was a problem hiding this comment.
| title: Uno R4 Capacitor Tutorial | |
| title: Uno R4 Capacitive-Touch Tutorial. |
I'd like to suggest this title since it correlates more naturally with the topic and the library that the tutorial will focus on, the capacitive touch chracteristic.
| description: Learn to use the built-in capacitive sensing capabilities of the Arduino® Uno R4. | ||
| tags: [Arduino, Capacitive Sensing, Uno R4] | ||
| author: Pedro Lima |
There was a problem hiding this comment.
Here it would be nice to add additional metadata keys that we have as well for other documentation, like:
| description: Learn to use the built-in capacitive sensing capabilities of the Arduino® Uno R4. | |
| tags: [Arduino, Capacitive Sensing, Uno R4] | |
| author: Pedro Lima | |
| difficulty: beginner | |
| description: Learn to use the built-in capacitive sensing capabilities of the Arduino® Uno R4. | |
| tags: [Arduino, Capacitive Sensing, Uno R4] | |
| author: Pedro Lima | |
| hardware: | |
| - hardware/02.hero/boards/uno-r4-wifi | |
| - hardware/02.hero/boards/uno-r4-minima | |
| software: | |
| - ide-v2 | |
| - web-editor |
|
|
||
|
|
There was a problem hiding this comment.
Suggestion for spacing removal
| **Arduino® UNO-R4 Minima:** | ||
| | Arduino Pin | Touch Sensor Channel (TS#) | Channel Control Index (CHAC idx) | Channel Control Bit Mask (CHAC val) | | ||
| |--------------|----------------------------|----------------------------------|-------------------------------------| |
There was a problem hiding this comment.
In the preview, here I see some broken formatting:
Maybe we could apply the following update:
| **Arduino® UNO-R4 Minima:** | |
| | Arduino Pin | Touch Sensor Channel (TS#) | Channel Control Index (CHAC idx) | Channel Control Bit Mask (CHAC val) | | |
| |--------------|----------------------------|----------------------------------|-------------------------------------| | |
| **Arduino® UNO-R4 Minima:** | |
| | Arduino Pin | Touch Sensor Channel (TS#) | Channel Control Index (CHAC idx) | Channel Control Bit Mask (CHAC val) | | |
| |--------------|----------------------------|----------------------------------|-------------------------------------| |
Which separates the table title from the table itself
| **Arduino® UNO-R4 WiFi:** | ||
| | Arduino Pin | Touch Sensor Channel (TS#) | Channel Control Index (CHAC idx) | Channel Control Bit Mask (CHAC val) | | ||
| |--------------|----------------------------|----------------------------------|-------------------------------------| |
There was a problem hiding this comment.
| **Arduino® UNO-R4 WiFi:** | |
| | Arduino Pin | Touch Sensor Channel (TS#) | Channel Control Index (CHAC idx) | Channel Control Bit Mask (CHAC val) | | |
| |--------------|----------------------------|----------------------------------|-------------------------------------| | |
| **Arduino® UNO-R4 WiFi:** | |
| | Arduino Pin | Touch Sensor Channel (TS#) | Channel Control Index (CHAC idx) | Channel Control Bit Mask (CHAC val) | | |
| |--------------|----------------------------|----------------------------------|-------------------------------------| |
Similar to the table above
| 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. | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
Here I think we should add:
Goals
Required Hardware and Software
To show directly what are the goals of the tutorial, as well as the hardware and software that would be used so the reader knows the requirements right at the beginning
| 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. | ||
|
|
||
|  |
There was a problem hiding this comment.
I think it would be nice to move this to a separate and dedicated section, so the readers can assemble the hardware and understand how it works electrically. Then they can move to example section to upload the code and test it.
|
|
||
| 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. | ||
|
|
||
|  |
There was a problem hiding this comment.
I think we could add this as a duplicate after the example section, so it works as a nice visual addition of what to expect or how it would work. The image placement here is good because it shows the reader from the introduction what they are expecting to learn within the tutorial, so I think it would be nice to copy this line and add it next to the example section.
| | D13 | 12 | 1 | (1 << 4) | | ||
| | A1 (D15) | 21 | 2 | (1 << 5) | | ||
| | A2 (D16) | 22 | 2 | (1 << 6) | | ||
| | LOVE_BUTTON | 0 | 0 | (1 << 0) | |
There was a problem hiding this comment.
the lovebutton is a pin at bottom side of the minima right?
| 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. |
There was a problem hiding this comment.
I think here it would be nice to be more concise if possible, for example, like:
| 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. | |
| Capacitive sensing on the Arduino UNO R4 lets you add intuitive touch controls with minimal hardware, simply pair the board with the `Arduino_CapacitiveTouch` library. Tune the detection threshold for your environment (humidity, nearby electronics, etc.), and you can quickly scale from a single touch button to richer, multi-point interfaces. |
It would also be nice to add Next Steps section if possible
What This PR Changes
Contribution Guidelines