Skip to content
This repository has been archived by the owner on Mar 23, 2021. It is now read-only.

Latest commit

 

History

History
110 lines (62 loc) · 6.63 KB

README.md

File metadata and controls

110 lines (62 loc) · 6.63 KB
Raw

FLipMouse goes ESP32

This repository contains the ongoing progress on the firmware for the FLipMouse version 3. It will be API-compatible with FLipMouse v2, but with major improvements on speed (instead of one CortexM0 we will have a dual-core Tensilica and an additional CortexM0 for USB).

If you want to have a look at the FLipMouse v2, follow this link to the main repository.

The BLE-HID stuff is based on the other repository, where we use the ESP32 as BLE module replacement.

Online demo version of Web GUI: https://asterics.github.io/FLipMouse-esp32/

Following 3 steps are necessary to completely update/flash the firmware and the necessary support files/devices:

Building the ESP32 firmware

Please follow the step-by-step instructions of Espressif's ESP-IDF manual to setup the build infrastructure: Setup Toolchain

Note: Due to frequent breaking changes within the esp-idf and all build tools, we recommend to use a specific version of the tools:

  • release v4.1 (on 04.02.2020)
  • master branch (on 04.02.2020)

To get this version, use the following commands:

git clone -b release/v4.1 --recursive https://github.com/espressif/esp-idf.git
cd esp-idf
./install.sh
. ./export.sh

Now change your directory into the root directory of this repository.

Create the sdkconfig:

  • Execute make menuconfig in this directory
  • Change: Serial flasher config -> Flash size to 4MB
  • Change: Partition table -> Partition table to Custom partition table CSV
  • Change: Component config -> Bluetooth to enabled

Optional (for runtime statistics):

  • Change: Component config->FreeRTOS->Enable FreeRTOS trace facility to enabled

Optional (extensive stack/heap debugging):

  • Change Component config->Heap memory debugging->Heap corruption detection to whatever you need

After a successful setup, you should be able to build the FLipMouse/FABI firmware by executing 'make flash monitor'.

Building the LPC11U14 firmware (USB bridging chip)

The dedicated USB chip firmware is located in this repository: usb_bridge. Please clone this repository, and import it into the MCUXpresso IDE.

You can download the IDE here: MCUXpresso IDE

After a successful build, you need to flash the firmware to the LPC11U14 chip. We recommend using a development board by Embedded Artists, because it is very useful for initial testing & debugging. It is possible to split this board into two pieces, one LPC11U14 target and a JTAG programmer, which we use on a fully assembled FLipMouse. Please refer to the corresponding documents of this board how to connect the JTAG header to our FLipMouse (will be announced as soon as the PCB is final).

LPCXpresso development board:

LPCXpresso 11U14

Uploading the WebGUI

The FLipMouse with ESP32 contains a web interface for customizing the parameters. The web page itself is located in the FAT partition as the config data.

TBA: I think it is very easy to use mkfats by copying the component into ESP-IDF and simply call make mkfatfs to build the tool and make flashfatfs to upload the image.

BUT we have a 8.3 naming convention here...

Currently proposed workflow:

Please clone/download the mkfats tool, and copy the folder ESP32_mkfatfs/components/mkfatfs into your ESP-IDF's components path.

Execute make mkfatfs in this repository to build the mkfatfs tool.

If you want to update the webpage on the FLipMouse/FABI device, execute:

make makefatfs flashfatfs

WARNING:** All your slot configuration and IR commands will be deleted by this operation.

WARNING: THIS IS EARLY WORK IN PROGRESS

Acknowledgements

Supporters, MA23, people using this device and many more for input.

ESP-IDF developers for HOG testcode

mkfatfs project

thanks to Luca Dentella for the esp32lights demo, see http://www.lucadentella.it/en/2018/01/08/esp32lights/

thanks to Jeroen Domburg and Cornelis for the captive portal DNS code, see: https://github.com/cornelis-61/esp32_Captdns

thanks to Thomas Barth for esp32 Websocket demo code, see https://github.com/ThomasBarth/WebSockets-on-the-ESP32/

thanks to Lucas Bruder for the Neopixel library for ESP32, see https://github.com/Lucas-Bruder/ESP32_LED_STRIP/