andrew
/
GymPal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added more info to readme.

This commit is contained in:
Andrew Lalis 2022-12-02 11:54:18 +01:00
parent e480b46e47
commit cf4cd2813b
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,6 +1,8 @@
# GymPal
A simple device for recording gym sessions, using AVR.
The GymPal is a lightweight piece of hardware with built-in storage, time-keeping, display, and controls, to allow you to record exercise metrics on-the-fly in a satisfying, tactile way.
## Development
The software for this system is developed in C, using [avr-libc](https://www.nongnu.org/avr-libc/), and the build toolchain is managed by make, using [avr-gcc](https://linux.die.net/man/1/avr-gcc) and [avr-dude](https://github.com/avrdudes/avrdude) to upload firmware to the Atmega328p microcontroller.
@ -8,6 +10,13 @@ To compile the firmware, you can run `make`.
To upload the firmware to an Arduino, run `make flash`.
## Hardware
Here's a list of the hardware that this project uses, just for reference:
- Microprocessor: [Atmega328p](https://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-7810-Automotive-Microcontrollers-ATmega328P_Datasheet.pdf)
- Real-Time-Clock: [DS3231SN](https://nl.mouser.com/datasheet/2/256/DS3231-1513891.pdf)
- Display (subject to change): [SSD1306 OLED 128x64](https://cdn-shop.adafruit.com/datasheets/SSD1306.pdf)
- Onboard storage: [Adafruit SD Card Module](https://cdn-shop.adafruit.com/datasheets/TS16GUSDHC6.pdf)
### Helpful Links
The following links are helpful for learning how to program an AVR-based microcontroller.