Skip to content

sweetlilmre/TapuinoNext

Repository files navigation

TapuinoNext

TapuinoCI

Intro

Welcome to the TapuinoNext alpha.

Most of the code has been written and tested to a fair extent, but there are bound to be loads of bugs. Please report bugs as issues against the repo. If you have fixes, please submit these as a pull request. I could really use some help with documentation in markdown format if you would like to contribute in that way.

Using the TapuinoNext

Instructions on how to navigate the UI and detail on the TapuinoNext functionality can be found on this page: TapuinoNext UI. This is still very much a work in progress.

Hardware

  • "instructions" to build a stripboard prototype are available at Prototype Build
  • schematics and board designs for reference implementations are available in the Eagle folder.
  • the mini board has been produced and tested successfully!
  • NB: the micro board has not

The BOM for the TapuinoNext is:

ESP32 Dev Module

KY-040 Rotary Encoder

SD Card Adapter

4 Channel Level Shifter

Wire this all up according to the schematic and flash the firmware.

Firmware

If you have already flashed a recent firmware, then firmware releases are available at: https://github.com/sweetlilmre/TapuinoNext/releases

As newer firmware can self update, all you need to do is drop the update.bin file onto the root of the SD Card and select the firmware update option from the options menu.

For a first time build:

There is now an alternative to building the code and flashing.

  • Download the latest update.factory.bin from the TapuinoNext Releases Page
  • Using Google Chrome, go to the Adafruit ESP Tool page.
  • Connect your ESP32 to your machine and make sure the drivers are installed
  • Click "Connect" on the Adafruit page and select the COM port of your ESP32
  • If the connect succeeds, you should see several Choose a file... buttons
  • Click the first one, navigate to and select the update.factory.bin file you downloaded
  • Click Program
  • A progress bar will appear, once this is complete you should be good to go

Probably the easiest way to handle this at the moment is to:

  • install VS Code
  • install Platformio on top of that
  • install the Espressif 32 platform or start a new project and choose "Espressif ESP32 Dev Module" as the board, with "Arduino" as the framework
  • clone the TapuinoNext repository
  • you will need to create a config-user.h file in the include directory. This is currently used to specify which of the 2 supported displays you have and what the correct I2C address for the display is. A sample config-user.h.example has beem provided
  • point VS code to the directory you cloned the repo into and upload to the board (I'm assuming that you know how to do all of this)

TODO / Roadmap

See TODO

Attribution

See Attribution