Merge pull request #16 from OpenShock/feature/dotenv-vars

Start implementing dotenv vars

Author: redmushie

.env

@@ -0,0 +1,2 @@
+OPENSHOCK_API_DOMAIN=api.shocklink.net
+OPENSHOCK_FW_VERSION=0.8.1

.env.development

@@ -0,0 +1 @@
+LOG_LEVEL=VERBOSE

.env.production

@@ -0,0 +1 @@
+LOG_LEVEL=INFO

.github/workflows/ci-build.yml

@@ -153,6 +153,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           sparse-checkout: |
+            scripts
             boards
 
       - uses: actions/setup-python@v4
@@ -175,7 +176,7 @@ jobs:
 
       - name: Merge flash image
         run: |
-          python merge_image.py ${{ matrix.board }} &&
+          python scripts/merge_image.py ${{ matrix.board }} &&
             mv merged.bin OpenShock.${{ matrix.board }}.bin
 
       - name: Upload merged flashable image

.gitignore

@@ -7,3 +7,6 @@
 
 # data/www is autogenerated by the build process, ignore it:
 data/www
+
+# ignore local config files
+*.local

.vscode/settings.json

@@ -94,5 +94,6 @@
     "editor.defaultFormatter": "esbenp.prettier-vscode",
     "editor.formatOnSave": true
   },
-  "python.analysis.typeCheckingMode": "basic"
+  "python.analysis.typeCheckingMode": "basic",
+  "black-formatter.args": ["--line-length", "120", "--skip-string-normalization"]
 }

build_frontend.py

@@ -8,12 +8,14 @@
 config = configparser.ConfigParser()
 config.read('platformio.io')
 
-source_dir = Path().absolute() / "boards"
-target_dir = Path.home() / ".platformio" / "boards"
+source_dir = Path().absolute() / 'boards'
+target_dir = Path.home() / '.platformio' / 'boards'
+
 
 def create_boards_dir():
     os.makedirs(target_dir, exist_ok=True)
 
+
 def wipe_installed_boards():
     print('Wiping installed boards')
     for filename in os.listdir(target_dir):
@@ -27,17 +29,20 @@ def wipe_installed_boards():
         except Exception as e:
             print('Failed to delete boards. Reason: %s' % (path, e))
 
+
 def install_board(file):
-    dest = target_dir / ("OpenShock-" + file +  ".json")
-    print("  Installing: %s" % dest)
-    shutil.copyfile(source_dir / file / "board.json", dest)
+    dest = target_dir / ('OpenShock-' + file + '.json')
+    print('  Installing: %s' % dest)
+    shutil.copyfile(source_dir / file / 'board.json', dest)
+
 
 def install_boards():
-    print("Installing defined boards")
+    print('Installing defined boards')
     for filename in os.listdir(source_dir):
-        if os.path.exists(source_dir / filename / "board.json"):
+        if os.path.exists(source_dir / filename / 'board.json'):
             install_board(filename)
 
+
 create_boards_dir()
 wipe_installed_boards()
 install_boards()

embed_version.py

@@ -24,9 +24,8 @@ lib_deps =
 board_build.partitions = huge_app.csv ; Overridden per board
 board_build.filesystem = littlefs
 extra_scripts =
-  pre:release_or_develop.py
-  pre:embed_version.py
-  post:build_frontend.py
+  pre:scripts/embed_env_vars.py
+  post:scripts/build_frontend.py
 
 ; Serial Monitor options
 upload_speed = 921600

install_boards.py

@@ -0,0 +1 @@
+**/__pycache__