{"id":21363569,"url":"https://github.com/acvigue/smartmatrixserver","last_synced_at":"2025-07-13T03:31:47.919Z","repository":{"id":118830506,"uuid":"577891968","full_name":"acvigue/SmartMatrixServer","owner":"acvigue","description":"Helper application that serves generated sprites to SmartMatrix devices over MQTT","archived":false,"fork":false,"pushed_at":"2024-10-23T17:37:12.000Z","size":32980,"stargazers_count":7,"open_issues_count":12,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-24T22:07:24.759Z","etag":null,"topics":["esp32","mqtt","tidbyt","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acvigue.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"acvigue"}},"created_at":"2022-12-13T19:05:13.000Z","updated_at":"2024-09-09T22:46:38.000Z","dependencies_parsed_at":"2023-12-17T23:29:10.669Z","dependency_job_id":"83eddafc-49b8-44f9-8d16-1c4a777fa3e9","html_url":"https://github.com/acvigue/SmartMatrixServer","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acvigue%2FSmartMatrixServer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acvigue%2FSmartMatrixServer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acvigue%2FSmartMatrixServer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acvigue%2FSmartMatrixServer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acvigue","download_url":"https://codeload.github.com/acvigue/SmartMatrixServer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225851245,"owners_count":17534271,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esp32","mqtt","tidbyt","typescript"],"created_at":"2024-11-22T06:19:58.387Z","updated_at":"2024-11-22T06:19:59.015Z","avatar_url":"https://github.com/acvigue.png","language":"TypeScript","funding_links":["https://github.com/sponsors/acvigue"],"categories":[],"sub_categories":[],"readme":"\n# SmartMatrixServer\n\n[![GPLv3 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)\n[![CodeFactor](https://www.codefactor.io/repository/github/acvigue/smartmatrixserver/badge)](https://www.codefactor.io/repository/github/acvigue/smartmatrixserver)\n\nSmartMatrixServer is a MQTT-based helper that serves as the backend for the SmartMatrix-IDF project.\n\n## Run with Docker Compose\n\n```yml\n  smx:\n    image: ghcr.io/acvigue/smartmatrixserver:main\n    volumes:\n      - ./tidbytcommunity/apps:/sprites\n      - ./devices:/devices\n    environment:\n      REDIS_HOSTNAME: redis\n      REDIS_USERNAME: default\n      REDIS_PASSWORD: redispassword\n      MQTT_HOST: ~~~~~~~\n      MQTT_USERNAME: ~~~~~~~\n      MQTT_PASSWORD: ~~~~~~~\n      DEVICE_FOLDER: /devices\n      SPRITE_FOLDER: /sprites\n  redis:\n    image: redis:alpine\n    command: redis-server --requirepass redispassword\n    volumes: \n      - ./redis_data:/data\n```\n\n\n## Configuration\n\nFiles should be stored in the containers attached `/devices` directory as `SmartMatrixXXXXXX.json` where XXXXXX is the last 6 characters of the ESP32's MAC address\n\nArray of objects containing name, duration, and any required configuration parameters.\n\nApplets must be stored in the container with the format `/sprites/[name]/[name].star`\n\n```json\n[\n    {\n      \"name\": \"paraland\",\n      \"duration\": 10,\n      \"config\": {\n        \"image\": \"north_carolina_morning\"\n      }\n    },\n    {\n      \"name\": \"paraland\",\n      \"duration\": 10,\n      \"config\": {\n        \"image\": \"arizona_day\"\n      }\n    },\n]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facvigue%2Fsmartmatrixserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facvigue%2Fsmartmatrixserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facvigue%2Fsmartmatrixserver/lists"}