Installation¶

This page provides detailed installation instructions for the AutoPi Home Assistant integration.

Prerequisites¶

System Requirements¶

AutoPi Requirements¶

• Active AutoPi Account: Sign up at autopi.io
• AutoPi Device: Installed and connected vehicle device
• API Access: Valid API token with vehicle permissions

Installation Methods¶

HACS Installation¶

HACS is the recommended installation method for custom integrations.

Step 1: Install HACS (if needed)¶

If you don't have HACS installed:

1. Prerequisites:
2. Home Assistant Supervisor (for Supervisor installations)

3. Git installed (for manual HACS installation)

4. Install HACS:

5. Follow the official HACS installation guide
6. Restart Home Assistant after installation

Step 2: Add AutoPi Repository¶

1. Open HACS:
2. Navigate to HACS in your Home Assistant sidebar

3. Click on Integrations

4. Add Custom Repository:

5. Click the ⋮ (three dots) menu
6. Select Custom repositories
7. Add repository URL: https://github.com/rknightion/autopi-ha
8. Select category: Integration
9. Click Add

Step 3: Install Integration¶

1. Search for AutoPi:
2. In HACS Integrations, search for "AutoPi"

3. Click on AutoPi in the results

4. Install:

5. Click Install
6. Select the version (latest recommended)

7. Wait for download to complete

8. Restart Home Assistant:

9. Go to Settings → System → Restart
10. Wait for restart to complete

Manual Installation¶

For advanced users or custom Home Assistant setups.

Step 1: Download Integration¶

Choose one of these methods:

Method A: Download Release

# Download latest release
wget https://github.com/rknightion/autopi-ha/releases/latest/download/autopi.zip

# Extract to custom_components
unzip autopi.zip -d /config/custom_components/

Method B: Clone Repository

# Clone the repository
git clone https://github.com/rknightion/autopi-ha.git

# Copy integration files
cp -r autopi-ha/custom_components/autopi /config/custom_components/

Step 2: Verify Installation¶

Check that files are in the correct location:

/config/custom_components/autopi/
├── __init__.py
├── config_flow.py
├── const.py
├── coordinator.py
├── manifest.json
├── sensor.py
├── device_tracker.py
└── ... (other files)

Step 3: Restart Home Assistant¶

• Restart your Home Assistant instance
• Check logs for any errors during startup

Docker Installation¶

For Docker-based Home Assistant installations.

Docker Compose Example¶

version: '3'
services:
  homeassistant:
    container_name: homeassistant
    image: ghcr.io/home-assistant/home-assistant:stable
    volumes:
      - ./config:/config
      - ./custom_components:/config/custom_components
    restart: unless-stopped
    # ... other configuration

Installation Steps¶

1. Prepare Directory:

   mkdir -p ./custom_components/autopi
   

2. Download Integration:

   # Download and extract
   wget -O autopi.zip https://github.com/rknightion/autopi-ha/releases/latest/download/autopi.zip
   unzip autopi.zip -d ./custom_components/
   

3. Restart Container:

   docker-compose restart homeassistant
   

Installation Verification¶

Check Integration Loading¶

1. Navigate to Integrations:
2. Go to Settings → Devices & Services
3. Click + Add Integration

4. Search for "AutoPi"

5. Verify Availability:

6. AutoPi should appear in the search results
7. Icon should be visible
8. Description should be present

Check Logs¶

Enable debug logging to verify installation:

# configuration.yaml
logger:
  default: info
  logs:
    custom_components.autopi: debug

Look for these log entries:

INFO: AutoPi integration loaded successfully
DEBUG: AutoPi manifest loaded: version X.X.X

Troubleshooting Installation¶

Common Issues¶

Integration Not Found¶

Symptoms: AutoPi doesn't appear in integration list

Solutions: 1. Verify files are in correct directory 2. Check file permissions (readable by Home Assistant) 3. Restart Home Assistant completely 4. Check logs for loading errors

Version Conflicts¶

Symptoms: Integration fails to load with dependency errors

Solutions: 1. Check Home Assistant version compatibility 2. Update Home Assistant to latest version 3. Verify integration version compatibility

HACS Issues¶

Symptoms: HACS can't find or install integration

Solutions: 1. Verify HACS is properly installed 2. Check internet connectivity 3. Manually refresh HACS repositories 4. Clear HACS cache and retry

Log Analysis¶

Common log entries and meanings:

Getting Help¶

If installation fails:

1. Check Documentation: Review this guide and FAQ
2. Search Issues: Look for similar problems on GitHub
3. Create Issue: Report with installation details:
4. Home Assistant version
5. Installation method used
6. Complete error logs
7. System information

Next Steps¶

After successful installation:

1. Getting Started: Complete setup guide
2. Configuration: Configure the integration
3. Vehicle Data: Understand available data

Updates and Maintenance¶

Updating via HACS¶

1. Check for Updates:
2. HACS will notify of available updates

3. Updates appear in HACS dashboard

4. Install Update:

5. Click Update in HACS
6. Select version to install
7. Restart Home Assistant

Manual Updates¶

1. Download New Version:
2. Get latest release from GitHub

3. Follow manual installation steps

4. Backup Configuration:

5. Integration settings are preserved
6. Consider backing up config entries

Version Management¶

• Stable Releases: Recommended for production
• Beta Releases: Early access to new features
• Development: Latest code, may be unstable

Keep track of installed version in: - HACS interface - Integration device info - custom_components/autopi/manifest.json