Skip to content

Latest commit

 

History

History
103 lines (71 loc) · 3.4 KB

README.md

File metadata and controls

103 lines (71 loc) · 3.4 KB

Arduino Client

Receives CPU, RAM & GPU usage via USB (Serial) from the server and displays it on the connected LCD screen.

 

Table of Contents

 

Download

Download the Arduino Firmware from the latest release.
It is located at the bottom in the 'Assets' section.

Note

The version of the server (your PC) and client (the Arduino) must match.
Make sure to download the latest server when installing the latest firmware.
You can find every version on the releases page.

 

Optional: Compiling yourself

If you'd like to compile the client yourself instead of downloading it from the releases section, do this:

(Click to expand)  

Preface:
This firmware was built using the help of PlatformIO for compiling, flashing and debugging.
It's great, I totally recommend it to anyone.

Connect the Arduino.
Make sure the correct path to the USB device is set in platformio.ini at upload_port.


Method 1: CLI, more suited for only installing
Install PlatformIO Core through your package manager (platformio-core on Arch) or using a installer from their website.
Open the client subdirectory (this one) in your terminal/PowerShell.

Depending on if you are using an Arduino with the old or the new bootloader, run one of these commands:
Old: platformio run --target upload --environment nano
New: platformio run --target upload --environment nanoNew


Method 2: Code Editor, more suited for development
Install VsCodium and the PlatformIO extension from the Extensions tab.
Open the client subdirectory (this one) in VsCodium. PlatformIO should detect the configuration file inside it.

Depending on if you are using an Arduino with the old or the new bootloader, choose the environment nano or nanoNew at the bottom of VsCodium.
Hit the '->' button at the bottom to build and flash.


[!IMPORTANT] Use these methods to compile only during development.
When done, use the build-releases.sh script to compile all firmwares meant to be released!
The build script requires platformio to be installed through your package manager.

 

Flashing the Firmware

TBA, there are no really great options out there right now, except PlatformIO or the official Arduino IDE, which are technically more aimed at developers.

For now, please read the Compiling yourself instructions from above.
Instead of running the build command listed there, run:
Old bootloader: platformio run --target upload --environment nano
New bootloader: platformio run --target upload --environment nanoNew

After the upload has finished, you can uninstall PIO Core again.

 

Connecting the Display

Connect your display like this:
SDA -> A4
SDC -> A5
VCC -> 5V or VIN
GND -> GND

(left is the display side, right the Arduino side)

 

Optional: Connecting a Display Backlight switch

Connect your switch like this:
GND -> Switch
Switch -> D2