acidvegas/meshtastic-mqtt-json
acidvegas/meshtastic-mqtt-json
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Updated README

Browse Source
This commit is contained in:
Dionysus 2024-11-29 21:08:40 -05:00
parent 453421a0d0
commit 94c6c16aef
Signed by: acidvegas
GPG Key ID: EF4B922DB85DC9DE
2 changed files with 56 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
LICENSE Normal file
View File

@ -0,0 +1,15 @@
ISC License
Copyright (c) 2024, acidvegas <acid.vegas@acid.vegas>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

76
README.md
View File

@ -27,15 +27,16 @@ python meshtastic_mqtt.py [options]
### Command Line Options ### Command Line Options
| Option | Description |
- `--broker`: MQTT broker address (default: mqtt.meshtastic.org) | ------------ | ---------------------------------------------------- |
- `--port`: MQTT broker port (default: 1883) | `--broker` | MQTT broker address *(default: mqtt.meshtastic.org)* |
- `--root`: Root topic (default: msh/US/2/e/) | `--port` | MQTT broker port *(default: 1883)* |
- `--channel`: Channel name (default: LongFast) | `--root` | Root topic *(default: msh/US/2/e/)* |
- `--username`: MQTT username (default: meshdev) | `--channel` | Channel name *(default: LongFast)* |
- `--password`: MQTT password (default: large4cats) | `--username` | MQTT username *(default: meshdev)* |
- `--key`: Encryption key (default: AQ==) | `--password` | MQTT password *(default: large4cats)* |
- `--filter`: Filter specific message types (comma-separated) | `--key` | Encryption key *(default: AQ==)* |
| `--filter` | Filter specific message types *(comma-separated)* |
### Filter Example ### Filter Example
```bash ```bash
@ -46,31 +47,32 @@ python meshtastic_mqtt.py --filter "NODEINFO,POSITION,TEXT_MESSAGE"
## Supported Message Types ## Supported Message Types
The library supports parsing of the following Meshtastic message types: The library supports parsing of the following Meshtastic message types:
| Message Type | Description |
1. **ADMIN_APP**: Administrative messages | ------------------------------- | ----------------------------- |
2. **ATAK_FORWARDER**: ATAK forwarding messages | **ADMIN_APP** | Administrative messages |
3. **ATAK_PLUGIN**: ATAK plugin messages | **ATAK_FORWARDER** | ATAK forwarding messages |
4. **AUDIO_APP**: Audio messages | **ATAK_PLUGIN** | ATAK plugin messages |
5. **DETECTION_SENSOR_APP**: Sensor detection data | **AUDIO_APP** | Audio messages |
6. **IP_TUNNEL_APP**: IP tunneling messages | **DETECTION_SENSOR_APP** | Sensor detection data |
7. **NEIGHBORINFO_APP**: Neighbor information | **IP_TUNNEL_APP** | IP tunneling messages |
8. **NODEINFO_APP**: Node information and details | **NEIGHBORINFO_APP** | Neighbor information |
9. **PAXCOUNTER_APP**: People counter data | **NODEINFO_APP** | Node information and details |
10. **POSITION_APP**: GPS position updates | **PAXCOUNTER_APP** | People counter data |
11. **PRIVATE_APP**: Private messages | **POSITION_APP** | GPS position updates |
12. **RANGE_TEST_APP**: Range testing data | **PRIVATE_APP** | Private messages |
13. **REMOTE_HARDWARE_APP**: Remote hardware control | **RANGE_TEST_APP** | Range testing data |
14. **REPLY_APP**: Reply messages | **REMOTE_HARDWARE_APP** | Remote hardware control |
15. **ROUTING_APP**: Routing information | **REPLY_APP** | Reply messages |
16. **SERIAL_APP**: Serial communication | **ROUTING_APP** | Routing information |
17. **SIMULATOR_APP**: Simulator messages | **SERIAL_APP** | Serial communication |
18. **STORE_FORWARD_APP**: Store and forward messages | **SIMULATOR_APP** | Simulator messages |
19. **TELEMETRY_APP**: Device telemetry data | **STORE_FORWARD_APP** | Store and forward messages |
20. **TEXT_MESSAGE_APP**: Plain text messages | **TELEMETRY_APP** | Device telemetry data |
21. **TEXT_MESSAGE_COMPRESSED_APP**: Compressed text messages | **TEXT_MESSAGE_APP** | Plain text messages |
22. **TRACEROUTE_APP**: Network route tracing | **TEXT_MESSAGE_COMPRESSED_APP** | Compressed text messages |
23. **WAYPOINT_APP**: Waypoint information | **TRACEROUTE_APP** | Network route tracing |
24. **ZPS_APP**: Zone/Position System messages | **WAYPOINT_APP** | Waypoint information |
| **ZPS_APP** | Zone/Position System messages |
## Building Applications ## Building Applications
@ -82,4 +84,8 @@ This library serves as a foundation for building more complex Meshtastic applica
- Network monitoring tools - Network monitoring tools
- Chat applications - Chat applications
- Telemetry data collection - Telemetry data collection
- Mesh network analysis tools - Mesh network analysis tools
___
###### Mirrors for this repository: [acid.vegas](https://git.acid.vegas/meshtastic_mqtt) • [SuperNETs](https://git.supernets.org/acidvegas/meshtastic_mqtt) • [GitHub](https://github.com/acidvegas/meshtastic_mqtt) • [GitLab](https://gitlab.com/acidvegas/meshtastic_mqtt) • [Codeberg](https://codeberg.org/acidvegas/meshtastic_mqtt)