Difference between revisions of "SatNOGS Monitor"

From SatNOGS
m (Build and install libgpredict)
(updates infos for version 0.3.0)
Line 26: Line 26:
 
You can run the SatNOGS Monitor on the same Raspberry Pi as your ground station. You'll need to build and install libgpredict as shown above and can build the monitor from source (see [#Hacking]) or use the prebuild Raspbian package.
 
You can run the SatNOGS Monitor on the same Raspberry Pi as your ground station. You'll need to build and install libgpredict as shown above and can build the monitor from source (see [#Hacking]) or use the prebuild Raspbian package.
  
  wget https://github.com/wose/satnogs-monitor/releases/download/0.2.0/satnogs-monitor_0.2.0_armhf.deb
+
  wget https://github.com/wose/satnogs-monitor/releases/download/0.3.0/satnogs-monitor_0.3.0_armhf.deb
  sudo dpkg -i satnogs-monitor_0.2.0_armhf.deb
+
  sudo dpkg -i satnogs-monitor_0.3.0_armhf.deb
  
 
You can then run the monitor over any ssh connection to your ground station or view it directly on a display attached to your RPi. See [https://community.libre.space/t/stegoboard-satnogs-ground-station/4640 this thread] for some inspiration.
 
You can then run the monitor over any ssh connection to your ground station or view it directly on a display attached to your RPi. See [https://community.libre.space/t/stegoboard-satnogs-ground-station/4640 this thread] for some inspiration.
Line 34: Line 34:
 
If you're running an Debian like distribution you can install the prebuild package after building and installing libgpredict.
 
If you're running an Debian like distribution you can install the prebuild package after building and installing libgpredict.
  
  wget https://github.com/wose/satnogs-monitor/releases/download/0.2.0/satnogs-monitor_0.2.0_amd64.deb
+
  wget https://github.com/wose/satnogs-monitor/releases/download/0.3.0/satnogs-monitor_0.3.0_amd64.deb
  sudo dpkg -i satnogs-monitor_0.2.0_amd64.deb
+
  sudo dpkg -i satnogs-monitor_0.3.0_amd64.deb
  
 
See [#Hacking] if you're running another distribution.
 
See [#Hacking] if you're running another distribution.
  
 
==Running it==
 
==Running it==
The monitor makes heavy usage of braille unicode characters so make sure your terminal emulator uses a font which includes those glyphs. The screenshot at the top shows alacritty[https://github.com/jwilm/alacritty] with the tewi-font[https://github.com/lucy/tewi-font].
+
The monitor makes heavy usage of braille unicode characters so make sure your terminal emulator uses a font which includes those glyphs. The screenshot at the top shows alacritty[https://github.com/jwilm/alacritty] with the tewi-font[https://github.com/lucy/tewi-font]. Take a look at nerd-fonts[https://github.com/ryanoasis/nerd-fonts/] if you're unsure about which font to use.
  
 
Monitor single station:
 
Monitor single station:
Line 50: Line 50:
 
Monitor a local station and multiple remote stations:
 
Monitor a local station and multiple remote stations:
 
  satnogs-monitor -l 175 -s 227 -s 2
 
  satnogs-monitor -l 175 -s 227 -s 2
 +
 +
If satnogs-montor runs on the same machine as satnogs-client (typically a Raspberry Pi) you can set the satnogs client data path and enable the spectrum and/or waterfall plot to get a visualization of the received signal of the current observation.
 +
satnogs-monitor -l 175 --data-path /tmp/.satnoogs/data/ --waterfall --spectrum
  
 
You can also create a config file with all those informations:
 
You can also create a config file with all those informations:
Line 59: Line 62:
 
Check the help for more command line arguments:
 
Check the help for more command line arguments:
 
  $ satnogs-monitor -h
 
  $ satnogs-monitor -h
  satnogs-monitor 0.2.0
+
  satnogs-monitor 0.3.0
 
  Monitors the current and future jobs of SatNOGS ground stations.
 
  Monitors the current and future jobs of SatNOGS ground stations.
 
   
 
   
Line 66: Line 69:
 
   
 
   
 
  FLAGS:
 
  FLAGS:
     -h, --help       Prints help information
+
     -h, --help         Prints help information
     -V, --version   Prints version information
+
        --spectrum    Enables the spectrum plot
     -v               Sets the level of log verbosity
+
     -V, --version     Prints version information
 +
     -v                 Sets the level of log verbosity
 +
        --waterfall    Enables the waterfall plot
 
   
 
   
 
  OPTIONS:
 
  OPTIONS:
     -a, --api <URL>         Sets the SatNOGS network api endpoint url
+
     -a, --api <URL>                 Sets the SatNOGS network api endpoint url
     -c, --config <FILE>     Sets custom config file
+
     -c, --config <FILE>             Sets custom config file
     -l, --local <ID>...     Adds a station running on the same machine as this monitor with this
+
        --data-path <PATH>          Enables the spectrum and waterfall plot if set to the SatNOGS
                              SatNOGS network id to to the list of monitored stations
+
                                      client data path (/tmp/.satnogs/data/)
     -o, --orbits <NUM>       Sets the number of orbits plotted on the map
+
     -l, --local <ID>...             Adds a station running on the same machine as this monitor with
     -s, --station <ID>...   Adds a station with this SatNOGS network id to the list of monitored
+
                                      this SatNOGS network id to to the list of monitored stations
                              stations
+
     -o, --orbits <NUM>               Sets the number of orbits plotted on the map
 +
     -s, --station <ID>...           Adds a station with this SatNOGS network id to the list of
 +
                                      monitored stations
 +
        --waterfall-zoom <FACTOR>    Zooms the spectrum and waterfall plot (1.0 - 10.0)
 +
 
 
'''TAB''' key will cycle through available stations while SatNOGS Monitor is running.
 
'''TAB''' key will cycle through available stations while SatNOGS Monitor is running.
  

Revision as of 23:20, 3 December 2019

Description

Satnogs-monitor.png

SatNOGS Monitor is a terminal ui to monitor your and/or other ground stations of the SatNOGS network. It is written in Rust and runs on Linux and has been reported to run on MacOS[1]. Windows is currently not supported by the underlying terminal library, but might be added at some point in the future. SatNOGS Monitor does not need to be installed on an actual SatNOGS station computer (although there are benefits to doing so as discussed below).

Installation

Dependencies

SatNOGS Monitor uses bindings to libgpredict[2]. This library is not available as installable package and you'll have to build it yourself.

Install libgpredict dependencies

sudo apt-get install libglib2.0-dev cmake build-essential git

Build and install libgpredict

git clone https://github.com/cubehub/libgpredict.git
cd libgpredict
mkdir build
cd build
cmake ../
make
sudo make install
sudo ldconfig # for linux

Raspberry Pi (armhf)

You can run the SatNOGS Monitor on the same Raspberry Pi as your ground station. You'll need to build and install libgpredict as shown above and can build the monitor from source (see [#Hacking]) or use the prebuild Raspbian package.

wget https://github.com/wose/satnogs-monitor/releases/download/0.3.0/satnogs-monitor_0.3.0_armhf.deb
sudo dpkg -i satnogs-monitor_0.3.0_armhf.deb

You can then run the monitor over any ssh connection to your ground station or view it directly on a display attached to your RPi. See this thread for some inspiration.

Linux (x86_64)

If you're running an Debian like distribution you can install the prebuild package after building and installing libgpredict.

wget https://github.com/wose/satnogs-monitor/releases/download/0.3.0/satnogs-monitor_0.3.0_amd64.deb
sudo dpkg -i satnogs-monitor_0.3.0_amd64.deb

See [#Hacking] if you're running another distribution.

Running it

The monitor makes heavy usage of braille unicode characters so make sure your terminal emulator uses a font which includes those glyphs. The screenshot at the top shows alacritty[3] with the tewi-font[4]. Take a look at nerd-fonts[5] if you're unsure about which font to use.

Monitor single station:

satnogs-monitor -s 175

Multiple stations:

satnogs-monitor -s 175 -s 227

Monitor a station on the same machine as the monitor runs (gets you more system infos):

satnogs-monitor -l 175

Monitor a local station and multiple remote stations:

satnogs-monitor -l 175 -s 227 -s 2

If satnogs-montor runs on the same machine as satnogs-client (typically a Raspberry Pi) you can set the satnogs client data path and enable the spectrum and/or waterfall plot to get a visualization of the received signal of the current observation.

satnogs-monitor -l 175 --data-path /tmp/.satnoogs/data/ --waterfall --spectrum

You can also create a config file with all those informations:

mkdir ~/config/satnogs-monitor
cd ~/config/satnogs-monitor
wget https://raw.githubusercontent.com/wose/satnogs-monitor/master/monitor/examples/config.toml
edit config.toml

Check the help for more command line arguments:

$ satnogs-monitor -h
satnogs-monitor 0.3.0
Monitors the current and future jobs of SatNOGS ground stations.

USAGE:
    satnogs-monitor [FLAGS] [OPTIONS]

FLAGS:
    -h, --help         Prints help information
        --spectrum     Enables the spectrum plot
    -V, --version      Prints version information
    -v                 Sets the level of log verbosity
        --waterfall    Enables the waterfall plot

OPTIONS:
    -a, --api <URL>                  Sets the SatNOGS network api endpoint url
    -c, --config <FILE>              Sets custom config file
        --data-path <PATH>           Enables the spectrum and waterfall plot if set to the SatNOGS
                                     client data path (/tmp/.satnogs/data/)
    -l, --local <ID>...              Adds a station running on the same machine as this monitor with
                                     this SatNOGS network id to to the list of monitored stations
    -o, --orbits <NUM>               Sets the number of orbits plotted on the map
    -s, --station <ID>...            Adds a station with this SatNOGS network id to the list of
                                     monitored stations
        --waterfall-zoom <FACTOR>    Zooms the spectrum and waterfall plot (1.0 - 10.0)

TAB key will cycle through available stations while SatNOGS Monitor is running.

Hacking

To build the monitor from source you'll need to install the Rust. Use your package manager or follow this site.

git clone https://github.com/wose/satnogs-monitor.git
cd satnogs-monitor/monitor
mkdir ~/.config/satnogs-monitor
cp examples/config.toml ~/.config/satnogs-monitor/
edit ~/.config/satnogs-monitor/config.toml
cargo run --release -- -s 175