arduino / help-center-content Goto Github PK

View Code? Open in Web Editor NEW

9.0 13.0 8.0 130.33 MB

The content for https://support.arduino.cc

License: Other

Go 30.23% JavaScript 69.77%

arduino

help-center-content's Introduction

Arduino Help Center

What Is this Repository?

This repository hosts the content for the Arduino Help Center. The content is written in Markdown, which is converted to HTML automatically during the build process.

✅ What belongs in this repo

General "how-to" articles
Troubleshooting articles
Answering common questions

❌ What does not belong in this repo

Project tutorials (use the Project Hub)
Reference material for code (see the Arduino Reference repo instead)
Device specifications

Can I Contribute?

Yes! Get started by reading the wiki.

License

The contents of this repository is licensed under a Creative Commons Attribution 4.0 International Licence.

help-center-content's People

Contributors

Stargazers

Watchers

Forkers

photonicsguy ben-jacobson isabella232 maria-tonini avpaneendra raisingawesome pedasmith fr4ng

help-center-content's Issues

Can not select board USB port because it keeps appearing and disappearing

Article summary
See the Arduino forum discussion here starting at article no. 6.

More information
Include any/all of the following:

For an ESP32 create a program that crashes and reboots again, over and over
Use the buttons to put the board into upload mode, now select the serial port and upload a program that does not crash
Not an error log but more information in the forum
See above

429 Too Many Requests, Number of allowed API requests per minute exceeded

Summary:
Deploy to production workflows get 429 Too Many Requests, Number of allowed API requests per minute exceeded errors and eventually fail.

Failed jobs:

Deploy to production #19

time="2022-03-17T09:57:58Z" level=error msg="> update article 'My 12 month free Create plan code from the Oplá kit is not working': PUT 'https://arduino.zendesk.com/api/v2/help_center/en-us/articles/4412950847506.json' '{\"article\":{\"created_at\":\"0001-01-01T00:00:00Z\",\"updated_at\":\"0001-01-01T00:00:00Z\",\"edited_at\":\"0001-01-01T00:00:00Z\",\"user_segment_id\":null}}': 429 Too Many Requests, Number of allowed API requests per minute exceeded"
time="2022-03-17T09:57:58Z" level=error msg="> PUT 'https://arduino.zendesk.com/api/v2/help_center/en-us/articles/4412950847506.json' '{\"article\":{\"created_at\":\"0001-01-01T00:00:00Z\",\"updated_at\":\"0001-01-01T00:00:00Z\",\"edited_at\":\"0001-01-01T00:00:00Z\",\"user_segment_id\":null}}': 429 Too Many Requests, Number of allowed API requests per minute exceeded"
panic: update article 'My 12 month free Create plan code from the Oplá kit is not working': PUT 'https://arduino.zendesk.com/api/v2/help_center/en-us/articles/4412950847506.json' '{"article":{"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","edited_at":"0001-01-01T00:00:00Z","user_segment_id":null}}': 429 Too Many Requests, Number of allowed API requests per minute exceeded

Deploy to production #18

time="2022-03-17T09:57:57Z" level=info msg="skip content update" article="Accessing the Serial Monitor for the Arduino CLI on Windows"
time="2022-03-17T09:57:57Z" level=info msg="update content" article="Error: file does not exist, no such file or directory, system cannot find the file specified"
time="2022-03-17T09:57:57Z" level=info msg="Update article in section 360004641979: Error: file does not exist, no such file or directory, system cannot find the file specified"
time="2022-03-17T09:57:58Z" level=error msg="> GET 'https://arduino.zendesk.com/api/v2/help_center/articles/4406565090706/attachments': 429 Too Many Requests, Number of allowed API requests per minute exceeded"
panic: GET 'https://arduino.zendesk.com/api/v2/help_center/articles/4406565090706/attachments': 429 Too Many Requests, Number of allowed API requests per minute exceeded

goroutine 1 [running]:
main.must(...)
	/home/runner/work/help-center-content/help-center-content/_deploy/main.go:384
main.main()
	/home/runner/work/help-center-content/help-center-content/_deploy/main.go:80 +0x5dd
exit status 2
Error: Process completed with exit code 1.

The Chromebook extension will not download

Using Arduino with Chromebook
A link to the published article.

The article points you to the Chrome Store to install the Arduino Chrome Extension, but the Add to Chrome button fails. The dialog box says, "Download interrupted," and the file elmgohdonjdamp...crx does not exist. The message says Failed -- no file.

I've tested this behavior on two Macs and gotten the same result.

403 Forbidden

Error in deploy workflow.

Earliest instance here: https://github.com/arduino/help-center-content/runs/5183848991?check_suite_focus=true

Run cd _deploy
go: downloading github.com/alecthomas/chroma v0.8.0
go: downloading github.com/algolia/algoliasearch-client-go/v3 v3.4.0
go: downloading github.com/caarlos0/env v3.5.0+incompatible
go: downloading github.com/gohugoio/hugo v0.75.0
go: downloading github.com/microcosm-cc/bluemonday v1.0.16
go: downloading github.com/sirupsen/logrus v1.2.0
go: downloading github.com/yuin/goldmark v1.2.1
go: downloading github.com/yuin/goldmark-highlighting v0.0.0-20200307114337-60d527fdb691
go: downloading github.com/aymerick/douceur v0.2.0
go: downloading golang.org/x/net v0.0.0-20210614182718-04defd469f4e
go: downloading golang.org/x/crypto v0.0.0-20190605[12](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:12)3033-f99c8df09eb5
go: downloading github.com/dlclark/regexp2 v1.2.0
go: downloading github.com/gorilla/css v1.0.0
go: downloading github.com/pkg/errors v0.9.1
go: downloading golang.org/x/sys v0.0.0-20210423082822-04245dca01da
go: downloading github.com/BurntSushi/toml v0.3.1
go: downloading github.com/niklasfasching/go-org v1.3.2
go: downloading github.com/spf[13](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:13)/afero v1.2.2
go: downloading github.com/spf13/cast v1.3.1
go: downloading github.com/spf13/jwalterweatherman v1.1.0
go: downloading gopkg.in/yaml.v2 v2.3.0
go: downloading github.com/danwakefield/fnmatch v0.0.0-20160403171240-cbb64ac3d964
go: downloading github.com/mitchellh/mapstructure v1.3.3
go: downloading golang.org/x/text v0.3.6
go: downloading github.com/gobwas/glob v0.2.3
go: downloading github.com/mattn/go-isatty v0.0.12
time="2022-02-15T16:51:58Z" level=info msg="Read all articles"
time="2022-02-15T16:52:08Z" level=info msg="Read all categories"
time="2022-02-15T16:52:08Z" level=info msg="Read all sections"
time="2022-02-15T16:52:10Z" level=info msg="Create section graph"
time="2022-02-15T16:52:10Z" level=info msg="Process markdown"
time="2022-02-15T16:52:11Z" level=info msg="skip content update" article="Can I use the official Arduino logo for a community group?"
time="2022-02-15T16:52:13Z" level=info msg="skip content update" article="Can I use the Arduino Community logo on or in connection with my product so my customers easily can understand what it is?"
time="2022-02-15T16:52:[14](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:14)Z" level=info msg="skip content update" article="Can I use the official Arduino logo on my blog, to show that I am part of the Arduino Community?"
time="2022-02-[15](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:15)T[16](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:16):52:15Z" level=info msg="skip content update" article="I am arranging an event that will be focused on Arduino. May I use the Arduino logo in the poster and on other promotional materials?"
time="2022-02-15T16:52:[17](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:17)Z" level=info msg="skip content update" article="To what extent am I allowed to customize the Community logo?"
time="2022-02-15T16:52:[18](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:18)Z" level=info msg="skip content update" article="Why can't I use the Community logo on a commercial product to show that it derived from the Arduino Community?"
time="[20](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:20)22-02-15T16:52:20Z" level=info msg="skip content update" article="Can I design my own Arduino board and sell it?"
time="2022-02-15T16:52:[21](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:21)Z" level=info msg="skip content update" article="Can I further develop the Arduino IDE and make my own distribution of it?"
time="20[22](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:22)-02-15T16:52:22Z" level=info msg="skip content update" article="Can I include Arduino in the name of my product, so my customers easily can understand what it is?"
time="2022-02-15T16:52:[24](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:24)Z" level=info msg="skip content update" article="Can I include the Arduino name or parts of it in my company name since my business is similar to Arduino?"
time="2022-02-15T16:52:[25](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:25)Z" level=info msg="skip content update" article="Can I make a variation of the Arduino logotype and use it on my product since it is based on Arduino technology?"
time="2022-02-15T16:52:27Z" level=info msg="skip content update" article="Can I use the Arduino logo on or in connection with my product so my customers easily can understand what it is?"
time="2022-02-15T16:52:28Z" level=info msg="update content" article="Distributing products based on Arduino"
time="2022-02-15T16:52:28Z" level=info msg="Update article in section 360004749[26](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:26)0: Distributing products based on Arduino"
time="2022-02-15T16:52:[29](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:29)Z" level=error msg="> update article 'Distributing products based on Arduino': PUT 'https://arduino.zendesk.com/api/v2/help_center/en-us/articles/4415094490770.json' '{\"article\":{\"created_at\":\"0001-01-01T00:00:00Z\",\"updated_at\":\"0001-01-01T00:00:00Z\",\"edited_at\":\"0001-01-01T00:00:00Z\",\"user_segment_id\":null}}': 403 Forbidden, "
time="2022-02-15T16:52:29Z" level=error msg="> PUT 'https://arduino.zendesk.com/api/v2/help_center/en-us/articles/4415094490770.json' '{\"article\":{\"created_at\":\"0001-01-01T00:00:00Z\",\"updated_at\":\"0001-01-01T00:00:00Z\",\"edited_at\":\"0001-01-01T00:00:00Z\",\"user_segment_id\":null}}': 403 Forbidden, "
panic: update article 'Distributing products based on Arduino': PUT 'https://arduino.zendesk.com/api/v2/help_center/en-us/articles/4415094490770.json' '{"article":{"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","edited_at":"0001-01-01T00:00:00Z","user_segment_id":null}}': 403 Forbidden, 

goroutine 1 [running]:
main.must(...)
	/home/runner/work/help-center-content/help-center-content/_deploy/main.go:[38](https://github.com/arduino/help-center-content/runs/5203854577?check_suite_focus=true#step:4:38)4
main.main()
	/home/runner/work/help-center-content/help-center-content/_deploy/main.go:80 +0x5dd
exit status 2
Error: Process completed with exit code 1.

Cannot change Email adressed for Arduino User Profile while logged in via GitHub.

Normally, you would edit your Email adress via the field "Change" behind your registered Email adress, but this field is not given in the Arduino User Profile.

Wiring between UNO and Nano using `RESET` and `10` pins appears to be inverted

Article URL

https://support.arduino.cc/hc/en-us/articles/4841602539164-Burn-the-bootloader-on-UNO-Mega-and-classic-Nano-using-another-Arduino

Describe the problem with the article

In the diagram displaying the wiring between the UNO and Nano (in the section: Option A: Using the digital and power pins), the UNO's RESET pin connects to the Nano's 10 pin; the image description also indicates the UNO as the programmer board:

However, based on the table above the diagram, the programmer board's PIN 10 pin should be connected to the target board's RESET pin:

In this case, it looks like the UNO/programmer board's PIN 10 in the image should be connected to the Nano/target board's RESET pin instead (or perhaps the Nano in the image should be indicated as the board programming the UNO instead); wiring the two boards first-hand this way appears to confirm the case too

Article suggestion: missing port on Linux caused by interference from BRLTTY

Article summary

Some Linux distros have a pre-installed application named BRLTTY that interfaces the terminal with braille displays. These displays use a serial port for communication with the computer. Unfortunately, BRLTTY assumes that the port from any general purpose USB to serial adapter is a braille display and takes over the ports. If the port is actually of an Arduino board, this causes the port to not appear in the Arduino IDE ports list.

More information

Steps to reproduce the problem

Equipment

Any Arduino board or other hardware (e.g., an "FTDI" module or cable) that uses a general purpose USB to serial adapter chip:

FTDI FT232R
Silicon Labs CP210x
WCH CH340
ⓘ Even though I could reproduce the fault with the other two, I did not with the CH340, but other users have reported the fault occurring for this specific chip, so it may be limited to certain distros.

The most common official Arduino board that is affected is the Arduino Nano (which uses the FT232R chip)

Steps

Connect the board to a computer running Linux
Type the following command in a terminal:
```
ps -C brltty
```
You will now see output with a format similar to one of the following:
```
    PID TTY          TIME CMD
  12037 ?        00:00:02 brltty
```
OR
```
    PID TTY          TIME CMD
```
If the output has the latter output, either your Linux distro is not subject to this problem or else you have already applied the fix. In this case, simulate the environment of an affected distro by running this command from the terminal:
```
brltty
```
Start Arduino IDE.
Check the list of available ports in Arduno IDE
🐛 The port of the connected device is not shown.

Run the following command from the terminal:

dmesg

🐛 The output shows the port was created, but then disconnected due to interference from BRLTTY:

[ 5337.350288] usb 3-4: New USB device found, idVendor=0403, idProduct=6001, bcdDevice= 6.00
[ 5337.350292] usb 3-4: New USB device strings: Mfr=1, Product=2, SerialNumber=3
[ 5337.350295] usb 3-4: Product: FT232R USB UART
[ 5337.350297] usb 3-4: Manufacturer: FTDI
[ 5337.350299] usb 3-4: SerialNumber: AB0P8H9K
[ 5337.353430] ftdi_sio 3-4:1.0: FTDI USB Serial Device converter detected
[ 5337.353504] usb 3-4: Detected FT232RL
[ 5337.354003] usb 3-4: FTDI USB Serial Device converter now attached to ttyUSB0
[ 5339.669621] usb 3-4: usbfs: interface 0 claimed by ftdi_sio while 'brltty' sets config #1
[ 5339.670517] ftdi_sio ttyUSB0: FTDI USB Serial Device converter now disconnected from ttyUSB0
[ 5339.670546] ftdi_sio 3-4:1.0: device disconnected

Known answers or solutions

The most simple solution is to uninstall BRLTTY:

sudo apt-get remove brltty

Obviously this solution will be unacceptable for users of braille displays who find BRLTTY to be useful. Some more "surgical" approaches are discussed here:

https://unix.stackexchange.com/questions/670636/unable-to-use-usb-dongle-based-on-usb-serial-converter-chip/670637#670637

Links

Arduino Folder location for IDE2.0 not specified for MacOS

Article URL
content/Software Support/IDE Settings/Open-the-Arduino15-folder.md
content/Software Support/Installation/Uninstall-Arduino-IDE.md

Describe the problem with the article
I had an issue on MacOS after running the user where the IDE would not start as it was pointing to the older folder...
I had multiple versions of Arduino IDE installed over the years.

The problem was that Arduino IDE 2.0 uses a location in my instance a location not specified anywhere in the documentation

/Users/yyy/.arduinoIDE/arduino-cli.yaml -> that a file with OLD bad setting...

This directory wan't mentioned anywhere and resulted in me wasting lots of time.

- incorrect or outdated content
Please mentioned on both of these pages stating this new directory
~/.arduinoIDE

Further details
https://forum.arduino.cc/t/arduino-ide-2-1-0-fails-to-open-on-macos-after-user-migration/1134165/9

Contradictory information re: title format

The project's wiki specifies the required format for the article title:

https://github.com/arduino/help-center-content/wiki/Markdown-style-and-conventions#front-matter

This contains errors:

The title should be written in TitleCase

There is no such term as "TitleCase". The correct term is "title case":

https://en.wikipedia.org/wiki/Title_case

This is more than a nitpick. Mashing the words together in this way indicates to the reader that spaces should be omitted from the title text ("CamelCase").

i.e only the first word is capitalized, except for 'Arduino', product names, etc.

This is an incorrect description for title case. The description is of "sentence case":

https://apastyle.apa.org/style-grammar-guidelines/capitalization/sentence-case