Skip to content

Latest commit

 

History

History
376 lines (238 loc) · 23 KB

README.md

File metadata and controls

376 lines (238 loc) · 23 KB

First-time firmware installation procedure

List by Model

Model Instructions Firmware folder
Standalone Edition NodeMCU
ESP32-C3
ESP32-C6		 NodeMCU
ESP32C3
ESP32C6
Prime Edition Mk2 ESP32 ESP32
Prime Edition Mk3 ESP32-S3 ESP32S3
Ham Edition ESP32-S3 ESP32S3
Midi Edition ESP32-S3 ESP32S3
Badge Edition nRF52840 nRF52840
Card Edition  nRF52840 nRF52840
Cozy Edition  nRF52840 nRF52840
Dongle Edition S76G S76G
ES Edition LPC4320 LPC4320
Lego Edition RP2040 RP2040
Balkan Edition STM32WLE5 STM32WLE5
Uni Edition CC1352R CC1352
Mini Edition CubeCell ASR650x
Octave Concept ASR6601 ASR6601
Raspberry Edition RaspberryPi
UAV Edition NodeMCU NodeMCU
Academy Edition N/A1 N/A1
Eco Edition  N/A2 N/A2

1 - since primary purpose of the Academy Edition is education - we do not provide firmware binaries for this model. Students and a teacher are responsible to build and install the SoftRF firmware ( SAMD21 or RA4M1 ) from source code by themselves ;
2 - users of Eco Edition should build and install the SoftRF firmware from source code as well.

Model Instructions Firmware folder
SkyView EZ ESP32 ESP32
SkyView Pico RP2040
ESP32-S3		 RP2040
ESP32S3
WebTop Serial NodeMCU NodeMCU
WebTop USB ESP32-S2 ESP32S2
USB to Bluetooth XIAO SAMD21

NodeMCU

Select NodeMCU COM port

Select firmware file

Start flashing cycle

Wait for completion

ESP32

  1. Take ESP32 flash download tool from this location: http://www.espressif.com/en/support/download/other-tools
    You might also need to install:

  1. Download an appropriate version of SoftRF firmware from this location and unzip the archive ;

  2. Select COM port, enter partition files and addresses, select options ;

    Here is an example:

  1. Press START button and wait for completion.

For some boards you may need to push BOOT button in order to activate flash download mode.
"Stock" modules may also require to apply full flash memory erase (use ERASE UI "button") prior to first flashing with SoftRF's firmware.
One may need to reduce BAUD rate down to 115200 bps.


CubeCell

  1. Take CubeCellflash for Windows (Linux and MacOS variants are also available there) download tool from this location: https://resource.heltec.cn/download/
    You might also need to install a driver for the CP210X USB to UART bridge from Silicon Labs prior to first use of the CubeCellflash tool ;
  2. Download an appropriate version of SoftRF firmware from this location and unzip the archive ;

  1. Use Windows command line tool to execute firmware flashing procedure as follows:


nRF52840

The T-Echo board typically comes with factory pre-installed Adafruit_nRF52_Bootloader.
The Bootloader is capable to self-program an application firmware into the device. In order to simplify the firmware transfer, the bootloader emulates a "USB Mass Storage" interface.

  1. Download an appropriate version of SoftRF firmware from this location ;

  2. Connect the SoftRF Badge Edition device to your PC by means of a USB cable (Type-A <-> Type-C) ;

  3. Double click (within 0.5 seconds) onto the SoftRF device RESET button (LilyGO T-Echo or Heltec T114) or connect twice (within 0.5 seconds) the USB cable while holding the device button been pressed (Seeed T1000-E).

        A virtual disk with a device specific label should appear in your "File manager" afterwards.

        For LilyGO T-Echo the label is   TECHOBOOT (or NRF52BOOT)
        For Seeed T1000-E                     T1000-E
        For Heltec T114                           HT-n5262

  1. Drag the downloaded firmware file by your pointing device (mouse, trackball,...) , then drop it into TECHOBOOT / NRF52BOOT / T1000-E / HT-n5262 disk. Wait until the file transfer is complete.


LPC4320

For Linux and Mac OS X users, you will need a few tools installed on your computer before you begin:

  • dfu-util 0.8 or newer - Used to load and run the stock HackRF One firmware from RAM. dfu-util 0.8 is recommended, as it is the most extensively tested with the HackRF One hardware and build software.
  • hackrf - All you need is the host tools, specifically, hackrf_spiflash.

Backup of factory firmware

$ hackrf_spiflash -v -r HackRF_One_factory_firmware.bin
Reading 256 bytes from 0x000000.
Reading 256 bytes from 0x000100.

< ... skipped ... >

$ ls -la HackRF_One_factory_firmware.bin
-rw-r--r-- 1 pi pi 1048576 Nov  4 10:18 HackRF_One_factory_firmware.bin

Flashing

  1. Download an appropriate version of SoftRF firmware from this location ;
  2. Plug the HackRF One into a PC USB slot while holding down DFU button (the button closer to antenna jack). Release the DFU button, then execute:
$ dfu-util -D hackrf_one_usb.dfu --reset
$ hackrf_spiflash -v -w SoftRF-firmware-v1.1-LPC4320.bin

Restore of HackRF One firmware

Plug the HackRF One into a PC USB slot while holding down DFU button (the button closer to antenna jack). Release the DFU button, then execute:

$ dfu-util -D hackrf_one_usb.dfu --reset
$ hackrf_spiflash -v -w HackRF_One_factory_firmware.bin

ASR6601

  1. Download an appropriate version of SoftRF firmware from this location ;
  2. Take a copy of tremo_loader.py script from ASR SDK ;
  3. Connect an appropriate USB-Serial adapter to ASR6601 MCU pins as follows:
Adapter MCU
GND GND
3V3 VCC
TX GPIO16
RX GPIO17
DTR 3 GPIO2
RTS RESET

3 - certain USB-Serial adapters may require to invert DTR signal either in hardware or in the Python script.

  1. Plug the USB-Serial adapter into spare USB slot of your PC ;
  2. Use the loader tool to read the serial number of the MCU. This is a safety action to make sure that all the connections are good ;
$ python tremo_loader.py --port /dev/ttyUSB0 read_sn
Connecting...
Connected
The SN is: 0c15458cc5fb3201
  1. Write the SoftRF firmware binary into flash memory of the ASR6601.
$ python tremo_loader.py --port /dev/ttyUSB0 flash 0x08000000 SoftRF-firmware-v1.1-ASR6601.bin
Connecting...
Connected
('send: ', 512)
('send: ', 1024)
('send: ', 1536)
('send: ', 2048)
('send: ', 2560)
('send: ', 3072)

< ... skipped ... >

('send: ', 102400)
('send: ', 102912)
('send: ', 103228)
Download files successfully

RP2040

Every RAK11310 WisBlock Core module has built-in (ROM) bootloader.
The bootloader is capable to self-program an application firmware into the device. In order to simplify the firmware transfer, the bootloader emulates a "USB Mass Storage" interface.

  1. Download an appropriate version of SoftRF firmware from this location ;

  2. Plug RAK11310 WisBlock Core module into RAK5005-O WisBlock Base ;

  3. Connect the RAK5005-O to your PC by means of a USB cable (Type-A <-> micro Type-B) ;

  4. Press and keep holding BOOT button of RAK11310 Core module ;

  5. Press and release RESET button on RAK5005-O Base ;

  6. Release BOOT button of RAK11310 module. A virtual disk with RPI-RP2 label should appear in your "File manager" afterwards ;

  7. Drag the downloaded firmware file by your pointing device (mouse, trackball,...) , then drop it into RPI-RP2 disk. Wait until the file transfer is complete.



ESP32-S2

  1. Take esptool-v4.4-win64.zip flash tool for Windows from this location: https://github.com/espressif/esptool/releases/tag/v4.4 and unzip the archive ;
  2. Download an appropriate version of WebTop firmware from this location and unzip the archive ;
  3. Connect the ESP32-S2 board into spare USB slot of your Windows PC ;
  4. Press and keep holding BOOT button of the ESP32-S2 board ;
  5. Press and release RESET button on the ESP32-S2 board ;
  6. Release BOOT button of the ESP32-S2 board. A virtual COM port should appear in "Device Manager" afterwards ;
  7. Execute essptool.exe utility as folows :


STM32WLE5

  1. Take pre-built OpenOCD tool for Windows from this location: https://gnutoolchains.com/arm-eabi/openocd/ and extract the archive ;
  2. Download an appropriate version of SoftRF firmware from this location ;
  3. Connect the SoftRF Balkan Edition device to your PC by means of a USB cable ;
  4. Use Windows command line tool to execute firmware flashing procedure as follows:
C:\OpenOCD-20211118-0.11.0>.\bin\openocd.exe -f interface/cmsis-dap.cfg -c "cmsis_dap_vid_pid 0x15ba 0x0044" -c "transport select swd" -c "adapter speed 4000" -f "target/stm32wlx.cfg" -c "program SoftRF-firmware-v1.2-WLE5.bin 0x08000000"

Example:


ESP32-S3

The T-Beam Supreme board typically comes with factory pre-installed TinyUF2 bootloader.
The Bootloader is capable to self-program an application firmware into the device. In order to simplify the firmware transfer, the bootloader emulates a "USB Mass Storage" interface.

  1. Download an appropriate version of SoftRF firmware from this location and extract the archive ;

  2. Connect the SoftRF device to your PC by means of a USB cable (Type-A <-> Type-C) ;

  3. Press and release RESET button of the SoftRF device. Immediately (within 1 second) press and release the BOOT button. One should see this message on the OLED display.

     For T-Beam Supreme:

     For T-TWR Plus:

     This white LED on the Heltec Tracker will start to flicker:


        A virtual disk with a device specific label should appear in your "File manager" afterwards.

        For T-Beam Supreme the label is   TBEAMBOOT
        For T-TWR Plus                               TWRBOOT
        For Heltec Tracker                           HTBOOT

  1. Drag the downloaded .uf2 firmware file by your pointing device (mouse, trackball,...) , then drop it into TBEAMBOOT / TWRBOOT / HTBOOT disk. Wait until the file transfer is complete.


ESP32-C3

  1. Take ESP32 flash download tool from this location: http://www.espressif.com/en/support/download/other-tools

  2. Download an appropriate version of SoftRF firmware from this location and unzip the archive ;

  3. Connect the ESP32-C3 based device to your PC by means of a USB cable ;

  4. Execute the tool; Select ESP32-C3 Chip Type, Develop WorkMode and UART LoadMode ;

  5. Select COM port, enter partition files and addresses, select options ;

    Here is an example:

  1. Press START button and wait for completion.

"Stock" devices may also require to apply full flash memory erase (use ERASE UI "button") prior to first flashing with SoftRF's firmware.


ESP32-C6

  1. Take ESP32 flash download tool from this location: http://www.espressif.com/en/support/download/other-tools

  2. Download an appropriate version of SoftRF firmware from this location and unzip the archive ;

  3. Connect the ESP32-C6 based device to your PC by means of a USB cable ;

  4. Execute the tool; Select ESP32-C6 Chip Type, Develop WorkMode and UART LoadMode ;

  5. Select COM port, enter partition files and addresses, select options ;

    Here is an example:

  1. Press START button and wait for completion.

"Stock" devices may also require to apply full flash memory erase (use ERASE UI "button") prior to first flashing with SoftRF's firmware.