keannu125/auxoscloud_fastapi
1
0
Fork 0
mirror of https://github.com/lemeow125/auxoscloud_fastapi.git synced 2026-04-07 02:14:03 +08:00
Code Issues Projects Releases Packages 1 Wiki Activity
A simple barebones API to quickly expose data on your Auxos inverter
13 commits 1 branch 0 tags 167 KiB
Find a file
Exact
Keannu Bernasol 7d6dd9e352 Add .dockerignore
2026-03-23 16:49:05 +08:00
.woodpecker Use buildx 2026-03-23 16:30:46 +08:00
api/auxos Refactor client folder structure 2026-03-20 21:23:55 +08:00
config Run isort 2026-03-20 01:34:13 +08:00
.dockerignore Add .dockerignore 2026-03-23 16:49:05 +08:00
.env.sample Initial commit 2026-03-20 01:22:52 +08:00
.gitignore Initial commit 2026-03-20 01:22:52 +08:00
.python-version Initial commit 2026-03-20 01:22:52 +08:00
docker-compose.yml Initial commit 2026-03-20 01:22:52 +08:00
Dockerfile Initial commit 2026-03-20 01:22:52 +08:00
main.py Refactor client folder structure 2026-03-20 21:23:55 +08:00
pyproject.toml Implement endpoint caching 2026-03-20 02:39:10 +08:00
README.md Initial commit 2026-03-20 01:22:52 +08:00
uv.lock Implement endpoint caching 2026-03-20 02:39:10 +08:00

README.md

Auxos Cloud FastAPI

A simple, barebones API to quickly expose data from your Auxos inverter through a FastAPI interface.

Features

  • 🔋 Real-time Inverter Data: Fetch current inverter status and information
  • 📊 Analytics Data: Access time-series energy production data
  • 📈 Inverter Reports: Get detailed analytics reports from your Auxos inverter
  • 🚀 Docker Ready: Pre-configured for containerized deployment

Requirements

  • Python 3.13 or higher
  • uv (for dependency management)
  • Docker & Docker Compose (for containerized deployment)
  • Auxos Cloud account with inverter credentials

Quick Start

1. Clone the Repository

git clone <repository-url>
cd auxoscloud_fastapi

2. Environment Setup

Create a .env file in the project root with your Auxos credentials:

# Auxos API Configuration
AUXSOL_AUTH_USER=your-email@example.com
AUXSOL_AUTH_PASSWORD=your-password
AUXSOL_INVERTER_ID=your-inverter-id
AUXSOL_INVERTER_SN=your-inverter-serial-number

# Optional: API Configuration
AUXSOL_BASE_URL=https://eu.auxsolcloud.com/auxsol-api
AUXSOL_HOME_URL=https://www.auxsolcloud.com

# Server Configuration
BACKEND_PORT=8000

3. Running Locally

Using Python

# Install dependencies
uv sync

# Run the server
uv run fastapi dev --host 0.0.0.0

The API will be available at http://localhost:8000

Using Docker Compose

docker-compose up

Troubleshooting

Connection Issues

  • Verify your Auxos credentials in the .env file
  • Check that your inverter ID and serial number are correct
  • Ensure the Auxos API is accessible from your network