Skip to content

Commit f12c398

Browse files
authored
Merge pull request #15 from manavcodaty/badges-for-lessons
Badge implementation on lesson pages
2 parents e333341 + a9e8c6d commit f12c398

29 files changed

+11430
-25
lines changed

docs/week-1/building-your-first-circuit.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
---
22
sidebar_position: 5
3+
difficulty: beginner
4+
time: 20m
5+
prereqs: ['Basic Electrical Skills']
36
---
47

58
import Tabs from '@theme/Tabs';
69
import TabItem from '@theme/TabItem';
10+
import LessonMeta from '@site/src/components/LessonMeta';
711

812
# Building Your First Circuit
913

14+
<LessonMeta {...frontMatter} />
15+
1016
## Understanding schematics
1117

1218
We must understand that there are two distinct representations of a circuit:
@@ -129,4 +135,4 @@ Write out this code for yourself, and make sure you understand how each line wor
129135

130136
This section includes links to help you dive deeper into the topics from this lesson. It's optional, so don't worry if you choose to skip it.
131137

132-
- [Another helpful watch on how to read a schematic.](https://www.youtube.com/watch?v=_HZ-EQ8Hc8E)
138+
- [Another helpful watch on how to read a schematic.](https://www.youtube.com/watch?v=_HZ-EQ8Hc8E)

docs/week-1/electrical-skills.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
---
22
sidebar_position: 4
3+
difficulty: beginner
4+
time: 20m
5+
prereqs: ['Tools of the Trade']
36
---
47

58
import Tabs from '@theme/Tabs';
69
import TabItem from '@theme/TabItem';
10+
import LessonMeta from '@site/src/components/LessonMeta';
711

812
# Basic Electrical Skills
913

14+
<LessonMeta {...frontMatter} />
15+
1016
Before we learn about connecting components to our Arduino, we need to be familiar with some basic electrical engineering concepts.
1117

1218
## What is a circuit?
@@ -61,4 +67,4 @@ We can connect the power rails on either side of the breadboard. Ensure you don'
6167

6268
This section includes links to help you dive deeper into the topics from this lesson. It's optional, so don't worry if you choose to skip it.
6369

64-
- Check out [this video](https://www.youtube.com/watch?v=08YugQce9OA) to solidify these concepts.
70+
- Check out [this video](https://www.youtube.com/watch?v=08YugQce9OA) to solidify these concepts.

docs/week-1/programming-basics.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
---
22
sidebar_position: 3
3+
difficulty: beginner
4+
time: 30m
5+
prereqs: ['What is the Arduino?']
36
---
47

58
import Tabs from '@theme/Tabs';
69
import TabItem from '@theme/TabItem';
10+
import LessonMeta from '@site/src/components/LessonMeta';
711

812
# Basic Programming
913

14+
<LessonMeta {...frontMatter} />
15+
1016
Our microcontroller can't program itself. Therefore, we need to communicate with our Arduino board using programmed instructions written in `C++`.
1117

1218
## Writing your first sketch
@@ -133,4 +139,4 @@ myNum = 10;
133139

134140
This section includes links to help you dive deeper into the topics from this lesson. It's optional, so don't worry if you choose to skip it.
135141

136-
- Check out [this great summary video on data types for variables.](https://www.youtube.com/watch?v=vyxsg4Fc6Vg)
142+
- Check out [this great summary video on data types for variables.](https://www.youtube.com/watch?v=vyxsg4Fc6Vg)

docs/week-1/project-week-1.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
---
22
sidebar_position: 6
3+
difficulty: beginner
4+
time: 60m
5+
prereqs: ['Basic Programming', 'Building Your First Circuit']
36
---
47

58
# Project: Traffic Lights
69

10+
import LessonMeta from '@site/src/components/LessonMeta';
11+
12+
<LessonMeta {...frontMatter} />
13+
714
Projects are intended to consolidate the knowledge you have absorbed in previous lessons. This one will help you apply what you've learned about controlling LEDs.
815

916
In this project, you will simulate a basic traffic light system using three LEDs: red, yellow and green. Requirements:
@@ -45,4 +52,4 @@ If you get stuck, don't worry! There are a few helpful ways to troubleshoot and
4552
- Search the problem online. If your console reports an error, simply copy paste it online. It's likely someone else had the same issue as you.
4653
- Ask in forums and online communities. Good places to ask for help are:
4754
- [Arduino Forum](https://forum.arduino.cc/)
48-
- [Arduino Discord Server](https://support.arduino.cc/hc/en-us/articles/4405329164178-Join-the-official-Arduino-Discord-server)
55+
- [Arduino Discord Server](https://support.arduino.cc/hc/en-us/articles/4405329164178-Join-the-official-Arduino-Discord-server)

docs/week-1/tools-of-the-trade.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
---
22
sidebar_position: 2
3+
difficulty: beginner
4+
time: 10m
5+
prereqs: ['What is the Arduino?']
36
---
47

58
import Tabs from '@theme/Tabs';
69
import TabItem from '@theme/TabItem';
710

811
# Tools of the Trade
912

13+
import LessonMeta from '@site/src/components/LessonMeta';
14+
15+
<LessonMeta {...frontMatter} />
16+
1017
There are many tools that a hobbyist should be familiar with using and are essential for the electronics workbench. Although most will not be mandatory for following this course, they are recommended to pick up to help when creating your projects in the future.
1118

1219
## Solderless breadboard
@@ -39,4 +46,4 @@ A 3D printer is another useful tool to invest in for creating prototypes and pro
3946

4047
This section includes links to help you dive deeper into the topics from this lesson. It's optional, so don't worry if you choose to skip it.
4148

42-
- Check out [Workbench Essentials by Robonyx.](https://www.youtube.com/watch?v=kWFXAqv2ZKw)
49+
- Check out [Workbench Essentials by Robonyx.](https://www.youtube.com/watch?v=kWFXAqv2ZKw)

docs/week-1/what-is-the-arduino.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
---
22
sidebar_position: 1
3+
difficulty: beginner
4+
time: 10m
5+
prereqs: []
36
---
47

58
import Tabs from '@theme/Tabs';
69
import TabItem from '@theme/TabItem';
710

811
# What is the Arduino?
912

13+
import LessonMeta from '@site/src/components/LessonMeta';
14+
15+
<LessonMeta {...frontMatter} />
16+
1017
[Arduino](https://en.wikipedia.org/wiki/Arduino) is an open-source electronics company who have developed mutliple microcontrollers that allow users to create projects by connecting various sensors, actuators, and other input/output devices and programming them with the `C++` programming language. The Arduino Uno is a development board that utilizes the `ATmega328P` microcontroller from the Atmel AVR family.
1118

1219
:::note[Microcontroller vs Computer]
@@ -47,4 +54,4 @@ If you purchased an Arduino kit as advised in the `Introduction`, grab your Ardu
4754
This section includes links to help you dive deeper into the topics from this lesson. It's optional, so don't worry if you choose to skip it.
4855

4956
- [A great video that summarises this lesson.](https://www.youtube.com/watch?v=HIXnwFB902M)
50-
- [Sparkfun's comparison guide is an interesting exploration of different microcontrollers.](https://www.youtube.com/watch?v=hjRSwBcLcSU)
57+
- [Sparkfun's comparison guide is an interesting exploration of different microcontrollers.](https://www.youtube.com/watch?v=hjRSwBcLcSU)

docs/week-2/conditional-statements-and-loops.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
---
22
sidebar_position: 1
3+
difficulty: beginner
4+
time: 30m
5+
prereqs: ['Basic Programming']
36
---
47

58
import Tabs from '@theme/Tabs';
69
import TabItem from '@theme/TabItem';
10+
import LessonMeta from '@site/src/components/LessonMeta';
711

812
# Conditional Statements and Loops
913

14+
<LessonMeta {...frontMatter} />
15+
1016
This lesson will introduce you to more programming structures which are essential to learn about.
1117

1218
## Conditional statements
@@ -118,4 +124,4 @@ while (blink == 1) {
118124

119125
This section includes links to help you dive deeper into the topics from this lesson. It's optional, so don't worry if you choose to skip it.
120126

121-
- [This article](https://ihechikara.com/posts/how-to-use-loops-in-arduino/#how-to-use-a-do-while-loop-in-arduino) covers the `do...while` looping structure.
127+
- [This article](https://ihechikara.com/posts/how-to-use-loops-in-arduino/#how-to-use-a-do-while-loop-in-arduino) covers the `do...while` looping structure.

docs/week-2/project-week-2.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,16 @@
11
---
22
sidebar_position: 5
3+
difficulty: beginner
4+
time: 60m
5+
prereqs: ['The Serial Monitor', 'Understanding PWM', 'The RGB LED']
36
---
47

58
# Project: Mood Light
69

10+
import LessonMeta from '@site/src/components/LessonMeta';
11+
12+
<LessonMeta {...frontMatter} />
13+
714
Projects are intended to consolidate the knowledge you have absorbed in previous lessons. This one will help you apply what you've learned about the RGB LED.
815

916
In this project, you will create a mood light controller using an RGB LED. Requirements:
@@ -46,4 +53,4 @@ If you get stuck, don't worry! There are a few helpful ways to troubleshoot and
4653
- Search the problem online. If your console reports an error, simply copy paste it online. It's likely someone else had the same issue as you.
4754
- Ask in forums and online communities. Good places to ask for help are:
4855
- [Arduino Forum](https://forum.arduino.cc/)
49-
- [Arduino Discord Server](https://support.arduino.cc/hc/en-us/articles/4405329164178-Join-the-official-Arduino-Discord-server)
56+
- [Arduino Discord Server](https://support.arduino.cc/hc/en-us/articles/4405329164178-Join-the-official-Arduino-Discord-server)

docs/week-2/rgb-led.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
---
22
sidebar_position: 4
3+
difficulty: beginner
4+
time: 25m
5+
prereqs: ['Understanding PWM']
36
---
47

58
import Tabs from '@theme/Tabs';
69
import TabItem from '@theme/TabItem';
10+
import LessonMeta from '@site/src/components/LessonMeta';
711

812
# The RGB LED
913

14+
<LessonMeta {...frontMatter} />
15+
1016
An RGB (Red-Green-Blue) LED is is like 3 LEDs in one. We can use an RGB LED to produce a variety of colors by mixing different intensities of red, green and blue light. Search up `RGB LED` online to understand what one looks like.
1117

1218
## How it works
@@ -118,4 +124,4 @@ Alternatively, since we've connected our color pins to pins that support PWM, we
118124

119125
This section includes links to help you dive deeper into the topics from this lesson. It's optional, so don't worry if you choose to skip it.
120126

121-
- Here is [a tutorial video on RGB LEDs](https://www.youtube.com/watch?v=iFPfg-x1qX8) you can watch.
127+
- Here is [a tutorial video on RGB LEDs](https://www.youtube.com/watch?v=iFPfg-x1qX8) you can watch.

docs/week-2/the-serial-monitor.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
---
22
sidebar_position: 2
3+
difficulty: beginner
4+
time: 15m
5+
prereqs: ['Basic Programming']
36
---
47

58
import Tabs from '@theme/Tabs';
69
import TabItem from '@theme/TabItem';
10+
import LessonMeta from '@site/src/components/LessonMeta';
711

812
# The Serial Monitor
913

14+
<LessonMeta {...frontMatter} />
15+
1016
The serial monitor is a tool within the Arduino IDE which we can use to communicate to and from the Arduino board. The serial monitor is especially useful when debugging and testing out different components to ensure they are functioning as expected.
1117

1218
## Printing data to the serial monitor
@@ -122,4 +128,4 @@ void loop() {
122128

123129
This section includes links to help you dive deeper into the topics from this lesson. It's optional, so don't worry if you choose to skip it.
124130

125-
- Check out [this basic intro to the serial monitor](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-serial-monitor/).
131+
- Check out [this basic intro to the serial monitor](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-serial-monitor/).

0 commit comments

Comments
 (0)