From 27e3fd05090f9ffe39b112290b5e5a5c966734ee Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Thu, 7 Oct 2021 21:00:55 +0200
Subject: [PATCH] L2SS-434: Improve statistics writer description

---
 docs/source/devices/devices.rst | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/docs/source/devices/devices.rst b/docs/source/devices/devices.rst
index 833cb2570..409892aac 100644
--- a/docs/source/devices/devices.rst
+++ b/docs/source/devices/devices.rst
@@ -103,7 +103,7 @@ Conversely, to calculate the block index for an antenna pair ``(a,b)``, use::
 TCP stream
 ``````````
 
-The TCP stream interface allows a user to subscribe to the statistics packet streams, combined into a single TCP stream. To do so, simply connect to the following port:
+The TCP stream interface allows a user to subscribe to the statistics packet streams, combined into a single TCP stream. The statistics will be streamed until the user disconnects, or the device is turned off. Any number of subscribers is supported, as bandwidth allows. Simply connect to the following port:
 
 +----------+----------------+
 | Device   | TCP end point  |
@@ -113,7 +113,15 @@ The TCP stream interface allows a user to subscribe to the statistics packet str
 | XST      | localhost:5102 |
 +----------+----------------+
 
-The easiest way to capture this stream is to use our ``statistics_writer``, which will capture the statistics and store them in HDF5 file(s): the writer recognised packet boundaries, converts the packets into their respective matrix, and store a matrix for each received timestamp. Furthermore, packet header information is periodically recorded as HDF5 attributes::
+The easiest way to capture this stream is to use our ``statistics_writer``, which will capture the statistics and store them in HDF5 file(s). The writer:
+
+- computes packet boundaries,
+- processes the data of each packet, and stores their values into the matrix relevant for the mode,
+- stores a matrix per timestamp,
+- stores packet header information per timestamp, as HDF5 attributes,
+- writes to a new file at a configurable interval.
+
+To run the writer::
 
   cd devices/statistics_writer
   python3 statistics_writer.py --mode SST --host localhost
-- 
GitLab