meshaddicts/meshinfo

Realtime web UI to run against a Meshtastic regional or private mesh network.

meshinfo's Issues

Support emojis in names

Somehow emojis are just translating to an empty unicode char

Feature: Add protobuf decoding

We currently have JSON based decoding from MQTT, but we should add support for handling protobuf messages as well.

Refactor main.py

The main.py has bloated significantly, which was expected since this first started as an exploration but as become a real project since. We need to refactor it so that things are more modular and potentially testable.

Add customization of Caddyfile and docker-compose to Setup in README

Enhancement: Add missing metrics

For example see https://github.com/meshtastic/firmware/pull/4331/files#diff-9e0b139e1608f3cb528b6290c117286feb6102f2051567d2ffa8f0670c3ab107R72-R78

Create documentation

I've started this, but we need to refine it.

Move Caddyfile to Caddyfile.sample

Need to make this more friendly for users.

• move Caddyfile to Caddyfile.sample
• add Caddyfile to .gitignore
• update README.md with cp Caddyfile.sample Caddyfile and instructions to edit during setup steps

Extend map to full height on Map page

On the map page, it currently does not extend to the full height of the browser, nor does it resize.

Support main loop and API at same time

Add Traceroutes

Enhancement: Map node details needs links to neighbor nodes

Neighbor nodes on the node detail popup on the map need to link to the node detail pages.

Map: Add neighbor lines

Wrong link in bot response

Links in responses of Mesh Bot directs to https://svm1.meshinfo.network/ instead of source / intended network.

Add MapBox option

Add the option to use MapBox. This might be challenging to maintain two map implementations, but the value is that the host can benefit from more premium map features if willing to pay for MapBox (though the free tier offers a ton of value, especially for small sites, which these Meshtastic mesh sites should be).

@daviesgeek I will coordinate with you when this becomes a need in the React app (and can help a lot).

Enhancement: Convert config.json to YAML or INI format

We want to be able to comment in configurations, but you can't with JSON. This configuration format is convenient, but not user friendly.

Meshinfo stops working after sending command to BBS

if node and chat['text'].contains('TC2 BBS') and chat['text'].contains('Available commands')

Log attached:

20240718-1945.txt

Move config into json or yaml

Right now config is defined in config.py as a dict, but realistically this is not ideal.

We probably need something that combines a standard JSON/YAML plus some additional dynamic massaging.

Configuration - Mesh Name and Description

Feature: Backups

Initial capability to backup data.

1. On some (configurable in config.json) interval, backup all the JSON data (eventually include DB(s))
2. Optionally allow for backing up of the statically rendered HTML too

Feature: Nets

This is probably more along the lines of a BBS, but the ability to send out a message to which people must DM a check-in would be great for building a network map

Add consistent images for each hardware type

Some of the pages will use the hardware info of the nodes in order to display an image of the hardware. Preferably these should all go in public/images/hardware and be named based on their corresponding hardware integer ID (defined at https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.HardwareModel), thus a Heltec V3 is 43.png.

The images should have the following requirements:

• consistent sizing
• named NUM.png
• put in public/images/hardware/
• consistent in style as much as possible (though I recognize this is not perfect)
• alpha for the background if possible, otherwise white

Feature: Dynamic Mesh Name Styling

This is "neat"

but it doesn't work well for anyone running their own instance.

We need to dynamically style this based on the Mesh Name defined in the config.json.

Map: Add more node details to popup

Specifically add neighbors (both heard and heard by).

Move save() to async

Right now the save() functionality (which persists to JSON files and/or renders HTML files) is blocking and will interrupt the MQTT queue/stream, and also will block API requests. We need to make this an async operation.

We will likely need to make not only the method call async, but also do a .copy() on the objects so that other operations do not modify the contents of the references while it iterates.

MQTT client id to be semi-dynamic

Current default client_id is meshinfo, which is totally fine if only a single client with this ID will connect to a MQTT server. If it collides with another, it disconnects that client. Therefore, we should make client_id in the Config be renamed to client_id_prefix and then have it generate a dynamic (or saved) suffix, perhaps a UUID (one with the timestamp decodable perhaps).

Feature: Add Redis for caching

We will want a redis component to cache some fragments and/or even pages to improve general performance, eventually. The API and the main loop would make the most use of this, but the bot might as well.

Meshinfo stops runnig

From time to time, without any (for me) apparent reason, meshinfo crashes.

There appear to be several errors. The log file is attached.

meshinfo-1 ERROR Exceptio.txt

Feature: Additional Encrypted Channels

Nodes that exclusively use encrypted channels and therefore only send encrypted messages will not be included in the database.

Unicode support

Hey, this is cool, thanks.

I have the desire for unicode but the arduino json currently does not support it. I was going a different path with a preprocessing solution of sorts.

Anyway i quickly knocked this up from what I've found and thought I'd share.

https://gist.github.com/quimnut/c5ae707c627ed5434b300f6e8a40ccf7

App Icons

We need to create some kind of an app icon for MeshInfo. And then we need to put it in place for:

• public/favicon.ico
• public/apple-touch-icon.png
• public/apple-touch-icon-precomposed.png

Totally fine to put something quick and random as a temporary stopgap.

Add first pass of tests

We need some tests, it's only right for us to do this when there's more than 1 dev. First dev to implement some tests gets 3 cookies.

Handle invalid relative humidity

I have some values like -4.47034800288293e-08% for relative humidity will make round(2) fail in the template.

Feature: Add SQLite support

Feature: Add PostgreSQL support

Add additional information for nodes

Something like this would be super nice to get more information out there about each node.

Map: Add deeplinks to armoo's mesh view in node popups

Feature: Initial API endpoints

Now that we are looking to start moving to the SPA using React, we want to expose the data via an API. This API could also be used by the community of users that a MeshInfo is serving, perhaps to help power other projects.

Initial batch of endpoints considered are:

• /v1/nodes - Paginated array of all known nodes (or with some params, a filtered array of nodes)
• /v1/nodes/:id - Gets a node info (intelligently between hex and int ids)
• /v1/nodes/:id/texts
• /v1/nodes/:id/telemetry
• /v1/nodes/:id/traceroutes
• /v1/server/config - The server's configuration (useful for showing server details on UI)
• /v1/telemetry - Paginated array of telemetry (filterable)
• /v1/traceroutes - Paginated array of traceroutes (filterable)