meshtastic/README.md

# Meshtastic Utilities
> Experiments with Meshtastic, MQTT, Lora, & more....

## WORK-IN-PROGRESS

## Information
This repository serves as a collection of resources created in my journey to learn & utilize [LoRa](https://en.wikipedia.org/wiki/LoRa) based communications with [Meshtastic](https://meshtastic.org).

The goal here is to create simple & clean modules to interface with the hardware in a way that can be used to expand the possibilities of the devices capabilities.

The hardware I am experimenting with: [Lilygo T-Deck](https://www.lilygo.cc/products/t-deck), [Lilygo T-Beam](https://www.lilygo.cc/products/t-beam-v1-1-esp32-lora-module), [Heltec Lora 32 v3](https://heltec.org/project/wifi-lora-32-v3/), and [RAK Wireless 4631](https://store.rakwireless.com/products/wisblock-core-modules?variant=42440631419078)

## Notes to self & developers
- The node id formula is: f'!{hex(node_num)[2:]}'

## Hardware & Software related Issues
- T-Deck must have Wifi turned off when going mobile. Upon leaving my house with WiFi still enabled, the UI & connection was EXTREMELY laggy & poor. Couldn't even type well...
- T-Deck using a custom MQTT with TLS & auth will cause a reboot loop *(Need to fix this ASAP)*
- `event_node` event is called **AS** we are defining the interface, so using `self.interface` in that callback will error.

## Roadmap
- Asyncronous meshtastic interface *(Priority)*
- MQTT interface with working decryption
- Documentation on MQTT bridging for high availability
- Create a simple setup script to provision new devices over serial
- Bridge for IRC to allow channel messages to relay over Meshtastic & all Meshtastic events to relay into IRC. *(IRC to Meshtastic will require a command like `!mesh <message here>` to avoid overloading the traffic over LoRa)*

___

###### Mirrors for this repository: [acid.vegas](https://git.acid.vegas/meshtastic) • [SuperNETs](https://git.supernets.org/acidvegas/meshtastic) • [GitHub](https://github.com/acidvegas/meshtastic) • [GitLab](https://gitlab.com/acidvegas/meshtastic) • [Codeberg](https://codeberg.org/acidvegas/meshtastic)
Meshtastic events all handled mostly now and outputting to stdout, debugging and testing finished 2024-04-28 08:51:02 +00:00			`# Meshtastic Utilities`
Initial commit 2024-04-25 17:22:05 +00:00			`> Experiments with Meshtastic, MQTT, Lora, & more....`

			`## WORK-IN-PROGRESS`

IRC skeleton improved and stripped down, meshtastic serial interfacing mostly complete 2024-04-28 20:34:24 +00:00			`## Information`
			`This repository serves as a collection of resources created in my journey to learn & utilize [LoRa](https://en.wikipedia.org/wiki/LoRa) based communications with [Meshtastic](https://meshtastic.org).`
Updated README documentation and improved overall code-baae of the serial interfacing tool 2024-04-25 19:39:14 +00:00
IRC skeleton improved and stripped down, meshtastic serial interfacing mostly complete 2024-04-28 20:34:24 +00:00			`The goal here is to create simple & clean modules to interface with the hardware in a way that can be used to expand the possibilities of the devices capabilities.`
Updated README documentation and improved overall code-baae of the serial interfacing tool 2024-04-25 19:39:14 +00:00
IRC skeleton improved and stripped down, meshtastic serial interfacing mostly complete 2024-04-28 20:34:24 +00:00			`The hardware I am experimenting with: [Lilygo T-Deck](https://www.lilygo.cc/products/t-deck), [Lilygo T-Beam](https://www.lilygo.cc/products/t-beam-v1-1-esp32-lora-module), [Heltec Lora 32 v3](https://heltec.org/project/wifi-lora-32-v3/), and [RAK Wireless 4631](https://store.rakwireless.com/products/wisblock-core-modules?variant=42440631419078)`
Updated README documentation and improved overall code-baae of the serial interfacing tool 2024-04-25 19:39:14 +00:00
Added some firmware hacking documentation for customization, white-space cleanup, etc 2024-04-29 18:15:38 +00:00			`## Notes to self & developers`
			`- The node id formula is: f'!{hex(node_num)[2:]}'`
Updated README documentation and improved overall code-baae of the serial interfacing tool 2024-04-25 19:39:14 +00:00
IRC skeleton improved and stripped down, meshtastic serial interfacing mostly complete 2024-04-28 20:34:24 +00:00			`## Hardware & Software related Issues`
			`- T-Deck must have Wifi turned off when going mobile. Upon leaving my house with WiFi still enabled, the UI & connection was EXTREMELY laggy & poor. Couldn't even type well...`
Added notes and link to t-deck case 2024-04-27 08:20:27 +00:00			`- T-Deck using a custom MQTT with TLS & auth will cause a reboot loop (Need to fix this ASAP)`
IRC skeleton improved and stripped down, meshtastic serial interfacing mostly complete 2024-04-28 20:34:24 +00:00			- `event_node` event is called AS we are defining the interface, so using `self.interface` in that callback will error.

			`## Roadmap`
			`- Asyncronous meshtastic interface (Priority)`
			`- MQTT interface with working decryption`
			`- Documentation on MQTT bridging for high availability`
			`- Create a simple setup script to provision new devices over serial`
			- Bridge for IRC to allow channel messages to relay over Meshtastic & all Meshtastic events to relay into IRC. (IRC to Meshtastic will require a command like `!mesh <message here>` to avoid overloading the traffic over LoRa)
Added notes and link to t-deck case 2024-04-27 08:20:27 +00:00
Initial commit 2024-04-25 17:22:05 +00:00			`___`

			`###### Mirrors for this repository: [acid.vegas](https://git.acid.vegas/meshtastic) • [SuperNETs](https://git.supernets.org/acidvegas/meshtastic) • [GitHub](https://github.com/acidvegas/meshtastic) • [GitLab](https://gitlab.com/acidvegas/meshtastic) • [Codeberg](https://codeberg.org/acidvegas/meshtastic)`