[[File:Satnogs-setup.png|thumb]]
==Introduction==
<code>satnogs-setup</code> provides a set of scripts for provisioning and configuring '''SatNOGS'''. <code>satnogs-setup</code> main function is to bring up a menu-driven console configuration utility and provision the system using [[SatNOGS Client Ansible|Ansible]]. Instruction on this page assumes that you have successfully established console access on the host machine intended to run SatNOGS.

==Initial Setup==
The <code>satnogs-setup</code> configuration tool is automatically executed during [[Raspberry Pi#Installation|the installation process]]. However, if needed, you can reconfigure the software at any time by running it again:
$ satnogs-setup

==Configuration==
{{Warning| Configuring SatNOGS can potentially interrupt a running observation!}}The configuration is divided into <code>Basic</code> and <code>Advanced</code> submenus. The '''Basic Configuration''' includes the essential settings required to get the station up and running, while further optimization or customization can be done through the '''Advanced Configuration'''. The <code>Show</code> menu item displays the current configuration in a single view, and the <code>Reset</code> option deletes all existing configurations. Lastly, the <code>About</code> menu item provides information about the tool itself.
Once the configuration is completed, exiting the utility will apply the changes. Please note that this process may take several minutes, depending on the modifications made.{{Message|You can always reconfigure the software by running <code>sudo satnogs-setup</code> again.}}
===Basic Configuration===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_API_TOKEN</code>
|The API token assigned to your ground station on the SatNOGS Network website. Please don’t share your API key as this can give access to anyone to upload and change things in network related to your station and its observations.

To find your API token, log into [https://network.satnogs.org/ network.satnogs.org], click on the user icon at the top right corner and then click on the "Dashboard" option. On the top of the dashboard page, right under the user icon, click the button "API key" to show your API token.
|-
|<code>SATNOGS_SOAPY_RX_DEVICE</code>
|If you are using an RTL-SDR, this is <code>driver=rtlsdr</code>. For other devices tested configurations can be found at [[Software_Defined_Radio]].

See [https://github.com/pothosware/SoapyRTLSDR/wiki#modules pothosware/SoapyRTLSDR/wiki#modules] for other SDR modules (linked in the navigation bar at the right side of the page). If multiple devices are attached to your station you should also specify the serial of the desired device here, e.g. <code>driver=uhd,serial=3164495</code>.
|-
|<code>SATNOGS_ANTENNA</code>
|If you are using an RTL-SDR, this is <code>RX</code>. For other devices tested configurations can be found at [[Software_Defined_Radio]].

If your device is not listed there yet, use <code><nowiki>SoapySDRUtil --probe 2>&1| grep Antennas</nowiki></code> to get available antennas.
|-
|<code>SATNOGS_RX_SAMP_RATE</code>
|Specify the receiver sampling rate. Recommended value for RTL-SDR: <code>2.048e6</code> (for 2Msps), other devices will need different sample rates described at [[Software_Defined_Radio]] .

The command <code><nowiki>SoapySDRUtil --probe 2>&1 | grep Sample</nowiki></code> can be used to find all valid sample rates.
|-
|<code>SATNOGS_STATION_ELEV</code>
|The height of your ground station above sea level in metres.
|-
|<code>SATNOGS_STATION_ID</code>
|The '''numeric ID''' assigned to your station in the SatNOGS Network site when the groundstation was created.
|-
|<code>SATNOGS_STATION_LAT</code>
|The latitude of your station. North is positive, south is negative.
|-
|<code>SATNOGS_STATION_LON</code>
|The longitude of your station. East is positive, west is negative.
|}
===Advanced Setup===
{{Warning|Changes to the following settings may be required to optimise station performance, or enable support for additional features (e.g. rotator control)}}A more detailed description on setting up a development environment using the SatNOGS reference setup is given in [[SatNOGS_Client_Development]].

====Radio====
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_PPM_ERROR</code>
|The local oscillator frequency deviation in ppm (value will be rounded to integer).
Available with the following modules:

*SoapyRTLSDR
*SoapySDRPlay

Not available with the following modules:

*SoapyUHD
*SoapyPluto
|-
|<code>SATNOGS_LO_OFFSET</code>
|Don't use this parameter to correct for the local oscillator frequency deviation, use <code>SATNOGS_PPM_ERROR</code> instead!
To avoid the SDR carrier at the DC the LO is shifted from the actual frequency a little. Default: <code>100e3</code> (100 kHz)
|-
|<code>SATNOGS_GAIN_MODE</code>
|Choose the gain mode:

*<code>"Overall"</code> (default): Set the gain with the single value from <code>SATNOGS_RF_GAIN</code>
*<code>"Settings Field"</code>: Ignore <code>SATNOGS_RF_GAIN</code>, use the settings from <code>SATNOGS_OTHER_SETTINGS</code> instead
|-
|<code>SATNOGS_RF_GAIN</code>
|RF Gain value for your SDR hardware.

Run <code>SoapySDRUtil --probe</code> to see all possible gain values for your hardware. Example: For RTL-SDR without pre-amp, 32.8 is a good starting value. Follow [[Omnidirectional Station How To#Setting the gain|Setting the gain]] to find a good gain value.
|-
|<code>SATNOGS_RX_BANDWIDTH</code>
|Soapy baseband filter bandwidth [https://github.com/pothosware/SoapySDR/blob/a489f3dca9d3ccd9b276b95a608ac3ef0299f635/include/SoapySDR/Device.hpp#L904-L910] of RX Channel 0 in Hz (only available on specific devices). TODO: Testing.
|-
|<code>SATNOGS_DEV_ARGS</code>
|Soapy device arguments (currently only accepting the <code>serial</code> key successfully) and stream arguments.
NOTE: This parameter / its meaning might change in the near future, see issue [https://gitlab.com/librespacefoundation/satnogs/satnogs-client/-/issues/373 satnogs-client#373].
|-
|<code>SATNOGS_STREAM_ARGS</code>
|
|-
|<code>SATNOGS_TUNE_ARGS</code>
|
|-
|<code>SATNOGS_OTHER_SETTINGS</code>
|Only available if <code>SATNOGS_GAIN_MODE</code>is<code>"Settings Field"</code>.
Available gain settings can be retrieved using <code>SoapySDRUtil --probe="driver=xxxx`</code>

Example for Airspy: Use<code>"LNA=12,MIX=8,VGA=11"</code>See also: [[SDR#Airspy|Airspy support]]
|-
|<code>SATNOGS_DC_REMOVAL</code>
|
|-
|<code>SATNOGS_BB_FREQ</code>
|
|}

====Rotator====
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_ROT_MODEL</code>
|Hamlib rotator model. If you don't have a rotator (like the [[No rotator|No rotator setup]]), leave it empty.
Use the macro name for your rotator model from this [https://gist.github.com/kerel-fs/2354ff9c082cd3c1594afc38c67bc32a#hamlib-release-33 list of rotator models in Hamlib]. If you are connecting to a separate rotctld instance, use <code>ROT_MODEL_NETROTCTL</code>
|-
|<code>SATNOGS_ROT_BAUD</code>
|Baud rate for Hamlib rotator serial port, if using a serial-connected rotator.
|-
|<code>SATNOGS_ROT_PORT</code>
|Serial port for Hamlib rotator, OR the network address of a rotctld instance (e.g. <code>localhost:4533</code> )
|-
|<code>SATNOGS_ROT_THRESHOLD</code>
|Rotator movement threshold, in degrees. If set, the rotator will only be commanded when the target has moved more than <threshold> degrees away from the current azimuth/elevation position. Default: 4 degrees
|}

====Artifacts====
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_ARTIFACTS_ENABLED</code>
|Enable generation and uploading of HDF5 artifacts files to SatNOGS DB. (added in satnogs-client 1.7)
|-
|<code>SATNOGS_ARTIFACTS_API_TOKEN</code>
|SatNOGS DB API token associated with an account in SatNOGS DB. This token is secret. It is used to upload artifacts to SatNOGS DB. It can be found in SatNOGS DB user page. (added in satnogs-client 1.7)
|}

====Scripts====
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_PRE_OBSERVATION_SCRIPT</code>
| rowspan="2" |Allows execution of a shell script either pre or post-observation. The following can be entered into the script path to enable passing of information to the script:
<code><nowiki>{{FREQ}}</nowiki></code> - Observation Centre Frequency

<code><nowiki>{{TLE}}</nowiki></code> - Target object TLE data, as a JSON-formatted object.

<code><nowiki>{{TIMESTAMP}}</nowiki></code> - Start time of the observation, in the format: %Y-%m-%dT%H-%M-%S%z

<code><nowiki>{{ID}}</nowiki></code> - Observation ID number.

<code><nowiki>{{BAUD}}</nowiki></code> - Baud rate of the modulation used, if applicable.

<code><nowiki>{{SCRIPT_NAME}}</nowiki></code> - The name of the demodulation flow-graph script in use.
|-
|<code>SATNOGS_POST_OBSERVATION_SCRIPT</code>
|}

====Hamlib====
{| class="wikitable"
!Setting
!Description
|-
|<code>HAMLIB_UTILS_ROT_ENABLED</code>
|Whether or not to enable the Hamlibs rotator daemon. Rotctld is a software daemon that provides a network server to control a rotator on a serial port.
|-
|<code>HAMLIB_UTILS_ROT_OPTS</code>
|Options for rotcld:
For a yaesu rotator, use <code>-m 601 -r /dev/ttyACM0 -s 9600 -T 0.0.0.0</code>

For a SatNOGS rotator <code>-m 204 -s 19200 -r /dev/ttyACM0 -C timeout=200</code> or <code>-m 204 -s 19200 -r /dev/ttyUSB0 -C timeout=200</code>
|}

====Development====
{| class="wikitable"
!Setting
!Description
|-
|<code>EXPERIMENTAL</code>
|Install latest (experimental) versions of all software
|}

====Debug====
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_LOG_LEVEL</code>
|Define SatNOGS client log level, available values: <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code> and <code>DEBUG</code>
|}

===Obsolete Settings===
The following options were available in previous versions of SatNOGS and have no effect on the latest stable version.
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_RX_DEVICE</code>
|If you are using an RTL-SDR, this is <code>rtlsdr</code>. Other devices supported by gr-satnogs include <code>usrpb200</code>, <code>usrp2</code>, <code>airspy/airspymini</code>, <code>lime</code>, or <code>hackrf</code>.
|-
|<code>SATNOGS_IF_GAIN</code>
|gr-satnogs: Intermediate frequency gain [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/-/blob/v1.5.1/apps/flowgraphs/README.md#execution-arguements-interface]
|-
|<code>SATNOGS_BB_GAIN</code>
|gr-satnogs: Baseband gain [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/-/blob/v1.5.1/apps/flowgraphs/README.md#execution-arguements-interface]
|-
|<code>SATNOGS_RADIO_GR_SATNOGS_VERSION</code>
|This options allows you to change the version of gr-satnogs package to be installed. For example: <code>1.5.1-1</code>
|-
|<code>APT_REPOSITORY</code>
|This options allows you to change the SatNOGS packages repository. For example, to install unstable package builds use:
<code>deb <nowiki>http://download.opensuse.org/repositories/home:/librespace:/satnogs-unstable/Raspbian_10</nowiki> ./</code>
|-
|<code>APT_KEY_URL</code>
|This options allows you to change the SatNOGS packages repository key URL. For example, to install unstable package builds use:
<code><nowiki>http://download.opensuse.org/repositories/home:/librespace:/satnogs-unstable/Raspbian_10/Release.key</nowiki></code>
|-
|<code>APT_KEY_ID</code>
|This options allows you to specify an alternative SatNOGS packages repository key ID.
|-
|<code>SATNOGS_CLIENT_URL</code>
|If you to try a development version of satnogs-client, you can change the URL here. The URL needs to be in [https://pip.pypa.io/en/stable/reference/pip_install PIP format]. Here are some examples:

*<code>git+<nowiki>https://gitlab.com/librespacefoundation/satnogs/satnogs-client.git@master</nowiki></code> -- the 'master' branch (the current development version) of satnogs-client
*<code><nowiki>git+https://gitlab.com/jdoe/satnogs-client.git@new-feature</nowiki></code> -- the 'new-feature' branch of jdoe's fork of satnogs-client
|-
|<code>SATNOGS_RADIO_FLOWGRAPHS_VERSION</code>
|This options allows you to change the version of satnogs-flowgraphs package to be installed. For example:
<code>0.1-1</code>
|}
==Updating SatNOGS Software==
{{Warning| An update can potentially interrupt a running observation!}}The software is updated automatically when <code>satnogs-setup</code> is executed.{{Message|Client version on SatNOGS Network is updated after the first observation with the new client.}}
===Upgrading from legacy software===
{{Warning|IMPORTANT: Some essential features from the previous version are currently unavailable in the newer version. Please review the [[SatNOGS Setup#Missing_features|Missing Features Table]] before proceeding with the upgrade. If any of the missing features are critical to your setup, follow the [[Raspberry_Pi_Legacy|Legacy Software Installation Guide]] to install the legacy software.}}
====Missing features====
{| class="wikitable"
!Feature
!Description
!Related issue
|-
|Rotator support
|No access to serial devices.
|[https://gitlab.com/librespacefoundation/satnogs/satnogs-ansible/-/issues/146 satnogs-ansible#146]
|-
|Installation of experimental software
|This feature is currently unimplemented.
|[https://gitlab.com/librespacefoundation/satnogs/satnogs-ansible/-/issues/156 satnogs-ansible#156]
|-
| rowspan="2" |Post and pre-observation scripts
|No path is defined or mounted.
|[https://gitlab.com/librespacefoundation/satnogs/satnogs-ansible/-/issues/184 satnogs-ansible#184]
|-
|Double curly braces are broken.
|[https://gitlab.com/librespacefoundation/satnogs/satnogs-ansible/-/issues/176 satnogs-ansible#176]
|-
|Component versions in support report
|The versions of components in the support report is not available.
|[https://gitlab.com/librespacefoundation/satnogs/satnogs-config/-/issues/68 satnogs-config#68]
|-
|Cannot modify running software
|Containers are read-only.
|[https://gitlab.com/librespacefoundation/satnogs/satnogs-ansible/-/issues/157 satnogs-ansible#157]
|}
To update from the legacy SatNOGS software execute the normal installation command:
$ curl -sfL <nowiki>https://satno.gs/install</nowiki> | sh -s --
The command will clean-up the old software, install the new one and then bring up the SatNOGS configuraion menu-driver utility.

==Verification of correct installation==
To verify that the software is set up correctly, execute:<pre>
$ sudo docker ps -f 'name=^satnogs_' --format "table {{.Names}}\t{{.Status}}"
</pre>You should see an output that looks like this:<pre>
NAMES STATUS
satnogs_satnogs-client Up 31 seconds
satnogs_rigctld Up 31 seconds
</pre>If you see that, great -- you're ready to [[Operation|schedule your first observation]]! If not, check out the [[Troubleshooting]] page.
==Backup & Restore the configuration==
The configuration of your SatNOGS station is stored at <code>/var/lib/docker-bindmounts/ansible/etc/ansible/host_vars/ansible</code>. If your station software is broken (e.g. due to a corrupt SD card), you can perform the following steps:

#Backup the configuration file
#Re-flash the SD card with a fresh image
#Restore the configuration file
#Execute <code>$ curl -sfL <nowiki>https://satno.gs/install</nowiki> | sh -s --</code>

==See also==

*[[SatNOGS Ansible]]

[[Category:Build]]
[[Category:Software]]

Raspberry Pi

2025-01-11T13:56:24Z

Acinonyx: /* Flashing */

2025-01-11T12:45:34Z

Acinonyx: Acinonyx moved page SatNOGS Client Ansible to SatNOGS Ansible: Project rename

{{Outdated}}

==Introduction==

{{Warning|Follow these instructions only if you are provisioning SatNOGS to a host from another host or are installing on the same host. }}

'''SatNOGS Ansible''' makes the actual provisioning of SatNOGS software. It is called, under the hood, when applying the configuration using [[SatNOGS Setup|SatNOGS Setup utility]]. Supported distributions and releases can be found in the [https://gitlab.com/librespacefoundation/satnogs/satnogs-ansible#supported-distributions-and-releases README file of the project].

==Raspbian==

For Raspberry Pi, which is the reference platform for SatNOGS, a custom Raspbian image with '''SatNOGS Ansible''' pre-installed is available. Installation instructions are given in the [[Raspberry_Pi| Raspberry Pi Setup Guide]].

==Debian==

These sections contain generic instructions for installing SatNOGS Client on a Debian system.

==Other distributions==

Other distributions are not supported by '''SatNOGS Ansible''', as the pre-built packages won't be compatible. Thus, while derived from Debian, '''SatNOGS Ansible''' is known to break for Ubuntu and Linux Mint. If you are an experienced user, a manual installation of all components could be possible.

==Installation Guide==
===Prerequisites===

*A target Debian system. To install Debian please follow the [https://www.debian.org/releases/stretch/installmanual Debian Installation Guide] and chose the net installer if you want to run a headless server. The target system can be the host itself.
*A user (referenced later as ''youruser'') which is member of 'sudo' group exists on the target system. Don't use the username `satnogs` when you install the Debian system.
*An SSH server running on the target system.
*Install installation dependencies: `sudo apt-get install ansible git sshpass python-setuptools`

===Installation===

On the host system run the following commands:
$ git clone <nowiki>https://gitlab.com/librespacefoundation/satnogs/satnogs-client-ansible.git</nowiki> # Clone SatNOGS Client Ansible repository
$ cd satnogs-client-ansible # Change to cloned repository directory
$ git checkout stable # Optionally, check out stable (Debian Buster 10) branch
$ cp -r production.dist production # Copy dist configuration
$ vi production/inventory/hosts # Update file with your own target host e.g. 127.0.0.1, user and SSH password
$ ssh youruser@yourtargetsystem true # Test SSH connection to target system
$ ansible-playbook -i production/inventory/hosts -K site.yml # Run Ansible playbook
$ ssh -t youruser@yourtargetsystem sudo satnogs-setup # Setup SatNOGS client (see below)

 

===Next Steps===

Follow [[SatNOGS_Client_Setup|SatNOGS Client Setup]] to configure your system and SatNOGS station.

[[Category:Build]]
[[Category:Software]]

SatNOGS Ansible

2025-01-11T12:45:08Z

Acinonyx: Marked as outdated.

SatNOGS Setup

2025-01-11T12:38:34Z

Acinonyx: Fix headings

SatNOGS Setup

2025-01-11T12:37:18Z

Acinonyx: Promote heading

==Introduction==
<code>satnogs-setup</code> provides a set of scripts for provisioning and configuring '''SatNOGS'''. <code>satnogs-setup</code> main function is to bring up a menu-driven console configuration utility and provision the system using [[SatNOGS Client Ansible|Ansible]]. Instruction on this page assumes that you have successfully established console access on the host machine intended to run SatNOGS.

==Initial Setup==
The <code>satnogs-setup</code> configuration tool is automatically executed during [[Raspberry Pi#Installation|the installation process]]. However, if needed, you can reconfigure the software at any time by running it again:
$ satnogs-setup

==Configuration==
[[File:Satnogs-setup.png|thumb]]
{{Warning| Configuring SatNOGS can potentially interrupt a running observation!}}The configuration is divided into <code>Basic</code> and <code>Advanced</code> submenus. The '''Basic Configuration''' includes the essential settings required to get the station up and running, while further optimization or customization can be done through the '''Advanced Configuration'''. The <code>Show</code> menu item displays the current configuration in a single view, and the <code>Reset</code> option deletes all existing configurations. Lastly, the <code>About</code> menu item provides information about the tool itself.
Once the configuration is completed, exiting the utility will apply the changes. Please note that this process may take several minutes, depending on the modifications made.{{Message|You can always reconfigure the software by running <code>sudo satnogs-setup</code> again.}}
===Basic Configuration===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_API_TOKEN</code>
|The API token assigned to your ground station on the SatNOGS Network website. Please don’t share your API key as this can give access to anyone to upload and change things in network related to your station and its observations.

To find your API token, log into [https://network.satnogs.org/ network.satnogs.org], click on the user icon at the top right corner and then click on the "Dashboard" option. On the top of the dashboard page, right under the user icon, click the button "API key" to show your API token.
|-
|<code>SATNOGS_SOAPY_RX_DEVICE</code>
|If you are using an RTL-SDR, this is <code>driver=rtlsdr</code>. For other devices tested configurations can be found at [[Software_Defined_Radio]].

See [https://github.com/pothosware/SoapyRTLSDR/wiki#modules pothosware/SoapyRTLSDR/wiki#modules] for other SDR modules (linked in the navigation bar at the right side of the page). If multiple devices are attached to your station you should also specify the serial of the desired device here, e.g. <code>driver=uhd,serial=3164495</code>.
|-
|<code>SATNOGS_ANTENNA</code>
|If you are using an RTL-SDR, this is <code>RX</code>. For other devices tested configurations can be found at [[Software_Defined_Radio]].

If your device is not listed there yet, use <code><nowiki>SoapySDRUtil --probe 2>&1| grep Antennas</nowiki></code> to get available antennas.
|-
|<code>SATNOGS_RX_SAMP_RATE</code>
|Specify the receiver sampling rate. Recommended value for RTL-SDR: <code>2.048e6</code> (for 2Msps), other devices will need different sample rates described at [[Software_Defined_Radio]] .

The command <code><nowiki>SoapySDRUtil --probe 2>&1 | grep Sample</nowiki></code> can be used to find all valid sample rates.
|-
|<code>SATNOGS_STATION_ELEV</code>
|The height of your ground station above sea level in metres.
|-
|<code>SATNOGS_STATION_ID</code>
|The '''numeric ID''' assigned to your station in the SatNOGS Network site when the groundstation was created.
|-
|<code>SATNOGS_STATION_LAT</code>
|The latitude of your station. North is positive, south is negative.
|-
|<code>SATNOGS_STATION_LON</code>
|The longitude of your station. East is positive, west is negative.
|}
==Advanced Setup==
{{Warning|Changes to the following settings may be required to optimise station performance, or enable support for additional features (e.g. rotator control)}}A more detailed description on setting up a development environment using the SatNOGS reference setup is given in [[SatNOGS_Client_Development]].

===Radio===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_PPM_ERROR</code>
|The local oscillator frequency deviation in ppm (value will be rounded to integer).
Available with the following modules:

*SoapyRTLSDR
*SoapySDRPlay

Not available with the following modules:

*SoapyUHD
*SoapyPluto
|-
|<code>SATNOGS_LO_OFFSET</code>
|Don't use this parameter to correct for the local oscillator frequency deviation, use <code>SATNOGS_PPM_ERROR</code> instead!
To avoid the SDR carrier at the DC the LO is shifted from the actual frequency a little. Default: <code>100e3</code> (100 kHz)
|-
|<code>SATNOGS_GAIN_MODE</code>
|Choose the gain mode:

*<code>"Overall"</code> (default): Set the gain with the single value from <code>SATNOGS_RF_GAIN</code>
*<code>"Settings Field"</code>: Ignore <code>SATNOGS_RF_GAIN</code>, use the settings from <code>SATNOGS_OTHER_SETTINGS</code> instead
|-
|<code>SATNOGS_RF_GAIN</code>
|RF Gain value for your SDR hardware.

Run <code>SoapySDRUtil --probe</code> to see all possible gain values for your hardware. Example: For RTL-SDR without pre-amp, 32.8 is a good starting value. Follow [[Omnidirectional Station How To#Setting the gain|Setting the gain]] to find a good gain value.
|-
|<code>SATNOGS_RX_BANDWIDTH</code>
|Soapy baseband filter bandwidth [https://github.com/pothosware/SoapySDR/blob/a489f3dca9d3ccd9b276b95a608ac3ef0299f635/include/SoapySDR/Device.hpp#L904-L910] of RX Channel 0 in Hz (only available on specific devices). TODO: Testing.
|-
|<code>SATNOGS_DEV_ARGS</code>
|Soapy device arguments (currently only accepting the <code>serial</code> key successfully) and stream arguments.
NOTE: This parameter / its meaning might change in the near future, see issue [https://gitlab.com/librespacefoundation/satnogs/satnogs-client/-/issues/373 satnogs-client#373].
|-
|<code>SATNOGS_STREAM_ARGS</code>
|
|-
|<code>SATNOGS_TUNE_ARGS</code>
|
|-
|<code>SATNOGS_OTHER_SETTINGS</code>
|Only available if <code>SATNOGS_GAIN_MODE</code>is<code>"Settings Field"</code>.
Available gain settings can be retrieved using <code>SoapySDRUtil --probe="driver=xxxx`</code>

Example for Airspy: Use<code>"LNA=12,MIX=8,VGA=11"</code>See also: [[SDR#Airspy|Airspy support]]
|-
|<code>SATNOGS_DC_REMOVAL</code>
|
|-
|<code>SATNOGS_BB_FREQ</code>
|
|}

===Rotator===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_ROT_MODEL</code>
|Hamlib rotator model. If you don't have a rotator (like the [[No rotator|No rotator setup]]), leave it empty.
Use the macro name for your rotator model from this [https://gist.github.com/kerel-fs/2354ff9c082cd3c1594afc38c67bc32a#hamlib-release-33 list of rotator models in Hamlib]. If you are connecting to a separate rotctld instance, use <code>ROT_MODEL_NETROTCTL</code>
|-
|<code>SATNOGS_ROT_BAUD</code>
|Baud rate for Hamlib rotator serial port, if using a serial-connected rotator.
|-
|<code>SATNOGS_ROT_PORT</code>
|Serial port for Hamlib rotator, OR the network address of a rotctld instance (e.g. <code>localhost:4533</code> )
|-
|<code>SATNOGS_ROT_THRESHOLD</code>
|Rotator movement threshold, in degrees. If set, the rotator will only be commanded when the target has moved more than <threshold> degrees away from the current azimuth/elevation position. Default: 4 degrees
|}

===Artifacts===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_ARTIFACTS_ENABLED</code>
|Enable generation and uploading of HDF5 artifacts files to SatNOGS DB. (added in satnogs-client 1.7)
|-
|<code>SATNOGS_ARTIFACTS_API_TOKEN</code>
|SatNOGS DB API token associated with an account in SatNOGS DB. This token is secret. It is used to upload artifacts to SatNOGS DB. It can be found in SatNOGS DB user page. (added in satnogs-client 1.7)
|}

===Scripts===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_PRE_OBSERVATION_SCRIPT</code>
| rowspan="2" |Allows execution of a shell script either pre or post-observation. The following can be entered into the script path to enable passing of information to the script:
<code><nowiki>{{FREQ}}</nowiki></code> - Observation Centre Frequency

<code><nowiki>{{TLE}}</nowiki></code> - Target object TLE data, as a JSON-formatted object.

<code><nowiki>{{TIMESTAMP}}</nowiki></code> - Start time of the observation, in the format: %Y-%m-%dT%H-%M-%S%z

<code><nowiki>{{ID}}</nowiki></code> - Observation ID number.

<code><nowiki>{{BAUD}}</nowiki></code> - Baud rate of the modulation used, if applicable.

<code><nowiki>{{SCRIPT_NAME}}</nowiki></code> - The name of the demodulation flow-graph script in use.
|-
|<code>SATNOGS_POST_OBSERVATION_SCRIPT</code>
|}

===Hamlib===
{| class="wikitable"
!Setting
!Description
|-
|<code>HAMLIB_UTILS_ROT_ENABLED</code>
|Whether or not to enable the Hamlibs rotator daemon. Rotctld is a software daemon that provides a network server to control a rotator on a serial port.
|-
|<code>HAMLIB_UTILS_ROT_OPTS</code>
|Options for rotcld:
For a yaesu rotator, use <code>-m 601 -r /dev/ttyACM0 -s 9600 -T 0.0.0.0</code>

For a SatNOGS rotator <code>-m 204 -s 19200 -r /dev/ttyACM0 -C timeout=200</code> or <code>-m 204 -s 19200 -r /dev/ttyUSB0 -C timeout=200</code>
|}

===Development===
{| class="wikitable"
!Setting
!Description
|-
|<code>EXPERIMENTAL</code>
|Install latest (experimental) versions of all software
|}

===Debug===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_LOG_LEVEL</code>
|Define SatNOGS client log level, available values: <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code> and <code>DEBUG</code>
|}

==Obsolete Settings==
The following options were available in previous versions of SatNOGS and have no effect on the latest stable version.
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_RX_DEVICE</code>
|If you are using an RTL-SDR, this is <code>rtlsdr</code>. Other devices supported by gr-satnogs include <code>usrpb200</code>, <code>usrp2</code>, <code>airspy/airspymini</code>, <code>lime</code>, or <code>hackrf</code>.
|-
|<code>SATNOGS_IF_GAIN</code>
|gr-satnogs: Intermediate frequency gain [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/-/blob/v1.5.1/apps/flowgraphs/README.md#execution-arguements-interface]
|-
|<code>SATNOGS_BB_GAIN</code>
|gr-satnogs: Baseband gain [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/-/blob/v1.5.1/apps/flowgraphs/README.md#execution-arguements-interface]
|-
|<code>SATNOGS_RADIO_GR_SATNOGS_VERSION</code>
|This options allows you to change the version of gr-satnogs package to be installed. For example: <code>1.5.1-1</code>
|-
|<code>APT_REPOSITORY</code>
|This options allows you to change the SatNOGS packages repository. For example, to install unstable package builds use:
<code>deb <nowiki>http://download.opensuse.org/repositories/home:/librespace:/satnogs-unstable/Raspbian_10</nowiki> ./</code>
|-
|<code>APT_KEY_URL</code>
|This options allows you to change the SatNOGS packages repository key URL. For example, to install unstable package builds use:
<code><nowiki>http://download.opensuse.org/repositories/home:/librespace:/satnogs-unstable/Raspbian_10/Release.key</nowiki></code>
|-
|<code>APT_KEY_ID</code>
|This options allows you to specify an alternative SatNOGS packages repository key ID.
|-
|<code>SATNOGS_CLIENT_URL</code>
|If you to try a development version of satnogs-client, you can change the URL here. The URL needs to be in [https://pip.pypa.io/en/stable/reference/pip_install PIP format]. Here are some examples:

*<code>git+<nowiki>https://gitlab.com/librespacefoundation/satnogs/satnogs-client.git@master</nowiki></code> -- the 'master' branch (the current development version) of satnogs-client
*<code><nowiki>git+https://gitlab.com/jdoe/satnogs-client.git@new-feature</nowiki></code> -- the 'new-feature' branch of jdoe's fork of satnogs-client
|-
|<code>SATNOGS_RADIO_FLOWGRAPHS_VERSION</code>
|This options allows you to change the version of satnogs-flowgraphs package to be installed. For example:
<code>0.1-1</code>
|}
==Updating SatNOGS Software==
{{Warning| An update can potentially interrupt a running observation!}}The software is updated automatically when <code>satnogs-setup</code> is executed.{{Message|Client version on SatNOGS Network is updated after the first observation with the new client.}}
===Upgrading from legacy software===
To update from the legacy SatNOGS software execute the normal installation command:
$ curl -sfL <nowiki>https://satno.gs/install</nowiki> | sh -s --
The command will clean-up the old software, install the new one and then bring up the SatNOGS configuraion menu-driver utility.

==Verification of correct installation==
To verify that the software is set up correctly, execute:<pre>
$ sudo docker ps -f 'name=^satnogs_' --format "table {{.Names}}\t{{.Status}}"
</pre>You should see an output that looks like this:<pre>
NAMES STATUS
satnogs_satnogs-client Up 31 seconds
satnogs_rigctld Up 31 seconds
</pre>If you see that, great -- you're ready to [[Operation|schedule your first observation]]! If not, check out the [[Troubleshooting]] page.
==Backup & Restore the configuration==
The configuration of your SatNOGS station is stored at <code>/var/lib/docker-bindmounts/ansible/etc/ansible/host_vars/ansible</code>. If your station software is broken (e.g. due to a corrupt SD card), you can perform the following steps:

#Backup the configuration file
#Re-flash the SD card with a fresh image
#Restore the configuration file
#Execute <code>$ curl -sfL <nowiki>https://satno.gs/install</nowiki> | sh -s --</code>

==See also==

*[[SatNOGS Client Ansible]]

SatNOGS Setup

2025-01-11T12:36:39Z

Acinonyx: Update available variables

==Introduction==
<code>satnogs-setup</code> provides a set of scripts for provisioning and configuring '''SatNOGS'''. <code>satnogs-setup</code> main function is to bring up a menu-driven console configuration utility and provision the system using [[SatNOGS Client Ansible|Ansible]]. Instruction on this page assumes that you have successfully established console access on the host machine intended to run SatNOGS.

==Initial Setup==
The <code>satnogs-setup</code> configuration tool is automatically executed during [[Raspberry Pi#Installation|the installation process]]. However, if needed, you can reconfigure the software at any time by running it again:
$ satnogs-setup

==Configuration==
[[File:Satnogs-setup.png|thumb]]
{{Warning| Configuring SatNOGS can potentially interrupt a running observation!}}The configuration is divided into <code>Basic</code> and <code>Advanced</code> submenus. The '''Basic Configuration''' includes the essential settings required to get the station up and running, while further optimization or customization can be done through the '''Advanced Configuration'''. The <code>Show</code> menu item displays the current configuration in a single view, and the <code>Reset</code> option deletes all existing configurations. Lastly, the <code>About</code> menu item provides information about the tool itself.
Once the configuration is completed, exiting the utility will apply the changes. Please note that this process may take several minutes, depending on the modifications made.{{Message|You can always reconfigure the software by running <code>sudo satnogs-setup</code> again.}}
===Basic Configuration===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_API_TOKEN</code>
|The API token assigned to your ground station on the SatNOGS Network website. Please don’t share your API key as this can give access to anyone to upload and change things in network related to your station and its observations.

To find your API token, log into [https://network.satnogs.org/ network.satnogs.org], click on the user icon at the top right corner and then click on the "Dashboard" option. On the top of the dashboard page, right under the user icon, click the button "API key" to show your API token.
|-
|<code>SATNOGS_SOAPY_RX_DEVICE</code>
|If you are using an RTL-SDR, this is <code>driver=rtlsdr</code>. For other devices tested configurations can be found at [[Software_Defined_Radio]].

See [https://github.com/pothosware/SoapyRTLSDR/wiki#modules pothosware/SoapyRTLSDR/wiki#modules] for other SDR modules (linked in the navigation bar at the right side of the page). If multiple devices are attached to your station you should also specify the serial of the desired device here, e.g. <code>driver=uhd,serial=3164495</code>.
|-
|<code>SATNOGS_ANTENNA</code>
|If you are using an RTL-SDR, this is <code>RX</code>. For other devices tested configurations can be found at [[Software_Defined_Radio]].

If your device is not listed there yet, use <code><nowiki>SoapySDRUtil --probe 2>&1| grep Antennas</nowiki></code> to get available antennas.
|-
|<code>SATNOGS_RX_SAMP_RATE</code>
|Specify the receiver sampling rate. Recommended value for RTL-SDR: <code>2.048e6</code> (for 2Msps), other devices will need different sample rates described at [[Software_Defined_Radio]] .

The command <code><nowiki>SoapySDRUtil --probe 2>&1 | grep Sample</nowiki></code> can be used to find all valid sample rates.
|-
|<code>SATNOGS_STATION_ELEV</code>
|The height of your ground station above sea level in metres.
|-
|<code>SATNOGS_STATION_ID</code>
|The '''numeric ID''' assigned to your station in the SatNOGS Network site when the groundstation was created.
|-
|<code>SATNOGS_STATION_LAT</code>
|The latitude of your station. North is positive, south is negative.
|-
|<code>SATNOGS_STATION_LON</code>
|The longitude of your station. East is positive, west is negative.
|}
==Advanced Setup==
{{Warning|Changes to the following settings may be required to optimise station performance, or enable support for additional features (e.g. rotator control)}}A more detailed description on setting up a development environment using the SatNOGS reference setup is given in [[SatNOGS_Client_Development]].

=== Radio ===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_PPM_ERROR</code>
|The local oscillator frequency deviation in ppm (value will be rounded to integer).
Available with the following modules:

*SoapyRTLSDR
*SoapySDRPlay

Not available with the following modules:

*SoapyUHD
*SoapyPluto
|-
|<code>SATNOGS_LO_OFFSET</code>
|Don't use this parameter to correct for the local oscillator frequency deviation, use <code>SATNOGS_PPM_ERROR</code> instead!
To avoid the SDR carrier at the DC the LO is shifted from the actual frequency a little. Default: <code>100e3</code> (100 kHz)
|-
|<code>SATNOGS_GAIN_MODE</code>
|Choose the gain mode:

*<code>"Overall"</code> (default): Set the gain with the single value from <code>SATNOGS_RF_GAIN</code>
*<code>"Settings Field"</code>: Ignore <code>SATNOGS_RF_GAIN</code>, use the settings from <code>SATNOGS_OTHER_SETTINGS</code> instead
|-
|<code>SATNOGS_RF_GAIN</code>
|RF Gain value for your SDR hardware.

Run <code>SoapySDRUtil --probe</code> to see all possible gain values for your hardware. Example: For RTL-SDR without pre-amp, 32.8 is a good starting value. Follow [[Omnidirectional Station How To#Setting the gain|Setting the gain]] to find a good gain value.
|-
|<code>SATNOGS_RX_BANDWIDTH</code>
|Soapy baseband filter bandwidth [https://github.com/pothosware/SoapySDR/blob/a489f3dca9d3ccd9b276b95a608ac3ef0299f635/include/SoapySDR/Device.hpp#L904-L910] of RX Channel 0 in Hz (only available on specific devices). TODO: Testing.
|-
|<code>SATNOGS_DEV_ARGS</code>
|Soapy device arguments (currently only accepting the <code>serial</code> key successfully) and stream arguments.
NOTE: This parameter / its meaning might change in the near future, see issue [https://gitlab.com/librespacefoundation/satnogs/satnogs-client/-/issues/373 satnogs-client#373].
|-
|<code>SATNOGS_STREAM_ARGS</code>
|
|-
|<code>SATNOGS_TUNE_ARGS</code>
|
|-
|<code>SATNOGS_OTHER_SETTINGS</code>
|Only available if <code>SATNOGS_GAIN_MODE</code>is<code>"Settings Field"</code>.
Available gain settings can be retrieved using <code>SoapySDRUtil --probe="driver=xxxx`</code>

Example for Airspy: Use<code>"LNA=12,MIX=8,VGA=11"</code>See also: [[SDR#Airspy|Airspy support]]
|-
|<code>SATNOGS_DC_REMOVAL</code>
|
|-
|<code>SATNOGS_BB_FREQ</code>
|
|}

=== Rotator ===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_ROT_MODEL</code>
|Hamlib rotator model. If you don't have a rotator (like the [[No rotator|No rotator setup]]), leave it empty.
Use the macro name for your rotator model from this [https://gist.github.com/kerel-fs/2354ff9c082cd3c1594afc38c67bc32a#hamlib-release-33 list of rotator models in Hamlib]. If you are connecting to a separate rotctld instance, use <code>ROT_MODEL_NETROTCTL</code>
|-
|<code>SATNOGS_ROT_BAUD</code>
|Baud rate for Hamlib rotator serial port, if using a serial-connected rotator.
|-
|<code>SATNOGS_ROT_PORT</code>
|Serial port for Hamlib rotator, OR the network address of a rotctld instance (e.g. <code>localhost:4533</code> )
|-
|<code>SATNOGS_ROT_THRESHOLD</code>
|Rotator movement threshold, in degrees. If set, the rotator will only be commanded when the target has moved more than <threshold> degrees away from the current azimuth/elevation position. Default: 4 degrees
|}

=== Artifacts ===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_ARTIFACTS_ENABLED</code>
|Enable generation and uploading of HDF5 artifacts files to SatNOGS DB. (added in satnogs-client 1.7)
|-
|<code>SATNOGS_ARTIFACTS_API_TOKEN</code>
|SatNOGS DB API token associated with an account in SatNOGS DB. This token is secret. It is used to upload artifacts to SatNOGS DB. It can be found in SatNOGS DB user page. (added in satnogs-client 1.7)
|}

=== Scripts ===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_PRE_OBSERVATION_SCRIPT</code>
| rowspan="2" |Allows execution of a shell script either pre or post-observation. The following can be entered into the script path to enable passing of information to the script:
<code><nowiki>{{FREQ}}</nowiki></code> - Observation Centre Frequency

<code><nowiki>{{TLE}}</nowiki></code> - Target object TLE data, as a JSON-formatted object.

<code><nowiki>{{TIMESTAMP}}</nowiki></code> - Start time of the observation, in the format: %Y-%m-%dT%H-%M-%S%z

<code><nowiki>{{ID}}</nowiki></code> - Observation ID number.

<code><nowiki>{{BAUD}}</nowiki></code> - Baud rate of the modulation used, if applicable.

<code><nowiki>{{SCRIPT_NAME}}</nowiki></code> - The name of the demodulation flow-graph script in use.
|-
|<code>SATNOGS_POST_OBSERVATION_SCRIPT</code>
|}

=== Hamlib ===
{| class="wikitable"
!Setting
!Description
|-
|<code>HAMLIB_UTILS_ROT_ENABLED</code>
|Whether or not to enable the Hamlibs rotator daemon. Rotctld is a software daemon that provides a network server to control a rotator on a serial port.
|-
|<code>HAMLIB_UTILS_ROT_OPTS</code>
|Options for rotcld:
For a yaesu rotator, use <code>-m 601 -r /dev/ttyACM0 -s 9600 -T 0.0.0.0</code>

For a SatNOGS rotator <code>-m 204 -s 19200 -r /dev/ttyACM0 -C timeout=200</code> or <code>-m 204 -s 19200 -r /dev/ttyUSB0 -C timeout=200</code>
|}

=== Development ===
{| class="wikitable"
!Setting
!Description
|-
|<code>EXPERIMENTAL</code>
|Install latest (experimental) versions of all software
|}

=== Debug ===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_LOG_LEVEL</code>
|Define SatNOGS client log level, available values: <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code> and <code>DEBUG</code>
|}

=== Obsolete Variables ===
The following options were available in previous versions of SatNOGS and have no effect on the latest stable version.
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_RX_DEVICE</code>
|If you are using an RTL-SDR, this is <code>rtlsdr</code>. Other devices supported by gr-satnogs include <code>usrpb200</code>, <code>usrp2</code>, <code>airspy/airspymini</code>, <code>lime</code>, or <code>hackrf</code>.
|-
|<code>SATNOGS_IF_GAIN</code>
|gr-satnogs: Intermediate frequency gain [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/-/blob/v1.5.1/apps/flowgraphs/README.md#execution-arguements-interface]
|-
|<code>SATNOGS_BB_GAIN</code>
|gr-satnogs: Baseband gain [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/-/blob/v1.5.1/apps/flowgraphs/README.md#execution-arguements-interface]
|-
|<code>SATNOGS_RADIO_GR_SATNOGS_VERSION</code>
|This options allows you to change the version of gr-satnogs package to be installed. For example: <code>1.5.1-1</code>
|-
|<code>APT_REPOSITORY</code>
|This options allows you to change the SatNOGS packages repository. For example, to install unstable package builds use:
<code>deb <nowiki>http://download.opensuse.org/repositories/home:/librespace:/satnogs-unstable/Raspbian_10</nowiki> ./</code>
|-
|<code>APT_KEY_URL</code>
|This options allows you to change the SatNOGS packages repository key URL. For example, to install unstable package builds use:
<code><nowiki>http://download.opensuse.org/repositories/home:/librespace:/satnogs-unstable/Raspbian_10/Release.key</nowiki></code>
|-
|<code>APT_KEY_ID</code>
|This options allows you to specify an alternative SatNOGS packages repository key ID.
|-
|<code>SATNOGS_CLIENT_URL</code>
|If you to try a development version of satnogs-client, you can change the URL here. The URL needs to be in [https://pip.pypa.io/en/stable/reference/pip_install PIP format]. Here are some examples:

*<code>git+<nowiki>https://gitlab.com/librespacefoundation/satnogs/satnogs-client.git@master</nowiki></code> -- the 'master' branch (the current development version) of satnogs-client
*<code><nowiki>git+https://gitlab.com/jdoe/satnogs-client.git@new-feature</nowiki></code> -- the 'new-feature' branch of jdoe's fork of satnogs-client
|-
|<code>SATNOGS_RADIO_FLOWGRAPHS_VERSION</code>
|This options allows you to change the version of satnogs-flowgraphs package to be installed. For example:
<code>0.1-1</code>
|}
==Updating SatNOGS Software==
{{Warning| An update can potentially interrupt a running observation!}}The software is updated automatically when <code>satnogs-setup</code> is executed.{{Message|Client version on SatNOGS Network is updated after the first observation with the new client.}}
===Upgrading from legacy software===
To update from the legacy SatNOGS software execute the normal installation command:
$ curl -sfL <nowiki>https://satno.gs/install</nowiki> | sh -s --
The command will clean-up the old software, install the new one and then bring up the SatNOGS configuraion menu-driver utility.

==Verification of correct installation==
To verify that the software is set up correctly, execute:<pre>
$ sudo docker ps -f 'name=^satnogs_' --format "table {{.Names}}\t{{.Status}}"
</pre>You should see an output that looks like this:<pre>
NAMES STATUS
satnogs_satnogs-client Up 31 seconds
satnogs_rigctld Up 31 seconds
</pre>If you see that, great -- you're ready to [[Operation|schedule your first observation]]! If not, check out the [[Troubleshooting]] page.
==Backup & Restore the configuration==
The configuration of your SatNOGS station is stored at <code>/var/lib/docker-bindmounts/ansible/etc/ansible/host_vars/ansible</code>. If your station software is broken (e.g. due to a corrupt SD card), you can perform the following steps:

#Backup the configuration file
#Re-flash the SD card with a fresh image
#Restore the configuration file
#Execute <code>$ curl -sfL <nowiki>https://satno.gs/install</nowiki> | sh -s --</code>

==See also==

*[[SatNOGS Client Ansible]]

SatNOGS Client Development

2025-01-11T12:09:13Z

Acinonyx:

{{Outdated}}

==Intro==
This page describes the setup of a development environment for the
SatNOGS ground station reference setup based on [https://gitlab.com/librespacefoundation/satnogs/satnogs-client-ansible satnogs-client-ansible].
It is assumed you have already setup your ground station as explained in [[SatNOGS_Client_Setup]].

==satnogs-flowgraphs==
For each Satellite Transmitter Mode there is a specific flowgraph in this package. There are generic (e.g. CW) and satellite-specific flowgraphs. The Satellite-Transmitter-Mode-to-flowgraph mapping is defined in satnogs-client. This package is using gr-soapy for SDR hardware support and gr-satnogs for required GNURadio blocks.
 
==gr-satnogs==

The gnuradio Out-Of-Tree module [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs gr-satnogs] provides blocks required by satnogs-flowgraphs. The gitlab-CI automatically builds the package in docker containers, configured by the [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/blob/master/.gitlab-ci.yml .gitlab-ci.yml]. The built packages for releases are pushed to the librespace:satnogs package repository, the built package for the latest development version on master is pushed to the librespace:satnogs-unstable package repository.

To use a modified gr-satnogs module on a SatNOGS ground station, it’s recommended to clone your fork on your station, build the patched gr-satnogs packages and install it.

To install the latest development version of gr-satnogs on your station, set <code>experimental=True</code> or configure in <code>satnogs-setup</code>.

 

===Setting up a gr-satnogs development environment===

OUTDATED since [https://gitlab.com/librespacefoundation/satnogs/satnogs-client-ansible/-/commit/336a3206fbeec8e1a5257ce375578f31a92988e4 satnogs-client-ansible@336a320]!

*Fork gr-satnogs
*Fork gr-satnogs-package
*Adjust the repository url of gr-satnogs in [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs-package/blob/master/debian/debian/rules#L22 gr-satnogs-package/debian/debian/rules#L22]
*Adjust the repository url in the version detection in [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs-package/blob/master/.gitlab-ci.yml#L13 gr-satnogs-package/.gitlab-ci.yml#L13] ,[https://gitlab.com/librespacefoundation/satnogs/gr-satnogs-package/blob/master/.gitlab-ci.yml#L30 #L30] ,[https://gitlab.com/librespacefoundation/satnogs/gr-satnogs-package/blob/master/.gitlab-ci.yml#L47 #L47]
*Wait for the gitlab-CI to build your first version of gr-satnogs-package (~45 min)
*Install your freshly built gr-satnogs-package by pointing the <code>SATNOGS_RADIO_GR_SATNOGS_PACKAGE</code> in satnogs-setup to the built artifact/debian package of your architecture (e.g. <code>armhf</code>, <code>amd64</code>). The build artifacts are available in your gr-satnogs-package fork by clicking CI/CD, selecting there the latest pipeline, the latest build-job and then in the right column <code>Browse</code>, path <code>build/debian/output/$your_arch/gr-satnogs_$your_arch.deb</code>

==satnogs-client==
The [https://gitlab.com/librespacefoundation/satnogs/satnogs-client satnogs-client] is a python package, and gets installed by satnogs-setup in a python virtual environment using [https://pip.pypa.io/ pip]. The development is done in the <code>master</code> branch.

Please note that satnogs-client and satnogs-flowgraphs must be installed in compatible versions, due to (frequent) changes in the arguments available in the demodulation scripts, see [[Compatibility]].
===Setting up a satnogs-client development environment===

#Fork [https://gitlab.com/librespacefoundation/satnogs/satnogs-client satnogs-client]
#Clone the repository on your development machine
#Create a new branch (e.g. station123) with your changes & push it
#Run satnogs-setup and change the value of <code>SATNOGS_CLIENT_URL</code> to point to your repository and branch as described in [[SatNOGS_Client_Setup#Advanced_Setup]]
#Hit "Apply" in satnogs-setup to finally install your satnogs-client version
#Profit.

===Miscellaneous development notes===

*[[How to bodge an immediate observation in for testing purposes]]

[[Category:Develop]]
[[Category:Software]]

SatNOGS Setup

2025-01-10T15:57:19Z

Acinonyx: Created page with "== Introduction == <code>satnogs-setup</code> provides a set of scripts for provisioning and configuring '''SatNOGS'''. <code>satnogs-setup</code> main function is to bring up..."

== Introduction ==
<code>satnogs-setup</code> provides a set of scripts for provisioning and configuring '''SatNOGS'''. <code>satnogs-setup</code> main function is to bring up a menu-driven console configuration utility and provision the system using [[SatNOGS Client Ansible|Ansible]]. Instruction on this page assumes that you have successfully established console access on the host machine intended to run SatNOGS.

==Initial Setup==
The <code>satnogs-setup</code> configuration tool is automatically executed during [[Raspberry Pi#Installation|the installation process]]. However, if needed, you can reconfigure the software at any time by running it again:
$ satnogs-setup

== Configuration ==
[[File:Satnogs-setup.png|thumb]]
{{Warning| Configuring SatNOGS can potentially interrupt a running observation!}}The configuration is divided into <code>Basic</code> and <code>Advanced</code> submenus. The '''Basic Configuration''' includes the essential settings required to get the station up and running, while further optimization or customization can be done through the '''Advanced Configuration'''. The <code>Show</code> menu item displays the current configuration in a single view, and the <code>Reset</code> option deletes all existing configurations. Lastly, the <code>About</code> menu item provides information about the tool itself.

Once the configuration is completed, exiting the utility will apply the changes. Please note that this process may take several minutes, depending on the modifications made.{{Message|You can always reconfigure the software by running <code>sudo satnogs-setup</code> again.}}
===Basic Configuration===
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_API_TOKEN</code>
|The API token assigned to your ground station on the SatNOGS Network website. Please don’t share your API key as this can give access to anyone to upload and change things in network related to your station and its observations.

To find your API token, log into [https://network.satnogs.org/ network.satnogs.org], click on the user icon at the top right corner and then click on the "Dashboard" option. On the top of the dashboard page, right under the user icon, click the button "API key" to show your API token.
|-
|<code>SATNOGS_SOAPY_RX_DEVICE</code>
|If you are using an RTL-SDR, this is <code>driver=rtlsdr</code>. For other devices tested configurations can be found at [[Software_Defined_Radio]].

See [https://github.com/pothosware/SoapyRTLSDR/wiki#modules pothosware/SoapyRTLSDR/wiki#modules] for other SDR modules (linked in the navigation bar at the right side of the page). If multiple devices are attached to your station you should also specify the serial of the desired device here, e.g. <code>driver=uhd,serial=3164495</code>.
|-
|<code>SATNOGS_ANTENNA</code>
|If you are using an RTL-SDR, this is <code>RX</code>. For other devices tested configurations can be found at [[Software_Defined_Radio]].

If your device is not listed there yet, use <code><nowiki>SoapySDRUtil --probe 2>&1| grep Antennas</nowiki></code> to get available antennas.
|-
|<code>SATNOGS_RX_SAMP_RATE</code>
|Specify the receiver sampling rate. Recommended value for RTL-SDR: <code>2.048e6</code> (for 2Msps), other devices will need different sample rates described at [[Software_Defined_Radio]] .

The command <code><nowiki>SoapySDRUtil --probe 2>&1 | grep Sample</nowiki></code> can be used to find all valid sample rates.
|-
|<code>SATNOGS_RF_GAIN</code>
|RF Gain value for your SDR hardware.

Run <code>SoapySDRUtil --probe</code> to see all possible gain values for your hardware. Example: For RTL-SDR without pre-amp, 32.8 is a good starting value. Follow [[Omnidirectional Station How To#Setting the gain|Setting the gain]] to find a good gain value.
|-
|<code>SATNOGS_STATION_ELEV</code>
|The height of your ground station above sea level in metres.
|-
|<code>SATNOGS_STATION_ID</code>
|The '''numeric ID''' assigned to your station in the SatNOGS Network site when the groundstation was created.
|-
|<code>SATNOGS_STATION_LAT</code>
|The latitude of your station. North is positive, south is negative.
|-
|<code>SATNOGS_STATION_LON</code>
|The longitude of your station. East is positive, west is negative.
|}
==Advanced Setup==
{{Warning|Changes to the following settings may be required to optimise station performance, or enable support for additional features (e.g. rotator control)}}A more detailed description on setting up a development environment using the SatNOGS reference setup is given in [[SatNOGS_Client_Development]].
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_PPM_ERROR</code>
|The local oscillator frequency deviation in ppm (value will be rounded to integer).
Available with the following modules:

*SoapyRTLSDR
*SoapySDRPlay

Not available with the following modules:

*SoapyUHD
*SoapyPluto
|-
|<code>SATNOGS_RX_BANDWIDTH</code>
|Soapy baseband filter bandwidth [https://github.com/pothosware/SoapySDR/blob/a489f3dca9d3ccd9b276b95a608ac3ef0299f635/include/SoapySDR/Device.hpp#L904-L910] of RX Channel 0 in Hz (only available on specific devices). TODO: Testing.
|-
|<code>SATNOGS_DEV_ARGS</code>
|Soapy device arguments (currently only accepting the <code>serial</code> key successfully) and stream arguments.
NOTE: This parameter / its meaning might change in the near future, see issue [https://gitlab.com/librespacefoundation/satnogs/satnogs-client/-/issues/373 satnogs-client#373].
|-
|<code>SATNOGS_GAIN_MODE</code>
|Choose the gain mode:

*<code>"Overall"</code> (default): Set the gain with the single value from <code>SATNOGS_RF_GAIN</code>
*<code>"Settings Field"</code>: Ignore <code>SATNOGS_RF_GAIN</code>, use the settings from <code>SATNOGS_OTHER_SETTINGS</code> instead
|-
|<code>SATNOGS_STREAM_ARGS</code>
|
|-
|<code>SATNOGS_TUNE_ARGS</code>
|
|-
|<code>SATNOGS_OTHER_SETTINGS</code>
|Only available if <code>SATNOGS_GAIN_MODE</code>is<code>"Settings Field"</code>.
Available gain settings can be retrieved using <code>SoapySDRUtil --probe="driver=xxxx`</code>

Example for Airspy: Use<code>"LNA=12,MIX=8,VGA=11"</code>See also: [[SDR#Airspy|Airspy support]]
|-
|<code>SATNOGS_DC_REMOVAL</code>
|
|-
|<code>SATNOGS_BB_FREQ</code>
|
|-
|<code>SATNOGS_LO_OFFSET</code>
|Don't use this parameter to correct for the local oscillator frequency deviation, use <code>SATNOGS_PPM_ERROR</code> instead!
To avoid the SDR carrier at the DC the LO is shifted from the actual frequency a little. Default: <code>100e3</code> (100 kHz)
|-
|<code>SATNOGS_ROT_MODEL</code>
|Hamlib rotator model. If you don't have a rotator (like the [[No rotator|No rotator setup]]), leave it empty.
Use the macro name for your rotator model from this [https://gist.github.com/kerel-fs/2354ff9c082cd3c1594afc38c67bc32a#hamlib-release-33 list of rotator models in Hamlib]. If you are connecting to a separate rotctld instance, use <code>ROT_MODEL_NETROTCTL</code>
|-
|<code>SATNOGS_ROT_BAUD</code>
|Baud rate for Hamlib rotator serial port, if using a serial-connected rotator.
|-
|<code>SATNOGS_ROT_PORT</code>
|Serial port for Hamlib rotator, OR the network address of a rotctld instance (e.g. <code>localhost:4533</code> )
|-
|<code>SATNOGS_ROT_THRESHOLD</code>
|Rotator movement threshold, in degrees. If set, the rotator will only be commanded when the target has moved more than <threshold> degrees away from the current azimuth/elevation position. Default: 4 degrees
|-
|<code>HAMLIB_UTILS_ROT_ENABLED</code>
|Whether or not to enable the Hamlibs rotator daemon. Rotctld is a software daemon that provides a network server to control a rotator on a serial port.
|-
|<code>HAMLIB_UTILS_ROT_OPTS</code>
|Options for rotcld:
For a yaesu rotator, use <code>-m 601 -r /dev/ttyACM0 -s 9600 -T 0.0.0.0</code>

For a SatNOGS rotator <code>-m 204 -s 19200 -r /dev/ttyACM0 -C timeout=200</code> or <code>-m 204 -s 19200 -r /dev/ttyUSB0 -C timeout=200</code>
|-
|<code>SATNOGS_PRE_OBSERVATION_SCRIPT</code><code>SATNOGS_POST_OBSERVATION_SCRIPT</code>
|Allows execution of a shell script either pre or post-observation. The following can be entered into the script path to enable passing of information to the script:
<code><nowiki>{{FREQ}}</nowiki></code> - Observation Centre Frequency

<code><nowiki>{{TLE}}</nowiki></code> - Target object TLE data, as a JSON-formatted object.

<code><nowiki>{{TIMESTAMP}}</nowiki></code> - Start time of the observation, in the format: %Y-%m-%dT%H-%M-%S%z

<code><nowiki>{{ID}}</nowiki></code> - Observation ID number.

<code><nowiki>{{BAUD}}</nowiki></code> - Baud rate of the modulation used, if applicable.

<code><nowiki>{{SCRIPT_NAME}}</nowiki></code> - The name of the demodulation flow-graph script in use.
|-
|<code>EXPERIMENTAL</code>
|Install latest (experimental) versions of all software
|-
|<code>APT_REPOSITORY</code>
|This options allows you to change the SatNOGS packages repository. For example, to install unstable package builds use:
<code>deb <nowiki>http://download.opensuse.org/repositories/home:/librespace:/satnogs-unstable/Raspbian_10</nowiki> ./</code>
|-
|<code>APT_KEY_URL</code>
|This options allows you to change the SatNOGS packages repository key URL. For example, to install unstable package builds use:
<code><nowiki>http://download.opensuse.org/repositories/home:/librespace:/satnogs-unstable/Raspbian_10/Release.key</nowiki></code>
|-
|<code>APT_KEY_ID</code>
|This options allows you to specify an alternative SatNOGS packages repository key ID.
|-
|<code>SATNOGS_CLIENT_URL</code>
|If you to try a development version of satnogs-client, you can change the URL here. The URL needs to be in [https://pip.pypa.io/en/stable/reference/pip_install PIP format]. Here are some examples:

*<code>git+<nowiki>https://gitlab.com/librespacefoundation/satnogs/satnogs-client.git@master</nowiki></code> -- the 'master' branch (the current development version) of satnogs-client
*<code><nowiki>git+https://gitlab.com/jdoe/satnogs-client.git@new-feature</nowiki></code> -- the 'new-feature' branch of jdoe's fork of satnogs-client
|-
|<code>SATNOGS_RADIO_FLOWGRAPHS_VERSION</code>
|This options allows you to change the version of satnogs-flowgraphs package to be installed. For example:
<code>0.1-1</code>
|-
|<code>LOG_LEVEL</code>
|Define SatNOGS client log level, available values: <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code> and <code>DEBUG</code>
|-
|<code>SATNOGS_ARTIFACTS_ENABLED</code>
|Enable generation and uploading of HDF5 artifacts files to SatNOGS DB. (added in satnogs-client 1.7)
|-
|<code>SATNOGS_ARTIFACTS_API_TOKEN</code>
|SatNOGS DB API token associated with an account in SatNOGS DB. This token is secret. It is used to upload artifacts to SatNOGS DB. It can be found in SatNOGS DB user page. (added in satnogs-client 1.7)
|}
==Obsolete Setup Variables==
The following options were available in previous versions of the SatNOGS client system and have no effect on the latest stable version.
{| class="wikitable"
!Setting
!Description
|-
|<code>SATNOGS_RX_DEVICE</code>
|If you are using an RTL-SDR, this is <code>rtlsdr</code>. Other devices supported by gr-satnogs include <code>usrpb200</code>, <code>usrp2</code>, <code>airspy/airspymini</code>, <code>lime</code>, or <code>hackrf</code>.
|-
|<code>SATNOGS_PPM_ERROR</code> (available again)
|gr-satnogs: The PPM correction [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/-/blob/v1.5.1/apps/flowgraphs/README.md#execution-arguements-interface]
|-
|<code>SATNOGS_DEV_ARGS</code> (available again)
|gr-satnogs: SDR device specific arguments [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/-/blob/v1.5.1/apps/flowgraphs/README.md#execution-arguements-interface]
Note: This variable was re-purposed to set soapy device and stream arguments, so it's not obsolete anymore.
|-
|<code>SATNOGS_IF_GAIN</code>
|gr-satnogs: Intermediate frequency gain [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/-/blob/v1.5.1/apps/flowgraphs/README.md#execution-arguements-interface]
|-
|<code>SATNOGS_BB_GAIN</code>
|gr-satnogs: Baseband gain [https://gitlab.com/librespacefoundation/satnogs/gr-satnogs/-/blob/v1.5.1/apps/flowgraphs/README.md#execution-arguements-interface]
|-
|<code>SATNOGS_RADIO_GR_SATNOGS_VERSION</code>
|This options allows you to change the version of gr-satnogs package to be installed. For example: <code>1.5.1-1</code>
|}
==Updating SatNOGS Software==
{{Warning| An update can potentially interrupt a running observation!}}The software is updated automatically when <code>satnogs-setup</code> is executed.{{Message|Client version on SatNOGS Network is updated after the first observation with the new client.}}
===Upgrading from legacy software===
To update from the legacy SatNOGS software execute the normal installation command:
$ curl -sfL <nowiki>https://satno.gs/install</nowiki> | sh -s --
The command will clean-up the old software, install the new one and then bring up the SatNOGS configuraion menu-driver utility.

==Verification of correct installation==
To verify that the software is set up correctly, execute:<pre>
$ sudo docker ps -f 'name=^satnogs_' --format "table {{.Names}}\t{{.Status}}"
</pre>You should see an output that looks like this:<pre>
NAMES STATUS
satnogs_satnogs-client Up 31 seconds
satnogs_rigctld Up 31 seconds
</pre>If you see that, great -- you're ready to [[Operation|schedule your first observation]]! If not, check out the [[Troubleshooting]] page.
==Backup & Restore the configuration==
The configuration of your SatNOGS station is stored at <code>/var/lib/docker-bindmounts/ansible/etc/ansible/host_vars/ansible</code>. If your station software is broken (e.g. due to a corrupt SD card), you can perform the following steps:

#Backup the configuration file
#Re-flash the SD card with a fresh image
#Restore the configuration file
#Execute <code>$ curl -sfL <nowiki>https://satno.gs/install</nowiki> | sh -s --</code>

==See also==

*[[SatNOGS Client Ansible]]

Raspberry Pi

2025-01-10T15:42:34Z

Acinonyx:

Raspberry Pi

2022-09-10T16:42:52Z

Acinonyx: Remove Pi4 Workaround

[[File:B3342fcc865731d69e0c9d7a8b1abb887185bc13 1 531x500.jpg|alt=Libre Space Foundation Raspberry Pi Case|thumb|Libre Space Foundation Raspberry Pi Case, [https://www.thingiverse.com/thing:3233687 on thingiverse]]]

==Introduction==

The Raspberry Pi (version 3 and 4) is the reference platform for SatNOGS (see our [[SatNOGS Client Ansible|Ansible guide]] to install SatNOGS on other Linux machines). You can try using various distributions for this (eg. Debian/Armbian, Arch, Fedora), but the one we suggest is our custom image based on latest Raspbian.

{{Message|This page assumes you have an account and a ground station registered on either network.satnogs.org or network-dev.satnogs.org. Make note of your station ID and API Key.}}

==Download==
'''<big>Raspbian SatNOGS Image:</big> <big>[https://gitlab.com/librespacefoundation/satnogs/satnogs-pi-gen/-/jobs/artifacts/2022091000/download?job=release artifacts.zip]</big> ''' (Release: 2022091000)

Download the latest Raspbian SatNOGS Image from above (or via the "Download" icon on the right side of the [https://gitlab.com/librespacefoundation/satnogs/satnogs-pi-gen/tags latest tag page on GitLab]). This image has the SatNOGS setup script installed, the SSH server enabled and all required packages preinstalled. You will get an <code>artifacts.zip</code> file with the following content:

*A Zipped image file
*An Image info file
*A SHA256 checksum file

===Data integrity verification===

You should verify the data integrity of the artifacts by comparing the SHA256 checksums. On Linux, run <code>sha256sum -c sha256sums</code> in the directory where the artifacts are downloaded and unzipped.

Example:
<pre>
$ sha256sum -c sha256sums
2022-09-10-Raspbian-SatNOGS-master-lite.info: OK
image_2022-09-10-Raspbian-SatNOGS-master-lite.zip: OK
</pre> 
==Flashing==
[https://www.raspberrypi.org/documentation/installation/installing-images/README.md Follow the usual Raspbian flashing instructions], and boot your Raspberry Pi.

==Getting console access==
You can log in the Raspberry Pi by connecting it to a keyboard and monitor or through network via an SSH connection.

===Keyboard and monitor===
Once your Raspberry Pi is booted, log in with username "'''pi'''" password "'''raspberry'''".

===Ethernet===
If you are using wired Ethernet you should get connectivity right away. You just need to find the IP address of Raspberry Pi (e.g. in your router management interface). Log in with SSH using username "'''pi'''" password "'''raspberry'''", for example:
$ ssh pi@192.168.1.2
If your network supports [[wikipedia:Zero-configuration_networking|<code>zeroconf</code>]], then you can use the hostname of your Pi:
$ ssh pi@raspberrypi.local

===Pre-boot wireless configuration===
If neither keyboard/monitor, nor a wired Ethernet are available, you can set up a WiFi connection before boot by mounting the boot partition of the flashed SD card and editing files directly. Note your OS may mount boot partition in a different location. [https://raspberrypi.stackexchange.com/questions/10251/prepare-sd-card-for-wifi-on-headless-pi#comment98121_57023 Windows users have line ending problems]. Suggested actions:

$ $EDITOR /media/Raspbian_SatNOGS-boot/wpa_supplicant.conf

contents: (note key_mgmt options include NONE, WPA-PSK, WPA-EAP)

ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
update_config=1
country=US

network={
ssid="NETWORK_NAME"
psk="password"
key_mgmt=WPA-PSK
}

==Configuration==

===Raspberry Pi Setup===
Once your Raspberry Pi is booted, log in with username "'''pi'''" password "'''raspberry'''" and run:
<pre>
$ sudo raspi-config
</pre>

You will want to be sure to do the following:

*Set a strong, unique password
*Change localization settings:
**by default the rpi locale is configured for EN-GB, change as appropriate (ie: to EN_US.UTF-8)
**set timezone (we recommend UTC so your logs match the times in Network; UTC is under the 'none of the above' submenu)
**set keyboard layout, again this is defaulting to a UK layout
**set wifi country
**expand filesystem (under the Advanced menu)
*Configure network or WiFi (see [https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md this doc for network configuration instructions])
*Finish and reboot

===SatNOGS Setup===
SSH to the Raspberry Pi with user "'''pi'''" and your new password.

Follow [[SatNOGS Client Setup]] instructions to configure the system.

[[Category:Build]]
[[Category:Software]]

Raspberry Pi

2022-09-10T16:41:56Z

Acinonyx: SSH enabled during build

[[File:B3342fcc865731d69e0c9d7a8b1abb887185bc13 1 531x500.jpg|alt=Libre Space Foundation Raspberry Pi Case|thumb|Libre Space Foundation Raspberry Pi Case, [https://www.thingiverse.com/thing:3233687 on thingiverse]]]

==Introduction==

The Raspberry Pi (version 3 and 4) is the reference platform for SatNOGS (see our [[SatNOGS Client Ansible|Ansible guide]] to install SatNOGS on other Linux machines). You can try using various distributions for this (eg. Debian/Armbian, Arch, Fedora), but the one we suggest is our custom image based on latest Raspbian.

{{Message|This page assumes you have an account and a ground station registered on either network.satnogs.org or network-dev.satnogs.org. Make note of your station ID and API Key.}}

==Download==
'''<big>Raspbian SatNOGS Image:</big> <big>[https://gitlab.com/librespacefoundation/satnogs/satnogs-pi-gen/-/jobs/artifacts/2022091000/download?job=release artifacts.zip]</big> ''' (Release: 2022091000)

Download the latest Raspbian SatNOGS Image from above (or via the "Download" icon on the right side of the [https://gitlab.com/librespacefoundation/satnogs/satnogs-pi-gen/tags latest tag page on GitLab]). This image has the SatNOGS setup script installed, the SSH server enabled and all required packages preinstalled. You will get an <code>artifacts.zip</code> file with the following content:

*A Zipped image file
*An Image info file
*A SHA256 checksum file

===Data integrity verification===

You should verify the data integrity of the artifacts by comparing the SHA256 checksums. On Linux, run <code>sha256sum -c sha256sums</code> in the directory where the artifacts are downloaded and unzipped.

Example:
<pre>
$ sha256sum -c sha256sums
2022-09-10-Raspbian-SatNOGS-master-lite.info: OK
image_2022-09-10-Raspbian-SatNOGS-master-lite.zip: OK
</pre>

===Pi4 Workaround===

With newer Pi4 models there where missing firmware files in the image, for now we have created a temporary solution.
The updated image can be downloaded via the following [https://cloud.libre.space/s/4cfcK6H4joCdyCm link]

Data integrity information:

<pre>
md5: 5128e134554ef32aa7eb31267305b302
sha256: c769ead89686f6b232a79f23637dedec018aa73982ec31e387e61d4d60029d52
</pre>

==Flashing==
[https://www.raspberrypi.org/documentation/installation/installing-images/README.md Follow the usual Raspbian flashing instructions], and boot your Raspberry Pi.

==Getting console access==
You can log in the Raspberry Pi by connecting it to a keyboard and monitor or through network via an SSH connection.

===Keyboard and monitor===
Once your Raspberry Pi is booted, log in with username "'''pi'''" password "'''raspberry'''".

===Ethernet===
If you are using wired Ethernet you should get connectivity right away. You just need to find the IP address of Raspberry Pi (e.g. in your router management interface). Log in with SSH using username "'''pi'''" password "'''raspberry'''", for example:
$ ssh pi@192.168.1.2
If your network supports [[wikipedia:Zero-configuration_networking|<code>zeroconf</code>]], then you can use the hostname of your Pi:
$ ssh pi@raspberrypi.local

===Pre-boot wireless configuration===
If neither keyboard/monitor, nor a wired Ethernet are available, you can set up a WiFi connection before boot by mounting the boot partition of the flashed SD card and editing files directly. Note your OS may mount boot partition in a different location. [https://raspberrypi.stackexchange.com/questions/10251/prepare-sd-card-for-wifi-on-headless-pi#comment98121_57023 Windows users have line ending problems]. Suggested actions:

$ $EDITOR /media/Raspbian_SatNOGS-boot/wpa_supplicant.conf

contents: (note key_mgmt options include NONE, WPA-PSK, WPA-EAP)

ctrl_interface=DIR=/var/run/wpa_supplicant GROUP=netdev
update_config=1
country=US

network={
ssid="NETWORK_NAME"
psk="password"
key_mgmt=WPA-PSK
}

==Configuration==

===Raspberry Pi Setup===
Once your Raspberry Pi is booted, log in with username "'''pi'''" password "'''raspberry'''" and run:
<pre>
$ sudo raspi-config
</pre>

You will want to be sure to do the following:

*Set a strong, unique password
*Change localization settings:
**by default the rpi locale is configured for EN-GB, change as appropriate (ie: to EN_US.UTF-8)
**set timezone (we recommend UTC so your logs match the times in Network; UTC is under the 'none of the above' submenu)
**set keyboard layout, again this is defaulting to a UK layout
**set wifi country
**expand filesystem (under the Advanced menu)
*Configure network or WiFi (see [https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md this doc for network configuration instructions])
*Finish and reboot

===SatNOGS Setup===
SSH to the Raspberry Pi with user "'''pi'''" and your new password.

Follow [[SatNOGS Client Setup]] instructions to configure the system.

[[Category:Build]]
[[Category:Software]]