From 94c6c16aef92d3b4f9a7edbed502d7f207cc426a Mon Sep 17 00:00:00 2001 From: acidvegas Date: Fri, 29 Nov 2024 21:08:40 -0500 Subject: [PATCH] Updated README --- LICENSE | 15 +++++++++++ README.md | 76 ++++++++++++++++++++++++++++++------------------------- 2 files changed, 56 insertions(+), 35 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..54ec6ab --- /dev/null +++ b/LICENSE @@ -0,0 +1,15 @@ +ISC License + +Copyright (c) 2024, acidvegas + +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. diff --git a/README.md b/README.md index 1f487a0..de3aa83 100644 --- a/README.md +++ b/README.md @@ -27,15 +27,16 @@ python meshtastic_mqtt.py [options] ### Command Line Options - -- `--broker`: MQTT broker address (default: mqtt.meshtastic.org) -- `--port`: MQTT broker port (default: 1883) -- `--root`: Root topic (default: msh/US/2/e/) -- `--channel`: Channel name (default: LongFast) -- `--username`: MQTT username (default: meshdev) -- `--password`: MQTT password (default: large4cats) -- `--key`: Encryption key (default: AQ==) -- `--filter`: Filter specific message types (comma-separated) +| Option | Description | +| ------------ | ---------------------------------------------------- | +| `--broker` | MQTT broker address *(default: mqtt.meshtastic.org)* | +| `--port` | MQTT broker port *(default: 1883)* | +| `--root` | Root topic *(default: msh/US/2/e/)* | +| `--channel` | Channel name *(default: LongFast)* | +| `--username` | MQTT username *(default: meshdev)* | +| `--password` | MQTT password *(default: large4cats)* | +| `--key` | Encryption key *(default: AQ==)* | +| `--filter` | Filter specific message types *(comma-separated)* | ### Filter Example ```bash @@ -46,31 +47,32 @@ python meshtastic_mqtt.py --filter "NODEINFO,POSITION,TEXT_MESSAGE" ## Supported Message Types The library supports parsing of the following Meshtastic message types: - -1. **ADMIN_APP**: Administrative messages -2. **ATAK_FORWARDER**: ATAK forwarding messages -3. **ATAK_PLUGIN**: ATAK plugin messages -4. **AUDIO_APP**: Audio messages -5. **DETECTION_SENSOR_APP**: Sensor detection data -6. **IP_TUNNEL_APP**: IP tunneling messages -7. **NEIGHBORINFO_APP**: Neighbor information -8. **NODEINFO_APP**: Node information and details -9. **PAXCOUNTER_APP**: People counter data -10. **POSITION_APP**: GPS position updates -11. **PRIVATE_APP**: Private messages -12. **RANGE_TEST_APP**: Range testing data -13. **REMOTE_HARDWARE_APP**: Remote hardware control -14. **REPLY_APP**: Reply messages -15. **ROUTING_APP**: Routing information -16. **SERIAL_APP**: Serial communication -17. **SIMULATOR_APP**: Simulator messages -18. **STORE_FORWARD_APP**: Store and forward messages -19. **TELEMETRY_APP**: Device telemetry data -20. **TEXT_MESSAGE_APP**: Plain text messages -21. **TEXT_MESSAGE_COMPRESSED_APP**: Compressed text messages -22. **TRACEROUTE_APP**: Network route tracing -23. **WAYPOINT_APP**: Waypoint information -24. **ZPS_APP**: Zone/Position System messages +| Message Type | Description | +| ------------------------------- | ----------------------------- | +| **ADMIN_APP** | Administrative messages | +| **ATAK_FORWARDER** | ATAK forwarding messages | +| **ATAK_PLUGIN** | ATAK plugin messages | +| **AUDIO_APP** | Audio messages | +| **DETECTION_SENSOR_APP** | Sensor detection data | +| **IP_TUNNEL_APP** | IP tunneling messages | +| **NEIGHBORINFO_APP** | Neighbor information | +| **NODEINFO_APP** | Node information and details | +| **PAXCOUNTER_APP** | People counter data | +| **POSITION_APP** | GPS position updates | +| **PRIVATE_APP** | Private messages | +| **RANGE_TEST_APP** | Range testing data | +| **REMOTE_HARDWARE_APP** | Remote hardware control | +| **REPLY_APP** | Reply messages | +| **ROUTING_APP** | Routing information | +| **SERIAL_APP** | Serial communication | +| **SIMULATOR_APP** | Simulator messages | +| **STORE_FORWARD_APP** | Store and forward messages | +| **TELEMETRY_APP** | Device telemetry data | +| **TEXT_MESSAGE_APP** | Plain text messages | +| **TEXT_MESSAGE_COMPRESSED_APP** | Compressed text messages | +| **TRACEROUTE_APP** | Network route tracing | +| **WAYPOINT_APP** | Waypoint information | +| **ZPS_APP** | Zone/Position System messages | ## Building Applications @@ -82,4 +84,8 @@ This library serves as a foundation for building more complex Meshtastic applica - Network monitoring tools - Chat applications - Telemetry data collection -- Mesh network analysis tools \ No newline at end of file +- 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)