Skip to content

Update Ephys-Socket.rst #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tzijnge wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update Ephys-Socket.rst #96

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53b1f45
Update Ephys-Socket.rst
tzijnge Dec 17, 2025
04673c5
Update Ephys-Socket.rst
tzijnge Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion source/User-Manual/Plugins/Ephys-Socket.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -138,3 +138,6 @@ The following commands are available:
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
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. Always returns the string :code:`DISCONNECTED`
Loading