MeshCore icon

MeshCore

Interact with a MeshCore device over TCP/WiFi

Utility → Encode Advert

AI-generated

Summary

Builds and signs a MeshCore advert packet for the identity represented by the supplied private key. The packet announces the node name and type, optionally includes its location, and uses the selected route and path hash size.

Inputs

  • Private Key (required) — 64-byte identity private key in hex. The advert is signed with this key and announces its matching public key.
  • Advert Name (required) — Name included in the advert; required for the firmware to retain it.
  • Node Type — Advertised role: Chat (Companion), Repeater, Room Server, or Sensor. Defaults to Chat (Companion).
  • Include Location — Whether to include latitude and longitude. Defaults to false.
  • Latitude and Longitude — Coordinates included when Include Location is enabled; each defaults to 0.
  • Timestamp — Unix timestamp in seconds; 0 uses the current time. For adverts, receivers that already know the key ignore timestamps that are not newer than the last stored advert.
  • Route Type — Advert route: Flood, Direct, Transport Flood, or Transport Direct. Defaults to Flood.
  • Path Hash Size — Bytes per hop in the packed path-length byte. Must match the mesh setting; defaults to 1 byte per hop.

Output shape

A single encoded advert packet result.

The operation constructs and signs the packet; it does not send the advert over the mesh. The supplied source view omits function bodies, so the exact returned field names and any payload encoding details are not shown.

Links

Discussion