mirror of
https://gitlab1.ptb.de/waltem01/Matrix
synced 2024-07-07 02:03:44 +00:00
22 lines
1.4 KiB
Markdown
22 lines
1.4 KiB
Markdown
# RPI RGB LED Matrix
|
|
|
|
## Description
|
|
|
|
This project is a two-part software solution designed to drive LED matrices. It leverages a [specific library](./API/deps/librgbmatrix.so), which was originally uploaded by Github user [`hzeller`](https://github.com/hzeller/). The project adds an additional layer of abstraction to this library, making it more accessible and easier to use.
|
|
|
|
### REST API
|
|
|
|
The first part of the project is a [REST API](./API/), written in Python. This API interacts with the aforementioned library, providing access to its basic functions as well as more complex commands derived from them.
|
|
|
|
### Webserver
|
|
|
|
The second part of the project is a [webserver](./Webserver/). This server interacts with the [REST API](./API/), using its commands to execute actions in the form of sub-programs.
|
|
|
|
## Project Structure
|
|
|
|
The project is divided into two main directories, each containing the necessary files for the [REST API](./API/) and the [Webserver](./Webserver/) respectively. You might've noticed the links to these directories whenever they were mentioned. The setup instructions for each part are provided within their respective directories.
|
|
|
|
## Environment Variables
|
|
|
|
The project is configured using optional environment variables. You will find project-wide variables here in [`.env.example`](./.env.example) that both the [REST API](./API/) and the [Webserver](./Webserver/) use to configure your hardware configuration.
|