From 062e15c5c4dcfeb2a388cb8e70667a210690c61e Mon Sep 17 00:00:00 2001 From: Sebastian Maj Date: Mon, 27 Nov 2023 23:23:57 -0500 Subject: [PATCH 1/3] Update README with new device codes values --- README.md | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a5ab8279..d4ae98c3 100644 --- a/README.md +++ b/README.md @@ -78,17 +78,33 @@ $ export FIRMWARE_SHORT_HASH=$(git rev-parse --short HEAD) **Step 1:** Update the settings.ini file to accept the new values which you wish to set in the generation of the docker-compose.yml file -**Step 2:** Generate your respective .yml file based on the device you will be pushing to: -- RPI (Raspberry Pi based device): `python gen_docker_compose.py rpi -o device-compose-files/docker-compose-rpi.yml` -- ROCKPI (ROCK Pi based device): `python gen_docker_compose.py rockpi -o device-compose-files/docker-compose-rockpi.yml` - -**Step 3:** Copy device compose file into root directory as docker-compose.yml: -- RPI: `cp device-compose-files/docker-compose-rpi.yml ./docker-compose.yml` -- ROCKPI: `cp device-compose-files/docker-compose-rockpi.yml ./docker-compose.yml` - -**Step 4:** Validate that the changed values you applied to settings.ini were applied in the docker-compose.yml file - -**Step 5:** Continue with the steps below to push the containers to your fleet via balena +**Step 2:** Create the device-compose-files directory: +`mkdir device-compose-files` + +**Step 3:** Generate your respective .yml file based on the device you will be pushing to: +`python gen_docker_compose_by_variant.py [DEVICE_CODE] -o device-compose-files/docker-compose.yml` +Find the device codes below. + +| Model | DEVICE_CODE | +| --- | --- | +| Nebra Indoor Hotspot Gen 1 | NEBHNT-IN1 | +| Nebra Outdoor Hotspot Gen 1 | NEBHNT-OUT1 | +| Nebra Pi 0 Light Hotspot S | NEBHNT-LGT-ZS | +| Nebra Pi 0 Light Hotspot X | NEBHNT-LGT-ZX | +| Nebra Beaglebone Light Hotspot | NEBHNT-BBB | +| Nebra Pocket Beagle Light Hotspot | NEBHNT-PBB | +| Nebra Hotspot HAT ROCK Pi 4 Indoor | NEBHNT-HHRK4 | +| Nebra Hotspot HAT ROCK Pi 4 Outdoor | NEBHNT-HHRK4-OUT | +| Nebra Hotspot HAT RPi | NEBHNT-HHRPI | +| Nebra Hotspot HAT RPi LIGHT | NEBHNT-HHRPL | +| Nebra Hotspot HAT Tinkerboard 2 | NEBHNT-HHTK | + +**Step 4:** Copy device compose file into root directory as docker-compose.yml: +`cp device-compose-files/docker-compose.yml ./docker-compose.yml` + +**Step 5:** Validate that the changed values you applied to settings.ini were applied in the docker-compose.yml file + +**Step 6:** Continue with the steps below to push the containers to your fleet via balena ### Quick Start Steps From 875e9806d67986b6a01c961b11dbd92f89425845 Mon Sep 17 00:00:00 2001 From: Sebastian Maj Date: Mon, 27 Nov 2023 23:32:31 -0500 Subject: [PATCH 2/3] Added device code step to compose file name --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d4ae98c3..c39ca297 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ $ export FIRMWARE_SHORT_HASH=$(git rev-parse --short HEAD) `mkdir device-compose-files` **Step 3:** Generate your respective .yml file based on the device you will be pushing to: -`python gen_docker_compose_by_variant.py [DEVICE_CODE] -o device-compose-files/docker-compose.yml` +`python gen_docker_compose_by_variant.py [DEVICE_CODE] -o device-compose-files/docker-compose-[DEVICE_CODE].yml` Find the device codes below. | Model | DEVICE_CODE | @@ -100,7 +100,7 @@ Find the device codes below. | Nebra Hotspot HAT Tinkerboard 2 | NEBHNT-HHTK | **Step 4:** Copy device compose file into root directory as docker-compose.yml: -`cp device-compose-files/docker-compose.yml ./docker-compose.yml` +`cp device-compose-files/docker-compose-[DEVICE_CODE].yml ./docker-compose.yml` **Step 5:** Validate that the changed values you applied to settings.ini were applied in the docker-compose.yml file From 332d9d4ea051deed2d292d1c9c30dee6817f1002 Mon Sep 17 00:00:00 2001 From: Sebastian Maj Date: Mon, 27 Nov 2023 23:35:20 -0500 Subject: [PATCH 3/3] Added additional devices --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index c39ca297..661506de 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,11 @@ Find the device codes below. | Nebra Hotspot HAT RPi | NEBHNT-HHRPI | | Nebra Hotspot HAT RPi LIGHT | NEBHNT-HHRPL | | Nebra Hotspot HAT Tinkerboard 2 | NEBHNT-HHTK | +| Rak Hotspot Miner | COMP-RAKHM | +| OG Helium Hotspot | COMP-HELIUM | +| SenseCAP M1 | COMP-SENSECAPM1 | +| Pi Supply IoT LoRa Gateway HAT | DIY-PISLGH | +| RAK2287 | DIY-RAK2287 | **Step 4:** Copy device compose file into root directory as docker-compose.yml: `cp device-compose-files/docker-compose-[DEVICE_CODE].yml ./docker-compose.yml`