Skip to content

Commit d6a36ea

Browse files
committed
readme cleanup
1 parent 63aba97 commit d6a36ea

1 file changed

Lines changed: 15 additions & 14 deletions

File tree

readme.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
# BUZZER PIANO
22

3-
**A computer-controlled virtual piano that plays sound through a microcontroller-driven piezo buzzer over a USB serial connection.**
43

5-
The system is split into two parts:
6-
- **Desktop application** — Graphical piano interface and serial controller
7-
- **MCU Micropython script** — Receives note data and generates sound using PWM
4+
**Play piano on a physical piezo-electric passive buzzer using a serial-connected MCU.**
85

6+
## Features
7+
- **Computer application**
8+
- Graphical piano interface and serial controller
9+
- Configurable number of piano octaves
10+
- **Microcontroller mpy script**
11+
- Receives note data and controls the buzzer
12+
- User-defined MCU pin via REPL on Linux
913

10-
https://github.com/user-attachments/assets/6d5003f8-bf1f-4924-867a-da4762076cf4
1114

12-
## Features
13-
- Graphical piano interface
14-
- Configurable number of piano octaves
15-
- User-defined MCU pin via REPL (Linux)
15+
https://github.com/user-attachments/assets/6d5003f8-bf1f-4924-867a-da4762076cf4
1616

1717
## Running the project
1818
### MCU side
1919
1. Copy the **OS-appropriate** mcu.py as the main script on the board.
20-
Exemple using mpremote:
21-
```bash
22-
mpremote cp mpy/mcu_linux.py :main.py
23-
```
20+
```bash
21+
# example using mpremote, copying the linux script
22+
mpremote cp mpy/mcu_linux.py :main.py
23+
```
2424
2. Configure the GPIO pin used for the buzzer:
2525
- **Linux**
2626
- Open the REPL after flashing the script.
@@ -62,18 +62,19 @@ mpremote cp mpy/mcu_linux.py :main.py
6262
| Mpremote | 1.27 | Sending script to MCU
6363
| Colorama | 0.4.6 | stdout coloring (debug)
6464

65-
Install dependencies:
6665
```bash
6766
# Linux
6867
python -m venv .venv
6968
source .venv/bin/activate
7069
pip install -r requirements.txt
70+
python main.py
7171
```
7272
```pwsh
7373
# Windows (Powershell)
7474
python -m venv .venv
7575
.venv\Scripts\activate
7676
pip install -r requirements.txt
77+
python main.py
7778
```
7879

7980
#### Or compile from source:

0 commit comments

Comments
 (0)