booster: clarify initial setup

This commit is contained in:
2025-08-01 12:27:55 +08:00
parent ea2188adae
commit 0a0c2d11d5

View File

@@ -49,7 +49,7 @@ cargo objcopy --release -- -O binary booster-release.bin
#### For version before September 2023 on NixOS
```shell
git clone git@github.com:quartiq/booster.git
git clone https://github.com/quartiq/booster
cd booster
git checkout a1f83b63180511ecd68f88a04621624941d17a41 # or earlier
nix-shell -p rustup cargo rustc dfu-util
@@ -125,6 +125,22 @@ In case someone sets some setting wrongly, or updates the firmware and suddenly
11. Connect to your MQTT broker
12. Restart booster to receive settings
## Calibration software setup
For the first setup, we need to create a Python virtual environment with necessary components: ``booster`` script and ``miniconf``.
```shell
python -m venv env
source env/bin/activate.fish
pip install git+https://github.com/quartiq/miniconf.git@84cc9046bf504cc2d0d33b84d2f3133f2faf2248#subdirectory=py/miniconf-mqtt
git clone https://github.com/quartiq/booster
cd booster/py
pip install .
cd ../..
```
For subsequent runs, just call ``source env/bin/activate.fish``.
## Calibration
1. Assemble Kasli with one Urukul, build and flash firmware for it with [booster.json](../extra/booster/booster.json)
@@ -133,23 +149,14 @@ In case someone sets some setting wrongly, or updates the firmware and suddenly
![50Ohm load](../img/50ohm_parallel_load.jpg),
4. Configure oscilloscope for 1M Ohm impedance
5. Attach attenuator to the Urukul's RF2
6. `cd py/`
7. You may also need to download or install python's `gmqtt` and `miniconf`:
```shell
python -m venv env
source env/bin/activate.fish
pip install git+https://github.com/quartiq/miniconf.git@84cc9046bf504cc2d0d33b84d2f3133f2faf2248#subdirectory=py/miniconf-mqtt
```
8. Enable channels:
6. Enable channels:
`python -m booster --broker 192.168.1.123 --prefix dt/sinara/booster/xx-xx-xx-xx-xx-xx --channel N tune=0.1`
9. Using [booster_template](../extra/booster/booster_template.ods) fill in `y0`, `y1`, `m`, `c`,
7. Using [booster_template](../extra/booster/booster_template.ods) fill in `y0`, `y1`, `m`, `c`,
values using instructions below
10. Update settings with the adjusted values
11. Save settings with
8. Update settings with the adjusted values
9. Save settings with
`python -m booster --broker 192.168.1.123 --prefix dt/sinara/booster/xx-xx-xx-xx-xx-xx --channel N save`
12. Reboot and check settings are applied
10. Reboot and check settings are applied
### Input power