Skip to main content

VIBE Firmware Manager

Firmware download and installation manager for VIBE FM firmware packages.

The application connects to The Firmware Hub, downloads available firmware packages, stores them locally and installs firmware files into the VIBE FM Firmware directory.


Features

✅ Sync firmware packages

✅ Download firmware packages

✅ Cache downloads locally

✅ Install downloaded firmware

✅ Backup existing firmware before updates

✅ Force download all firmware packages

✅ Force reinstall all firmware packages

✅ Remove all

✅ Offline installation from cached packages

✅ Command line interface


Installation

From PyPI

pip install vibe-firmware-manager

Usage

Show help:

vibe-fw --help

Download sync firmware packages:

Checks against the library.json which is saved locally to se if there are any updates.

vibe-fw sync

Download available firmware packages:

Downloads all of the firmware packages.

vibe-fw download

Install previously downloaded firmware:

Installs all packages in the downloads folder.

vibe-fw install

Download and reinstall everything:

Force a removal of everything and adds the latest firmware and library.json

vibe-fw force

Remove:

All:

Removes all the firmware in the firmware folder and the library,json

vibe-fw remove

Dry run:

vibe-fw remove --dry-run

A package:

vibe-fw remove --package funkydunky

Application Folders

The application stores all firmware data under:

%APPDATA%\VIBE FM

Directory structure:

VIBE FM
│
├── library.json
│
├── Downloads
│   ├── PackageA-1.0.zip
│   ├── PackageB-1.2.zip
│   └── PackageC-4.0.zip
│
├── Firmware
│   ├── PackageA.json
│   ├── PackageA.wasm
│   └── PackageA.aot
│
└── Backup
    ├── 20261101-120000
    └── 20261101-133000

Sync process

  1. Fetch the current library using LibraryService.get_library().
  2. Load the local library file from paths.library. If it contains a dictionary, the service reads its "library" list; it also supports a top-level list.
  3. Compare versions by package ID. A package needs an update if it isn’t in the local library or its installed version differs from the available version.
  4. Handle the no-update case: print “No updates available.” and stop.
  5. Ask what to update: quit, select all updates, or enter package numbers. Invalid input or an empty selection stops the process.
  6. Process each selected package: back up its existing firmware files, download the package ZIP, then install it into the firmware directory.
  7. Save the latest library data to paths.library after all selected packages have been processed.
  8. Report completion by printing “Synchronisation completed.”

Sync flowchart

flowchart TD
    A[Start sync] --> B[Fetch current library]
    B --> C[Load local library]
    C --> D[Compare package IDs and versions]
    D --> E{Updates found?}

    E -- No --> F[Print No updates available]
    F --> Z[End]

    E -- Yes --> G[Display available updates]
    G --> H{User choice}

    H -- Quit --> I[Print Cancelled]
    I --> Z

    H -- Select updates --> J[Read and validate package numbers]
    J --> K{Valid selection?}
    K -- No --> L[Print Invalid selection]
    L --> Z
    K -- Yes --> M{Any packages selected?}

    H -- Download and install all --> N[Select all updates]
    M -- No --> O[Print Nothing selected]
    O --> Z
    M -- Yes --> P[Process selected packages]
    N --> P

    P --> Q[Back up package]
    Q --> R[Download package ZIP]
    R --> S[Install package]
    S --> T{More selected packages?}
    T -- Yes --> Q
    T -- No --> U[Save latest library to paths.library]
    U --> V[Print Synchronisation completed]
    V --> Z

Removal process

  1. Choose the removal mode:
    • Remove all matching firmware files and the library file using remove_files().
    • Remove only one package’s matching firmware files using remove_package_files().
  2. Find matching files: the service looks for .json, .wasm, and .aot files in the firmware directory.
  3. Include the library file: in all-files mode, library_file is included if it exists. Package-specific removal does not affect the library file.
  4. Preview or delete: with dry_run=True (the default), the service returns the matching file paths without deleting them. With dry_run=False, it deletes the selected files.
  5. Return the paths: both methods return a list of files selected for removal, whether or not they were actually deleted.

Removal flowchart

flowchart TD
    A[Start removal] --> B{Removal mode?}

    B -- All files --> C[Find matching firmware files]
    C --> D[Check whether library file exists]
    D -- Yes --> E[Add library file to removal list]
    D -- No --> F[Keep firmware files in removal list]
    E --> G{Dry run?}
    F --> G

    B -- One package --> H[Check package files for each extension]
    H --> I[Add existing package files to removal list]
    I --> G

    G -- Yes --> J[Return file list without deleting]
    G -- No --> K[Delete files in removal list]
    K --> L[Return file list]

    J --> M[End]
    L --> M

Download Process

Downloaded ZIP files are stored in:

%APPDATA%\VIBE FM\Downloads

The service retains downloaded ZIP files so firmware can be installed later without downloading them again. If a ZIP with the same package name and version already exists, the download overwrites it.

  1. Ensure the destination exists: create the destination directory and any missing parent directories.
  2. Build the ZIP file path: use the package name and version in the filename: {package.name}-{package.version}.zip.
  3. Build the download URL: combine base_url with package.file_url, removing any leading slash from package.file_url.
  4. Fetch and save the file: request the ZIP’s bytes through HttpClient and write them to the destination path.
  5. Return the path: return the path to the saved ZIP file.

Download Flowchart

flowchart TD
    A[Start download] --> B[Create destination directory]
    B --> C[Build ZIP filename from package name and version]
    C --> D[Build download URL from base URL and package file URL]
    D --> E[Fetch ZIP bytes using HttpClient]
    E --> F[Write bytes to destination path]
    F --> G[Return ZIP file path]
    G --> H[End]

Supported Firmware Files

Only the following file types will be installed:

.json
.wasm
.aot

All other files contained within firmware packages are ignored.


Backup Process

Before replacing firmware files, the current firmware files can be backed up to a timestamped directory under the backup root.

Example:

Backup
└── 20261101-120000
    ├── SynthOne.json
    ├── SynthOne.wasm
    └── SynthOne.aot

The service supports two backup modes:

  1. Back up all firmware files: create_backup() copies every .json, .wasm, and .aot file in the firmware directory.
  2. Back up one package: create_package_backup() copies only the matching files for the specified package, if they exist.
  3. Create a timestamped folder: both methods create a folder named with the current date and time in YYYYMMDD-HHMMSS format.
  4. Preserve file metadata: shutil.copy2() copies each file and its metadata.
  5. Return the backup path: each method returns the path to the created backup directory.

This backup can be used to restore firmware files if a rollback is needed.

Backup Flowchart

flowchart TD
    A[Start backup] --> B{Backup mode?}

    B -- All firmware files --> C[Find .json, .wasm, and .aot files]
    B -- One package --> D[Find matching package files with supported extensions]

    C --> E[Create timestamped backup directory]
    D --> E

    E --> F{Matching files found?}
    F -- Yes --> G[Copy files with metadata using shutil.copy2]
    F -- No --> H[Leave backup directory empty]

    G --> I[Return backup directory path]
    H --> I
    I --> J[End]

Force Install

Force Install performs the following steps:

1. Download all firmware packages
2. Backup current firmware
3. Remove existing firmware files
4. Reinstall all downloaded firmware

Files removed during force install:

*.json
*.wasm
*.aot

Development

Clone repository:

git clone https://github.com/kesi03/vibe-firmware-manager.git

Create virtual environment:

python -m venv .venv

Activate virtual environment:

Windows:

.venv\Scripts\activate

Install editable package:

pip install -e .

Run directly:

python -m vibe_firmware download

Running Tests

pytest

License

MIT License

Metadata

Release files for vibe-firmware-manager 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vibe-firmware-manager 1.0.2
File Size Uploaded Provenance Actions
vibe_firmware_manager-1.0.2.tar.gz 14.3 kB With provenance Details for vibe_firmware_manager-1.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vibe-firmware-manager 1.0.2
File Interpreter ABI Platform Actions
vibe_firmware_manager-1.0.2-py3-none-any.whl Python 3 none any Details for vibe_firmware_manager-1.0.2-py3-none-any.whl

Total release size: 30.2 kB

Release files / vibe_firmware_manager-1.0.2.tar.gz

Download URL vibe_firmware_manager-1.0.2.tar.gz
Size 14.3 kB
Tags Source
SHA-256 checksum
How to use checksums
1eb58604c5bc254056254c74a7cdb0701afb412942e7c628c485dda5ea908ff8
BLAKE2b-256 checksum
How to use checksums
18563cf1f5f7d6f4a5942f75d436b89dc1deb673e9154d145e88d8dcaafeb73c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Release files / vibe_firmware_manager-1.0.2-py3-none-any.whl

Download URL vibe_firmware_manager-1.0.2-py3-none-any.whl
Size 15.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e1b8e8263ae5537b12a183537f16869c858303bc46b3061a6c9ea9bca270b55c
BLAKE2b-256 checksum
How to use checksums
85d54c8364dadb45330f4ef4100f4621d083fc27aab1f99671aac5ffb6d75740
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

Security for vibe-firmware-manager 1.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for vibe_firmware_manager-1.0.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 2, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.2 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page