Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 1.41 KB

README.md

File metadata and controls

49 lines (31 loc) · 1.41 KB

MOD Dwarf Controller

This is the source code for the MOD Dwarf controller (sometimes referred to as "HMI").

If you don't know what this refers to, see wiki.mod.audio/wiki/Dwarf_Device_Settings.

Building

There are no external dependencies besides arm-none-eabi- GCC and mod-controller-proto (used as git submodule).

So building can be done with:

# adjust if not using debian-based distribution
sudo apt install gcc-arm-none-eabi

# clone recursively (note the --recursive, important!)
git clone --recursive https://github.com/mod-audio/mod-dwarf-controller.git

# change dir to where code is
cd mod-dwarf-controller

# build firmware
make moddwarf

The generated firmware file will be placed inside the out/ subdirectory.

Deploying

You can deploy HMI firmware with the hmi-update command included inside the MOD OS. Just copy the firmware binary into the MOD unit over SSH and run this script with the binary filename as argument.

For example:

# Copy firmware file to MOD unit
scp -O out/mod-dwarf-controller.bin [email protected]:/tmp/

# Update HMI firmware
ssh [email protected] "hmi-update /tmp/mod-dwarf-controller.bin"

# Restart mod-ui service
ssh [email protected] "systemctl stop mod-ui"

License

MOD Dwarf Controller is licensed under AGPLv3+, see LICENSE for more details.