VSSL REST API
  • Introduction
  • GETTING STARTED
    • Introduction
    • START HERE!
    • Using a Raspberry PI
    • Installing the VSSL Agent
    • Discovery of the API
    • Sending requests
    • Reading the examples
  • ZONES
    • Get zones
    • Reboot a zone
  • ZONE CONTROL
    • Play Control
    • Volume
    • Mute
    • Set Party
    • Set Group
    • Priority
    • Set Analog Input Source
    • RampVolume
  • ANNOUNCEMENTS
    • Play an audio clip
  • SUPPORT
    • Feature request
    • Contact us
Powered by GitBook
On this page
  • 1. Select a host device for the VSSL agent
  • 2. Install the VSSL agent on the host device
  • 3. Discover and set the host device IP address to static
  • 4. Send the host device HTTP requests
  • API Overview

Was this helpful?

  1. GETTING STARTED

START HERE!

PreviousIntroductionNextUsing a Raspberry PI

Last updated 5 years ago

Was this helpful?

Follow these steps to set up the VSSL API.

1. Select a host device for the VSSL agent

The VSSL agent needs to be installed on a Linux based host device.

A Raspberry Pi makes a great host for the VSSL agent. .

2. Install the VSSL agent on the host device

If you are not using a Raspberry Pi, follow these instructions to install the VSSL snap agent.

3. Discover and set the host device IP address to static

Follow the instructions for your host device to set the IP address to be static. Learn more about discovery of the API .

COMING SOON: For Raspberry Pi's use the VSSL app to discover the agent and set the network settings.

4. Send the host device HTTP requests

Learn about sending HTTP requests .

API Overview

  • Zones

  • Zone Control

  • Announcements

Set up a Raspberry Pi
Install VSSL Agent
here
here
Get Zones
Reboot a zone
Play Control
Volume
Mute
Set Party
Set Group
Set Analog Input Source
Set Priority
Play an audio clip