Skip to content

README.md

Latest commit

 

History

History
88 lines (61 loc) · 2.38 KB

README.md

File metadata and controls

88 lines (61 loc) · 2.38 KB
Raw

Ampvortex

AmpVortex Web API

AmpVortex Web API provides developers with full access to AmpVortex AVRs and multi-room amplifiers. Use this API to control zones, adjust volume, switch sources, and integrate with smart home platforms like Home Assistant.

Official API documentation: AmpVortex Web API PDF
Explore AmpVortex products: AmpVortex Products
Official website: https://www.ampvortex.com

Features

  • Control AmpVortex AVRs and multi-room amplifiers remotely
  • Manage zones, playback, and volume
  • Switch sources: AirPlay 2, Bluetooth Audio, Google Cast
  • Integration with Home Assistant and other smart home platforms
  • Python and NodeJS example scripts for developers
  • Open for API extension and custom automation

Installation

Clone the repository and install dependencies for example scripts:

git clone https://github.com/username/AmpVortex-WebAPI.git
cd AmpVortex-WebAPI
pip install -r requirements.txt

Usage Example (Python)

from ampvortex_webapi import AmpVortexAPI

api = AmpVortexAPI(base_url="http://your-device-ip", token="YOUR_API_TOKEN")

# Get all zones
zones = api.get_zones()
print(zones)

# Set volume in a specific zone
api.set_volume(zone="Living Room", level=50)

# Play a track via AirPlay 2
api.play_airplay(zone="Living Room", url="https://example.com/song.mp3")

NodeJS Example (placeholder):

// Future NodeJS example

API Documentation

Official Web API PDF Examples Folder (coming soon) Scripts Folder (coming soon)

Project Structure

AmpVortex-WebAPI/
├─ README.md
├─ LICENSE
├─ CHANGELOG.md
├─ docs/                # Documentation and guides
├─ examples/            # Python/NodeJS example scripts
├─ scripts/             # API utility scripts
├─ assets/              # Banner and illustrations
└─ .github/             # Issue & PR templates

Contributing

Contributions are welcome! Please see CONTRIBUTING.md (coming soon) for guidelines.

License

This project is licensed under the MIT License. See LICENSE for details.