diff --git a/faq/index.html b/faq/index.html index 07b7551e..d69cfda9 100644 --- a/faq/index.html +++ b/faq/index.html @@ -647,7 +647,7 @@ - 3.7. Q: My repeater maybe suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. what can I do? + 3.7. Q: My repeater maybe suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do? @@ -658,7 +658,7 @@ - 3.8 Q: How do I make my repeater an observer on the mesh + 3.8. Q: How do I make my repeater an observer on the mesh? @@ -1816,7 +1816,7 @@ - 3.7. Q: My repeater maybe suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. what can I do? + 3.7. Q: My repeater maybe suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do? @@ -1827,7 +1827,7 @@ - 3.8 Q: How do I make my repeater an observer on the mesh + 3.8. Q: How do I make my repeater an observer on the mesh? @@ -2586,8 +2586,8 @@
  • 3.4. Q: What is the password to join a room server?
  • 3.5. Q: Can I retrieve a repeater's private key or set a repeater's private key?
  • 3.6. Q: The first byte of my repeater's public key collides with an exisitng repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing?
    • -
  • 3.7. Q: My repeater maybe suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. what can I do?
    • -
  • 3.8 Q: How do I make my repeater an observer on the mesh
    • +
  • 3.7. Q: My repeater maybe suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do?
    • +
  • 3.8. Q: How do I make my repeater an observer on the mesh?
  • 4. T-Deck Related
  • 4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro?
  • 4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?
    • @@ -2777,12 +2777,12 @@ Advert means to advertise yourself on the network. In Reticulum terms it would b

    Reboot the repeater after set prv.key <hex> command for the new private key to take effect.

    3.6. Q: The first byte of my repeater's public key collides with an exisitng repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing?

    A: You can generate a new private key and specific the first byte of its public key here: https://gessaman.com/mc-keygen/

    -

    3.7. Q: My repeater maybe suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. what can I do?

    -

    A: This may be due to the SX1262 radio's auto gain control feature. You can use this command to preiodically reset its AGC.

    +

    3.7. Q: My repeater maybe suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do?

    +

    A: This may be due to the SX1262 radio's auto gain control feature. You can use this command to periodically reset its AGC.

    set agc.reset.interval <number>

    The <number> unit is in seconds and is incremented by 4. set agc.reset.interval 4 works well to cure deafness.

    This is a very low cost operation. AGC reset is done by simply setting state = STATE_IDLE; in function RadioLibWrapper::resetAGC() in RadioLibWrappers.cpp

    -

    3.8 Q: How do I make my repeater an observer on the mesh

    +

    3.8. Q: How do I make my repeater an observer on the mesh?

    A: The observer instruction is available here: https://analyzer.letsmesh.net/observer/onboard

    diff --git a/search/search_index.json b/search/search_index.json index fa64b37c..ffff9d6f 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Introduction","text":"

    Welcome to the MeshCore documentation.

    Below are a few quick start guides.

    If you find a mistake in any of our documentation, or find something is missing, please feel free to open a pull request for us to review.

    "},{"location":"cli_commands/","title":"CLI Commands","text":"

    This document provides an overview of CLI commands that can be sent to MeshCore Repeaters, Room Servers and Sensors.

    "},{"location":"cli_commands/#navigation","title":"Navigation","text":""},{"location":"cli_commands/#operational","title":"Operational","text":""},{"location":"cli_commands/#reboot-the-node","title":"Reboot the node","text":"

    Usage: - reboot

    "},{"location":"cli_commands/#reset-the-clock-and-reboot","title":"Reset the clock and reboot","text":"

    Usage: - clkreboot

    "},{"location":"cli_commands/#sync-the-clock-with-the-remote-device","title":"Sync the clock with the remote device","text":"

    Usage: - clock sync

    "},{"location":"cli_commands/#display-current-time-in-utc","title":"Display current time in UTC","text":"

    Usage: - clock

    "},{"location":"cli_commands/#set-the-time-to-a-specific-timestamp","title":"Set the time to a specific timestamp","text":"

    Usage: - time <epoch_seconds>

    Parameters: - epoc_seconds: Unix epoc time

    "},{"location":"cli_commands/#send-a-flood-advert","title":"Send a flood advert","text":"

    Usage: - advert

    "},{"location":"cli_commands/#start-an-over-the-air-ota-firmware-update","title":"Start an Over-The-Air (OTA) firmware update","text":"

    Usage: - start ota

    "},{"location":"cli_commands/#erasefactory-reset","title":"Erase/Factory Reset","text":"

    Usage: - erase

    Serial Only: Yes

    Warning: This is destructive!

    "},{"location":"cli_commands/#neighbors-repeater-only","title":"Neighbors (Repeater Only)","text":""},{"location":"cli_commands/#list-nearby-neighbors","title":"List nearby neighbors","text":"

    Usage: - neighbors

    Note: The output of this command is limited to the 8 most recent adverts.

    Note: Each line is encoded as {pubkey-prefix}:{timestamp}:{snr*4}

    "},{"location":"cli_commands/#remove-a-neighbor","title":"Remove a neighbor","text":"

    Usage: - neighbor.remove <pubkey_prefix>

    Parameters: - pubkey_prefix: The public key of the node to remove from the neighbors list

    "},{"location":"cli_commands/#statistics","title":"Statistics","text":""},{"location":"cli_commands/#clear-stats","title":"Clear Stats","text":"

    Usage: clear stats

    "},{"location":"cli_commands/#system-stats-battery-uptime-queue-length-and-debug-flags","title":"System Stats - Battery, Uptime, Queue Length and Debug Flags","text":"

    Usage: - stats-core

    Serial Only: Yes

    "},{"location":"cli_commands/#radio-stats-noise-floor-last-rssisnr-airtime-receive-errors","title":"Radio Stats - Noise floor, Last RSSI/SNR, Airtime, Receive errors","text":"

    Usage: stats-radio

    Serial Only: Yes

    "},{"location":"cli_commands/#packet-stats-packet-counters-received-sent","title":"Packet stats - Packet counters: Received, Sent","text":"

    Usage: stats-packets

    Serial Only: Yes

    "},{"location":"cli_commands/#logging","title":"Logging","text":""},{"location":"cli_commands/#begin-capture-of-rx-log-to-node-storage","title":"Begin capture of rx log to node storage","text":"

    Usage: log start

    "},{"location":"cli_commands/#end-capture-of-rx-log-to-node-sotrage","title":"End capture of rx log to node sotrage","text":"

    Usage: log stop

    "},{"location":"cli_commands/#erase-captured-log","title":"Erase captured log","text":"

    Usage: log erase

    "},{"location":"cli_commands/#print-the-captured-log-to-the-serial-terminal","title":"Print the captured log to the serial terminal","text":"

    Usage: log

    Serial Only: Yes

    "},{"location":"cli_commands/#info","title":"Info","text":""},{"location":"cli_commands/#get-the-version","title":"Get the Version","text":"

    Usage: ver

    "},{"location":"cli_commands/#show-the-hardware-name","title":"Show the hardware name","text":"

    Usage: board

    "},{"location":"cli_commands/#configuration","title":"Configuration","text":""},{"location":"cli_commands/#radio","title":"Radio","text":""},{"location":"cli_commands/#view-or-change-this-nodes-radio-parameters","title":"View or change this node's radio parameters","text":"

    Usage: - get radio - set radio <freq>,<bw>,<sf>,<cr>

    Parameters: - freq: Frequency in MHz - bw: Bandwidth in kHz - sf: Spreading factor (5-12) - cr: Coding rate (5-8)

    Set by build flag: LORA_FREQ, LORA_BW, LORA_SF, LORA_CR

    Default: 869.525,250,11,5

    Note: Requires reboot to apply

    "},{"location":"cli_commands/#view-or-change-this-nodes-transmit-power","title":"View or change this node's transmit power","text":"

    Usage: - get tx - set tx <dbm>

    Parameters: - dbm: Power level in dBm (1-22)

    Set by build flag: LORA_TX_POWER

    Default: Varies by board

    Notes: This setting only controls the power level of the LoRa chip. Some nodes have an additional power amplifier stage which increases the total output. Referr to the node's manual for the correct setting to use. Setting a value too high may violate the laws in your country.

    "},{"location":"cli_commands/#change-the-radio-parameters-for-a-set-duration","title":"Change the radio parameters for a set duration","text":"

    Usage: - tempradio <freq>,<bw>,<sf>,<cr>,<timeout_mins>

    Parameters: - freq: Frequency in MHz (300-2500) - bw: Bandwidth in kHz (7.8-500) - sf: Spreading factor (5-12) - cr: Coding rate (5-8) - timeout_mins: Duration in minutes (must be > 0)

    Note: This is not saved to preferences and will clear on reboot

    "},{"location":"cli_commands/#view-or-change-this-nodes-frequency","title":"View or change this node's frequency","text":"

    Usage: - get freq - set freq <frequency>

    Parameters: - frequency: Frequency in MHz

    Default: 869.525

    Note: Requires reboot to apply

    "},{"location":"cli_commands/#system","title":"System","text":""},{"location":"cli_commands/#view-or-change-this-nodes-name","title":"View or change this node's name","text":"

    Usage: - get name - set name <name>

    Parameters: - name: Node name

    Set by build flag: ADVERT_NAME

    Default: Varies by board

    Note: Max length varies. If a location is set, the max length is 24 bytes; 32 otherwise. Emoji and unicode characters may take more than one byte.

    "},{"location":"cli_commands/#view-or-change-this-nodes-latitude","title":"View or change this node's latitude","text":"

    Usage: - get lat - set lat <degrees>

    Set by build flag: ADVERT_LAT

    Default: 0

    Parameters: - degrees: Latitude in degrees

    "},{"location":"cli_commands/#view-or-change-this-nodes-longitude","title":"View or change this node's longitude","text":"

    Usage: - get lon - set lon <degrees>

    Set by build flag: ADVERT_LON

    Default: 0

    Parameters: - degrees: Longitude in degrees

    "},{"location":"cli_commands/#view-or-change-this-nodes-identity-private-key","title":"View or change this node's identity (Private Key)","text":"

    Usage: - get prv.key - set prv.key <private_key>

    Parameters: - private_key: Private key in hex format (64 hex characters)

    Serial Only: - get prv.key: Yes - set prv.key: No

    Note: Requires reboot to take effect after setting

    "},{"location":"cli_commands/#view-or-change-this-nodes-admin-password","title":"View or change this node's admin password","text":"

    Usage: - get password - set password <password>

    Parameters: - password: Admin password

    Set by build flag: ADMIN_PASSWORD

    Default: password

    Note: Echoed back for confirmation

    Note: Any node using this password will be added to the admin ACL list.

    "},{"location":"cli_commands/#view-or-change-this-nodes-guest-password","title":"View or change this node's guest password","text":"

    Usage: - get guest.password - set guest.password <password>

    Parameters: - password: Guest password

    Set by build flag: ROOM_PASSWORD (Room Server only)

    Default: <blank>

    "},{"location":"cli_commands/#view-or-change-this-nodes-owner-info","title":"View or change this node's owner info","text":"

    Usage: - get owner.info - set owner.info <text>

    Parameters: - text: Owner information text

    Default: <blank>

    Note: | characters are translated to newlines

    Note: Requires firmware 1.12.+

    "},{"location":"cli_commands/#fine-tune-the-battery-reading","title":"Fine-tune the battery reading","text":"

    Usage: - get adc.multiplier - set adc.multiplier <value>

    Parameters: - value: ADC multiplier (0.0-10.0)

    Default: 0.0 (value defined by board)

    Note: Returns \"Error: unsupported by this board\" if hardware doesn't support it

    "},{"location":"cli_commands/#view-or-change-this-nodes-power-saving-flag-repeater-only","title":"View or change this node's power saving flag (Repeater Only)","text":"

    Usage: - powersaving <state> - powersaving

    Parameters: - state: on|off

    Default: on

    Note: When enabled, device enters sleep mode between radio transmissions

    "},{"location":"cli_commands/#routing","title":"Routing","text":""},{"location":"cli_commands/#view-or-change-this-nodes-repeat-flag","title":"View or change this node's repeat flag","text":"

    Usage: - get repeat - set repeat <state>

    Parameters: - state: on|off

    Default: on

    "},{"location":"cli_commands/#view-or-change-the-retransmit-delay-factor-for-flood-traffic","title":"View or change the retransmit delay factor for flood traffic","text":"

    Usage: - get txdelay - set txdelay <value>

    Parameters: - value: Transmit delay factor (0-2)

    Default: 0.5

    "},{"location":"cli_commands/#view-or-change-the-retransmit-delay-factor-for-direct-traffic","title":"View or change the retransmit delay factor for direct traffic","text":"

    Usage: - get direct.txdelay - set direct.txdelay <value>

    Parameters: - value: Direct transmit delay factor (0-2)

    Default: 0.2

    "},{"location":"cli_commands/#experimental-view-or-change-the-processing-delay-for-received-traffic","title":"[Experimental] View or change the processing delay for received traffic","text":"

    Usage: - get rxdelay - set rxdelay <value>

    Parameters: - value: Receive delay base (0-20)

    Default: 0.0

    "},{"location":"cli_commands/#view-or-change-the-airtime-factor-duty-cycle-limit","title":"View or change the airtime factor (duty cycle limit)","text":"

    Usage: - get af - set af <value>

    Parameters: - value: Airtime factor (0-9)

    Default: 1.0

    "},{"location":"cli_commands/#view-or-change-the-local-interference-threshold","title":"View or change the local interference threshold","text":"

    Usage: - get int.thresh - set int.thresh <value>

    Parameters: - value: Interference threshold value

    Default: 0.0

    "},{"location":"cli_commands/#view-or-change-the-agc-reset-interval","title":"View or change the AGC Reset Interval","text":"

    Usage: - get agc.reset.interval - set agc.reset.interval <value>

    Parameters: - value: Interval in seconds rounded down to a multiple of 4 (17 becomes 16)

    Default: 0.0

    "},{"location":"cli_commands/#enable-or-disable-multi-acks-support","title":"Enable or disable Multi-Acks support","text":"

    Usage: - get multi.acks - set multi.acks <state>

    Parameters: - state: 0 (disable) or 1 (enable)

    Default: 0

    "},{"location":"cli_commands/#view-or-change-the-flood-advert-interval","title":"View or change the flood advert interval","text":"

    Usage: - get flood.advert.interval - set flood.advert.interval <hours>

    Parameters: - hours: Interval in hours (3-168)

    Default: 12 (Repeater) - 0 (Sensor)

    "},{"location":"cli_commands/#view-or-change-the-zero-hop-advert-interval","title":"View or change the zero-hop advert interval","text":"

    Usage: - get advert.interval - set advert.interval <minutes>

    Parameters: - minutes: Interval in minutes rounded down to the nearest multiple of 2 (61 becomes 60) (60-240)

    Default: 0

    "},{"location":"cli_commands/#limit-the-number-of-hops-for-a-flood-message","title":"Limit the number of hops for a flood message","text":"

    Usage: - get flood.max - set flood.max <value>

    Parameters: - value: Maximum flood hop count (0-64)

    Default: 64

    "},{"location":"cli_commands/#acl","title":"ACL","text":""},{"location":"cli_commands/#add-update-or-remove-permissions-for-a-companion","title":"Add, update or remove permissions for a companion","text":"

    Usage: - setperm <pubkey> <permissions>

    Parameters: - pubkey: Companion public key - permissions: - 0: Guest - 1: Read-only - 2: Read-write - 3: Admin

    Note: Removes the entry when permissions is omitted

    "},{"location":"cli_commands/#view-the-current-acl","title":"View the current ACL","text":"

    Usage: - get acl

    Serial Only: Yes

    "},{"location":"cli_commands/#view-or-change-this-room-servers-read-only-flag","title":"View or change this room server's 'read-only' flag","text":"

    Usage: - get allow.read.only - set allow.read.only <state>

    Parameters: - state: on (enable) or off (disable)

    Default: off

    "},{"location":"cli_commands/#region-management-v110","title":"Region Management (v1.10.+)","text":""},{"location":"cli_commands/#bulk-load-region-lists","title":"Bulk-load region lists","text":"

    Usage: - region load - region load <name> [flood_flag]

    Parameters: - name: A name of a region. * represents the wildcard region

    Note: flood_flag: Optional F to allow flooding

    Note: Indentation creates parent-child relationships (max 8 levels)

    Note: region load with an empty name will not work remotely (it's interactive)

    "},{"location":"cli_commands/#save-any-changes-to-regions-made-since-reboot","title":"Save any changes to regions made since reboot","text":"

    Usage: - region save

    "},{"location":"cli_commands/#allow-a-region","title":"Allow a region","text":"

    Usage: - region allowf <name>

    Parameters: - name: Region name (or * for wildcard)

    Note: Setting on wildcard * allows packets without region transport codes

    "},{"location":"cli_commands/#block-a-region","title":"Block a region","text":"

    Usage: - region denyf <name>

    Parameters: - name: Region name (or * for wildcard)

    Note: Setting on wildcard * drops packets without region transport codes

    "},{"location":"cli_commands/#show-information-for-a-region","title":"Show information for a region","text":"

    Usage: - region get <name>

    Parameters: - name: Region name (or * for wildcard)

    "},{"location":"cli_commands/#view-or-change-the-home-region-for-this-node","title":"View or change the home region for this node","text":"

    Usage: - region home - region home <name>

    Parameters: - name: Region name

    "},{"location":"cli_commands/#create-a-new-region","title":"Create a new region","text":"

    Usage: - region put <name> [parent_name]

    Parameters: - name: Region name - parent_name: Parent region name (optional, defaults to wildcard)

    "},{"location":"cli_commands/#remove-a-region","title":"Remove a region","text":"

    Usage: - region remove <name>

    Parameters: - name: Region name

    Note: Must remove all child regions before the region can be removed

    "},{"location":"cli_commands/#view-all-regions","title":"View all regions","text":"

    Usage: - region list <filter>

    Serial Only: Yes

    Parameters: - filter: allowed|denied

    Note: Requires firmware 1.12.+

    "},{"location":"cli_commands/#dump-all-defined-regions-and-flood-permissions","title":"Dump all defined regions and flood permissions","text":"

    Usage: - region

    Serial Only: Yes

    "},{"location":"cli_commands/#region-examples","title":"Region Examples","text":"

    Example 1: Using F Flag with Named Public Region

    region load\n#Europe F\n<blank line to end region load>\nregion save\n

    Explanation: - Creates a region named #Europe with flooding enabled - Packets from this region will be flooded to other nodes

    Example 2: Using Wildcard with F Flag

    region load \n* F\n<blank line to end region load>\nregion save\n

    Explanation: - Creates a wildcard region * with flooding enabled - Enables flooding for all regions automatically - Applies only to packets without transport codes

    Example 3: Using Wildcard Without F Flag

    region load \n*\n<blank line to end region load>\nregion save\n

    Explanation: - Creates a wildcard region * without flooding - This region exists but doesn't affect packet distribution - Used as a default/empty region

    Example 4: Nested Public Region with F Flag

    region load \n#Europe F\n  #UK\n    #London\n    #Manchester\n  #France\n    #Paris\n    #Lyon\n<blank line to end region load>\nregion save\n

    Explanation: - Creates #Europe region with flooding enabled - Adds nested child regions (#UK, #France) - All nested regions inherit the flooding flag from parent

    Example 5: Wildcard with Nested Public Regions

    region load \n* F\n  #NorthAmerica\n    #USA\n      #NewYork\n      #California\n    #Canada\n      #Ontario\n      #Quebec\n<blank line to end region load>\nregion save\n

    Explanation: - Creates wildcard region * with flooding enabled - Adds nested #NorthAmerica hierarchy - Enables flooding for all child regions automatically - Useful for global networks with specific regional rules

    "},{"location":"cli_commands/#gps-when-gps-support-is-compiled-in","title":"GPS (When GPS support is compiled in)","text":""},{"location":"cli_commands/#view-or-change-gps-state","title":"View or change GPS state","text":"

    Usage: - gps - gps <state>

    Parameters: - state: on|off

    Default: off

    Note: Output format: {status}, {fix}, {sat count} (when enabled)

    "},{"location":"cli_commands/#sync-this-nodes-clock-with-gps-time","title":"Sync this node's clock with GPS time","text":"

    Usage: - gps sync

    "},{"location":"cli_commands/#set-this-nodes-location-based-on-the-gps-coordinates","title":"Set this node's location based on the GPS coordinates","text":"

    Usage: - gps setloc

    "},{"location":"cli_commands/#view-or-change-the-gps-advert-policy","title":"View or change the GPS advert policy","text":"

    Usage: - gps advert - gps advert <policy>

    Parameters: - policy: none|shared|prefs - none: don't include location in adverts - share: share gps location (from SensorManager) - prefs: location stored in node's lat and lon settings

    Default: prefs

    "},{"location":"cli_commands/#sensors-when-sensor-support-is-compiled-in","title":"Sensors (When sensor support is compiled in)","text":""},{"location":"cli_commands/#view-the-list-of-sensors-on-this-node","title":"View the list of sensors on this node","text":"

    Usage: sensor list [start]

    Parameters: - start: Optional starting index (defaults to 0)

    Note: Output format: <var_name>=<value>\\n

    "},{"location":"cli_commands/#view-or-change-thevalue-of-a-sensor","title":"View or change thevalue of a sensor","text":"

    Usage: - sensor get <key> - sensor set <key> <value>

    Parameters: - key: Sensor setting name - value: The value to set the sensor to

    "},{"location":"cli_commands/#bridge-when-bridge-support-is-compiled-in","title":"Bridge (When bridge support is compiled in)","text":""},{"location":"cli_commands/#view-or-change-the-bridge-enabled-flag","title":"View or change the bridge enabled flag","text":"

    Usage: - get bridge.enabled - set bridge.enabled <state>

    Parameters: - state: on|off

    Default: off

    "},{"location":"cli_commands/#view-the-bridge-source","title":"View the bridge source","text":"

    Usage: - get bridge.source

    "},{"location":"cli_commands/#add-a-delay-to-packets-routed-through-this-bridge","title":"Add a delay to packets routed through this bridge","text":"

    Usage: - get bridge.delay - set bridge.delay <ms>

    Parameters: - ms: Delay in milliseconds (0-10000)

    Default: 500

    "},{"location":"cli_commands/#view-or-change-the-source-of-packets-bridged-to-the-external-interface","title":"View or change the source of packets bridged to the external interface","text":"

    Usage: - get bridge.source - set bridge.source <source>

    Parameters: - source: - rx: bridges received packets - tx: bridges transmitted packets

    Default: tx

    "},{"location":"cli_commands/#view-or-change-the-speed-of-the-bridge-rs-232-only","title":"View or change the speed of the bridge (RS-232 only)","text":"

    Usage: - get bridge.baud - set bridge.baud <rate>

    Parameters: - rate: Baud rate (9600, 19200, 38400, 57600, or 115200)

    Default: 115200

    "},{"location":"cli_commands/#view-or-change-the-channel-used-for-bridging-espnow-only","title":"View or change the channel used for bridging (ESPNow only)","text":"

    Usage: - get bridge.channel - set bridge.channel <channel>

    Parameters: - channel: Channel number (1-14)

    "},{"location":"cli_commands/#set-the-esp-now-secret","title":"Set the ESP-Now secret","text":"

    Usage: - get bridge.secret - set bridge.secret <secret>

    Parameters: - secret: 16-character encryption secret

    Default: Varies by board

    "},{"location":"companion_protocol/","title":"Companion Protocol","text":"

    NOTE: This document is still in development. Some information may be inaccurate.

    This document provides a comprehensive guide for communicating with MeshCore devices over Bluetooth Low Energy (BLE).

    It is platform-agnostic and can be used for Android, iOS, Python, JavaScript, or any other platform that supports BLE.

    "},{"location":"companion_protocol/#official-libraries","title":"Official Libraries","text":"

    Please see the following repos for existing MeshCore Companion Protocol libraries.

    "},{"location":"companion_protocol/#important-security-note","title":"Important Security Note","text":"

    All secrets, hashes, and cryptographic values shown in this guide are example values only.

    "},{"location":"companion_protocol/#table-of-contents","title":"Table of Contents","text":"
    1. BLE Connection
    2. Packet Structure
    3. Commands
    4. Channel Management
    5. Message Handling
    6. Response Parsing
    7. Example Implementation Flow
    8. Best Practices
    9. Troubleshooting
    "},{"location":"companion_protocol/#ble-connection","title":"BLE Connection","text":""},{"location":"companion_protocol/#service-and-characteristics","title":"Service and Characteristics","text":"

    MeshCore Companion devices expose a BLE service with the following UUIDs:

    "},{"location":"companion_protocol/#connection-steps","title":"Connection Steps","text":"

    1. Scan for Devices

    2. Connect to GATT

    3. Discover Services and Characteristics

    4. Enable Notifications

    5. Send Initial Commands

    Note: MeshCore devices may disconnect after periods of inactivity. Implement auto-reconnect logic with exponential backoff.

    "},{"location":"companion_protocol/#ble-write-type","title":"BLE Write Type","text":"

    When writing commands to the RX characteristic, specify the write type:

    Platform-specific:

    Recommendation: Use write with response for reliability.

    "},{"location":"companion_protocol/#mtu-maximum-transmission-unit","title":"MTU (Maximum Transmission Unit)","text":"

    The default BLE MTU is 23 bytes (20 bytes payload). For larger commands like SET_CHANNEL (66 bytes), you may need to:

    1. Request Larger MTU: Request MTU of 512 bytes if supported
    "},{"location":"companion_protocol/#command-sequencing","title":"Command Sequencing","text":"

    Critical: Commands must be sent in the correct sequence:

    1. After Connection:

    2. Command-Response Matching:

    "},{"location":"companion_protocol/#command-queue-management","title":"Command Queue Management","text":"

    For reliable operation, implement a command queue.

    Queue Structure:

    Error Handling:

    "},{"location":"companion_protocol/#packet-structure","title":"Packet Structure","text":"

    The MeshCore protocol uses a binary format with the following structure:

    Most packets follow this format:

    [Packet Type (1 byte)] [Data (variable length)]\n

    The first byte indicates the packet type (see Response Parsing).

    "},{"location":"companion_protocol/#commands","title":"Commands","text":""},{"location":"companion_protocol/#1-app-start","title":"1. App Start","text":"

    Purpose: Initialize communication with the device. Must be sent first after connection.

    Command Format:

    Byte 0: 0x01\nByte 1: 0x03\nBytes 2-10: \"mccli\" (ASCII, null-padded to 9 bytes)\n

    Example (hex):

    01 03 6d 63 63 6c 69 00 00 00 00\n

    Response: PACKET_OK (0x00)

    "},{"location":"companion_protocol/#2-device-query","title":"2. Device Query","text":"

    Purpose: Query device information.

    Command Format:

    Byte 0: 0x16\nByte 1: 0x03\n

    Example (hex):

    16 03\n

    Response: PACKET_DEVICE_INFO (0x0D) with device information

    "},{"location":"companion_protocol/#3-get-channel-info","title":"3. Get Channel Info","text":"

    Purpose: Retrieve information about a specific channel.

    Command Format:

    Byte 0: 0x1F\nByte 1: Channel Index (0-7)\n

    Example (get channel 1):

    1F 01\n

    Response: PACKET_CHANNEL_INFO (0x12) with channel details

    Note: The device does not return channel secrets for security reasons. Store secrets locally when creating channels.

    "},{"location":"companion_protocol/#4-set-channel","title":"4. Set Channel","text":"

    Purpose: Create or update a channel on the device.

    Command Format:

    Byte 0: 0x20\nByte 1: Channel Index (0-7)\nBytes 2-33: Channel Name (32 bytes, UTF-8, null-padded)\nBytes 34-65: Secret (32 bytes)\n

    Total Length: 66 bytes

    Channel Index: - Index 0: Reserved for public channels (no secret) - Indices 1-7: Available for private channels

    Channel Name: - UTF-8 encoded - Maximum 32 bytes - Padded with null bytes (0x00) if shorter

    Secret Field (32 bytes): - For private channels: 32-byte secret - For public channels: All zeros (0x00)

    Example (create channel \"YourChannelName\" at index 1 with secret):

    20 01 53 4D 53 00 00 ... (name padded to 32 bytes)\n    [32 bytes of secret]\n

    Response: PACKET_OK (0x00) on success, PACKET_ERROR (0x01) on failure

    "},{"location":"companion_protocol/#5-send-channel-message","title":"5. Send Channel Message","text":"

    Purpose: Send a text message to a channel.

    Command Format:

    Byte 0: 0x03\nByte 1: 0x00\nByte 2: Channel Index (0-7)\nBytes 3-6: Timestamp (32-bit little-endian Unix timestamp, seconds)\nBytes 7+: Message Text (UTF-8, variable length)\n

    Timestamp: Unix timestamp in seconds (32-bit unsigned integer, little-endian)

    Example (send \"Hello\" to channel 1 at timestamp 1234567890):

    03 00 01 D2 02 96 49 48 65 6C 6C 6F\n

    Response: PACKET_MSG_SENT (0x06) on success

    "},{"location":"companion_protocol/#6-get-message","title":"6. Get Message","text":"

    Purpose: Request the next queued message from the device.

    Command Format:

    Byte 0: 0x0A\n

    Example (hex):

    0A\n

    Response: - PACKET_CHANNEL_MSG_RECV (0x08) or PACKET_CHANNEL_MSG_RECV_V3 (0x11) for channel messages - PACKET_CONTACT_MSG_RECV (0x07) or PACKET_CONTACT_MSG_RECV_V3 (0x10) for contact messages - PACKET_NO_MORE_MSGS (0x0A) if no messages available

    Note: Poll this command periodically to retrieve queued messages. The device may also send PACKET_MESSAGES_WAITING (0x83) as a notification when messages are available.

    "},{"location":"companion_protocol/#7-get-battery","title":"7. Get Battery","text":"

    Purpose: Query device battery level.

    Command Format:

    Byte 0: 0x14\n

    Example (hex):

    14\n

    Response: PACKET_BATTERY (0x0C) with battery percentage

    "},{"location":"companion_protocol/#channel-management","title":"Channel Management","text":""},{"location":"companion_protocol/#channel-types","title":"Channel Types","text":"
    1. Public Channel
    2. Hashtag Channels
    3. Private Channels
    "},{"location":"companion_protocol/#channel-lifecycle","title":"Channel Lifecycle","text":"
    1. Set Channel:
    2. Get Channel:
    3. Delete Channel:
    "},{"location":"companion_protocol/#message-handling","title":"Message Handling","text":""},{"location":"companion_protocol/#receiving-messages","title":"Receiving Messages","text":"

    Messages are received via the RX characteristic (notifications). The device sends:

    1. Channel Messages:
    2. PACKET_CHANNEL_MSG_RECV (0x08) - Standard format

    3. PACKET_CHANNEL_MSG_RECV_V3 (0x11) - Version 3 with SNR

    4. Contact Messages:

    5. PACKET_CONTACT_MSG_RECV (0x07) - Standard format

    6. PACKET_CONTACT_MSG_RECV_V3 (0x10) - Version 3 with SNR

    7. Notifications:

    8. PACKET_MESSAGES_WAITING (0x83) - Indicates messages are queued
    "},{"location":"companion_protocol/#contact-message-format","title":"Contact Message Format","text":"

    Standard Format (PACKET_CONTACT_MSG_RECV, 0x07):

    Byte 0: 0x07 (packet type)\nBytes 1-6: Public Key Prefix (6 bytes, hex)\nByte 7: Path Length\nByte 8: Text Type\nBytes 9-12: Timestamp (32-bit little-endian)\nBytes 13-16: Signature (4 bytes, only if txt_type == 2)\nBytes 17+: Message Text (UTF-8)\n

    V3 Format (PACKET_CONTACT_MSG_RECV_V3, 0x10):

    Byte 0: 0x10 (packet type)\nByte 1: SNR (signed byte, multiplied by 4)\nBytes 2-3: Reserved\nBytes 4-9: Public Key Prefix (6 bytes, hex)\nByte 10: Path Length\nByte 11: Text Type\nBytes 12-15: Timestamp (32-bit little-endian)\nBytes 16-19: Signature (4 bytes, only if txt_type == 2)\nBytes 20+: Message Text (UTF-8)\n

    Parsing Pseudocode:

    def parse_contact_message(data):\n    packet_type = data[0]\n    offset = 1\n\n    # Check for V3 format\n    if packet_type == 0x10:  # V3\n        snr_byte = data[offset]\n        snr = ((snr_byte if snr_byte < 128 else snr_byte - 256) / 4.0)\n        offset += 3  # Skip SNR + reserved\n\n    pubkey_prefix = data[offset:offset+6].hex()\n    offset += 6\n\n    path_len = data[offset]\n    txt_type = data[offset + 1]\n    offset += 2\n\n    timestamp = int.from_bytes(data[offset:offset+4], 'little')\n    offset += 4\n\n    # If txt_type == 2, skip 4-byte signature\n    if txt_type == 2:\n        offset += 4\n\n    message = data[offset:].decode('utf-8')\n\n    return {\n        'pubkey_prefix': pubkey_prefix,\n        'path_len': path_len,\n        'txt_type': txt_type,\n        'timestamp': timestamp,\n        'message': message,\n        'snr': snr if packet_type == 0x10 else None\n    }\n
    "},{"location":"companion_protocol/#channel-message-format","title":"Channel Message Format","text":"

    Standard Format (PACKET_CHANNEL_MSG_RECV, 0x08):

    Byte 0: 0x08 (packet type)\nByte 1: Channel Index (0-7)\nByte 2: Path Length\nByte 3: Text Type\nBytes 4-7: Timestamp (32-bit little-endian)\nBytes 8+: Message Text (UTF-8)\n

    V3 Format (PACKET_CHANNEL_MSG_RECV_V3, 0x11):

    Byte 0: 0x11 (packet type)\nByte 1: SNR (signed byte, multiplied by 4)\nBytes 2-3: Reserved\nByte 4: Channel Index (0-7)\nByte 5: Path Length\nByte 6: Text Type\nBytes 7-10: Timestamp (32-bit little-endian)\nBytes 11+: Message Text (UTF-8)\n

    Parsing Pseudocode:

    def parse_channel_message(data):\n    packet_type = data[0]\n    offset = 1\n\n    # Check for V3 format\n    if packet_type == 0x11:  # V3\n        snr_byte = data[offset]\n        snr = ((snr_byte if snr_byte < 128 else snr_byte - 256) / 4.0)\n        offset += 3  # Skip SNR + reserved\n\n    channel_idx = data[offset]\n    path_len = data[offset + 1]\n    txt_type = data[offset + 2]\n    timestamp = int.from_bytes(data[offset+3:offset+7], 'little')\n    message = data[offset+7:].decode('utf-8')\n\n    return {\n        'channel_idx': channel_idx,\n        'timestamp': timestamp,\n        'message': message,\n        'snr': snr if packet_type == 0x11 else None\n    }\n
    "},{"location":"companion_protocol/#sending-messages","title":"Sending Messages","text":"

    Use the SEND_CHANNEL_MESSAGE command (see Commands).

    Important: - Messages are limited to 133 characters per MeshCore specification - Long messages should be split into chunks - Include a chunk indicator (e.g., \"[1/3] message text\")

    "},{"location":"companion_protocol/#response-parsing","title":"Response Parsing","text":""},{"location":"companion_protocol/#packet-types","title":"Packet Types","text":"Value Name Description 0x00 PACKET_OK Command succeeded 0x01 PACKET_ERROR Command failed 0x02 PACKET_CONTACT_START Start of contact list 0x03 PACKET_CONTACT Contact information 0x04 PACKET_CONTACT_END End of contact list 0x05 PACKET_SELF_INFO Device self-information 0x06 PACKET_MSG_SENT Message sent confirmation 0x07 PACKET_CONTACT_MSG_RECV Contact message (standard) 0x08 PACKET_CHANNEL_MSG_RECV Channel message (standard) 0x09 PACKET_CURRENT_TIME Current time response 0x0A PACKET_NO_MORE_MSGS No more messages available 0x0C PACKET_BATTERY Battery level 0x0D PACKET_DEVICE_INFO Device information 0x10 PACKET_CONTACT_MSG_RECV_V3 Contact message (V3 with SNR) 0x11 PACKET_CHANNEL_MSG_RECV_V3 Channel message (V3 with SNR) 0x12 PACKET_CHANNEL_INFO Channel information 0x80 PACKET_ADVERTISEMENT Advertisement packet 0x82 PACKET_ACK Acknowledgment 0x83 PACKET_MESSAGES_WAITING Messages waiting notification 0x88 PACKET_LOG_DATA RF log data (can be ignored)"},{"location":"companion_protocol/#parsing-responses","title":"Parsing Responses","text":"

    PACKET_OK (0x00):

    Byte 0: 0x00\nBytes 1-4: Optional value (32-bit little-endian integer)\n

    PACKET_ERROR (0x01):

    Byte 0: 0x01\nByte 1: Error code (optional)\n

    PACKET_CHANNEL_INFO (0x12):

    Byte 0: 0x12\nByte 1: Channel Index\nBytes 2-33: Channel Name (32 bytes, null-terminated)\nBytes 34-65: Secret (32 bytes, but device typically only returns 20 bytes total)\n

    Note: The device may not return the full 66-byte packet. Parse what is available. The secret field is typically not returned for security reasons.

    PACKET_DEVICE_INFO (0x0D):

    Byte 0: 0x0D\nByte 1: Firmware Version (uint8)\nBytes 2+: Variable length based on firmware version\n\nFor firmware version >= 3:\nByte 2: Max Contacts Raw (uint8, actual = value * 2)\nByte 3: Max Channels (uint8)\nBytes 4-7: BLE PIN (32-bit little-endian)\nBytes 8-19: Firmware Build (12 bytes, UTF-8, null-padded)\nBytes 20-59: Model (40 bytes, UTF-8, null-padded)\nBytes 60-79: Version (20 bytes, UTF-8, null-padded)\n

    Parsing Pseudocode:

    def parse_device_info(data):\n    if len(data) < 2:\n        return None\n\n    fw_ver = data[1]\n    info = {'fw_ver': fw_ver}\n\n    if fw_ver >= 3 and len(data) >= 80:\n        info['max_contacts'] = data[2] * 2\n        info['max_channels'] = data[3]\n        info['ble_pin'] = int.from_bytes(data[4:8], 'little')\n        info['fw_build'] = data[8:20].decode('utf-8').rstrip('\\x00').strip()\n        info['model'] = data[20:60].decode('utf-8').rstrip('\\x00').strip()\n        info['ver'] = data[60:80].decode('utf-8').rstrip('\\x00').strip()\n\n    return info\n

    PACKET_BATTERY (0x0C):

    Byte 0: 0x0C\nBytes 1-2: Battery Level (16-bit little-endian, percentage 0-100)\n\nOptional (if data size > 3):\nBytes 3-6: Used Storage (32-bit little-endian, KB)\nBytes 7-10: Total Storage (32-bit little-endian, KB)\n

    Parsing Pseudocode:

    def parse_battery(data):\n    if len(data) < 3:\n        return None\n\n    level = int.from_bytes(data[1:3], 'little')\n    info = {'level': level}\n\n    if len(data) > 3:\n        used_kb = int.from_bytes(data[3:7], 'little')\n        total_kb = int.from_bytes(data[7:11], 'little')\n        info['used_kb'] = used_kb\n        info['total_kb'] = total_kb\n\n    return info\n

    PACKET_SELF_INFO (0x05):

    Byte 0: 0x05\nByte 1: Advertisement Type\nByte 2: TX Power\nByte 3: Max TX Power\nBytes 4-35: Public Key (32 bytes, hex)\nBytes 36-39: Advertisement Latitude (32-bit little-endian, divided by 1e6)\nBytes 40-43: Advertisement Longitude (32-bit little-endian, divided by 1e6)\nByte 44: Multi ACKs\nByte 45: Advertisement Location Policy\nByte 46: Telemetry Mode (bitfield)\nByte 47: Manual Add Contacts (bool)\nBytes 48-51: Radio Frequency (32-bit little-endian, divided by 1000.0)\nBytes 52-55: Radio Bandwidth (32-bit little-endian, divided by 1000.0)\nByte 56: Radio Spreading Factor\nByte 57: Radio Coding Rate\nBytes 58+: Device Name (UTF-8, variable length, null-terminated)\n

    Parsing Pseudocode:

    def parse_self_info(data):\n    if len(data) < 36:\n        return None\n\n    offset = 1\n    info = {\n        'adv_type': data[offset],\n        'tx_power': data[offset + 1],\n        'max_tx_power': data[offset + 2],\n        'public_key': data[offset + 3:offset + 35].hex()\n    }\n    offset += 35\n\n    lat = int.from_bytes(data[offset:offset+4], 'little') / 1e6\n    lon = int.from_bytes(data[offset+4:offset+8], 'little') / 1e6\n    info['adv_lat'] = lat\n    info['adv_lon'] = lon\n    offset += 8\n\n    info['multi_acks'] = data[offset]\n    info['adv_loc_policy'] = data[offset + 1]\n    telemetry_mode = data[offset + 2]\n    info['telemetry_mode_env'] = (telemetry_mode >> 4) & 0b11\n    info['telemetry_mode_loc'] = (telemetry_mode >> 2) & 0b11\n    info['telemetry_mode_base'] = telemetry_mode & 0b11\n    info['manual_add_contacts'] = data[offset + 3] > 0\n    offset += 4\n\n    freq = int.from_bytes(data[offset:offset+4], 'little') / 1000.0\n    bw = int.from_bytes(data[offset+4:offset+8], 'little') / 1000.0\n    info['radio_freq'] = freq\n    info['radio_bw'] = bw\n    info['radio_sf'] = data[offset + 8]\n    info['radio_cr'] = data[offset + 9]\n    offset += 10\n\n    if offset < len(data):\n        name_bytes = data[offset:]\n        info['name'] = name_bytes.decode('utf-8').rstrip('\\x00').strip()\n\n    return info\n

    PACKET_MSG_SENT (0x06):

    Byte 0: 0x06\nByte 1: Message Type\nBytes 2-5: Expected ACK (4 bytes, hex)\nBytes 6-9: Suggested Timeout (32-bit little-endian, seconds)\n

    PACKET_ACK (0x82):

    Byte 0: 0x82\nBytes 1-6: ACK Code (6 bytes, hex)\n
    "},{"location":"companion_protocol/#error-codes","title":"Error Codes","text":"

    PACKET_ERROR (0x01) may include an error code in byte 1:

    Error Code Description 0x00 Generic error (no specific code) 0x01 Invalid command 0x02 Invalid parameter 0x03 Channel not found 0x04 Channel already exists 0x05 Channel index out of range 0x06 Secret mismatch 0x07 Message too long 0x08 Device busy 0x09 Not enough storage

    Note: Error codes may vary by firmware version. Always check byte 1 of PACKET_ERROR response.

    "},{"location":"companion_protocol/#partial-packet-handling","title":"Partial Packet Handling","text":"

    BLE notifications may arrive in chunks, especially for larger packets. Implement buffering:

    Implementation:

    class PacketBuffer:\n    def __init__(self):\n        self.buffer = bytearray()\n        self.expected_length = None\n\n    def add_data(self, data):\n        self.buffer.extend(data)\n\n        # Check if we have a complete packet\n        if len(self.buffer) >= 1:\n            packet_type = self.buffer[0]\n\n            # Determine expected length based on packet type\n            expected = self.get_expected_length(packet_type)\n\n            if expected is not None and len(self.buffer) >= expected:\n                # Complete packet\n                packet = bytes(self.buffer[:expected])\n                self.buffer = self.buffer[expected:]\n                return packet\n            elif expected is None:\n                # Variable length packet - try to parse what we have\n                # Some packets have minimum length requirements\n                if self.can_parse_partial(packet_type):\n                    return self.try_parse_partial()\n\n        return None  # Incomplete packet\n\n    def get_expected_length(self, packet_type):\n        # Fixed-length packets\n        fixed_lengths = {\n            0x00: 5,  # PACKET_OK (minimum)\n            0x01: 2,  # PACKET_ERROR (minimum)\n            0x0A: 1,  # PACKET_NO_MORE_MSGS\n            0x14: 3,  # PACKET_BATTERY (minimum)\n        }\n        return fixed_lengths.get(packet_type)\n\n    def can_parse_partial(self, packet_type):\n        # Some packets can be parsed partially\n        return packet_type in [0x12, 0x08, 0x11, 0x07, 0x10, 0x05, 0x0D]\n\n    def try_parse_partial(self):\n        # Try to parse with available data\n        # Return packet if successfully parsed, None otherwise\n        # This is packet-type specific\n        pass\n

    Usage:

    buffer = PacketBuffer()\n\ndef on_notification_received(data):\n    packet = buffer.add_data(data)\n    if packet:\n        parse_and_handle_packet(packet)\n
    "},{"location":"companion_protocol/#response-handling","title":"Response Handling","text":"
    1. Command-Response Pattern:
    2. Send command via TX characteristic
    3. Wait for response via RX characteristic (notification)
    4. Match response to command using sequence numbers or command type
    5. Handle timeout (typically 5 seconds)

    6. Use command queue to prevent concurrent commands

    7. Asynchronous Messages:

    8. Device may send messages at any time via RX characteristic
    9. Handle PACKET_MESSAGES_WAITING (0x83) by polling GET_MESSAGE command
    10. Parse incoming messages and route to appropriate handlers

    11. Buffer partial packets until complete

    12. Response Matching:

    13. Match responses to commands by expected packet type:

    14. Timeout Handling:

    15. Default timeout: 5 seconds per command
    16. On timeout: Log error, clear current command, proceed to next in queue
    17. Some commands may take longer (e.g., SET_CHANNEL may need 1-2 seconds)

    18. Consider longer timeout for channel operations

    19. Error Recovery:

    20. On PACKET_ERROR: Log error code, clear current command
    21. On connection loss: Clear command queue, attempt reconnection
    22. On invalid response: Log warning, clear current command, proceed
    "},{"location":"companion_protocol/#example-implementation-flow","title":"Example Implementation Flow","text":""},{"location":"companion_protocol/#initialization","title":"Initialization","text":"
    # 1. Scan for MeshCore device\ndevice = scan_for_device(\"MeshCore\")\n\n# 2. Connect to BLE GATT\ngatt = connect_to_device(device)\n\n# 3. Discover services and characteristics\nservice = discover_service(gatt, \"0000ff00-0000-1000-8000-00805f9b34fb\")\nrx_char = discover_characteristic(service, \"0000ff01-0000-1000-8000-00805f9b34fb\")\ntx_char = discover_characteristic(service, \"0000ff02-0000-1000-8000-00805f9b34fb\")\n\n# 4. Enable notifications on RX characteristic\nenable_notifications(rx_char, on_notification_received)\n\n# 5. Send AppStart command\nsend_command(tx_char, build_app_start())\nwait_for_response(PACKET_OK)\n
    "},{"location":"companion_protocol/#creating-a-private-channel","title":"Creating a Private Channel","text":"
    # 1. Generate 16-byte secret\nsecret_16_bytes = generate_secret(16)  # Use CSPRNG\nsecret_hex = secret_16_bytes.hex()\n\n# 2. Expand secret to 32 bytes using SHA-512\nimport hashlib\nsha512_hash = hashlib.sha512(secret_16_bytes).digest()\nsecret_32_bytes = sha512_hash[:32]\n\n# 3. Build SET_CHANNEL command\nchannel_name = \"YourChannelName\"\nchannel_index = 1  # Use 1-7 for private channels\ncommand = build_set_channel(channel_index, channel_name, secret_32_bytes)\n\n# 4. Send command\nsend_command(tx_char, command)\nresponse = wait_for_response(PACKET_OK)\n\n# 5. Store secret locally (device won't return it)\nstore_channel_secret(channel_index, secret_hex)\n
    "},{"location":"companion_protocol/#sending-a-message","title":"Sending a Message","text":"
    # 1. Build channel message command\nchannel_index = 1\nmessage = \"Hello, MeshCore!\"\ntimestamp = int(time.time())\ncommand = build_channel_message(channel_index, message, timestamp)\n\n# 2. Send command\nsend_command(tx_char, command)\nresponse = wait_for_response(PACKET_MSG_SENT)\n
    "},{"location":"companion_protocol/#receiving-messages_1","title":"Receiving Messages","text":"
    def on_notification_received(data):\n    packet_type = data[0]\n\n    if packet_type == PACKET_CHANNEL_MSG_RECV or packet_type == PACKET_CHANNEL_MSG_RECV_V3:\n        message = parse_channel_message(data)\n        handle_channel_message(message)\n    elif packet_type == PACKET_MESSAGES_WAITING:\n        # Poll for messages\n        send_command(tx_char, build_get_message())\n
    "},{"location":"companion_protocol/#best-practices","title":"Best Practices","text":"
    1. Connection Management:
    2. Implement auto-reconnect with exponential backoff
    3. Handle disconnections gracefully

    4. Store last connected device address for quick reconnection

    5. Secret Management:

    6. Always use cryptographically secure random number generators
    7. Store secrets securely (encrypted storage)

    8. Never log or transmit secrets in plain text

    9. Message Handling:

    10. Send CMD_SYNC_NEXT_MESSAGE when PUSH_CODE_MSG_WAITING is received

    11. Implement message deduplication to avoid display the same message twice

    12. Channel Management:

    13. Error Handling:

    14. Implement timeouts for all commands (typically 5 seconds)
    15. Handle RESP_CODE_ERR responses appropriately
    "},{"location":"companion_protocol/#troubleshooting","title":"Troubleshooting","text":""},{"location":"companion_protocol/#connection-issues","title":"Connection Issues","text":""},{"location":"companion_protocol/#command-issues","title":"Command Issues","text":""},{"location":"companion_protocol/#message-issues","title":"Message Issues","text":""},{"location":"docs/","title":"Local Documentation","text":"

    This document explains how to build and view the MeshCore documentation locally.

    "},{"location":"docs/#building-and-viewing-docs","title":"Building and viewing Docs","text":"
    pip install mkdocs\npip install mkdocs-material\n
    "},{"location":"faq/","title":"Frequently Asked Questions","text":"

    A list of frequently-asked questions and answers for MeshCore

    "},{"location":"faq/#1-introduction","title":"1. Introduction","text":""},{"location":"faq/#11-q-what-is-meshcore","title":"1.1. Q: What is MeshCore?","text":"

    A: MeshCore is a multi platform system for enabling secure text based communications utilising LoRa radio hardware. It can be used for Off-Grid Communication, Emergency Response & Disaster Recovery, Outdoor Activities, Tactical Security including law enforcement and private security and also IoT sensor networks. (source)

    MeshCore is free and open source: * MeshCore is the routing and firmware etc, available on GitHub under MIT license * There are clients made by the community, such as the web clients, these are free to use, and some are open source too * The cross platform mobile app developed by Liam Cottle for Android/iOS/PC etc is free to download and use * The T-Deck firmware is developed by Scott at Ripple Radios, the creator of MeshCore, is also free to flash on your devices and use

    Some more advanced, but optional features are available on T-Deck if you register your device for a key to unlock. On the MeshCore smartphone clients for Android and iOS/iPadOS, you can unlock the wait timer for repeater and room server remote management over RF feature.

    These features are completely optional and aren't needed for the core messaging experience. They're like super bonus features and to help the developers continue to work on these amazing features, they may charge a small fee for an unlock code to utilise the advanced features.

    Anyone is able to build anything they like on top of MeshCore without paying anything.

    "},{"location":"faq/#12-q-what-do-you-need-to-start-using-meshcore","title":"1.2. Q: What do you need to start using MeshCore?","text":"

    A: Everything you need for MeshCore is available at:

    You need LoRa hardware devices to run MeshCore firmware as clients or server (repeater and room server).

    "},{"location":"faq/#121-hardware","title":"1.2.1. Hardware","text":"

    MeshCore is available on a variety of 433MHz, 868MHz and 915MHz LoRa devices. For example, Lilygo T-Deck, T-Pager, RAK Wireless WisBlock RAK4631 devices (e.g. 19003, 19007, 19026), Heltec V3, Xiao S3 WIO, Xiao C3, Heltec T114, Station G2, Nano G2 Ultra, Seeed Studio T1000-E. More devices are being added regularly.

    For an up-to-date list of supported devices, please go to https://flasher.meshcore.co.uk/

    To use MeshCore without using a phone as the client interface, you can run MeshCore on a LiLygo's T-Deck, T-Deck Plus, T-Pager, T-Watch, or T-Display Pro. MeshCore Ultra firmware running on these devices are a complete off-grid secure communication solution.

    "},{"location":"faq/#122-firmware","title":"1.2.2. Firmware","text":"

    MeshCore has four firmware types that are not available on other LoRa systems. MeshCore has the following:

    "},{"location":"faq/#123-companion-radio-firmware","title":"1.2.3. Companion Radio Firmware","text":"

    Companion radios are for connecting to the Android app or web app as a messenger client. There are two different companion radio firmware versions:

    1. BLE Companion BLE Companion firmware runs on a supported LoRa device and connects to a smart device running the Android or iOS MeshCore client over BLE https://meshcore.co.uk/apps.html

    2. USB Serial Companion USB Serial Companion firmware runs on a supported LoRa device and connects to a smart device or a computer over USB Serial running the MeshCore web client https://meshcore.liamcottle.net/#/ https://client.meshcore.co.uk/tabs/devices

    "},{"location":"faq/#124-repeater","title":"1.2.4. Repeater","text":"

    Repeaters are used to extend the range of a MeshCore network. Repeater firmware runs on the same devices that run client firmware. A repeater's job is to forward MeshCore packets to the destination device. It does not forward or retransmit every packet it receives, unlike other LoRa mesh systems.

    A repeater can be remotely administered using a T-Deck running the MeshCore firmware with remote administration features unlocked, or from a BLE Companion client connected to a smartphone running the MeshCore app.

    "},{"location":"faq/#125-room-server","title":"1.2.5. Room Server","text":"

    A room server is a simple BBS server for sharing posts. T-Deck devices running MeshCore firmware or a BLE Companion client connected to a smartphone running the MeshCore app can connect to a room server.

    Room servers store message history on them and push the stored messages to users. Room servers allow roaming users to come back later and retrieve message history. With channels, messages are either received when it's sent, or not received and missed if the channel user is out of range. Room servers are different and more like email servers where you can come back later and get your emails from your mail server.

    A room server can be remotely administered using a T-Deck running the MeshCore firmware with remote administration features unlocked, or from a BLE Companion client connected to a smartphone running the MeshCore app.

    When a client logs into a room server, the client will receive the previously 32 unseen messages.

    Although room server can also repeat with the command line command set repeat on, it is not recommended nor encouraged. A room server with repeat set to on lacks the full set of repeater and remote administration features that are only available in the repeater firmware.

    The recommendation is to run repeater and room server on separate devices for the best experience.

    "},{"location":"faq/#2-initial-setup","title":"2. Initial Setup","text":""},{"location":"faq/#21-q-how-many-devices-do-i-need-to-start-using-meshcore","title":"2.1. Q: How many devices do I need to start using MeshCore?","text":"

    A: If you have one supported device, flash the BLE Companion firmware and use your device as a client. You can connect to the device using the Android or iOS client via Bluetooth. You can start communicating with other MeshCore users near you.

    If you have two supported devices, and there are not many MeshCore users near you, flash both to BLE Companion firmware so you can use your devices to communicate with your near-by friends and family.

    If you have two supported devices, and there are other MeshCore users nearby, you can flash one of your devices with BLE Companion firmware and flash another supported device to repeater firmware. Place the repeater high above ground to extend your MeshCore network's reach.

    After you flashed the latest firmware onto your repeater device, keep the device connected to your computer via USB serial, use the console feature on the web flasher and set the frequency for your region or country, so your client can remote administer the repeater or room server over RF:

    set freq {frequency}

    The repeater and room server CLI reference is here: https://github.com/meshcore-dev/MeshCore/wiki/Repeater-&-Room-Server-CLI-Reference

    If you have more supported devices, you can use your additional devices with the room server firmware.

    "},{"location":"faq/#22-q-does-meshcore-cost-any-money","title":"2.2. Q: Does MeshCore cost any money?","text":"

    A: All radio firmware versions (e.g. for Heltec V3, RAK, T-1000E, etc) are free and open source developed by Scott at Ripple Radios.

    The native Android and iOS client uses the freemium model and is developed by Liam Cottle, developer of meshtastic map at meshtastic.liamcottle.net on GitHub and reticulum-meshchat on github.

    The T-Deck firmware is free to download and most features are available without cost. To support the firmware developer, you can pay for a registration key to unlock your T-Deck for deeper map zoom and remote server administration over RF using the T-Deck. You do not need to pay for the registration to use your T-Deck for direct messaging and connecting to repeaters and room servers.

    "},{"location":"faq/#23-q-what-frequencies-are-supported-by-meshcore","title":"2.3. Q: What frequencies are supported by MeshCore?","text":"

    A: It supports the 868MHz range in the UK/EU and the 915MHz range in New Zealand, Australia, and the USA. Countries and regions in these two frequency ranges are also supported.

    Use the smartphone client or the repeater setup feature on there web flasher to set your radios' RF settings by choosing the preset for your regions.

    Recently, as of October 2025, many regions have moved to the \"narrow\" setting, aka using BW62.5 and a lower SF number (instead of the original SF11). For example, USA/Canada (Recommended) preset is 910.525MHz, SF7, BW62.5, CR5.

    After extensive testing, many regions have switched or about to switch over to BW62.5 and SF7, 8, or 9. Narrower bandwidth setting and lower SF setting allow MeshCore's radio signals to fit between interference in the ISM band, provide for a lower noise floor, better SNR, and faster transmissions.

    If you have consensus from your community in your region to update your region's preset recommendation, please post your update request on the #meshcore-app channel on the MeshCore Discord server to let Liam Cottle know.

    "},{"location":"faq/#24-q-what-is-an-advert-in-meshcore","title":"2.4. Q: What is an \"advert\" in MeshCore?","text":"

    A: Advert means to advertise yourself on the network. In Reticulum terms it would be to announce. In Meshtastic terms it would be the node sending its node info.

    MeshCore allows you to manually broadcast your name, position and public encryption key, which is also signed to prevent spoofing. When you click the advert button, it broadcasts that data over LoRa. MeshCore calls that an Advert. There's two ways to advert, \"zero hop\" and \"flood\".

    MeshCore clients only advertise themselves when the user initiates it. A repeater sends a flood advert once every 3 hours by default. This interval can be configured using the following command:

    set advert.interval {minutes}

    As of Aug 20 2025, a pending PR on github will change the flood advert to 12 hours to minimize airtime utilization caused by repeaters' flood adverts.

    "},{"location":"faq/#25-q-is-there-a-hop-limit","title":"2.5. Q: Is there a hop limit?","text":"

    A: Internally the firmware has maximum limit of 64 hops. In real world settings it will be difficult to get close to the limit due to the environments and timing as packets travel further and further. We want to hear how far your MeshCore conversations go.

    "},{"location":"faq/#3-server-administration","title":"3. Server Administration","text":""},{"location":"faq/#31-q-how-do-you-configure-a-repeater-or-a-room-server","title":"3.1. Q: How do you configure a repeater or a room server?","text":"

    A: - When MeshCore is flashed onto a LoRa device is for the first time, it is necessary to set the server device's frequency to make it utilize the frequency that is legal in your country or region.

    Repeater or room server can be administered with one of the options below:

    https://buymeacoffee.com/ripplebiz/e/249834

    "},{"location":"faq/#32-q-do-i-need-to-set-the-location-for-a-repeater","title":"3.2. Q: Do I need to set the location for a repeater?","text":"

    A: While not required, with location set for a repeater it will show up on the MeshCore map in the future. Set location with the following command:

    set lat <GPS Lat> set long <GPS Lon>

    You can get the latitude and longitude from Google Maps by right-clicking the location you are at on the map.

    "},{"location":"faq/#33-q-what-is-the-password-to-administer-a-repeater-or-a-room-server","title":"3.3. Q: What is the password to administer a repeater or a room server?","text":"

    A: The default admin password to a repeater and room server is password. Use the following command to change the admin password:

    password {new-password}

    "},{"location":"faq/#34-q-what-is-the-password-to-join-a-room-server","title":"3.4. Q: What is the password to join a room server?","text":"

    A: The default guest password to a room server is hello. Use the following command to change the guest password:

    set guest.password {guest-password}

    "},{"location":"faq/#35-q-can-i-retrieve-a-repeaters-private-key-or-set-a-repeaters-private-key","title":"3.5. Q: Can I retrieve a repeater's private key or set a repeater's private key?","text":"

    A: You can issue these commands to get or set a repeater's private key using a USB serial connection.

    get prv.key to print a repeater's private key on the serial console set prv.key <hex> to set a repeater's private key on the serial console

    Reboot the repeater after set prv.key <hex> command for the new private key to take effect.

    "},{"location":"faq/#36-q-the-first-byte-of-my-repeaters-public-key-collides-with-an-exisitng-repeater-on-the-mesh-how-do-i-get-a-new-private-key-with-a-matching-public-key-that-has-its-first-byte-of-my-choosing","title":"3.6. Q: The first byte of my repeater's public key collides with an exisitng repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing?","text":"

    A: You can generate a new private key and specific the first byte of its public key here: https://gessaman.com/mc-keygen/

    "},{"location":"faq/#37-q-my-repeater-maybe-suffering-from-deafness-due-to-high-power-interference-near-my-meshs-frequency-it-is-not-hearing-other-in-range-meshcore-radios-what-can-i-do","title":"3.7. Q: My repeater maybe suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. what can I do?","text":"

    A: This may be due to the SX1262 radio's auto gain control feature. You can use this command to preiodically reset its AGC.

    set agc.reset.interval <number>

    The <number> unit is in seconds and is incremented by 4. set agc.reset.interval 4 works well to cure deafness.

    This is a very low cost operation. AGC reset is done by simply setting state = STATE_IDLE; in function RadioLibWrapper::resetAGC() in RadioLibWrappers.cpp

    "},{"location":"faq/#38-q-how-do-i-make-my-repeater-an-observer-on-the-mesh","title":"3.8 Q: How do I make my repeater an observer on the mesh","text":"

    A: The observer instruction is available here: https://analyzer.letsmesh.net/observer/onboard

    "},{"location":"faq/#4-t-deck-related","title":"4. T-Deck Related","text":""},{"location":"faq/#41-q-is-there-a-user-guide-for-t-deck-t-pager-t-watch-or-t-display-pro","title":"4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro?","text":"

    A: Yes, it is available on https://buymeacoffee.com/ripplebiz/ultra-v7-7-guide-meshcore-users

    "},{"location":"faq/#42-q-what-are-the-steps-to-get-a-t-deck-into-dfu-device-firmware-update-mode","title":"4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?","text":"

    A: 1. Device off 2. Connect USB cable to device 3. Hold down trackball (keep holding) 4. Turn on device 5. Hear USB connection sound 6. Release trackball 7. T-Deck in DFU mode now 8. At this point you can begin flashing using https://flasher.meshcore.co.uk/

    "},{"location":"faq/#43-q-why-is-my-t-deck-plus-not-getting-any-satellite-lock","title":"4.3. Q: Why is my T-Deck Plus not getting any satellite lock?","text":"

    A: For T-Deck Plus, the GPS baud rate should be set to 38400. Also, some T-Deck Plus devices were found to have the GPS module installed upside down, with the GPS antenna facing down instead of up. If your T-Deck Plus still doesn't get any satellite lock after setting the baud rate to 38400, you might need to open the device to check the GPS orientation.

    GPS on T-Deck is always enabled. You can skip the \"GPS clock sync\" and the T-Deck will continue to try to get a GPS lock. You can go to the GPS Info screen; you should see the Sentences: counter increasing if the baud rate is correct.

    Source

    "},{"location":"faq/#44-q-why-is-my-og-non-plus-t-deck-not-getting-any-satellite-lock","title":"4.4. Q: Why is my OG (non-Plus) T-Deck not getting any satellite lock?","text":"

    A: The OG (non-Plus) T-Deck doesn't come with a GPS. If you added a GPS to your OG T-Deck, please refer to the manual of your GPS to see what baud rate it requires. Alternatively, you can try to set the baud rate from 9600, 19200, etc., and up to 115200 to see which one works.

    "},{"location":"faq/#45-q-what-size-of-sd-card-does-the-t-deck-support","title":"4.5. Q: What size of SD card does the T-Deck support?","text":"

    A: Users have had no issues using 16GB or 32GB SD cards. Format the SD card to FAT32.

    "},{"location":"faq/#46-q-what-is-the-public-key-for-the-default-public-channel","title":"4.6. Q: what is the public key for the default public channel?","text":"

    A: T-Deck uses the same key the smartphone apps use but in base64 izOH6cXN6mrJ5e26oRXNcg==

    There is no = key on the T-Deck's hardware keyboard. You can use the on-screen software keyboard to enter =. Tap the text box to enable the on-screen software keyboard. The third character is the capital letter O (Oh), not zero 0

    The smartphone app key is in hex: 8b3387e9c5cdea6ac9e5edbaa115cd72

    Source

    "},{"location":"faq/#47-q-how-do-i-get-maps-on-t-deck","title":"4.7. Q: How do I get maps on T-Deck?","text":"

    A: You need map tiles. You can get pre-downloaded map tiles here (a good way to support development): - https://buymeacoffee.com/ripplebiz/e/342543 (Europe) - https://buymeacoffee.com/ripplebiz/e/342542 (US)

    Another way to download map tiles is to use this Python script to get the tiles in the areas you want: https://github.com/fistulareffigy/MTD-Script

    There is also a modified script that adds additional error handling and parallel downloads: https://discord.com/channels/826570251612323860/1330643963501351004/1338775811548905572

    UK map tiles are available separately from Andy Kirby on his discord server: https://discord.com/channels/826570251612323860/1330643963501351004/1331346597367386224

    "},{"location":"faq/#48-q-where-do-the-map-tiles-go","title":"4.8. Q: Where do the map tiles go?","text":"

    Once you have the tiles downloaded, copy the \\tiles folder to the root of your T-Deck's SD card.

    "},{"location":"faq/#49-q-how-to-unlock-deeper-map-zoom-and-server-management-features-on-t-deck","title":"4.9. Q: How to unlock deeper map zoom and server management features on T-Deck?","text":"

    A: You can download, install, and use the T-Deck firmware for free, but it has some features (map zoom, server administration) that are enabled if you purchase an unlock code for \\$10 per T-Deck device. Unlock page: https://buymeacoffee.com/ripplebiz/e/249834

    "},{"location":"faq/#410-q-how-to-decipher-the-diagnostics-screen-on-t-deck","title":"4.10. Q: How to decipher the diagnostics screen on T-Deck?","text":"

    **A: ** Space is tight on T-Deck's screen, so the information is a bit cryptic. The format is : {hops} l:{packet-length}({payload-len}) t:{packet-type} snr:{n} rssi:{n}

    See here for packet-type: https://github.com/meshcore-dev/MeshCore/blob/main/src/Packet.h#L19

    #define PAYLOAD_TYPE_REQ 0x00 // request (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob)\n#define PAYLOAD_TYPE_RESPONSE 0x01 // response to REQ or ANON_REQ (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob)\n#define PAYLOAD_TYPE_TXT_MSG 0x02 // a plain text message (prefixed with dest/src hashes, MAC) (enc data: timestamp, text)\n#define PAYLOAD_TYPE_ACK 0x03 // a simple ack #define PAYLOAD_TYPE_ADVERT 0x04 // a node advertising its Identity\n#define PAYLOAD_TYPE_GRP_TXT 0x05 // an (unverified) group text message (prefixed with channel hash, MAC) (enc data: timestamp, \"name: msg\")\n#define PAYLOAD_TYPE_GRP_DATA 0x06 // an (unverified) group datagram (prefixed with channel hash, MAC) (enc data: timestamp, blob)\n#define PAYLOAD_TYPE_ANON_REQ 0x07 // generic request (prefixed with dest_hash, ephemeral pub_key, MAC) (enc data: ...)\n#define PAYLOAD_TYPE_PATH 0x08 // returned path (prefixed with dest/src hashes, MAC) (enc data: path, extra)\n

    Source

    "},{"location":"faq/#411-q-the-t-deck-sound-is-too-loud","title":"4.11. Q: The T-Deck sound is too loud?","text":""},{"location":"faq/#412-q-can-you-customize-the-sound","title":"4.12. Q: Can you customize the sound?","text":"

    A: You can customise the sounds on the T-Deck, by placing .mp3 files onto the root dir of the SD card. The files are:

    "},{"location":"faq/#413-q-what-is-the-import-from-clipboard-feature-on-the-t-deck-and-is-there-a-way-to-manually-add-nodes-without-having-to-receive-adverts","title":"4.13. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts?","text":"

    A: 'Import from Clipboard' is for importing a contact via a file named 'clipboard.txt' on the SD card. The opposite, is in the Identity screen, the 'Card to Clipboard' menu, which writes to 'clipboard.txt' so you can share yourself (call these 'biz cards', that start with \"meshcore://...\")

    "},{"location":"faq/#414-q-how-to-capture-a-screenshot-on-t-deck","title":"4.14. Q: How to capture a screenshot on T-Deck?","text":"

    A: To capture a screenshot on a T-Deck, long press the top-left corner of the screen. The screenshot is saved to the microSD card, if one is inserted into the device.

    "},{"location":"faq/#5-general","title":"5. General","text":""},{"location":"faq/#51-q-what-are-bw-sf-and-cr","title":"5.1. Q: What are BW, SF, and CR?","text":"

    A:

    BW is bandwidth - width of frequency spectrum that is used for transmission

    SF is spreading factor - how much should the communication spread in time

    CR is coding rate - from: https://www.thethingsnetwork.org/docs/lorawan/fec-and-code-rate/

    TL;DR: default CR to 5 for good stable links. If it is not a solid link and is intermittent, change to CR to 7 or 8.

    Forward Error Correction is a process of adding redundant bits to the data to be transmitted. During the transmission, data may get corrupted by interference (changes from 0 to 1 / 1 to 0). These error correction bits are used at the receivers for restoring corrupted bits.

    The Code Rate of a forward error correction expresses the proportion of bits in a data stream that actually carry useful information.

    There are 4 code rates used in LoRaWAN:

    4/5 4/6 5/7 4/8

    For example, if the code rate is 5/7, for every 5 bits of useful information, the coder generates a total of 7 bits of data, of which 2 bits are redundant.

    Making the bandwidth 2x wider (from BW125 to BW250) allows you to send 2x more bytes in the same time. Making the spreading factor 1 step lower (from SF10 to SF9) allows you to send 2x more bytes in the same time.

    Lowering the spreading factor makes it more difficult for the gateway to receive a transmission, as it will be more sensitive to noise. You could compare this to two people taking in a noisy place (a bar for example). If you\u2019re far from each other, you have to talk slow (SF10), but if you\u2019re close, you can talk faster (SF7)

    So, it's balancing act between speed of the transmission and resistance to noise. things network is mainly focused on LoRaWAN, but the LoRa low-level stuff still checks out for any LoRa project

    "},{"location":"faq/#52-q-do-meshcore-clients-repeat","title":"5.2. Q: Do MeshCore clients repeat?","text":"

    A: No, MeshCore clients do not repeat. This is the core of MeshCore's messaging-first design. This is to avoid devices flooding the air ware and create endless collisions, so messages sent aren't received. In MeshCore, only repeaters and room server with set repeat on repeat.

    "},{"location":"faq/#53-q-what-happens-when-a-node-learns-a-route-via-a-mobile-repeater-and-that-repeater-is-gone","title":"5.3. Q: What happens when a node learns a route via a mobile repeater, and that repeater is gone?","text":"

    A: If you used to reach a node through a repeater and the repeater is no longer reachable, the client will send the message using the existing (but now broken) known path, the message will fail after 3 retries, and the app will reset the path and send the message as flood on the last retry by default. This can be turned off in settings. If the destination is reachable directly or through another repeater, the new path will be used going forward. Or you can set the path manually if you know a specific repeater to use to reach that destination.

    In the case if users are moving around frequently, and the paths are breaking, they just see the phone client retries and revert to flood to attempt to re-establish a path.

    "},{"location":"faq/#54-q-how-does-a-node-discovery-a-path-to-its-destination-and-then-use-it-to-send-messages-in-the-future-instead-of-flooding-every-message-it-sends-like-meshtastic","title":"5.4. Q: How does a node discovery a path to its destination and then use it to send messages in the future, instead of flooding every message it sends like Meshtastic?","text":"

    Routes are stored in sender's contact list. When you send a message the first time, the message first gets to your destination by flood routing. When your destination node gets the message, it will send back a delivery report to the sender with all repeaters that the original message went through. This delivery report is flood-routed back to you the sender and is a basis for future direct path. When you send the next message, the path will get embedded into the packet and be evaluated by repeaters. If the hop and address of the repeater matches, it will retransmit the message, otherwise it will not retransmit, hence minimizing utilization.

    Source

    "},{"location":"faq/#55-q-do-public-channels-always-flood-do-private-channels-always-flood","title":"5.5. Q: Do public channels always flood? Do private channels always flood?","text":"

    A: Yes, group channels are A to B, so there is no defined path. They have to flood. Repeaters can however deny flood traffic up to some hop limit, with the set flood.max CLI command. Administrators of repeaters get to set the rules of their repeaters.

    Source

    "},{"location":"faq/#56-q-what-is-the-public-key-for-the-default-public-channel","title":"5.6. Q: what is the public key for the default public channel?","text":"

    A: The smartphone app key is in hex: 8b3387e9c5cdea6ac9e5edbaa115cd72

    T-Deck uses the same key but in base64 izOH6cXN6mrJ5e26oRXNcg== The third character is the capital letter 'O', not zero 0 Source

    "},{"location":"faq/#57-q-is-meshcore-open-source","title":"5.7. Q: Is MeshCore open source?","text":"

    A: Most of the firmware is freely available. Everything is open source except the T-Deck firmware and Liam's native mobile apps. - Firmware repo: https://github.com/meshcore-dev/MeshCore

    "},{"location":"faq/#58-q-how-can-i-support-meshcore","title":"5.8. Q: How can I support MeshCore?","text":"

    A: Provide your honest feedback on GitHub and on MeshCore Discord server. Spread the word of MeshCore to your friends and communities; help them get started with MeshCore. Support Scott's MeshCore development at https://buymeacoffee.com/ripplebiz.

    Support Liam Cottle's smartphone client development by unlocking the server administration wait gate with in-app purchase

    Support Rastislav Vysoky (recrof)'s flasher web site and the map web site development through PayPal or Revolut

    "},{"location":"faq/#59-q-how-do-i-build-meshcore-firmware-from-source","title":"5.9. Q: How do I build MeshCore firmware from source?","text":"

    A: See instructions here: https://discord.com/channels/826570251612323860/1330643963501351004/1341826372120608769

    Build instructions for MeshCore:

    For Windows, first install WSL and Python+pip via: https://plainenglish.io/blog/setting-up-python-on-windows-subsystem-for-linux-wsl-26510f1b2d80

    (Linux, Windows+WSL) In the terminal/shell:

    sudo apt update\nsudo apt install libpython3-dev\nsudo apt install python3-venv\n

    Mac: python3 should be already installed.

    Then it should be the same for all platforms:

    python3 -m venv meshcore\ncd meshcore && source bin/activate\npip install -U platformio\ngit clone https://github.com/ripplebiz/MeshCore.git\ncd MeshCore\n

    open platformio.ini and in [arduino_base] edit the LORA_FREQ=867.5 save, then run:

    pio run -e RAK_4631_Repeater\n

    then you'll find firmware.zip in .pio/build/RAK_4631_Repeater

    Andy also has a video on how to build using VS Code: How to build and flash Meshcore repeater firmware | Heltec V3 https://www.youtube.com/watch?v=WJvg6dt13hk (Link referenced in the Discord post)

    "},{"location":"faq/#510-q-are-there-other-meshcore-related-open-source-projects","title":"5.10. Q: Are there other MeshCore related open source projects?","text":"

    A: Liam Cottle's MeshCore web client and MeshCore Javascript library are open source under MIT license.

    Web client: https://github.com/liamcottle/meshcore-web Javascript: https://github.com/liamcottle/meshcore.js

    "},{"location":"faq/#511-q-does-meshcore-support-atak","title":"5.11. Q: Does MeshCore support ATAK","text":"

    A: ATAK is not currently on MeshCore's roadmap.

    Meshcore would not be best suited to ATAK because MeshCore: clients do not repeat and therefore you would need a network of repeaters in place will not have a stable path where all clients are constantly moving between repeaters

    MeshCore clients would need to reset path constantly and flood traffic across the network which could lead to lots of collisions with something as chatty as ATAK.

    This could change in the future if MeshCore develops a client firmware that repeats. Source

    "},{"location":"faq/#512-q-how-do-i-add-a-node-to-the-meshcore-map","title":"5.12. Q: How do I add a node to the MeshCore Map","text":"

    A:

    To add a BLE Companion radio, connect to the BLE Companion radio from the MeshCore smartphone app. In the app, tap the 3 dot menu icon at the top right corner, then tap Internet Map. Tap the 3 dot menu icon again and choose Add me to the Map

    To add a Repeater or Room Server to the map, go to the Contact List, tap the 3 dot next to the Repeater or Room Server you want to add to the Internet Map, tap Share, then tap Upload to Internet Map.

    You can use the same companion (same public key) that you used to add your repeaters or room servers to remove them from the Internet Map.

    "},{"location":"faq/#513-q-can-i-use-a-raspberry-pi-to-update-a-meshcore-radio","title":"5.13. Q: Can I use a Raspberry Pi to update a MeshCore radio?","text":"

    ** A:** Yes. Below are the instructions to flash firmware onto a supported LoRa device using a Raspberry Pi over USB serial.

    Instructions for nRF devices like RAK, T1000-E, T114 are immediately after the ESP instructions

    For ESP-based devices (e.g. Heltec V3) you need: - Download firmware file from flasher.meshcore.co.uk - Go to the web site on a browser, find the section that has the firmware up need - Click the Download button, right click on the file you need, for example, - Heltec_V3_companion_radio_ble-v1.7.1-165fb33.bin - Non-merged bin keeps the existing Bluetooth pairing database - Heltec_v3_companion_radio_usb-v1.7.1-165fb33-merged.bin - Merged bin overwrites everything including the bootloader, existing Bluetooth pairing database, but keeps configurations. - Right click on the file name and copy the link and note it for later use here is an example: https://flasher.meshcore.dev/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin - Run: - wget https://flasher.meshcore.dev/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin to download the firmware file for your device type. or the version you need - USB, BLE, Repeater, Room Server, merged bin or non-merged bin - If the above wget command only downloads a very small file (10K bytes instead of more than 100K byte, use this command instead: - wget --user-agent=\"Mozilla/5.0\" --content-disposition \"https://flasher.meshcore.dev/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_usb-v1.7.1-165fb33.bin\" - Confirm the ttyXXXX device path on your Raspberry Pi: - Go to /dev directory, run ls command to find confirm your device path - They are usually /dev/ttyUSB0 for ESP devices - For ESP-based devices, install esptool from the shell: - pip install esptool --break-system-packages - To flash, use the following command: - For non-merged bin: - esptool.py -p /dev/ttyUSB0 --chip esp32-s3 write_flash 0x10000 <non-merged_firmware>.bin - For merged bin: - esptool.py -p /dev/ttyUSB0 --chip esp32-s3 write_flash 0x00000 <merged_firmware>.bin

    Instructions for nRF devices:

    For nRF devices (e.g. RAK, Heltec T114) you need the following: - Download firmware file from flasher.meshcore.co.uk - Go to the web site on a browser, find the section that has the firmware up need - You need the ZIP version for the adafruit flash tool (below) - Click the Download button, right click on the ZIP file, for example: - RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip - Right click on the file name and copy the link and note it for later use here is an example: https://flasher.meshcore.dev/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip - Run: - wget https://flasher.meshcore.dev/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip to download the firmware file for your device type. or the version you need - USB, BLE, Repeater, Room Server, ZIP file only - Confirm the ttyXXXX device path on your Raspberry Pi: - Go to /dev directory, run ls command to find confirm your device path - They are usually /dev/ttyACM0 for nRF devices - For nRF-based devices, install adafruit-nrfutil - pip install adafruit-nrfutil --break-system-packages - Use this command to flash the nRF device: - adafruit-nrfutil --verbose dfu serial --package RAK_4631_companion_radio_usb-v1.7.1-165fb33.zip -p /dev/ttyACM0 -b 115200 --singlebank --touch 1200

    To manage a repeater or room server connected to a Pi over USB serial using shell commands, you need to install picocom. To install picocom, run the following command: - sudo apt install picocom

    To start managing your USB serial-connected device using picocom, use the following command: - picocom -b 115200 /dev/ttyUSB0 --imap lfcrlf

    From here, reference repeater and room server command line commands on MeshCore github wiki here: - https://github.com/meshcore-dev/MeshCore/wiki/Repeater-&-Room-Server-CLI-Reference

    "},{"location":"faq/#514-q-are-there-are-projects-built-around-meshcore","title":"5.14. Q: Are there are projects built around MeshCore?","text":"

    A: Yes. See the following:

    "},{"location":"faq/#5141-meshcoremqtt","title":"5.14.1. meshcoremqtt","text":"

    A Python script to send meshcore debug and packet capture data to MQTT for analysis. Cisien's version is a fork of Andrew-a-g's and is being used to to collect data for https://map.w0z.is/messages and https://analyzer.letsmesh.net/ https://github.com/Cisien/meshcoretomqtt https://github.com/Andrew-a-g/meshcoretomqtt

    "},{"location":"faq/#5142-meshcore-for-home-assistant","title":"5.14.2. MeshCore for Home Assistant","text":"

    A custom Home Assistant integration for MeshCore mesh radio nodes. It allows you to monitor and control MeshCore nodes via USB, BLE, or TCP connections. https://github.com/awolden/meshcore-ha

    "},{"location":"faq/#5143-python-meshcore","title":"5.14.3. Python MeshCore","text":"

    Bindings to access your MeshCore companion radio nodes in python. https://github.com/fdlamotte/meshcore_py

    "},{"location":"faq/#5144-meshcore-cli","title":"5.14.4. meshcore-cli","text":"

    CLI interface to MeshCore companion radio over BLE, TCP, or serial. Uses Python MeshCore above. https://github.com/fdlamotte/meshcore-cli

    "},{"location":"faq/#5145-meshcorejs","title":"5.14.5. meshcore.js","text":"

    A JavaScript library for interacting with a MeshCore device running the companion radio firmware https://github.com/liamcottle/meshcore.js

    "},{"location":"faq/#5146-pymc_core","title":"5.14.6. pyMC_core","text":"

    pyMC_Core is a Python port of MeshCore, designed for Raspberry Pi and similar hardware, it talks to LoRa modules over SPI. https://github.com/rightup/pyMC_core

    "},{"location":"faq/#5147-meshcore-packet-decoder","title":"5.14.7. MeshCore Packet Decoder","text":"

    A TypeScript library for decoding MeshCore mesh networking packets with full cryptographic support. Uses WebAssembly (WASM) for Ed25519 key derivation through the orlp/ed25519 library. It powers the MeshCore Packet Analyzer. https://github.com/michaelhart/meshcore-decoder

    "},{"location":"faq/#5148-meshcore-pi","title":"5.14.8. meshcore-pi","text":"

    meshcore-pi is another Python port of MeshCore, designed for Raspberry Pi and similar hardware, it talks to LoRa modules over SPI or GPIO. https://github.com/brianwiddas/meshcore-pi

    "},{"location":"faq/#5149-pymc_repeater","title":"5.14.9. pyMC_Repeater","text":"

    pyMC_Repeater is a repeater daemon in Python built on top of the pymc_core library. https://github.com/rightup/pyMC_Repeater

    "},{"location":"faq/#515-q-are-there-client-applications-for-windows-or-mac","title":"5.15. Q: Are there client applications for Windows or Mac?","text":"

    A: Yes, the same iOS and Android client is also available for Windows and Intel Mac (sorry, not available for ARM-based Mac yet). You can find them together with the Android APK here: https://files.liamcottle.net/MeshCore

    Both the Windows and Intel Mac versions of the client app are fully unlocked and are free to use.

    "},{"location":"faq/#516-q-are-there-any-resources-that-compare-meshcore-to-other-lora-systems","title":"5.16. Q: Are there any resources that compare MeshCore to other LoRa systems?","text":"

    A: Here is a list of MeshCore comparison resources: The Comms Channel on YouTube: https://www.youtube.com/watch?v=guDoKGs02Us MeshCore Advantages by MCarper: https://github.com/mikecarper/meshfirmware/blob/main/MeshCoreAdvantages.md Meshcore vs Meshtastic by austinmesh.org https://www.austinmesh.org/learn/meshcore-vs-meshtastic/

    "},{"location":"faq/#6-troubleshooting","title":"6. Troubleshooting","text":""},{"location":"faq/#61-q-my-client-says-another-client-or-a-repeater-or-a-room-server-was-last-seen-many-many-days-ago","title":"6.1. Q: My client says another client or a repeater or a room server was last seen many, many days ago.","text":""},{"location":"faq/#62-q-a-repeater-or-a-client-or-a-room-server-i-expect-to-see-on-my-discover-list-on-t-deck-or-contact-list-on-a-smart-device-client-are-not-listed","title":"6.2. Q: A repeater or a client or a room server I expect to see on my discover list (on T-Deck) or contact list (on a smart device client) are not listed.","text":"

    A: - If your client is a T-Deck, it may not have its time set (no GPS installed, no GPS lock, or wrong GPS baud rate). - If you are using the Android or iOS client, the other client, repeater, or room server may have the wrong time.

    You can get the epoch time on https://www.epochconverter.com/ and use it to set your T-Deck clock. For a repeater and room server, the admin can use a T-Deck to remotely set their clock (clock sync), or use the time command in the USB serial console with the server device connected.

    "},{"location":"faq/#63-q-how-to-connect-to-a-repeater-via-ble-bluetooth","title":"6.3. Q: How to connect to a repeater via BLE (Bluetooth)?","text":"

    A: You can't connect to a device running repeater firmware via Bluetooth. Devices running the BLE companion firmware you can connect to it via Bluetooth using the android app

    "},{"location":"faq/#64-q-my-companion-isnt-showing-up-over-bluetooth","title":"6.4. Q: My companion isn't showing up over Bluetooth?","text":"

    A: make sure that you flashed the Bluetooth companion firmware and not the USB-only companion firmware.

    "},{"location":"faq/#65-q-i-cant-connect-via-bluetooth-what-is-the-bluetooth-pairing-code","title":"6.5. Q: I can't connect via Bluetooth, what is the Bluetooth pairing code?","text":"

    A: the default Bluetooth pairing code is 123456

    "},{"location":"faq/#66-q-my-heltec-v3-keeps-disconnecting-from-my-smartphone-it-cant-hold-a-solid-bluetooth-connection","title":"6.6. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection.","text":"

    A: Heltec V3 has a very small coil antenna on its PCB for Wi-Fi and Bluetooth connectivity. It has a very short range, only a few feet. It is possible to remove the coil antenna and replace it with a 31mm wire. The BT range is much improved with the modification.

    "},{"location":"faq/#67-q-my-rakt1000-exiao_nrf52-device-seems-to-be-corrupted-how-do-i-wipe-it-clean-to-start-fresh","title":"6.7. Q: My RAK/T1000-E/xiao_nRF52 device seems to be corrupted, how do I wipe it clean to start fresh?","text":"

    A: 1. Connect USB-C cable to your device, per your device's instruction, get it to flash mode: - For RAK, click the reset button TWICE - For T1000-e, quickly disconnect and reconnect the magnetic side of the cable from the device TWICE - For Heltec T114, click the reset button TWICE (the bottom button) - For Xiao nRF52, click the reset button once. If that doesn't work, quickly double click the reset button twice. If that doesn't work, disconnection the board from your PC and reconnect again (seeed studio wiki) 5. A new folder will appear on your computer's desktop 6. Download the flash_erase*.uf2 file for your device on flasher.meshcore.co.uk - RAK WisBlock and Heltec T114: Flash_erase-nRF32_softdevice_v6.uf2 - Seeed Studio Xiao nRF52 WIO: Flash_erase-nRF52_softdevice_v7.uf2 8. drag and drop the uf2 file for your device to the root of the new folder 9. Wait for the copy to complete. You might get an error dialog, you can ignore it 10. Go to https://flasher.meshcore.co.uk/, click Console and select the serial port for your connected device 11. In the console, press enter. Your flash should now be erased 12. You may now flash the latest MeshCore firmware onto your device

    Separately, starting in firmware version 1.7.0, there is a CLI Rescue mode. If your device has a user button (e.g. some RAK, T114), you can activate the rescue mode by hold down the user button of the device within 8 seconds of boot. Then you can use the 'Console' on flasher.meshcore.co.uk

    "},{"location":"faq/#68-q-webflasher-fails-on-linux-with-failed-to-open","title":"6.8. Q: WebFlasher fails on Linux with failed to open","text":"

    A: If the usb port doesn't have the right ownership for this task, the process fails with the following error: NetworkError: Failed to execute 'open' on 'SerialPort': Failed to open serial port.

    Allow the browser user on it: # setfacl -m u:YOUR_USER_HERE:rw /dev/ttyUSB0

    "},{"location":"faq/#7-other-questions","title":"7. Other Questions:","text":""},{"location":"faq/#71-q-how-to-update-nrf-rak-t114-seed-xiao-repeater-and-room-server-firmware-over-the-air-using-the-new-simpler-dfu-app","title":"7.1. Q: How to update nRF (RAK, T114, Seed XIAO) repeater and room server firmware over the air using the new simpler DFU app?","text":"

    A: The steps below work on both Android and iOS as nRF has made both apps' user interface the same on both platforms:

    1. Download nRF's DFU app from iOS App Store or Android's Play Store, you can find the app by searching for nrf dfu, the app's full name is nRF Device Firmware Update
    2. On flasher.meshcore.co.uk, download the ZIP version of the firmware for your nRF device (e.g. RAK or Heltec T114 or Seeed Studio's Xiao)
    3. From the MeshCore app, login remotely to the repeater you want to update with admin privilege
    4. Go to the Command Line tab, type start ota and hit enter.
    5. you should see OK to confirm the repeater device is now in OTA mode
    6. Run the DFU app,tab Settings on the top right corner
    7. Enable Packets receipt notifications, and change Number of Packets to 10 for RAK, 8 for T114. 8 also works for RAK.
    8. Select the firmware zip file you downloaded
    9. Select the device you want to update. If the device you want to update is not on the list, try enablingOTA on the device again
    10. If the device is not found, enable Force Scanning in the DFU app
    11. Tab the Upload to begin OTA update
    12. If it fails, try turning off and on Bluetooth on your phone. If that doesn't work, try rebooting your phone.
    13. Wait for the update to complete. It can take a few minutes.
    "},{"location":"faq/#711-q-can-i-update-seeed-studio-wio-tracker-l1-pro-using-ota","title":"7.1.1 Q: Can I update Seeed Studio Wio Tracker L1 Pro using OTA?","text":"

    A: You can flash this safer bootloader to the Wio Tracker L1 Pro https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX

    After this bootloader is flashed onto the device, you can trigger over the air update using bluetooth by holding the button next to the D-Pad and then click the reset button. The follow the same OTA update instructions above. You can skip pass the start ota instruction and start the update using the DFU app.

    "},{"location":"faq/#72-q-how-to-update-esp32-based-devices-over-the-air","title":"7.2. Q: How to update ESP32-based devices over the air?","text":"

    A: For ESP32-based devices (e.g. Heltec V3): 1. On flasher.meshcore.co.uk, download the non-merged version of the firmware for your ESP32 device (e.g. Heltec_v3_repeater-v1.6.2-4449fd3.bin, no \"merged\" in the file name) 2. From the MeshCore app, login remotely to the repeater you want to update with admin privilege 4. Go to the Command Line tab, type start ota and hit enter. 5. you should see OK to confirm the repeater device is now in OTA mode 6. The command start ota on an ESP32-based device starts a wifi hotspot named MeshCore OTA 7. From your phone or computer connect to the 'MeshCore OTA' hotspot 8. From a browser, go to http://192.168.4.1/update and upload the non-merged bin from the flasher

    "},{"location":"faq/#73-q-is-there-a-way-to-lower-the-chance-of-a-failed-ota-device-firmware-update-dfu","title":"7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)?","text":"

    A: Yes, developer che aporeps has an enhanced OTA DFU bootloader for nRF52 based devices. With this bootloader, if it detects that the application firmware is invalid, it falls back to OTA DFU mode so you can attempt to flash again to recover. This bootloader has other changes to make the OTA DFU process more fault tolerant.

    Refer to https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX for the latest information.

    Currently, the following boards are supported: - Heltec Automation Mesh Node T114 / HT-nRF5262 - Nologo ProMicro NRF52840 (aka SuperMini NRF52840) - Seeed Studio SenseCAP Card Tracker T1000-E - Seeed Studio Wio Tracker L1 - Seeed Studio XIAO nRF52840 BLE - Seeed Studio XIAO nRF52840 BLE SENSE - RAK 4631 (See note) - RAK WisMesh Tag (new 28/11/2025)

    "},{"location":"faq/#74-q-are-the-meshcore-logo-and-font-available","title":"7.4. Q: are the MeshCore logo and font available?","text":"

    A: Yes, it is on the MeshCore github repo here: https://github.com/meshcore-dev/MeshCore/tree/main/logo

    "},{"location":"faq/#75-q-what-is-the-format-of-a-contact-or-channel-qr-code","title":"7.5. Q: What is the format of a contact or channel QR code?","text":"

    A: Channel: meshcore://channel/add?name=<name>&secret=<secret>

    Contact: meshcore://contact/add?name=<name>&public_key=<secret>&type=<type>

    where &type is: chat = 1 repeater = 2 room = 3 sensor = 4

    "},{"location":"faq/#76-q-how-do-i-connect-to-the-companion-via-wifi-eg-using-a-heltec-v3","title":"7.6. Q: How do I connect to the companion via WIFI, e.g. using a heltec v3?","text":"

    A: WiFi firmware requires you to compile it yourself, as you need to set the wifi ssid and password. Edit WIFI_SSID and WIFI_PWD in ./variants/heltec_v3/platformio.ini and then flash it to your device.

    "},{"location":"faq/#77-q-i-have-a-station-g2-or-a-heltec-v4-or-an-ikoka-stick-or-a-radio-with-a-ebyte-e22-900m30s-or-a-e22-900m33s-module-what-should-their-transmit-power-be-set-to","title":"7.7. Q: I have a Station G2, or a Heltec V4, or an Ikoka Stick, or a radio with a EByte E22-900M30S or a E22-900M33S module, what should their transmit power be set to?","text":"

    A: For companion radios, you can set these radios' transmit power in the smartphone app. For repeater and room server radios, you can set their transmit power using the command line command set tx. You can get their current value using command line comand get tx

    Device / Model Region / Description In-App Setting (dBm) Target Radio Output Notes Station G2 Reference US915 Max Output 19 dBm 36.5 dBm (4.46W) US915 Recommended Max 16 dBm 35 dBm (3.16W) 1dB compression point EU868 Recommended Max 15 dBm 34.5 dBm (2.82W) 1dB compression point US915 1W Output 10 dBm 1W EU868 1W Output 9 dBm 1W Ikoka Stick E22-900M30S 1W Model 19 dBm 1W DO NOT EXCEED (Risk of burn out) Ikoka Stick E22-900M33S 2W Model 9 dBm 2W DO NOT EXCEED (Risk of burn out) Heltec V4 Standard Output 10 dBm 22 dBm High Output 22 dBm 28 dBm ---"},{"location":"faq/#warning-set-these-values-at-your-own-risk-incorrect-power-settings-can-permanently-damage-your-radio-hardware","title":"\u26a0\ufe0f WARNING: Set these values at your own risk. Incorrect power settings can permanently damage your radio hardware.","text":""},{"location":"nrf52_power_management/","title":"nRF52 Power Management","text":""},{"location":"nrf52_power_management/#overview","title":"Overview","text":"

    The nRF52 Power Management module provides battery protection features to prevent over-discharge, minimise likelihood of brownout and flash corruption conditions existing, and enable safe voltage-based recovery.

    "},{"location":"nrf52_power_management/#features","title":"Features","text":""},{"location":"nrf52_power_management/#boot-voltage-protection","title":"Boot Voltage Protection","text":""},{"location":"nrf52_power_management/#voltage-wake-lpcomp-vbus","title":"Voltage Wake (LPCOMP + VBUS)","text":""},{"location":"nrf52_power_management/#early-boot-register-capture","title":"Early Boot Register Capture","text":""},{"location":"nrf52_power_management/#shutdown-reason-tracking","title":"Shutdown Reason Tracking","text":"

    Shutdown reason codes (stored in GPREGRET2): | Code | Name | Description | |------|------|-------------| | 0x00 | NONE | Normal boot / no previous shutdown | | 0x4C | LOW_VOLTAGE | Runtime low voltage threshold reached | | 0x55 | USER | User requested powerOff() | | 0x42 | BOOT_PROTECT | Boot voltage protection triggered |

    "},{"location":"nrf52_power_management/#supported-boards","title":"Supported Boards","text":"Board Implemented LPCOMP wake VBUS wake Seeed Studio XIAO nRF52840 (xiao_nrf52) Yes Yes Yes RAK4631 (rak4631) Yes Yes Yes Heltec T114 (heltec_t114) Yes Yes Yes Promicro nRF52840 No No No RAK WisMesh Tag No No No Heltec Mesh Solar No No No LilyGo T-Echo / T-Echo Lite No No No SenseCAP Solar No No No WIO Tracker L1 / L1 E-Ink No No No WIO WM1110 No No No Mesh Pocket No No No Nano G2 Ultra No No No ThinkNode M1/M3/M6 No No No T1000-E No No No Ikoka Nano/Stick/Handheld (nRF) No No No Keepteen LT1 No No No Minewsemi ME25LS01 No No No

    Notes: - \"Implemented\" reflects Phase 1 (boot lockout + shutdown reason capture). - User power-off on Heltec T114 does not enable LPCOMP wake. - VBUS detection is used to skip boot lockout on external power, and VBUS wake is configured alongside LPCOMP when supported hardware exposes VBUS to the nRF52.

    "},{"location":"nrf52_power_management/#technical-details","title":"Technical Details","text":""},{"location":"nrf52_power_management/#architecture","title":"Architecture","text":"

    The power management functionality is integrated into the NRF52Board base class in src/helpers/NRF52Board.cpp. Board variants provide hardware-specific configuration via a PowerMgtConfig struct and override initiateShutdown(uint8_t reason) to perform board-specific power-down work and conditionally enable voltage wake (LPCOMP + VBUS).

    "},{"location":"nrf52_power_management/#early-boot-capture","title":"Early Boot Capture","text":"

    A static constructor with priority 101 in NRF52Board.cpp captures the RESETREAS and GPREGRET2 registers before: - SystemInit() (priority 102) - which clears RESETREAS - Static C++ constructors (default priority 65535)

    This ensures we capture the true reset reason before any initialisation code runs.

    "},{"location":"nrf52_power_management/#board-implementation","title":"Board Implementation","text":"

    To enable power management on a board variant:

    1. Enable in platformio.ini: ini -D NRF52_POWER_MANAGEMENT

    2. Define configuration in variant.h: c #define PWRMGT_VOLTAGE_BOOTLOCK 3300 // Won't boot below this voltage (mV) #define PWRMGT_LPCOMP_AIN 7 // AIN channel for voltage sensing #define PWRMGT_LPCOMP_REFSEL 2 // REFSEL (0-6=1/8..7/8, 7=ARef, 8-15=1/16..15/16)

    3. Implement in board .cpp file: ```cpp #ifdef NRF52_POWER_MANAGEMENT const PowerMgtConfig power_config = { .lpcomp_ain_channel = PWRMGT_LPCOMP_AIN, .lpcomp_refsel = PWRMGT_LPCOMP_REFSEL, .voltage_bootlock = PWRMGT_VOLTAGE_BOOTLOCK };

    void MyBoard::initiateShutdown(uint8_t reason) { // Board-specific shutdown preparation (e.g., disable peripherals) bool enable_lpcomp = (reason == SHUTDOWN_REASON_LOW_VOLTAGE || reason == SHUTDOWN_REASON_BOOT_PROTECT);

     if (enable_lpcomp) {\n   configureVoltageWake(power_config.lpcomp_ain_channel, power_config.lpcomp_refsel);\n }\n\n enterSystemOff(reason);\n

    } #endif

    void MyBoard::begin() { NRF52Board::begin(); // or NRF52BoardDCDC::begin() // ... board setup ...

    #ifdef NRF52_POWER_MANAGEMENT checkBootVoltage(&power_config); #endif } ```

    For user-initiated shutdowns, powerOff() remains board-specific. Power management only arms LPCOMP for automated shutdown reasons (boot protection/low voltage).

    1. Declare override in board .h file: cpp #ifdef NRF52_POWER_MANAGEMENT void initiateShutdown(uint8_t reason) override; #endif
    "},{"location":"nrf52_power_management/#voltage-wake-configuration","title":"Voltage Wake Configuration","text":"

    The LPCOMP (Low Power Comparator) is configured to: - Monitor the specified AIN channel (0-7 corresponding to P0.02-P0.05, P0.28-P0.31) - Compare against VDD fraction reference (REFSEL: 0-6=1/8..7/8, 7=ARef, 8-15=1/16..15/16) - Detect UP events (voltage rising above threshold) - Use 50mV hysteresis for noise immunity - Wake the device from SYSTEMOFF when triggered

    VBUS wake is enabled via the POWER peripheral USBDETECTED event whenever configureVoltageWake() is used. This requires USB VBUS to be routed to the nRF52 (typical on nRF52840 boards with native USB).

    LPCOMP Reference Selection (PWRMGT_LPCOMP_REFSEL): | REFSEL | Fraction | VBAT @ 1M/1M divider (VDD=3.0-3.3) | VBAT @ 1.5M/1M divider (VDD=3.0-3.3) | |--------|----------|------------------------------------|--------------------------------------| | 0 | 1/8 | 0.75-0.82 V | 0.94-1.03 V | | 1 | 2/8 | 1.50-1.65 V | 1.88-2.06 V | | 2 | 3/8 | 2.25-2.47 V | 2.81-3.09 V | | 3 | 4/8 | 3.00-3.30 V | 3.75-4.12 V | | 4 | 5/8 | 3.75-4.12 V | 4.69-5.16 V | | 5 | 6/8 | 4.50-4.95 V | 5.62-6.19 V | | 6 | 7/8 | 5.25-5.77 V | 6.56-7.22 V | | 7 | ARef | - | - | | 8 | 1/16 | 0.38-0.41 V | 0.47-0.52 V | | 9 | 3/16 | 1.12-1.24 V | 1.41-1.55 V | | 10 | 5/16 | 1.88-2.06 V | 2.34-2.58 V | | 11 | 7/16 | 2.62-2.89 V | 3.28-3.61 V | | 12 | 9/16 | 3.38-3.71 V | 4.22-4.64 V | | 13 | 11/16 | 4.12-4.54 V | 5.16-5.67 V | | 14 | 13/16 | 4.88-5.36 V | 6.09-6.70 V | | 15 | 15/16 | 5.62-6.19 V | 7.03-7.73 V |

    Important: For boards with a voltage divider on the battery sense pin, LPCOMP measures the divided voltage. Use: VBAT_threshold \u2248 (VDD * fraction) * divider_scale, where divider_scale = (Rtop + Rbottom) / Rbottom (e.g., 2.0 for 1M/1M, 2.5 for 1.5M/1M, 3.0 for XIAO).

    "},{"location":"nrf52_power_management/#softdevice-compatibility","title":"SoftDevice Compatibility","text":"

    The power management code checks whether SoftDevice is enabled and uses the appropriate API: - When SD enabled: sd_power_* functions - When SD disabled: Direct register access (NRF_POWER->*)

    This ensures compatibility regardless of BLE stack state.

    "},{"location":"nrf52_power_management/#cli-commands","title":"CLI Commands","text":"

    Power management status can be queried via the CLI:

    Command Description get pwrmgt.support Returns \"supported\" or \"unsupported\" get pwrmgt.source Returns current power source - \"battery\" or \"external\" (5V/USB power) get pwrmgt.bootreason Returns reset and shutdown reason strings get pwrmgt.bootmv Returns boot voltage in millivolts

    On boards without power management enabled, all commands except get pwrmgt.support return:

    ERROR: Power management not supported\n
    "},{"location":"nrf52_power_management/#debug-output","title":"Debug Output","text":"

    When MESH_DEBUG=1 is enabled, the power management module outputs:

    DEBUG: PWRMGT: Reset = Wake from LPCOMP (0x20000); Shutdown = Low Voltage (0x4C)\nDEBUG: PWRMGT: Boot voltage = 3450 mV (threshold = 3300 mV)\nDEBUG: PWRMGT: LPCOMP wake configured (AIN7, ref=3/8 VDD)\n
    "},{"location":"nrf52_power_management/#phase-2-planned","title":"Phase 2 (Planned)","text":""},{"location":"nrf52_power_management/#references","title":"References","text":""},{"location":"packet_format/","title":"Packet Format","text":"

    This document describes the MeshCore packet format.

    "},{"location":"packet_format/#version-1-packet-format","title":"Version 1 Packet Format","text":"

    This is the protocol level packet structure used in MeshCore firmware v1.12.0

    [header][transport_codes(optional)][path_length][path][payload]\n
    "},{"location":"packet_format/#packet-format_1","title":"Packet Format","text":"Field Size (bytes) Description header 1 Contains routing type, payload type, and payload version transport_codes 4 (optional) 2x 16-bit transport codes (if ROUTE_TYPE_TRANSPORT_*) path_length 1 Length of the path field in bytes path up to 64 (MAX_PATH_SIZE) Stores the routing path if applicable payload up to 184 (MAX_PACKET_PAYLOAD) Data for the provided Payload Type

    NOTE: see the Payloads documentation for more information about the content of specific payload types.

    "},{"location":"packet_format/#header-format","title":"Header Format","text":"

    Bit 0 means the lowest bit (1s place)

    Bits Mask Field Description 0-1 0x03 Route Type Flood, Direct, etc 2-5 0x3C Payload Type Request, Response, ACK, etc 6-7 0xC0 Payload Version Versioning of the payload format"},{"location":"packet_format/#route-types","title":"Route Types","text":"Value Name Description 0x00 ROUTE_TYPE_TRANSPORT_FLOOD Flood Routing + Transport Codes 0x01 ROUTE_TYPE_FLOOD Flood Routing 0x02 ROUTE_TYPE_DIRECT Direct Routing 0x03 ROUTE_TYPE_TRANSPORT_DIRECT Direct Routing + Transport Codes"},{"location":"packet_format/#payload-types","title":"Payload Types","text":"Value Name Description 0x00 PAYLOAD_TYPE_REQ Request (destination/source hashes + MAC) 0x01 PAYLOAD_TYPE_RESPONSE Response to REQ or ANON_REQ 0x02 PAYLOAD_TYPE_TXT_MSG Plain text message 0x03 PAYLOAD_TYPE_ACK Acknowledgment 0x04 PAYLOAD_TYPE_ADVERT Node advertisement 0x05 PAYLOAD_TYPE_GRP_TXT Group text message (unverified) 0x06 PAYLOAD_TYPE_GRP_DATA Group datagram (unverified) 0x07 PAYLOAD_TYPE_ANON_REQ Anonymous request 0x08 PAYLOAD_TYPE_PATH Returned path 0x09 PAYLOAD_TYPE_TRACE Trace a path, collecting SNR for each hop 0x0A PAYLOAD_TYPE_MULTIPART Packet is part of a sequence of packets 0x0B PAYLOAD_TYPE_CONTROL Control packet data (unencrypted) 0x0C reserved reserved 0x0D reserved reserved 0x0E reserved reserved 0x0F PAYLOAD_TYPE_RAW_CUSTOM Custom packet (raw bytes, custom encryption)"},{"location":"packet_format/#payload-versions","title":"Payload Versions","text":"Value Version Description 0x00 1 1-byte src/dest hashes, 2-byte MAC 0x01 2 Future version (e.g., 2-byte hashes, 4-byte MAC) 0x02 3 Future version 0x03 4 Future version"},{"location":"payloads/","title":"Payload Format","text":"

    Inside each MeshCore Packet is a payload, identified by the payload type in the packet header. The types of payloads are:

    This document defines the structure of each of these payload types.

    NOTE: all 16 and 32-bit integer fields are Little Endian.

    "},{"location":"payloads/#important-concepts","title":"Important concepts:","text":""},{"location":"payloads/#node-advertisement","title":"Node advertisement","text":"

    This kind of payload notifies receivers that a node exists, and gives information about the node

    Field Size (bytes) Description public key 32 Ed25519 public key of the node timestamp 4 unix timestamp of advertisement signature 64 Ed25519 signature of public key, timestamp, and app data appdata rest of payload optional, see below

    Appdata

    Field Size (bytes) Description flags 1 specifies which of the fields are present, see below latitude 4 (optional) decimal latitude multiplied by 1000000, integer longitude 4 (optional) decimal longitude multiplied by 1000000, integer feature 1 2 (optional) reserved for future use feature 2 2 (optional) reserved for future use name rest of appdata name of the node

    Appdata Flags

    Value Name Description 0x01 is chat node advert is for a chat node 0x02 is repeater advert is for a repeater 0x03 is room server advert is for a room server 0x04 is sensor advert is for a sensor server 0x10 has location appdata contains lat/long information 0x20 has feature 1 Reserved for future use. 0x40 has feature 2 Reserved for future use. 0x80 has name appdata contains a node name"},{"location":"payloads/#acknowledgement","title":"Acknowledgement","text":"

    An acknowledgement that a message was received. Note that for returned path messages, an acknowledgement can be sent in the \"extra\" payload (see Returned Path) instead of as a separate ackowledgement packet. CLI commands do not cause acknowledgement responses, neither discrete nor extra.

    Field Size (bytes) Description checksum 4 CRC checksum of message timestamp, text, and sender pubkey"},{"location":"payloads/#returned-path-request-response-and-plain-text-message","title":"Returned path, request, response, and plain text message","text":"

    Returned path, request, response, and plain text messages are all formatted in the same way. See the subsection for more details about the ciphertext's associated plaintext representation.

    Field Size (bytes) Description destination hash 1 first byte of destination node public key source hash 1 first byte of source node public key cipher MAC 2 MAC for encrypted data in next field ciphertext rest of payload encrypted message, see subsections below for details"},{"location":"payloads/#returned-path","title":"Returned path","text":"

    Returned path messages provide a description of the route a packet took from the original author. Receivers will send returned path messages to the author of the original message.

    Field Size (bytes) Description path length 1 length of next field path see above a list of node hashes (one byte each) extra type 1 extra, bundled payload type, eg., acknowledgement or response. Same values as in Packet Format extra rest of data extra, bundled payload content, follows same format as main content defined by this document"},{"location":"payloads/#request","title":"Request","text":"Field Size (bytes) Description timestamp 4 send time (unix timestamp) request type 1 see below request data rest of payload depends on request type

    Request type

    Value Name Description 0x01 get stats get stats of repeater or room server 0x02 keepalive (deprecated) 0x03 get telemetry data TODO 0x04 get min,max,avg data sensor nodes - get min, max, average for given time span 0x05 get access list get node's approved access list 0x06 get neighbors get repeater node's neighbors 0x07 get owner info get repeater firmware-ver/name/owner info"},{"location":"payloads/#get-stats","title":"Get stats","text":"

    Gets information about the node, possibly including the following:

    "},{"location":"payloads/#get-telemetry-data","title":"Get telemetry data","text":"

    Request data about sensors on the node, including battery level.

    "},{"location":"payloads/#get-telemetry","title":"Get Telemetry","text":"

    TODO

    "},{"location":"payloads/#get-minmaxave-sensor-nodes","title":"Get Min/Max/Ave (Sensor nodes)","text":"

    TODO

    "},{"location":"payloads/#get-access-list","title":"Get Access List","text":"

    TODO

    "},{"location":"payloads/#get-neighors","title":"Get Neighors","text":"

    TODO

    "},{"location":"payloads/#get-owner-info","title":"Get Owner Info","text":"

    TODO

    "},{"location":"payloads/#response","title":"Response","text":"Field Size (bytes) Description tag 4 TODO content rest of payload TODO"},{"location":"payloads/#plain-text-message","title":"Plain text message","text":"Field Size (bytes) Description timestamp 4 send time (unix timestamp) txt_type + attempt 1 upper six bits are txt_type (see below), lower two bits are attempt number (0..3) message rest of payload the message content, see next table

    txt_type

    Value Description Message content 0x00 plain text message the plain text of the message 0x01 CLI command the command text of the message 0x02 signed plain text message first four bytes is sender pubkey prefix, followed by plain text message"},{"location":"payloads/#anonymous-request","title":"Anonymous request","text":"Field Size (bytes) Description destination hash 1 first byte of destination node public key public key 32 sender's Ed25519 public key cipher MAC 2 MAC for encrypted data in next field ciphertext rest of payload encrypted message, see below for details"},{"location":"payloads/#room-server-login","title":"Room server login","text":"Field Size (bytes) Description timestamp 4 sender time (unix timestamp) sync timestamp 4 sender's \"sync messages SINCE x\" timestamp password rest of message password for room"},{"location":"payloads/#repeatersensor-login","title":"Repeater/Sensor login","text":"Field Size (bytes) Description timestamp 4 sender time (unix timestamp) password rest of message password for repeater/sensor"},{"location":"payloads/#repeater-regions-request","title":"Repeater - Regions request","text":"Field Size (bytes) Description timestamp 4 sender time (unix timestamp) req type 1 0x01 (request sub type) reply path len 1 path len for reply reply path (variable) reply path"},{"location":"payloads/#repeater-owner-info-request","title":"Repeater - Owner info request","text":"Field Size (bytes) Description timestamp 4 sender time (unix timestamp) req type 1 0x02 (request sub type) reply path len 1 path len for reply reply path (variable) reply path"},{"location":"payloads/#repeater-clock-and-status-request","title":"Repeater - Clock and status request","text":"Field Size (bytes) Description timestamp 4 sender time (unix timestamp) req type 1 0x03 (request sub type) reply path len 1 path len for reply reply path (variable) reply path"},{"location":"payloads/#group-text-message-datagram","title":"Group text message / datagram","text":"Field Size (bytes) Description channel hash 1 first byte of SHA256 of channel's shared key cipher MAC 2 MAC for encrypted data in next field ciphertext rest of payload encrypted message, see below for details

    The plaintext contained in the ciphertext matches the format described in plain text message. Specifically, it consists of a four byte timestamp, a flags byte, and the message. The flags byte will generally be 0x00 because it is a \"plain text message\". The message will be of the form <sender name>: <message body> (eg., user123: I'm on my way).

    "},{"location":"payloads/#control-data","title":"Control data","text":"Field Size (bytes) Description flags 1 upper 4 bits is sub_type data rest of payload typically unencrypted data"},{"location":"payloads/#discover_req-sub_type","title":"DISCOVER_REQ (sub_type)","text":"Field Size (bytes) Description flags 1 0x8 (upper 4 bits), prefix_only (lowest bit) type_filter 1 bit for each ADV_TYPE_* tag 4 randomly generate by sender since 4 (optional) epoch timestamp (0 by default)"},{"location":"payloads/#discover_resp-sub_type","title":"DISCOVER_RESP (sub_type)","text":"Field Size (bytes) Description flags 1 0x9 (upper 4 bits), node_type (lower 4) snr 1 signed, SNR*4 tag 4 reflected back from DISCOVER_REQ pubkey 8 or 32 node's ID (or prefix)"},{"location":"payloads/#custom-packet","title":"Custom packet","text":"

    Custom packets have no defined format.

    "},{"location":"qr_codes/","title":"QR Codes","text":"

    This document provides an overview of QR Code formats that can be used for sharing MeshCore channels and contacts. The formats described below are supported by the MeshCore mobile app.

    "},{"location":"qr_codes/#add-channel","title":"Add Channel","text":"

    Example URL:

    meshcore://channel/add?name=Public&secret=8b3387e9c5cdea6ac9e5edbaa115cd72\n

    Parameters:

    "},{"location":"qr_codes/#add-contact","title":"Add Contact","text":"

    Example URL:

    meshcore://contact/add?name=Example+Contact&public_key=9cd8fcf22a47333b591d96a2b848b73f457b1bb1a3ea2453a885f9e5787765b1&type=1\n

    Parameters:

    "},{"location":"stats_binary_frames/","title":"Stats Binary Frame Structures","text":"

    Binary frame structures for companion radio stats commands. All multi-byte integers use little-endian byte order.

    "},{"location":"stats_binary_frames/#command-codes","title":"Command Codes","text":"Command Code Description CMD_GET_STATS 56 Get statistics (2-byte command: code + sub-type)"},{"location":"stats_binary_frames/#stats-sub-types","title":"Stats Sub-Types","text":"

    The CMD_GET_STATS command uses a 2-byte frame structure: - Byte 0: CMD_GET_STATS (56) - Byte 1: Stats sub-type: - STATS_TYPE_CORE (0) - Get core device statistics - STATS_TYPE_RADIO (1) - Get radio statistics - STATS_TYPE_PACKETS (2) - Get packet statistics

    "},{"location":"stats_binary_frames/#response-codes","title":"Response Codes","text":"Response Code Description RESP_CODE_STATS 24 Statistics response (2-byte response: code + sub-type)"},{"location":"stats_binary_frames/#stats-response-sub-types","title":"Stats Response Sub-Types","text":"

    The RESP_CODE_STATS response uses a 2-byte header structure: - Byte 0: RESP_CODE_STATS (24) - Byte 1: Stats sub-type (matches command sub-type): - STATS_TYPE_CORE (0) - Core device statistics response - STATS_TYPE_RADIO (1) - Radio statistics response - STATS_TYPE_PACKETS (2) - Packet statistics response

    "},{"location":"stats_binary_frames/#resp_code_stats-stats_type_core-24-0","title":"RESP_CODE_STATS + STATS_TYPE_CORE (24, 0)","text":"

    Total Frame Size: 11 bytes

    Offset Size Type Field Name Description Range/Notes 0 1 uint8_t response_code Always 0x18 (24) - 1 1 uint8_t stats_type Always 0x00 (STATS_TYPE_CORE) - 2 2 uint16_t battery_mv Battery voltage in millivolts 0 - 65,535 4 4 uint32_t uptime_secs Device uptime in seconds 0 - 4,294,967,295 8 2 uint16_t errors Error flags bitmask - 10 1 uint8_t queue_len Outbound packet queue length 0 - 255"},{"location":"stats_binary_frames/#example-structure-cc","title":"Example Structure (C/C++)","text":"
    struct StatsCore {\n    uint8_t  response_code;  // 0x18\n    uint8_t  stats_type;     // 0x00 (STATS_TYPE_CORE)\n    uint16_t battery_mv;\n    uint32_t uptime_secs;\n    uint16_t errors;\n    uint8_t  queue_len;\n} __attribute__((packed));\n
    "},{"location":"stats_binary_frames/#resp_code_stats-stats_type_radio-24-1","title":"RESP_CODE_STATS + STATS_TYPE_RADIO (24, 1)","text":"

    Total Frame Size: 14 bytes

    Offset Size Type Field Name Description Range/Notes 0 1 uint8_t response_code Always 0x18 (24) - 1 1 uint8_t stats_type Always 0x01 (STATS_TYPE_RADIO) - 2 2 int16_t noise_floor Radio noise floor in dBm -140 to +10 4 1 int8_t last_rssi Last received signal strength in dBm -128 to +127 5 1 int8_t last_snr SNR scaled by 4 Divide by 4.0 for dB 6 4 uint32_t tx_air_secs Cumulative transmit airtime in seconds 0 - 4,294,967,295 10 4 uint32_t rx_air_secs Cumulative receive airtime in seconds 0 - 4,294,967,295"},{"location":"stats_binary_frames/#example-structure-cc_1","title":"Example Structure (C/C++)","text":"
    struct StatsRadio {\n    uint8_t  response_code;  // 0x18\n    uint8_t  stats_type;     // 0x01 (STATS_TYPE_RADIO)\n    int16_t  noise_floor;\n    int8_t   last_rssi;\n    int8_t   last_snr;       // Divide by 4.0 to get actual SNR in dB\n    uint32_t tx_air_secs;\n    uint32_t rx_air_secs;\n} __attribute__((packed));\n
    "},{"location":"stats_binary_frames/#resp_code_stats-stats_type_packets-24-2","title":"RESP_CODE_STATS + STATS_TYPE_PACKETS (24, 2)","text":"

    Total Frame Size: 26 bytes

    Offset Size Type Field Name Description Range/Notes 0 1 uint8_t response_code Always 0x18 (24) - 1 1 uint8_t stats_type Always 0x02 (STATS_TYPE_PACKETS) - 2 4 uint32_t recv Total packets received 0 - 4,294,967,295 6 4 uint32_t sent Total packets sent 0 - 4,294,967,295 10 4 uint32_t flood_tx Packets sent via flood routing 0 - 4,294,967,295 14 4 uint32_t direct_tx Packets sent via direct routing 0 - 4,294,967,295 18 4 uint32_t flood_rx Packets received via flood routing 0 - 4,294,967,295 22 4 uint32_t direct_rx Packets received via direct routing 0 - 4,294,967,295"},{"location":"stats_binary_frames/#notes","title":"Notes","text":""},{"location":"stats_binary_frames/#example-structure-cc_2","title":"Example Structure (C/C++)","text":"
    struct StatsPackets {\n    uint8_t  response_code;  // 0x18\n    uint8_t  stats_type;     // 0x02 (STATS_TYPE_PACKETS)\n    uint32_t recv;\n    uint32_t sent;\n    uint32_t flood_tx;\n    uint32_t direct_tx;\n    uint32_t flood_rx;\n    uint32_t direct_rx;\n} __attribute__((packed));\n
    "},{"location":"stats_binary_frames/#command-usage-example-python","title":"Command Usage Example (Python)","text":"
    # Send CMD_GET_STATS command\ndef send_get_stats_core(serial_interface):\n    \"\"\"Send command to get core stats\"\"\"\n    cmd = bytes([56, 0])  # CMD_GET_STATS (56) + STATS_TYPE_CORE (0)\n    serial_interface.write(cmd)\n\ndef send_get_stats_radio(serial_interface):\n    \"\"\"Send command to get radio stats\"\"\"\n    cmd = bytes([56, 1])  # CMD_GET_STATS (56) + STATS_TYPE_RADIO (1)\n    serial_interface.write(cmd)\n\ndef send_get_stats_packets(serial_interface):\n    \"\"\"Send command to get packet stats\"\"\"\n    cmd = bytes([56, 2])  # CMD_GET_STATS (56) + STATS_TYPE_PACKETS (2)\n    serial_interface.write(cmd)\n
    "},{"location":"stats_binary_frames/#response-parsing-example-python","title":"Response Parsing Example (Python)","text":"
    import struct\n\ndef parse_stats_core(frame):\n    \"\"\"Parse RESP_CODE_STATS + STATS_TYPE_CORE frame (11 bytes)\"\"\"\n    response_code, stats_type, battery_mv, uptime_secs, errors, queue_len = \\\n        struct.unpack('<B B H I H B', frame)\n    assert response_code == 24 and stats_type == 0, \"Invalid response type\"\n    return {\n        'battery_mv': battery_mv,\n        'uptime_secs': uptime_secs,\n        'errors': errors,\n        'queue_len': queue_len\n    }\n\ndef parse_stats_radio(frame):\n    \"\"\"Parse RESP_CODE_STATS + STATS_TYPE_RADIO frame (14 bytes)\"\"\"\n    response_code, stats_type, noise_floor, last_rssi, last_snr, tx_air_secs, rx_air_secs = \\\n        struct.unpack('<B B h b b I I', frame)\n    assert response_code == 24 and stats_type == 1, \"Invalid response type\"\n    return {\n        'noise_floor': noise_floor,\n        'last_rssi': last_rssi,\n        'last_snr': last_snr / 4.0,  # Unscale SNR\n        'tx_air_secs': tx_air_secs,\n        'rx_air_secs': rx_air_secs\n    }\n\ndef parse_stats_packets(frame):\n    \"\"\"Parse RESP_CODE_STATS + STATS_TYPE_PACKETS frame (26 bytes)\"\"\"\n    response_code, stats_type, recv, sent, flood_tx, direct_tx, flood_rx, direct_rx = \\\n        struct.unpack('<B B I I I I I I', frame)\n    assert response_code == 24 and stats_type == 2, \"Invalid response type\"\n    return {\n        'recv': recv,\n        'sent': sent,\n        'flood_tx': flood_tx,\n        'direct_tx': direct_tx,\n        'flood_rx': flood_rx,\n        'direct_rx': direct_rx\n    }\n
    "},{"location":"stats_binary_frames/#command-usage-example-javascripttypescript","title":"Command Usage Example (JavaScript/TypeScript)","text":"
    // Send CMD_GET_STATS command\nconst CMD_GET_STATS = 56;\nconst STATS_TYPE_CORE = 0;\nconst STATS_TYPE_RADIO = 1;\nconst STATS_TYPE_PACKETS = 2;\n\nfunction sendGetStatsCore(serialInterface: SerialPort): void {\n    const cmd = new Uint8Array([CMD_GET_STATS, STATS_TYPE_CORE]);\n    serialInterface.write(cmd);\n}\n\nfunction sendGetStatsRadio(serialInterface: SerialPort): void {\n    const cmd = new Uint8Array([CMD_GET_STATS, STATS_TYPE_RADIO]);\n    serialInterface.write(cmd);\n}\n\nfunction sendGetStatsPackets(serialInterface: SerialPort): void {\n    const cmd = new Uint8Array([CMD_GET_STATS, STATS_TYPE_PACKETS]);\n    serialInterface.write(cmd);\n}\n
    "},{"location":"stats_binary_frames/#response-parsing-example-javascripttypescript","title":"Response Parsing Example (JavaScript/TypeScript)","text":"
    interface StatsCore {\n    battery_mv: number;\n    uptime_secs: number;\n    errors: number;\n    queue_len: number;\n}\n\ninterface StatsRadio {\n    noise_floor: number;\n    last_rssi: number;\n    last_snr: number;\n    tx_air_secs: number;\n    rx_air_secs: number;\n}\n\ninterface StatsPackets {\n    recv: number;\n    sent: number;\n    flood_tx: number;\n    direct_tx: number;\n    flood_rx: number;\n    direct_rx: number;\n}\n\nfunction parseStatsCore(buffer: ArrayBuffer): StatsCore {\n    const view = new DataView(buffer);\n    const response_code = view.getUint8(0);\n    const stats_type = view.getUint8(1);\n    if (response_code !== 24 || stats_type !== 0) {\n        throw new Error('Invalid response type');\n    }\n    return {\n        battery_mv: view.getUint16(2, true),\n        uptime_secs: view.getUint32(4, true),\n        errors: view.getUint16(8, true),\n        queue_len: view.getUint8(10)\n    };\n}\n\nfunction parseStatsRadio(buffer: ArrayBuffer): StatsRadio {\n    const view = new DataView(buffer);\n    const response_code = view.getUint8(0);\n    const stats_type = view.getUint8(1);\n    if (response_code !== 24 || stats_type !== 1) {\n        throw new Error('Invalid response type');\n    }\n    return {\n        noise_floor: view.getInt16(2, true),\n        last_rssi: view.getInt8(4),\n        last_snr: view.getInt8(5) / 4.0,  // Unscale SNR\n        tx_air_secs: view.getUint32(6, true),\n        rx_air_secs: view.getUint32(10, true)\n    };\n}\n\nfunction parseStatsPackets(buffer: ArrayBuffer): StatsPackets {\n    const view = new DataView(buffer);\n    const response_code = view.getUint8(0);\n    const stats_type = view.getUint8(1);\n    if (response_code !== 24 || stats_type !== 2) {\n        throw new Error('Invalid response type');\n    }\n    return {\n        recv: view.getUint32(2, true),\n        sent: view.getUint32(6, true),\n        flood_tx: view.getUint32(10, true),\n        direct_tx: view.getUint32(14, true),\n        flood_rx: view.getUint32(18, true),\n        direct_rx: view.getUint32(22, true)\n    };\n}\n
    "},{"location":"stats_binary_frames/#field-size-considerations","title":"Field Size Considerations","text":""},{"location":"terminal_chat_cli/","title":"Terminal Chat CLI","text":"

    Below are the commands you can enter into the Terminal Chat clients:

    set freq {frequency}\n

    Set the LoRa frequency. Example: set freq 915.8

    set tx {tx-power-dbm}\n

    Sets LoRa transmit power in dBm.

    set name {name}\n

    Sets your advertisement name.

    set lat {latitude}\n

    Sets your advertisement map latitude. (decimal degrees)

    set lon {longitude}\n

    Sets your advertisement map longitude. (decimal degrees)

    set af {air-time-factor}\n

    Sets the transmit air-time-factor.

    time {epoch-secs}\n

    Set the device clock using UNIX epoch seconds. Example: time 1738242833

    advert\n

    Sends an advertisement packet

    clock\n

    Displays current time per device's clock.

    ver\n

    Shows the device version and firmware build date.

    card\n

    Displays your 'business card', for other to manually import

    import {card}\n

    Imports the given card to your contacts.

    list {n}\n

    List all contacts by most recent. (optional {n}, is the last n by advertisement date)

    to\n

    Shows the name of current recipient contact. (for subsequent 'send' commands)

    to {name-prefix}\n

    Sets the recipient to the first matching contact (in 'list') by the name prefix. (ie. you don't have to type whole name)

    send {text}\n

    Sends the text message (as DM) to current recipient.

    reset path\n

    Resets the path to current recipient, for new path discovery.

    public {text}\n

    Sends the text message to the built-in 'public' group channel

    "}]} \ No newline at end of file +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Introduction","text":"

    Welcome to the MeshCore documentation.

    Below are a few quick start guides.

    If you find a mistake in any of our documentation, or find something is missing, please feel free to open a pull request for us to review.

    "},{"location":"cli_commands/","title":"CLI Commands","text":"

    This document provides an overview of CLI commands that can be sent to MeshCore Repeaters, Room Servers and Sensors.

    "},{"location":"cli_commands/#navigation","title":"Navigation","text":""},{"location":"cli_commands/#operational","title":"Operational","text":""},{"location":"cli_commands/#reboot-the-node","title":"Reboot the node","text":"

    Usage: - reboot

    "},{"location":"cli_commands/#reset-the-clock-and-reboot","title":"Reset the clock and reboot","text":"

    Usage: - clkreboot

    "},{"location":"cli_commands/#sync-the-clock-with-the-remote-device","title":"Sync the clock with the remote device","text":"

    Usage: - clock sync

    "},{"location":"cli_commands/#display-current-time-in-utc","title":"Display current time in UTC","text":"

    Usage: - clock

    "},{"location":"cli_commands/#set-the-time-to-a-specific-timestamp","title":"Set the time to a specific timestamp","text":"

    Usage: - time <epoch_seconds>

    Parameters: - epoc_seconds: Unix epoc time

    "},{"location":"cli_commands/#send-a-flood-advert","title":"Send a flood advert","text":"

    Usage: - advert

    "},{"location":"cli_commands/#start-an-over-the-air-ota-firmware-update","title":"Start an Over-The-Air (OTA) firmware update","text":"

    Usage: - start ota

    "},{"location":"cli_commands/#erasefactory-reset","title":"Erase/Factory Reset","text":"

    Usage: - erase

    Serial Only: Yes

    Warning: This is destructive!

    "},{"location":"cli_commands/#neighbors-repeater-only","title":"Neighbors (Repeater Only)","text":""},{"location":"cli_commands/#list-nearby-neighbors","title":"List nearby neighbors","text":"

    Usage: - neighbors

    Note: The output of this command is limited to the 8 most recent adverts.

    Note: Each line is encoded as {pubkey-prefix}:{timestamp}:{snr*4}

    "},{"location":"cli_commands/#remove-a-neighbor","title":"Remove a neighbor","text":"

    Usage: - neighbor.remove <pubkey_prefix>

    Parameters: - pubkey_prefix: The public key of the node to remove from the neighbors list

    "},{"location":"cli_commands/#statistics","title":"Statistics","text":""},{"location":"cli_commands/#clear-stats","title":"Clear Stats","text":"

    Usage: clear stats

    "},{"location":"cli_commands/#system-stats-battery-uptime-queue-length-and-debug-flags","title":"System Stats - Battery, Uptime, Queue Length and Debug Flags","text":"

    Usage: - stats-core

    Serial Only: Yes

    "},{"location":"cli_commands/#radio-stats-noise-floor-last-rssisnr-airtime-receive-errors","title":"Radio Stats - Noise floor, Last RSSI/SNR, Airtime, Receive errors","text":"

    Usage: stats-radio

    Serial Only: Yes

    "},{"location":"cli_commands/#packet-stats-packet-counters-received-sent","title":"Packet stats - Packet counters: Received, Sent","text":"

    Usage: stats-packets

    Serial Only: Yes

    "},{"location":"cli_commands/#logging","title":"Logging","text":""},{"location":"cli_commands/#begin-capture-of-rx-log-to-node-storage","title":"Begin capture of rx log to node storage","text":"

    Usage: log start

    "},{"location":"cli_commands/#end-capture-of-rx-log-to-node-sotrage","title":"End capture of rx log to node sotrage","text":"

    Usage: log stop

    "},{"location":"cli_commands/#erase-captured-log","title":"Erase captured log","text":"

    Usage: log erase

    "},{"location":"cli_commands/#print-the-captured-log-to-the-serial-terminal","title":"Print the captured log to the serial terminal","text":"

    Usage: log

    Serial Only: Yes

    "},{"location":"cli_commands/#info","title":"Info","text":""},{"location":"cli_commands/#get-the-version","title":"Get the Version","text":"

    Usage: ver

    "},{"location":"cli_commands/#show-the-hardware-name","title":"Show the hardware name","text":"

    Usage: board

    "},{"location":"cli_commands/#configuration","title":"Configuration","text":""},{"location":"cli_commands/#radio","title":"Radio","text":""},{"location":"cli_commands/#view-or-change-this-nodes-radio-parameters","title":"View or change this node's radio parameters","text":"

    Usage: - get radio - set radio <freq>,<bw>,<sf>,<cr>

    Parameters: - freq: Frequency in MHz - bw: Bandwidth in kHz - sf: Spreading factor (5-12) - cr: Coding rate (5-8)

    Set by build flag: LORA_FREQ, LORA_BW, LORA_SF, LORA_CR

    Default: 869.525,250,11,5

    Note: Requires reboot to apply

    "},{"location":"cli_commands/#view-or-change-this-nodes-transmit-power","title":"View or change this node's transmit power","text":"

    Usage: - get tx - set tx <dbm>

    Parameters: - dbm: Power level in dBm (1-22)

    Set by build flag: LORA_TX_POWER

    Default: Varies by board

    Notes: This setting only controls the power level of the LoRa chip. Some nodes have an additional power amplifier stage which increases the total output. Referr to the node's manual for the correct setting to use. Setting a value too high may violate the laws in your country.

    "},{"location":"cli_commands/#change-the-radio-parameters-for-a-set-duration","title":"Change the radio parameters for a set duration","text":"

    Usage: - tempradio <freq>,<bw>,<sf>,<cr>,<timeout_mins>

    Parameters: - freq: Frequency in MHz (300-2500) - bw: Bandwidth in kHz (7.8-500) - sf: Spreading factor (5-12) - cr: Coding rate (5-8) - timeout_mins: Duration in minutes (must be > 0)

    Note: This is not saved to preferences and will clear on reboot

    "},{"location":"cli_commands/#view-or-change-this-nodes-frequency","title":"View or change this node's frequency","text":"

    Usage: - get freq - set freq <frequency>

    Parameters: - frequency: Frequency in MHz

    Default: 869.525

    Note: Requires reboot to apply

    "},{"location":"cli_commands/#system","title":"System","text":""},{"location":"cli_commands/#view-or-change-this-nodes-name","title":"View or change this node's name","text":"

    Usage: - get name - set name <name>

    Parameters: - name: Node name

    Set by build flag: ADVERT_NAME

    Default: Varies by board

    Note: Max length varies. If a location is set, the max length is 24 bytes; 32 otherwise. Emoji and unicode characters may take more than one byte.

    "},{"location":"cli_commands/#view-or-change-this-nodes-latitude","title":"View or change this node's latitude","text":"

    Usage: - get lat - set lat <degrees>

    Set by build flag: ADVERT_LAT

    Default: 0

    Parameters: - degrees: Latitude in degrees

    "},{"location":"cli_commands/#view-or-change-this-nodes-longitude","title":"View or change this node's longitude","text":"

    Usage: - get lon - set lon <degrees>

    Set by build flag: ADVERT_LON

    Default: 0

    Parameters: - degrees: Longitude in degrees

    "},{"location":"cli_commands/#view-or-change-this-nodes-identity-private-key","title":"View or change this node's identity (Private Key)","text":"

    Usage: - get prv.key - set prv.key <private_key>

    Parameters: - private_key: Private key in hex format (64 hex characters)

    Serial Only: - get prv.key: Yes - set prv.key: No

    Note: Requires reboot to take effect after setting

    "},{"location":"cli_commands/#view-or-change-this-nodes-admin-password","title":"View or change this node's admin password","text":"

    Usage: - get password - set password <password>

    Parameters: - password: Admin password

    Set by build flag: ADMIN_PASSWORD

    Default: password

    Note: Echoed back for confirmation

    Note: Any node using this password will be added to the admin ACL list.

    "},{"location":"cli_commands/#view-or-change-this-nodes-guest-password","title":"View or change this node's guest password","text":"

    Usage: - get guest.password - set guest.password <password>

    Parameters: - password: Guest password

    Set by build flag: ROOM_PASSWORD (Room Server only)

    Default: <blank>

    "},{"location":"cli_commands/#view-or-change-this-nodes-owner-info","title":"View or change this node's owner info","text":"

    Usage: - get owner.info - set owner.info <text>

    Parameters: - text: Owner information text

    Default: <blank>

    Note: | characters are translated to newlines

    Note: Requires firmware 1.12.+

    "},{"location":"cli_commands/#fine-tune-the-battery-reading","title":"Fine-tune the battery reading","text":"

    Usage: - get adc.multiplier - set adc.multiplier <value>

    Parameters: - value: ADC multiplier (0.0-10.0)

    Default: 0.0 (value defined by board)

    Note: Returns \"Error: unsupported by this board\" if hardware doesn't support it

    "},{"location":"cli_commands/#view-or-change-this-nodes-power-saving-flag-repeater-only","title":"View or change this node's power saving flag (Repeater Only)","text":"

    Usage: - powersaving <state> - powersaving

    Parameters: - state: on|off

    Default: on

    Note: When enabled, device enters sleep mode between radio transmissions

    "},{"location":"cli_commands/#routing","title":"Routing","text":""},{"location":"cli_commands/#view-or-change-this-nodes-repeat-flag","title":"View or change this node's repeat flag","text":"

    Usage: - get repeat - set repeat <state>

    Parameters: - state: on|off

    Default: on

    "},{"location":"cli_commands/#view-or-change-the-retransmit-delay-factor-for-flood-traffic","title":"View or change the retransmit delay factor for flood traffic","text":"

    Usage: - get txdelay - set txdelay <value>

    Parameters: - value: Transmit delay factor (0-2)

    Default: 0.5

    "},{"location":"cli_commands/#view-or-change-the-retransmit-delay-factor-for-direct-traffic","title":"View or change the retransmit delay factor for direct traffic","text":"

    Usage: - get direct.txdelay - set direct.txdelay <value>

    Parameters: - value: Direct transmit delay factor (0-2)

    Default: 0.2

    "},{"location":"cli_commands/#experimental-view-or-change-the-processing-delay-for-received-traffic","title":"[Experimental] View or change the processing delay for received traffic","text":"

    Usage: - get rxdelay - set rxdelay <value>

    Parameters: - value: Receive delay base (0-20)

    Default: 0.0

    "},{"location":"cli_commands/#view-or-change-the-airtime-factor-duty-cycle-limit","title":"View or change the airtime factor (duty cycle limit)","text":"

    Usage: - get af - set af <value>

    Parameters: - value: Airtime factor (0-9)

    Default: 1.0

    "},{"location":"cli_commands/#view-or-change-the-local-interference-threshold","title":"View or change the local interference threshold","text":"

    Usage: - get int.thresh - set int.thresh <value>

    Parameters: - value: Interference threshold value

    Default: 0.0

    "},{"location":"cli_commands/#view-or-change-the-agc-reset-interval","title":"View or change the AGC Reset Interval","text":"

    Usage: - get agc.reset.interval - set agc.reset.interval <value>

    Parameters: - value: Interval in seconds rounded down to a multiple of 4 (17 becomes 16)

    Default: 0.0

    "},{"location":"cli_commands/#enable-or-disable-multi-acks-support","title":"Enable or disable Multi-Acks support","text":"

    Usage: - get multi.acks - set multi.acks <state>

    Parameters: - state: 0 (disable) or 1 (enable)

    Default: 0

    "},{"location":"cli_commands/#view-or-change-the-flood-advert-interval","title":"View or change the flood advert interval","text":"

    Usage: - get flood.advert.interval - set flood.advert.interval <hours>

    Parameters: - hours: Interval in hours (3-168)

    Default: 12 (Repeater) - 0 (Sensor)

    "},{"location":"cli_commands/#view-or-change-the-zero-hop-advert-interval","title":"View or change the zero-hop advert interval","text":"

    Usage: - get advert.interval - set advert.interval <minutes>

    Parameters: - minutes: Interval in minutes rounded down to the nearest multiple of 2 (61 becomes 60) (60-240)

    Default: 0

    "},{"location":"cli_commands/#limit-the-number-of-hops-for-a-flood-message","title":"Limit the number of hops for a flood message","text":"

    Usage: - get flood.max - set flood.max <value>

    Parameters: - value: Maximum flood hop count (0-64)

    Default: 64

    "},{"location":"cli_commands/#acl","title":"ACL","text":""},{"location":"cli_commands/#add-update-or-remove-permissions-for-a-companion","title":"Add, update or remove permissions for a companion","text":"

    Usage: - setperm <pubkey> <permissions>

    Parameters: - pubkey: Companion public key - permissions: - 0: Guest - 1: Read-only - 2: Read-write - 3: Admin

    Note: Removes the entry when permissions is omitted

    "},{"location":"cli_commands/#view-the-current-acl","title":"View the current ACL","text":"

    Usage: - get acl

    Serial Only: Yes

    "},{"location":"cli_commands/#view-or-change-this-room-servers-read-only-flag","title":"View or change this room server's 'read-only' flag","text":"

    Usage: - get allow.read.only - set allow.read.only <state>

    Parameters: - state: on (enable) or off (disable)

    Default: off

    "},{"location":"cli_commands/#region-management-v110","title":"Region Management (v1.10.+)","text":""},{"location":"cli_commands/#bulk-load-region-lists","title":"Bulk-load region lists","text":"

    Usage: - region load - region load <name> [flood_flag]

    Parameters: - name: A name of a region. * represents the wildcard region

    Note: flood_flag: Optional F to allow flooding

    Note: Indentation creates parent-child relationships (max 8 levels)

    Note: region load with an empty name will not work remotely (it's interactive)

    "},{"location":"cli_commands/#save-any-changes-to-regions-made-since-reboot","title":"Save any changes to regions made since reboot","text":"

    Usage: - region save

    "},{"location":"cli_commands/#allow-a-region","title":"Allow a region","text":"

    Usage: - region allowf <name>

    Parameters: - name: Region name (or * for wildcard)

    Note: Setting on wildcard * allows packets without region transport codes

    "},{"location":"cli_commands/#block-a-region","title":"Block a region","text":"

    Usage: - region denyf <name>

    Parameters: - name: Region name (or * for wildcard)

    Note: Setting on wildcard * drops packets without region transport codes

    "},{"location":"cli_commands/#show-information-for-a-region","title":"Show information for a region","text":"

    Usage: - region get <name>

    Parameters: - name: Region name (or * for wildcard)

    "},{"location":"cli_commands/#view-or-change-the-home-region-for-this-node","title":"View or change the home region for this node","text":"

    Usage: - region home - region home <name>

    Parameters: - name: Region name

    "},{"location":"cli_commands/#create-a-new-region","title":"Create a new region","text":"

    Usage: - region put <name> [parent_name]

    Parameters: - name: Region name - parent_name: Parent region name (optional, defaults to wildcard)

    "},{"location":"cli_commands/#remove-a-region","title":"Remove a region","text":"

    Usage: - region remove <name>

    Parameters: - name: Region name

    Note: Must remove all child regions before the region can be removed

    "},{"location":"cli_commands/#view-all-regions","title":"View all regions","text":"

    Usage: - region list <filter>

    Serial Only: Yes

    Parameters: - filter: allowed|denied

    Note: Requires firmware 1.12.+

    "},{"location":"cli_commands/#dump-all-defined-regions-and-flood-permissions","title":"Dump all defined regions and flood permissions","text":"

    Usage: - region

    Serial Only: Yes

    "},{"location":"cli_commands/#region-examples","title":"Region Examples","text":"

    Example 1: Using F Flag with Named Public Region

    region load\n#Europe F\n<blank line to end region load>\nregion save\n

    Explanation: - Creates a region named #Europe with flooding enabled - Packets from this region will be flooded to other nodes

    Example 2: Using Wildcard with F Flag

    region load \n* F\n<blank line to end region load>\nregion save\n

    Explanation: - Creates a wildcard region * with flooding enabled - Enables flooding for all regions automatically - Applies only to packets without transport codes

    Example 3: Using Wildcard Without F Flag

    region load \n*\n<blank line to end region load>\nregion save\n

    Explanation: - Creates a wildcard region * without flooding - This region exists but doesn't affect packet distribution - Used as a default/empty region

    Example 4: Nested Public Region with F Flag

    region load \n#Europe F\n  #UK\n    #London\n    #Manchester\n  #France\n    #Paris\n    #Lyon\n<blank line to end region load>\nregion save\n

    Explanation: - Creates #Europe region with flooding enabled - Adds nested child regions (#UK, #France) - All nested regions inherit the flooding flag from parent

    Example 5: Wildcard with Nested Public Regions

    region load \n* F\n  #NorthAmerica\n    #USA\n      #NewYork\n      #California\n    #Canada\n      #Ontario\n      #Quebec\n<blank line to end region load>\nregion save\n

    Explanation: - Creates wildcard region * with flooding enabled - Adds nested #NorthAmerica hierarchy - Enables flooding for all child regions automatically - Useful for global networks with specific regional rules

    "},{"location":"cli_commands/#gps-when-gps-support-is-compiled-in","title":"GPS (When GPS support is compiled in)","text":""},{"location":"cli_commands/#view-or-change-gps-state","title":"View or change GPS state","text":"

    Usage: - gps - gps <state>

    Parameters: - state: on|off

    Default: off

    Note: Output format: {status}, {fix}, {sat count} (when enabled)

    "},{"location":"cli_commands/#sync-this-nodes-clock-with-gps-time","title":"Sync this node's clock with GPS time","text":"

    Usage: - gps sync

    "},{"location":"cli_commands/#set-this-nodes-location-based-on-the-gps-coordinates","title":"Set this node's location based on the GPS coordinates","text":"

    Usage: - gps setloc

    "},{"location":"cli_commands/#view-or-change-the-gps-advert-policy","title":"View or change the GPS advert policy","text":"

    Usage: - gps advert - gps advert <policy>

    Parameters: - policy: none|shared|prefs - none: don't include location in adverts - share: share gps location (from SensorManager) - prefs: location stored in node's lat and lon settings

    Default: prefs

    "},{"location":"cli_commands/#sensors-when-sensor-support-is-compiled-in","title":"Sensors (When sensor support is compiled in)","text":""},{"location":"cli_commands/#view-the-list-of-sensors-on-this-node","title":"View the list of sensors on this node","text":"

    Usage: sensor list [start]

    Parameters: - start: Optional starting index (defaults to 0)

    Note: Output format: <var_name>=<value>\\n

    "},{"location":"cli_commands/#view-or-change-thevalue-of-a-sensor","title":"View or change thevalue of a sensor","text":"

    Usage: - sensor get <key> - sensor set <key> <value>

    Parameters: - key: Sensor setting name - value: The value to set the sensor to

    "},{"location":"cli_commands/#bridge-when-bridge-support-is-compiled-in","title":"Bridge (When bridge support is compiled in)","text":""},{"location":"cli_commands/#view-or-change-the-bridge-enabled-flag","title":"View or change the bridge enabled flag","text":"

    Usage: - get bridge.enabled - set bridge.enabled <state>

    Parameters: - state: on|off

    Default: off

    "},{"location":"cli_commands/#view-the-bridge-source","title":"View the bridge source","text":"

    Usage: - get bridge.source

    "},{"location":"cli_commands/#add-a-delay-to-packets-routed-through-this-bridge","title":"Add a delay to packets routed through this bridge","text":"

    Usage: - get bridge.delay - set bridge.delay <ms>

    Parameters: - ms: Delay in milliseconds (0-10000)

    Default: 500

    "},{"location":"cli_commands/#view-or-change-the-source-of-packets-bridged-to-the-external-interface","title":"View or change the source of packets bridged to the external interface","text":"

    Usage: - get bridge.source - set bridge.source <source>

    Parameters: - source: - rx: bridges received packets - tx: bridges transmitted packets

    Default: tx

    "},{"location":"cli_commands/#view-or-change-the-speed-of-the-bridge-rs-232-only","title":"View or change the speed of the bridge (RS-232 only)","text":"

    Usage: - get bridge.baud - set bridge.baud <rate>

    Parameters: - rate: Baud rate (9600, 19200, 38400, 57600, or 115200)

    Default: 115200

    "},{"location":"cli_commands/#view-or-change-the-channel-used-for-bridging-espnow-only","title":"View or change the channel used for bridging (ESPNow only)","text":"

    Usage: - get bridge.channel - set bridge.channel <channel>

    Parameters: - channel: Channel number (1-14)

    "},{"location":"cli_commands/#set-the-esp-now-secret","title":"Set the ESP-Now secret","text":"

    Usage: - get bridge.secret - set bridge.secret <secret>

    Parameters: - secret: 16-character encryption secret

    Default: Varies by board

    "},{"location":"companion_protocol/","title":"Companion Protocol","text":"

    NOTE: This document is still in development. Some information may be inaccurate.

    This document provides a comprehensive guide for communicating with MeshCore devices over Bluetooth Low Energy (BLE).

    It is platform-agnostic and can be used for Android, iOS, Python, JavaScript, or any other platform that supports BLE.

    "},{"location":"companion_protocol/#official-libraries","title":"Official Libraries","text":"

    Please see the following repos for existing MeshCore Companion Protocol libraries.

    "},{"location":"companion_protocol/#important-security-note","title":"Important Security Note","text":"

    All secrets, hashes, and cryptographic values shown in this guide are example values only.

    "},{"location":"companion_protocol/#table-of-contents","title":"Table of Contents","text":"
    1. BLE Connection
    2. Packet Structure
    3. Commands
    4. Channel Management
    5. Message Handling
    6. Response Parsing
    7. Example Implementation Flow
    8. Best Practices
    9. Troubleshooting
    "},{"location":"companion_protocol/#ble-connection","title":"BLE Connection","text":""},{"location":"companion_protocol/#service-and-characteristics","title":"Service and Characteristics","text":"

    MeshCore Companion devices expose a BLE service with the following UUIDs:

    "},{"location":"companion_protocol/#connection-steps","title":"Connection Steps","text":"

    1. Scan for Devices

    2. Connect to GATT

    3. Discover Services and Characteristics

    4. Enable Notifications

    5. Send Initial Commands

    Note: MeshCore devices may disconnect after periods of inactivity. Implement auto-reconnect logic with exponential backoff.

    "},{"location":"companion_protocol/#ble-write-type","title":"BLE Write Type","text":"

    When writing commands to the RX characteristic, specify the write type:

    Platform-specific:

    Recommendation: Use write with response for reliability.

    "},{"location":"companion_protocol/#mtu-maximum-transmission-unit","title":"MTU (Maximum Transmission Unit)","text":"

    The default BLE MTU is 23 bytes (20 bytes payload). For larger commands like SET_CHANNEL (66 bytes), you may need to:

    1. Request Larger MTU: Request MTU of 512 bytes if supported
    "},{"location":"companion_protocol/#command-sequencing","title":"Command Sequencing","text":"

    Critical: Commands must be sent in the correct sequence:

    1. After Connection:

    2. Command-Response Matching:

    "},{"location":"companion_protocol/#command-queue-management","title":"Command Queue Management","text":"

    For reliable operation, implement a command queue.

    Queue Structure:

    Error Handling:

    "},{"location":"companion_protocol/#packet-structure","title":"Packet Structure","text":"

    The MeshCore protocol uses a binary format with the following structure:

    Most packets follow this format:

    [Packet Type (1 byte)] [Data (variable length)]\n

    The first byte indicates the packet type (see Response Parsing).

    "},{"location":"companion_protocol/#commands","title":"Commands","text":""},{"location":"companion_protocol/#1-app-start","title":"1. App Start","text":"

    Purpose: Initialize communication with the device. Must be sent first after connection.

    Command Format:

    Byte 0: 0x01\nByte 1: 0x03\nBytes 2-10: \"mccli\" (ASCII, null-padded to 9 bytes)\n

    Example (hex):

    01 03 6d 63 63 6c 69 00 00 00 00\n

    Response: PACKET_OK (0x00)

    "},{"location":"companion_protocol/#2-device-query","title":"2. Device Query","text":"

    Purpose: Query device information.

    Command Format:

    Byte 0: 0x16\nByte 1: 0x03\n

    Example (hex):

    16 03\n

    Response: PACKET_DEVICE_INFO (0x0D) with device information

    "},{"location":"companion_protocol/#3-get-channel-info","title":"3. Get Channel Info","text":"

    Purpose: Retrieve information about a specific channel.

    Command Format:

    Byte 0: 0x1F\nByte 1: Channel Index (0-7)\n

    Example (get channel 1):

    1F 01\n

    Response: PACKET_CHANNEL_INFO (0x12) with channel details

    Note: The device does not return channel secrets for security reasons. Store secrets locally when creating channels.

    "},{"location":"companion_protocol/#4-set-channel","title":"4. Set Channel","text":"

    Purpose: Create or update a channel on the device.

    Command Format:

    Byte 0: 0x20\nByte 1: Channel Index (0-7)\nBytes 2-33: Channel Name (32 bytes, UTF-8, null-padded)\nBytes 34-65: Secret (32 bytes)\n

    Total Length: 66 bytes

    Channel Index: - Index 0: Reserved for public channels (no secret) - Indices 1-7: Available for private channels

    Channel Name: - UTF-8 encoded - Maximum 32 bytes - Padded with null bytes (0x00) if shorter

    Secret Field (32 bytes): - For private channels: 32-byte secret - For public channels: All zeros (0x00)

    Example (create channel \"YourChannelName\" at index 1 with secret):

    20 01 53 4D 53 00 00 ... (name padded to 32 bytes)\n    [32 bytes of secret]\n

    Response: PACKET_OK (0x00) on success, PACKET_ERROR (0x01) on failure

    "},{"location":"companion_protocol/#5-send-channel-message","title":"5. Send Channel Message","text":"

    Purpose: Send a text message to a channel.

    Command Format:

    Byte 0: 0x03\nByte 1: 0x00\nByte 2: Channel Index (0-7)\nBytes 3-6: Timestamp (32-bit little-endian Unix timestamp, seconds)\nBytes 7+: Message Text (UTF-8, variable length)\n

    Timestamp: Unix timestamp in seconds (32-bit unsigned integer, little-endian)

    Example (send \"Hello\" to channel 1 at timestamp 1234567890):

    03 00 01 D2 02 96 49 48 65 6C 6C 6F\n

    Response: PACKET_MSG_SENT (0x06) on success

    "},{"location":"companion_protocol/#6-get-message","title":"6. Get Message","text":"

    Purpose: Request the next queued message from the device.

    Command Format:

    Byte 0: 0x0A\n

    Example (hex):

    0A\n

    Response: - PACKET_CHANNEL_MSG_RECV (0x08) or PACKET_CHANNEL_MSG_RECV_V3 (0x11) for channel messages - PACKET_CONTACT_MSG_RECV (0x07) or PACKET_CONTACT_MSG_RECV_V3 (0x10) for contact messages - PACKET_NO_MORE_MSGS (0x0A) if no messages available

    Note: Poll this command periodically to retrieve queued messages. The device may also send PACKET_MESSAGES_WAITING (0x83) as a notification when messages are available.

    "},{"location":"companion_protocol/#7-get-battery","title":"7. Get Battery","text":"

    Purpose: Query device battery level.

    Command Format:

    Byte 0: 0x14\n

    Example (hex):

    14\n

    Response: PACKET_BATTERY (0x0C) with battery percentage

    "},{"location":"companion_protocol/#channel-management","title":"Channel Management","text":""},{"location":"companion_protocol/#channel-types","title":"Channel Types","text":"
    1. Public Channel
    2. Hashtag Channels
    3. Private Channels
    "},{"location":"companion_protocol/#channel-lifecycle","title":"Channel Lifecycle","text":"
    1. Set Channel:
    2. Get Channel:
    3. Delete Channel:
    "},{"location":"companion_protocol/#message-handling","title":"Message Handling","text":""},{"location":"companion_protocol/#receiving-messages","title":"Receiving Messages","text":"

    Messages are received via the RX characteristic (notifications). The device sends:

    1. Channel Messages:
    2. PACKET_CHANNEL_MSG_RECV (0x08) - Standard format

    3. PACKET_CHANNEL_MSG_RECV_V3 (0x11) - Version 3 with SNR

    4. Contact Messages:

    5. PACKET_CONTACT_MSG_RECV (0x07) - Standard format

    6. PACKET_CONTACT_MSG_RECV_V3 (0x10) - Version 3 with SNR

    7. Notifications:

    8. PACKET_MESSAGES_WAITING (0x83) - Indicates messages are queued
    "},{"location":"companion_protocol/#contact-message-format","title":"Contact Message Format","text":"

    Standard Format (PACKET_CONTACT_MSG_RECV, 0x07):

    Byte 0: 0x07 (packet type)\nBytes 1-6: Public Key Prefix (6 bytes, hex)\nByte 7: Path Length\nByte 8: Text Type\nBytes 9-12: Timestamp (32-bit little-endian)\nBytes 13-16: Signature (4 bytes, only if txt_type == 2)\nBytes 17+: Message Text (UTF-8)\n

    V3 Format (PACKET_CONTACT_MSG_RECV_V3, 0x10):

    Byte 0: 0x10 (packet type)\nByte 1: SNR (signed byte, multiplied by 4)\nBytes 2-3: Reserved\nBytes 4-9: Public Key Prefix (6 bytes, hex)\nByte 10: Path Length\nByte 11: Text Type\nBytes 12-15: Timestamp (32-bit little-endian)\nBytes 16-19: Signature (4 bytes, only if txt_type == 2)\nBytes 20+: Message Text (UTF-8)\n

    Parsing Pseudocode:

    def parse_contact_message(data):\n    packet_type = data[0]\n    offset = 1\n\n    # Check for V3 format\n    if packet_type == 0x10:  # V3\n        snr_byte = data[offset]\n        snr = ((snr_byte if snr_byte < 128 else snr_byte - 256) / 4.0)\n        offset += 3  # Skip SNR + reserved\n\n    pubkey_prefix = data[offset:offset+6].hex()\n    offset += 6\n\n    path_len = data[offset]\n    txt_type = data[offset + 1]\n    offset += 2\n\n    timestamp = int.from_bytes(data[offset:offset+4], 'little')\n    offset += 4\n\n    # If txt_type == 2, skip 4-byte signature\n    if txt_type == 2:\n        offset += 4\n\n    message = data[offset:].decode('utf-8')\n\n    return {\n        'pubkey_prefix': pubkey_prefix,\n        'path_len': path_len,\n        'txt_type': txt_type,\n        'timestamp': timestamp,\n        'message': message,\n        'snr': snr if packet_type == 0x10 else None\n    }\n
    "},{"location":"companion_protocol/#channel-message-format","title":"Channel Message Format","text":"

    Standard Format (PACKET_CHANNEL_MSG_RECV, 0x08):

    Byte 0: 0x08 (packet type)\nByte 1: Channel Index (0-7)\nByte 2: Path Length\nByte 3: Text Type\nBytes 4-7: Timestamp (32-bit little-endian)\nBytes 8+: Message Text (UTF-8)\n

    V3 Format (PACKET_CHANNEL_MSG_RECV_V3, 0x11):

    Byte 0: 0x11 (packet type)\nByte 1: SNR (signed byte, multiplied by 4)\nBytes 2-3: Reserved\nByte 4: Channel Index (0-7)\nByte 5: Path Length\nByte 6: Text Type\nBytes 7-10: Timestamp (32-bit little-endian)\nBytes 11+: Message Text (UTF-8)\n

    Parsing Pseudocode:

    def parse_channel_message(data):\n    packet_type = data[0]\n    offset = 1\n\n    # Check for V3 format\n    if packet_type == 0x11:  # V3\n        snr_byte = data[offset]\n        snr = ((snr_byte if snr_byte < 128 else snr_byte - 256) / 4.0)\n        offset += 3  # Skip SNR + reserved\n\n    channel_idx = data[offset]\n    path_len = data[offset + 1]\n    txt_type = data[offset + 2]\n    timestamp = int.from_bytes(data[offset+3:offset+7], 'little')\n    message = data[offset+7:].decode('utf-8')\n\n    return {\n        'channel_idx': channel_idx,\n        'timestamp': timestamp,\n        'message': message,\n        'snr': snr if packet_type == 0x11 else None\n    }\n
    "},{"location":"companion_protocol/#sending-messages","title":"Sending Messages","text":"

    Use the SEND_CHANNEL_MESSAGE command (see Commands).

    Important: - Messages are limited to 133 characters per MeshCore specification - Long messages should be split into chunks - Include a chunk indicator (e.g., \"[1/3] message text\")

    "},{"location":"companion_protocol/#response-parsing","title":"Response Parsing","text":""},{"location":"companion_protocol/#packet-types","title":"Packet Types","text":"Value Name Description 0x00 PACKET_OK Command succeeded 0x01 PACKET_ERROR Command failed 0x02 PACKET_CONTACT_START Start of contact list 0x03 PACKET_CONTACT Contact information 0x04 PACKET_CONTACT_END End of contact list 0x05 PACKET_SELF_INFO Device self-information 0x06 PACKET_MSG_SENT Message sent confirmation 0x07 PACKET_CONTACT_MSG_RECV Contact message (standard) 0x08 PACKET_CHANNEL_MSG_RECV Channel message (standard) 0x09 PACKET_CURRENT_TIME Current time response 0x0A PACKET_NO_MORE_MSGS No more messages available 0x0C PACKET_BATTERY Battery level 0x0D PACKET_DEVICE_INFO Device information 0x10 PACKET_CONTACT_MSG_RECV_V3 Contact message (V3 with SNR) 0x11 PACKET_CHANNEL_MSG_RECV_V3 Channel message (V3 with SNR) 0x12 PACKET_CHANNEL_INFO Channel information 0x80 PACKET_ADVERTISEMENT Advertisement packet 0x82 PACKET_ACK Acknowledgment 0x83 PACKET_MESSAGES_WAITING Messages waiting notification 0x88 PACKET_LOG_DATA RF log data (can be ignored)"},{"location":"companion_protocol/#parsing-responses","title":"Parsing Responses","text":"

    PACKET_OK (0x00):

    Byte 0: 0x00\nBytes 1-4: Optional value (32-bit little-endian integer)\n

    PACKET_ERROR (0x01):

    Byte 0: 0x01\nByte 1: Error code (optional)\n

    PACKET_CHANNEL_INFO (0x12):

    Byte 0: 0x12\nByte 1: Channel Index\nBytes 2-33: Channel Name (32 bytes, null-terminated)\nBytes 34-65: Secret (32 bytes, but device typically only returns 20 bytes total)\n

    Note: The device may not return the full 66-byte packet. Parse what is available. The secret field is typically not returned for security reasons.

    PACKET_DEVICE_INFO (0x0D):

    Byte 0: 0x0D\nByte 1: Firmware Version (uint8)\nBytes 2+: Variable length based on firmware version\n\nFor firmware version >= 3:\nByte 2: Max Contacts Raw (uint8, actual = value * 2)\nByte 3: Max Channels (uint8)\nBytes 4-7: BLE PIN (32-bit little-endian)\nBytes 8-19: Firmware Build (12 bytes, UTF-8, null-padded)\nBytes 20-59: Model (40 bytes, UTF-8, null-padded)\nBytes 60-79: Version (20 bytes, UTF-8, null-padded)\n

    Parsing Pseudocode:

    def parse_device_info(data):\n    if len(data) < 2:\n        return None\n\n    fw_ver = data[1]\n    info = {'fw_ver': fw_ver}\n\n    if fw_ver >= 3 and len(data) >= 80:\n        info['max_contacts'] = data[2] * 2\n        info['max_channels'] = data[3]\n        info['ble_pin'] = int.from_bytes(data[4:8], 'little')\n        info['fw_build'] = data[8:20].decode('utf-8').rstrip('\\x00').strip()\n        info['model'] = data[20:60].decode('utf-8').rstrip('\\x00').strip()\n        info['ver'] = data[60:80].decode('utf-8').rstrip('\\x00').strip()\n\n    return info\n

    PACKET_BATTERY (0x0C):

    Byte 0: 0x0C\nBytes 1-2: Battery Level (16-bit little-endian, percentage 0-100)\n\nOptional (if data size > 3):\nBytes 3-6: Used Storage (32-bit little-endian, KB)\nBytes 7-10: Total Storage (32-bit little-endian, KB)\n

    Parsing Pseudocode:

    def parse_battery(data):\n    if len(data) < 3:\n        return None\n\n    level = int.from_bytes(data[1:3], 'little')\n    info = {'level': level}\n\n    if len(data) > 3:\n        used_kb = int.from_bytes(data[3:7], 'little')\n        total_kb = int.from_bytes(data[7:11], 'little')\n        info['used_kb'] = used_kb\n        info['total_kb'] = total_kb\n\n    return info\n

    PACKET_SELF_INFO (0x05):

    Byte 0: 0x05\nByte 1: Advertisement Type\nByte 2: TX Power\nByte 3: Max TX Power\nBytes 4-35: Public Key (32 bytes, hex)\nBytes 36-39: Advertisement Latitude (32-bit little-endian, divided by 1e6)\nBytes 40-43: Advertisement Longitude (32-bit little-endian, divided by 1e6)\nByte 44: Multi ACKs\nByte 45: Advertisement Location Policy\nByte 46: Telemetry Mode (bitfield)\nByte 47: Manual Add Contacts (bool)\nBytes 48-51: Radio Frequency (32-bit little-endian, divided by 1000.0)\nBytes 52-55: Radio Bandwidth (32-bit little-endian, divided by 1000.0)\nByte 56: Radio Spreading Factor\nByte 57: Radio Coding Rate\nBytes 58+: Device Name (UTF-8, variable length, null-terminated)\n

    Parsing Pseudocode:

    def parse_self_info(data):\n    if len(data) < 36:\n        return None\n\n    offset = 1\n    info = {\n        'adv_type': data[offset],\n        'tx_power': data[offset + 1],\n        'max_tx_power': data[offset + 2],\n        'public_key': data[offset + 3:offset + 35].hex()\n    }\n    offset += 35\n\n    lat = int.from_bytes(data[offset:offset+4], 'little') / 1e6\n    lon = int.from_bytes(data[offset+4:offset+8], 'little') / 1e6\n    info['adv_lat'] = lat\n    info['adv_lon'] = lon\n    offset += 8\n\n    info['multi_acks'] = data[offset]\n    info['adv_loc_policy'] = data[offset + 1]\n    telemetry_mode = data[offset + 2]\n    info['telemetry_mode_env'] = (telemetry_mode >> 4) & 0b11\n    info['telemetry_mode_loc'] = (telemetry_mode >> 2) & 0b11\n    info['telemetry_mode_base'] = telemetry_mode & 0b11\n    info['manual_add_contacts'] = data[offset + 3] > 0\n    offset += 4\n\n    freq = int.from_bytes(data[offset:offset+4], 'little') / 1000.0\n    bw = int.from_bytes(data[offset+4:offset+8], 'little') / 1000.0\n    info['radio_freq'] = freq\n    info['radio_bw'] = bw\n    info['radio_sf'] = data[offset + 8]\n    info['radio_cr'] = data[offset + 9]\n    offset += 10\n\n    if offset < len(data):\n        name_bytes = data[offset:]\n        info['name'] = name_bytes.decode('utf-8').rstrip('\\x00').strip()\n\n    return info\n

    PACKET_MSG_SENT (0x06):

    Byte 0: 0x06\nByte 1: Message Type\nBytes 2-5: Expected ACK (4 bytes, hex)\nBytes 6-9: Suggested Timeout (32-bit little-endian, seconds)\n

    PACKET_ACK (0x82):

    Byte 0: 0x82\nBytes 1-6: ACK Code (6 bytes, hex)\n
    "},{"location":"companion_protocol/#error-codes","title":"Error Codes","text":"

    PACKET_ERROR (0x01) may include an error code in byte 1:

    Error Code Description 0x00 Generic error (no specific code) 0x01 Invalid command 0x02 Invalid parameter 0x03 Channel not found 0x04 Channel already exists 0x05 Channel index out of range 0x06 Secret mismatch 0x07 Message too long 0x08 Device busy 0x09 Not enough storage

    Note: Error codes may vary by firmware version. Always check byte 1 of PACKET_ERROR response.

    "},{"location":"companion_protocol/#partial-packet-handling","title":"Partial Packet Handling","text":"

    BLE notifications may arrive in chunks, especially for larger packets. Implement buffering:

    Implementation:

    class PacketBuffer:\n    def __init__(self):\n        self.buffer = bytearray()\n        self.expected_length = None\n\n    def add_data(self, data):\n        self.buffer.extend(data)\n\n        # Check if we have a complete packet\n        if len(self.buffer) >= 1:\n            packet_type = self.buffer[0]\n\n            # Determine expected length based on packet type\n            expected = self.get_expected_length(packet_type)\n\n            if expected is not None and len(self.buffer) >= expected:\n                # Complete packet\n                packet = bytes(self.buffer[:expected])\n                self.buffer = self.buffer[expected:]\n                return packet\n            elif expected is None:\n                # Variable length packet - try to parse what we have\n                # Some packets have minimum length requirements\n                if self.can_parse_partial(packet_type):\n                    return self.try_parse_partial()\n\n        return None  # Incomplete packet\n\n    def get_expected_length(self, packet_type):\n        # Fixed-length packets\n        fixed_lengths = {\n            0x00: 5,  # PACKET_OK (minimum)\n            0x01: 2,  # PACKET_ERROR (minimum)\n            0x0A: 1,  # PACKET_NO_MORE_MSGS\n            0x14: 3,  # PACKET_BATTERY (minimum)\n        }\n        return fixed_lengths.get(packet_type)\n\n    def can_parse_partial(self, packet_type):\n        # Some packets can be parsed partially\n        return packet_type in [0x12, 0x08, 0x11, 0x07, 0x10, 0x05, 0x0D]\n\n    def try_parse_partial(self):\n        # Try to parse with available data\n        # Return packet if successfully parsed, None otherwise\n        # This is packet-type specific\n        pass\n

    Usage:

    buffer = PacketBuffer()\n\ndef on_notification_received(data):\n    packet = buffer.add_data(data)\n    if packet:\n        parse_and_handle_packet(packet)\n
    "},{"location":"companion_protocol/#response-handling","title":"Response Handling","text":"
    1. Command-Response Pattern:
    2. Send command via TX characteristic
    3. Wait for response via RX characteristic (notification)
    4. Match response to command using sequence numbers or command type
    5. Handle timeout (typically 5 seconds)

    6. Use command queue to prevent concurrent commands

    7. Asynchronous Messages:

    8. Device may send messages at any time via RX characteristic
    9. Handle PACKET_MESSAGES_WAITING (0x83) by polling GET_MESSAGE command
    10. Parse incoming messages and route to appropriate handlers

    11. Buffer partial packets until complete

    12. Response Matching:

    13. Match responses to commands by expected packet type:

    14. Timeout Handling:

    15. Default timeout: 5 seconds per command
    16. On timeout: Log error, clear current command, proceed to next in queue
    17. Some commands may take longer (e.g., SET_CHANNEL may need 1-2 seconds)

    18. Consider longer timeout for channel operations

    19. Error Recovery:

    20. On PACKET_ERROR: Log error code, clear current command
    21. On connection loss: Clear command queue, attempt reconnection
    22. On invalid response: Log warning, clear current command, proceed
    "},{"location":"companion_protocol/#example-implementation-flow","title":"Example Implementation Flow","text":""},{"location":"companion_protocol/#initialization","title":"Initialization","text":"
    # 1. Scan for MeshCore device\ndevice = scan_for_device(\"MeshCore\")\n\n# 2. Connect to BLE GATT\ngatt = connect_to_device(device)\n\n# 3. Discover services and characteristics\nservice = discover_service(gatt, \"0000ff00-0000-1000-8000-00805f9b34fb\")\nrx_char = discover_characteristic(service, \"0000ff01-0000-1000-8000-00805f9b34fb\")\ntx_char = discover_characteristic(service, \"0000ff02-0000-1000-8000-00805f9b34fb\")\n\n# 4. Enable notifications on RX characteristic\nenable_notifications(rx_char, on_notification_received)\n\n# 5. Send AppStart command\nsend_command(tx_char, build_app_start())\nwait_for_response(PACKET_OK)\n
    "},{"location":"companion_protocol/#creating-a-private-channel","title":"Creating a Private Channel","text":"
    # 1. Generate 16-byte secret\nsecret_16_bytes = generate_secret(16)  # Use CSPRNG\nsecret_hex = secret_16_bytes.hex()\n\n# 2. Expand secret to 32 bytes using SHA-512\nimport hashlib\nsha512_hash = hashlib.sha512(secret_16_bytes).digest()\nsecret_32_bytes = sha512_hash[:32]\n\n# 3. Build SET_CHANNEL command\nchannel_name = \"YourChannelName\"\nchannel_index = 1  # Use 1-7 for private channels\ncommand = build_set_channel(channel_index, channel_name, secret_32_bytes)\n\n# 4. Send command\nsend_command(tx_char, command)\nresponse = wait_for_response(PACKET_OK)\n\n# 5. Store secret locally (device won't return it)\nstore_channel_secret(channel_index, secret_hex)\n
    "},{"location":"companion_protocol/#sending-a-message","title":"Sending a Message","text":"
    # 1. Build channel message command\nchannel_index = 1\nmessage = \"Hello, MeshCore!\"\ntimestamp = int(time.time())\ncommand = build_channel_message(channel_index, message, timestamp)\n\n# 2. Send command\nsend_command(tx_char, command)\nresponse = wait_for_response(PACKET_MSG_SENT)\n
    "},{"location":"companion_protocol/#receiving-messages_1","title":"Receiving Messages","text":"
    def on_notification_received(data):\n    packet_type = data[0]\n\n    if packet_type == PACKET_CHANNEL_MSG_RECV or packet_type == PACKET_CHANNEL_MSG_RECV_V3:\n        message = parse_channel_message(data)\n        handle_channel_message(message)\n    elif packet_type == PACKET_MESSAGES_WAITING:\n        # Poll for messages\n        send_command(tx_char, build_get_message())\n
    "},{"location":"companion_protocol/#best-practices","title":"Best Practices","text":"
    1. Connection Management:
    2. Implement auto-reconnect with exponential backoff
    3. Handle disconnections gracefully

    4. Store last connected device address for quick reconnection

    5. Secret Management:

    6. Always use cryptographically secure random number generators
    7. Store secrets securely (encrypted storage)

    8. Never log or transmit secrets in plain text

    9. Message Handling:

    10. Send CMD_SYNC_NEXT_MESSAGE when PUSH_CODE_MSG_WAITING is received

    11. Implement message deduplication to avoid display the same message twice

    12. Channel Management:

    13. Error Handling:

    14. Implement timeouts for all commands (typically 5 seconds)
    15. Handle RESP_CODE_ERR responses appropriately
    "},{"location":"companion_protocol/#troubleshooting","title":"Troubleshooting","text":""},{"location":"companion_protocol/#connection-issues","title":"Connection Issues","text":""},{"location":"companion_protocol/#command-issues","title":"Command Issues","text":""},{"location":"companion_protocol/#message-issues","title":"Message Issues","text":""},{"location":"docs/","title":"Local Documentation","text":"

    This document explains how to build and view the MeshCore documentation locally.

    "},{"location":"docs/#building-and-viewing-docs","title":"Building and viewing Docs","text":"
    pip install mkdocs\npip install mkdocs-material\n
    "},{"location":"faq/","title":"Frequently Asked Questions","text":"

    A list of frequently-asked questions and answers for MeshCore

    "},{"location":"faq/#1-introduction","title":"1. Introduction","text":""},{"location":"faq/#11-q-what-is-meshcore","title":"1.1. Q: What is MeshCore?","text":"

    A: MeshCore is a multi platform system for enabling secure text based communications utilising LoRa radio hardware. It can be used for Off-Grid Communication, Emergency Response & Disaster Recovery, Outdoor Activities, Tactical Security including law enforcement and private security and also IoT sensor networks. (source)

    MeshCore is free and open source: * MeshCore is the routing and firmware etc, available on GitHub under MIT license * There are clients made by the community, such as the web clients, these are free to use, and some are open source too * The cross platform mobile app developed by Liam Cottle for Android/iOS/PC etc is free to download and use * The T-Deck firmware is developed by Scott at Ripple Radios, the creator of MeshCore, is also free to flash on your devices and use

    Some more advanced, but optional features are available on T-Deck if you register your device for a key to unlock. On the MeshCore smartphone clients for Android and iOS/iPadOS, you can unlock the wait timer for repeater and room server remote management over RF feature.

    These features are completely optional and aren't needed for the core messaging experience. They're like super bonus features and to help the developers continue to work on these amazing features, they may charge a small fee for an unlock code to utilise the advanced features.

    Anyone is able to build anything they like on top of MeshCore without paying anything.

    "},{"location":"faq/#12-q-what-do-you-need-to-start-using-meshcore","title":"1.2. Q: What do you need to start using MeshCore?","text":"

    A: Everything you need for MeshCore is available at:

    You need LoRa hardware devices to run MeshCore firmware as clients or server (repeater and room server).

    "},{"location":"faq/#121-hardware","title":"1.2.1. Hardware","text":"

    MeshCore is available on a variety of 433MHz, 868MHz and 915MHz LoRa devices. For example, Lilygo T-Deck, T-Pager, RAK Wireless WisBlock RAK4631 devices (e.g. 19003, 19007, 19026), Heltec V3, Xiao S3 WIO, Xiao C3, Heltec T114, Station G2, Nano G2 Ultra, Seeed Studio T1000-E. More devices are being added regularly.

    For an up-to-date list of supported devices, please go to https://flasher.meshcore.co.uk/

    To use MeshCore without using a phone as the client interface, you can run MeshCore on a LiLygo's T-Deck, T-Deck Plus, T-Pager, T-Watch, or T-Display Pro. MeshCore Ultra firmware running on these devices are a complete off-grid secure communication solution.

    "},{"location":"faq/#122-firmware","title":"1.2.2. Firmware","text":"

    MeshCore has four firmware types that are not available on other LoRa systems. MeshCore has the following:

    "},{"location":"faq/#123-companion-radio-firmware","title":"1.2.3. Companion Radio Firmware","text":"

    Companion radios are for connecting to the Android app or web app as a messenger client. There are two different companion radio firmware versions:

    1. BLE Companion BLE Companion firmware runs on a supported LoRa device and connects to a smart device running the Android or iOS MeshCore client over BLE https://meshcore.co.uk/apps.html

    2. USB Serial Companion USB Serial Companion firmware runs on a supported LoRa device and connects to a smart device or a computer over USB Serial running the MeshCore web client https://meshcore.liamcottle.net/#/ https://client.meshcore.co.uk/tabs/devices

    "},{"location":"faq/#124-repeater","title":"1.2.4. Repeater","text":"

    Repeaters are used to extend the range of a MeshCore network. Repeater firmware runs on the same devices that run client firmware. A repeater's job is to forward MeshCore packets to the destination device. It does not forward or retransmit every packet it receives, unlike other LoRa mesh systems.

    A repeater can be remotely administered using a T-Deck running the MeshCore firmware with remote administration features unlocked, or from a BLE Companion client connected to a smartphone running the MeshCore app.

    "},{"location":"faq/#125-room-server","title":"1.2.5. Room Server","text":"

    A room server is a simple BBS server for sharing posts. T-Deck devices running MeshCore firmware or a BLE Companion client connected to a smartphone running the MeshCore app can connect to a room server.

    Room servers store message history on them and push the stored messages to users. Room servers allow roaming users to come back later and retrieve message history. With channels, messages are either received when it's sent, or not received and missed if the channel user is out of range. Room servers are different and more like email servers where you can come back later and get your emails from your mail server.

    A room server can be remotely administered using a T-Deck running the MeshCore firmware with remote administration features unlocked, or from a BLE Companion client connected to a smartphone running the MeshCore app.

    When a client logs into a room server, the client will receive the previously 32 unseen messages.

    Although room server can also repeat with the command line command set repeat on, it is not recommended nor encouraged. A room server with repeat set to on lacks the full set of repeater and remote administration features that are only available in the repeater firmware.

    The recommendation is to run repeater and room server on separate devices for the best experience.

    "},{"location":"faq/#2-initial-setup","title":"2. Initial Setup","text":""},{"location":"faq/#21-q-how-many-devices-do-i-need-to-start-using-meshcore","title":"2.1. Q: How many devices do I need to start using MeshCore?","text":"

    A: If you have one supported device, flash the BLE Companion firmware and use your device as a client. You can connect to the device using the Android or iOS client via Bluetooth. You can start communicating with other MeshCore users near you.

    If you have two supported devices, and there are not many MeshCore users near you, flash both to BLE Companion firmware so you can use your devices to communicate with your near-by friends and family.

    If you have two supported devices, and there are other MeshCore users nearby, you can flash one of your devices with BLE Companion firmware and flash another supported device to repeater firmware. Place the repeater high above ground to extend your MeshCore network's reach.

    After you flashed the latest firmware onto your repeater device, keep the device connected to your computer via USB serial, use the console feature on the web flasher and set the frequency for your region or country, so your client can remote administer the repeater or room server over RF:

    set freq {frequency}

    The repeater and room server CLI reference is here: https://github.com/meshcore-dev/MeshCore/wiki/Repeater-&-Room-Server-CLI-Reference

    If you have more supported devices, you can use your additional devices with the room server firmware.

    "},{"location":"faq/#22-q-does-meshcore-cost-any-money","title":"2.2. Q: Does MeshCore cost any money?","text":"

    A: All radio firmware versions (e.g. for Heltec V3, RAK, T-1000E, etc) are free and open source developed by Scott at Ripple Radios.

    The native Android and iOS client uses the freemium model and is developed by Liam Cottle, developer of meshtastic map at meshtastic.liamcottle.net on GitHub and reticulum-meshchat on github.

    The T-Deck firmware is free to download and most features are available without cost. To support the firmware developer, you can pay for a registration key to unlock your T-Deck for deeper map zoom and remote server administration over RF using the T-Deck. You do not need to pay for the registration to use your T-Deck for direct messaging and connecting to repeaters and room servers.

    "},{"location":"faq/#23-q-what-frequencies-are-supported-by-meshcore","title":"2.3. Q: What frequencies are supported by MeshCore?","text":"

    A: It supports the 868MHz range in the UK/EU and the 915MHz range in New Zealand, Australia, and the USA. Countries and regions in these two frequency ranges are also supported.

    Use the smartphone client or the repeater setup feature on there web flasher to set your radios' RF settings by choosing the preset for your regions.

    Recently, as of October 2025, many regions have moved to the \"narrow\" setting, aka using BW62.5 and a lower SF number (instead of the original SF11). For example, USA/Canada (Recommended) preset is 910.525MHz, SF7, BW62.5, CR5.

    After extensive testing, many regions have switched or about to switch over to BW62.5 and SF7, 8, or 9. Narrower bandwidth setting and lower SF setting allow MeshCore's radio signals to fit between interference in the ISM band, provide for a lower noise floor, better SNR, and faster transmissions.

    If you have consensus from your community in your region to update your region's preset recommendation, please post your update request on the #meshcore-app channel on the MeshCore Discord server to let Liam Cottle know.

    "},{"location":"faq/#24-q-what-is-an-advert-in-meshcore","title":"2.4. Q: What is an \"advert\" in MeshCore?","text":"

    A: Advert means to advertise yourself on the network. In Reticulum terms it would be to announce. In Meshtastic terms it would be the node sending its node info.

    MeshCore allows you to manually broadcast your name, position and public encryption key, which is also signed to prevent spoofing. When you click the advert button, it broadcasts that data over LoRa. MeshCore calls that an Advert. There's two ways to advert, \"zero hop\" and \"flood\".

    MeshCore clients only advertise themselves when the user initiates it. A repeater sends a flood advert once every 3 hours by default. This interval can be configured using the following command:

    set advert.interval {minutes}

    As of Aug 20 2025, a pending PR on github will change the flood advert to 12 hours to minimize airtime utilization caused by repeaters' flood adverts.

    "},{"location":"faq/#25-q-is-there-a-hop-limit","title":"2.5. Q: Is there a hop limit?","text":"

    A: Internally the firmware has maximum limit of 64 hops. In real world settings it will be difficult to get close to the limit due to the environments and timing as packets travel further and further. We want to hear how far your MeshCore conversations go.

    "},{"location":"faq/#3-server-administration","title":"3. Server Administration","text":""},{"location":"faq/#31-q-how-do-you-configure-a-repeater-or-a-room-server","title":"3.1. Q: How do you configure a repeater or a room server?","text":"

    A: - When MeshCore is flashed onto a LoRa device is for the first time, it is necessary to set the server device's frequency to make it utilize the frequency that is legal in your country or region.

    Repeater or room server can be administered with one of the options below:

    https://buymeacoffee.com/ripplebiz/e/249834

    "},{"location":"faq/#32-q-do-i-need-to-set-the-location-for-a-repeater","title":"3.2. Q: Do I need to set the location for a repeater?","text":"

    A: While not required, with location set for a repeater it will show up on the MeshCore map in the future. Set location with the following command:

    set lat <GPS Lat> set long <GPS Lon>

    You can get the latitude and longitude from Google Maps by right-clicking the location you are at on the map.

    "},{"location":"faq/#33-q-what-is-the-password-to-administer-a-repeater-or-a-room-server","title":"3.3. Q: What is the password to administer a repeater or a room server?","text":"

    A: The default admin password to a repeater and room server is password. Use the following command to change the admin password:

    password {new-password}

    "},{"location":"faq/#34-q-what-is-the-password-to-join-a-room-server","title":"3.4. Q: What is the password to join a room server?","text":"

    A: The default guest password to a room server is hello. Use the following command to change the guest password:

    set guest.password {guest-password}

    "},{"location":"faq/#35-q-can-i-retrieve-a-repeaters-private-key-or-set-a-repeaters-private-key","title":"3.5. Q: Can I retrieve a repeater's private key or set a repeater's private key?","text":"

    A: You can issue these commands to get or set a repeater's private key using a USB serial connection.

    get prv.key to print a repeater's private key on the serial console set prv.key <hex> to set a repeater's private key on the serial console

    Reboot the repeater after set prv.key <hex> command for the new private key to take effect.

    "},{"location":"faq/#36-q-the-first-byte-of-my-repeaters-public-key-collides-with-an-exisitng-repeater-on-the-mesh-how-do-i-get-a-new-private-key-with-a-matching-public-key-that-has-its-first-byte-of-my-choosing","title":"3.6. Q: The first byte of my repeater's public key collides with an exisitng repeater on the mesh. How do I get a new private key with a matching public key that has its first byte of my choosing?","text":"

    A: You can generate a new private key and specific the first byte of its public key here: https://gessaman.com/mc-keygen/

    "},{"location":"faq/#37-q-my-repeater-maybe-suffering-from-deafness-due-to-high-power-interference-near-my-meshs-frequency-it-is-not-hearing-other-in-range-meshcore-radios-what-can-i-do","title":"3.7. Q: My repeater maybe suffering from deafness due to high power interference near my mesh's frequency, it is not hearing other in-range MeshCore radios. What can I do?","text":"

    A: This may be due to the SX1262 radio's auto gain control feature. You can use this command to periodically reset its AGC.

    set agc.reset.interval <number>

    The <number> unit is in seconds and is incremented by 4. set agc.reset.interval 4 works well to cure deafness.

    This is a very low cost operation. AGC reset is done by simply setting state = STATE_IDLE; in function RadioLibWrapper::resetAGC() in RadioLibWrappers.cpp

    "},{"location":"faq/#38-q-how-do-i-make-my-repeater-an-observer-on-the-mesh","title":"3.8. Q: How do I make my repeater an observer on the mesh?","text":"

    A: The observer instruction is available here: https://analyzer.letsmesh.net/observer/onboard

    "},{"location":"faq/#4-t-deck-related","title":"4. T-Deck Related","text":""},{"location":"faq/#41-q-is-there-a-user-guide-for-t-deck-t-pager-t-watch-or-t-display-pro","title":"4.1. Q: Is there a user guide for T-Deck, T-Pager, T-Watch, or T-Display Pro?","text":"

    A: Yes, it is available on https://buymeacoffee.com/ripplebiz/ultra-v7-7-guide-meshcore-users

    "},{"location":"faq/#42-q-what-are-the-steps-to-get-a-t-deck-into-dfu-device-firmware-update-mode","title":"4.2. Q: What are the steps to get a T-Deck into DFU (Device Firmware Update) mode?","text":"

    A: 1. Device off 2. Connect USB cable to device 3. Hold down trackball (keep holding) 4. Turn on device 5. Hear USB connection sound 6. Release trackball 7. T-Deck in DFU mode now 8. At this point you can begin flashing using https://flasher.meshcore.co.uk/

    "},{"location":"faq/#43-q-why-is-my-t-deck-plus-not-getting-any-satellite-lock","title":"4.3. Q: Why is my T-Deck Plus not getting any satellite lock?","text":"

    A: For T-Deck Plus, the GPS baud rate should be set to 38400. Also, some T-Deck Plus devices were found to have the GPS module installed upside down, with the GPS antenna facing down instead of up. If your T-Deck Plus still doesn't get any satellite lock after setting the baud rate to 38400, you might need to open the device to check the GPS orientation.

    GPS on T-Deck is always enabled. You can skip the \"GPS clock sync\" and the T-Deck will continue to try to get a GPS lock. You can go to the GPS Info screen; you should see the Sentences: counter increasing if the baud rate is correct.

    Source

    "},{"location":"faq/#44-q-why-is-my-og-non-plus-t-deck-not-getting-any-satellite-lock","title":"4.4. Q: Why is my OG (non-Plus) T-Deck not getting any satellite lock?","text":"

    A: The OG (non-Plus) T-Deck doesn't come with a GPS. If you added a GPS to your OG T-Deck, please refer to the manual of your GPS to see what baud rate it requires. Alternatively, you can try to set the baud rate from 9600, 19200, etc., and up to 115200 to see which one works.

    "},{"location":"faq/#45-q-what-size-of-sd-card-does-the-t-deck-support","title":"4.5. Q: What size of SD card does the T-Deck support?","text":"

    A: Users have had no issues using 16GB or 32GB SD cards. Format the SD card to FAT32.

    "},{"location":"faq/#46-q-what-is-the-public-key-for-the-default-public-channel","title":"4.6. Q: what is the public key for the default public channel?","text":"

    A: T-Deck uses the same key the smartphone apps use but in base64 izOH6cXN6mrJ5e26oRXNcg==

    There is no = key on the T-Deck's hardware keyboard. You can use the on-screen software keyboard to enter =. Tap the text box to enable the on-screen software keyboard. The third character is the capital letter O (Oh), not zero 0

    The smartphone app key is in hex: 8b3387e9c5cdea6ac9e5edbaa115cd72

    Source

    "},{"location":"faq/#47-q-how-do-i-get-maps-on-t-deck","title":"4.7. Q: How do I get maps on T-Deck?","text":"

    A: You need map tiles. You can get pre-downloaded map tiles here (a good way to support development): - https://buymeacoffee.com/ripplebiz/e/342543 (Europe) - https://buymeacoffee.com/ripplebiz/e/342542 (US)

    Another way to download map tiles is to use this Python script to get the tiles in the areas you want: https://github.com/fistulareffigy/MTD-Script

    There is also a modified script that adds additional error handling and parallel downloads: https://discord.com/channels/826570251612323860/1330643963501351004/1338775811548905572

    UK map tiles are available separately from Andy Kirby on his discord server: https://discord.com/channels/826570251612323860/1330643963501351004/1331346597367386224

    "},{"location":"faq/#48-q-where-do-the-map-tiles-go","title":"4.8. Q: Where do the map tiles go?","text":"

    Once you have the tiles downloaded, copy the \\tiles folder to the root of your T-Deck's SD card.

    "},{"location":"faq/#49-q-how-to-unlock-deeper-map-zoom-and-server-management-features-on-t-deck","title":"4.9. Q: How to unlock deeper map zoom and server management features on T-Deck?","text":"

    A: You can download, install, and use the T-Deck firmware for free, but it has some features (map zoom, server administration) that are enabled if you purchase an unlock code for \\$10 per T-Deck device. Unlock page: https://buymeacoffee.com/ripplebiz/e/249834

    "},{"location":"faq/#410-q-how-to-decipher-the-diagnostics-screen-on-t-deck","title":"4.10. Q: How to decipher the diagnostics screen on T-Deck?","text":"

    **A: ** Space is tight on T-Deck's screen, so the information is a bit cryptic. The format is : {hops} l:{packet-length}({payload-len}) t:{packet-type} snr:{n} rssi:{n}

    See here for packet-type: https://github.com/meshcore-dev/MeshCore/blob/main/src/Packet.h#L19

    #define PAYLOAD_TYPE_REQ 0x00 // request (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob)\n#define PAYLOAD_TYPE_RESPONSE 0x01 // response to REQ or ANON_REQ (prefixed with dest/src hashes, MAC) (enc data: timestamp, blob)\n#define PAYLOAD_TYPE_TXT_MSG 0x02 // a plain text message (prefixed with dest/src hashes, MAC) (enc data: timestamp, text)\n#define PAYLOAD_TYPE_ACK 0x03 // a simple ack #define PAYLOAD_TYPE_ADVERT 0x04 // a node advertising its Identity\n#define PAYLOAD_TYPE_GRP_TXT 0x05 // an (unverified) group text message (prefixed with channel hash, MAC) (enc data: timestamp, \"name: msg\")\n#define PAYLOAD_TYPE_GRP_DATA 0x06 // an (unverified) group datagram (prefixed with channel hash, MAC) (enc data: timestamp, blob)\n#define PAYLOAD_TYPE_ANON_REQ 0x07 // generic request (prefixed with dest_hash, ephemeral pub_key, MAC) (enc data: ...)\n#define PAYLOAD_TYPE_PATH 0x08 // returned path (prefixed with dest/src hashes, MAC) (enc data: path, extra)\n

    Source

    "},{"location":"faq/#411-q-the-t-deck-sound-is-too-loud","title":"4.11. Q: The T-Deck sound is too loud?","text":""},{"location":"faq/#412-q-can-you-customize-the-sound","title":"4.12. Q: Can you customize the sound?","text":"

    A: You can customise the sounds on the T-Deck, by placing .mp3 files onto the root dir of the SD card. The files are:

    "},{"location":"faq/#413-q-what-is-the-import-from-clipboard-feature-on-the-t-deck-and-is-there-a-way-to-manually-add-nodes-without-having-to-receive-adverts","title":"4.13. Q: What is the 'Import from Clipboard' feature on the t-deck and is there a way to manually add nodes without having to receive adverts?","text":"

    A: 'Import from Clipboard' is for importing a contact via a file named 'clipboard.txt' on the SD card. The opposite, is in the Identity screen, the 'Card to Clipboard' menu, which writes to 'clipboard.txt' so you can share yourself (call these 'biz cards', that start with \"meshcore://...\")

    "},{"location":"faq/#414-q-how-to-capture-a-screenshot-on-t-deck","title":"4.14. Q: How to capture a screenshot on T-Deck?","text":"

    A: To capture a screenshot on a T-Deck, long press the top-left corner of the screen. The screenshot is saved to the microSD card, if one is inserted into the device.

    "},{"location":"faq/#5-general","title":"5. General","text":""},{"location":"faq/#51-q-what-are-bw-sf-and-cr","title":"5.1. Q: What are BW, SF, and CR?","text":"

    A:

    BW is bandwidth - width of frequency spectrum that is used for transmission

    SF is spreading factor - how much should the communication spread in time

    CR is coding rate - from: https://www.thethingsnetwork.org/docs/lorawan/fec-and-code-rate/

    TL;DR: default CR to 5 for good stable links. If it is not a solid link and is intermittent, change to CR to 7 or 8.

    Forward Error Correction is a process of adding redundant bits to the data to be transmitted. During the transmission, data may get corrupted by interference (changes from 0 to 1 / 1 to 0). These error correction bits are used at the receivers for restoring corrupted bits.

    The Code Rate of a forward error correction expresses the proportion of bits in a data stream that actually carry useful information.

    There are 4 code rates used in LoRaWAN:

    4/5 4/6 5/7 4/8

    For example, if the code rate is 5/7, for every 5 bits of useful information, the coder generates a total of 7 bits of data, of which 2 bits are redundant.

    Making the bandwidth 2x wider (from BW125 to BW250) allows you to send 2x more bytes in the same time. Making the spreading factor 1 step lower (from SF10 to SF9) allows you to send 2x more bytes in the same time.

    Lowering the spreading factor makes it more difficult for the gateway to receive a transmission, as it will be more sensitive to noise. You could compare this to two people taking in a noisy place (a bar for example). If you\u2019re far from each other, you have to talk slow (SF10), but if you\u2019re close, you can talk faster (SF7)

    So, it's balancing act between speed of the transmission and resistance to noise. things network is mainly focused on LoRaWAN, but the LoRa low-level stuff still checks out for any LoRa project

    "},{"location":"faq/#52-q-do-meshcore-clients-repeat","title":"5.2. Q: Do MeshCore clients repeat?","text":"

    A: No, MeshCore clients do not repeat. This is the core of MeshCore's messaging-first design. This is to avoid devices flooding the air ware and create endless collisions, so messages sent aren't received. In MeshCore, only repeaters and room server with set repeat on repeat.

    "},{"location":"faq/#53-q-what-happens-when-a-node-learns-a-route-via-a-mobile-repeater-and-that-repeater-is-gone","title":"5.3. Q: What happens when a node learns a route via a mobile repeater, and that repeater is gone?","text":"

    A: If you used to reach a node through a repeater and the repeater is no longer reachable, the client will send the message using the existing (but now broken) known path, the message will fail after 3 retries, and the app will reset the path and send the message as flood on the last retry by default. This can be turned off in settings. If the destination is reachable directly or through another repeater, the new path will be used going forward. Or you can set the path manually if you know a specific repeater to use to reach that destination.

    In the case if users are moving around frequently, and the paths are breaking, they just see the phone client retries and revert to flood to attempt to re-establish a path.

    "},{"location":"faq/#54-q-how-does-a-node-discovery-a-path-to-its-destination-and-then-use-it-to-send-messages-in-the-future-instead-of-flooding-every-message-it-sends-like-meshtastic","title":"5.4. Q: How does a node discovery a path to its destination and then use it to send messages in the future, instead of flooding every message it sends like Meshtastic?","text":"

    Routes are stored in sender's contact list. When you send a message the first time, the message first gets to your destination by flood routing. When your destination node gets the message, it will send back a delivery report to the sender with all repeaters that the original message went through. This delivery report is flood-routed back to you the sender and is a basis for future direct path. When you send the next message, the path will get embedded into the packet and be evaluated by repeaters. If the hop and address of the repeater matches, it will retransmit the message, otherwise it will not retransmit, hence minimizing utilization.

    Source

    "},{"location":"faq/#55-q-do-public-channels-always-flood-do-private-channels-always-flood","title":"5.5. Q: Do public channels always flood? Do private channels always flood?","text":"

    A: Yes, group channels are A to B, so there is no defined path. They have to flood. Repeaters can however deny flood traffic up to some hop limit, with the set flood.max CLI command. Administrators of repeaters get to set the rules of their repeaters.

    Source

    "},{"location":"faq/#56-q-what-is-the-public-key-for-the-default-public-channel","title":"5.6. Q: what is the public key for the default public channel?","text":"

    A: The smartphone app key is in hex: 8b3387e9c5cdea6ac9e5edbaa115cd72

    T-Deck uses the same key but in base64 izOH6cXN6mrJ5e26oRXNcg== The third character is the capital letter 'O', not zero 0 Source

    "},{"location":"faq/#57-q-is-meshcore-open-source","title":"5.7. Q: Is MeshCore open source?","text":"

    A: Most of the firmware is freely available. Everything is open source except the T-Deck firmware and Liam's native mobile apps. - Firmware repo: https://github.com/meshcore-dev/MeshCore

    "},{"location":"faq/#58-q-how-can-i-support-meshcore","title":"5.8. Q: How can I support MeshCore?","text":"

    A: Provide your honest feedback on GitHub and on MeshCore Discord server. Spread the word of MeshCore to your friends and communities; help them get started with MeshCore. Support Scott's MeshCore development at https://buymeacoffee.com/ripplebiz.

    Support Liam Cottle's smartphone client development by unlocking the server administration wait gate with in-app purchase

    Support Rastislav Vysoky (recrof)'s flasher web site and the map web site development through PayPal or Revolut

    "},{"location":"faq/#59-q-how-do-i-build-meshcore-firmware-from-source","title":"5.9. Q: How do I build MeshCore firmware from source?","text":"

    A: See instructions here: https://discord.com/channels/826570251612323860/1330643963501351004/1341826372120608769

    Build instructions for MeshCore:

    For Windows, first install WSL and Python+pip via: https://plainenglish.io/blog/setting-up-python-on-windows-subsystem-for-linux-wsl-26510f1b2d80

    (Linux, Windows+WSL) In the terminal/shell:

    sudo apt update\nsudo apt install libpython3-dev\nsudo apt install python3-venv\n

    Mac: python3 should be already installed.

    Then it should be the same for all platforms:

    python3 -m venv meshcore\ncd meshcore && source bin/activate\npip install -U platformio\ngit clone https://github.com/ripplebiz/MeshCore.git\ncd MeshCore\n

    open platformio.ini and in [arduino_base] edit the LORA_FREQ=867.5 save, then run:

    pio run -e RAK_4631_Repeater\n

    then you'll find firmware.zip in .pio/build/RAK_4631_Repeater

    Andy also has a video on how to build using VS Code: How to build and flash Meshcore repeater firmware | Heltec V3 https://www.youtube.com/watch?v=WJvg6dt13hk (Link referenced in the Discord post)

    "},{"location":"faq/#510-q-are-there-other-meshcore-related-open-source-projects","title":"5.10. Q: Are there other MeshCore related open source projects?","text":"

    A: Liam Cottle's MeshCore web client and MeshCore Javascript library are open source under MIT license.

    Web client: https://github.com/liamcottle/meshcore-web Javascript: https://github.com/liamcottle/meshcore.js

    "},{"location":"faq/#511-q-does-meshcore-support-atak","title":"5.11. Q: Does MeshCore support ATAK","text":"

    A: ATAK is not currently on MeshCore's roadmap.

    Meshcore would not be best suited to ATAK because MeshCore: clients do not repeat and therefore you would need a network of repeaters in place will not have a stable path where all clients are constantly moving between repeaters

    MeshCore clients would need to reset path constantly and flood traffic across the network which could lead to lots of collisions with something as chatty as ATAK.

    This could change in the future if MeshCore develops a client firmware that repeats. Source

    "},{"location":"faq/#512-q-how-do-i-add-a-node-to-the-meshcore-map","title":"5.12. Q: How do I add a node to the MeshCore Map","text":"

    A:

    To add a BLE Companion radio, connect to the BLE Companion radio from the MeshCore smartphone app. In the app, tap the 3 dot menu icon at the top right corner, then tap Internet Map. Tap the 3 dot menu icon again and choose Add me to the Map

    To add a Repeater or Room Server to the map, go to the Contact List, tap the 3 dot next to the Repeater or Room Server you want to add to the Internet Map, tap Share, then tap Upload to Internet Map.

    You can use the same companion (same public key) that you used to add your repeaters or room servers to remove them from the Internet Map.

    "},{"location":"faq/#513-q-can-i-use-a-raspberry-pi-to-update-a-meshcore-radio","title":"5.13. Q: Can I use a Raspberry Pi to update a MeshCore radio?","text":"

    ** A:** Yes. Below are the instructions to flash firmware onto a supported LoRa device using a Raspberry Pi over USB serial.

    Instructions for nRF devices like RAK, T1000-E, T114 are immediately after the ESP instructions

    For ESP-based devices (e.g. Heltec V3) you need: - Download firmware file from flasher.meshcore.co.uk - Go to the web site on a browser, find the section that has the firmware up need - Click the Download button, right click on the file you need, for example, - Heltec_V3_companion_radio_ble-v1.7.1-165fb33.bin - Non-merged bin keeps the existing Bluetooth pairing database - Heltec_v3_companion_radio_usb-v1.7.1-165fb33-merged.bin - Merged bin overwrites everything including the bootloader, existing Bluetooth pairing database, but keeps configurations. - Right click on the file name and copy the link and note it for later use here is an example: https://flasher.meshcore.dev/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin - Run: - wget https://flasher.meshcore.dev/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_ble-v1.7.1-165fb33.bin to download the firmware file for your device type. or the version you need - USB, BLE, Repeater, Room Server, merged bin or non-merged bin - If the above wget command only downloads a very small file (10K bytes instead of more than 100K byte, use this command instead: - wget --user-agent=\"Mozilla/5.0\" --content-disposition \"https://flasher.meshcore.dev/releases/download/companion-v1.7.1/Heltec_v3_companion_radio_usb-v1.7.1-165fb33.bin\" - Confirm the ttyXXXX device path on your Raspberry Pi: - Go to /dev directory, run ls command to find confirm your device path - They are usually /dev/ttyUSB0 for ESP devices - For ESP-based devices, install esptool from the shell: - pip install esptool --break-system-packages - To flash, use the following command: - For non-merged bin: - esptool.py -p /dev/ttyUSB0 --chip esp32-s3 write_flash 0x10000 <non-merged_firmware>.bin - For merged bin: - esptool.py -p /dev/ttyUSB0 --chip esp32-s3 write_flash 0x00000 <merged_firmware>.bin

    Instructions for nRF devices:

    For nRF devices (e.g. RAK, Heltec T114) you need the following: - Download firmware file from flasher.meshcore.co.uk - Go to the web site on a browser, find the section that has the firmware up need - You need the ZIP version for the adafruit flash tool (below) - Click the Download button, right click on the ZIP file, for example: - RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip - Right click on the file name and copy the link and note it for later use here is an example: https://flasher.meshcore.dev/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip - Run: - wget https://flasher.meshcore.dev/releases/download/companion-v1.7.1/RAK_4631_companion_radio_ble-v1.7.1-165fb33.zip to download the firmware file for your device type. or the version you need - USB, BLE, Repeater, Room Server, ZIP file only - Confirm the ttyXXXX device path on your Raspberry Pi: - Go to /dev directory, run ls command to find confirm your device path - They are usually /dev/ttyACM0 for nRF devices - For nRF-based devices, install adafruit-nrfutil - pip install adafruit-nrfutil --break-system-packages - Use this command to flash the nRF device: - adafruit-nrfutil --verbose dfu serial --package RAK_4631_companion_radio_usb-v1.7.1-165fb33.zip -p /dev/ttyACM0 -b 115200 --singlebank --touch 1200

    To manage a repeater or room server connected to a Pi over USB serial using shell commands, you need to install picocom. To install picocom, run the following command: - sudo apt install picocom

    To start managing your USB serial-connected device using picocom, use the following command: - picocom -b 115200 /dev/ttyUSB0 --imap lfcrlf

    From here, reference repeater and room server command line commands on MeshCore github wiki here: - https://github.com/meshcore-dev/MeshCore/wiki/Repeater-&-Room-Server-CLI-Reference

    "},{"location":"faq/#514-q-are-there-are-projects-built-around-meshcore","title":"5.14. Q: Are there are projects built around MeshCore?","text":"

    A: Yes. See the following:

    "},{"location":"faq/#5141-meshcoremqtt","title":"5.14.1. meshcoremqtt","text":"

    A Python script to send meshcore debug and packet capture data to MQTT for analysis. Cisien's version is a fork of Andrew-a-g's and is being used to to collect data for https://map.w0z.is/messages and https://analyzer.letsmesh.net/ https://github.com/Cisien/meshcoretomqtt https://github.com/Andrew-a-g/meshcoretomqtt

    "},{"location":"faq/#5142-meshcore-for-home-assistant","title":"5.14.2. MeshCore for Home Assistant","text":"

    A custom Home Assistant integration for MeshCore mesh radio nodes. It allows you to monitor and control MeshCore nodes via USB, BLE, or TCP connections. https://github.com/awolden/meshcore-ha

    "},{"location":"faq/#5143-python-meshcore","title":"5.14.3. Python MeshCore","text":"

    Bindings to access your MeshCore companion radio nodes in python. https://github.com/fdlamotte/meshcore_py

    "},{"location":"faq/#5144-meshcore-cli","title":"5.14.4. meshcore-cli","text":"

    CLI interface to MeshCore companion radio over BLE, TCP, or serial. Uses Python MeshCore above. https://github.com/fdlamotte/meshcore-cli

    "},{"location":"faq/#5145-meshcorejs","title":"5.14.5. meshcore.js","text":"

    A JavaScript library for interacting with a MeshCore device running the companion radio firmware https://github.com/liamcottle/meshcore.js

    "},{"location":"faq/#5146-pymc_core","title":"5.14.6. pyMC_core","text":"

    pyMC_Core is a Python port of MeshCore, designed for Raspberry Pi and similar hardware, it talks to LoRa modules over SPI. https://github.com/rightup/pyMC_core

    "},{"location":"faq/#5147-meshcore-packet-decoder","title":"5.14.7. MeshCore Packet Decoder","text":"

    A TypeScript library for decoding MeshCore mesh networking packets with full cryptographic support. Uses WebAssembly (WASM) for Ed25519 key derivation through the orlp/ed25519 library. It powers the MeshCore Packet Analyzer. https://github.com/michaelhart/meshcore-decoder

    "},{"location":"faq/#5148-meshcore-pi","title":"5.14.8. meshcore-pi","text":"

    meshcore-pi is another Python port of MeshCore, designed for Raspberry Pi and similar hardware, it talks to LoRa modules over SPI or GPIO. https://github.com/brianwiddas/meshcore-pi

    "},{"location":"faq/#5149-pymc_repeater","title":"5.14.9. pyMC_Repeater","text":"

    pyMC_Repeater is a repeater daemon in Python built on top of the pymc_core library. https://github.com/rightup/pyMC_Repeater

    "},{"location":"faq/#515-q-are-there-client-applications-for-windows-or-mac","title":"5.15. Q: Are there client applications for Windows or Mac?","text":"

    A: Yes, the same iOS and Android client is also available for Windows and Intel Mac (sorry, not available for ARM-based Mac yet). You can find them together with the Android APK here: https://files.liamcottle.net/MeshCore

    Both the Windows and Intel Mac versions of the client app are fully unlocked and are free to use.

    "},{"location":"faq/#516-q-are-there-any-resources-that-compare-meshcore-to-other-lora-systems","title":"5.16. Q: Are there any resources that compare MeshCore to other LoRa systems?","text":"

    A: Here is a list of MeshCore comparison resources: The Comms Channel on YouTube: https://www.youtube.com/watch?v=guDoKGs02Us MeshCore Advantages by MCarper: https://github.com/mikecarper/meshfirmware/blob/main/MeshCoreAdvantages.md Meshcore vs Meshtastic by austinmesh.org https://www.austinmesh.org/learn/meshcore-vs-meshtastic/

    "},{"location":"faq/#6-troubleshooting","title":"6. Troubleshooting","text":""},{"location":"faq/#61-q-my-client-says-another-client-or-a-repeater-or-a-room-server-was-last-seen-many-many-days-ago","title":"6.1. Q: My client says another client or a repeater or a room server was last seen many, many days ago.","text":""},{"location":"faq/#62-q-a-repeater-or-a-client-or-a-room-server-i-expect-to-see-on-my-discover-list-on-t-deck-or-contact-list-on-a-smart-device-client-are-not-listed","title":"6.2. Q: A repeater or a client or a room server I expect to see on my discover list (on T-Deck) or contact list (on a smart device client) are not listed.","text":"

    A: - If your client is a T-Deck, it may not have its time set (no GPS installed, no GPS lock, or wrong GPS baud rate). - If you are using the Android or iOS client, the other client, repeater, or room server may have the wrong time.

    You can get the epoch time on https://www.epochconverter.com/ and use it to set your T-Deck clock. For a repeater and room server, the admin can use a T-Deck to remotely set their clock (clock sync), or use the time command in the USB serial console with the server device connected.

    "},{"location":"faq/#63-q-how-to-connect-to-a-repeater-via-ble-bluetooth","title":"6.3. Q: How to connect to a repeater via BLE (Bluetooth)?","text":"

    A: You can't connect to a device running repeater firmware via Bluetooth. Devices running the BLE companion firmware you can connect to it via Bluetooth using the android app

    "},{"location":"faq/#64-q-my-companion-isnt-showing-up-over-bluetooth","title":"6.4. Q: My companion isn't showing up over Bluetooth?","text":"

    A: make sure that you flashed the Bluetooth companion firmware and not the USB-only companion firmware.

    "},{"location":"faq/#65-q-i-cant-connect-via-bluetooth-what-is-the-bluetooth-pairing-code","title":"6.5. Q: I can't connect via Bluetooth, what is the Bluetooth pairing code?","text":"

    A: the default Bluetooth pairing code is 123456

    "},{"location":"faq/#66-q-my-heltec-v3-keeps-disconnecting-from-my-smartphone-it-cant-hold-a-solid-bluetooth-connection","title":"6.6. Q: My Heltec V3 keeps disconnecting from my smartphone. It can't hold a solid Bluetooth connection.","text":"

    A: Heltec V3 has a very small coil antenna on its PCB for Wi-Fi and Bluetooth connectivity. It has a very short range, only a few feet. It is possible to remove the coil antenna and replace it with a 31mm wire. The BT range is much improved with the modification.

    "},{"location":"faq/#67-q-my-rakt1000-exiao_nrf52-device-seems-to-be-corrupted-how-do-i-wipe-it-clean-to-start-fresh","title":"6.7. Q: My RAK/T1000-E/xiao_nRF52 device seems to be corrupted, how do I wipe it clean to start fresh?","text":"

    A: 1. Connect USB-C cable to your device, per your device's instruction, get it to flash mode: - For RAK, click the reset button TWICE - For T1000-e, quickly disconnect and reconnect the magnetic side of the cable from the device TWICE - For Heltec T114, click the reset button TWICE (the bottom button) - For Xiao nRF52, click the reset button once. If that doesn't work, quickly double click the reset button twice. If that doesn't work, disconnection the board from your PC and reconnect again (seeed studio wiki) 5. A new folder will appear on your computer's desktop 6. Download the flash_erase*.uf2 file for your device on flasher.meshcore.co.uk - RAK WisBlock and Heltec T114: Flash_erase-nRF32_softdevice_v6.uf2 - Seeed Studio Xiao nRF52 WIO: Flash_erase-nRF52_softdevice_v7.uf2 8. drag and drop the uf2 file for your device to the root of the new folder 9. Wait for the copy to complete. You might get an error dialog, you can ignore it 10. Go to https://flasher.meshcore.co.uk/, click Console and select the serial port for your connected device 11. In the console, press enter. Your flash should now be erased 12. You may now flash the latest MeshCore firmware onto your device

    Separately, starting in firmware version 1.7.0, there is a CLI Rescue mode. If your device has a user button (e.g. some RAK, T114), you can activate the rescue mode by hold down the user button of the device within 8 seconds of boot. Then you can use the 'Console' on flasher.meshcore.co.uk

    "},{"location":"faq/#68-q-webflasher-fails-on-linux-with-failed-to-open","title":"6.8. Q: WebFlasher fails on Linux with failed to open","text":"

    A: If the usb port doesn't have the right ownership for this task, the process fails with the following error: NetworkError: Failed to execute 'open' on 'SerialPort': Failed to open serial port.

    Allow the browser user on it: # setfacl -m u:YOUR_USER_HERE:rw /dev/ttyUSB0

    "},{"location":"faq/#7-other-questions","title":"7. Other Questions:","text":""},{"location":"faq/#71-q-how-to-update-nrf-rak-t114-seed-xiao-repeater-and-room-server-firmware-over-the-air-using-the-new-simpler-dfu-app","title":"7.1. Q: How to update nRF (RAK, T114, Seed XIAO) repeater and room server firmware over the air using the new simpler DFU app?","text":"

    A: The steps below work on both Android and iOS as nRF has made both apps' user interface the same on both platforms:

    1. Download nRF's DFU app from iOS App Store or Android's Play Store, you can find the app by searching for nrf dfu, the app's full name is nRF Device Firmware Update
    2. On flasher.meshcore.co.uk, download the ZIP version of the firmware for your nRF device (e.g. RAK or Heltec T114 or Seeed Studio's Xiao)
    3. From the MeshCore app, login remotely to the repeater you want to update with admin privilege
    4. Go to the Command Line tab, type start ota and hit enter.
    5. you should see OK to confirm the repeater device is now in OTA mode
    6. Run the DFU app,tab Settings on the top right corner
    7. Enable Packets receipt notifications, and change Number of Packets to 10 for RAK, 8 for T114. 8 also works for RAK.
    8. Select the firmware zip file you downloaded
    9. Select the device you want to update. If the device you want to update is not on the list, try enablingOTA on the device again
    10. If the device is not found, enable Force Scanning in the DFU app
    11. Tab the Upload to begin OTA update
    12. If it fails, try turning off and on Bluetooth on your phone. If that doesn't work, try rebooting your phone.
    13. Wait for the update to complete. It can take a few minutes.
    "},{"location":"faq/#711-q-can-i-update-seeed-studio-wio-tracker-l1-pro-using-ota","title":"7.1.1 Q: Can I update Seeed Studio Wio Tracker L1 Pro using OTA?","text":"

    A: You can flash this safer bootloader to the Wio Tracker L1 Pro https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX

    After this bootloader is flashed onto the device, you can trigger over the air update using bluetooth by holding the button next to the D-Pad and then click the reset button. The follow the same OTA update instructions above. You can skip pass the start ota instruction and start the update using the DFU app.

    "},{"location":"faq/#72-q-how-to-update-esp32-based-devices-over-the-air","title":"7.2. Q: How to update ESP32-based devices over the air?","text":"

    A: For ESP32-based devices (e.g. Heltec V3): 1. On flasher.meshcore.co.uk, download the non-merged version of the firmware for your ESP32 device (e.g. Heltec_v3_repeater-v1.6.2-4449fd3.bin, no \"merged\" in the file name) 2. From the MeshCore app, login remotely to the repeater you want to update with admin privilege 4. Go to the Command Line tab, type start ota and hit enter. 5. you should see OK to confirm the repeater device is now in OTA mode 6. The command start ota on an ESP32-based device starts a wifi hotspot named MeshCore OTA 7. From your phone or computer connect to the 'MeshCore OTA' hotspot 8. From a browser, go to http://192.168.4.1/update and upload the non-merged bin from the flasher

    "},{"location":"faq/#73-q-is-there-a-way-to-lower-the-chance-of-a-failed-ota-device-firmware-update-dfu","title":"7.3. Q: Is there a way to lower the chance of a failed OTA device firmware update (DFU)?","text":"

    A: Yes, developer che aporeps has an enhanced OTA DFU bootloader for nRF52 based devices. With this bootloader, if it detects that the application firmware is invalid, it falls back to OTA DFU mode so you can attempt to flash again to recover. This bootloader has other changes to make the OTA DFU process more fault tolerant.

    Refer to https://github.com/oltaco/Adafruit_nRF52_Bootloader_OTAFIX for the latest information.

    Currently, the following boards are supported: - Heltec Automation Mesh Node T114 / HT-nRF5262 - Nologo ProMicro NRF52840 (aka SuperMini NRF52840) - Seeed Studio SenseCAP Card Tracker T1000-E - Seeed Studio Wio Tracker L1 - Seeed Studio XIAO nRF52840 BLE - Seeed Studio XIAO nRF52840 BLE SENSE - RAK 4631 (See note) - RAK WisMesh Tag (new 28/11/2025)

    "},{"location":"faq/#74-q-are-the-meshcore-logo-and-font-available","title":"7.4. Q: are the MeshCore logo and font available?","text":"

    A: Yes, it is on the MeshCore github repo here: https://github.com/meshcore-dev/MeshCore/tree/main/logo

    "},{"location":"faq/#75-q-what-is-the-format-of-a-contact-or-channel-qr-code","title":"7.5. Q: What is the format of a contact or channel QR code?","text":"

    A: Channel: meshcore://channel/add?name=<name>&secret=<secret>

    Contact: meshcore://contact/add?name=<name>&public_key=<secret>&type=<type>

    where &type is: chat = 1 repeater = 2 room = 3 sensor = 4

    "},{"location":"faq/#76-q-how-do-i-connect-to-the-companion-via-wifi-eg-using-a-heltec-v3","title":"7.6. Q: How do I connect to the companion via WIFI, e.g. using a heltec v3?","text":"

    A: WiFi firmware requires you to compile it yourself, as you need to set the wifi ssid and password. Edit WIFI_SSID and WIFI_PWD in ./variants/heltec_v3/platformio.ini and then flash it to your device.

    "},{"location":"faq/#77-q-i-have-a-station-g2-or-a-heltec-v4-or-an-ikoka-stick-or-a-radio-with-a-ebyte-e22-900m30s-or-a-e22-900m33s-module-what-should-their-transmit-power-be-set-to","title":"7.7. Q: I have a Station G2, or a Heltec V4, or an Ikoka Stick, or a radio with a EByte E22-900M30S or a E22-900M33S module, what should their transmit power be set to?","text":"

    A: For companion radios, you can set these radios' transmit power in the smartphone app. For repeater and room server radios, you can set their transmit power using the command line command set tx. You can get their current value using command line comand get tx

    Device / Model Region / Description In-App Setting (dBm) Target Radio Output Notes Station G2 Reference US915 Max Output 19 dBm 36.5 dBm (4.46W) US915 Recommended Max 16 dBm 35 dBm (3.16W) 1dB compression point EU868 Recommended Max 15 dBm 34.5 dBm (2.82W) 1dB compression point US915 1W Output 10 dBm 1W EU868 1W Output 9 dBm 1W Ikoka Stick E22-900M30S 1W Model 19 dBm 1W DO NOT EXCEED (Risk of burn out) Ikoka Stick E22-900M33S 2W Model 9 dBm 2W DO NOT EXCEED (Risk of burn out) Heltec V4 Standard Output 10 dBm 22 dBm High Output 22 dBm 28 dBm ---"},{"location":"faq/#warning-set-these-values-at-your-own-risk-incorrect-power-settings-can-permanently-damage-your-radio-hardware","title":"\u26a0\ufe0f WARNING: Set these values at your own risk. Incorrect power settings can permanently damage your radio hardware.","text":""},{"location":"nrf52_power_management/","title":"nRF52 Power Management","text":""},{"location":"nrf52_power_management/#overview","title":"Overview","text":"

    The nRF52 Power Management module provides battery protection features to prevent over-discharge, minimise likelihood of brownout and flash corruption conditions existing, and enable safe voltage-based recovery.

    "},{"location":"nrf52_power_management/#features","title":"Features","text":""},{"location":"nrf52_power_management/#boot-voltage-protection","title":"Boot Voltage Protection","text":""},{"location":"nrf52_power_management/#voltage-wake-lpcomp-vbus","title":"Voltage Wake (LPCOMP + VBUS)","text":""},{"location":"nrf52_power_management/#early-boot-register-capture","title":"Early Boot Register Capture","text":""},{"location":"nrf52_power_management/#shutdown-reason-tracking","title":"Shutdown Reason Tracking","text":"

    Shutdown reason codes (stored in GPREGRET2): | Code | Name | Description | |------|------|-------------| | 0x00 | NONE | Normal boot / no previous shutdown | | 0x4C | LOW_VOLTAGE | Runtime low voltage threshold reached | | 0x55 | USER | User requested powerOff() | | 0x42 | BOOT_PROTECT | Boot voltage protection triggered |

    "},{"location":"nrf52_power_management/#supported-boards","title":"Supported Boards","text":"Board Implemented LPCOMP wake VBUS wake Seeed Studio XIAO nRF52840 (xiao_nrf52) Yes Yes Yes RAK4631 (rak4631) Yes Yes Yes Heltec T114 (heltec_t114) Yes Yes Yes Promicro nRF52840 No No No RAK WisMesh Tag No No No Heltec Mesh Solar No No No LilyGo T-Echo / T-Echo Lite No No No SenseCAP Solar No No No WIO Tracker L1 / L1 E-Ink No No No WIO WM1110 No No No Mesh Pocket No No No Nano G2 Ultra No No No ThinkNode M1/M3/M6 No No No T1000-E No No No Ikoka Nano/Stick/Handheld (nRF) No No No Keepteen LT1 No No No Minewsemi ME25LS01 No No No

    Notes: - \"Implemented\" reflects Phase 1 (boot lockout + shutdown reason capture). - User power-off on Heltec T114 does not enable LPCOMP wake. - VBUS detection is used to skip boot lockout on external power, and VBUS wake is configured alongside LPCOMP when supported hardware exposes VBUS to the nRF52.

    "},{"location":"nrf52_power_management/#technical-details","title":"Technical Details","text":""},{"location":"nrf52_power_management/#architecture","title":"Architecture","text":"

    The power management functionality is integrated into the NRF52Board base class in src/helpers/NRF52Board.cpp. Board variants provide hardware-specific configuration via a PowerMgtConfig struct and override initiateShutdown(uint8_t reason) to perform board-specific power-down work and conditionally enable voltage wake (LPCOMP + VBUS).

    "},{"location":"nrf52_power_management/#early-boot-capture","title":"Early Boot Capture","text":"

    A static constructor with priority 101 in NRF52Board.cpp captures the RESETREAS and GPREGRET2 registers before: - SystemInit() (priority 102) - which clears RESETREAS - Static C++ constructors (default priority 65535)

    This ensures we capture the true reset reason before any initialisation code runs.

    "},{"location":"nrf52_power_management/#board-implementation","title":"Board Implementation","text":"

    To enable power management on a board variant:

    1. Enable in platformio.ini: ini -D NRF52_POWER_MANAGEMENT

    2. Define configuration in variant.h: c #define PWRMGT_VOLTAGE_BOOTLOCK 3300 // Won't boot below this voltage (mV) #define PWRMGT_LPCOMP_AIN 7 // AIN channel for voltage sensing #define PWRMGT_LPCOMP_REFSEL 2 // REFSEL (0-6=1/8..7/8, 7=ARef, 8-15=1/16..15/16)

    3. Implement in board .cpp file: ```cpp #ifdef NRF52_POWER_MANAGEMENT const PowerMgtConfig power_config = { .lpcomp_ain_channel = PWRMGT_LPCOMP_AIN, .lpcomp_refsel = PWRMGT_LPCOMP_REFSEL, .voltage_bootlock = PWRMGT_VOLTAGE_BOOTLOCK };

    void MyBoard::initiateShutdown(uint8_t reason) { // Board-specific shutdown preparation (e.g., disable peripherals) bool enable_lpcomp = (reason == SHUTDOWN_REASON_LOW_VOLTAGE || reason == SHUTDOWN_REASON_BOOT_PROTECT);

     if (enable_lpcomp) {\n   configureVoltageWake(power_config.lpcomp_ain_channel, power_config.lpcomp_refsel);\n }\n\n enterSystemOff(reason);\n

    } #endif

    void MyBoard::begin() { NRF52Board::begin(); // or NRF52BoardDCDC::begin() // ... board setup ...

    #ifdef NRF52_POWER_MANAGEMENT checkBootVoltage(&power_config); #endif } ```

    For user-initiated shutdowns, powerOff() remains board-specific. Power management only arms LPCOMP for automated shutdown reasons (boot protection/low voltage).

    1. Declare override in board .h file: cpp #ifdef NRF52_POWER_MANAGEMENT void initiateShutdown(uint8_t reason) override; #endif
    "},{"location":"nrf52_power_management/#voltage-wake-configuration","title":"Voltage Wake Configuration","text":"

    The LPCOMP (Low Power Comparator) is configured to: - Monitor the specified AIN channel (0-7 corresponding to P0.02-P0.05, P0.28-P0.31) - Compare against VDD fraction reference (REFSEL: 0-6=1/8..7/8, 7=ARef, 8-15=1/16..15/16) - Detect UP events (voltage rising above threshold) - Use 50mV hysteresis for noise immunity - Wake the device from SYSTEMOFF when triggered

    VBUS wake is enabled via the POWER peripheral USBDETECTED event whenever configureVoltageWake() is used. This requires USB VBUS to be routed to the nRF52 (typical on nRF52840 boards with native USB).

    LPCOMP Reference Selection (PWRMGT_LPCOMP_REFSEL): | REFSEL | Fraction | VBAT @ 1M/1M divider (VDD=3.0-3.3) | VBAT @ 1.5M/1M divider (VDD=3.0-3.3) | |--------|----------|------------------------------------|--------------------------------------| | 0 | 1/8 | 0.75-0.82 V | 0.94-1.03 V | | 1 | 2/8 | 1.50-1.65 V | 1.88-2.06 V | | 2 | 3/8 | 2.25-2.47 V | 2.81-3.09 V | | 3 | 4/8 | 3.00-3.30 V | 3.75-4.12 V | | 4 | 5/8 | 3.75-4.12 V | 4.69-5.16 V | | 5 | 6/8 | 4.50-4.95 V | 5.62-6.19 V | | 6 | 7/8 | 5.25-5.77 V | 6.56-7.22 V | | 7 | ARef | - | - | | 8 | 1/16 | 0.38-0.41 V | 0.47-0.52 V | | 9 | 3/16 | 1.12-1.24 V | 1.41-1.55 V | | 10 | 5/16 | 1.88-2.06 V | 2.34-2.58 V | | 11 | 7/16 | 2.62-2.89 V | 3.28-3.61 V | | 12 | 9/16 | 3.38-3.71 V | 4.22-4.64 V | | 13 | 11/16 | 4.12-4.54 V | 5.16-5.67 V | | 14 | 13/16 | 4.88-5.36 V | 6.09-6.70 V | | 15 | 15/16 | 5.62-6.19 V | 7.03-7.73 V |

    Important: For boards with a voltage divider on the battery sense pin, LPCOMP measures the divided voltage. Use: VBAT_threshold \u2248 (VDD * fraction) * divider_scale, where divider_scale = (Rtop + Rbottom) / Rbottom (e.g., 2.0 for 1M/1M, 2.5 for 1.5M/1M, 3.0 for XIAO).

    "},{"location":"nrf52_power_management/#softdevice-compatibility","title":"SoftDevice Compatibility","text":"

    The power management code checks whether SoftDevice is enabled and uses the appropriate API: - When SD enabled: sd_power_* functions - When SD disabled: Direct register access (NRF_POWER->*)

    This ensures compatibility regardless of BLE stack state.

    "},{"location":"nrf52_power_management/#cli-commands","title":"CLI Commands","text":"

    Power management status can be queried via the CLI:

    Command Description get pwrmgt.support Returns \"supported\" or \"unsupported\" get pwrmgt.source Returns current power source - \"battery\" or \"external\" (5V/USB power) get pwrmgt.bootreason Returns reset and shutdown reason strings get pwrmgt.bootmv Returns boot voltage in millivolts

    On boards without power management enabled, all commands except get pwrmgt.support return:

    ERROR: Power management not supported\n
    "},{"location":"nrf52_power_management/#debug-output","title":"Debug Output","text":"

    When MESH_DEBUG=1 is enabled, the power management module outputs:

    DEBUG: PWRMGT: Reset = Wake from LPCOMP (0x20000); Shutdown = Low Voltage (0x4C)\nDEBUG: PWRMGT: Boot voltage = 3450 mV (threshold = 3300 mV)\nDEBUG: PWRMGT: LPCOMP wake configured (AIN7, ref=3/8 VDD)\n
    "},{"location":"nrf52_power_management/#phase-2-planned","title":"Phase 2 (Planned)","text":""},{"location":"nrf52_power_management/#references","title":"References","text":""},{"location":"packet_format/","title":"Packet Format","text":"

    This document describes the MeshCore packet format.

    "},{"location":"packet_format/#version-1-packet-format","title":"Version 1 Packet Format","text":"

    This is the protocol level packet structure used in MeshCore firmware v1.12.0

    [header][transport_codes(optional)][path_length][path][payload]\n
    "},{"location":"packet_format/#packet-format_1","title":"Packet Format","text":"Field Size (bytes) Description header 1 Contains routing type, payload type, and payload version transport_codes 4 (optional) 2x 16-bit transport codes (if ROUTE_TYPE_TRANSPORT_*) path_length 1 Length of the path field in bytes path up to 64 (MAX_PATH_SIZE) Stores the routing path if applicable payload up to 184 (MAX_PACKET_PAYLOAD) Data for the provided Payload Type

    NOTE: see the Payloads documentation for more information about the content of specific payload types.

    "},{"location":"packet_format/#header-format","title":"Header Format","text":"

    Bit 0 means the lowest bit (1s place)

    Bits Mask Field Description 0-1 0x03 Route Type Flood, Direct, etc 2-5 0x3C Payload Type Request, Response, ACK, etc 6-7 0xC0 Payload Version Versioning of the payload format"},{"location":"packet_format/#route-types","title":"Route Types","text":"Value Name Description 0x00 ROUTE_TYPE_TRANSPORT_FLOOD Flood Routing + Transport Codes 0x01 ROUTE_TYPE_FLOOD Flood Routing 0x02 ROUTE_TYPE_DIRECT Direct Routing 0x03 ROUTE_TYPE_TRANSPORT_DIRECT Direct Routing + Transport Codes"},{"location":"packet_format/#payload-types","title":"Payload Types","text":"Value Name Description 0x00 PAYLOAD_TYPE_REQ Request (destination/source hashes + MAC) 0x01 PAYLOAD_TYPE_RESPONSE Response to REQ or ANON_REQ 0x02 PAYLOAD_TYPE_TXT_MSG Plain text message 0x03 PAYLOAD_TYPE_ACK Acknowledgment 0x04 PAYLOAD_TYPE_ADVERT Node advertisement 0x05 PAYLOAD_TYPE_GRP_TXT Group text message (unverified) 0x06 PAYLOAD_TYPE_GRP_DATA Group datagram (unverified) 0x07 PAYLOAD_TYPE_ANON_REQ Anonymous request 0x08 PAYLOAD_TYPE_PATH Returned path 0x09 PAYLOAD_TYPE_TRACE Trace a path, collecting SNR for each hop 0x0A PAYLOAD_TYPE_MULTIPART Packet is part of a sequence of packets 0x0B PAYLOAD_TYPE_CONTROL Control packet data (unencrypted) 0x0C reserved reserved 0x0D reserved reserved 0x0E reserved reserved 0x0F PAYLOAD_TYPE_RAW_CUSTOM Custom packet (raw bytes, custom encryption)"},{"location":"packet_format/#payload-versions","title":"Payload Versions","text":"Value Version Description 0x00 1 1-byte src/dest hashes, 2-byte MAC 0x01 2 Future version (e.g., 2-byte hashes, 4-byte MAC) 0x02 3 Future version 0x03 4 Future version"},{"location":"payloads/","title":"Payload Format","text":"

    Inside each MeshCore Packet is a payload, identified by the payload type in the packet header. The types of payloads are:

    This document defines the structure of each of these payload types.

    NOTE: all 16 and 32-bit integer fields are Little Endian.

    "},{"location":"payloads/#important-concepts","title":"Important concepts:","text":""},{"location":"payloads/#node-advertisement","title":"Node advertisement","text":"

    This kind of payload notifies receivers that a node exists, and gives information about the node

    Field Size (bytes) Description public key 32 Ed25519 public key of the node timestamp 4 unix timestamp of advertisement signature 64 Ed25519 signature of public key, timestamp, and app data appdata rest of payload optional, see below

    Appdata

    Field Size (bytes) Description flags 1 specifies which of the fields are present, see below latitude 4 (optional) decimal latitude multiplied by 1000000, integer longitude 4 (optional) decimal longitude multiplied by 1000000, integer feature 1 2 (optional) reserved for future use feature 2 2 (optional) reserved for future use name rest of appdata name of the node

    Appdata Flags

    Value Name Description 0x01 is chat node advert is for a chat node 0x02 is repeater advert is for a repeater 0x03 is room server advert is for a room server 0x04 is sensor advert is for a sensor server 0x10 has location appdata contains lat/long information 0x20 has feature 1 Reserved for future use. 0x40 has feature 2 Reserved for future use. 0x80 has name appdata contains a node name"},{"location":"payloads/#acknowledgement","title":"Acknowledgement","text":"

    An acknowledgement that a message was received. Note that for returned path messages, an acknowledgement can be sent in the \"extra\" payload (see Returned Path) instead of as a separate ackowledgement packet. CLI commands do not cause acknowledgement responses, neither discrete nor extra.

    Field Size (bytes) Description checksum 4 CRC checksum of message timestamp, text, and sender pubkey"},{"location":"payloads/#returned-path-request-response-and-plain-text-message","title":"Returned path, request, response, and plain text message","text":"

    Returned path, request, response, and plain text messages are all formatted in the same way. See the subsection for more details about the ciphertext's associated plaintext representation.

    Field Size (bytes) Description destination hash 1 first byte of destination node public key source hash 1 first byte of source node public key cipher MAC 2 MAC for encrypted data in next field ciphertext rest of payload encrypted message, see subsections below for details"},{"location":"payloads/#returned-path","title":"Returned path","text":"

    Returned path messages provide a description of the route a packet took from the original author. Receivers will send returned path messages to the author of the original message.

    Field Size (bytes) Description path length 1 length of next field path see above a list of node hashes (one byte each) extra type 1 extra, bundled payload type, eg., acknowledgement or response. Same values as in Packet Format extra rest of data extra, bundled payload content, follows same format as main content defined by this document"},{"location":"payloads/#request","title":"Request","text":"Field Size (bytes) Description timestamp 4 send time (unix timestamp) request type 1 see below request data rest of payload depends on request type

    Request type

    Value Name Description 0x01 get stats get stats of repeater or room server 0x02 keepalive (deprecated) 0x03 get telemetry data TODO 0x04 get min,max,avg data sensor nodes - get min, max, average for given time span 0x05 get access list get node's approved access list 0x06 get neighbors get repeater node's neighbors 0x07 get owner info get repeater firmware-ver/name/owner info"},{"location":"payloads/#get-stats","title":"Get stats","text":"

    Gets information about the node, possibly including the following:

    "},{"location":"payloads/#get-telemetry-data","title":"Get telemetry data","text":"

    Request data about sensors on the node, including battery level.

    "},{"location":"payloads/#get-telemetry","title":"Get Telemetry","text":"

    TODO

    "},{"location":"payloads/#get-minmaxave-sensor-nodes","title":"Get Min/Max/Ave (Sensor nodes)","text":"

    TODO

    "},{"location":"payloads/#get-access-list","title":"Get Access List","text":"

    TODO

    "},{"location":"payloads/#get-neighors","title":"Get Neighors","text":"

    TODO

    "},{"location":"payloads/#get-owner-info","title":"Get Owner Info","text":"

    TODO

    "},{"location":"payloads/#response","title":"Response","text":"Field Size (bytes) Description tag 4 TODO content rest of payload TODO"},{"location":"payloads/#plain-text-message","title":"Plain text message","text":"Field Size (bytes) Description timestamp 4 send time (unix timestamp) txt_type + attempt 1 upper six bits are txt_type (see below), lower two bits are attempt number (0..3) message rest of payload the message content, see next table

    txt_type

    Value Description Message content 0x00 plain text message the plain text of the message 0x01 CLI command the command text of the message 0x02 signed plain text message first four bytes is sender pubkey prefix, followed by plain text message"},{"location":"payloads/#anonymous-request","title":"Anonymous request","text":"Field Size (bytes) Description destination hash 1 first byte of destination node public key public key 32 sender's Ed25519 public key cipher MAC 2 MAC for encrypted data in next field ciphertext rest of payload encrypted message, see below for details"},{"location":"payloads/#room-server-login","title":"Room server login","text":"Field Size (bytes) Description timestamp 4 sender time (unix timestamp) sync timestamp 4 sender's \"sync messages SINCE x\" timestamp password rest of message password for room"},{"location":"payloads/#repeatersensor-login","title":"Repeater/Sensor login","text":"Field Size (bytes) Description timestamp 4 sender time (unix timestamp) password rest of message password for repeater/sensor"},{"location":"payloads/#repeater-regions-request","title":"Repeater - Regions request","text":"Field Size (bytes) Description timestamp 4 sender time (unix timestamp) req type 1 0x01 (request sub type) reply path len 1 path len for reply reply path (variable) reply path"},{"location":"payloads/#repeater-owner-info-request","title":"Repeater - Owner info request","text":"Field Size (bytes) Description timestamp 4 sender time (unix timestamp) req type 1 0x02 (request sub type) reply path len 1 path len for reply reply path (variable) reply path"},{"location":"payloads/#repeater-clock-and-status-request","title":"Repeater - Clock and status request","text":"Field Size (bytes) Description timestamp 4 sender time (unix timestamp) req type 1 0x03 (request sub type) reply path len 1 path len for reply reply path (variable) reply path"},{"location":"payloads/#group-text-message-datagram","title":"Group text message / datagram","text":"Field Size (bytes) Description channel hash 1 first byte of SHA256 of channel's shared key cipher MAC 2 MAC for encrypted data in next field ciphertext rest of payload encrypted message, see below for details

    The plaintext contained in the ciphertext matches the format described in plain text message. Specifically, it consists of a four byte timestamp, a flags byte, and the message. The flags byte will generally be 0x00 because it is a \"plain text message\". The message will be of the form <sender name>: <message body> (eg., user123: I'm on my way).

    "},{"location":"payloads/#control-data","title":"Control data","text":"Field Size (bytes) Description flags 1 upper 4 bits is sub_type data rest of payload typically unencrypted data"},{"location":"payloads/#discover_req-sub_type","title":"DISCOVER_REQ (sub_type)","text":"Field Size (bytes) Description flags 1 0x8 (upper 4 bits), prefix_only (lowest bit) type_filter 1 bit for each ADV_TYPE_* tag 4 randomly generate by sender since 4 (optional) epoch timestamp (0 by default)"},{"location":"payloads/#discover_resp-sub_type","title":"DISCOVER_RESP (sub_type)","text":"Field Size (bytes) Description flags 1 0x9 (upper 4 bits), node_type (lower 4) snr 1 signed, SNR*4 tag 4 reflected back from DISCOVER_REQ pubkey 8 or 32 node's ID (or prefix)"},{"location":"payloads/#custom-packet","title":"Custom packet","text":"

    Custom packets have no defined format.

    "},{"location":"qr_codes/","title":"QR Codes","text":"

    This document provides an overview of QR Code formats that can be used for sharing MeshCore channels and contacts. The formats described below are supported by the MeshCore mobile app.

    "},{"location":"qr_codes/#add-channel","title":"Add Channel","text":"

    Example URL:

    meshcore://channel/add?name=Public&secret=8b3387e9c5cdea6ac9e5edbaa115cd72\n

    Parameters:

    "},{"location":"qr_codes/#add-contact","title":"Add Contact","text":"

    Example URL:

    meshcore://contact/add?name=Example+Contact&public_key=9cd8fcf22a47333b591d96a2b848b73f457b1bb1a3ea2453a885f9e5787765b1&type=1\n

    Parameters:

    "},{"location":"stats_binary_frames/","title":"Stats Binary Frame Structures","text":"

    Binary frame structures for companion radio stats commands. All multi-byte integers use little-endian byte order.

    "},{"location":"stats_binary_frames/#command-codes","title":"Command Codes","text":"Command Code Description CMD_GET_STATS 56 Get statistics (2-byte command: code + sub-type)"},{"location":"stats_binary_frames/#stats-sub-types","title":"Stats Sub-Types","text":"

    The CMD_GET_STATS command uses a 2-byte frame structure: - Byte 0: CMD_GET_STATS (56) - Byte 1: Stats sub-type: - STATS_TYPE_CORE (0) - Get core device statistics - STATS_TYPE_RADIO (1) - Get radio statistics - STATS_TYPE_PACKETS (2) - Get packet statistics

    "},{"location":"stats_binary_frames/#response-codes","title":"Response Codes","text":"Response Code Description RESP_CODE_STATS 24 Statistics response (2-byte response: code + sub-type)"},{"location":"stats_binary_frames/#stats-response-sub-types","title":"Stats Response Sub-Types","text":"

    The RESP_CODE_STATS response uses a 2-byte header structure: - Byte 0: RESP_CODE_STATS (24) - Byte 1: Stats sub-type (matches command sub-type): - STATS_TYPE_CORE (0) - Core device statistics response - STATS_TYPE_RADIO (1) - Radio statistics response - STATS_TYPE_PACKETS (2) - Packet statistics response

    "},{"location":"stats_binary_frames/#resp_code_stats-stats_type_core-24-0","title":"RESP_CODE_STATS + STATS_TYPE_CORE (24, 0)","text":"

    Total Frame Size: 11 bytes

    Offset Size Type Field Name Description Range/Notes 0 1 uint8_t response_code Always 0x18 (24) - 1 1 uint8_t stats_type Always 0x00 (STATS_TYPE_CORE) - 2 2 uint16_t battery_mv Battery voltage in millivolts 0 - 65,535 4 4 uint32_t uptime_secs Device uptime in seconds 0 - 4,294,967,295 8 2 uint16_t errors Error flags bitmask - 10 1 uint8_t queue_len Outbound packet queue length 0 - 255"},{"location":"stats_binary_frames/#example-structure-cc","title":"Example Structure (C/C++)","text":"
    struct StatsCore {\n    uint8_t  response_code;  // 0x18\n    uint8_t  stats_type;     // 0x00 (STATS_TYPE_CORE)\n    uint16_t battery_mv;\n    uint32_t uptime_secs;\n    uint16_t errors;\n    uint8_t  queue_len;\n} __attribute__((packed));\n
    "},{"location":"stats_binary_frames/#resp_code_stats-stats_type_radio-24-1","title":"RESP_CODE_STATS + STATS_TYPE_RADIO (24, 1)","text":"

    Total Frame Size: 14 bytes

    Offset Size Type Field Name Description Range/Notes 0 1 uint8_t response_code Always 0x18 (24) - 1 1 uint8_t stats_type Always 0x01 (STATS_TYPE_RADIO) - 2 2 int16_t noise_floor Radio noise floor in dBm -140 to +10 4 1 int8_t last_rssi Last received signal strength in dBm -128 to +127 5 1 int8_t last_snr SNR scaled by 4 Divide by 4.0 for dB 6 4 uint32_t tx_air_secs Cumulative transmit airtime in seconds 0 - 4,294,967,295 10 4 uint32_t rx_air_secs Cumulative receive airtime in seconds 0 - 4,294,967,295"},{"location":"stats_binary_frames/#example-structure-cc_1","title":"Example Structure (C/C++)","text":"
    struct StatsRadio {\n    uint8_t  response_code;  // 0x18\n    uint8_t  stats_type;     // 0x01 (STATS_TYPE_RADIO)\n    int16_t  noise_floor;\n    int8_t   last_rssi;\n    int8_t   last_snr;       // Divide by 4.0 to get actual SNR in dB\n    uint32_t tx_air_secs;\n    uint32_t rx_air_secs;\n} __attribute__((packed));\n
    "},{"location":"stats_binary_frames/#resp_code_stats-stats_type_packets-24-2","title":"RESP_CODE_STATS + STATS_TYPE_PACKETS (24, 2)","text":"

    Total Frame Size: 26 bytes

    Offset Size Type Field Name Description Range/Notes 0 1 uint8_t response_code Always 0x18 (24) - 1 1 uint8_t stats_type Always 0x02 (STATS_TYPE_PACKETS) - 2 4 uint32_t recv Total packets received 0 - 4,294,967,295 6 4 uint32_t sent Total packets sent 0 - 4,294,967,295 10 4 uint32_t flood_tx Packets sent via flood routing 0 - 4,294,967,295 14 4 uint32_t direct_tx Packets sent via direct routing 0 - 4,294,967,295 18 4 uint32_t flood_rx Packets received via flood routing 0 - 4,294,967,295 22 4 uint32_t direct_rx Packets received via direct routing 0 - 4,294,967,295"},{"location":"stats_binary_frames/#notes","title":"Notes","text":""},{"location":"stats_binary_frames/#example-structure-cc_2","title":"Example Structure (C/C++)","text":"
    struct StatsPackets {\n    uint8_t  response_code;  // 0x18\n    uint8_t  stats_type;     // 0x02 (STATS_TYPE_PACKETS)\n    uint32_t recv;\n    uint32_t sent;\n    uint32_t flood_tx;\n    uint32_t direct_tx;\n    uint32_t flood_rx;\n    uint32_t direct_rx;\n} __attribute__((packed));\n
    "},{"location":"stats_binary_frames/#command-usage-example-python","title":"Command Usage Example (Python)","text":"
    # Send CMD_GET_STATS command\ndef send_get_stats_core(serial_interface):\n    \"\"\"Send command to get core stats\"\"\"\n    cmd = bytes([56, 0])  # CMD_GET_STATS (56) + STATS_TYPE_CORE (0)\n    serial_interface.write(cmd)\n\ndef send_get_stats_radio(serial_interface):\n    \"\"\"Send command to get radio stats\"\"\"\n    cmd = bytes([56, 1])  # CMD_GET_STATS (56) + STATS_TYPE_RADIO (1)\n    serial_interface.write(cmd)\n\ndef send_get_stats_packets(serial_interface):\n    \"\"\"Send command to get packet stats\"\"\"\n    cmd = bytes([56, 2])  # CMD_GET_STATS (56) + STATS_TYPE_PACKETS (2)\n    serial_interface.write(cmd)\n
    "},{"location":"stats_binary_frames/#response-parsing-example-python","title":"Response Parsing Example (Python)","text":"
    import struct\n\ndef parse_stats_core(frame):\n    \"\"\"Parse RESP_CODE_STATS + STATS_TYPE_CORE frame (11 bytes)\"\"\"\n    response_code, stats_type, battery_mv, uptime_secs, errors, queue_len = \\\n        struct.unpack('<B B H I H B', frame)\n    assert response_code == 24 and stats_type == 0, \"Invalid response type\"\n    return {\n        'battery_mv': battery_mv,\n        'uptime_secs': uptime_secs,\n        'errors': errors,\n        'queue_len': queue_len\n    }\n\ndef parse_stats_radio(frame):\n    \"\"\"Parse RESP_CODE_STATS + STATS_TYPE_RADIO frame (14 bytes)\"\"\"\n    response_code, stats_type, noise_floor, last_rssi, last_snr, tx_air_secs, rx_air_secs = \\\n        struct.unpack('<B B h b b I I', frame)\n    assert response_code == 24 and stats_type == 1, \"Invalid response type\"\n    return {\n        'noise_floor': noise_floor,\n        'last_rssi': last_rssi,\n        'last_snr': last_snr / 4.0,  # Unscale SNR\n        'tx_air_secs': tx_air_secs,\n        'rx_air_secs': rx_air_secs\n    }\n\ndef parse_stats_packets(frame):\n    \"\"\"Parse RESP_CODE_STATS + STATS_TYPE_PACKETS frame (26 bytes)\"\"\"\n    response_code, stats_type, recv, sent, flood_tx, direct_tx, flood_rx, direct_rx = \\\n        struct.unpack('<B B I I I I I I', frame)\n    assert response_code == 24 and stats_type == 2, \"Invalid response type\"\n    return {\n        'recv': recv,\n        'sent': sent,\n        'flood_tx': flood_tx,\n        'direct_tx': direct_tx,\n        'flood_rx': flood_rx,\n        'direct_rx': direct_rx\n    }\n
    "},{"location":"stats_binary_frames/#command-usage-example-javascripttypescript","title":"Command Usage Example (JavaScript/TypeScript)","text":"
    // Send CMD_GET_STATS command\nconst CMD_GET_STATS = 56;\nconst STATS_TYPE_CORE = 0;\nconst STATS_TYPE_RADIO = 1;\nconst STATS_TYPE_PACKETS = 2;\n\nfunction sendGetStatsCore(serialInterface: SerialPort): void {\n    const cmd = new Uint8Array([CMD_GET_STATS, STATS_TYPE_CORE]);\n    serialInterface.write(cmd);\n}\n\nfunction sendGetStatsRadio(serialInterface: SerialPort): void {\n    const cmd = new Uint8Array([CMD_GET_STATS, STATS_TYPE_RADIO]);\n    serialInterface.write(cmd);\n}\n\nfunction sendGetStatsPackets(serialInterface: SerialPort): void {\n    const cmd = new Uint8Array([CMD_GET_STATS, STATS_TYPE_PACKETS]);\n    serialInterface.write(cmd);\n}\n
    "},{"location":"stats_binary_frames/#response-parsing-example-javascripttypescript","title":"Response Parsing Example (JavaScript/TypeScript)","text":"
    interface StatsCore {\n    battery_mv: number;\n    uptime_secs: number;\n    errors: number;\n    queue_len: number;\n}\n\ninterface StatsRadio {\n    noise_floor: number;\n    last_rssi: number;\n    last_snr: number;\n    tx_air_secs: number;\n    rx_air_secs: number;\n}\n\ninterface StatsPackets {\n    recv: number;\n    sent: number;\n    flood_tx: number;\n    direct_tx: number;\n    flood_rx: number;\n    direct_rx: number;\n}\n\nfunction parseStatsCore(buffer: ArrayBuffer): StatsCore {\n    const view = new DataView(buffer);\n    const response_code = view.getUint8(0);\n    const stats_type = view.getUint8(1);\n    if (response_code !== 24 || stats_type !== 0) {\n        throw new Error('Invalid response type');\n    }\n    return {\n        battery_mv: view.getUint16(2, true),\n        uptime_secs: view.getUint32(4, true),\n        errors: view.getUint16(8, true),\n        queue_len: view.getUint8(10)\n    };\n}\n\nfunction parseStatsRadio(buffer: ArrayBuffer): StatsRadio {\n    const view = new DataView(buffer);\n    const response_code = view.getUint8(0);\n    const stats_type = view.getUint8(1);\n    if (response_code !== 24 || stats_type !== 1) {\n        throw new Error('Invalid response type');\n    }\n    return {\n        noise_floor: view.getInt16(2, true),\n        last_rssi: view.getInt8(4),\n        last_snr: view.getInt8(5) / 4.0,  // Unscale SNR\n        tx_air_secs: view.getUint32(6, true),\n        rx_air_secs: view.getUint32(10, true)\n    };\n}\n\nfunction parseStatsPackets(buffer: ArrayBuffer): StatsPackets {\n    const view = new DataView(buffer);\n    const response_code = view.getUint8(0);\n    const stats_type = view.getUint8(1);\n    if (response_code !== 24 || stats_type !== 2) {\n        throw new Error('Invalid response type');\n    }\n    return {\n        recv: view.getUint32(2, true),\n        sent: view.getUint32(6, true),\n        flood_tx: view.getUint32(10, true),\n        direct_tx: view.getUint32(14, true),\n        flood_rx: view.getUint32(18, true),\n        direct_rx: view.getUint32(22, true)\n    };\n}\n
    "},{"location":"stats_binary_frames/#field-size-considerations","title":"Field Size Considerations","text":""},{"location":"terminal_chat_cli/","title":"Terminal Chat CLI","text":"

    Below are the commands you can enter into the Terminal Chat clients:

    set freq {frequency}\n

    Set the LoRa frequency. Example: set freq 915.8

    set tx {tx-power-dbm}\n

    Sets LoRa transmit power in dBm.

    set name {name}\n

    Sets your advertisement name.

    set lat {latitude}\n

    Sets your advertisement map latitude. (decimal degrees)

    set lon {longitude}\n

    Sets your advertisement map longitude. (decimal degrees)

    set af {air-time-factor}\n

    Sets the transmit air-time-factor.

    time {epoch-secs}\n

    Set the device clock using UNIX epoch seconds. Example: time 1738242833

    advert\n

    Sends an advertisement packet

    clock\n

    Displays current time per device's clock.

    ver\n

    Shows the device version and firmware build date.

    card\n

    Displays your 'business card', for other to manually import

    import {card}\n

    Imports the given card to your contacts.

    list {n}\n

    List all contacts by most recent. (optional {n}, is the last n by advertisement date)

    to\n

    Shows the name of current recipient contact. (for subsequent 'send' commands)

    to {name-prefix}\n

    Sets the recipient to the first matching contact (in 'list') by the name prefix. (ie. you don't have to type whole name)

    send {text}\n

    Sends the text message (as DM) to current recipient.

    reset path\n

    Resets the path to current recipient, for new path discovery.

    public {text}\n

    Sends the text message to the built-in 'public' group channel

    "}]} \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index a908d6a2..df489662 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -2,46 +2,46 @@ https://meshcore-dev.github.io/meshcore/ - 2026-02-12 + 2026-02-15 https://meshcore-dev.github.io/meshcore/cli_commands/ - 2026-02-12 + 2026-02-15 https://meshcore-dev.github.io/meshcore/companion_protocol/ - 2026-02-12 + 2026-02-15 https://meshcore-dev.github.io/meshcore/docs/ - 2026-02-12 + 2026-02-15 https://meshcore-dev.github.io/meshcore/faq/ - 2026-02-12 + 2026-02-15 https://meshcore-dev.github.io/meshcore/nrf52_power_management/ - 2026-02-12 + 2026-02-15 https://meshcore-dev.github.io/meshcore/packet_format/ - 2026-02-12 + 2026-02-15 https://meshcore-dev.github.io/meshcore/payloads/ - 2026-02-12 + 2026-02-15 https://meshcore-dev.github.io/meshcore/qr_codes/ - 2026-02-12 + 2026-02-15 https://meshcore-dev.github.io/meshcore/stats_binary_frames/ - 2026-02-12 + 2026-02-15 https://meshcore-dev.github.io/meshcore/terminal_chat_cli/ - 2026-02-12 + 2026-02-15 \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz index 56b68630..f8793dfd 100644 Binary files a/sitemap.xml.gz and b/sitemap.xml.gz differ