meshtastic/website/docs/developers/device/port-numbers.md

21 lines
1.1 KiB
Markdown
Raw Normal View History

2021-04-25 14:50:52 -07:00
---
2021-04-25 15:21:15 -07:00
id: portnum
2021-04-25 14:50:52 -07:00
title: Meshtastic port numbers
sidebar_label: Port numbers
---
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:
2021-04-27 10:34:56 -07:00
* 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 do not want to register publically
2021-04-25 14:50:52 -07:00
All other values are reserved.
Note: This was formerly a Type enum named `typ` with the same id #
2021-04-27 10:34:56 -07:00
We have changed 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.
2021-04-25 14:50:52 -07:00
2021-04-27 10:34:56 -07:00
The current list of port numbers can be found listed in the [protobufs](/docs/developers/protobufs/api#portnumsproto)