Skip to content

Edit Settings

doomke edited this page Aug 31, 2023 · 9 revisions

Edit Settings

Once the Firmware is uploaded, changes can be made either using the serial interface (recommended) or flashing an additional settings file.

Enter Settings Using Serial Interface

  • Open an Instance to the Serial Interface (for example using the Arduino IDE or platformIO)
    • make sure the correct COMport is selected
    • set BAUD rate to 115200
  • Send the text setup over the serial interface (for everyone not using the arduino IDE: line must terminate with \n)
  • The board stops all operation and goes into setup mode
screenshot starting setup
  • Follow the instructions to add, delete, swap or edit modules
  • Each action comes with a set of available options that are always printed on the serial monitor
  • Send the letter or number of the setting you wish to access over the serial monitor (line must terminate with \n)
screenshot stepper setup
  • For some modules like input and macro as well as for internal events additional settings are available
screenshot input setup
  • After finishing your changes return to the starting menu (where the modules get listed)
screenshot return to menu
  • type and send r to restart the device
screenshot setup restart
  • The device restarts and sends numerous messages via the serial interface, detailing the function of the modules
screenshot setup success

Manually Create and Upload Settings File

  • Download the latest release of mklittlefs
  • Unzip and transfer the mklittlefs executable to the location you want to create the settings file
  • Create a new folder "data" in the same location
  • Create a new text file data/settings.txt
  • Open the text file and copy all settings in JSON format
  • Save the text file and open a command prompt
  • Navigate to the location of your mklittlefs executable (using cd)
  • Copy, paste and execute the command:
mklittlefs -b 4096 -p 256 -s 16384 -c ./data settings.bin
  • If successful, a new file settings.bin has been created in the same location
  • Open the flash download tool as described in Flash Firmware
  • Press ... and navigate to the new settings.bin
  • Select the binary for upload and choose the appropriate offset:
    • standard for a dev board is 0x290000
    • standard for a camera board is 0x310000
    • if you are using other boards or partition schemes, refer to the partition tables to find the offset for the spiffs section
  • Upload the file using the same upload settings as in Flash Firmware

General

Guides

Principle of Operation

Modules

Software Hardware
camera camera
infoLED infoLED
input input
macro macro
output output
servo servo
socket socket
stepper stepper
WiFi wifi

Clone this wiki locally