meshtastic/README.md

# Meshtastic Utilities

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)

![](.screens/htpdeck.png)

## Documentation
- [Firmware Hacks & Customization](./FIRMWARE.md)
- [Setup Hardware](./SETUP.md)

## Bugs & Issues
- Devices 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...
- Devices using a custom MQTT with TLS & auth will cause a reboot loop *(Need to fix this ASAP)*
- A fix for the reboot loop is simply disabling MQTT over serial with `meshtastic --set mqtt.enabled false`
- `event_node` event is called **AS** we are defining the interface, so using `self.interface` in that callback will error.

## Roadmap
- Asyncronous meshtastic interface
- MQTT interface with working decryption
- Documentation on MQTT bridging for high availability
- 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
IRC skeleton improved and stripped down, meshtastic serial interfacing mostly complete 2024-04-28 20:34:24 +00:00			`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 a preview picture of my T-deck 2024-04-30 00:07:44 +00:00			`![](.screens/htpdeck.png)`

Added documentation on firmware hacking & hardware provisioning, started working on the MQTT interface 2024-04-30 00:03:38 +00:00			`## Documentation`
			`- [Firmware Hacks & Customization](./FIRMWARE.md)`
			`- [Setup Hardware](./SETUP.md)`

			`## Bugs & Issues`
Added hardware info for newfags, added custom gta fish boot logo, documented more issues 2024-05-05 18:39:51 +00:00			`- Devices 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...`
			`- Devices using a custom MQTT with TLS & auth will cause a reboot loop (Need to fix this ASAP)`
			- A fix for the reboot loop is simply disabling MQTT over serial with `meshtastic --set mqtt.enabled false`
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`
Added documentation on firmware hacking & hardware provisioning, started working on the MQTT interface 2024-04-30 00:03:38 +00:00			`- Asyncronous meshtastic interface`
IRC skeleton improved and stripped down, meshtastic serial interfacing mostly complete 2024-04-28 20:34:24 +00:00			`- MQTT interface with working decryption`
			`- Documentation on MQTT bridging for high availability`
			- 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)`