-
-
Notifications
You must be signed in to change notification settings - Fork 128
Development & Contributing
Automatic Radiosonde Receiver Utilities can be installed natively or with docker.
The easiest way to develop and contribute to the project is with a native install on the latest testing branch.
To install the testing branch natively replace the first command here with:
git clone --single-branch --branch testing https://github.com/projecthorus/radiosonde_auto_rx.git
To update the testing branch natively replace the git pull command here with git pull origin testing.
To develop with a local instance of auto_rx is quite simple. The program files can be found in radiosonde_auto_rx, on Windows you can use software such as WinSCP to remotely access and upload files to your installation. You will also need to use a program such as PuTTY to execute remote commands on the installation.
When modifying decoder binaries or other components of the program you will need to re-build the decoder binaries as if you were updating. This can be done from the auto_rx directory by executing the following command:
$ ./build.sh
If you are making significant changes to any core components that might affect your uploaded data please modify the auto_rx version number so that we can debug if issues arise on SondeHub etc. The auto_rx version number can be set here, you will need to rebuild decoder binaries after updating this value.
To update the user interface you can simply edit the relevant HTML, CSS, and JS files and upload them to the device, to force the changes to load on your web interface you will need to perform a forced reload with Shift F5 on Chrome.
To install or update the testing branch with docker replace radiosonde_auto_rx:latest in commands from here with radiosonde_auto_rx:testing.
We can develop with a docker installation by using Visual Studio Code and Docker (must be installed on both machines).
We will need to install the Docker, Remote - Container, and the Remote - SSH extensions.
We will use the SSH connection to connect to our auto_rx host device, selecting the green SSH icon in the bottom left choose Remote-SSH: Connect To Host... and enter the IP address and user for the device e.g. [email protected]. Visual Studio will attempt to connect to your device and will prompt you for the user password.
Once we have established a SSH connection we can connect to the auto_rx docker instance running on our device. We can select the docker tab from the side-menu and we should see our auto_rx docker container listed. We can connect to the container by right-clicking and selecting Attach Visual Studio Code this will open the container in a new window for development. If you cannot connect to the container follow the steps here.
The auto_rx code is stored in the /opt/auto_rx folder so we can set this as our foot folder in Visual Studio Code. We can now make our changes and Visual Studio Code will save them on the host device. Website changes will be live immediately after saving and shift f5 in Chrome. You cannot make changes to the decoder binaries or other core components as the docker version currently doesn't support builds (possibly fixed in the future with devcontainer).
To submit your changes to radiosonde_auto_rx, fork this repository and make your changes in the testing branch (not the main branch!). You can then open a pull request (which should be targeted at the testing branch of projecthorus/radiosonde_auto_rx), describing your changes. If you are contributing a fix to an existing issue please discuss your changes in that issues discussion before submitting the pull request.