Froth, and this site, are pre-alpha. This site is largely OSAI-generated documentation from the Froth repo.

Hardware

Froth’s maintained hardware surface is layered:

  • Board words for the one-page lookup table
  • Display for grid.*, matrix.*, tm1629.*, and tm1629.raw.*
  • Input for joy.*?, knob.*, and the raw button pattern
  • Utilities for timing, random, and math helpers used by Machine sketches
  • Base image for GPIO, LED, ADC, and seeded pins
  • GPIO and Timing for the low-level shared board words
  • I2C , UART , and PWM/LEDC for source-board peripheral surfaces outside the beginner Machine path

This first public cut treats the TM1629-based esp32-devkit-v4-game-board as the protoboard target while still documenting the shared base-image board surface underneath it.

If you want the applied board docs first, use Machine . That section teaches the Froth Machine as a board you can draw on and play with, while this section stays focused on exact surface details.

  1. Base Image Seeded pins, timing, GPIO, LED, and ADC helpers that live in the board base image.
  2. Board Words One-page lookup table for Froth Machine words, arity, return value, and use.
  3. Display The Froth Machine display words across grid, matrix, and TM1629 layers.
  4. Input Joystick, knob, and raw button input words for the Froth Machine.
  5. Utilities Timing, random, and math helpers commonly used by Machine sketches.
  6. GPIO Digital pin input and output words, plus the Froth helper layer over them.
  7. Timing Board timing words for sleeping and reading monotonic uptime.
  8. I2C Source-board I2C bus, device, probe, byte, and register words.
  9. UART Auxiliary UART handles and console-routing words for boards that expose them.
  10. PWM and LEDC ESP32 LEDC words for PWM duty, frequency, fade, and servo-style pulses.