Hub Home Downloads Documentation Releases

Arrays and modules

PreviousDocumentation NextBeams and presets

Last updated 7 months ago

Was this helpful?

Get Arrays

Returns information about all arrays

get

/arrays

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/arrays'

200

500

{
  "ANY_ADDITIONAL_PROPERTY": {
    "health": {
      "message": "Okay",
      "status": "okay"
    },
    "name": "Stage Left",
    "modules": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "power_status": "awake"
  }
}

Get Array

Returns information for a specific array

get

/arrays/{arrayID}

Path parameters

arrayIDstringrequired

Array ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/arrays/{arrayID}'

200

400

404

500

{
  "health": {
    "message": "Okay",
    "status": "okay"
  },
  "name": "Stage Left",
  "modules": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "power_status": "awake"
}

Set Array Blink

Changes the blink state for a specific array

put

/arrays/{arrayID}/blink

Path parameters

arrayIDstringrequired

Array ID

Body

onbooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/arrays/{arrayID}/blink' \
  --header 'Content-Type: application/json' \
  --data '{"on":true}'

204

400

500

No body

No Content

Set Array Power State

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

put

/arrays/{arrayID}/power

Path parameters

arrayIDstringrequired

Array ID

Body

targetundefined · enumrequired

Example: on

Options: unknown, on, sleep

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/arrays/{arrayID}/power' \
  --header 'Content-Type: application/json' \
  --data '{"target":"on"}'

204

400

500

No body

No Content

Get Modules

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

get

/modules

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/modules'

200

500

{
  "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
      }
    },
    "product": "X1",
    "type": "MD96",
    "power_status": "awake"
  }
}

Get Module

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

get

/modules/{moduleID}

Path parameters

moduleIDstringrequired

Module ID

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/modules/{moduleID}'

200

400

404

500

{
  "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
    }
  },
  "product": "X1",
  "type": "MD96",
  "power_status": "awake"
}

Set Module Blink

Changes the blink state for a specific module

put

/modules/{moduleID}/blink

Path parameters

moduleIDstringrequired

Module ID

Body

onbooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/modules/{moduleID}/blink' \
  --header 'Content-Type: application/json' \
  --data '{"on":true}'

204

400

500

No body

No Content

Set Module Power State

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

put

/modules/{moduleID}/power

Path parameters

moduleIDstringrequired

Module ID

Body

targetundefined · enumrequired

Example: on

Options: unknown, on, sleep

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/modules/{moduleID}/power' \
  --header 'Content-Type: application/json' \
  --data '{"target":"on"}'

204

400

500

No body

No Content