From 8b881b350d099b0a263d56b524381657420d2094 Mon Sep 17 00:00:00 2001
From: Jan David Mol <mol@astron.nl>
Date: Tue, 14 Dec 2021 16:25:26 +0100
Subject: [PATCH] Add hint on how to manually inspect statistics packets

---
 docs/source/faq.rst | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/docs/source/faq.rst b/docs/source/faq.rst
index 631c6fa3a..05022cd81 100644
--- a/docs/source/faq.rst
+++ b/docs/source/faq.rst
@@ -147,6 +147,17 @@ Let's see where the packets get stuck. Let us assume your MTU=9000 network inter
 
 - If still on error was found, you've likely hit a bug in our software.
 
+Inspecting SST/XST packets
+``````````````````````````````````````````````````````````````````````````````````````````````````````````````
+
+The fields ``sst.last_packet_R`` and ``xst.last_packet_R`` contain a raw dump of the last received packet for that statistic. Parsing these packets is aided greatly by using our packet parser::
+
+  from tangostationcontrol.devices.sdp.statistics_packet import SSTPacket, XSTPacket
+
+  # print the headers of the last received packets
+  print(SSTPacket(bytes(sst.last_packet_R)).header())
+  print(XSTPacket(bytes(xst.last_packet_R)).header())
+
 Other containers
 --------------------------------------------------------------------------------------------------------------
 
-- 
GitLab