Skip to content
This repository has been archived by the owner on Apr 5, 2023. It is now read-only.

creising/CueServer-Client

Repository files navigation

Build Status

Build Status Coverage Status

Introduction

The CueSever Java client library is intended to facilitate interaction with CueServer's HTTP interface. In addition to the client, there is also a simple command line interface to demonstrate the use of the CueServer client.

Currently, the client library does not throttle requests to the CueServer. As noted in CueServer's documentation, new requests should only be sent after a response from the previous request has been received from CueServer.

Documentation

All Javadoc can be found here.

Project Structure

./client contains all code related to the client library. ./cli contains all of the code related to the example command line interface.

Compilation

The client library uses the Gradle build system. If you're new to Gradle, here are a couple of common commands to get you started. All commands should be run from the root directory.

./gradlew build: Compiles all code and runs the unit tests.

./gradle javadoc: Generate Javadoc.

./gradlew clean: Removes the build directories.

./gradlew cli:installApp: Creates a JVM application along with libs and OS specific scripts. Once this command is run, the application can be found in: cli/build/install/.

Artifacts

Artifacts can be found on The Central Repository.

Dependencies

The client library has the following dependencies:

  • Google's guava v18.0
  • Apache's httpclient v4.3.5
  • Your favorite SLF4J library for logging

Additional Reading

For further information regarding the CueServer, please visit: Interactive Technologies.

Supported Operations

The client library currently supports the following operations:

  • Retrieval of system information
  • Retrieval of playback information
  • Retrieval of level from the DMX output
  • Play a cue on a playback
  • Clear a playback
  • Set a channel
  • Set a range of channels
  • Record a cue
  • Update a cue
  • Delete a cue

About

Java client for CueServer's HTTP interface

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages