From 41922645cde9b5477e32d3135b2f22e5413c15b5 Mon Sep 17 00:00:00 2001
From: Brandon Parks <bap@open-ephys.org>
Date: Tue, 2 Apr 2024 11:07:03 -0400
Subject: [PATCH] Ephys socket update - Add HTTP documentation (#40)

* Add HTTP documentation

* Remove caching of dependencies
---
 .github/workflows/sphinx-build.yml          |  7 -------
 source/User-Manual/Plugins/Ephys-Socket.rst | 19 ++++++++++++++++++-
 2 files changed, 18 insertions(+), 8 deletions(-)

diff --git a/.github/workflows/sphinx-build.yml b/.github/workflows/sphinx-build.yml
index 6b84b78..9e683c7 100644
--- a/.github/workflows/sphinx-build.yml
+++ b/.github/workflows/sphinx-build.yml
@@ -25,14 +25,7 @@ jobs:
         run: |
           python -m pip install --upgrade pipenv wheel
 
-      - id: cache-pipenv
-        uses: actions/cache@v1
-        with:
-          path: ~/.local/share/virtualenvs
-          key: ${{ runner.os }}-pipenv-${{ hashFiles('**/Pipfile.lock') }}
-
       - name: Install dependencies
-        if: steps.cache-pipenv.outputs.cache-hit != 'true'
         run: |
           pipenv install --deploy --dev
 
diff --git a/source/User-Manual/Plugins/Ephys-Socket.rst b/source/User-Manual/Plugins/Ephys-Socket.rst
index 2da16df..4f74a0a 100644
--- a/source/User-Manual/Plugins/Ephys-Socket.rst
+++ b/source/User-Manual/Plugins/Ephys-Socket.rst
@@ -110,7 +110,7 @@ An example Python script is included in the `Resources <https://github.com/open-
     "**Variable**", "**Data Type**", "**Description**"
     "Offset", "`int32`", "Integer defining the offset in the data stream. For TCP sockets, value must always be set to **0**."
     "Number of Bytes", "`int32`", "Total number of bytes sent in each packet. Calculated as :code:`num_bytes = num_channels * num_samples * element_size`. This does **not** include the header bytes."
-    "Bit Depth", "int16", "Depth defines the OpenCV.Mat `Depth <https://github.com/horizongir/opencv.net/blob/main/src/OpenCV.Net/CoreTypes.cs#L93>`__, an enumeration defined as :code:`[U8, S8, U16, S16, S32, F32, F64]`, where U is 'unsigned', S is 'signed', F is 'float', and the number indicates the number of bits. For example, :code:`U16` means 'unsigned integer with 16 bits'. Note that the enumeration is zero-indexed, where :code:`U8 = 0`, and :code:`F64 = 6`"
+    "Bit Depth", "`int16`", "Depth defines the OpenCV.Mat `Depth <https://github.com/horizongir/opencv.net/blob/main/src/OpenCV.Net/CoreTypes.cs#L93>`__, an enumeration defined as :code:`[U8, S8, U16, S16, S32, F32, F64]`, where U is 'unsigned', S is 'signed', F is 'float', and the number indicates the number of bits. For example, :code:`U16` means 'unsigned integer with 16 bits'. Note that the enumeration is zero-indexed, where :code:`U8 = 0`, and :code:`F64 = 6`"
     "Element Size", "`int32`", "Number of bytes needed for each sample. For :code:`U16`, :code:`element_size = 2`, while for :code:`F64`, :code:`element_size = 8`."
     "Number of Channels", "`int32`", "Number of channels per packet."
     "Number of Samples", "`int32`", "Number of samples sent per channel per packet."
@@ -118,3 +118,20 @@ An example Python script is included in the `Resources <https://github.com/open-
 .. note::
 
     Pay attention to the order of data samples in the example script. Samples are not interleaved, but rather in each packet the samples for channel 1 are sent, followed by the samples for channel 2, and so on.
+
+Remote Control
+#################
+
+Some Ephys Socket settings can be modified via the GUI's built-in HTTP server. Commands are sent as "config messages" to the Ephys Socket node.
+
+.. note::
+
+    Parameters cannot be modified while acquisition is running, nor can they be modified if the port is connected. To change any settings remotely, the port must be disconnected in the GUI
+
+The following commands are available:
+
+1. :code:`ES INFO` : returns a JSON string containing information about all available variables (i.e., scale, offset, port, and frequency)
+2. :code:`ES SCALE <data_scale>` : set the data scale
+3. :code:`ES OFFSET <data_offset>` : set the data offset
+4. :code:`ES PORT <port>` : set the port number
+5. :code:`ES FREQUENCY <sample_rate>` : set the sampling frequency