Skip to content

Commit e8aa964

Browse files
committed
Document telemetry submission to HIT
See csete#131
1 parent d1fcfd1 commit e8aa964

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/source/command_line.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -450,6 +450,9 @@ certain satellite projects:
450450

451451
* The `BME telemetry server`_, which is used by SMOG-P, ATL-1 and SMOG-1.
452452

453+
* `Harbin Institute of Technology`_, which connects to the telemetry proxy included in
454+
`gr-lilacsat`_ and `gr-dslwp`_.
455+
453456
To enable telemetry submission, it is necessary to edit some parameters in
454457
``gr_satellites``'s config file, which is located in
455458
``~/.gr_satellites/config.ini``. If this file does not exist, it will be created
@@ -495,6 +498,21 @@ To enable telemetry submission to the BME server, it is necessary to
495498
`register an account in the BME server`_. The user and password should be
496499
entered into the gr-satellites ``.ini`` file.
497500

501+
To use the Harbin Institute of Technology proxy to submit telemetry, the proxy
502+
needs to be run and started in the local computer before running
503+
``gr_satellites``. The command line tool will connect to the correct port where
504+
the proxy is listening (this is specified in the SatYAML file of each
505+
satellite). All the configuration regarding the station and the operator is done
506+
in the proxy itself. When ``gr_satellites`` starts, it will attempt to connect
507+
to the proxy, and print a warning if unable (in which case telemetry submission
508+
through the proxy is disabled for this run).
509+
510+
.. note::
511+
The Harbin Institute of Technology proxy is a Python2 application that uses
512+
PyQt4. Users having more modern sytems may find useful the PyQt5 version that
513+
can be found in the `pyqt5 branch of gr-lilacsat`_. This requires ``tornado`` version
514+
4.5.3. It will not work with more recent versions of ``tornado``.
515+
498516
For some telemetry servers, including SatNOGS DB, the frames are submitted
499517
together with a timestamp of reception. This timestamp is taken from the
500518
computer's clock by ``gr_satellites`` at the moment when it decodes the
@@ -654,3 +672,7 @@ processed, thus restoring the correct polarity.
654672
.. _feh: https://feh.finalrewind.org/
655673
.. _NumPy: https://numpy.org/
656674
.. _Matplotlib: https://matplotlib.org/
675+
.. _Harbin Institute of Technology: http://lilacsat.hit.edu.cn/
676+
.. _gr-lilacsat: https://github.com/bg2bhc/gr-lilacsat
677+
.. _gr-dslwp: https://github.com/bg2bhc/gr-dslwp
678+
.. _pyqt5 branch of gr-lilacsat: https://github.com/daniestevez/gr-lilacsat/tree/pyqt5

0 commit comments

Comments
 (0)