mirror of https://github.com/vide/matedroid.git synced 2026-01-20 00:03:17 +08:00

Files

Davide Ferrari 2a0976b36d docs: update README with new features and utility script

- Add 3D car image, charge details, dark mode to feature list
- Add osmdroid to tech stack
- Document fetch_tesla_assets.py utility script

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

2025-12-20 18:53:29 +01:00

3.8 KiB

Raw Blame History

MateDroid

A native Android application for viewing Tesla vehicle data from your self-hosted Teslamate instance via the TeslamateApi.

Features

Dashboard - Real-time vehicle status at a glance with 3D car image matching your vehicle's color and wheels
Charging History - View all charging sessions with statistics and charts
Charge Details - Interactive map and detailed power/voltage/temperature charts
Drive History - Track trips with efficiency metrics and route visualization
Battery Health - Monitor battery degradation over time
Software Updates - Track update history
Dark Mode - Follows system theme

Requirements

Android 8.0 (API 26) or higher
A running Teslamate instance
TeslamateApi deployed and accessible

Installation

From Release (Recommended)

Download the latest APK from the Releases page and install it on your Android device.

Build from Source

Prerequisites

Java 17 or higher
Android SDK (API 35)
(Optional) Android Studio

Build Steps

# Clone the repository
git clone https://github.com/yourusername/matedroid.git
cd matedroid

# Build debug APK
./gradlew assembleDebug

# The APK will be at: app/build/outputs/apk/debug/app-debug.apk

# Or install directly to a connected device/emulator
./gradlew installDebug

Development

Project Structure

matedroid/
├── app/src/main/java/com/matedroid/
│   ├── data/           # Data layer (API, repository, local storage)
│   ├── domain/         # Domain layer (models, use cases)
│   ├── ui/             # UI layer (screens, components, theme)
│   └── di/             # Dependency injection modules
├── gradle/             # Gradle wrapper and version catalog
└── PLAN.md             # Detailed implementation plan

Tech Stack

Language: Kotlin
UI: Jetpack Compose with Material Design 3
Architecture: MVVM + Clean Architecture
DI: Hilt
Networking: Retrofit + OkHttp + Moshi
Local Storage: DataStore
Charts: Vico
Maps: osmdroid (OpenStreetMap)

Utility Scripts

`util/fetch_tesla_assets.py`

Python script to download Tesla car 3D renders from Tesla's compositor service. Requires uv for dependency management.

# Download all car images (Model 3 & Y, various colors/wheels)
./util/fetch_tesla_assets.py

# Preview what would be downloaded
./util/fetch_tesla_assets.py --dry-run

# Custom output directory
./util/fetch_tesla_assets.py --output-dir /path/to/assets

Running Tests

# Unit tests
./gradlew test

# Instrumented tests (requires emulator/device)
./gradlew connectedAndroidTest

Development Workflow

Start your Android emulator or connect a device
Build and install: ./gradlew installDebug
View logs: adb logcat | grep -i matedroid

Or use Android Studio:

Open the project folder
Wait for Gradle sync
Click Run (green play button)

Configuration

On first launch, you'll be prompted to configure your TeslamateApi connection:

Server URL: Your TeslamateApi instance URL (e.g., https://teslamate-api.example.com)
API Token: (Optional) If your instance requires authentication

License

This project is licensed under the GNU General Public License v3.0. See LICENSE for details.

Acknowledgments

Teslamate - Self-hosted Tesla data logger
TeslamateApi - RESTful API for Teslamate
t-buddy - iOS app inspiration

3.8 KiB Raw Blame History