Skip to content

Commit ae078b8

Browse files
committed
docs: add header comment to examples
1 parent b95fb0d commit ae078b8

File tree

2 files changed

+36
-12
lines changed

2 files changed

+36
-12
lines changed

examples/Touch_IRQ/Touch_IRQ.ino

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
1-
/*
2-
Touch_IRQ
3-
4-
created 03 May 2023
5-
by Leonardo Cavagnis
6-
*/
1+
/*
2+
* Touch_IRQ.ino
3+
*
4+
* This example shows how to get the number of points and the coordinates of the first touch points detected by the touch controller using interrupts.
5+
*
6+
* The setup() function initializes the serial communication and the touch controller. Whenever a touch event is detcted, the gigaTouchHandler function is called that prints the number of points and first touch co-ordinates to the Serial Monitor. The loop() function is empty because the touch controller is configured to work with interrupts.
7+
*
8+
* For the polling version of this example, see Touch_Polling.ino
9+
*
10+
* Instructions:
11+
* 1. Connect your GIGA Display Shield (ASX00039) to a GIGA R1 WiFi (ABX00063) board .
12+
* 2. Upload this sketch to your board.
13+
* 3. Open the Serial Monitor.
14+
* 4. Touch the screen with your finger(s) and view the coordinates printed on the Serial Monitor.
15+
*
16+
* Initial author: Leonardo Cavagnis @leonardocavagnis
17+
* Created: 03 May 2023
18+
*/
719

820
#include "Arduino_GigaDisplayTouch.h"
921

examples/Touch_Polling/Touch_Polling.ino

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
1-
/*
2-
Touch_Polling
3-
4-
created 03 May 2023
5-
by Leonardo Cavagnis
6-
*/
1+
/*
2+
* Touch_Polling.ino
3+
*
4+
* This example shows how to get the number of points and the coordinates of the first touch points detected by the touch controller using polling.
5+
*
6+
* The setup() function initializes the serial communication and the touch controller. The loop() function continuously checks to see if a touch event is detected. Whenever a touch event is detcted, that prints the number of points and first touch co-ordinates to the Serial Monitor.
7+
*
8+
* For the interrupt version of this example, see Touch_IRQ.ino
9+
*
10+
* Instructions:
11+
* 1. Connect your GIGA Display Shield (ASX00039) to a GIGA R1 WiFi (ABX00063) board .
12+
* 2. Upload this sketch to your board.
13+
* 3. Open the Serial Monitor.
14+
* 4. Touch the screen with your finger(s) and view the coordinates printed on the Serial Monitor.
15+
*
16+
* Initial author: Leonardo Cavagnis @leonardocavagnis
17+
* Created: 03 May 2023
18+
*/
719

820
#include "Arduino_GigaDisplayTouch.h"
921

0 commit comments

Comments
 (0)