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
  • CURL
  • HTTPie
  • NodeJS
  • TCP/IP

Was this helpful?

  1. GETTING STARTED

Reading the examples

PreviousSending requestsNextGet zones

Last updated 6 years ago

Was this helpful?

This document uses several examples for example requests. You can select between the examples on a page, by selecting the different options at the top.

CURL

cURL is an open source command line tool for making web requests. cURL is distributed with most OS's, including Linux and Mac. It can also be downloaded for Windows.

HTTPie

HTTPie is another open source command line tool that simplifies making HTTP requests

NodeJS

NodeJS is a cross platform runtime interpreter for JavaScript. It's used to run JavaScript code on a server.

TCP/IP

Many 3rd party automation systems have a restricted API for interfacing with VSSL. These systems often can only send IP based commands.

This document uses examples of the host ip, port number, and ASCII data you need to send a command to the VSSL agent.

.

Our examples use , an open source JavaScript library that runs on Node or a web browser to simplify HTTP requests.

Curl website
HTTPie on GitHub
NodeJS
axios
CURL
HTTPie
NodeJS
TCP/IP
Select Example Language