README.md

Batch Video Processing

Upload Videos from a folder to Stream via file-upload.

python video_upload.py

Stream Monitor

Monitor Stream HEALTH through it's logs. This script exposes a single API endpoint that returns responses in this format:

{"active": true, "cameras": {"camera-1": {"status": "running"}}}

{"active": true, "cameras": {"camera-1": {"status": "offline"}}}

active is true if the stream container is running, so you need to check it before checking cameras.

1. Installation

git clone https://github.com/parkpow/deep-license-plate-recognition.git
cd stream
python stream_monitor.py --help

Optional arguments:

  -c CONTAINER, --container CONTAINER
                        Stream Container Name or ID
  -l LISTEN, --listen LISTEN
                        Server listen address
  -p PORT, --port PORT  Server listen port
  -i INTERVAL, --interval INTERVAL
                        Interval between reading logs in seconds
  -d DURATION, --duration DURATION
                        Duration to use in considering a camera as offline in seconds

For example, you can start the script with:

python stream_monitor.py -c stream -i 30 -d 120

2. Calling the API endpoint

In another terminal, you can query Stream status.

 curl localhost:8001
 # {"active": false, "cameras": {}}

Remove Stream Images

By Time

This script runs nightly to remove images that are over xx hours in Stream folder. However, if you wouldn't want to save images locally at all, you may refer to this guide.

Make sure to have this remove_images.py script inside the Stream folder.

Format: python remove_images.py --age --threshold <integer> --directory /path/to/stream

Notes:

1. Don't forget to update the --threshold (time duration in hours) to remove images older than xx hours.

2. --threshold should be an integer between 1 and 23 (hours).

_3. --directory Stream working directory, default value = .

Schedule running of script

For Linux:

Note: Make sure cron is installed.

sudo sh -c 'echo "0 0 * * * root <path_to_python_interpreter> <path_to_script> --age --threshold 23" >> /etc/crontab'

# Example: This runs the script daily at midnight and removes images older than 23 hours.
sudo sh -c 'echo "0 0 * * * root /usr/bin/python3 /home/user/stream/remove_images.py --age --threshold 23" >> /etc/crontab'

# Incase you would want to log script errors to a file.
sudo sh -c 'echo "0 0 * * * root <path_to_python_interpreter> <path_to_script> --age --threshold 23 >> <path_to_log_file> 2>&1" >> /etc/crontab'

# Example: This logs the script errors to /home/user/stream/remove_images.log.
sudo sh -c 'echo "0 0 * * * root /usr/bin/python3 /home/user/stream/remove_images.py --age --threshold 23 >> /home/user/stream/remove_images.log 2>&1" >> /etc/crontab'

For Windows:

1. Run this in a command promt or powershell to add the script to Windows Task Scheduler.

schtasks /create /sc <frequency> /tn RemoveStreamImages /tr "<path_to_python_interpreter> <path_to_script> --age --threshold 10" /st <start_time>

# Example: This runs the script daily at midnight and removes images older than 10 hours.
schtasks /create /sc daily /tn RemoveStreamImages /tr "C:\Users\User\AppData\Local\Microsoft\WindowsApps\python.exe C:\PlateRecognizer\Stream\remove_images.py --age --threshold 10" /st 00:00

2. Lastly, to make sure this runs on the Stream directory. Open Task Scheduler, click on the newly created scheduler task, then choose Properties. Go to the Actions tab, then click on Edit. Set the Start in (optional) to be the path of your Stream Directory then click Ok.

Uninstall

To uninstall the service, just remove the script from the Stream directory.

To remove the scheduled running of the script,

For Linux, run this in the terminal:

sudo sed -i '/remove_images/d' /etc/crontab

For Windows, run this in command promt or powershell:

schtasks /delete /tn RemoveStreamImages /f

By Disk Space Percentage

This script automatically deletes the oldest images in the Stream folder to free up disk space when the disk usage exceeds a certain threshold. The script checks if disk usage is above a trigger percentage (y%) and deletes images until it reaches a target free space percentage (x%).

Make sure to have this remove_images.py script inside the Stream folder.

python remove_images.py --usage --target_free <integer> --trigger_usage <integer> --directory /path/to/images

Notes:

_1. Don't forget to update the --target_free (desired free space %) and --trigger_usage (disk usage % that triggers cleanup).

_2. Both --target_free and --trigger_usage must be integers between 1 and 99. _3. --directory Stream working directory, default value = .

Schedule running of script

For Linux:

Note: Make sure cron is installed.

sudo sh -c 'echo "*/10 * * * * root <path_to_python_interpreter> <path_to_script> --usage --target_free 20 --trigger_usage 80 --directory /path/to/stream" >> /etc/crontab'

#Example: Run the script every 10 minutes. If disk usage is above 80%, it will delete oldest images until free space is at least 20%.

sudo sh -c 'echo "*/10 * * * * root /usr/bin/python3 /home/user/stream/remove_images.py --usage --target_free 20 --trigger_usage 80 --directory /home/user/stream" >> /etc/crontab'

#Example: Run the script daily at midnight.

sudo sh -c 'echo "0 0 * * * root /usr/bin/python3 /home/user/stream/remove_images.py --usage --target_free 20 --trigger_usage 80 --directory /home/user/stream" >> /etc/crontab'

#To log script output and errors:

sudo sh -c 'echo "*/10 * * * * root /usr/bin/python3 /home/user/stream/remove_images.py --usage --target_free 20 --trigger_usage 80 --directory /home/user/stream >> /home/user/stream/free_up_disk_space.log 2>&1" >> /etc/crontab'

For Windows:

1. Create a scheduled task in Command Prompt or PowerShell:

schtasks /create /sc <frequency> /tn FreeUpDiskSpace /tr "<path_to_python_interpreter> <path_to_script> --usage --target_free 20 --trigger_usage 80 --directory C:\PlateRecognizer\Stream" /st <start_time>

Example: Run daily at midnight.

schtasks /create /sc daily /tn FreeUpDiskSpace /tr "C:\Users\User\AppData\Local\Microsoft\WindowsApps\python.exe C:\PlateRecognizer\Stream\remove_images.py --usage --target_free 20 --trigger_usage 80 --directory C:\PlateRecognizer\Stream" /st 00:00

Then, open Task Scheduler → find your new task → right-click Properties → Actions tab → click Edit, and set the Start in (optional) path to your Stream folder.

Uninstall

To uninstall the scheduled task:

For Linux, run:

sudo sed -i '/remove_images/d' /etc/crontab

For Windows, run:

schtasks /delete /tn RemoveStreamImages /f

Important Reminders:

• The scripts only delete .jpg files.

• The script deletes the oldest files first (FIFO).

• You can always test the script manually before fully automating to avoid accidental data loss.