From 79053a9c157381557281c4a60404c70c8a666bd0 Mon Sep 17 00:00:00 2001 From: Brian Koopman Date: Fri, 27 Oct 2023 16:58:58 -0400 Subject: [PATCH] Add example session.data structure for labjack acq process --- socs/agents/labjack/agent.py | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/socs/agents/labjack/agent.py b/socs/agents/labjack/agent.py index e0706b9fc..a8e611ac7 100644 --- a/socs/agents/labjack/agent.py +++ b/socs/agents/labjack/agent.py @@ -278,6 +278,24 @@ def acq(self, session, params=None): sampling_frequency (float): Sampling frequency for data collection. Defaults to 2.5 Hz. + Notes: + An example of the session data is shown below. The keys in the + 'data' dictionary correspond with configured channels from the + ``active_channels`` attribute:: + + >>> response.session['data'] + { + "block_name": "sens", + "data": { + "AIN0V": 0.0015984050696715713, + "FIO0V": 1, + "FIO1V": 1, + "AIN55V": 0.00033546771737746894, + "AIN116V": 0.000019733395674847998, + }, + "timestamp": 1698439453.8471205 + } + """ if params is None: params = {}