Matrix/README.md

18 lines
1.1 KiB
Markdown
Raw Normal View History

2024-02-12 10:52:25 +00:00
# RPI RGB LED Matrix
2024-01-11 13:40:23 +00:00
2024-02-12 10:52:25 +00:00
## Description
2024-02-12 10:57:06 +00:00
This project is a two-part software solution designed to drive LED matrices. It leverages a [specific library](./API/deps/librgbmatrix.so), which is originally designed for controlling LED matrices. The project adds an additional layer of abstraction to this library, making it more accessible and easier to use.
2024-02-12 10:52:25 +00:00
### REST API
2024-02-12 10:57:06 +00:00
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.
2024-02-12 10:52:25 +00:00
### Webserver
2024-02-12 10:57:06 +00:00
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.
2024-02-12 10:52:25 +00:00
## Project Structure
2024-02-12 10:57:06 +00:00
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.