mirror of
https://github.com/sunnypilot/sunnypilot.git
synced 2026-08-21 04:53:47 +08:00
phase 1-5
This commit is contained in:
@@ -0,0 +1,42 @@
|
||||
---
|
||||
title: Read Before Installing
|
||||
---
|
||||
|
||||
# Read Before Installing
|
||||
|
||||
Before installing sunnypilot, please review the following important information.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- A supported comma device (comma 3X or compatible)
|
||||
- A compatible vehicle harness for your car
|
||||
- A stable internet connection for the initial setup
|
||||
- Your vehicle must be in the supported list
|
||||
|
||||
## Important Notes
|
||||
|
||||
!!! warning
|
||||
- sunnypilot is a **driver assistance** system — always pay attention to the road
|
||||
- Ensure your device firmware is up to date before installing
|
||||
- Installation will replace any existing openpilot installation on your device
|
||||
|
||||
## Choosing an Installation Method
|
||||
|
||||
| Method | Difficulty | Best For |
|
||||
|--------|-----------|----------|
|
||||
| [URL Method](url-method.md) | Easy | Most users |
|
||||
| [SSH Method](ssh-method.md) | Advanced | Developers and power users |
|
||||
|
||||
## After Installation
|
||||
|
||||
1. The device will download and install the software
|
||||
2. A reboot may be required
|
||||
3. Follow the on-screen setup wizard
|
||||
4. Take a test drive to calibrate the system
|
||||
|
||||
## Getting Help
|
||||
|
||||
If you run into issues:
|
||||
|
||||
- Join the [Discord Community](https://discord.sunnypilot.ai)
|
||||
- Check [Reporting a Bug](../community/reporting-a-bug.md) for how to submit issues
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
title: SSH Method
|
||||
---
|
||||
|
||||
# SSH Method
|
||||
|
||||
The SSH method provides more control over the installation process. Recommended for advanced users.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- SSH access to your comma device
|
||||
- Basic familiarity with the command line
|
||||
|
||||
## Steps
|
||||
|
||||
1. Connect to your device via SSH
|
||||
2. Clone the sunnypilot repository:
|
||||
```bash
|
||||
cd /data
|
||||
git clone https://github.com/sunnypilot/sunnypilot.git openpilot
|
||||
```
|
||||
3. Check out the desired branch:
|
||||
```bash
|
||||
cd openpilot
|
||||
git checkout <branch-name>
|
||||
```
|
||||
4. Reboot the device
|
||||
|
||||
See [Branch Definitions](../references/branch-definitions.md) for available branches.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **SSH connection refused**: Ensure SSH is enabled in device settings
|
||||
- **Git clone fails**: Check internet connectivity
|
||||
- **Branch not found**: Verify the branch name in [Recommended Branches](../references/recommended-branches.md)
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: URL Method
|
||||
---
|
||||
|
||||
# URL Method
|
||||
|
||||
The URL method is the easiest way to install sunnypilot on your comma device.
|
||||
|
||||
## Steps
|
||||
|
||||
1. On your comma device, navigate to **Settings** > **Software**
|
||||
2. Tap **Uninstall** if you have an existing installation
|
||||
3. Enter the sunnypilot installation URL when prompted
|
||||
4. Wait for the download and installation to complete
|
||||
5. The device will reboot automatically
|
||||
|
||||
## Recommended Branches
|
||||
|
||||
See [Recommended Branches](../references/recommended-branches.md) for which branch to install based on your needs.
|
||||
|
||||
!!! tip
|
||||
Most users should install the latest stable branch for the best experience.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- **Download stalls**: Check your internet connection and try again
|
||||
- **Device doesn't reboot**: Manually reboot by holding the power button
|
||||
- **Installation fails**: Try the [SSH Method](ssh-method.md) as an alternative
|
||||
Reference in New Issue
Block a user