Skip to content

Commit 3db49b7

Browse files
karlsoderbykarlsoderby
committed
Add feature tutorials
1 parent df5f79d commit 3db49b7

File tree

6 files changed

+673
-1
lines changed

6 files changed

+673
-1
lines changed

‎content/hardware/02.hero/boards/uno-r4-wifi/tutorials/adc-resolution/adc-resolution.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: 'Arduino UNO R4 WiFi ADC Resolution'
3+
description: 'Learn how to change the ADC resolution on the UNO R4 WiFi.'
4+
tags:
5+
- ADC
6+
- 14-bit
7+
author: 'Karl Söderby'
8+
---
9+
10+
In this tutorial you will learn how to change the analog-to-digital converter (ADC) on an **Arduino UNO R4 WiFi** board. By default, the resolution is set to 10-bit, which can be updated to both 12-bit (0-4096) and 14-bit (0-65355) resolutions for improved accuracy on analog readings.
11+
12+
## Goals
13+
14+
The goals of this tutorials are:
15+
16+
- Update the ADC resolution to 12/14-bit.
17+
18+
## Hardware & Software Needed
19+
20+
- Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)).
21+
- [Arduino R4 WiFi](/hardware/uno-r4-wifi).
22+
- [Arduino Renesas Core](https://github.com/bcmi-labs/ArduinoCore-renesas)
23+
24+
## Analog-to-Digital Converter (ADC)
25+
26+
An analog-to-digital converter (ADC) transforms an analog signal to a digital one. The standard resolution on Arduino boards is set to 10-bit (0-1023). The UNO R4 WiFi supports up to 14-bit resolutions, which can provide a more precise value from analog signals.
27+
28+
To update the resolution, you will only need to use the [analogReadResolution()](https://reference.arduino.cc/reference/en/language/functions/zero-due-mkr-family/analogreadresolution/) command.
29+
30+
To use it, simply include it in your `setup()`, and use `analogRead()` to retrieve a value from an analog pin.
31+
32+
```arduino
33+
void setup(){
34+
analogReadResolution(14); //change to 14-bit resolution
35+
}
36+
37+
void loop(){
38+
int reading = analogRead(A3); // returns a value between 0-65355
39+
}
40+
```
41+
42+
## Summary
43+
44+
This short tutorial show how to update the resolution for your ADC, a new feature available on the UNO R4 WiFi board.

‎content/hardware/02.hero/boards/uno-r4-wifi/tutorials/can/can.md

Lines changed: 161 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,161 @@
1+
---
2+
title: 'Arduino UNO R4 WiFi CAN Bus'
3+
description: 'Learn how to send messages using the CAN bus on the UNO R4 WiFi.'
4+
tags:
5+
- CAN
6+
author: 'Karl Söderby'
7+
---
8+
9+
In this tutorial you will learn how to use the CAN controller on the **Arduino UNO R4 WiFi** board. The CAN controller is embedded in the UNO R4 WiFi's microcontroller (RA4M1). CAN is a serial protocol that is mainly used in the automotive industry.
10+
11+
***Please note that CAN controller requires an external transceiver to function. Instructions and hardware examples are provided in this tutorial.***
12+
13+
## Goals
14+
15+
The goals of this tutorial are:
16+
- Get an overview of the built-in CAN library
17+
- Learn how to connect a board to a CAN transceiver module
18+
- Send a CAN message between two Arduinos
19+
20+
## Hardware & Software Needed
21+
22+
- Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)).
23+
- [Arduino R4 WiFi](/hardware/uno-r4-wifi).
24+
- [Arduino Renesas Core](https://github.com/bcmi-labs/ArduinoCore-renesas)
25+
- CAN transceiver module\*
26+
- Jumper wires
27+
28+
In this tutorial, we are using a SN65HVD230 breakout module.
29+
30+
## Controller Area Network (CAN)
31+
32+
The CAN bus uses two wires: **CAN high** and **CAN low**. On the Arduino UNO R4 WiFi, these pins are:
33+
- D5/CANRX0 (receive)
34+
- D4/CANTX0 (transmit)
35+
36+
To communicate with other CAN devices however, you need a transceiver module. In this tutorial, we will be using a SN65HVD230 breakout. To connect this, you can follow the circuit diagram available in the section below.
37+
38+
For this tutorial, we will use a simple example that sends a CAN message between two UNO R4 WiFi devices. If you wish, you can also connect an existing CAN device to the UNO R4 WiFi.
39+
40+
## Circuit
41+
42+
To connect the CAN transceiver, follow the table and circuit diagram below:
43+
44+
| UNO R4 WiFi | CAN Transceiver |
45+
| ------------- | --------------- |
46+
| D5 (CANRX0) | CANRX |
47+
| D4 (CANTX0) | CANTX |
48+
| 5V | VIN/VCC/5V |
49+
| GND | GND |
50+
51+
Then, between the CAN transceivers, connect the following:
52+
53+
| CAN Transceiver 1 | CAN Transceiver 2 |
54+
| ----------------- | ----------------- |
55+
| CANH (HIGH) | CANH (HIGH) |
56+
| CANL (LOW) | CANL (LOW) |
57+
58+
## Code Examples
59+
60+
The following code examples needs to be uploaded to each of the UNO R4 WiFi boards, one will send a message, one will receive it. These examples are available in the Renesas core, and using the Arduino IDE, you can access them by navigating to **File > Examples > Arduino_CAN > CANWrite/CANRead**
61+
62+
The library used is built in to the core, so no need to install the library if you have the core installed.
63+
64+
To initialize the library, use `CAN.begin(CanBitRate::BR_250k)`, where a CAN bit rate is specified. Choose between:
65+
- BR_125k (125000)
66+
- BR_250k (250000)
67+
- BR_500k (500000)
68+
- BR_1000k (1000000)
69+
70+
### CAN Write
71+
72+
To send a CAN message, you can create a `CanMsg` object, which should contain the `CAN_ID`, size and message data. Below is an example on how to create such object.
73+
74+
```arduino
75+
uint8_t const msg_data[] = {0xCA,0xFE,0,0,0,0,0,0};
76+
memcpy((void *)(msg_data + 4), &msg_cnt, sizeof(msg_cnt));
77+
CanMsg msg(CAN_ID, sizeof(msg_data), msg_data);
78+
```
79+
80+
After you have crafted a CAN message, we can send it off, by using the `CAN.write()` method. The following example creates a CAN message that increases each time `void loop()` is executed.
81+
82+
```arduino
83+
#include <Arduino_CAN.h>
84+
85+
static uint32_t const CAN_ID = 0x20;
86+
87+
void setup()
88+
{
89+
Serial.begin(115200);
90+
while (!Serial) { }
91+
92+
if (!CAN.begin(CanBitRate::BR_250k))
93+
{
94+
Serial.println("CAN.begin(...) failed.");
95+
for (;;) {}
96+
}
97+
}
98+
99+
static uint32_t msg_cnt = 0;
100+
101+
void loop()
102+
{
103+
/* Assemble a CAN message with the format of
104+
* 0xCA 0xFE 0x00 0x00 [4 byte message counter]
105+
*/
106+
uint8_t const msg_data[] = {0xCA,0xFE,0,0,0,0,0,0};
107+
memcpy((void *)(msg_data + 4), &msg_cnt, sizeof(msg_cnt));
108+
CanMsg msg(CAN_ID, sizeof(msg_data), msg_data);
109+
110+
/* Transmit the CAN message, capture and display an
111+
* error core in case of failure.
112+
*/
113+
if (int const rc = CAN.write(msg); rc < 0)
114+
{
115+
Serial.print ("CAN.write(...) failed with error code ");
116+
Serial.println(rc);
117+
for (;;) { }
118+
}
119+
120+
/* Increase the message counter. */
121+
msg_cnt++;
122+
123+
/* Only send one message per second. */
124+
delay(1000);
125+
}
126+
```
127+
128+
### CAN Read
129+
130+
To read an incoming CAN message, first use `CAN.available()` to check if data is available, before using `CAN.read()` to read the message.
131+
132+
```arduino
133+
#include <Arduino_CAN.h>
134+
135+
void setup()
136+
{
137+
Serial.begin(115200);
138+
while (!Serial) { }
139+
140+
if (!CAN.begin(CanBitRate::BR_250k))
141+
{
142+
Serial.println("CAN.begin(...) failed.");
143+
for (;;) {}
144+
}
145+
}
146+
147+
void loop()
148+
{
149+
if (CAN.available())
150+
{
151+
CanMsg const msg = CAN.read();
152+
Serial.println(msg);
153+
}
154+
}
155+
```
156+
157+
## Summary
158+
159+
This tutorial shows how to use the CAN bus available on the UNO R4 WiFi, and how to send and receive data using the Arduino_CAN library.
160+
161+
Read more about this board in the [Arduino UNO R4 WiFi documentation](/hardware/uno-r4-wifi).

‎content/hardware/02.hero/boards/uno-r4-wifi/tutorials/cheat-sheet/cheat-sheet.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ Read more in the [Getting Started with the Web Editor](https://docs.arduino.cc/a
6060

6161
## Renesas RA4M1
6262

63-
The UNO R4 WiFi features the powerful and very robust renesas microcontroller also found on the UNO R4 Minima. Renesas microcontrollers are known for their high performance and robustness, including their built-in peripheral set.
63+
The UNO R4 WiFi features the powerful and very robust renesas microcontroller also found on the UNO R4 WiFi. Renesas microcontrollers are known for their high performance and robustness, including their built-in peripheral set.
6464

6565
These peripherals include analog-to-digital converters, timers, pulse width modulation (PWM) units, communication interfaces (such as UART, SPI, and I2C) and more.
6666

@@ -414,6 +414,17 @@ And to write something, we can use the following command:
414414
Serial1.write("Hello world!");
415415
```
416416

417+
## USB HID
418+
419+
This board can act as an HID (keyboard/mouse) and send keystrokes or coordinates to your computer via native USB.
420+
421+
```arduino
422+
keyboard.press('W');
423+
mouse.move(x,y);
424+
```
425+
426+
This support is enabled by the [keyboard](https://www.arduino.cc/reference/en/language/functions/usb/keyboard/) and [mouse](https://www.arduino.cc/reference/en/language/functions/usb/mouse/) libraries that are pre-bundled into the core and require no installation.
427+
417428
## CAN Module
418429

419430
The UNO R4 WiFi's RA4M1 has a built-in CAN module that complies with the CAN 2.0A/CAN 2.0B standard.

‎content/hardware/02.hero/boards/uno-r4-wifi/tutorials/eeprom/eeprom.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
---
2+
title: 'Arduino UNO R4 WiFi EEPROM'
3+
description: 'Learn how to access the EEPROM memory on the UNO R4 WiFi.'
4+
tags:
5+
- RTC
6+
- Alarm
7+
author: 'Karl Söderby'
8+
---
9+
10+
In this tutorial you will learn how to access the EEPROM (memory) on an **Arduino UNO R4 WiFi** board. The EEPROM is embedded in the UNO R4 WiFi's microcontroller (RA4M1).
11+
12+
## Goals
13+
14+
The goals of this tutorials are:
15+
16+
- Write to the EEPROM memory,
17+
- read from the EEPROM memory.
18+
19+
## Hardware & Software Needed
20+
21+
- Arduino IDE ([online](https://create.arduino.cc/) or [offline](https://www.arduino.cc/en/main/software)).
22+
- [Arduino R4 WiFi](/hardware/uno-r4-wifi).
23+
- [Arduino Renesas Core](https://github.com/bcmi-labs/ArduinoCore-renesas)
24+
25+
## EEPROM
26+
27+
Electronically erasable programmable read-only memory (EEPROM) is a memory that can be used to store data that can be retrieved after power loss. This memory can be effective to use during run-time to log data can be used to re-initialize whenever a system comes back online.
28+
29+
When writing to the EEPROM memory, we specify two parameters: the **address** and **value**. Each byte can hold a value between 0-255.
30+
31+
```arduino
32+
EEPROM.write(0,15); //writes the value 15 to the first byte
33+
```
34+
35+
We are writing a value of `15` to the first byte available in the memory, `0`.
36+
37+
To read the value of this memory, we simply use:
38+
39+
```arduino
40+
EEPROM.read(0); //reads first byte
41+
```
42+
43+
There are several more methods available when working with EEPROM, and you can read more about this in the [A Guide to EEPROM](https://docs.arduino.cc/learn/programming/eeprom-guide).
44+
45+
***Please note: EEPROM is a type of memory with limited amount of write cycles. Be cautious when writing to this memory as you may significantly reduce the lifespan of this memory.***
46+
47+
### EEPROM Write
48+
49+
A minimal example on how to **write** to the EEPROM can be found below:
50+
51+
```arduino
52+
#include <EEPROM.h>
53+
54+
int addr = 0;
55+
byte value = 100;
56+
57+
void setup() {
58+
EEPROM.write(addr, val);
59+
}
60+
void loop(){
61+
}
62+
```
63+
64+
### EEPROM Read
65+
66+
A minimal example on how to **read** from the EEPROM can be found below:
67+
68+
```arduino
69+
#include <EEPROM.h>
70+
71+
int address = 0;
72+
byte value;
73+
74+
void setup() {
75+
Serial.begin(9600);
76+
value = EEPROM.read(addr);
77+
while (!Serial) {
78+
;
79+
}
80+
81+
Serial.print("Address 0: ");
82+
Serial.println(addr);
83+
}
84+
85+
void loop() {
86+
}
87+
```
88+
89+
## Summary
90+
91+
In this tutorial, you've learned how to access the EEPROM on the UNO R4 WiFi board. To learn more about EEPROM, visit [A Guide to EEPROM](https://docs.arduino.cc/learn/programming/eeprom-guide).

0 commit comments

Comments
 (0)