Skip to content

Commit

Permalink
Use styles for blockquotes [HC-1597] (#421)
Browse files Browse the repository at this point in the history
* Updated blockquote style

* Apply suggestions from code review

Co-authored-by: Renat0Ribeir0 <86349945+Renat0Ribeir0@users.noreply.github.com>

* Update Get-started-with-the-Arduino-Science-Journal.md

---------

Co-authored-by: Renat0Ribeir0 <86349945+Renat0Ribeir0@users.noreply.github.com>
  • Loading branch information
gorillagripcore and Renat0Ribeir0 authored Oct 2, 2024
1 parent 9bb2db8 commit c2e8030
Show file tree
Hide file tree
Showing 40 changed files with 67 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ id: 4412377144338

In late 2021 a series of security vulnerabilities were found in **Apache Log4j**, a logging utility used by Arduino IDE 1.8 at the time. As of version 1.8.19, Log4j is no longer used by the IDE.

> [!NOTE]
> Arduino IDE 2 and Cloud services do not use Log4j and were not affected.
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ In order to [create a Junior Account](https://support.arduino.cc/hc/en-us/articl

To complete the registration of a Junior Account, it is necessary to provide a parent's email. Arduino will process the [personal data](https://www.arduino.cc/en/privacy-policy/children-privacy-policy) of the person exercising parental authority.

> [!NOTE]
> If the parent's email is not provided the Junior Account will not be created and all data provided will be deleted within 30 days.
**With a Junior Account, users are able to:**
Expand All @@ -45,6 +46,7 @@ As for the Junior Accounts, users between 14 and 16 years old will be asked to p

With an regular account with restrictions, the user has access to all the services available on the Arduino website, except for those services and features expressly reserved for the person exercising parental authority.

> [!NOTE]
> Only the person exercising parental authority may choose which services would be activated and which services the user between 14 and 16 years old can access.
## Further reading
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ There are two ways to sign up for an account:
* [Email](#email)
* [SSO (Single Sign On)](#sso)

> [!NOTE]
> Users under the age of 14 need to [sign up for a junior account](https://support.arduino.cc/hc/en-us/articles/360022234360).
---
Expand All @@ -20,6 +21,7 @@ There are two ways to sign up for an account:

![The sign in button on arduino.cc](img/arduino-cc-sign-in-button.png)

> [!NOTE]
> If another account is signed in, click the ![Profile icon](img/symbol_profile.png) profile button and select 'Sign Out' first.
2. Below the **Sign In** button, find the text "Don't have an account yet?", and click on **Create one** to proceed.
Expand All @@ -30,6 +32,7 @@ There are two ways to sign up for an account:

![Entering date of birth.](img/arduino-account-sign-up-dob.png)

> [!NOTE]
> Users under the age of 14 need to [sign up for a junior account](https://support.arduino.cc/hc/en-us/articles/360022234360).
4. Enter the following:
Expand All @@ -50,6 +53,7 @@ There are two ways to sign up for an account:

![Email confirming account creation.](img/arduino-account-welcome-email.png)

> [!TIP]
> If you don't see the email in your main inbox, please check the spam folder.
You can review your account and configure your account on [the profile page](https://id.arduino.cc/).
Expand All @@ -62,6 +66,7 @@ Alternatively, you can sign in using an identity provider such as Google or Face

1. Go to [arduino.cc](https://www.arduino.cc/) and click Sign In in the top-right to open the [sign-in page](https://login.arduino.cc/login).

> [!NOTE]
> If another account is signed in, click the ![Profile icon](img/symbol_profile.png) profile button and select 'Sign Out'.
![Sign-in button highlighted](img/arduino-cc-sign-in-button.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This article covers the issue of counterfeit boards – how to identify them and
* **Compatible:** When a third-party product has copied the open-source hardware design and uses its own brand name. No problem!
* **Counterfeit:** When a third-party product uses the Arduino name and/or logo directly on the product, or in the store, to deceive customers. Not cool!

> [!NOTE]
> It is fine for compatible brands to *reference* Arduino, in order for their customers to easily identify what type of product it is. Read more about trademark use in relation to compatible products [here](https://support.arduino.cc/hc/en-us/sections/360004749260-Compatible-Products).
## How to identify a counterfeit board
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Add and connect a device to Arduino Cloud"
id: 360016495559
---

> [!NOTE]
> Also see [Getting Started With the Arduino Cloud](https://docs.arduino.cc/cloud/iot-cloud/tutorials/iot-cloud-getting-started) in Arduino Docs.
Connecting a new device to Arduino Cloud consists of three steps:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ This article will show you how to connect your Arduino Cloud to an IFTTT webhook
* An [IFTTT account](https://ifttt.com/)
* A 'Thing' that you want to configure with IFTTT.

> [!NOTE]
> For a general overview of Arduino Cloud, see [this page](https://www.arduino.cc/en/IoT/HomePage).
## Creating an applet in IFTTT
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ Here are the credentials for the Arduino Sim:
</tr>
</table>

> Note: Arduino Sim takes 24 hours to get activated after the registration and a confirmation email will be sent.
> [!NOTE]
> Arduino Sim takes 24 hours to get activated after the registration and a confirmation email will be sent.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ Arduino Cloud Editor allows you to import sketches and files in the following fo
- Libraries in `.zip` format.
- Zipped folders containing sketches and libraries.

> Note: Make sure your libraries are in a folder called ‘libraries’. Be sure not to mix sketches and libraries in the same folder.
> [!NOTE]
> Make sure your libraries are in a folder called ‘libraries’. Be sure not to mix sketches and libraries in the same folder.
## Steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ id: 4405884552594

Several techniques can be used to make Arduino Cloud Editor pick a specific library when multiple libraries with the same name are available. One method is importing a copy of the library you want to use. Imported libraries are given preference over the pre-installed libraries ([full details here](https://arduino.github.io/arduino-cli/latest/sketch-build-process/#location-priorities-in-arduino-web-editor)). The technique works with any library, but we'll use the `DS18B20` library as an example in this guide.

> [!NOTE]
> See [this forum post](https://forum.arduino.cc/index.php?topic=684441.msg4605368#msg4605368) if you're interested in learning alternative methods to the technique described in this guide.
1. From the menu on the left side of the Cloud Editor window, click on the "Libraries" tab.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ To use the Cloud Editor on **Windows, macOS, and Linux**, you need the Arduino C

If you are using **Chrome OS**, see [Use Arduino with Chromebook](https://support.arduino.cc/hc/en-us/articles/360016495639-Use-Arduino-with-Chromebook).

> [!NOTE]
> To install the agent on other systems, you will have to compile it yourself. You can find the agent's [source code on GitHub](https://github.com/arduino/arduino-create-agent). If you are compiling for Raspberry Pi, you can consult [this tutorial written by our developers](https://github.com/arduino/arduino-create-agent/wiki/How-to-compile-on-Raspberry-Pi).
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ id: 4407002993426

By default, the Arduino Cloud Agent updates automatically. To ensure you have the latest version, or for any other purpose, you can check which version is installed by following the steps for your system below.

> [!NOTE]
> The latest release number can be found in the [source repository](https://github.com/arduino/arduino-create-agent).
## Windows
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ id: 4407770369042

![The Pro Gateway setup activation page.](img/lora-gateway-connect-activating.png)

> [!NOTE]
> Refresh the page if the activation appears to be stuck.
Your device should now appear in your Linux devices.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ These spaces have _Student_, _Teacher_, and _Admin_ member roles.
* Can access courses that are shared in the Space
* Expanded account features and limits offered by the School plan

> [!NOTE]
> You can compare the Free and School plan by going to [arduino.cc/cloud/plans](https://cloud.arduino.cc/plans) and clicking the "For Schools" tab.
### Teachers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,4 +33,5 @@ Most educational kits include a *Troubleshooting* or *Not Working* section on ea

* [Contact us](https://www.arduino.cc/en/contact-us/).

> Please provide a concise description of the problem and include this information (when applicable): Board name, Operating System, IDE or Cloud Agent version, and error output.
> [!NOTE]
> Please provide a concise description of the problem and include this information (when applicable): Board name, Operating System, IDE or Cloud Agent version, and error output.
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ This kit comes with a complete set of 8 Internet of Things projects ready to tur
* Comes with 8 out of the box guided projects
* Build custom connected devices that can be controlled with your mobile phone

> [!NOTE]
> More info in its [Arduino store page](https://store.arduino.cc/products/arduino-opla-iot-kit)
## The Explore IoT Kit
Expand All @@ -30,6 +31,7 @@ learning-by-doing approach. Step-by-step, students will acquire knowledge by con
* Complete guides for both students & teachers
* Comes with storage box for repeated use in the classroom

> [!NOTE]
> More info in its [Arduino store page](https://store.arduino.cc/products/arduino-explore-iot-kit)
## Both kits include
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ id: 4412950847506

The [Arduino Oplà IoT Kit](https://store.arduino.cc/opla-iot-kit) comes with 12 free months of the Arduino Cloud Maker Plan. Follow the steps below to activate your discounted plan.

> [!NOTE]
> If you already have an active paid plan, we recommend you wait until the end of your subscription period before changing to the Maker plan. If your currently active plan is a Maker plan, you will have to cancel it and sign up again to activate the discount code.
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "What Cloud plan is needed for the Oplà kit activities?"
id: 360021767939
---

> [!NOTE]
> The Oplà IoT Kit comes with a 12-month discount code for the Maker plan. Read more about [how to activate your discount here](https://support.arduino.cc/hc/en-us/articles/4412950847506).
The activities in the [Arduino Oplà IoT Kit](https://store.arduino.cc/opla-iot-kit) can be completed with an Entry plan or above. You can review and sign up for plans in the [Digital Store](https://store.arduino.cc/digital/create).
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ The Science Journal can be used with the following boards:
* Arduino Nano 33 BLE Sense Rev2
* Arduino Nano RP2040 Connect (by itself, or with the Science Carrier R3)

> Note: The MKR WiFi 1010 needs to be connected using the Science Carrier, which is only available in the [Arduino Science Kit Physics Lab](https://store.arduino.cc/products/arduino-science-kit-physics-lab).
> [!NOTE]
> The MKR WiFi 1010 needs to be connected using the Science Carrier, which is only available in the [Arduino Science Kit Physics Lab](https://store.arduino.cc/products/arduino-science-kit-physics-lab).
<a id="set-up-your-board"></a>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,12 @@ The Science Journal can be used with the following boards:
* Arduino Nano 33 BLE Sense Rev2
* Arduino Nano RP2040 Connect (by itself, or with the Science Carrier R3)

> Note 1: The MKR WiFi 1010 needs to be connected using the Science Carrier, which is only available in the [Arduino Science Kit Physics Lab](https://store.arduino.cc/products/arduino-science-kit-physics-lab).
>
> Note 2: If your board came with a Science Kit, it will have the the required firmware out-of-the-box. If you're using a board not included in a Science Kit, an individually bought board replacement, or have flashed the board with different firmware, see [Upload the Science Journal firmware](https://support.arduino.cc/hc/en-us/articles/4408029337746-Upload-the-Science-Journal-firmware).
> [!NOTE]
> The MKR WiFi 1010 needs to be connected using the Science Carrier, which is only available in the [Arduino Science Kit Physics Lab](https://store.arduino.cc/products/arduino-science-kit-physics-lab).
<!-- markdownlint-disable-next-line MD028 -->
> [!NOTE]
> If your board came with a Science Kit, it will have the the required firmware out-of-the-box. If you're using a board not included in a Science Kit, an individually bought board replacement, or have flashed the board with different firmware, see [Upload the Science Journal firmware](https://support.arduino.cc/hc/en-us/articles/4408029337746-Upload-the-Science-Journal-firmware).
<a id="connect-a-board"></a>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ The following boards use either an Atmega16U2 or Atmega8U2 chip as a USB-to-seri

The converter chip firmware can be flashed with a computer by setting the board to **DFU mode** (Device Firmware Update).

> Note that this article does _not_ apply to the Uno WiFi Rev2, which uses a different chip with closed source firmware.
> [!NOTE]
> This article does _not_ apply to the Uno WiFi Rev2, which uses a different chip with closed source firmware.
## 1. Get the firmware

Expand Down Expand Up @@ -84,6 +85,7 @@ Next we'll flash the drivers using FLIP.

02. Open FLIP.

> [!NOTE]
> Opening the application may prompt a 'Could not find a Java Virtual Machine' error. In this case, [install Java Runtime Environment](https://www.java.com/en/download/manual.jsp) with the **Windows Online** option.
03. Select the device name you identified earlier (ATmega16U2 or ATmega8U2).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,5 @@ The MKR Vidor 4000 [Camera enabling example](https://docs.arduino.cc/tutorials/m

4. When the video stream is active and it is routed to the **HDMI** port, you can stop the video opening the serial monitor and typing **STOP**. This activates the `vcam.end();` function.

> [!NOTE]
> If get an upload error, reset the board and try again.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ Every MKR FOX 1200 comes with a **free one-year subscription** to Sigfox data pl

In the first configuration example tutorial here: [Sigfoxfirstconfiguration](https://www.arduino.cc/en/Tutorial/SigFoxFirstConfiguration) you'll find the steps needed to register your board on the Sigfox network.

> Note that the ID and PAC numbers required for the Sigfox subscription are preflashed into the MKRFOX1200 during the time of manufacture, and they can be found in the serial monitor after running the first configuration example.
> [!NOTE]
> The ID and PAC numbers required for the Sigfox subscription are preflashed into the MKRFOX1200 during the time of manufacture, and they can be found in the serial monitor after running the first configuration example.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ When [Arduino Nano](https://docs.arduino.cc/hardware/nano) is selected in Arduin

## About the processor options

> [!NOTE]
> Original Arduino Nano boards use the ATmega328P microcontroller, but those sold in 2018 or later come with an updated bootloader. For this reason, the **Arduino AVR Boards** package has **two** versions of ATmega328P available (v1.16.21 and later).
Three processor options are available:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Devices from the **MKR** and **Classic** family can easily be connected and "sta
* To connect a carrier, insert the board's male header pins into the female connectors on the carrier.
* To connect a shield, insert the shield's male header pins into the female connectors on the board.

> [!NOTE]
> Multiple shields can be connected to one board but depending on your project, you may want to consider the ordering. If you're a shield for measuring light intensity, you may want to attach it on top, to not obstruct its sensors.
Follow these steps to connect MKR or Classic devices:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ The MKR IoT Carrier is equipped with a [HTS221](https://www.arduino.cc/en/Refere

Use another source to get the temperature of the room (e.g. Thermostat, Smartphone). Compare the temperature from your chosen source to the one of the HTS221 sensor by subtracting the two. Save the difference as your offset to be used for calibration adjustment.

> Example: Temperature reading from secondary source 28°C and the HTS221 sensor is 23°C. Therefore, (28°C - 23°C = 5°C) offset = 5°C.
**Example:** Temperature reading from secondary source 28°C and the HTS221 sensor is 23°C. Therefore, (28°C - 23°C = 5°C) offset = 5°C.

The above would indicate that the HTS221 sensor is 5°C less than the actual temperature; therefore, we will offset the difference in the following sections.
The example above would indicate that the HTS221 sensor is 5°C less than the actual temperature; therefore, we will offset the difference in the following sections.

## 2. Calibrate the temperature

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Even if there is no specific line in the main code stating to write this message

This message comes from the MKR IoT library included in the code when using the carrier as `#include <Arduino_MKRIoTCarrier.h>`, and it's displayed when initializing and testing the Carrier's different sensors and actuators.

> [!NOTE]
> If you want to check more in depth what's in the library, all the files are available in our github.
> Check here the [Arduino_MKRIoTCarrier.cpp file](https://github.com/arduino-libraries/Arduino_MKRIoTCarrier/blob/master/src/Arduino_MKRIoTCarrier.cpp#L84).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Learn how to reduce the size and memory usage of your sketch.

* **Store constant data in storage instead of memory** with [PROGMEM](https://www.arduino.cc/reference/en/language/variables/utilities/progmem/).

> [!NOTE]
> Arduino sketches are written in the Arduino language, which is based on standard C++. Therefore, using general C++ optimization techniques will help.
## Additional options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "avrdude: jtagmkII_initialize(): Cannot locate 'flash' and 'boot' memorie
id: 4405239282578
---

> [!NOTE]
> This error has mostly been reported for the _Arduino Nano Every_
When a sketch is successfully compiled and uploaded, the Arduino IDE console output may indicate
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ Arduino IDE translations have been made through community contributions, and not
* [Arduino IDE 1 translation project](https://www.transifex.com/mbanzi/arduino-ide-15/)
* [Arduino IDE 2 translation project](https://www.transifex.com/arduino-1/ide2/)

> Note that some messages printed in the "Output" view are generated by 3rd party compilation and upload tools (e.g. AVRDUDE) and modifying the language preferences in Arduino IDE will not affect these.
> [!NOTE]
> Some messages printed in the "Output" view are generated by 3rd party compilation and upload tools (e.g. AVRDUDE) and modifying the language preferences in Arduino IDE will not affect these.
### If the language isn't changing

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Once the Boards Manager is open, search for the name of your board or the name o

![Updating Core available](img/How_to_update_the_core_of_your_Arduino_board_1.png)

> Note: If `Update` is not visible this would indicate that you have an updated core and no further action would be needed.
> [!NOTE]
> If `Update` is not visible, this would indicate that you have an updated core, and no further action would be needed.
![Updating Core not available](img/How_to_update_the_core_of_your_Arduino_board_2.png)
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Depending on whether "All users" or "Only me" was selected during installation,
* **All users:** `C:\Program Files\Arduino IDE`
* **Only me:** `C:\Users\%USERNAME%\AppData\Local\Programs\Arduino IDE`

> [!NOTE]
> Prior to IDE 2, the application name was `Arduino`, with `C:\Program Files (x86)\Arduino` being the default path.
### Navigate to the installation folder in File Explorer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: "Use a custom theme for Arduino IDE 1"
id: 4408893497362
---

> [!NOTE]
> Custom themes are currently not supported for Arduino IDE 2.
Learn how to install a .zip packaged theme for Arduino IDE 1.
Expand All @@ -27,7 +28,8 @@ Learn how to install a .zip packaged theme for Arduino IDE 1.

4. Drag and drop the custom theme .zip file into the `theme` subfolder you created.

> Note: The custom theme must be in the root of the .zip file, **NOT** in a subfolder.
> [!NOTE]
> The custom theme must be in the root of the .zip file, **NOT** in a subfolder.
* The folder structure should look as follows:

Expand Down
Loading

0 comments on commit c2e8030

Please sign in to comment.