You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/content/docs/tools/probe-rs.mdx
+54Lines changed: 54 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,8 +35,62 @@ To use [RTT](https://docs.rs/rtt-target/latest/rtt_target/) or [defmt](https://d
35
35
36
36
This is great for inspecting a target - where you might not even have knowledge of the firmware - without altering its state.
37
37
38
+
## serve
39
+
40
+
> The probe-rs server and client support is gated behind the `remote` feature and are not available in the default distribution.
41
+
42
+
`probe-rs serve` starts a remote server on your machine. You can `run`, `attach` to a device, `read` and `write` memory, `list` probes and read device `info` from another machine.
43
+
44
+
The server communicates over websockets. It is recommended to add your own TLS layer on top of it. You can specify the bind address and port, as well as the list of user credentials in the `probe-rs` configuration file.
45
+
46
+
To connect to a server, use the `--host` and `--token` options: `probe-rs [command] --host ws[s]://<host> --token <token> [additional arguments]`.
47
+
38
48
## Additional commands
39
49
40
50
To learn more about additional commands, use the `probe-rs help` or `probe-rs <command> --help` commands.
41
51
52
+
## Configuration
53
+
54
+
`probe-rs` can be configured via a config file. Currently the following options are available:
55
+
56
+
- Server listening parameters
57
+
- Server users
58
+
- Command presets
59
+
60
+
The config file can be a `toml`, `json`, `yaml` or `yml` file located at the following paths:
# access= { allow= ["probe serial 1", "probe serial 2"] }
80
+
# access= { deny= ["probe serial 1", "probe serial 2"] }
81
+
```
82
+
83
+
### Specifying presets
84
+
85
+
Presets allow you to simplify the CLI arguments. You can define any number of presets, and then use the `--preset <name>` option to select one. The arguments in the preset will then be added to the command. You may create a `default` preset that will be selected when `--preset` is not specified.
Then, issuing the `probe-rs run <firmware> --preset preset_name` command will effectively run `probe-rs run <firmware> --probe vid:pid:serial --host remote --token token`.
0 commit comments