From 653586a6260b070d847ae3aca63fbbe80de0ff80 Mon Sep 17 00:00:00 2001 From: flowers Date: Tue, 25 Feb 2025 08:50:35 -0600 Subject: [PATCH] Update readme for firmware installation instructions --- .github/workflows/release-firmware.yml | 5 ++--- SVS Control Module Firmwares/readme.txt | 24 ++++++++++++++++++++---- 2 files changed, 22 insertions(+), 7 deletions(-) diff --git a/.github/workflows/release-firmware.yml b/.github/workflows/release-firmware.yml index 8e5bbbf..00c625c 100644 --- a/.github/workflows/release-firmware.yml +++ b/.github/workflows/release-firmware.yml @@ -33,7 +33,7 @@ jobs: cp "SVS Control Module Firmwares/Scripts/SVS Firmware Update Tool v1.0 Unix.sh" release/ cp "SVS Control Module Firmwares/Scripts/SVS Firmware Update Tool v1.0 Windows.bat" release/ cp -r "SVS Control Module Firmwares/Scripts/tools" release/ - cd release/ && zip -r ../SVS_Firmware_${VERSION}.zip . && cd .. + cd release/ && zip -r SVS_Firmware_${VERSION}.zip . && cd .. - name: Create GitHub Release uses: softprops/action-gh-release@v2 @@ -44,6 +44,5 @@ jobs: Release Notes: ${{ env.DESC }} files: | - release/SVS_Firmware_${{ env.VERSION }}_Mac.zip - release/SVS_Firmware_${{ env.VERSION }}_Windows.zip + release/SVS_Firmware_${{ env.VERSION }}.zip draft: true diff --git a/SVS Control Module Firmwares/readme.txt b/SVS Control Module Firmwares/readme.txt index c1a52c6..638ee00 100644 --- a/SVS Control Module Firmwares/readme.txt +++ b/SVS Control Module Firmwares/readme.txt @@ -9,9 +9,25 @@ The SVS Firmware Update Tool will search for the correct COM port for updating y The SVS Firmware Update Tool will search for the latest firmware update file in the root of the firmware update folder. If the firmware update file it selects is different than the one you want to install then you can manually type in the file name of the firmware version you wish to install as long as that file is also located in the root of your firmware update folder. Once the firmware update is complete you can press any key to close the firmware update tool. -** Linux and Mac Users +** Linux Users -Currently there is no automated script for updating on these platforms. You will need to use AVRDUDE for firmware updates. Below is the command that you need to use. Where is replaced with the correct serial port path for your SVS’s USB serial chip, and where is replaced with the full path to the hex file from the firmware update package. Make sure you use this exact command. If you set the programming options incorrectly then you can brick your control module. The only way to recover it is to send it back to me to have the factory base firmware and security keys reloaded. +Install AVRDUDE using your package manager: -AVRDUDE Update Command -./avrdude -c urclock -p m328p -P -b 115200 -V -D -U flash:w:"":i \ No newline at end of file +Open a terminal and run the following command to install AVRDUDE: +sudo apt-get install avrdude + +For your specific Linux distribution, you may need to use a different package manager or command to install AVRDUDE. +The example above is for Ubuntu and Debian based distributions. + +Run in the terminal: +bash SVS\ Firmware\ Update\ Tool\ v1.0\ Unix.sh + +** Mac Users + +Follow the instruction at https://brew.sh to install Brew. + +Install AVRDUDE using Brew: +brew install avrdude + +Run in the terminal: +bash SVS\ Firmware\ Update\ Tool\ v1.0\ Unix.sh