Merge pull request #537 from jLynx/flashing

Added flashing tools

.github/workflows/changelog.py

@@ -0,0 +1,28 @@
+import os
+import re
+import sys
+
+raw_git = os.popen('git log next --since="24 hours" --pretty=format:"- %h - {USERNAME}*+%al-%an*: %s"').read()
+
+
+def compute_username(line):
+    stripped = re.search(r'(?<=\*)(.*?)(?=\*)', line).group(0)
+
+    pattern = re.compile("[$@+&?].*[$@+&?]")
+    if pattern.match(stripped):
+        stripped = re.sub("[$@+&?].*[$@+&?]", "", stripped)
+        stripped = re.match(r'.+?(?=-)', stripped).group(0)
+    else:
+        stripped = re.sub(r'^.*?-', "", stripped)
+    return "@" + stripped
+
+
+def compile_line(line):
+    username = compute_username(line)
+    line = re.sub(r'[*].*[*]', "", line)
+    line = line.replace("{USERNAME}", username)
+    return line
+
+
+for row in raw_git.splitlines():
+    print(compile_line(row))

.github/workflows/create_nightly_release.yml

@@ -0,0 +1,99 @@
+name: Nightly Release
+
+on:
+  schedule:
+    - cron: "0 0 * * *"
+    
+  workflow_dispatch:
+
+jobs:
+  check_date:
+    runs-on: ubuntu-latest
+    name: Check latest commit
+    outputs:
+      should_run: ${{ steps.should_run.outputs.should_run }}
+    steps:
+      - uses: actions/checkout@v2
+      - name: print latest_commit
+        run: echo ${{ github.sha }}
+
+      - name: check latest commit is less than a day
+        id: should_run
+        continue-on-error: true
+        run: test -z $(git rev-list  --after="24 hours" ${{ github.sha }}) && echo "::set-output name=should_run::false"
+  build:
+    needs: check_date
+    if: ${{ needs.check_date.outputs.should_run != 'false' }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
+      - name: Get version date
+        id: version_date
+        run: echo "::set-output name=date::n_$(date +'%y%m%d')"
+      - name: Checkout 
+        uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+          ref: next
+          submodules: true
+      - name: Git Sumbodule Update
+        run: |
+          git submodule update --init --recursive
+      - name: Build the Docker image
+        run: docker build -t portapack-dev -f dockerfile-nogit . --tag my-image-name:$(date +%s)
+      - name: Make build folder
+        run: mkdir ${{ github.workspace }}/build
+      - name: Run the Docker image
+        run: docker run -e VERSION_STRING=${{ steps.version_date.outputs.date }} -i -v ${{ github.workspace }}:/havoc portapack-dev
+      - name: Create Firmware ZIP
+        run: |
+          zip --junk-paths firmware build/firmware/portapack-h1_h2-mayhem.bin
+      - name: Create SD Card ZIP
+        run: |
+          zip -r sdcard.zip sdcard
+      - name: Create changelog
+        run: |
+          CHANGELOG=$(python3 .github/workflows/changelog.py)
+          CHANGELOG="${CHANGELOG//'%'/'%25'}"
+          CHANGELOG="${CHANGELOG//$'\n'/'%0A'}"
+          CHANGELOG="${CHANGELOG//$'\r'/'%0D'}"
+          echo "::set-output name=content::$CHANGELOG"
+        id: changelog
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: nightly-tag-${{ steps.date.outputs.date }}
+          release_name: Nightly Release - ${{ steps.date.outputs.date }}
+          body: |
+            **Nightly release - ${{ steps.date.outputs.date }}**
+            This build is the latest and greatest, although may not be the most stable as this is a nightly release.
+            ## Release notes
+            ###  Revision (${{ steps.version_date.outputs.date }}):
+            ${{ steps.changelog.outputs.content }}
+          draft: false
+          prerelease: true
+      - name: Upload Firmware Asset
+        id: upload-firmware-asset 
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./firmware.zip
+          asset_name: mayhem_nightly_${{ steps.version_date.outputs.date }}_FIRMWARE.zip
+          asset_content_type: application/zip
+      - name: Upload SD Card Assets
+        id: upload-sd-card-asset 
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./sdcard.zip
+          asset_name: mayhem_nightly_${{ steps.version_date.outputs.date }}_COPY_TO_SDCARD.zip
+          asset_content_type: application/zip

CMakeLists.txt

@@ -25,8 +25,8 @@ set(CMAKE_TOOLCHAIN_FILE ${CMAKE_CURRENT_LIST_DIR}/firmware/toolchain-arm-cortex
 
 project(portapack-h1)
 
-#set(VERSION "")
-if (NOT DEFINED VERSION)
+set(VERSION "$ENV{VERSION_STRING}")
+if ("$ENV{VERSION_STRING}" STREQUAL "")
 	execute_process(
 		COMMAND git log -n 1 --format=%h
 		WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
@@ -38,7 +38,7 @@ if (NOT DEFINED VERSION)
 	if (GIT_VERSION_FOUND)
 		set(VERSION "unknown")
 	else (GIT_VERSION_FOUND)
-		set(VERSION "local-${GIT_VERSION}")
+		set(VERSION "${GIT_VERSION}")
 	endif (GIT_VERSION_FOUND)
 endif()
 

firmware/application/apps/tpms_app.hpp

@@ -136,7 +136,7 @@ private:
 		3,
 		{
 			{ "315", 315000000 },
-			{ "434", 433920000 },
+			{ "433", 433920000 },
 		}
 	};
 

firmware/application/ui_navigation.hpp

@@ -190,7 +190,7 @@ namespace ui
 		void on_speaker();
 		void on_stealth();
 		void on_bias_tee();
-		//void on_textentry();
+		// void on_textentry();
 		void on_camera();
 		void on_title();
 		void refresh();
@@ -212,7 +212,7 @@ namespace ui
 		void refresh();
 
 	private:
-		static constexpr auto version_string = "v1.4.4";
+		// static constexpr auto version_string = "v1.4.4"; // This is commented out as we are now setting the version via ENV (VERSION_STRING=v1.0.0)
 		NavigationView &nav_;
 
 		Rectangle backdrop{
@@ -221,7 +221,7 @@ namespace ui
 
 		Text version{
 			{2, 0, 11 * 8, 16},
-			version_string};
+			VERSION_STRING};
 
 		LiveDateTime ltime{
 			{86, 0, 19 * 8, 16}};

flashing/Check for firmware updates.url

@@ -0,0 +1,2 @@
+[InternetShortcut]
+URL=https://github.com/eried/portapack-mayhem/releases

flashing/How to update the firmware.url

@@ -0,0 +1,2 @@
+[InternetShortcut]
+URL=https://github.com/eried/portapack-mayhem/wiki/Update-firmware

flashing/README.txt

@@ -0,0 +1 @@
+Plug HackRF+Portapack, set it in HackRF mode, launch flash_portapack_mayhem.bat

flashing/dfu_hackrf_one.bat

@@ -0,0 +1,19 @@
+@echo off
+
+echo *** Run HackRF firmware in RAM via LPC DFU ***
+echo.
+echo This is used to "unbrick" your HackRF, if you are no longer able to use
+echo HackRF tools to flash or operate your HackRF.
+echo.
+echo Connect your HackRF One to a USB port on your computer.
+echo.
+echo Hold down both the DFU and RESET buttons on the HackRF.
+echo Then release the RESET button (closest to the edge).
+echo Then release the DFU button.
+echo.
+pause
+
+echo.
+dfu-util-static.exe --device 1fc9:000c --download hackrf_one_usb.dfu --reset
+echo.
+pause

flashing/driver/dpinst.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" ?>
+<dpinst>
+  <deleteBinaries/>
+  <installAllOrNone/>
+  <suppressAddRemovePrograms/>
+  <suppressWizard/>
+</dpinst>

flashing/flash_hackrf_one.bat

@@ -0,0 +1,15 @@
+@echo off
+
+echo *** Re-flash the HackRF with HackRF firmware ***
+echo.
+echo Connect your HackRF One to a USB port on your computer.
+echo.
+echo If using a PortaPack, put the PortaPack in HackRF mode by selecting
+echo the "HackRF" option from the main menu.
+echo.
+pause
+
+echo.
+hackrf_update.exe hackrf_one_usb.bin
+echo.
+pause

flashing/flash_portapack_mayhem.bat

@@ -0,0 +1,15 @@
+@echo off
+
+echo *** Re-flash the HackRF with PortaPack firmware ***
+echo.
+echo Connect your HackRF One to a USB port on your computer.
+echo.
+echo If using a PortaPack, put the PortaPack in HackRF mode by selecting
+echo the "HackRF" option from the main menu.
+echo.
+pause
+
+echo.
+hackrf_update.exe portapack-h1_h2-mayhem.bin
+echo.
+pause

sdcard/SAMPLES/README.md

@@ -0,0 +1,11 @@
+# Files for Replay app
+
+Sample files below can be used with Replay app.
+
+See [Wiki](https://github.com/eried/portapack-mayhem/wiki/C16-format) for more info over C16 file format.
+
+| file | description | frequency |
+| ------ | ------ | ------: |
+| [HamptonBayFanOnOff.C16](HamptonBayFanOnOff.C16) | Switches Hampton Bay fan on/off. |304.175 Mhz |
+| [TeslaChargePort_EU_AU.C16](TeslaChargePort_EU_AU.C16) | Opens a Tesla charge door. This version is for non-US Tesla cars operating at 433MHz.  | 433.95 Mhz |
+| [TeslaChargePort_US.C16](TeslaChargePort_US.C16) | Opens a Tesla charge door. This version is for US Tesla cars operating at 315MHz. |315 Mhz |

sdcard/SAMPLES/TeslaChargePort_EU_AU.TXT

@@ -1,2 +1,2 @@
-sample_rate=600000
+sample_rate=500000
 center_frequency=433950000

sdcard/SAMPLES/TeslaChargePort_US.TXT

@@ -0,0 +1,2 @@
+sample_rate=500000
+center_frequency=315000000