From 53b1f45397f6f2db9a45078a542bdf0440165baf Mon Sep 17 00:00:00 2001 From: Timon Zijnge <47081647+tzijnge@users.noreply.github.com> Date: Wed, 17 Dec 2025 14:22:44 +0100 Subject: [PATCH 1/2] Update Ephys-Socket.rst Documentation related to https://github.com/open-ephys-plugins/ephys-socket/issues/26 --- source/User-Manual/Plugins/Ephys-Socket.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/User-Manual/Plugins/Ephys-Socket.rst b/source/User-Manual/Plugins/Ephys-Socket.rst index ac45506..d18d21b 100644 --- a/source/User-Manual/Plugins/Ephys-Socket.rst +++ b/source/User-Manual/Plugins/Ephys-Socket.rst @@ -129,7 +129,7 @@ Some Ephys Socket settings can be modified via the GUI's built-in HTTP server. C .. 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 + Most 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. Exceptions are :code:`ES INFO` which doesn't affect the data streaming and the commands related to socket connection The following commands are available: @@ -138,3 +138,6 @@ The following commands are available: 3. :code:`ES OFFSET ` : set the data offset 4. :code:`ES PORT ` : set the port number 5. :code:`ES FREQUENCY ` : set the sampling frequency +6. :code:`ES CONNECTION_STATUS` : Query the connection state. Returns the string :code:`CONNECTED` or :code:`DISCONNECTED` +7. :code:`ES CONNECT` : Connect the socket. Does nothing when already connected. Returns the string :code:`CONNECTED` or :code:`DISCONNECTED` +8. :code:`ES DISCONNECT` : Disonnect the socket. Does nothing when already disconnected. Returns the string :code:`CONNECTED` or :code:`DISCONNECTED` From 04673c53983c92da9a631b7a5a904636db6441ef Mon Sep 17 00:00:00 2001 From: Timon Zijnge <47081647+tzijnge@users.noreply.github.com> Date: Wed, 17 Dec 2025 15:49:11 +0100 Subject: [PATCH 2/2] Update Ephys-Socket.rst Correction --- source/User-Manual/Plugins/Ephys-Socket.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/User-Manual/Plugins/Ephys-Socket.rst b/source/User-Manual/Plugins/Ephys-Socket.rst index d18d21b..0f2ca03 100644 --- a/source/User-Manual/Plugins/Ephys-Socket.rst +++ b/source/User-Manual/Plugins/Ephys-Socket.rst @@ -140,4 +140,4 @@ The following commands are available: 5. :code:`ES FREQUENCY ` : set the sampling frequency 6. :code:`ES CONNECTION_STATUS` : Query the connection state. Returns the string :code:`CONNECTED` or :code:`DISCONNECTED` 7. :code:`ES CONNECT` : Connect the socket. Does nothing when already connected. Returns the string :code:`CONNECTED` or :code:`DISCONNECTED` -8. :code:`ES DISCONNECT` : Disonnect the socket. Does nothing when already disconnected. Returns the string :code:`CONNECTED` or :code:`DISCONNECTED` +8. :code:`ES DISCONNECT` : Disonnect the socket. Does nothing when already disconnected. Always returns the string :code:`DISCONNECTED`