Skip to main content

Intro

Grid controllers run Lua 5.5 scripts for their configurations. It's a Turing complete system, meaning you can come up with unique workflow improvements utilizing Grid's tactile controls. The API for configurations aka grid_protocol used by Grid modules can be read in this reference manual.

Lua is a script language, please check out the official lua page for correct syntax.

This manual is supposed to be used together with the Wiki section as some functions are explained there in more detail under their respective Action Block (containers that house one or more functions, conveniently grouped together).

Auto-generated reference

The Grid Functions and Control Element Functions pages below aren't hand-written - they're generated straight from the LuaCATS annotations in the grid-editor project's source code, and regenerated on every release build so they never drift out of sync with the actual firmware/editor API. Please don't edit those pages directly - edit the annotations in grid-editor instead, and the change will show up here automatically.