Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README with new device codes values #893

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update README with new device codes values #893

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
062e15c
Update README with new device codes values
Nov 28, 2023
875e980
Added device code step to compose file name
Nov 28, 2023
332d9d4
Added additional devices
Nov 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 32 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,17 +78,38 @@ $ 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-[DEVICE_CODE].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 |
| 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`

**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

Expand Down