Skip to content

Commit bccac25

Browse files
committed
add Getting started
1 parent c87b34a commit bccac25

File tree

3 files changed

+79
-0
lines changed

3 files changed

+79
-0
lines changed

.vitepress/config.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ export default defineConfig({
2424
{
2525
text: 'Main',
2626
items: [
27+
{ text: 'Getting started', link: '/getting-started' },
2728
{ text: 'Troubleshooting Guide', link: '/troubleshooting' },
2829
{ text: 'Markdown Examples', link: '/markdown-examples' },
2930
{ text: 'Runtime API Examples', link: '/api-examples' }

getting-started.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
title: Getting Started
3+
description: Learn how to flash, connect, and configure aa-proxy for the first time.
4+
---
5+
6+
# Getting Started
7+
8+
This guide walks you through the first setup of **aa-proxy**, including flashing the SD card, connecting to your phone and car, and using the web interface for configuration.
9+
10+
---
11+
12+
## 💾 Flashing SD Card
13+
14+
The latest stable SD card images are available on the [Releases page](https://github.com/manio/aa-proxy-rs/releases).
15+
Download the correct image for your hardware and flash it using your preferred tool (for example, **Raspberry Pi Imager** or **balenaEtcher**).
16+
17+
---
18+
19+
## 🔌 First-Time Connection
20+
21+
1. **Verify Android Auto with your car:**
22+
Connect your phone directly to the car head unit (HU) via USB and confirm that Android Auto starts successfully. Then disconnect the phone.
23+
24+
2. **Connect the aa-proxy board:**
25+
Use a **data-capable USB cable** and make sure you connect to the correct **OTG-enabled port** on your board:
26+
27+
- **Raspberry Pi Zero W** and **Raspberry Pi Zero 2 W** → second micro-USB port labeled **“USB”** (not “PWR”)
28+
- **Raspberry Pi 3 A+** → the only USB-A port (use a USB-A to USB-A cable)
29+
- **Raspberry Pi 4** → the USB-C port (the same one normally used for power)
30+
31+
3. **Pair via Bluetooth:**
32+
On your phone, open Bluetooth settings and pair with the new device named `aa-proxy-*`.
33+
34+
4. **Automatic Wi‑Fi connection:**
35+
After pairing, your phone should automatically connect via Wi‑Fi. The aa-proxy will then connect to the head unit via USB and start Android Auto on the car display.
36+
37+
From the next connection onward, Android Auto should launch automatically without further setup.
38+
39+
> [!WARNING]
40+
> For convenience during the first setup, **SSH access is enabled by default** and the device uses a predefined Wi‑Fi password.
41+
> It is **strongly recommended** to change these defaults or disable SSH entirely for security reasons.
42+
43+
> [!NOTE]
44+
> 📶 **Default Wi‑Fi credentials:**
45+
> SSID: `aa-proxy`
46+
> WPA password: `aa-proxy`
47+
>
48+
> 🔐 **Default SSH credentials:**
49+
> User: `root`
50+
> Password: `password`
51+
>
52+
> See below for instructions on connecting to the device’s Wi‑Fi network.
53+
54+
---
55+
56+
## 🌐 Embedded Web Interface
57+
58+
When connected to the device’s Wi‑Fi network, open [http://10.0.0.1](http://10.0.0.1) in a web browser to access the built‑in web interface.
59+
60+
> [!WARNING]
61+
> If you want to access the device (via web or SSH) **while Android Auto is running**, it will not be reachable from the same phone.
62+
> You have two options:
63+
>
64+
> - Use a **different device** (e.g., laptop or another phone) to connect to the aa-proxy Wi‑Fi network.
65+
> - Or temporarily **stop Android Auto**, for example by:
66+
> - Enabling airplane mode, then re‑enabling Wi‑Fi only and connecting manually, **or**
67+
> - Disabling both Wi‑Fi and Bluetooth, waiting a few seconds, then re‑enabling Wi‑Fi and reconnecting.
68+
>
69+
> If connection issues persist, try disabling **MAC address randomization** on your phone.
70+
> [This guide](https://help.kings.edu/hc/en-us/articles/4406119218455-How-to-Disable-Randomized-MAC-Addresses-on-Android) explains how to do this on Android.
71+
72+
Within the web interface, you can configure all settings available in `/etc/aa-proxy-rs/config.toml`, such as Bluetooth behavior, logging options, and network parameters.
73+
74+
![Webserver preview](./images/webserver.png)
75+
76+
You can also **download logs** directly with a single click for troubleshooting or support purposes.
77+
78+
---

images/webserver.png

251 KB
Loading

0 commit comments

Comments
 (0)