For any new 'apps' that run on the device or via sister apps on phones/PCs they should pick and use a unique 'portnum' for their application. If you are making a new app using meshtastic, please send in a pull request to add your 'portnum' to this master table. PortNums should be assigned in the following range: 0-63 Core Meshtastic use, do not use for third party apps 64-127 Registered 3rd party apps, send in a pull request that adds a new entry to portnums.proto to register your application 256-511 Use one of these portnums for your private applications that you don't want to register publically All other values are reserved. Note: This was formerly a Type enum named 'typ' with the same id # We have change to this 'portnum' based scheme for specifying app handlers for particular payloads. This change is backwards compatible by treating the legacy OPAQUE/CLEAR_TEXT values identically.

Generated

from enum meshtastic.PortNum

Enumeration Members

ADMIN_APP: 6

Admin control packets. Payload is a AdminMessage message ENCODING: Protobuf

Generated

from enum value: ADMIN_APP = 6;

ATAK_FORWARDER: 257

ATAK Forwarder Module https://github.com/paulmandal/atak-forwarder ENCODING: libcotshrink

Generated

from enum value: ATAK_FORWARDER = 257;

ATAK_PLUGIN: 72

ATAK Plugin Portnum for payloads from the official Meshtastic ATAK plugin

Generated

from enum value: ATAK_PLUGIN = 72;

AUDIO_APP: 9

Audio Payloads. Encapsulated codec2 packets. On 2.4 GHZ Bandwidths only for now ENCODING: codec2 audio frames NOTE: audio frames contain a 3 byte header (0xc0 0xde 0xc2) and a one byte marker for the decompressed bitrate. This marker comes from the 'moduleConfig.audio.bitrate' enum minus one.

Generated

from enum value: AUDIO_APP = 9;

DETECTION_SENSOR_APP: 10

Same as Text Message but originating from Detection Sensor Module. NOTE: This portnum traffic is not sent to the public MQTT starting at firmware version 2.2.9

Generated

from enum value: DETECTION_SENSOR_APP = 10;

IP_TUNNEL_APP: 33

Used for the python IP tunnel feature ENCODING: IP Packet. Handled by the python API, firmware ignores this one and pases on.

Generated

from enum value: IP_TUNNEL_APP = 33;

MAX: 511

Currently we limit port nums to no higher than this value

Generated

from enum value: MAX = 511;

NEIGHBORINFO_APP: 71

Aggregates edge info for the network by sending out a list of each node's neighbors ENCODING: Protobuf

Generated

from enum value: NEIGHBORINFO_APP = 71;

NODEINFO_APP: 4

The built-in user info app. Payload is a User message ENCODING: Protobuf

Generated

from enum value: NODEINFO_APP = 4;

PAXCOUNTER_APP: 34

Paxcounter lib included in the firmware ENCODING: protobuf

Generated

from enum value: PAXCOUNTER_APP = 34;

POSITION_APP: 3

The built-in position messaging app. Payload is a Position message ENCODING: Protobuf

Generated

from enum value: POSITION_APP = 3;

PRIVATE_APP: 256

Private applications should use portnums >= 256. To simplify initial development and testing you can use "PRIVATE_APP" in your code without needing to rebuild protobuf files (via regen-protos.sh)

Generated

from enum value: PRIVATE_APP = 256;

RANGE_TEST_APP: 66

Optional port for messages for the range test module. ENCODING: ASCII Plaintext NOTE: This portnum traffic is not sent to the public MQTT starting at firmware version 2.2.9

Generated

from enum value: RANGE_TEST_APP = 66;

REMOTE_HARDWARE_APP: 2

Reserved for built-in GPIO/example app. See remote_hardware.proto/HardwareMessage for details on the message sent/received to this port number ENCODING: Protobuf

Generated

from enum value: REMOTE_HARDWARE_APP = 2;

REPLY_APP: 32

Provides a 'ping' service that replies to any packet it receives. Also serves as a small example module. ENCODING: ASCII Plaintext

Generated

from enum value: REPLY_APP = 32;

ROUTING_APP: 5

Protocol control packets for mesh protocol use. Payload is a Routing message ENCODING: Protobuf

Generated

from enum value: ROUTING_APP = 5;

SERIAL_APP: 64

Provides a hardware serial interface to send and receive from the Meshtastic network. Connect to the RX/TX pins of a device with 38400 8N1. Packets received from the Meshtastic network is forwarded to the RX pin while sending a packet to TX will go out to the Mesh network. Maximum packet size of 240 bytes. Module is disabled by default can be turned on by setting SERIAL_MODULE_ENABLED = 1 in SerialPlugh.cpp. ENCODING: binary undefined

Generated

from enum value: SERIAL_APP = 64;

SIMULATOR_APP: 69

Used to let multiple instances of Linux native applications communicate as if they did using their LoRa chip. Maintained by GitHub user GUVWAF. Project files at https://github.com/GUVWAF/Meshtasticator ENCODING: Protobuf (?)

Generated

from enum value: SIMULATOR_APP = 69;

STORE_FORWARD_APP: 65

STORE_FORWARD_APP (Work in Progress) Maintained by Jm Casler (MC Hamster) : jm@casler.org ENCODING: Protobuf

Generated

from enum value: STORE_FORWARD_APP = 65;

TELEMETRY_APP: 67

Provides a format to send and receive telemetry data from the Meshtastic network. Maintained by Charles Crossan (crossan007) : crossan007@gmail.com ENCODING: Protobuf

Generated

from enum value: TELEMETRY_APP = 67;

TEXT_MESSAGE_APP: 1

A simple UTF-8 text message, which even the little micros in the mesh can understand and show on their screen eventually in some circumstances even signal might send messages in this form (see below) ENCODING: UTF-8 Plaintext (?)

Generated

from enum value: TEXT_MESSAGE_APP = 1;

TEXT_MESSAGE_COMPRESSED_APP: 7

Compressed TEXT_MESSAGE payloads. ENCODING: UTF-8 Plaintext (?) with Unishox2 Compression NOTE: The Device Firmware converts a TEXT_MESSAGE_APP to TEXT_MESSAGE_COMPRESSED_APP if the compressed payload is shorter. There's no need for app developers to do this themselves. Also the firmware will decompress any incoming TEXT_MESSAGE_COMPRESSED_APP payload and convert to TEXT_MESSAGE_APP.

Generated

from enum value: TEXT_MESSAGE_COMPRESSED_APP = 7;

TRACEROUTE_APP: 70

Provides a traceroute functionality to show the route a packet towards a certain destination would take on the mesh. ENCODING: Protobuf

Generated

from enum value: TRACEROUTE_APP = 70;

UNKNOWN_APP: 0

Deprecated: do not use in new code (formerly called OPAQUE) A message sent from a device outside of the mesh, in a form the mesh does not understand NOTE: This must be 0, because it is documented in IMeshService.aidl to be so ENCODING: binary undefined

Generated

from enum value: UNKNOWN_APP = 0;

WAYPOINT_APP: 8

Waypoint payloads. Payload is a Waypoint message ENCODING: Protobuf

Generated

from enum value: WAYPOINT_APP = 8;

ZPS_APP: 68

Experimental tools for estimating node position without a GPS Maintained by Github user a-f-G-U-C (a Meshtastic contributor) Project files at https://github.com/a-f-G-U-C/Meshtastic-ZPS ENCODING: arrays of int64 fields

Generated

from enum value: ZPS_APP = 68;

Generated using TypeDoc