LogoLogo
Hub HomeDownloadsDocumentationReleases
  • Welcome
  • Introduction to HOLOPLOT
    • HOLOPLOT unique capabilities
    • HOLOPLOT technology
    • HOLOPLOT OS
      • Audio signal flow
    • Product family
  • user guides
    • HOLOPLOT system design
      • System design best practices
        • Introduction to sound system design
        • Which HOLOPLOT product is best suited to the application?
        • How do I decide on the position of my arrays?
        • What should be the size and aspect ratio of my arrays?
      • Beam design best practices
        • What are the fundamental principles of designing with beams?
        • How do I set up my coverage zones and what impact does that have on my design?
        • What are the different beam parameters and how do I apply them in my design?
        • How do I apply those beams in real world applications?
    • HOLOPLOT system deployment
      • Integration overview
      • Unboxing
      • Networking overview
      • AES67 Quick start guide
      • Advanced Network Configuration Tips
      • Power
      • Rigging
        • X1 Rigging Components
        • X1 standard rigging side plate attachment guide
        • X1 Standard rigging lifting procedures
        • X1 custom rigging
      • Venue validation
      • System operation & monitoring
      • Pairing the arrays & routing audio
      • Align and tune beams
      • Measurement and system optimization
    • Troubleshooting
  • HOLOPLOT Plan
    • Getting started
      • Recommended specifications
      • Installing HOLOPLOT Plan
      • Additional 3rd party tools
      • Navigating the interface
    • Onboarding videos
    • Importing 3D assets from SketchUp
      • Setting up the SketchUp toolkit
      • Installing the Khronos glTF Exporter for SketchUp
      • Defining zone types in SketchUp
      • Importing assets from SketchUp
    • Working with Matrix Arrays
      • Creating arrays
      • Moving arrays
    • Working with zones
      • Defining zone types
      • Drawing zones
      • Moving zones
    • Working with presets
      • Creating a preset
      • Working with preset layers
      • Working with environmental conditions
    • Working with beams
      • Creating a Parametric Beam
        • Adjusting Parametric Beam parameters
      • Creating a Virtual Source
        • Adjusting Virtual Source parameters
      • Creating a Coverage Beam
        • Assigning zones to a Coverage Beam
        • Adjusting Coverage Beam parameters
        • Optimizing a Coverage Beam
        • Working with beam variants (advanced)
      • Creating an LF Coverage Beam
        • Creating crossovers
      • Routing Beams
    • Simulation
      • Simulation controls
      • Tuning
      • Probe Mode
      • Simulating with S21 arrays
    • Saving & exporting
      • Exporting to AFMG EASE
  • HOLOPLOT Control
    • Getting started
      • Accessing HOLOPLOT Control
      • Navigating the interface
    • Configuring the system
      • Setting up system essentials
      • Managing a project
      • Pairing Modules
      • Network Settings - RAVENNA only
      • Stream Management - RAVENNA only
      • Setting up Analog mode on X2 Modules
    • Operating the system
      • Getting an overview of the active project
      • Routing streams to audio inputs
      • Switching presets and environmental conditions
      • Applying actions to the system
      • Tuning beams
      • Monitoring level meters
    • Maintaining the system
      • Monitoring device health
      • Module driver test
      • Module and Controller events
      • Module and Controllers Issues List
  • HOLOPLOT API
    • Getting started
    • Documentation
      • Arrays and modules
      • Beams and presets
      • Device health
      • Controllers
      • System operation
      • Spaces
    • Examples
      • Changing a preset
      • Adjusting the system's gain
Powered by GitBook
LogoLogo

HOLOPLOT

  • HOLOPLOT Website
  • Contact
  • Imprint
  • Privacy Policy

© 2024 HOLOPLOT GmbH. All rights reserved.

On this page

Was this helpful?

Export as PDF
  1. HOLOPLOT API
  2. Documentation

Arrays and modules

PreviousDocumentationNextBeams and presets

Last updated 1 month ago

Was this helpful?

Get Arrays

get

Returns information about all arrays

Responses
200
OK
application/json
500
Internal server error
application/json
get
GET /psapi/arrays HTTP/1.1
Host: aaa-1234.local
Accept: */*
{
  "ANY_ADDITIONAL_PROPERTY": {
    "health": {
      "message": "Okay",
      "status": "okay"
    },
    "modules": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "name": "Stage Left",
    "power_status": "awake"
  }
}

Get Array

get

Returns information for a specific array

Path parameters
arrayIDstringRequired

Array ID

Responses
200
OK
application/json
400
Bad request
application/json
404
Array not found
application/json
500
Internal server error
application/json
get
GET /psapi/arrays/{arrayID} HTTP/1.1
Host: aaa-1234.local
Accept: */*
{
  "health": {
    "message": "Okay",
    "status": "okay"
  },
  "modules": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "name": "Stage Left",
  "power_status": "awake"
}

Get Modules

get

Returns information about all modules.If a module is not paired, the field "name" will be an empty string.

Responses
200
OK
application/json
500
Internal server error
application/json
get
GET /psapi/modules HTTP/1.1
Host: aaa-1234.local
Accept: */*
{
  "ANY_ADDITIONAL_PROPERTY": {
    "blinking": false,
    "manufacturer": "HOLOPLOT",
    "name": "ABC-1234",
    "position": {
      "front_direction": {
        "x": 1,
        "y": 2,
        "z": 3
      },
      "position": {
        "x": 1,
        "y": 2,
        "z": 3
      },
      "up_direction": {
        "x": 1,
        "y": 2,
        "z": 3
      }
    },
    "power_status": "awake",
    "product": "X1",
    "type": "MD96"
  }
}

Get Module

get

Returns information for a specific module.If a module is not paired, the field "name" will be an empty string.

Path parameters
moduleIDstringRequired

Module ID

Responses
200
OK
application/json
400
Bad request
application/json
404
Module not found
application/json
500
Internal server error
application/json
get
GET /psapi/modules/{moduleID} HTTP/1.1
Host: aaa-1234.local
Accept: */*
{
  "blinking": false,
  "manufacturer": "HOLOPLOT",
  "name": "ABC-1234",
  "position": {
    "front_direction": {
      "x": 1,
      "y": 2,
      "z": 3
    },
    "position": {
      "x": 1,
      "y": 2,
      "z": 3
    },
    "up_direction": {
      "x": 1,
      "y": 2,
      "z": 3
    }
  },
  "power_status": "awake",
  "product": "X1",
  "type": "MD96"
}
  • GETGet Arrays
  • GETGet Array
  • PUTSet Array Blink
  • PUTSet Array Power State
  • GETGet Modules
  • GETGet Module
  • PUTSet Module Blink
  • PUTSet Module Power State

Set Array Blink

put

Changes the blink state for a specific array

Path parameters
arrayIDstringRequired

Array ID

Body
onbooleanRequired
Responses
204
No Content
400
Bad request
application/json
500
Internal server error
application/json
put
PUT /psapi/arrays/{arrayID}/blink HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "on": true
}

No content

Set Array Power State

put

Changes the target power state for the array, allowed values are "on" and "sleep"

Path parameters
arrayIDstringRequired

Array ID

Body
targetall ofRequiredExample: onPossible values:
string · enumOptionalPossible values:
Responses
204
No Content
400
Bad request
application/json
500
Internal server error
application/json
put
PUT /psapi/arrays/{arrayID}/power HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "target": "on"
}

No content

Set Module Blink

put

Changes the blink state for a specific module

Path parameters
moduleIDstringRequired

Module ID

Body
onbooleanRequired
Responses
204
No Content
400
Bad request
application/json
500
Internal server error
application/json
put
PUT /psapi/modules/{moduleID}/blink HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "on": true
}

No content

Set Module Power State

put

Changes the target power state for the module, allowed values are "on" and "sleep"

Path parameters
moduleIDstringRequired

Module ID

Body
targetall ofRequiredExample: onPossible values:
string · enumOptionalPossible values:
Responses
204
No Content
400
Bad request
application/json
500
Internal server error
application/json
put
PUT /psapi/modules/{moduleID}/power HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "target": "on"
}

No content