diff --git a/docs/community/software/index.mdx b/docs/community/software/index.mdx index 39e3fd0e..571e7a68 100644 --- a/docs/community/software/index.mdx +++ b/docs/community/software/index.mdx @@ -14,5 +14,7 @@ Current community projects: - [Node-RED Messages Node](/docs/community/software/community-node-red-messages) - Node-RED node to send and receive packets / text messages from a device connected via HTTP. - [MQTT Connect for Meshtastic](https://github.com/pdxlocations/MQTT-Connect-for-Meshtastic) - A nodeless python client for communicating with Meshtastic devices over MQTT. - [Contact](https://github.com/pdxlocations/contact) - A TUI console client for Meshtastic devices. Built with the curses library. +- [Telemetry Harbor - Grafana](/docs/community/software/telemetry-harbor) - A cloud-based solution for collecting, storing, and visualizing Meshtastic telemetry data using grafana. + Support for these projects should be sought from their respective authors. diff --git a/docs/community/software/telemetryharbor.mdx b/docs/community/software/telemetryharbor.mdx new file mode 100644 index 00000000..5fa0d459 --- /dev/null +++ b/docs/community/software/telemetryharbor.mdx @@ -0,0 +1,53 @@ +--- +id: telemetry-harbor +title: Telemetry Harbor Integration +sidebar_label: Telemetry Harbor +sidebar_position: 5 +--- + +## Using Telemetry Harbor with Meshtastic + +### How to Use + +#### Prepare Your Meshtastic Device + +1. Ensure your Meshtastic device is connected and operational. +2. Note the COM port associated with the device. + +#### Set Up the Script + +Clone this repository: + +```sh +git clone https://github.com/TelemetryHarbor/harbor-meshtastic.git +cd harbor-meshtastic +``` + +Install required dependencies: + +```sh +pip install -r requirements.txt +``` + +#### Run the Script + +Execute the script and provide the required information: + +- **Batch Endpoint**: Obtain this from your Telemetry Harbor account. +- **API Key**: Your unique key for secure communication. +- **COM Port**: The port your Meshtastic device is connected to. + +```sh +python app.py +``` + +#### Stream Data + +The script will push telemetry data from your device to the Telemetry Harbor batch endpoint. + +#### Visualize in Grafana + +1. Log in to your Telemetry Harbor Grafana instance. +2. Access pre-configured dashboards to view and analyze your Meshtastic data. + +[Repository Link](https://github.com/TelemetryHarbor/harbor-meshtastic)