Recommendation Updates and Adding Bridger #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Author
|
As far as I am concerned, this should be good for Bridger. Still seeing if @andyshinn has any final feedback. If we are happy with it, we can merge this PR and I can start a new one for the recommended settings changes, or we can keep this going and merge all at once. |
tekstrand
requested changes
Mar 9, 2025
Contributor
tekstrand
left a comment
tekstrand
left a comment
There was a problem hiding this comment.
Looking good! Just a few little changes, and one big reformat away from using dl. Let me know if you need any help figuring that out.
| <h2>Network Observability</h2> | ||
| <p><a href="https://github.com/austinmesh/bridger">Bridger</a> powers the backend of our network statistics dashboard. The project is maintained by the Austin Mesh community and written in Python. With Bridger, we can ingest MQTT packets from contributing gateways, parse the packets into <a href="https://github.com/influxdata/influxdb" >InfluxDB</a>, and represent the network statistics with <a href="https://grafana.com/">Grafana</a>.</p> | ||
| <dl> | ||
| <dt>How to view the Austin Mesh network statistics dashboard?</dt> |
Contributor
There was a problem hiding this comment.
Suggested change
| <dt>How to view the Austin Mesh network statistics dashboard?</dt> | |
| <dt>How do I view the network statistics dashboard?</dt> |
| <p><a href="https://github.com/austinmesh/bridger">Bridger</a> powers the backend of our network statistics dashboard. The project is maintained by the Austin Mesh community and written in Python. With Bridger, we can ingest MQTT packets from contributing gateways, parse the packets into <a href="https://github.com/influxdata/influxdb" >InfluxDB</a>, and represent the network statistics with <a href="https://grafana.com/">Grafana</a>.</p> | ||
| <dl> | ||
| <dt>How to view the Austin Mesh network statistics dashboard?</dt> | ||
| <dd>Our network statistics dashboard can be viewed by visiting <a href="https://graphs.austinmesh.org">graphs.austinmesh.org</a>. Feel free to explore the data and see the coverage, device metrics, node information, and more.</dd> |
Contributor
There was a problem hiding this comment.
Suggested change
| <dd>Our network statistics dashboard can be viewed by visiting <a href="https://graphs.austinmesh.org">graphs.austinmesh.org</a>. Feel free to explore the data and see the coverage, device metrics, node information, and more.</dd> | |
| <dd>Our network statistics dashboard can be viewed by visiting <a href="https://graphs.austinmesh.org" target="_blank">graphs.austinmesh.org</a>. There, you can explore the data to see geographical coverage, device metrics, node information, and more.</dd> |
| <dt>How to view the Austin Mesh network statistics dashboard?</dt> | ||
| <dd>Our network statistics dashboard can be viewed by visiting <a href="https://graphs.austinmesh.org">graphs.austinmesh.org</a>. Feel free to explore the data and see the coverage, device metrics, node information, and more.</dd> | ||
| <dt>Why is my node not listed?</dt> | ||
| <dd>Newer versions of the Meshtastic firmware have a setting called "Okay to MQTT" under the LoRa settings. This is a polite request to a device running the official firmware on whether or not packets from your node can be forwarded to MQTT brokers by other nodes. Please ensure that this is enabled to have your node reported on the network statistics dashboard. Please see the <a href="/join/#best-practices">best practices</a> page for more information on our recommended configuration for nodes.</dd> |
Contributor
There was a problem hiding this comment.
There are other reasons as well. They might not be on the network, or they might not be in sight of a gateway due to straight visibility or number of hops.
Unfortunately I think this change is going to require reformatting the html for this whole section away from using a datalist(dl) to instead using headings. My recommendation would be to change each dt to and h3 and then we can easily have an unordered list(ul) with a list of all of the various possible reasons. Something like
<h3>Why is my node not listed?</h3>
<p>There are a few reasons your node might node be visible on Bridger. Be sure to check our <a href="/join/#best-practices">best practices</a> and hop into our <a href="https://discord.gg/6a5Sv2s9bG" target="blank">Discord server</a> for more support.</p>
<ul>
<li>You're not connected to the AustinMesh network. Just because you can see other nodes doesn't mean they can see you!</li>
<li>Okay to MQTT is disabled. Bridger uses the internet and MQTT to track data so this setting must be configured in your node's settings.</li>
<li>You're not connected to a Gateway node. Only certain nodes uplink data to bridger, see more in <a href="#contributing-to-bridger">contributing to bridger below</a>.</li>
</ul>| <dt>Why is my node not listed?</dt> | ||
| <dd>Newer versions of the Meshtastic firmware have a setting called "Okay to MQTT" under the LoRa settings. This is a polite request to a device running the official firmware on whether or not packets from your node can be forwarded to MQTT brokers by other nodes. Please ensure that this is enabled to have your node reported on the network statistics dashboard. Please see the <a href="/join/#best-practices">best practices</a> page for more information on our recommended configuration for nodes.</dd> | ||
| <dt>How can I contribute data to Bridger?</dt> | ||
| <dd>To contribute data to Bridger, you will need a node that can connect to the MQTT server through the internet, like a Heltec V3. Ideally, contributing nodes should be connected 24/7. Your node will need credentials, which can be requested on the Austin Mesh discord by running the <b>/bridger-mqtt-request-account</b> command and supplying your 8-digit node ID. Be sure to store your username and password in a safe place. Once you have your credentials, open the MQTT settings and configure it as follows:<br><br> |
Contributor
There was a problem hiding this comment.
Suggested change
| <dd>To contribute data to Bridger, you will need a node that can connect to the MQTT server through the internet, like a Heltec V3. Ideally, contributing nodes should be connected 24/7. Your node will need credentials, which can be requested on the Austin Mesh discord by running the <b>/bridger-mqtt-request-account</b> command and supplying your 8-digit node ID. Be sure to store your username and password in a safe place. Once you have your credentials, open the MQTT settings and configure it as follows:<br><br> | |
| <dd>To contribute data to Bridger, you will need a node that can connect to the MQTT server through the internet either directly(ESP32) or through a connected client with MQTT>Proxy to Client enabled. Ideally, contributing nodes should be connected 24/7. Your node will need credentials, which can be requested on the Austin Mesh discord by running the <b>/bridger-mqtt-request-account</b> command and supplying your 8-digit node ID. Be sure to store your username and password in a safe place. Once you have your credentials, open the MQTT settings and configure it according to the table below. |
Contributor
There was a problem hiding this comment.
The following table is going to be another reason to not use the dl element and instead use headings. Tables can't go inside a dd element, actually no other html elements can, except for div.
| <tr><td>Encryption enabled</td><td>Disabled</td></tr> | ||
| <tr><td>JSON output enabled</td><td>Disabled</td></tr> | ||
| <tr><td>Root topic</td><td>egr/home</td></tr> | ||
| </table><br> |
Contributor
There was a problem hiding this comment.
Suggested change
| </table><br> | |
| </table> |
Collaborator
|
It seems good to me after the other requested changes. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Here is a PR for the changes we are working on.
Don't merge until finalized.