Skip to content

Commit fb9ad74

Browse files
committed
Chore updated Ephys Link CLI usage
1 parent 2e88c2a commit fb9ad74

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

source/ephys_link/installation_and_use.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ window instead of `localhost`.
7676
4. In a terminal, navigate to the repository's root directory and run
7777

7878
```bash
79-
hatch shell
79+
hatch shell
8080
```
8181

8282
This will create a virtual environment, install Python 12 (if not found), and install the package in editable mode.
@@ -98,31 +98,38 @@ server.launch("sensapex", 8081)
9898

9999
## CLI Usage
100100

101-
Ephys Link can be launched from the command line directly. This is useful for computers or servers without graphical
102-
user interfaces.
101+
Ephys Link can be launched from the command line directly without the configuration window. This is useful for computers
102+
or servers without graphical user interfaces.
103+
104+
With the standalone executable downloaded, invoking the executable from the command line:
105+
106+
```bash
107+
ephys_link-vX.X.X-Windows-x86_64.exe -b
108+
```
109+
110+
Use the actual name of the executable you downloaded. The `-b` or `--background` flag will launch the server without the
111+
configuration window and read configuration from CLI arguments.
103112

104113
Run the following commands in a terminal to start the server for the desired manipulator platform without the startup
105-
window:
114+
window (replace `ephys_link.exe` with the actual name of the executable you downloaded):
106115

107-
| Manipulator Platform | Command |
108-
|--------------------------------------|---------------------------------------------|
109-
| Sensapex uMp-4 | `ephys-link.exe -b` |
110-
| Sensapex uMp-3 | `ephys-link.exe -b -t ump3` |
111-
| New Scale | `ephys-link.exe -b -t new_scale` |
112-
| New Scale via Pathfinder HTTP server | `ephys-link.exe -b -t new_scale_pathfinder` |
116+
| Manipulator Platform | Command |
117+
|------------------------------------------|---------------------------------------------|
118+
| Sensapex uMp-4 | `ephys_link.exe -b` |
119+
| Sensapex uMp-3 | `ephys_link.exe -b -t ump3` |
120+
| New Scale Pathfinder MPM Control v2.8.8+ | `ephys_link.exe -b -t new_scale_pathfinder` |
121+
| New Scale M3-USB-3:1-EP | `ephys_link.exe -b -t new_scale` |
113122

114-
More options can be viewed by running `ephys-link.exe -h`.
123+
More options can be viewed by running `ephys_link.exe -h`.
115124

116-
### "New Scale" vs "New Scale via Pathfinder HTTP server"
125+
### "New Scale Pathfinder MPM Control" vs "New Scale M3-USB-3:1-EP"
117126

118-
New Scale manipulators have two methods of connection. The first method is through a direct hardware
119-
connection (`-t new_scale`) and the second is via the HTTP server broadcast by the Pathfinder
120-
software (`-t new_scale_pathfinder`). The latter method is only available if Pathfinder is running on the same computer
121-
as Ephys Link. New Scale manipulators should be connected to the Pathfinder software first and the HTTP server should be
122-
running.
127+
New Scale manipulators have two methods of connection. The first method is through the Pathfinder MPM Control software (`-t new_scale_pathfinder`) and the second is via a direct hardware
128+
connection (`-t new_scale`). The first method is only available if Pathfinder is running on the same computer
129+
as Ephys Link. New Scale manipulators should be connected to the Pathfinder software first and the Pathfinder HTTP server should be running.
123130

124131
**Note:** Currently (July 2023), Ephys Copilot automation and manual control within Pinpoint is not supported when
125-
connected to New Scale via Pathfinder HTTP server Pinpoint is not supported. Only positional data can be queried.
132+
connected to New Scale via Pathfinder MPM.
126133

127134
### Options
128135

@@ -131,6 +138,7 @@ All options can be viewed with `ephys_link --help`.
131138
| Option | Input | Default | Description |
132139
|----------------------------------|-----------------------------------------------------|-------------|----------------------------------------------------------------|
133140
| `-h, --help` | | | Show help message and options |
141+
| `-b, --background` | | | Launch server without startup window |
134142
| `-t TYPE, --type TYPE` | `sensapex` or `new_scale` or `new_scale_pathfinder` | `sensapex` | Select manipulator type |
135143
| `-p PORT, --port PORT` | Valid HTTP port number | `8081` | HTTP port to serve on |
136144
| `--pathfinder_port` | Valid HTTP port number | `8080` | HTTP port Pathfinder's server is running on |

0 commit comments

Comments
 (0)