Arduino Screen

A window application to control the Arduino screen
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

A windowed application that allows you to display the most useful information on the Arduino screen when your main displays are occupied with other things. The compact size of this screen allows you to place it in the most convenient location, such as under the monitor or above the keyboard. You decide what information to display, and you can change it whenever you need it.

Options that can be displayed:

• Time
• Date
• Weather
• RAM Usage
• RAM Available
• CPU Usage
• Network

(back to top)

Built With

The following tools were used to build the application:

• Aplikacja okienkowa:
  • Qt for Python (PySide 6)
  • Qt Creator (UI)
• Program na arduino:
  • .ino (C++)

(back to top)

Getting Started

To get started, you'll need the appropriate version of Python, the necessary dependencies, and an Arduino coding program installed. I also recommend Qt Creator as an IDE and Qt Designer for UI development, but they're not essential.

Prerequisites

Before you start working, connect the I2C LCD display (2x16) to the Arduino and then the whole thing via a USB cable to the computer.

Install Arduino IDE from the official website. Then use it to upload arduino-screen.ino to your arduino.

Installation

• python 3.9.6

  python3.9 --version

  If you don't have this version, install it.
• project files

  git clone https://github.com/w3rr0/Arduino-screen.git
  cd Arduino-screen

• virtual environment

  python3.9 -m venv .venv

  • Linux/Mac

    source .venv/bin/activate

  • Windows (cmd)

    .venv\Scripts\activate

  • Windows (PowerShell)

    .\.venv\Scripts\Activate.ps1

• requirements

  pip install -r requirements.txt

(back to top)

Usage

You can run the program from Qt Creator (green play icon) or simply run the widget.py file in Python.

First, you select a device from the list of available ports, select the information you want to display, and click Display. Your Arduino screen should now show the content you selected.

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b main/NewFeature)
3. Commit your Changes (git commit -m 'Add NewFeature')
4. Push to the Branch (git push origin main/NewFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Konrad Mateja - konradmateja65@gmail.com

Project Link: https://github.com/w3rr0/Arduino-screen

(back to top)