Skip to main content

Remote node administration

This feature will allow you to use the multiple channels feature to enable remote adminstration of meshtastic nodes. This will let you talk through the mesh to some far away node and change that node's settings. This is an advanced feature that (currently) few users would need. Also, keep in mind it is possible (if you are not careful) to assign settings to that remote node that cause it to completely drop off of your mesh.

Creating the admin channel#

By default, nodes will only respond to adminstrative commands via the local USB/bluetooth/TCP interface. This provides basic security to prevent unauthorized access. This is how normal administration and settings changes work. The only difference for the remote case is that we are sending those commands over the mesh.

Before a node will allow remote admin access, it must have a primary channel:

Expected output
$ meshtastic --infoConnected to radio...Channels:  PRIMARY psk=default { "modemConfig": "Bw125Cr48Sf4096", "psk": "AQ==" }Primary channel URL: https://www.meshtastic.org/d/#CgUYAyIBAQ

So from this output you see that this node knows about only one channel and that its PSK is set to the default value.

Now add an admin channel:

Command
meshtastic --ch-add admin
note

The name of the channel is important, it must be admin.

Your channels will now look like this:

Expected output
$ meshtastic --ch-add adminConnected to radioWriting modified channels to device$ meshtastic --infoConnected to radio...Channels:  PRIMARY psk=default { "modemConfig": "Bw125Cr48Sf4096", "psk": "AQ==" }  SECONDARY psk=secret { "psk": "HW7E3nMbiNbvr6MhsDonLCmj7eSAhttzjbIx/r5OQmg=", "name": "admin" }Primary channel URL: https://www.meshtastic.org/d/#CgUYAyIBAQComplete URL (includes all channels): https://www.meshtastic.org/d/#CgUYAyIBAQopIiAdbsTecxuI1u-voyGwOicsKaPt5ICG23ONsjH-vk5CaCoFYWRtaW4

Notice that now we have a new secondary channel. Also, the --info option prints out TWO URLs. The Complete URL includes all of the channels this node understands. You should consider this URL something you should be very cautious about sharing. In the case of remote adminstration, you only need the node you want to adminster and the node you are locally connected to know this new "admin" channel.

Sharing the admin channel with other nodes#

I'm going to assume you've already created the admin channel on your "local node" i.e. the meshtastic node sitting on your desk at your home. But now you want to enable access on the "remote node" you want to eventually have far away from you.

For this step you need physical access to both the nodes.

  1. Create the "admin" channel on the "local node" using the instructions above.
  2. Copy the "Complete URL" someplace for permanent reference/access.
  3. Connect to the "remote node" over the USB port.
  4. For the "remote node" type
    meshtastic --seturl the-url-from-step-2
  5. Run meshtastic --info and confirm that the "Complete URL" is the same for both of the nodes.

At this point you can take your remote node and install it far away and still be able to change any of its settings.

Remotely administering your node#

Now that both your local node and the remote node contain your secret admin channel key, you can do things like this:

Get the node list from the local node:

Expected output
$ meshtastic --nodesConnected to radio/-------------------------------------------------------------------------------------------------------------\|N|    User    |AKA|   ID    |Latitude|Longitude|Altitude|Battery|   SNR   |     LastHeard     |    Since     ||-+------------+---+---------+--------+---------+--------+-------+---------+-------------------+--------------||1|Unknown 9058|?58|!28979058|25.0382°|121.5731°|  N/A   |  N/A  |-13.50 dB|2021-03-22 09:25:42|19 seconds ago|\-------------------------------------------------------------------------------------------------------------/

Using the node ID from that list, send a message through the mesh telling that node to change its owner name.

Expected output
$ meshtastic --dest \!28979058 --set-owner "Im Remote"Connected to radioSetting device owner to Im RemoteINFO:root:Requesting configuration from remote node (this could take a while)
note

You will need to escape the ! using \! otherwise the command will fail.

And you can now confirm via the local node that the remote node has changed:

Expected output
$ meshtastic --nodes Connected to radio/----------------------------------------------------------------------------------------------------\|N|  User   |AKA|   ID    |        Position        |Battery|  SNR  |     LastHeard     |    Since    ||-+---------+---+---------+------------------------+-------+-------+-------------------+-------------||1|Im Remote|IR |!28979058|25.0382°, 121.5731°, N/A|  N/A  |8.75 dB|2021-03-22 09:35:42|3 minutes ago|\----------------------------------------------------------------------------------------------------/

Note: you can change any parameter, add channels or get info from the remote node. Here's an example of setting ls_secs and printing the complete device info from the remote node:

Expected output
$ meshtastic --dest \!28979058 --set ls_secs 301 --infoConnected to radioINFO:root:Requesting configuration from remote node (this could take a while)Set ls_secs to 301Writing modified preferences to devicePreferences: { "lsSecs": 301, "region": "TW" }Channels:  PRIMARY psk=default { "modemConfig": "Bw125Cr48Sf4096", "psk": "AQ==" }  SECONDARY psk=secret { "psk": "HW7E3nMbiNbvr6MhsDonLCmj7eSAhttzjbIx/r5OQmg=", "name": "admin" }Primary channel URL: https://www.meshtastic.org/d/#CgUYAyIBAQComplete URL (includes all channels): https://www.meshtastic.org/d/#CgUYAyIBAQopIiAdbsTecxuI1u-voyGwOicsKaPt5ICG23ONsjH-vk5CaCoFYWRtaW4

Areas for future development#

In the future we will add a "deadman timer" to this feature so that the remote node will revert any changes if you fail to send a special "commit changes" command. This will protect against sending bad settings to nodes that you can't physically access. Instead if the node does not receive a commit message within 10 minutes it will revert all changes and (hopefully) rejoin the mesh.