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
  • Using the VSSL prepared RPi image
  • Configuring a Raspberry Pi 3 From Scratch
  • Flashing the Image

Was this helpful?

  1. GETTING STARTED

Using a Raspberry PI

PreviousSTART HERE!NextInstalling the VSSL Agent

Last updated 6 years ago

Was this helpful?

The Raspberry Pi is a low cost option for running the VSSL api. It is a stable platform with good documentation and a huge global community. We support the Raspberry PI 3.

You can purchase a good Raspberry Pi kit here:

Using the VSSL prepared RPi image

We have put together a Rasbian image with the VSSL agent that runs the REST API preloaded.

You can follow these instructions to configure your Raspberry Pi 3 with the preconfigured VSSL rpi image.

  1. Download the VSSL configured image from:

    Currently this image is for a 32Gb SD card

  2. Load this image on a microSd card using the instructions at:

  3. Insert this microSd card in the PI and power on the PI

  4. The vsslagent will now be running on port 8000. You can test it from the terminal.

    a. List the VSSL zones that the pi can see

    curl localhost:8000/api/vssls

Remember that you will have to use the correct ip address (the address of the pi) when calling API functions from an entity outside the PI.

You can get the ip address of the pi using ifconfig. You will see an entry for enx<> that contains a field inet.

Configuring a Raspberry Pi 3 From Scratch

How to Configuring a Rapsberry Pi 3 using the latest image:

  1. Insert this microSd card in the PI and launch it

  2. Open a terminal and perform the following:

    a. Update the image to latest tools:

    sudo apt-get update && sudo apt-get dist-upgrade && sudo apt-get clean

    b. install the ubuntu snap tool:

    sudo apt-get install snapd

    c. install the vssl agent:

    sudo snap install vsslagent
  3. The vsslagent will now be running on port 8000. You can test it from the terminal.

    a. list the VSSL zones that the pi can see

    curl localhost:8000/api/vssls

Remember that you will have to use the correct ip address (the address of the pi) when calling API functions from an entity outside the PI.

You can get the ip address of the pi using ifconfig. You will see an entry for enx<> that contains a field inet.

Flashing the Image

Download the latest 'Rasbian Stretch with desktop' image from RaspberryPi.org:

Load this image on a microSd card using the instructions at RaspberryPi.org:

Use to flash the image to your SD card.

Download Image
Instructions
Etcher.io
Amazon RPi Kit
Download the image
Raspberry Pi Org
Using the prebuilt VSSL image
Raspberry PI from Scratch
Flashing an SD card