firmware icon indicating copy to clipboard operation
firmware copied to clipboard

[Bug]: Documentation issue regarding channel keys

Open KyleMaas opened this issue 1 year ago • 3 comments

Category

Other

Hardware

Not Applicable

Firmware Version

2.3.6

Description

I'm not sure if this is the correct place to post this, but in the documentation for channel keys on this page:

https://meshtastic.org/docs/configuration/radio/channels/

...it refers to keys as 0, 16, or 32 bytes but doesn't specify how they're supposed to be entered. It has the hex version of the primary default channel ("0x01") right next to a Base64-encoded "AQ==" key but doesn't specify which one you're supposed to use. It took me a bit of trial and error to generate a 32 byte key, because I assumed it was probably hex and saving the channel would fail and not tell me why. Once I figured out I needed to Base64-encode it, everything worked fine, but there's nothing in the interface or the docs as far as I've found which tells you this is the format it expects.

Relevant log output

No response

KyleMaas avatar May 10 '24 18:05 KyleMaas

The apps are synced up so that you can paste keys between the iOS and android app, not sure any users can really type in base64, not sure how useful it is to put in a warning.

garthvh avatar May 11 '24 17:05 garthvh

I did. I wanted to generate my own keys, and was not using the app but the web UI. There was no error message when I used a key that was too long (hex on my first attempt, so more digits). Even just a quick clarification in the docs would have been exceptionally helpful.

KyleMaas avatar May 11 '24 21:05 KyleMaas

This issue has been mentioned on Meshtastic. There might be relevant details there:

https://meshtastic.discourse.group/t/sending-on-only-one-private-channel/14180/2

meshtastic-bot avatar Aug 09 '24 14:08 meshtastic-bot