Skip to content

Commit d593bb2

Browse files
committed
Merge branch 'main' into IDE-2-naming
2 parents d0491f6 + 69997f1 commit d593bb2

18 files changed

+157
-71
lines changed

.github/workflows/workflow-validate.yaml

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,29 @@ on:
1010
types: [opened, synchronize, ready_for_review, reopened]
1111

1212
jobs:
13-
build:
13+
markdown:
1414
runs-on: ubuntu-latest
15-
env:
16-
ZENDESK_USER: ${{ secrets.ZENDESK_USER }}
17-
ZENDESK_PASS: ${{ secrets.ZENDESK_TOKEN }}
1815

1916
steps:
2017
- uses: actions/checkout@v1
2118

22-
- name: Lint
19+
- name: Markdownlint
2320
run: |
2421
cd _linter
2522
npm install
2623
cd ..
2724
node _linter/markdownlint.js
2825
26+
zendesk:
27+
if: github.repository_owner == 'arduino'
28+
runs-on: ubuntu-latest
29+
env:
30+
ZENDESK_USER: ${{ secrets.ZENDESK_USER }}
31+
ZENDESK_PASS: ${{ secrets.ZENDESK_TOKEN }}
32+
33+
steps:
34+
- uses: actions/checkout@v1
35+
2936
- name: Preview changes
3037
run: |
3138
cd _deploy

_deploy/zendesk.mjs

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,19 @@
11
'use strict';
22

33
// Read environment variables
4+
var authorized = true;
45
const ZENDESK_USER = process.env.ZENDESK_USER;
5-
if (!ZENDESK_USER) {
6-
throw new Error('Missing environment variable: ZENDESK_USER')
7-
}
86
const ZENDESK_PASS = process.env.ZENDESK_PASS;
9-
if (!ZENDESK_USER) {
10-
throw new Error('Missing environment variable: ZENDESK_PASS')
7+
let zendeskApiLimit;
8+
if (ZENDESK_USER && ZENDESK_PASS) {
9+
console.log('Zendesk credentials found.');
10+
zendeskApiLimit = 400;
11+
} else {
12+
console.log('Zendesk credentials not found.');
13+
zendeskApiLimit = 200;
1114
}
15+
console.log(`API requests per minute: ${zendeskApiLimit}\n`);
16+
1217
const AlgoliaID = process.env.ALGOLIA_APPLICATION_ID;
1318
const AlgoliaSecret = process.env.ALGOLIA_INDEXER_KEY;
1419
const AlgoliaIndexName = process.env.ALGOLIA_INDEX;
@@ -51,7 +56,7 @@ const client = createZendeskClient({
5156
helpcenter: true,
5257
throttle: {
5358
window: 60,
54-
limit: 400
59+
limit: zendeskApiLimit
5560
}
5661
});
5762

content/About Arduino/Courses, Workshops, and Publications/Guidelines-for-content-creation.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,7 @@ If you decide to open a website about Arduino, write a book, or develop a course
4343

4444
You are allowed to use screenshots of Arduino IDE in your course content, provided that you mention its source. You are also free to use images of Arduino products in your course or publication.
4545

46-
All editorial content on our website, including text and images, is distributed under an [Attribution-NonCommercial-ShareAlike 3.0 Unported (CC BY-NC-SA 3.0) license](https://creativecommons.org/licenses/by-nc-sa/3.0/). This means you can use them on your own derived works, in part or completely, as long as you also adopt the same license.
47-
48-
* See [Software and Licensing based on Arduino](https://support.arduino.cc/hc/en-us/articles/4415094490770-Distributing-products-based-on-Arduino).
46+
All editorial content on our website, including text and images, is distributed under an [Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0) license](https://creativecommons.org/licenses/by-sa/3.0/). This means you can use them, build upon them, and/or modify them on your own derived works, in part or completely, as long as you also adopt the same license. In particular this means that you must give appropriate credit, provide a link to the license, and indicate if changes were made. You may not apply legal terms or technological measures that restrict third parties from doing anything the license permits.
4947

5048
> If your content includes the use of components (for example, if you develop a video tutorial), you are free to use whichever brand you choose. In other words, you do not have to use original Arduino products. However, you must provide correct descriptions of the components you use. If you are using a compatible board, you may not call it “Arduino”.
5149
1.72 KB
Loading

content/Software Support/Upload/Error-2-UNKNOWN-uploading-error-no-upload-port-provided.md

Lines changed: 0 additions & 38 deletions
This file was deleted.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: "Failed uploading: no upload port provided"
3+
id: 360020831120
4+
---
5+
6+
When uploading, you may see this error:
7+
8+
```
9+
Failed uploading: no upload port provided
10+
```
11+
12+
The error will occur if no **port** has been selected.
13+
14+
Use one of these methods to select a port:
15+
16+
* In the top menu bar: Open _Tools > Port_ and click to select a port.
17+
18+
![The Tools > Port menu.](img/tools-port-uno.png)
19+
20+
* With the board selector menu (IDE 2): Click to open, then select one of the options to configure board and port selection.
21+
22+
![The board selector in IDE 2.](img/select-port.png)
23+
24+
When a board and port has been selected, this icon will be displayed:
25+
26+
![The board selector menu with a connected Arduino UNO.](img/board-selector-uno-connected.png)
27+
28+
It's useful to understand the difference between board and port selections:
29+
30+
* The **board** selection tells Arduino IDE how to compile the sketch and what protocols to use when uploading the sketch. In some cases, it will be automatically set, but it can be overridden with the _Tools > Board_ menu or in the "Select other board and port..." dialog.
31+
* The **port** selection refers to an actual board (or other device) that's connected to your computer. Many boards are automatically recognized by Arduino IDE—these boards will have their name displayed next to their port in the _Tools > Port_ menu and will have their port associated with the identified board in the board selector menu.
32+
33+
## Further reading
34+
35+
* [Select board and port in Arduino IDE](https://support.arduino.cc/hc/en-us/articles/4406856349970-Select-board-and-port-in-Arduino-IDE)
36+
* [If your board does not appear in the port menu](https://support.arduino.cc/hc/en-us/articles/4412955149586-If-your-board-does-not-appear-in-the-port-menu)

content/Software Support/Upload/Select-board-and-port-in-Arduino-IDE.md

Lines changed: 97 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,42 +7,122 @@ Learn how to select the right board and port in Arduino IDE.
77

88
---
99

10+
It's useful to understand the difference between board and port selections:
11+
12+
* The **board** selection tells Arduino IDE how to compile the sketch and what protocols to use when uploading the sketch. In some cases, it will be automatically set, but it can be overridden with the _Tools > Board_ menu or in the "Select other board and port..." dialog.
13+
* The **port** selection refers to an actual board (or other device) that's connected to your computer. Many boards are automatically recognized by Arduino IDE—these boards will have their name displayed next to their port in the _Tools > Port_ menu and will have their port associated with the identified board in the board selector menu.
14+
15+
Port and board selection can be managed in two ways:
16+
17+
* [Using the board selector (requires IDE 2)](#selector)
18+
* [Using the Tools menu](#tools-menu)
19+
20+
---
21+
22+
<a id="selector"></a>
23+
24+
## Using the board selector
25+
26+
> **Note:** The board selector is only available in IDE 2.
27+
28+
Follow these steps to use a connected board:
29+
30+
1. Find the board selector and click to open.
31+
32+
2. A list of ports will be displayed. If a board could be identified, the board name will be displayed, otherwise, it will display "Unknown".
33+
34+
![The board selector menu in Arduino IDE 2.](img/board-selector-labels.png)
35+
36+
3. Click on a port to select it:
37+
38+
* If a board was identified, it will automatically be selected. The selected board name will be displayed. The "![Port selected symbol.](img/symbol_port2.png)" indicates that a port is selected.
39+
40+
![The board selector, with a Arduino UNO connected.](img/board-selector-uno-connected.png)
41+
42+
* If it is unknown, the "Select Other board and port" dialog will open. See [Manually select a board](#other-board-and-port).
43+
44+
* If the board could be identified, but you are missing the board platform, you may be asked to install it:
45+
46+
* Select **Yes** to automatically install the board package in the background.
47+
48+
* Select **Install manually** to view the package in the Board Manager.
49+
50+
To learn more about installing boards, see [Add a board to Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360016119519-How-to-add-boards-in-the-board-manager).
51+
52+
<a id="other-board-and-port"></a>
53+
54+
### Manually select a board
55+
56+
In some cases you may want to individually control the port and board selection:
57+
58+
* Select a board that isn't connected to your computer (you can still write and verify sketches).
59+
* The board cannot be automatically identified.
60+
* The board associated with the port is incorrect.
61+
62+
Follow these steps:
63+
64+
1. Open the board selector and select **Select other board and port**.
65+
66+
![Selecting "Select other board and port" in the board selector.](img/board-selector-dialog-open.png)
67+
68+
2. Make your selections:
69+
70+
* Boards: Type in the text field to filter and scroll in list. Click on a board to select it.
71+
72+
* Ports: Select a port (optional).
73+
74+
![Selecting Arduino Nano in the "Select Other Board and Port" dialog.](img/select-other-board-and-port-nano.png)
75+
76+
3. Click **OK** to save the changes and close the dialog.
77+
78+
---
79+
80+
<a id="tools-menu"></a>
81+
82+
## Using the Tools menu
83+
84+
The menu bar can be used to perform many actions, including board and port selection.
85+
86+
![The 'Tools > Board' and 'Tools > Port' menu bar options.](img/tools-board-and-port.png)
87+
88+
The menu bar may be anchored to the top of the IDE window or the top of your screen, depending on your system.
89+
1090
<a id="board"></a>
1191

12-
## Select board
92+
### Select board with Tools > Board
1393

14-
1. Click on _Tools_ in the menu bar and find the _Board_ row. If a board is currently selected it will be displayed here.
94+
Follow these steps:
1595

16-
![The tools menu with the Board row highlighted.](img/tools_menu_highlight_board.png)
96+
1. Click on _Tools_ in the menu bar and find the _Board_ row. If a board is currently selected it will be displayed here.
1797

1898
2. Hover over the _Board_ row to reveal the installed board packages. These packages contain some popular boards:
1999

20100
| Package | Boards |
21101
|----------------------------------------------|-----------------------------------------------------------------------------|
22-
| Arduino AVR boards | Arduino Uno, Arduino Mega, Arduino Nano (classic) |
23-
| Arduino megaAVR boards | Arduino Uno WiFi Rev2, Arduino Nano Every |
102+
| Arduino AVR Boards | Arduino Uno, Arduino Mega, Arduino Nano (classic) |
103+
| Arduino megaAVR Boards | Arduino Uno WiFi Rev2, Arduino Nano Every |
24104
| Arduino SAMD (32-bits ARM Cortex-M0+) Boards | MKR Zero, MKR WiFi 1000, MKR WiFi 1010, and other MKR boards |
25105
| Arduino SAM (32-bits ARM Cortex-M3) Boards | Arduino Due |
26-
| Mbed OS Nano boards | Arduino Nano 33 BLE, Arduino Nano 33 BLE Sense, Arduino Nano RP2040 Connect |
27-
| Mbed OS Portenta boards | Portenta H7 |
106+
| Mbed OS Nano Boards | Arduino Nano 33 BLE, Arduino Nano 33 BLE Sense, Arduino Nano RP2040 Connect |
107+
| Mbed OS Portenta Boards | Portenta H7 |
28108

29-
If you don't know which package to use, or if it's missing from the list, see [Add a board to Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360016119519-How-to-add-boards-in-the-board-manager).
109+
> If you don't know which package to use, or if it's missing from the list, see [Add a board to Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360016119519-How-to-add-boards-in-the-board-manager).
30110
31-
3. Click on a board to select it.
111+
3. Hover over a package to reveal the boards.
32112

33-
![Selecting a board in Arduino IDE.](img/tools_menu_board_select.png)
113+
4. Click on a board to select it, for example:
34114

35-
> **Note:** If you don't know which package to use, or if it's missing from the list, see [Add a board to Arduino IDE](https://support.arduino.cc/hc/en-us/articles/360016119519-Add-a-board-to-Arduino-IDE).
36-
37-
---
115+
* _Tools > Board > Arduino AVR Boards > Arduino Uno_.
116+
* _Tools > Board > Mbed OS Nano Boards > Arduino Nano 33 BLE_
117+
* _Tools > Board > Mbed OS Portenta Boards > Portenta H7_
38118

39119
<a id="port"></a>
40120

41-
## Select port
121+
### Select port with Tools > Port
42122

43-
1. Click on _Tools_ in the menu bar and find the _Port_ row. If a board is currently selected it will be displayed here.
123+
Follow these steps:
44124

45-
![The tools menu with the Port row highlighted.](img/tools_menu_highlight_port.png)
125+
1. Click on _Tools_ in the menu bar and find the _Port_ row. If a board is currently selected it will be displayed here.
46126

47127
2. Hover over the _Port_ to reveal all ports. For Arduino devices, the board name will typically be displayed after the port.
48128

@@ -54,6 +134,4 @@ Learn how to select the right board and port in Arduino IDE.
54134

55135
3. Click on a port to select it.
56136

57-
![Selecting a port in Arduino IDE.](img/tools_menu_port_select.png)
58-
59-
If you don't see your board in the list, see [If your board does not appear in the port menu](https://support.arduino.cc/hc/en-us/articles/4412955149586-If-your-board-does-not-appear-in-the-port-menu).
137+
If you don't see your board in the list, see [If your board does not appear in the port menu](https://support.arduino.cc/hc/en-us/articles/4412955149586-If-your-board-does-not-appear-in-the-port-menu).
-24.7 KB
Binary file not shown.
-26.1 KB
Binary file not shown.
-28.3 KB
Binary file not shown.

0 commit comments

Comments
 (0)