Skip to content

nup002/Mathboard

Repository files navigation

Mathboard

Documentation Status

Documentation and instructions

This is the repository for the Mathboard V1. It is not fully finalized yet, and is being beta tested. The design files may therefore change without notice. However, the assembly instructions are not likely to change, and you can build your own Mathboard if you wish. Join the Mathboard Discord if you want to chat!

The Mathboard is a macropad to make it easier to write equations on a computer. It is intended for engineers, scientists, and anyone else who regularly need to write equations. This repository contains all the resources needed to make your own.

With the Mathboard you can type 75 of the most common symbols used in algebra, calculus, set theory, and logic, as well as all greek letters (including uppercase). The following equations are a few examples of what you can type directly with the Mathboard:

E = mc²
∛β ≫ ∯Ω(t)dt
(A⊂B) ∧ (A⊂C) ⇔ A ⊂ (B ∪ C)

You can follow its development on Hackaday: https://hackaday.io/project/186205-math-keyboard

Supported input methods

Input mode Supported
Unicode plaintext
LaTeX
Microsoft Office equation editor
Apache Open Office equation editor

Compatibility

The mathboard works on nearly all Unix systems, Apple macOS, and Windows. When using the Mathboard on Windows, the lightweight and open source application WinCompose must be installed and running.

Hardware

The mathboard has three main components:

  1. A printed circuit board (PCB)
  2. A 3D printed case
  3. Custom keycaps

All the production files for the PCB are in /hardware/pcb/Production files, and can be uploaded directly to JLCPCB. You will have to purchase and manually solder the switches, the microcontroller, and the indicator LED. A full purchase list can be found in Components and Tools

The case of the Mathboard is very simple, and it should be possible for virtually all 3D printers to print it. The .step files are located in /hardware/case.

You should use OEM R2 keycaps, since the decals in /hardware/keycaps/decals are made for them. Their shape also makes it easier to see the symbols printed on their front faces. You must find your own way of printing the keycaps. I have been using a UV printer, but you can also use waterslide decals.

Building and flashing the firmware

The newest firmware version can always be found in the releases. The releases also contain instructions on how to flash your Mathboard with the firmware.

If you wish to build the binaries yourself, for example after modifying the source files, you need to set up the build environment for QMK. This is not very difficult if you follow the guide. Once you've got the build environment set up, use the QMK CLI to navigate to the /firmware and type make.

Licenses

The Mathboard firmware is licensed under the GNU General Public License v3. The Mathboard hardware is licensed under CERN-OHL-S v2. This includes the PCB design files, case design files, and the keycap decals. As an individual you are free to make your own Mathboard, or to modify it, as long as these licenses are respected.