Skip to content

Commit 665a592

Browse files
committed
document channel_echoes
1 parent ae30ef7 commit 665a592

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,14 +142,17 @@ You'll get a prompt with the name of your node. From here you can type meshcore-
142142

143143
The `to` command is specific to chat mode, it lets you enter the recipient for next command. By default you're on your node but you can enter other nodes or public rooms. Here are some examples :
144144

145-
- `to <nodename>` : will enter nodename
145+
- `to <dest>` : will enter dest (node or channel)
146146
- `to /`, `to ~` : will go to the root (your node)
147147
- `to ..` : will go to the last node (it will switch between the two last nodes, this is just a 1-depth history)
148148
- `to !` : will switch to the node you received last message from
149149

150-
When you are connected to a node, the behaviour will depend on the node type, if you're on a chat node, it will send messages by default and you can chat. On a repeater or a room server, it will send commands (autocompletioin has been set to comply with the CommonCli class of meshcore). To send a message through a room you'll have to prefix the message with a quote or use the send command.
150+
When you are in a node, the behaviour will depend on the node type, if you're on a chat node, it will send messages by default and you can chat. On a repeater or a room server, it will send commands (autocompletion has been set to comply with the CommonCli class of meshcore). To send a message through a room you'll have to prefix the message with a quote or use the send command.
151151

152-
You can alse set a channel as recipient, `to public` will switch to the public channel, and `to ch1` to channel 1.
152+
The `/` character is used to bypass the node you have currently selected using `to`:
153+
- `/<cmd>` issues cmd command on the root
154+
`/<node>/<cmd>` will send cmd to selected node
155+
- `/<dest> <msg>` will send msg to dest (channel or node)
153156

154157
#### Flood Scope in interactive mode
155158

@@ -161,6 +164,14 @@ You can switch scope using the `scope` command, or postfixing the `to` command w
161164

162165
Scope can also be applied to a command using `%` before the scope name. For instance `login%#Morbihan` will limit diffusion of the login command (which is usually sent flood to get the path to a repeater) to the `#Morbihan` region.
163166

167+
#### Channel echoes
168+
169+
It's sometimes interesting to know the path taken by a message received from a channel or which repeaters have repeated a sent message.
170+
171+
The app give you the information by listening `rx_log` from the device, when obtained the information is attached to the message and can be read.
172+
173+
In meshcore-cli I went lower-level by implementing channel echoes. When activated (with `/set channel_echoes on`), all the channel messages will be printed on the terminal along with the SNR and path taken. When sending a message, you'll have all the repeats from 0-hop repeaters as echoes, and when a message is received, you should see information about the received message, but also all the instances of the same message that might have reached you from another path.
174+
164175
### Issuing batch commands to contacts with apply to
165176

166177
`apply_to <f> <cmd>` : applies cmd to contacts matching filter `<f>` it can be used to apply the same command to a pool of repeaters, or remove some contacts matching a condition.

0 commit comments

Comments
 (0)