Jocaru/matrix64
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Modular structure, auto-deploy scripts, and use main branch

Browse Source
This commit is contained in:
Joan
2025-12-31 11:48:42 +01:00
parent 04cd96b1af
commit d183b4e347
3 changed files with 84 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

145
README.md
View File

@@ -1,93 +1,110 @@
# matrix64
# Matrix64 LED Display
Display Home Assistant and Netdata data on a 64x64 LED matrix controlled by a Raspberry Pi.
## Features
## Getting started
- **Weather Display**: Current weather icon and outdoor temperature
- **Interior Climate**: Temperature and humidity from BTH01-3132 sensor
- **HDD Temperatures**: From Netdata server
- **Automatic Brightness**: Adjusts based on ambient light sensor
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
## Project Structure
```
cd existing_repo
git remote add origin http://gitlab.kingstudio.es/jocaru/matrix64.git
git branch -M main
git push -uf origin main
matrix64/
├── matrix.py # Main entry point
├── config.py # Environment configuration
├── weather_icons.py # Weather icon drawing functions
├── home_assistant.py # Home Assistant API client
├── netdata.py # Netdata API client
├── matrix64.service # Systemd service file
├── install.sh # Installation script
├── update.sh # Auto-update script
├── requirements.txt # Python dependencies
├── .env.example # Configuration template
└── .env # Your configuration (gitignored)
```
## Integrate with your tools
## Installation on Raspberry Pi
- [ ] [Set up project integrations](http://gitlab.kingstudio.es/jocaru/matrix64/-/settings/integrations)
### Quick Install
## Collaborate with your team
```bash
# Download and run the install script
curl -sSL https://gitlab.kingstudio.es/jocaru/matrix64/-/raw/main/install.sh | sudo bash
```
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
### Manual Install
## Test and Deploy
```bash
# Clone the repository
sudo git clone https://gitlab.kingstudio.es/jocaru/matrix64 /opt/matrix64
cd /opt/matrix64
Use the built-in continuous integration in GitLab.
# Install dependencies
sudo pip3 install -r requirements.txt
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
# Create your configuration
sudo cp .env.example .env
sudo nano .env # Edit with your values
***
# Install and enable the service
sudo cp matrix64.service /etc/systemd/system/
sudo systemctl daemon-reload
sudo systemctl enable matrix64
sudo systemctl start matrix64
```
# Editing this README
## Configuration
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
Edit `/opt/matrix64/.env` with your values:
## Suggestions for a good README
```env
# Home Assistant
HA_TOKEN=your_long_lived_access_token
HASS_URL=https://your-hass-instance.com
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
# Entity IDs
BRIGHTNESS_ENTITY_ID=sensor.your_brightness_sensor
WEATHER_ENTITY_ID=weather.forecast_home
INTERIOR_TEMP_ENTITY_ID=sensor.bth01_3132_temperature
INTERIOR_HUMIDITY_ENTITY_ID=sensor.bth01_3132_humidity
## Name
Choose a self-explaining name for your project.
# Netdata
NETDATA_URL=http://your-netdata-server:19999
```
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Service Management
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
```bash
# Start/stop/restart
sudo systemctl start matrix64
sudo systemctl stop matrix64
sudo systemctl restart matrix64
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
# Check status
sudo systemctl status matrix64
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
# View logs
sudo journalctl -u matrix64 -f
```
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Auto-Updates
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
The install script sets up a cron job that:
- Checks for updates every 5 minutes
- Pulls changes if available
- Restarts the service automatically
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
To disable auto-updates:
```bash
crontab -e # Remove the matrix64 line
```
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
## Manual Execution
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
```bash
cd /opt/matrix64
sudo python3 matrix.py --led-rows=64 --led-cols=64
```