Add full Companion builds and terminal path routing
This commit is contained in:
1 parent
4e91cc9487
commit
f40615ab56
8 files changed
+350
-8
No files matched your search
@@ -39,6 +39,14 @@ bash build.sh build-firmware RAK_4631_companion_radio_full \
|
||||
--firmware-version v1.17.0
|
||||
```
|
||||
|
||||
To build every available full Companion target, select the corresponding
|
||||
interactive menu item or run:
|
||||
|
||||
```bash
|
||||
bash build.sh build-full-companion-firmwares \
|
||||
--firmware-version v1.17.0
|
||||
```
|
||||
|
||||
Artifacts are written to `out/` by default.
|
||||
|
||||
On 4 MB ESP32 boards, the full target uses a single 3 MB application
|
||||
@@ -105,16 +113,20 @@ The terminal supports Companion chat commands, including `channels`,
|
||||
channels
|
||||
channel #rgdata Hello from Eugene 👋
|
||||
to Hilltop Repeater
|
||||
path A1B2C3,D4E5F6
|
||||
login my-admin-password
|
||||
cmd ver
|
||||
trace
|
||||
```
|
||||
|
||||
The `to` command selects the remote-administration target. Login passwords are
|
||||
masked during entry and limited by the radio protocol to 15 UTF-8 bytes. Wait
|
||||
for the asynchronous login result before using `cmd`; command replies appear
|
||||
as `CLI -> from <name>`. Remote ACL permissions determine which commands the
|
||||
target accepts.
|
||||
The `to` command selects the remote-administration target. `path` shows its
|
||||
saved outgoing route; `path direct`, `path clear`, or a comma-separated list
|
||||
such as `path A1B2C3,D4E5F6` changes the route used by subsequent `login`,
|
||||
`send`, and `cmd` commands. Every hop must use the same 2-, 4-, or 6-digit
|
||||
hexadecimal width. Login passwords are masked during entry and limited by the
|
||||
radio protocol to 15 UTF-8 bytes. Wait for the asynchronous login result before
|
||||
using `cmd`; command replies appear as `CLI -> from <name>`. Remote ACL
|
||||
permissions determine which commands the target accepts.
|
||||
|
||||
With no argument, `trace` uses the current `to` recipient. A name-prefix
|
||||
argument traces that contact directly without changing the current recipient.
|
||||
|
||||
@@ -132,13 +132,45 @@ to {name-prefix}
|
||||
```
|
||||
Sets the recipient to the _first_ matching contact (in 'list') by the name prefix. (ie. you don't have to type whole name)
|
||||
|
||||
```
|
||||
path
|
||||
```
|
||||
Shows the saved outgoing path for the current `to` recipient. This command and
|
||||
all path changes require a recipient to be selected first.
|
||||
|
||||
```
|
||||
path direct
|
||||
path clear
|
||||
path {hop-hash[,hop-hash...]}
|
||||
```
|
||||
Sets the outgoing path used by subsequent `login`, `send`, and `cmd` commands.
|
||||
`direct` selects a zero-hop route. `clear` forgets the saved route, causing the
|
||||
next operation to use flood routing and allowing normal path discovery to
|
||||
learn a replacement.
|
||||
|
||||
Explicit paths use comma-separated hop hashes. Each hop must contain exactly
|
||||
2, 4, or 6 hexadecimal digits, and every hop in one path must use the same
|
||||
width. Spaces around commas and hexadecimal letter case do not matter. The
|
||||
setting is saved with the selected contact.
|
||||
|
||||
For example:
|
||||
|
||||
```text
|
||||
to Hilltop Repeater
|
||||
path A1B2C3,D4E5F6
|
||||
path
|
||||
login my-admin-password
|
||||
```
|
||||
|
||||
```
|
||||
login {admin-password}
|
||||
```
|
||||
Sends a remote login request to the current recipient. Select a repeater,
|
||||
room, or other remotely managed node with `to {name-prefix}` first. The
|
||||
password is masked with `*` while it is entered and must be 1-15 UTF-8 bytes;
|
||||
longer passwords are rejected instead of truncated.
|
||||
longer passwords are rejected instead of truncated. Login uses the route shown
|
||||
by `path`: a known or explicitly set route is direct, while an unknown route is
|
||||
flooded.
|
||||
|
||||
Login results arrive asynchronously. A successful modern response displays
|
||||
the remote ACL permissions byte and server protocol level. A wrong password,
|
||||
@@ -219,7 +251,8 @@ eventually report a timeout.
|
||||
```
|
||||
reset path
|
||||
```
|
||||
Resets the path to current recipient, for new path discovery.
|
||||
Resets the path to current recipient, for new path discovery. This is retained
|
||||
as an alias for `path clear`.
|
||||
|
||||
```
|
||||
public {text}
|
||||
|
||||
Reference in new issue
Block a user