prefixaut / pad-conf

Dance-Pad Firmware and Calibration Tool

Pad-Conf

This Project is to setup and calibrate a generic Dance Pad (3x3 Pad) for multiple Games like DDR, PIU, etc.

Requirements:

• A Microcontroller:
  • Arduino
  • Teensy
• Microcontroller Development/Flash Setup:
  • Arduino IDE 1
    • Teensyduino
  • or Platform IO (In progress)

This Repository acts as a mono-repo for all required components of this project. For detailed information for each component, please refer to the README in the respective directory:

• Backend
• Common
• Controller
• Frontend

How to Use

1. Install this project
2. Setup the Firmware
3. Flash the Firmware
4. Start the Backend-Server
5. Open the Configurator App

Installation

Either clone or download this repository to your local machine. If you download this repository, then simply extract it into a folder.

git clone [email protected]:prefixaut/pad-conf.git

Additionally, you may download the latest release of this release from the Release Page for your system.

Start the Backend

Simply execute the downloaded release executable.

Development

For development, you need to have a compatible NodeJS runtime installed. Then, you only need to install the dependencies via npm or yarn:

# Install via Yarn
yarn

# Or via NPM
npm ci

For easy development, you may start the frontend and backend in the develop mode with hot-reload/auto-restart in two terminals:

# Start via Yarn
yarn frontend:serve
yarn backend:serve

# Or via NPM
npm run frontend:serve
npm run backend:serve