Skip to main content

Module config

Module config 

Source
Expand description

Pedalboard configuration types shared between CLI and firmware.

IMPORTANT: When changing Preset, ButtonConfig, EncoderConfig, AnalogConfig, Action, or any type serialized into flash, bump PRESET_SCHEMA_VERSION below. The firmware uses this to reject stale presets on boot.

Structs§

AnalogConfig
ButtonConfig
Config
DeviceInfo
Device info returned by PE GET to resource 0x7D.
EncoderConfig
GlobalConfig
System-wide configuration, independent of presets. Replaces OpenDeck global settings.
InitialState
Default toggle/radio/encoder state for a preset on first activation.
LedConfig
ListenCc
Reactive CC binding: maps incoming MIDI CC to LED ring visualization.
Preset
Trigger
A trigger that reacts to incoming MIDI.

Enums§

Action
ButtonMode
Color
EncoderAction
LedAnimation
LedRenderer
ListenMode
How the LED ring reacts to incoming CC.
SystemCommand
System command identifiers (body of PE Set to resource 0x7E).
TriggerAction
Action to perform when a trigger matches.
TriggerMatch
Incoming MIDI message pattern to match.

Constants§

DEVICE_INFO_RESOURCE
PE resource ID for device info (read-only, GET only).
GLOBAL_CONFIG_RESOURCE
PE resource ID for global configuration (presets use 0x00..0x1F).
MAX_ACTIONS
MAX_ANALOG
MAX_BUTTONS
MAX_CYCLE_VALUES
MAX_ENCODERS
MAX_LABEL_LEN
MAX_PRESETS
MAX_TRIGGERS
PRESET_SCHEMA_VERSION
Bump when any struct that is postcard-serialized into preset flash changes layout. Must match FORMAT_VERSION in pedalboard-midi/src/preset_format.rs.
SYSTEM_COMMAND_RESOURCE
PE resource ID for system commands.

Type Aliases§

Label