Skip to content

Commit 2de818c

Browse files
committed
release: v1.1.0 with INPUT_PULLUP wiring and docs update
1 parent ab90c87 commit 2de818c

5 files changed

Lines changed: 1949 additions & 177 deletions

File tree

README.md

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![GitHub Repository](https://img.shields.io/badge/GitHub-Maths__Quiz__Game-181717?logo=github)](https://github.com/DegsTerin/Maths_Quiz_Game)
44
[![Board](https://img.shields.io/badge/Board-Arduino_Uno-00979D?logo=arduino&logoColor=white)](https://www.arduino.cc/en/Main/ArduinoBoardUno)
55
[![Simulation](https://img.shields.io/badge/Simulation-Wokwi-5C6BC0)](https://wokwi.com/projects/new/arduino-uno)
6-
[![Release](https://img.shields.io/badge/Release-v1.0.0-2E7D32)](https://github.com/DegsTerin/Maths_Quiz_Game/releases/tag/v1.0.0)
6+
[![Release](https://img.shields.io/badge/Release-v1.1.0-2E7D32)](https://github.com/DegsTerin/Maths_Quiz_Game/releases/tag/v1.1.0)
77
An interactive Arduino-based maths quiz system with adaptive difficulty, multiple display modules, physical answer buttons, score tracking, and a complete Wokwi simulation setup.
88

99
## Project summary
@@ -16,7 +16,10 @@ This project presents arithmetic challenges using dedicated hardware modules:
1616
- one 16x2 I2C LCD for level and score feedback
1717
- three answer buttons, one reset button, and one potentiometer for difficulty selection
1818

19-
The main sketch is located at `arduino/maths-quiz-game/maths-quiz-game.ino`.
19+
Main sketches:
20+
21+
- English (en-gb): `arduino/maths-quiz-game-en-gb/maths-quiz-game-en-gb.ino`
22+
- Portuguese (pt-br): `arduino/maths-quiz-game-pt-br/maths-quiz-game-pt-br.ino`
2023

2124
## Gallery
2225

@@ -57,7 +60,7 @@ The main sketch is located at `arduino/maths-quiz-game/maths-quiz-game.ino`.
5760
- 1 reset button
5861
- 1 potentiometer
5962
- 2 feedback LEDs
60-
- Resistors and wiring according to the assembled circuit
63+
- No external resistors for the answer/reset buttons (`INPUT_PULLUP` is used)
6164

6265
## Pin mapping
6366

@@ -83,7 +86,12 @@ Configuration defined in the sketch:
8386
- Wrong LED: pin `13`
8487
- Potentiometer: `A0`
8588

86-
Note: the sketch treats `HIGH` as a pressed button, matching the current hardware configuration with external resistors.
89+
Important wiring update:
90+
91+
- Answer and reset buttons now use `INPUT_PULLUP`
92+
- Pressed state is `LOW`
93+
- Each button must be wired between input pin and `GND`
94+
- External 10k pull-down resistors are no longer required for these buttons
8795

8896
## How the game works
8997

@@ -103,10 +111,11 @@ The generated values change according to the selected level:
103111
- Medium: wider ranges and a more balanced mix of operations
104112
- Hard: larger values and a stronger weighting towards multiplication and division
105113

106-
Division rules:
114+
Decimal behaviour:
107115

108-
- At easy level, division is more likely to be exact
109-
- At medium and hard levels, decimal answers may appear
116+
- Easy: 10% of rounds may include decimal operands/results
117+
- Medium: 20%
118+
- Hard: 30%
110119

111120
## Libraries
112121

@@ -130,8 +139,10 @@ arduino/
130139
|-- libraries/
131140
| |-- LiquidCrystal_I2C/
132141
| `-- TM1637_Driver/
133-
`-- maths-quiz-game/
134-
`-- maths-quiz-game.ino
142+
|-- maths-quiz-game-en-gb/
143+
| `-- maths-quiz-game-en-gb.ino
144+
`-- maths-quiz-game-pt-br/
145+
`-- maths-quiz-game-pt-br.ino
135146
136147
assets/
137148
`-- media/
@@ -167,7 +178,9 @@ simulation/
167178

168179
1. Open the Arduino IDE.
169180
2. Install the required libraries if needed.
170-
3. Open `arduino/maths-quiz-game/maths-quiz-game.ino`.
181+
3. Open one sketch folder:
182+
- `arduino/maths-quiz-game-en-gb/` or
183+
- `arduino/maths-quiz-game-pt-br/`
171184
4. Connect the Arduino board.
172185
5. Compile and upload the sketch.
173186

@@ -180,7 +193,9 @@ You can start from the Arduino Uno template:
180193
Recommended setup:
181194

182195
1. Create a new Arduino Uno project in Wokwi.
183-
2. Replace the default `sketch.ino` with `simulation/sketch.ino`, or copy the code from `arduino/maths-quiz-game/maths-quiz-game.ino`.
196+
2. Replace the default `sketch.ino` with `simulation/sketch.ino`, or copy the code from one of:
197+
- `arduino/maths-quiz-game-en-gb/maths-quiz-game-en-gb.ino`
198+
- `arduino/maths-quiz-game-pt-br/maths-quiz-game-pt-br.ino`
184199
3. Replace the default `diagram.json` with `simulation/diagram.json`.
185200
4. Replace or create `libraries.txt` using `simulation/libraries.txt`.
186201
5. Confirm that `TM1637Display`, `LiquidCrystal_I2C`, and `LedControl` are available in the project.

0 commit comments

Comments
 (0)