Skip to content

Commit

Permalink
Update README with new device codes values
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Maj committed Nov 28, 2023
1 parent 07173bf commit 062e15c
Showing 1 changed file with 27 additions and 11 deletions.
38 changes: 27 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 062e15c

Please sign in to comment.