Skip to content

Commit 8f2fc85

Browse files
Merge pull request #539 from arduino/jhansson-ard/giga-display-shield-lastQA
GIGA Display Shield Last QA
2 parents 5228e89 + 40ec9f6 commit 8f2fc85

File tree

10 files changed

+35
-33
lines changed

10 files changed

+35
-33
lines changed

content/hardware/10.mega/shields/giga-display-shield/features.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<FeatureDescription>
22

3-
The GIGA Display Shield has a 3.97” 480x800 RGB touch screen, a digital microphone, a 6 Axis IMU and an RGB LED. The shield can easily be mounted on the GIGA R1 WiFi board.
3+
The GIGA Display Shield has a 3.97” 480x800 RGB touch screen, a digital microphone, a 6-axis IMU and an RGB LED. The shield can easily be mounted on the GIGA R1 WiFi board.
44

55
Utilizing the GIGA R1 WiFi's fast 480 MHz microcontroller, you can build powerful UIs, use interactive 3D animations, display camera feed and much more. The shield is compatible with a wide range of graphics libraries, including [LVGL](https://github.com/lvgl/lvgl), [GFX](https://github.com/bcmi-labs/Arduino_GigaDisplay_GFX/) and [ArduinoGraphics](https://github.com/arduino-libraries/ArduinoGraphics/).
66

@@ -9,7 +9,7 @@ Utilizing the GIGA R1 WiFi's fast 480 MHz microcontroller, you can build powerfu
99
<FeatureList>
1010

1111
<Feature title="3.97” 480x800 RGB touch screen" image="configurability">
12-
A back-light screen with the resolution of a 4.0 TFT-LCD which contains 480x800 pixels, and can display up to 16.7M colors.
12+
A back-light screen with the resolution of a 4.0 TFT-LCD which contains 480x800 pixels, and can display up to 16.7 million colors.
1313
</Feature>
1414

1515
<Feature title="LVGL" image="configurability">
@@ -30,7 +30,7 @@ The shield has an IMU that can provide precise acceleration, angular rate measur
3030
</Feature>
3131

3232
<Feature title="Camera Support" image="camera">
33-
This shield has a camera connector with support for a range of ArduCam cameras. Display the camera feed directly on the display!
33+
This shield has a camera connector with support for a range of Arducam® cameras. Display the camera feed directly on the display!
3434
<FeatureLink title="Camera Guide" url="/tutorials/giga-display-shield/camera-tutorial"/>
3535
</Feature>
3636

content/hardware/10.mega/shields/giga-display-shield/tech-specs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Sensors:
1717
Pins:
1818
LED: 1 RGB LED (I2C)
1919
Power:
20-
Circuit operating voltage: 3.3V
20+
Circuit operating voltage: 3.3 V
2121
Dimensions:
2222
Width: 80 mm
2323
Length: 106 mm

content/hardware/10.mega/shields/giga-display-shield/tutorials/01.getting-started/getting-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ In this guide you will learn how to set your board up with the GIGA R1 WiFi boar
1414

1515
## Hardware & Software Needed
1616

17-
- [GIGA R1 WiFi](https://store.arduino.cc/products/giga-r1-wifi).
18-
- [GIGA Display Shield](https://store.arduino.cc/products/giga-display-shield)
17+
- [Arduino GIGA R1 WiFi](https://store.arduino.cc/products/giga-r1-wifi)
18+
- [Arduino GIGA Display Shield](https://store.arduino.cc/products/giga-display-shield)
1919
- [Arduino IDE](https://www.arduino.cc/en/software)
2020

2121
## Overview
@@ -112,7 +112,7 @@ The connector is located just above the display, which makes it possible to see
112112

113113
This shield has a built-in IMU module, the **BMI270**. This sensor can be used for a number of purposes, for example to automatically orientate an object on the screen, see the following tutorial:
114114

115-
- [Giga Display Shield Automatic Orientation](/tutorials/giga-display-shield/image-orientation)
115+
- [GIGA Display Shield Automatic Orientation](/tutorials/giga-display-shield/image-orientation)
116116

117117
To access **BMI270**, use the [BMI270-250](https://www.arduino.cc/reference/en/libraries/arduino_bmi270_bmm150/) library. Please note that the sensor is not connected to the main I2C bus, so you will need to initialize the sensor on another bus. To do so, simply add the line below to the top of your sketch:
118118

content/hardware/10.mega/shields/giga-display-shield/tutorials/02.gfx-guide/gfx-guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ To access it, we can use a layer library called [Arduino_GigaDisplay_GFX](https:
1212
## Goals
1313

1414
In this guide we will cover:
15-
- Learn how to draw and print to the display,
16-
- How to draw basic shapes (circles, rectangles etc)
17-
- How to update values on the screen,
15+
- Learn how to draw and print to the display.
16+
- How to draw basic shapes (circles, rectangles etc).
17+
- How to update values on the screen.
1818

1919
## Hardware & Software Needed
2020

21-
- [GIGA R1 WiFi](/hardware/giga-r1-wifi).
22-
- [GIGA Display Shield](/hardware/giga-display-shield)
21+
- [Arduino GIGA R1 WiFi](/hardware/giga-r1-wifi)
22+
- [Arduino GIGA Display Shield](/hardware/giga-display-shield)
2323
- [Arduino IDE](https://www.arduino.cc/en/software)
2424

2525
## Installation
@@ -227,7 +227,7 @@ void changeSwitch() {
227227
}
228228
```
229229

230-
***Learn more about the Giga Display's touch interface in the [Touch Interface Guide](/tutorials/giga-display-shield/basic-touch).***
230+
***Learn more about the GIGA Display's touch interface in the [Touch Interface Guide](/tutorials/giga-display-shield/basic-touch).***
231231

232232
## Summary
233233

content/hardware/10.mega/shields/giga-display-shield/tutorials/03.lvgl-guide/content.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ tags: [Display, LVGL]
99

1010
[LVGL](https://lvgl.io/) is a graphical framework for building powerful UIs, and is fully compatible with the GIGA Display Shield. It allows you to build UIs, using pre-made widgets like buttons, images, loading bars, sliders, checkboxes, etc. It also allows you to fully customize the screenspace on the display. In this guide, we will go through some of the different components, so you can learn how to best implement it in your projects.
1111

12-
***LVGL is a large framework, and the aim of this guide is to get you familiar with it. For much more information, visit the [LVGL documentation](https://docs.lvgl.io/master/)***
12+
***LVGL is a large framework, and the aim of this guide is to get you familiar with it. For much more information, visit the [LVGL documentation](https://docs.lvgl.io/master/).***
1313

1414
## Hardware & Software Needed
1515

@@ -46,7 +46,7 @@ In this section, we will go through the fundamental elements of an LVGL sketch:
4646
- how to add an object to the grid,
4747
- how to update the display.
4848

49-
***At the end of this section, you will find a complete example which implements a grid layout. You can [skip directly to the example](#minimal-example), but if you have no prior experience with lvgl, we recommend you follow the information below.***
49+
***At the end of this section, you will find a complete example which implements a grid layout. You can [skip directly to the example](#minimal-example), but if you have no prior experience with LVGL, we recommend you follow the information below.***
5050

5151
### Display Shield Configuration
5252

@@ -114,7 +114,8 @@ Now that the columns and rows have been defined the overall screen needs to be t
114114
lv_obj_set_size(grid, Display.width(), Display.height());
115115
```
116116

117-
Then, just to test it out, let's add an object to the grid.
117+
Then, just to test it out, let's add an object to the grid:
118+
118119
- first declare the `obj` pointer add it to the `grid`,
119120
- then we set the grid cell via `lv_obj_set_grid_cell()` method.
120121

@@ -226,7 +227,7 @@ To make sure we see the image use the align function to make it centered. Then a
226227
lv_obj_set_size(img1, 200, 150);
227228
```
228229

229-
![An image rendered on the Display Shield with LVGL](assets/image.png)
230+
![An image rendered on the GIGA Display Shield with LVGL](assets/image.png)
230231

231232
**Full Example:**
232233

@@ -299,7 +300,7 @@ The startup state of the checkbox can be set with `lv_obj_add_state()`. Where th
299300
lv_obj_add_state(checkbox, LV_STATE_CHECKED);
300301
```
301302

302-
![Checkboxes rendered on the Display Shield with LVGL](assets/checkboxes.png)
303+
![Checkboxes rendered on the GIGA Display Shield with LVGL](assets/checkboxes.png)
303304

304305
**Full Example:**
305306

@@ -374,7 +375,7 @@ The size of the radio button is set with `lv_style_set_radius`. To make the radi
374375
lv_style_set_bg_img_src(&style_radio_chk, NULL);
375376
```
376377

377-
![Radio buttons rendered on the Display Shield with LVGL](assets/radiobuttons.png)
378+
![Radio buttons rendered on the GIGA Display Shield with LVGL](assets/radiobuttons.png)
378379

379380
**Full Example:**
380381

@@ -469,7 +470,7 @@ If you want a label by your slider it can be created like you would create any o
469470
lv_obj_align_to(label, slider, LV_ALIGN_OUT_BOTTOM_MID, 0, 10);
470471
```
471472

472-
![Slider rendered on the Display Shield with LVGL](assets/slider.png)
473+
![Slider rendered on the GIGA Display Shield with LVGL](assets/slider.png)
473474

474475
**Full Example:**
475476

@@ -593,7 +594,7 @@ static void set_bar_val(void * bar, int32_t val) {
593594
}
594595
```
595596

596-
![A bar rendered on the Display Shield with LVGL](assets/bar.gif)
597+
![A bar rendered on the GIGA Display Shield with LVGL](assets/bar.gif)
597598

598599
**Full Example:**
599600

@@ -708,7 +709,8 @@ static void button_event_callback(lv_event_t * e) {
708709
}
709710
```
710711

711-
![A button rendered on the Display Shield with LVGL](assets/button.png)
712+
![A button rendered on the GIGA Display Shield with LVGL](assets/button.png)
713+
712714
![Button when it has been pressed](assets/button-clicked.png)
713715

714716
**Full Example:**

content/hardware/10.mega/shields/giga-display-shield/tutorials/04.basic-draw-and-image/content.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This is a great tutorial for getting started with your shield and exploring what
1414

1515
## Hardware & Software Needed
1616

17-
- [Arduino GIGA R1 WiFi](/hardware/giga-r1-wifi).
17+
- [Arduino GIGA R1 WiFi](/hardware/giga-r1-wifi)
1818
- [Arduino GIGA Display Shield](/hardware/giga-display-shield)
1919
- [Arduino IDE](https://www.arduino.cc/en/software)
2020
- [ArduinoGraphics library](https://www.arduino.cc/reference/en/libraries/arduinographics/)
@@ -140,7 +140,7 @@ Using an online image converter you can pick any image you would like to be disp
140140

141141
### Displaying the Image on the Display
142142

143-
We will be using the example sketch "ArduinoLogo" as the basis for the sketch that lets us display an image. The example sketch can be found under **File->Examples->Arduino_H7_Video->ArduinoLogo**.
143+
We will be using the example sketch "ArduinoLogo" as the basis for the sketch that lets us display an image. The example sketch can be found under **File > Examples > Arduino_H7_Video > ArduinoLogo**.
144144

145145
Running the example sketch as is will display the Arduino logo on the screen, like in the image below:
146146

@@ -202,4 +202,4 @@ void loop() { }
202202

203203
## Conclusion
204204

205-
In this tutorial, we used basic drawing functions with the Giga Display Shield. Using the `ArduinoGraphics` library we managed to draw the Arduino logo with just a few simple commands. Using these basic functions it is possible to create most images that you can think of. Now you can let your imagination run wild and draw to your heart's content!
205+
In this tutorial, we used basic drawing functions with the GIGA Display Shield. Using the `ArduinoGraphics` library we managed to draw the Arduino logo with just a few simple commands. Using these basic functions it is possible to create most images that you can think of. Now you can let your imagination run wild and draw to your heart's content!

content/hardware/10.mega/shields/giga-display-shield/tutorials/05.basic-touch/basic-touch.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ This library is used to return the number of contact points, and the `x,y` coord
1111

1212
## Hardware & Software Needed
1313

14-
- [GIGA R1 WiFi](/hardware/giga-r1-wifi).
15-
- [GIGA Display Shield](/hardware/giga-display-shield)
14+
- [Arduino GIGA R1 WiFi](/hardware/giga-r1-wifi)
15+
- [Arduino GIGA Display Shield](/hardware/giga-display-shield)
1616
- [Arduino IDE](https://www.arduino.cc/en/software)
1717

1818
## Overview
1919

20-
The **Arduino_GigaDisplayTouch** library can be used in combination with any of the available graphics libraries ([see available options](/tutorials/giga-display-shield/getting-started#overview)), but is independent from them and works standalalone.
20+
The **Arduino_GigaDisplayTouch** library can be used in combination with any of the available graphics libraries ([see available options](/tutorials/giga-display-shield/getting-started#overview)), but is independent from them and works standalone.
2121

2222
The library has two methods of reading sensor data:
2323
- **Polling** - continuously read the sensor data through the `getTouchPoint()` method.
@@ -69,7 +69,7 @@ The IRQ example demonstrates how to set up an interrupt that triggers a function
6969

7070
## Delay Example
7171

72-
An important factor to consider is that the `loop()` on the GIGA R1 is executed at a very fast rate, meaning that you will register several touches each time you touch the screen.
72+
An important factor to consider is that the `loop()` on the GIGA R1 WiFi is executed at a very fast rate, meaning that you will register several touches each time you touch the screen.
7373

7474
This means that whenever you tap the screen, even quickly, you register somewhere between **5-20 touches**. So if you want a specific function to only execute once on a specific touch point, you will need to implement a delay in your code.
7575

content/hardware/10.mega/shields/giga-display-shield/tutorials/06.image-orientation/content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ Any image could be used in the sketch. This tutorial and the example uses an ima
170170

171171
Now try rotating your device to see if the image behaves correctly. If the image does not rotate correctly have another look at the values you entered into the previous sketch. It might help to try and run the simple IMU readings printer sketch to take a quick look at the IMU values in the serial monitor. This will help you figure out what values should be considered when the device is being moved.
172172

173-
[Gif of the orientation sketch running on the screen]()
173+
[GIF of the orientation sketch running on the screen]()
174174

175175
## Conclusion
176176

content/hardware/10.mega/shields/giga-display-shield/tutorials/07.microphone-tutorial/content.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ A callback function needs to be set, which is called when new PDM data is ready
5454

5555
`onPDMdata` is the callback function that we will have to create at the end of the sketch.
5656

57-
Now when we want to print or use the readings lets do it with a `for` loop since they are inside a buffer, which we need to step through. But lets first check so that there are readings to be printed with a simple `if` statement. These lines will step through the buffer until all the readings inside are printed and then start over:
57+
Now when we want to print or use the readings let's do it with a `for` loop since they are inside a buffer, which we need to step through. But let's first check so that there are readings to be printed with a simple `if` statement. These lines will step through the buffer until all the readings inside are printed and then start over:
5858

5959
```arduino
6060
if (samplesRead) {
@@ -97,7 +97,7 @@ This sketch uses the [Arduino_Graphics library](https://www.arduino.cc/reference
9797

9898
### Volume Indication Sketch
9999

100-
This sketch requires the [lvgl library](https://github.com/lvgl/lvgl), please make sure that is installed before you upload the sketch. The sketch will show a bar on the screen that is animated when noise is made, functionally making it display the volume of the microphones readings. For more information about using lvgl with the GIGA Display Shield, take a look at our documentation [here](tutorials/lvgl-guide). You will find the full sketch below:
100+
This sketch requires the [lvgl library](https://github.com/lvgl/lvgl), please make sure that is installed before you upload the sketch. The sketch will show a bar on the screen that is animated when noise is made, functionally making it display the volume of the microphones readings. For more information about using LVGL with the GIGA Display Shield, take a look at our documentation [here](tutorials/lvgl-guide). You will find the full sketch below:
101101

102102
```arduino
103103
#include <PDM.h>

content/hardware/10.mega/shields/giga-display-shield/tutorials/08.camera-tutorial/content.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ tags: [Display, Camera, ArduCam]
77

88
## Introduction
99

10-
The GIGA Display Shield comes with an Arducam camera connector. In this tutorial, we will go through what cameras are compatible with the display shield, how to connect the camera, and how to run a sketch to stream the camera feed to the display.
10+
The GIGA Display Shield comes with an Arducam® camera connector. In this tutorial, we will go through what cameras are compatible with the display shield, how to connect the camera, and how to run a sketch to stream the camera feed to the display.
1111

1212
## Hardware & Software Needed
1313

0 commit comments

Comments
 (0)