Version 2023.11.0
These tools manage uploads of RMS data to the UK Meteor Data Archive and to the livestream. There are two parts:
- The post-processing job that runs after RMS to send data to the archive.
- The realtime job that uploads detections to the livestream..
There is more information about RMS and the toolset in the wiki here
These instructions are for single-station setups such as on a Raspberry Pi.
- Login to your pi using VNC or AnyDesk or TeamViewer, open a Terminal window from the Accessories menu, then type the following
cd $HOME/source
git clone https://github.com/markmac99/ukmon-pitools.git Open a terminal window and type the following
cd ukmon-pitools
./refreshTools.sh -
When prompted, copy the SSH public key.
-
If you don't get prompted for the key, then find the hidden file /home/pi/.ssh/ukmon.pub.
-
Email the key to [email protected] along with your location (eg the name of your town or village), your GMN camera ID eg UK12345 and the rough direction your camera points in eg SW, S, NE.
-
We will add your key to our server and send you instructions for how to complete the setup.
These instructions are for multi station linux builds where multiple cameras are managed from a single userid. NB: If you're setting up such a configuration you MUST let me know the affected camera IDs so i can make some server-side adjustments.
To explain the process, lets assume you have cameras US0001 and US0002
- Login as the managing user and run the following to set up US0001
cd $HOME/source
git clone https://github.com/markmac99/ukmon-pitools.git ukmon-pitools-US0001
cd ukmon-pitools-US0001
./refreshTools.sh - This will create a default ukmon.ini file. Edit this file and make the following changes:
export UKMONKEY=~/.ssh/ukmon-US0001
export RMSCFG=~/source/Stations/US0001/.config -
Now rerun ./refreshTools.sh. This time it will create an SSH key called ~/.ssh/ukmon-US0001.
-
If you're setting up from scratch then email the public key to [email protected]. We'll email back instructions in how to complete the process.
-
If you're migrating an existing installation from a pi, then you can copy over the existing keys as follows (replace 'yourpiname' with your Pi's network name or ip address):
scp yourpiname:.ssh/ukmon \~/.ssh/ukmon-US0001
scp yourpiname:.ssh/ukmon.pub \~/.ssh/ukmon-US0001.pub -
Now edit the ini file again and set the LOCATION to the correct value.
-
Then rerun ./refreshTools.sh.
-
This time, it should complete successfully.
-
If you have more than one camera, repeat these instructions for each camera
This uses the RMS post-processing hook to creates JPGs and other data, then upload to the UK Meteor Network archive. The script has three optional capabilities:
The script can create MP4s of each detection. To enable these, edit ukmon.ini and set DOMP4S to 1
DOMP4S=1If you want to run an additional Python script after this one finishes, create a file named "extrascript" in the same folder, containing a single line with the full path to the script. For example to enable the feed to istrastream, you could open a Terminal window and type the following:
echo "$HOME/source/mystuff/myscript.py" > $HOME/source/ukmon-pitools/extrascript This should create file called 'extrascript' in the ukmon-pitools folder, containing one line "$HOME/source/mystuff/myscript.py"
The script must contain a function rmsExternal with the following definition
def rmsExternal(cap_dir, arch_dir, config):
# do stuff hereThis will be passed the capture_dir, archive_dir and RMS config object in the same way as RMS passes these to any external script.
This does the actual uploading to the UK meteor network archive. Can be called standalone if you want to reupload data: eg
python uploadToArchive.py UK0006_20210312_183741_206154 this will upload from $HOME/RMS_data/ArchivedFiles/UK0006_20210312_183741_206154
This script monitors in realtime for detections, then uploads them to the livestream. The script calls a python script liveMonitor.py.
There are two configuration parameters that you can set in ukmon.ini to control how this works:
- UKMFBINTERVAL: how frequently the process checks whether there's a request for fireball data. Default 1800 seconds. Set to zero to disable the fireball upload feature completely.
- UKMMAXAGE: How far back to look for events to upload. Default 1800 seconds. Each time the software is restarted, it will look for events in the log. This parameter avoids too much reuploading of old events.
You shouldn't really need to set these but if you do, then for example edit ukmon.ini and add
export UMFBINTERVAL=900to set the check interval to 900 seconds. Note there must be no spaces around the equals sign, and that export must be in lowercase.
Part of liveMonitor, this python script does the actual uploading. You can use it manually as follows:
python sendToLive.py capture-dir ff-file-name Updates the UKMON RMS Toolset to the latest version. After first run, this will run automatically every time your Pi reboots. You can also run it manually.
refreshTools reads from a configuration file that is specific to your camera. We will send you this file when you onboard to the network. The file contains your location ID and the details of our sftp server used to distribute security keys.
Any questions, concerns or suggestions:
- Check the wiki here https://github.com/markmac99/ukmon-pitools/wiki
- Join our group on Groups.io https://groups.io/g/ukmeteornetwork/topics
- As a last resort, email me via [email protected]
All code Copyright (C) 2018-2023 Mark McIntyre