meshtastic/docs/development/firmware/port-numbers.mdx

26 lines
1.3 KiB
Plaintext
Raw Normal View History

2021-04-25 14:50:52 -07:00
---
2021-04-25 15:21:15 -07:00
id: portnum
2022-11-03 17:10:08 -07:00
title: Meshtastic Port Numbers
sidebar_label: Port Numbers
2021-04-25 14:50:52 -07:00
---
2022-11-07 20:53:52 -08:00
Any new app that runs on the device or via sister apps on phones/PCs should pick and use a unique "portnum" for their applications use.
2021-04-25 14:50:52 -07:00
2023-01-13 20:30:18 -08:00
The current list of port numbers can be found listed in the [protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.CriticalErrorCode)
2022-11-07 20:53:52 -08:00
## Assignment
PortNums should be assigned by the following ranges:
2021-04-25 14:50:52 -07:00
2022-03-08 23:51:46 -08:00
| Portnum | Usage |
2023-01-13 20:30:18 -08:00
| :-----: | :--------------------------------------------------------------------------------------------------------------------- |
| 0-63 | Core Meshtastic use, do not use for third party apps. |
2022-03-08 23:51:46 -08:00
| 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 publicly |
2021-04-25 14:50:52 -07:00
All other values are reserved.
2022-11-07 20:53:52 -08:00
## Integration
2021-04-25 14:50:52 -07:00
2023-01-13 20:30:18 -08:00
If you are making a new app using Meshtastic, please send a pull request to add your chosen "portnum" to this master table.