Telemetry-Visualizer

This repository contains a Grafana Dashboard for visualizing telemetry data using MQTT.

Discord Alerts

Join our Discord to receive automated alerts based on Grafana telemetry thresholds: https://discord.gg/pFnUYfB9kc

Grafana is configured to generate alerts when selected telemetry values exceed (or fall below) defined threshold limits. These thresholds can be set per metric directly within Grafana’s alerting rules. When a threshold condition is met—such as high motor temperature, low state of charge, or abnormal voltage—Grafana can trigger a notification that is forwarded to this Discord server.

This allows real-time monitoring of vehicle performance, with Discord serving as a centralized place for team members to receive and respond to alerts.

Prerequisites

• Docker installed on your machine.
• An MQTT broker running (e.g., Eclipse Mosquitto). Detailed setup instructions for the MQTT broker can be found in the Helios-Telemetry, running only the aedes server.
• An MQTT client to publish telemetry data to the broker. Additional setup instructions for the MQTT client can be found in the Helios-Mqtt-Webserver-Test.

Instructions

1. Clone the Repository:

   git clone [repository-url]

2. Navigate to the Directory:

   cd Telemetry-Visualizer

3. Start the Docker Container:

   cd grafana
   docker-compose up -d

4. Start the MQTT Publisher:

   The MQTT publisher is responsible for sending telemetry data to the MQTT broker. The setup for the MQTT publisher can vary based on your telemetry data source. If you are using the UCSolarCarTeam's telemetry system, the setup for the Telemetry MQTT publisher can be found in the Helios-Mqtt-Webserver-Test github repository. Ensure you have your environment variables set up correctly to connect to the MQTT broker.

5. Start the MQTT Broker: Start the MQTT broker. You can find an aedes server that sends telemetry data in the Helios-Telemetry repository. If you are using the aedes server, ensure it is configured to run on port 1883 and is accessible at host.docker.internal:1883. Send packets to the topic packet for telemetry data. If you are using a different MQTT broker, ensure it is accessible at host.docker.internal:1883. Ensure that the MQTT broker is running, that you have the environment variables are set up correctly, and that you have the correct credentials to connect to it.

6. Start the MQTT Client: If you have an MQTT client set up, start it to publish telemetry data to the broker. Ensure it is configured to connect to host.docker.internal:1883 with the appropriate credentials.

7. Access Grafana: Open your web browser and go to http://localhost:3000. The default login credentials are:

   • Username: admin
   • Password: admin

8. Add Data Source:

   • Navigate to Configuration > Data Sources.
   • Click on Add data source.
   • Select MQTT.

9. Configure MQTT Data Source:

   • Name: MQTT
   • Server URL: host.docker.internal:1883
   • Username: [your-username]
   • Password: [your-password]

10. Save & Test:

    • Click on Save & Test to ensure the connection is successful.

11. Connect Query:

    • Navigate to Explore.
    • Select the MQTT data source you just created.
    • Enter the topic you want to subscribe to (e.g., packet).
    • Click on Run Query to see the telemetry data.

12. View Dashboard:

    • Navigate to Dashboards to view the telemetry dashboards. Dashboards are automatically synced from grafana/dashboards/ in this repository via Grafana Git Sync.
    • To update a dashboard, see grafana/DASHBOARD_WORKFLOW.md.

Helpful Commands

Use the following commands to interact with the MQTT broker and visualize data:

docker run -it --rm eclipse-mosquitto mosquitto_sub -h 10.0.0.63 -p 1883 -u [ username ] -P [password] -t packet

Pushing updates to AWS Elastic Container Registry (ECR)

To push updates to AWS ECR, follow these steps:

1. Authenticate Docker to AWS ECR Use the AWS CLI to authenticate Docker to your ECR registry. Replace [aws-region] with your AWS region.

   aws ecr get-login-password --region [aws-region] | docker login --username AWS --password-stdin [aws-account-id].dkr.ecr.[aws-region].amazonaws.com

2. Build the Docker Image Navigate to the directory containing your Dockerfile and build the image. Replace [image-name] with your desired image name.

   cd grafana
   docker build -t [image-name] .

3. Tag the Docker Image Tag the image to match your ECR repository. Replace [aws-account-id], [aws-region], and [image-name] with your AWS account ID, region, and image name respectively.

   docker tag [image-name]:latest [aws-account-id].dkr.ecr.[aws-region].amazonaws.com/[image-name]:latest

4. Tag the Docker Image Tag the image to match your ECR repository. Replace [aws-account-id], [aws-region], and [image-name] with your AWS account ID, region, and image name respectively.

   docker tag [image-name]:latest [aws-account-id].dkr.ecr.[aws-region].amazonaws.com/[image-name]:latest

5. Push the Docker Image to ECR Push the tagged image to your ECR repository.

   docker push [aws-account-id].dkr.ecr.[aws-region].amazonaws.com/[image-name]:latest

6. Push the Docker Image to ECR Push the tagged image to your ECR repository.

   docker push [aws-account-id].dkr.ecr.[aws-region].amazonaws.com/[image-name]:latest

Learn more here

https://ca-central-1.console.aws.amazon.com/ecr/repositories/private/602361116849/telemetry-visualizer?region=ca-central-1