Compare revisions

# editor crud

.vscode

*swp

*~

# Python

.venv

/venv/

# sphinx

docs/_build/

/tools/mypy.sh

# bl00mbox docs

components/bl00mbox/docs/

components/bl00mbox/public/

variables:

  GIT_SUBMODULE_STRATEGY: recursive

  GIT_DEPTH: 0

default:

  # built via:

  #     docker load < $(nix-build nix/docker-image.nix)

  image: registry.k0.hswaw.net/q3k/flow3r-build:ymrsh8w1z9l89qvvksw52k7sl54lx73q

  image: registry.gitlab.com/flow3r-badge/flow3r-build:238576xsg79mjr2bkqg106qisvd3b5q9

clang-tidy:

  stage: check

    reports:

      codequality: cqual.json

mypy:

  stage: check

  variables:

    MYPYPATH: python_payload/mypystubs

  script:

    - "set +e +o pipefail"

    - "bash tools/mypy.sh; result=$?"

    - "python3 tools/codequal-report.py mypy warnings.txt > cqual.json"

    - "set -e -o pipefail"

    - "[ $result == 0 ]"

  artifacts:

    when: always

    reports:

      codequality: cqual.json

format:

  stage: check

  script:

build:

  stage: build

  script:

    - idf.py -g c23 build

    - idf.py -g c23 build size

  artifacts:

    expose_as: 'firmware'

    paths: ['build/flow3r.bin']

    expire_in: 5 hours

build_recovery:

  stage: build

  script:

    - cd recovery

    - idf.py build size

  artifacts:

    expose_as: 'C23 ELF'

    paths: ['build/flow3r.elf']

    expose_as: 'Recovery'

    paths: ['recovery/build/flow3r-recovery.bin', 'recovery/build/partition_table/partition-table.bin', 'recovery/build/bootloader/bootloader.bin']

    expire_in: 5 hours

simulate:

  stage: build

  script:

    - python3 sim/run.py screenshot

    - python3 sim/run.py --screenshot

  artifacts:

    expose_as: 'Smulator Screenshot'

    expose_as: 'Simulator Screenshot'

    paths: ['flow3r.png']

    expire_in: 5 hours

pages:

  stage: deploy

  only:

    - main

  rules:

    - if: $CI_COMMIT_BRANCH == "main"

  script:

    - git tag | xargs git tag -d

    - git checkout origin/main

    - git checkout -b dev

    - git branch --all

    - git branch --all | sed -e 's/..//' | grep '^remotes/origin/release/' | while read b; do git checkout -b "v${b#remotes/origin/release/}" "$b"; done

    - git checkout dev

    - git branch

    - mkdir public

    - cd docs

    - make html

    - mv _build/html ../public

    - make versionedhtml

    - cp -r _build/$(git branch --sort=version:refname | tail -n1 | sed -e 's/..//')/* _build/

    - python redirects.py

    - cp -r _build/* ../public/

    - find ../public/

  artifacts:

    paths: ['public']

    expire_in: 1d

  variables:

    # Force a full clone to make version machinery work.

    GIT_STRATEGY: clone

  only:

    - /^v\/[0-9]+\.[0-9]+\.[0-9]+.*$/

    - /^release\/[0-9]+\.[0-9]+\.[0-9]+$/

    - tags

  rules:

    - if: $CI_COMMIT_TAG

  script:

    - bash tools/dist.sh

  artifacts:

## [Unreleased]

## [1.1.1] - 2023-08-17

## [1.4.0] - 2024-12-24

### Summary

- documentation reworked and expanded

- primary context menu: can be opened at any time to view help texts, open the audio mixer or force-exit an application.

- help viewer: applications can provide context-sensitive help texts to make it easier to figure them out and reduce

  the load on appilcation writers to explain everything on a small screen.

- audio mixer: set levels of bl00mbox channels and mute/unmute them. Muted channels don't use CPU.

- secondary context menu: can be opened in an application menu to delete apps, set them as autostart or mark them as

  favorite to sort them to the top of menus

- new preloaded apps: violin, wobbler, mp3 player

- major rework of captouch driver features

- added `st3m.ui.widgets` module for easier app integration of user inputs (for example, captouch gestures)

- bl00mbox can now run channel-specific micropython callbacks whenever the channel is rendered, allowing

  for much more flexible backgrounded music applications

### Added

- system: unregistered apps are marked as "new"

- system: new category "Demos" for things that focus on being technical examples rather than being use case oriented

- gdb: micropython REPL available while debugging

- micropython: added `indent` keyword to `json.dumps`/`json.dump`

- apps: added overrides for OS button

- apps: added `get_help()` method to provide context sensitive help texts to users

- settings: Touch UI (default off) activates preview for captouch menu navigation

- media: support for more (most) mp3 tag types

- gr33nhouse: sort by application type

- captouch: no more silent captouch calibration, driver saves persistent calibration file and guides user through manual

  calibration when none is found.

- captouch: petals can be turned off run with reduced output to increase data rate

- captouch: unfiltered data log is accessible

- captouch: added `PetalLog` helper class for data processing

- bl00mbox: added .delete() method for various objects, added destructors for better garbabe collection behavior

- bl00mbox: added RMS volume collection option and provide volume normalization guidelines in flo3r docs

### Changed

- settings: "Enable WiFi on Boot" option is now "Always-On Wi-Fi" (but is functionally identical), should help reduce confusion about Wi-Fi turning off automatically

- captouch: normalized positional output in new `.pos`/`.raw_pos` attributes, deprecated old `.position` API

- captouch: normalized raw capacitance output in new `.raw_cap` attribute, deprecated old `.pressure` API

- captouch: removed all abstractions that indicate petal pads without replacement,

  i.e. `InputController.petals[x].ccw` or `InputState.petals[x].raw`

### Fixed

- updat3r: Improved version comparison logic, making the "you are up to date :)" logic work

- captouch: petal 5 fully functional

- bl00mbox: a whole lot of bugs and performance issues (but not all :P)

## [1.3.0] - 2023-11-26

### Summary

- Wifi connection UI

- Media framework

- SD card works reliably

- Performance improvements

- Backend improvements

- Wider micropython API

- Improved preloaded applications

- ...and many bugfixes!

### Added

- Added the `Audio Passthrough` app for toggling audio passthrough through

  line-in/mic to speaker or lineout.

- Added the `w1f1` app for managing wifi access to Settings, incorporates

  an in-progress cap-touch multi-tap keyboard (`k3yboard`).

- Added the `Scalar` app in `Music` category for playing scales.

- Added the `Mandelbrot` app, which illustrates how one can do direct

  framebuffer access and control 8bpp palettized modes from python.

- Added configuration of audio adjustments and startup dB level to `settings.json`.

- Added configuration of wifi credentials + hostname via `settings.json`

- Added support for apps to set wifi state automatically (configurable in

  settings: `Let apps change WiFi`)

- Added task profiler which prints over serial (configurable in

  settings: `Debug: ftop`)

- Added an error screen to the `Nick` app when `nick.json` is invalid.

- Added `urequests` and `uos` support in the simulator.

- Added audio/video media framework, and `Wurzelitzer` app as a small jukebox

  frontend - currently supporting mp3 audio, mpeg1 video, GIF and protracker

  .mod files.

- Added exporting of built firmwares as part of CI.

- Added basic implementation of `os.statvfs()` to fetch full/available

  disk space on flash and SD.

- Added `set_position` and `scroll_to` methods to `ScrollController`

- graphics: sprite sheet support for `ctx.image()`

- graphics: `ctx.parse()` for parsing SVG-path-data/ctx-protocol.

- graphics: 1,2,4,8,16,24 and 32 bits-per-pixel graphics modes.

- graphics: direct framebuffer access.

- graphics: palette setting in 1,2,4 and 8bpp graphics modes.

- graphics: flags for 2x 3x and 4x pixel doubling, low-latency and direct-ctx modes.

- graphics: experimental smart redraw mode

- graphics: clipped and composited overlay buffer

- graphics: allow a graphics state depth of up to 10 (`ctx.save()` `ctx.restore()`)

- graphics: virtual framebuffer with scrolling

- battery: Main menu shows a charge percentage estimate based on real battery characterization

- Added basic media playback in the `fil3s` app.

- Added a delete button to `fil3s`/Files app to allow for deleting files,

  folders and apps on-device.

- Added new menu categories, `Media` and `Games`, and made category handling more robust

  to correctly handle introducing new categories in the future.

- Added configuration UI for audio, appearance and graphics settings.

- Added configurable LED patterns for the main menu.

- Added "restore defaults" option in the settings menu.

- Added wah modulation in `Otamatone`.

- Added several API functions for `ViewManager` to make complex view handling in apps

  easier and robust.

- Added firmware update app, `updat3r`.

- Added storage information in `About` app.

- Added audio equalization for built-in speakers.

- Added a function to retrieve scope data for manual drawing/processing.

- Added I2C scanner app.

- Added sensor demo app.

- Added `CONFIG_DEBUG_GDB_ENABLED` flag for easy debugging over USB JTAG.

- Added saving/restoring state to several apps.

- Added variable sequence length support in `gay drums`.

### Changed

- Changed the st3m\_tar logic to only update files on flash after an update

  if they've been changed, greatly improving start times after an update.

- Flashing flow3r through idf.py now automatically restarts it.

- Switched the REPL/fatal/disk restart button to the OS shoulder button (right

  shoulder button, unless swapped in settings).

- Improved performance of the `gr33nhouse` app list by not rendering hidden

  entries and scrolling ones too long to fit on screen.

- Changed the audio adjustment logic, and added support for holding down the

  shoulder to keep increasing/decreasing level.

- Improved download reliability of the `gr33nhouse` app by adding chunked

  downloads, some `gc.collect()` calls, progress bar and an error screen.

- Settings are now automatically loaded and saved when entering and leaving

  the settings page.

- Moved the `Clouds` app to the `Badge` menu and updated it to use IMU data.

- Added a more sane commandline interface to the simulator.

- More stub functions for the simulator.

- Improved performance of system menus by not rendering hidden entries.

- Added visualization of state, instead of an audio scope in UI of `harmonic

  demo` and `melodic demo`.

- The system provided scope is now always stroked.

- Improved BPM tap accuracy in `gay drums`.

- Some shell code rewritten to avoid the expensive calls `ctx.start_group()` and

  `ctx.end_group()`.

- Overlay graphics gets rendered to a separate framebuffer, of which a clipped rectangle

  is composited during scan-out. The python overlay code has been adapted to keep track

  of which parts of overlay need refresh.

- Slightly lower AA quality; for a 3x performance boost in the

  worst-case scanline rasterization code path.

- The entry section in `flow3r.toml` can now be omitted if the Application

  class is called `App`.

- disabled support for compositing group API in ctx, where used global\_alpha on

  its own did was responsible for it seeming to work.

- Split the `settings.py` file into two, creating `settings_menu.py` to hold

  UI-related code and allow `settings` to be used import loops without

  in many cases.

- When running apps through REPL mode (with `mpremote` etc), multi-view apps

  are now properly handled and don't restart whenever OS shoulder is pressed.

- A multitude of built-in apps now scroll names to fit the screen.

- Apps are now sorted and deduplicated by display name, not by folder name.

- Improved handedness in buttons.

- `harmonic demo` turned into a fully-featured `chord organ`

- `menu` key in `flow3r.toml` has been replaced with `category`. The old key can still

  be used to maintain backwards compatibility with older firmwares.

- Backported recent improvements for micropython's garbage collection to make it faster.

- `shoegaze` can now use chords configured in `chord organ`.

- Changed the priority of additional threads spawned by micropython to be equal to its

  main thread's priority.

- Apps that require Wi-Fi connection can directly take the user to Wi-Fi settings.

- Changed the default app installation directory on flash to `/flash/apps`.

- `gr33nhouse` now installs apps on SD card if available.

- Increased the frequency of LED animations.

- Changed the way LED colors are blended when using slew rates lower than 255 to be

  more in line with color perception.

- Rearranged system menu.

- Made system indicator icons bigger.

- Removed CCCamp's Wi-Fi settings from the default config.

- Made InputState and parts of InputController lazily evaluated.

- bl00mbox: allow circular signal dependencies

- bl00mbox: several plugins and patches deprecated and replaced with updated

  versions, see https://gitlab.com/moon2embeddedaudio/bl00mbox/-/blob/main/README.md

### Fixed

- Fixed `tiny sampler` keeping the microphone active after app exit.

- Fixed missing `include/` dir on builds on Darwin.

- Fixed the `time` module in the simulator being broken for apps trying to use it.

- Fixed wrong petal ordering in the simulator.

- Fixed simulator not exiting when closed.

- Fixed `Comic Mono` missing in the simulator.

- Fixed initialization orientation of display and transform initialization for

  ctx contexts, (this enables arbitrary transformations to images and gradients.)

- Fixed broken anti-aliasing for compressed side of curved strokes.

- Fixed cleanup at exit for firmware apps

- Fixed sampler start bug in bl00mbox

- Fixed reset of graphics subsystem upon entering REPL / using mpremote.

- Fixed multitude of issues with transition animations.

- Fixed lost captouch and button presses when they're shorter than a think cycle.

- Fixed `ScrollController`'s handling of high delta values.

- Fixed many crashes in `fil3s` app.

- Fixed a crash in `CapScrollController`.

- Fixed gamma LUT setting for LEDs.

- Fixed bl00mbox channels leaking on micropython's soft reboot.

- Fixed importing bl00mbox's fake stub in the simulator.

- Performance fixes for bl00mbox.

- Fixed troubles with deleting files on some SD cards (like the bundled one).

- Fixed the default I2C1 pins in micropython's I2C interface.

- Fixed large files being truncated when installing apps via `gr33nhouse`.

- Fixed LED color handling in the simulator.

- Fixed flickering .down property of Pressable when going through REPEATED state.

## [1.2.0] - 2023-08-18

### Added

- Added a WiFi status indicator icon.

- Added a battery status indicator icon.

- Added support for loading apps from `/sd/apps` and `/flash/apps`.

- Added an error screen when apps fail to start.

- Added Python/st3m API to access battery charge status.

- Added the ability to always hide icons (*System* ➜ *Settings* ➜ *Show Icons*).

### Fixed

- File descriptor leak on app load.  This would lead to the OS crashing when

  too many apps are installed.

## [1.1.1] - 2023-08-17

### Fixed

- Crash on WiFi startup

### Changed

- `ctx.get_font_name()` now raises an exception for unknown fonts.

- Raised umber of concurrent textures to 32.

- Raised max concurrent texture limit to 32.

### Fixed

- Fixed PNG without alpha and JPEG support by enabling `CTX_FORMAT_RGB8`.

Initial Release

[unreleased]: https://git.flow3r.garden/flow3r/flow3r-firmware/-/compare/v1.1.0...main

[unreleased]: https://git.flow3r.garden/flow3r/flow3r-firmware/-/compare/v1.4.0...main

[1.4.0]: https://git.flow3r.garden/flow3r/flow3r-firmware/-/compare/v1.3.0...v1.4.0

[1.3.0]: https://git.flow3r.garden/flow3r/flow3r-firmware/-/compare/v1.2.0...v1.3.0

[1.2.0]: https://git.flow3r.garden/flow3r/flow3r-firmware/-/compare/v1.1.1...v1.2.0

[1.1.1]: https://git.flow3r.garden/flow3r/flow3r-firmware/-/compare/v1.1.0...v1.1.1

[1.1.0]: https://git.flow3r.garden/flow3r/flow3r-firmware/-/compare/v1.0.0...v1.1.0

[1.0.0]: https://git.flow3r.garden/flow3r/flow3r-firmware/-/tags/v1.0.0

# generally don't want doubles, doubles on ESP32 bad.

idf_component_get_property(st3m_lib st3m COMPONENT_LIB)

idf_component_get_property(flow3r_bsp_lib flow3r_bsp COMPONENT_LIB)

idf_component_get_property(bl00mbox_lib bl00mbox COMPONENT_LIB)

if("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang")

    target_compile_options(${st3m_lib} PRIVATE -cl-single-precision-constant -Wdouble-promotion)

    target_compile_options(${flow3r_bsp_lib} PRIVATE -cl-single-precision-constant -Wdouble-promotion)

    target_compile_options(${bl00mbox_lib} PRIVATE -Wno-error=unknown-pragmas)

else()

    target_compile_options(${st3m_lib} PRIVATE -fsingle-precision-constant -Wdouble-promotion)

    target_compile_options(${flow3r_bsp_lib} PRIVATE -fsingle-precision-constant -Wdouble-promotion)