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

27 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
Squashed commit of the following: commit 86bc3c93e5fac8dfb5eb023f1aa6d405bb9d9ffe Merge: 6cabd5fe cfec3e8e Author: rcarteraz <robert.l.carter2@gmail.com> Date: Wed Jun 19 18:48:14 2024 -0700 Merge pull request #1301 from rcarteraz/1200bps-reset-button Add mention of 1200bps reset button in web flasher commit cfec3e8eace1719736a5a6cd4f0093385f0bdad8 Merge: 59d71321 6cabd5fe Author: rcarteraz <robert.l.carter2@gmail.com> Date: Wed Jun 19 17:59:09 2024 -0700 Merge branch 'master' into 1200bps-reset-button commit 6cabd5fe955461798f90dc7cebd98928c5d6578e Merge: f6a97b28 6c40c2e5 Author: rcarteraz <robert.l.carter2@gmail.com> Date: Wed Jun 19 17:58:54 2024 -0700 Merge pull request #1295 from geeksville/pr-nrf52-guide Add basic nrf52 guide commit 6c40c2e5558b7270646319a91123843c8671edbc Merge: 9cbea09e f6a97b28 Author: rcarteraz <robert.l.carter2@gmail.com> Date: Wed Jun 19 17:56:57 2024 -0700 Merge branch 'master' into pr-nrf52-guide commit 59d71321e380836c75d5b32401e2a8647933dd43 Author: rcarteraz <robert.l.carter2@gmail.com> Date: Wed Jun 19 17:52:06 2024 -0700 Add mention of 1200bps reset button in web flasher commit 9cbea09e5cb459853f9bcee2b8b206c19966d1f5 Author: rcarteraz <robert.l.carter2@gmail.com> Date: Tue Jun 18 13:53:25 2024 -0700 formatting and minor changes commit fad3a940d142558d7cc9dd59553af0b83d8c5d7c Merge: f3523b72 f95a398c Author: rcarteraz <robert.l.carter2@gmail.com> Date: Tue Jun 18 13:01:01 2024 -0700 Merge branch 'master' into pr-nrf52-guide commit f3523b72f5c24b338cc20acc2ba73b74dd73babb Merge: b2fcaa55 70638582 Author: geeksville <kevinh@geeksville.com> Date: Sun Jun 16 21:11:52 2024 -0700 Merge branch 'master' into pr-nrf52-guide commit b2fcaa55300ad339bf8994f1c89c52cb1aedfc1a Author: geeksville <kevinh@geeksville.com> Date: Sun Jun 16 15:16:37 2024 -0700 Add basic nrf52 guide
2024-06-19 18:50:33 -07:00
sidebar_position: 4
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-08-28 21:06:55 -07:00
The current list of port numbers can be found listed in the [protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.PortNum)
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.