A command-line tool for extensible LED matrix control with Raspberry Pi devices.

Will McGloughlin

Last update: May 1, 2023

Related tags

Foreign Function Interface rust raspberrypi wasm ws2812b ws281x extism

Overview

Matricks

"Teach an old matrix new tricks..."

Matricks is a WASM-based extensible LED matrix control tool intended for use on Raspberry Pi devices. LED matrix functionality is defined by user-developed plugins, or "tricks", which can be developed in any language that is supported by the Extism PDK. On non-Raspberry Pi devices, Matricks will simulate a LED matrix and display the simulated matrix state in real time.

See usage details below:

Usage: matricks [OPTIONS] --plugins <PLUGINS> --width <WIDTH> --height <HEIGHT>

Options:
  -p, --plugins <PLUGINS>              Path to plugin or directory of plugins
  -x, --width <WIDTH>                  Width of the matrix, in number of LEDs
  -y, --height <HEIGHT>                Height of the matrix, in number of LEDs
  -f, --fps <FPS>                      Target framerate at which to drive the matrix [default: 30]
  -l, --log-dir <LOG_DIR>              Directory to write logs [default: log]
  -s, --serpentine                     Data line alternates direction between columns or rows
  -m, --magnification <MAGNIFICATION>  Magnification of the simulated matrix [default: 10]
  -h, --help                           Print help
  -V, --version                        Print version

Installation

Matricks is installed using Cargo. In order to run a simulated matrix on non-Raspberry Pi machines, OpenCV and supported libraries must be installed before installing Matricks. See platform-specific instructions below.

Raspberry Pi

Install Rust and Cargo from the Rust website
Run apt install libclang-dev
Run cargo install matricks

Windows

Install Rust and Cargo from the Rust website
Install Chocolatey from the Chocolatey website
Install vcpkg from the the vcpkg website
Run choco install llvm opencv
Run vcpkg install llvm opencv4[contrib,nonfree]
Run cargo install matricks

Ubuntu

Install Rust and Cargo from the Rust website
Run apt install libopencv-dev clang libclang-dev
Run cargo install matricks

Arch Linux

Install Rust and Cargo from the Rust website
Run pacman -S clang qt5-base opencv
Run pacman -S vtk glew fmt openmpi
Run cargo install matricks

Mac

Install Rust and Cargo from the Rust website
Run brew install opencv
Run cargo install matricks

Note: for installation on Mac, you will likely also need a C++ compiler and libclang (brew install llvm).

fast rust implementation of online nonnegative matrix factorization as laid out in the paper "detect and track latent factors with online nonnegative matrix factorization"

ONMF status: early work in progress. still figuring this out. code still somewhat messy. api still in flux. fast rust implementation of online nonnega

2 Apr 10, 2020

A command line tool to control the power state of Valve Base Stations 2.0.

lighthousectl A command line tool to control the power state of Valve Base Stations 2.0. Usage Scan All Base Stations It scans endlessly. You can stop

11 Aug 9, 2022

REC2 (Rusty External Command and Control) is client and server tool allowing auditor to execute command from VirusTotal and Mastodon APIs written in Rust. 🦀

Information: REC2 is an old personal project (early 2023) that I didn't continue development on. It's part of a list of projects that helped me to lea

104 Oct 7, 2023

Comments

Add plugin loop option

Adds command line flag to loop plugins once all plugins have completed. Has the side effect that the plugin directory will now be checked before running the plugins again, allowing for plugins to be added/removed from the watch directory while Matricks is still running.

Closes #2

opened by wymcg 0
Plugin Time Limit Option

Add a command line flag that sets a time limit for how long a single plugin can run. If a plugin has been running for more than the specified time, move on to the next available plugin. There is no time limit by default, and the time limit is ignored if there is only one plugin available.
enhancement good first issue

opened by wymcg 0
Update Readme and GitHub Pages Site with new usage details

Several command line options have been added since v0.1.0. The usage page of the GitHub Pages site needs this information, and the main readme should be changed to reflect the added options as well.
documentation

opened by wymcg 1
Fix Conditional Compilation for Non-Raspberry Pi ARM64 Targets

Currently, Matricks will use the target architecture to determine whether to include rs_ws281x to drive the matrix or opencv to simulate the matrix, and will switch between matrix control thread functionality accordingly. We need to switch away from using a blanket cfg(target_arch = "aarch64") because it presents issues when compiling for non-Raspberry Pi devices that also use ARM64, such as M1 Macs.
bug

opened by wymcg 0

A command-line tool for extensible LED matrix control with Raspberry Pi devices.

Related tags

Overview

Matricks

Installation

Raspberry Pi

Windows

Ubuntu

Arch Linux

Mac

You might also like...

fast rust implementation of online nonnegative matrix factorization as laid out in the paper "detect and track latent factors with online nonnegative matrix factorization"

A command line tool to control the power state of Valve Base Stations 2.0.

REC2 (Rusty External Command and Control) is client and server tool allowing auditor to execute command from VirusTotal and Mastodon APIs written in Rust. 🦀

An EVM low-level language that gives full control over the control flow of the smart contract.

Small command-line tool to switch monitor inputs from command line

IR Remote Controller for WS2812(or analog) LED Strip

A blinking LED program written in Rust for the AVR

A LED Christmas Tree controlled by Rust. Contribute your own renderers!

Very simple Rust binary that can turn on/off a TP-Link L920 led light strip in your local network

A fast, extensible, command-line arguments parser

A simple, lightweight and extensible command line argument parser for rust codebases

Control Google Pixel Buds Pro from the Linux command line.

[OUTDATED] Instructions for how to cross compile Rust projects for the Raspberry Pi

Operating System development tutorials in Rust on the Raspberry Pi

A port of OxidGB to the Raspberry Pi Pico

Tested on Raspberry pi 3 on QEMU

Program a Raspberry Pi Pico with pure Rust

Raspberry PI library for Rust. GPIO controller, L298N motors, sockets and "i2clib" integrated

A Raspberry Pi Pico-based sequencer for Eurorack

Comments

Add plugin loop option

Plugin Time Limit Option

Update Readme and GitHub Pages Site with new usage details

Fix Conditional Compilation for Non-Raspberry Pi ARM64 Targets

Owner

Will McGloughlin

👾 Run WebAssembly (WASM-4) games on small devices (like PyBadge)

ruby-build is a command-line utility that makes it easy to install virtually any version of Ruby, from source.

zzhack-cli is a Command Tool to help you quickly generate a WASM WebApp with simple configuration and zero code

A dialect of Lisp that designed for Minecraft bedrock command.

📦✨ your favorite rust -> wasm workflow tool!

The Hassle-Free JavaScript Tool Manager

This tool converts Lua code to TS automatically, including the conversion of common standards to their TS equivalents.

Some tools for streaming frames to rpi-rgb-led-matrix using ZeroMQ, written in Rust.

Easy c̵̰͠r̵̛̠ö̴̪s̶̩̒s̵̭̀-t̶̲͝h̶̯̚r̵̺͐e̷̖̽ḁ̴̍d̶̖̔ ȓ̵͙ė̶͎ḟ̴͙e̸̖͛r̶̖͗ë̶̱́ṉ̵̒ĉ̷̥e̷͚̍ s̷̹͌h̷̲̉a̵̭͋r̷̫̊ḭ̵̊n̷̬͂g̵̦̃ f̶̻̊ơ̵̜ṟ̸̈́ R̵̞̋ù̵̺s̷̖̅ţ̸͗!̸̼͋

interactcli-rs is a command-line program framework used to solve the problem of the integration of command-line and interactive modes, including functions such as unification of command-line interactive modes and sub-command prompts. The framework integrates clap and shellwords.