Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TorbenGallobDynatrace authored Jan 18, 2024
1 parent a565066 commit 6530bae
Showing 1 changed file with 19 additions and 16 deletions.
35 changes: 19 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,49 @@
# DT Balanka - Table Soccer Observability

## Overview
Welcome to the DT Balanka repository, a project developed during the Dynatrace Innovation Day in January 2024 in order to take the spirit of playing table soccer at Dynatrace to a new level. Our project combines hardware and software elements to track and display game scores and player statistics in real-time.
Welcome to the DT Balanka repository, a proof of concept project developed by Team Luminux during the Dynatrace Innovation Day in January 2024 in order to take the spirit of playing table soccer at Dynatrace to a new level. Our project combines hardware and software elements to track and display game scores and player statistics for Balanka (table soccer).

## Project Components

### Hardware
- **ESP32 Device**: A compact, USB-powered, and WiFi-enabled microcontroller that forms the core of our hardware setup.
- **RFID Sensors**: Two sensors connected to the ESP32, allowing players to identify themselves using employee tags or custom RFID tags.
- **eInk Display**: A 2.7" WaveShare eInk display equipped with four buttons, providing an interactive interface for players.
- **OLED Display**: 128x32px mini OLED display.
- **Connectivity**: The ESP32's WiFi capabilities are utilized to connect the hardware with our web application.
- **Buttons**: Four simple buttons for user input.

### Software
- **ESP32 Arduino App**: Arduino C++ application for the ESP32 and the sensors using the VSCode PlatformIO plugin.
- **Supabase Backend**: Our backend infrastructure is built on Supabase, ensuring robust data management and seamless integration with our frontend.
- **React Frontend**: A user-friendly web application developed using React, showcasing game results and detailed player statistics.

## Features

- **Player Identification**: Utilizes RFID technology for player authentication and identification.
- **Real-Time Score Tracking**: Players can input scores directly through the hardware interface, which are then reflected in real-time on the web application.
- **Game Management**: The eInk display and buttons on the device enable players to start games, enter scores, and submit them to our backend.
- **Statistical Insights**: The web application provides comprehensive statistics and insights about game performances, scores, and player rankings.
- **Score Tracking**: Players can input scores directly through the hardware interface, which are then reflected on the web application.
- **Game Management**: The display and buttons on the device enable players to start games, enter scores, and submit them to the backend.
- **Statistical Insights**: The web application provides statistics and insights about game performances, scores, and player rankings.

# User Interface
# User Interface and process

- 2.7" eInk display with 4 Buttons
- Screen shows initial welcome message
- Button 1: Reset the game. Players can identify and register themselves for teams A and B and names will be shown on the display accordingly. Missing identities will be anonymous players.
- Button 2: Increase score of team A, 0 to 10, then go back to 0
- Button 3: Increase score of team B, 0 to 10, then go back to 0
- Button 4: Pressed once questions to submit the current score, press again to submit the score to Supabase
- Mini display with 4 Buttons
- 5 Screens
- **Welcome** (fetching player list over REST call)
- **Register Players** (switch between players 1-4, hold tag near RFID scanner to identify, proceed to team overview when ready)
- **Team Overview** (confirm team configuration or go back)
- **Scores** (show and set team scores)
- **Submit Scores?** (confirm or go back)
- **Submission result** (success or error screen, any key goes back to welcome)

## Getting Started

To get started with the DT Balanka project:

1. **Clone the Repository**: Clone this repository to your local machine.
2. **Hardware Setup**: Assemble the ESP32, RFID sensors, and eInk display as per the provided schematics.
2. **Hardware Setup**: Assemble the ESP32, RFID sensors, buttons and display.
3. **Software Installation**: Install the necessary software dependencies for both the backend and frontend components.
4. **Configuration**: Configure the ESP32 with your WiFi credentials and connect it to the Supabase backend.
5. **Running the App**: Launch the React web application to view real-time game data and statistics.
4. **Configuration**: Configure the ESP32 with your WiFi credentials and the API URLs.
5. **Running the App**: Launch the React web application to view game data and statistics.

## Contributions

Expand All @@ -51,4 +55,3 @@ For support, please open an issue in the repository, and we will assist you as s

Thank you for your interest in the DT Balanka project. Let's elevate the table soccer experience together! 🚀

# Test

0 comments on commit 6530bae

Please sign in to comment.