russelg / arcin

Fork of zyp's arcin firmware repository, containing modifications for SVRE9/SVSE5 controllers. (as well as a one-off modification for the FB9)

arcin

This repository contains firmware code for the arcin v1.1, a custom game controller board with support for 11 buttons, 2 analog or quadrature encoders, 2 always-on LCDs, and WS2812B LED lighting via the B9 connector.

The svre9 branch in this repository contains modifications to improve user experience when using this board with DJ Dao SVRE9 or SVSE5 game controllers outfitted with arcade-style encoders.

The original codebase by zyp is available at: http://cgit.jvnv.net/arcin/log/?h=conf (the svre9 branch is based on the current HEAD of the conf branch, 1cb55ca06ecbc3666d3bf66a583a768f69bf9278)

Setup

1. Install nix: https://nixos.org/manual/nix/stable/installation/installing-binary.html
2. git submodule init
3. nix-shell
4. make

Setup (old)

1. Grab the ARM toolchain: https://launchpad.net/gcc-arm-embedded/+download
2. You will need SCons to build the image: http://scons.org/pages/download.html
3. git submodule init: this will pull the external laks submodule, which contains headers for the hardware used by the arcin.
4. Supplementary scripts will require Python (2.7) as well as the hidapi plugin: https://pypi.python.org/pypi/hidapi/0.7.99.post16

Building and Testing

1. scons
2. ./hidflash.py arcin.elf

See simpletest.py for an example test script to monitor HID reports generated by an arcin controller.

Packaging

After building an image using scons, use the Python script in the arcin-utils directory to build a custom hidloader EXE with your new firmware image embedded into it. This EXE can be given to users to easily flash their device.

1. ./hidloader_append.py arcin.elf hidloader_v2.exe arcin_flash_custom.exe