FujiNet Flasher - FujiNetWIFI/fujinet-firmware GitHub Wiki

Table of Contents

Overview

Occasionally, new versions of the FujiNet firmware (the software that runs on the FujiNet device itself) are released. The main FujiNet website has a page dedicated to the FujiNet Flasher tool, located here: https://fujinet.online/download/

How to find out when a new firmware version is available?

Install the USB Driver

Some computers may not detect the FujiNet when it is plugged in. You may need to install the USB to UART driver from Silicon Labs (manufacturer of the chip used in Fujinet). Download and install the appropriate driver for your system.

Installing Firmware with FujiNet Flasher

The FujiNet Flasher tool will download the latest firmware, and upload it to your #FujiNet device.

[!important] The flash tool only supports FujiNet hardware with 8MB PSRAM and 16MB flash for ATARI. Coleco ADAM FujiNet has support for 8MB and 16MB flash.

Windows

Run with administrator privileges

macOS

(Details needed.)

Linux

Run as root, e.g. sudo ./FujiNet-Flasher. Alternatively, add your 'regular' user to the appropriate 'group' on your system. For example, if your #FujiNet, via micro-USB cable, appears on your system as the device /dev/ttyUSB0, check which group the device is part of.

ls -l /dev/ttyUSB0
crw-rw---- 1 root dialout 188, 0 Nov 14 11:10 /dev/ttyUSB0

Then, add your account to that group (in the example above, "dialout"):

sudo usermod -a -G dialout USERNAME

To access it immediately (no need to log out and back in) just run, e.g., newgrp dialout.

Now, you should be able to run ./FujiNet-Flasher without switching to root user, or running it under sudo.

Capturing Serial Debug Output

Debugging info from FujiNet can be captured using Fujinet-Flasher. This info may be requested by developers to aid in fixing bugs or troubleshooting hardware problems. These are the steps to capture this information:

  • Connect FujiNet to a computer with a MicroUSB cable
  • Run Fujinet-Flasher and select the the correct port used by Fujinet (ie, COM3 on Windows, /dev/ttyUSB0 on linux)
  • Click the Serial Debug Output button in Fujinet-Flasher
  • Press the RESET button on the FujiNet device (Button C, far right)
  • Debug information will appear in the Fujinet-Flasher window
  • Reproduce your problem with FujiNet then select all (CTRL-A) text in the box and copy it (CTRL-C)
  • Paste the debug output to the developer requesting this information
    • If using AtariAge forum, paste the information into a Spoiler box so the debug output does not fill up the thread
    • Optionally, use a paste site such as our FujiNet PrivateBin and provide the URL

Tips for flashing problems

Some people have issues where the flasher just shows Connecting...---... or similar when trying to flash the FujiNet. Sometimes this can be caused by a poor quality USB cable and can be fixed by trying another. If the problem persists, you can also force the FujiNet into flashing mode by pressing and holding down the A Button during the entire flashing process. (More info about the flashing issue in this "espressif/esptool" bug report comment.)

A user has provided this process for Windows users having issues. The issue appears to be that some other app or program takes control of the serial port if you wait too long:

run FujiNet-Flasher, select your platform, select firmware version, turn on or plugin the fujinet and quickly hit the Flash Firmware button

Flashing a custom firmware file

Sometimes the FujiNet development team may provide a custom firmware file (ZIP) to an end user for testing. This file can be flashed with FujiNet-Flasher. Previously, one had to run the flasher from the command line (FujiNet-Flasher /path/to/firmware.zip) to use a custom firmware file. The latest version has an option in the interface to select a local firmware file to flash.

Download the latest version at Fujinet Home

Screenshot from 2023-02-04 10-51-28

Creating a custom firmware file

Current Process Starting July 2023

A new script has been added to the fujinet-platformio repo that can be enabled in platformio.ini which will build a flashable firmware ZIP file. First, you must uncomment the post build script below (remove the semicolon at the beginning of the line):

extra_scripts =
    pre:build_packages.py
    pre:build_version.py
    pre:build_webui.py
    ;post:build_firmwarezip.py ; Optional, build firmware ZIP file for flash tool

You can also optionally have the script rename the firmware file. By default the name is based on platform (your chosen hardware platform) and version number (from include/version.h). To change the name, uncomment the line below in platformio.ini and modify it to your needs:

; Override platform name when creating firmware ZIP file
; ex: fujinet-CUSTOMNAME-v1.0.zip
;platform_name = CUSTOMNAME

After saving the settings to platformio.ini, you must first run the Project Tasks Build Filesystem Image and then Build the firmware. If the build is successful, you will see a new firmware dir in the fujinet-platformio repo dir that contains the flashable ZIP file.

Old Way

Some users may wish to build their own firmware file for distribution (ie, custom hardware builds, special unsupported features, etc).

  1. Create a new directory for the firmware files to reside and edit a new text file named release.json in that directory.

  2. Edit the release.json file accordingly for your target board. For an 8MB variant board:

    {
	"version": "NEW VERSION NUMBER",
	"version_date": "VERSION DATE/TIME, format: 2023-01-01 12:59:59",
	"build_date": "BUILD DATE/TIME, format: 2023-01-01 12:59:59",
	"description": "NOTES AND DESCRIPTION OF THE CHANGES",
	"git_commit": "GIT COMMIT HASH",
	"files":
	[
 	{
 		"filename": "bootloader.bin",
 		"offset": "0x1000"
 	},
 	{
 		"filename": "partitions.bin",
 		"offset": "0x8000"
 	},
 	{
 		"filename": "firmware.bin",
 		"offset": "0x10000"
 	},
 	{
 		"filename": "spiffs.bin",
 		"offset": "0x600000"
 	}
 ]
}

    For a 16MB variant board:

    {
 "version": "NEW VERSION NUMBER",
 "version_date": "VERSION DATE/TIME, format: 2023-01-01 12:59:59",
 "build_date": "BUILD DATE/TIME, format: 2023-01-01 12:59:59",
 "description": "NOTES AND DESCRIPTION OF THE CHANGES",
 "git_commit": "GIT COMMIT HASH",
 "files":
 [
 	{
 		"filename": "bootloader.bin",
 		"offset": "0x1000"
 	},
 	{
 		"filename": "partitions.bin",
 		"offset": "0x8000"
 	},
 	{
 		"filename": "firmware.bin",
 		"offset": "0x10000"
 	},
 	{
 		"filename": "spiffs.bin",
 		"offset": "0x910000"
 	}
 ]
}

  3. Using PlatformIO and VSCode, build the Firmware and Filesystem images

  4. Copy the firmware files (bootloader.bin, partitions.bin, firmware.bin and spiffs.bin) from fujinet-platformio/.pio/build/(target-platform)/ to the same directory with release.json

  5. Compress the files into the root of a ZIP file (not in a subfolder) and provide it to the end user