From 48ecefc5ce97d48aad5b65d3f87346f064b172b8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Thomas=20J=C3=BCrges?= <jurges@astron.nl>
Date: Thu, 22 Nov 2018 14:08:03 +0000
Subject: [PATCH] Task SW-533: Add documentation for switch_firmware
---
MAC/Services/TBB/TBBServer/lib/tbbservice.py | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/MAC/Services/TBB/TBBServer/lib/tbbservice.py b/MAC/Services/TBB/TBBServer/lib/tbbservice.py
index 1cca921500e..ad50dfb9824 100644
--- a/MAC/Services/TBB/TBBServer/lib/tbbservice.py
+++ b/MAC/Services/TBB/TBBServer/lib/tbbservice.py
@@ -225,7 +225,12 @@ class TBBControlService:
def switch_firmware(stations, mode):
- log_message = "Switching TBB firmware for mode %s on stations %s" % (mode, stations)
+ """
+ Command TBBs to switch to one of two firmwares: sub-band mode or raw voltage mode.
+ :param stations: string - Only TBBs of these stations will be commanded to start data recording.
+ :param mode: string - Parameter to set-up data recording in either \"subband\" or \"rawvoltage\" mode.
+ """
+ log_message = "Switching TBB firmware on stations %s to \"%s\"" % (stations, mode)
logger.info(log_message + "...")
load_tbb_firmware(stations, mode)
logger.info(log_message + "done.")
--
GitLab