Skip to content

Commit 3a73c8e

Browse files
committed
Update install/update instructions
Add steps to enable the startup service. Add new update instructions based on the update script. Remove instructions for cron job scheduling (startup service + config settings are now used) and adding Wi-Fi connections via nmtui (can now be added in the web app + config file).
1 parent 09dbe87 commit 3a73c8e

File tree

6 files changed

+27
-82
lines changed

6 files changed

+27
-82
lines changed
-11.3 KB
Binary file not shown.
-13.5 KB
Binary file not shown.
-23.8 KB
Binary file not shown.
-49.2 KB
Binary file not shown.

docs/software/pisetup.md

Lines changed: 23 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,24 @@ Generate self-signed SSL certificates to optionally enable HTTPS for the web app
468468
bash insect-detect/generate_ssl_certificates.sh
469469
```
470470

471+
To enable the `insect-detect-startup.service` at boot, copy it to the systemd directory:
472+
473+
``` bash
474+
sudo cp insect-detect/insect-detect-startup.service /etc/systemd/system/
475+
```
476+
477+
...reload the systemd daemon:
478+
479+
``` bash
480+
sudo systemctl daemon-reload
481+
```
482+
483+
...and enable the service:
484+
485+
``` bash
486+
sudo systemctl enable insect-detect-startup.service
487+
```
488+
471489
**Optional**: Install and configure [Rclone](https://rclone.org/docs/){target=_blank}
472490
if you want to use the upload feature:
473491

@@ -500,12 +518,14 @@ the software and how to use it.
500518
## Update Software
501519

502520
As the software for the Insect Detect camera trap is still under continuous
503-
development, it is recommended to update it regularly.
521+
development, it is recommended to update it regularly. The provided update
522+
script will create backups of all your config files, handle your local changes
523+
and give you instructions in the case of merge conflicts.
504524

505-
Update the `insect-detect` repo with git by running:
525+
Update the `insect-detect` repo by running the update script:
506526

507527
``` bash
508-
git -C ~/insect-detect pull
528+
bash insect-detect/insect_detect_update.sh
509529
```
510530

511531
If the `requirements.txt` file was included in the updates, make sure that you
@@ -514,79 +534,3 @@ have the latest versions of the required packages installed by running:
514534
``` bash
515535
env_insdet/bin/python3 -m pip install -r insect-detect/requirements.txt
516536
```
517-
518-
---
519-
520-
## Schedule Cron Job
521-
522-
To automatically run the recording script after each boot (triggered by the power management
523-
board), you will have to set up a [cron job](https://en.wikipedia.org/wiki/Cron){target=_blank}.
524-
525-
Open the crontab file for editing by running:
526-
527-
``` bash
528-
crontab -e
529-
```
530-
531-
When you are asked to choose an editor, type in `1` and confirm with ++enter++.
532-
533-
Paste the following lines at the end of the crontab file:
534-
535-
``` text
536-
# Wait 30 seconds after boot to ensure all system services are fully initialized
537-
# Run Python script with timestamped logging, including potential error messages
538-
@reboot sleep 30 && { printf "\%s - Running yolo_tracker_save_hqsync.py\n" "$(date +"\%F \%T,\%3N")"; env_insdet/bin/python3 insect-detect/yolo_tracker_save_hqsync.py; } >> insect-detect/cronjob_log.log 2>&1
539-
```
540-
541-
Exit the editor with ++ctrl+x++ and save the changes with ++y+enter++.
542-
543-
This cron job will wait for 30 seconds after boot (`sleep 30`) to make sure that
544-
all important services are ready. It will then run the Python script and log its
545-
execution, including potential error messages, to `insect-detect/cronjob_log.log`.
546-
547-
!!! tip ""
548-
549-
If you are still in the testing phase, it is highly recommended to deactivate
550-
your cronjob by adding `#` in front of `@reboot`. Otherwise each time you are
551-
booting up your Raspberry Pi, it will run the Python script.
552-
553-
??? info "Use custom configuration"
554-
555-
Modify the
556-
[`config_selector.yaml`](https://github.com/maxsitt/insect-detect/blob/main/configs/config_selector.yaml){target=_blank}
557-
file to select the active config that will be used to load all configuration
558-
parameters. Change it to
559-
[`config_custom.yaml`](https://github.com/maxsitt/insect-detect/blob/main/configs/config_custom.yaml){target=_blank}
560-
to use your modified settings when running the recording script.
561-
562-
---
563-
564-
## Add Wi-Fi Connections
565-
566-
Use the [NetworkManager TUI](https://networkmanager.dev/docs/api/latest/nmtui.html){target=_blank}
567-
to add or edit Wi-Fi connections (navigate with arrow keys):
568-
569-
``` bash
570-
sudo nmtui-edit
571-
```
572-
573-
![NetworkManager TUI Add Connection](assets/images/nmtui_add_connection.png){ width="400" }
574-
575-
Select `Wi-Fi` and then `Create` to add credentials for a new Wi-Fi connection.
576-
577-
![NetworkManager TUI Connection Type](assets/images/nmtui_connection_type.png){ width="400" }
578-
579-
Set a profile name and enter the SSID and password of the Wi-Fi connection you
580-
want to add. Hit ++space++ to activate `Show password`.
581-
582-
![NetworkManager TUI Edit Connection](assets/images/nmtui_edit_connection.png){ width="400" }
583-
584-
Hit `OK` and then `Quit` to save your new connection.
585-
586-
To show the available networks and connect to one of them, run:
587-
588-
``` bash
589-
nmtui-connect
590-
```
591-
592-
![NetworkManager TUI Connect Network](assets/images/nmtui_connect_network.png){ width="400" }

docs/software/usage.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,10 @@ env_insdet/bin/python3 insect-detect/yolo_tracker_save_hqsync.py
8282

8383
Stop the script by pressing ++ctrl+c++ in the Terminal.
8484

85-
For fully automated monitoring in the field, set up a
86-
[cron job](pisetup.md#schedule-cron-job){target=_blank} that will run the script
87-
automatically after each boot (triggered by the power management board).
85+
For fully autonomous monitoring in the field, enable `auto_run` in the `startup`
86+
settings of your custom config file and add `yolo_tracker_save_hqsync.py` as
87+
`primary` script. This will run the recording script automatically after each boot
88+
(triggered by the power management board).
8889

8990
**Processing pipeline:**
9091

0 commit comments

Comments
 (0)