m-labs · Feb 15, 2016 · Feb 15, 2016
Showing with 22 additions and 1 deletion.

+1 −1 artiq/coredevice/analyzer.py

+19 −0 doc/manual/getting_started_core.rst

+2 −0 doc/manual/utilities.rst
diff --git a/artiq/coredevice/analyzer.py b/artiq/coredevice/analyzer.py
@@ -288,7 +288,7 @@ def get_vcd_log_channels(log_channel, messages):
             message_payload = _extract_log_chars(message.data)
             log_entry += message_payload
             if len(message_payload) < 4:
-                channel_name, log_message = log_entry.split(":", maxsplit=1)
+                channel_name, log_message = log_entry.split("\x1E", maxsplit=1)
                 l = len(log_message)
                 if channel_name in vcd_log_channels:
                     if vcd_log_channels[channel_name] < l:

diff --git a/doc/manual/getting_started_core.rst b/doc/manual/getting_started_core.rst
@@ -134,6 +134,25 @@ Try reducing the period of the generated waveform until the CPU cannot keep up w
             except RTIOUnderflow:
                 print_underflow()
 
+The core device records the real-time IO waveforms into a circular buffer. It is possible to dump any Python object so that it appears alongside the waveforms using the ``rtio_log`` function, which accepts a channel name (i.e. a log target) as the first argument: ::
+
+    from artiq.experiment import *
+
+
+    class Tutorial(EnvExperiment):
+        def build(self):
+            self.setattr_device("core")
+            self.setattr_device("ttl0")
+
+        @kernel
+        def run(self):
+            for i in range(100):
+                self.ttl0.pulse(...)
+                rtio_log("ttl0", "i", i)
+                delay(...)
+
+Afterwards, the recorded data can be extracted and written to a VCD file using ``artiq_coreanalyzer -w rtio.vcd`` (see: :ref:`core-device-rtio-analyzer-tool`).
+
 Parallel and sequential blocks
 ------------------------------
 

diff --git a/doc/manual/utilities.rst b/doc/manual/utilities.rst
@@ -163,6 +163,8 @@ Core device log download tool
    :ref: artiq.frontend.artiq_corelog.get_argparser
    :prog: artiq_corelog
 
+.. _core-device-rtio-analyzer-tool:
+
 Core device RTIO analyzer tool
 ------------------------------