Programming Guide — Galileo GALAXY Network Platform
The term GALAXY is used generically for the versions of the Galileo GALAXY Network Platform listed below:
GALAXY 408
GALAXY 816
GALAXY 816-AES (legacy product)
Bluehorn 816
This document explains the Control Plane server in Meyer Sound’s Galileo GALAXY Network Platform. GALAXY is the server in a client/server relationship that lets multiple clients control the hardware simultaneously. These clients can be several computers running Compass software or other controllers using the protocols supported by GALAXY. Clients can subscribe to a GALAXY server and exchange control and status messages.
The document covers both ASCII and Open Sound Control (OSC) network protocols and defines each control point available in the system.
Disclaimer
This work has been compiled from many sources. It is not meant to replace those documents, or to supply documentation and education regarding networking. The Galileo GALAXY Network Platform can provide very loud sound pressure levels to the audience. Therefore, proper network security, risk assessment, and discipline are strongly recommended before using remote control over a network with third-party software. The authors of this work shall not hold any responsibility for the misuse of this document, for improper implementation, or carelessness.
Networking
Networking is a crucial part of communication between machines. Network management and security are critical tasks because of actions that can be triggered remotely, sometimes unintentionally. It is beyond the scope of this guide to provide basic network instruction, but proper network management is essential.
GALAXY can use an IPv4, IPv6, or mDNS address. Their functions are equivalent and they can be mixed within a network. The server can connect and control multiple clients simultaneously. GALAXY’s OSC server listens to two different networking protocols, TCP/IP and UDP, each with its advantages and constraints.
Example: Telnet connection to IPv4 address and the ASCII port
telnet 192.168.71.146 25003
Example: Telnet connection to IPv6 address and the ASCII port
telnet fe80::21c:abff:fe00:584c%en12 25003
Example: Constructing a user-created mDNS address by combining entity name and group name from Compass
From Compass we see the entity name is “MyGALAXY,” and the group name is “MyGroup.”
Entity Name.Group Name.local
telnet MyGalaxy.MyGroup.local 25003
Example: Generating an automatic mDNS address by combining the device type and serial number
A Meyer Sound Galileo GALAXY module is a device type mslg-gx-nnn
where nnn
can be 408, 816, 816aes, or bluehorn.
telnet mslg-gx-816-16342723.local 25003
Note
Telnet is not available on the current macOS. Use the netcat
command (nc) instead.
TCP/IP
The Transmission Control Protocol is connection-oriented, which requires handshaking to set up end-to-end communication. Once a connection is established, data can be sent bi-directionally.
Reliable – TCP manages message acknowledgment, retransmission and timeout. Multiple attempts to deliver the message are made. If some part of the data is lost along the way, the server will re-request the lost part. There is either no missing data, or, in case of multiple timeouts, the connection is dropped.
Ordered – If two messages are sent in sequence over a connection, the first message will reach the receiving application first. If data segments arrive in the wrong order, TCP buffers delay the out-of-order data until it is properly re-ordered and delivered to the application.
Heavyweight – TCP requires three packets to set up a socket connection before any user data can be sent. TCP prevents data congestion.
Streaming – Data is read as a continuous byte stream with nothing to distinguish signal message (segment) boundaries.
UDP
The Universal Data Protocol is a simpler message-based, connectionless protocol, which does not set up a dedicated end-to-end connection. Information is transmitted from source to destination without verifying the readiness or state of the receiver.
On a totally isolated network, statistics show high reliability for UDP, but this reliability decreases when the network is shared with additional clients that consume bandwidth.
UDP has less latency and jitter than TCP, which is an advantage when communicating with meters or other functions that require real-time updates.
Unreliable – When a message is sent, it cannot be known if it will reach its destination. There is no concept of acknowledgment, retransmission, or timeout.
Not ordered – If two messages are sent to the same recipient, the order in which they arrive cannot be predicted.
Lightweight – There is no ordering of messages or tracking connections. It is a small transport layer designed on top of IP.
Datagrams – Packets are sent individually and checked for integrity only if they arrive. Packets have definite boundaries that are honored upon receipt, meaning a read operation at the receiver socket will yield an entire message as it was originally sent.
No congestion control – UDP does not avoid congestion unless congestion control measures are implemented at the application level. Confirmation messages can also be implemented at the application level.
Regular expressions
Regular expressions are an efficient way to quickly configure and query a GALAXY system. For example, to set multiple control points, use a regular expression to denote the range or number of addresses.
The table below shows the most commonly used regular expressions and their functions.
Regular Expression | Function |
---|---|
. | Regular expressions match any single character value |
* | Regular expression wildcard |
\d | Regular expression integer wildcard |
\d+ | Regular expression integer greedy wildcard |
Regular expression examples
For example, to mute all single digit inputs, use the following command:
/processing/input/\d/mute=’true’
To confirm that these inputs are muted, use the following query:
/processing/input/\d/mute
The following information is returned showing that inputs 1–8 are muted:
/processing/input/1/mute='true'
/processing/input/2/mute='true'
/processing/input/3/mute='true'
/processing/input/4/mute='true'
/processing/input/5/mute='true'
/processing/input/6/mute='true'
/processing/input/7/mute='true'
/processing/input/8/mute='true'
You can use a regular expression to return all commands of a certain type, for example, a control point.
To return the value for all control points whose path starts with /project/snapshot/7/
:
/project/snapshot/7/.*
The following responses return all the possible control point/value pairs starting with /project/snapshot/7
:
/project/snapshot/7/comment='hello'
/project/snapshot/7/created='2017
-09-10 22:09:00'
/project/snapshot/7/last_updated='2017-09-10 22:09:00'
/project/snapshot/7/locked='false'
/project/snapshot/7/modified='false'
/project/snapshot/7/name='7'
Tip
See Regular expression commands for more examples.
Using the GALAXY server for OSC
OSC is often used as an alternative to the 1983 MIDI standard, when higher resolution and a richer musical parameter space is desired. OSC messages are commonly transported over Ethernet protocols. It gives users more flexibility and facility in addressing and interacting with remote machines.
OSC features an open-ended symbolic naming scheme, high resolution argument data, high resolution time tags, and more. It can pack messages into bundles whose effects must occur simultaneously.
OSC should work out of the box on most small-scale routers and network infrastructures. For large or administered networks, proper settings and bandwidth allocation is necessary.
Note
The GALAXY processor has two independent operating modes: normal mode for loudspeaker management using Compass Control Software or the Compass Go App and Spacemap mode for spatial mixing using the Spacemap Go app. When running virtual GALAXY processors, the port numbering scheme behaves differently depending on the operating mode.
The GALAXY server is always listening to port 25004 for OSC messages, unless you are addressing a virtual GALAXY, which in normal mode starts at port 50504. Decrement the port address by 100 for each additional virtual GALAXY (e.g., second virtual GALAXY has port address of 50404, third has 50304, etc.).
Virtual GALAXY port device numbering normal mode (ASCII ports shown)
In Spacemap mode, the virtual GALAXY server address begins at port 25004 for OSC messages. Increment the port address by 100 for each additional virtual GALAXY in Spacemap mode (e.g., second virtual GALAXY in Spacemap mode has port address of 25104, third has 25204, etc.).
Device | Type | Mode(s) | Device Number(s) | Address |
---|---|---|---|---|
Physical GALAXY | OSC | Normal, Spacemap | 1, 2, 3... | 25004, 25104, 25204... |
Physical GALAXY | ASCII | Normal, Spacemap | 1, 2, 3... | 25003, 25103, 25203... |
Virtual GALAXY | OSC | Normal | 1, 2, 3... | 50504, 50404, 50304... |
Virtual GALAXY | ASCII | Normal | 1, 2, 3... | 50503, 50403, 50303... |
Virtual GALAXY | OSC | Spacemap | 1, 2, 3... | 25004, 25104, 25204... |
Virtual GALAXY | ASCII | Spacemap | 1, 2, 3... | 25003, 25103, 25203... |
Virtual GALAXY port devicenumbering Spacemap mode (ASCII ports shown)
Note
Check the Log tab in Compass to determine the port address of any given GALAXY device.
When the OSC message asks for a response, the GALAXY server will reply within the established connection to the client’s address for TCP, and to the port of emission for UDP.
Subscriptions for TCP clients remain active until they are countermanded by an unsubscribe command, or until the client’s TCP connection is broken.
A UDP subscription remains active until it is countermanded by an unsubscribe command, or the server does not receive any UDP packets from the client for at least 30 seconds. To keep a UDP subscription active in the absence of GALAXY activity, use the keepalive tactic by sending an empty ping OSC message to the server.
OSC message syntax
An OSC message consists of an address, type tag string, and OSC argument(s). A type tag contains at least one character, a comma (,), followed by a sequence of characters corresponding to the sequence of OSC arguments in the OSC message.
OSC messages are sometimes compacted into bundles to conserve bandwidth. GALAXY accepts bundles or individual messages.
OSC arguments
OSC arguments may be any of the following types:
i | 32-bit integer |
f | 32-bit floating point |
s | OSC string |
F | Boolean false |
T | Boolean true |
h | 64-bit integer |
Note
Because some clients do not adhere to the OSC protocol governing argument types, GALAXY is programmed to type cast from integer to Boolean. For example, Boolean True is any positive non-zero integer.
Using the GALAXY server for ASCII
The GALAXY ASCII server is always listening on port 25003. When the message asks for a response, GALAXY will reply within the established connection to the client’s address.
Subscriptions for TCP clients remain active until they are revoked by an unsubscribe command, or until the client’s TCP connection is broken.
ASCII text messages are sent to port 25003 unless you address a virtual GALAXY procesor in normal mode, starting at port 50503. Decrement the port address by 100 for each virtual GALAXY processor in normal mode. Increment the port address by 100 for each virtual GALAXY processor in Spacemap mode.
All ASCII built-in functions are preceded by “:” as shown below:
:recall_snapshot 3
Note
All ASCII text commands must end with the newline character, which consists of a carriage return (CR) or line feed (LF): 0d
or 0a
GALAXY Server
This section describes how to interact with the GALAXY server for ASCII and OSC protocols. Most commands involve managing snapshots and communicating with control points. A snapshot contains all GALAXY settings.
All GALAXY parameters can be addressed as control points in OSC or ASCII formats. You can set and query control points. To set a single control point, you need just one Address.
Note
The examples in this section are ASCII commands.
For example, the following commands show how to query the mute status of input 1 and the response returned that it is unmuted:
query: /processing/input/1/mute
response: /processing/input/1/mute='false'
Regular expressions
Regular expressions are an efficient way to quickly configure and query a GALAXY system. For example, to set multiple control points, use a regular expression to denote the range or number of addresses.
The table below shows the most commonly used regular expressions and their functions.
Regular Expression | Function |
---|---|
. | Regular expressions match any single character value |
* | Regular expression wildcard |
\d | Regular expression integer wildcard |
\d+ | Regular expression integer greedy wildcard |
Regular expression examples
For example, to mute all single digit inputs, use the following command:
/processing/input/\d/mute=’true’
To confirm that these inputs are muted, use the following query:
/processing/input/\d/mute
The following information is returned showing that inputs 1–8 are muted:
/processing/input/1/mute='true'
/processing/input/2/mute='true'
/processing/input/3/mute='true'
/processing/input/4/mute='true'
/processing/input/5/mute='true'
/processing/input/6/mute='true'
/processing/input/7/mute='true'
/processing/input/8/mute='true'
You can use a regular expression to return all commands of a certain type, for example, a control point.
To return the value for all control points whose path starts with /project/snapshot/7/
:
/project/snapshot/7/.*
The following responses return all the possible control point/value pairs starting with /project/snapshot/7
:
/project/snapshot/7/comment='hello'
/project/snapshot/7/created='2017
-09-10 22:09:00'
/project/snapshot/7/last_updated='2017-09-10 22:09:00'
/project/snapshot/7/locked='false'
/project/snapshot/7/modified='false'
/project/snapshot/7/name='7'
Tip
See Regular expression commands for more examples.
Using the GALAXY server for OSC
OSC is often used as an alternative to the 1983 MIDI standard, when higher resolution and a richer musical parameter space is desired. OSC messages are commonly transported over Ethernet protocols. It gives users more flexibility and facility in addressing and interacting with remote machines.
OSC features an open-ended symbolic naming scheme, high resolution argument data, high resolution time tags, and more. It can pack messages into bundles whose effects must occur simultaneously.
OSC should work out of the box on most small-scale routers and network infrastructures. For large or administered networks, proper settings and bandwidth allocation is necessary.
Note
The GALAXY processor has two independent operating modes: normal mode for loudspeaker management using Compass Control Software or the Compass Go App and Spacemap mode for spatial mixing using the Spacemap Go app. When running virtual GALAXY processors, the port numbering scheme behaves differently depending on the operating mode.
The GALAXY server is always listening to port 25004 for OSC messages, unless you are addressing a virtual GALAXY, which in normal mode starts at port 50504. Decrement the port address by 100 for each additional virtual GALAXY (e.g., second virtual GALAXY has port address of 50404, third has 50304, etc.).
Virtual GALAXY port device numbering normal mode (ASCII ports shown)
In Spacemap mode, the virtual GALAXY server address begins at port 25004 for OSC messages. Increment the port address by 100 for each additional virtual GALAXY in Spacemap mode (e.g., second virtual GALAXY in Spacemap mode has port address of 25104, third has 25204, etc.).
Device | Type | Mode(s) | Device Number(s) | Address |
---|---|---|---|---|
Physical GALAXY | OSC | Normal, Spacemap | 1, 2, 3... | 25004, 25104, 25204... |
Physical GALAXY | ASCII | Normal, Spacemap | 1, 2, 3... | 25003, 25103, 25203... |
Virtual GALAXY | OSC | Normal | 1, 2, 3... | 50504, 50404, 50304... |
Virtual GALAXY | ASCII | Normal | 1, 2, 3... | 50503, 50403, 50303... |
Virtual GALAXY | OSC | Spacemap | 1, 2, 3... | 25004, 25104, 25204... |
Virtual GALAXY | ASCII | Spacemap | 1, 2, 3... | 25003, 25103, 25203... |
Virtual GALAXY port devicenumbering Spacemap mode (ASCII ports shown)
Note
Check the Log tab in Compass to determine the port address of any given GALAXY device.
When the OSC message asks for a response, the GALAXY server will reply within the established connection to the client’s address for TCP, and to the port of emission for UDP.
Subscriptions for TCP clients remain active until they are countermanded by an unsubscribe command, or until the client’s TCP connection is broken.
A UDP subscription remains active until it is countermanded by an unsubscribe command, or the server does not receive any UDP packets from the client for at least 30 seconds. To keep a UDP subscription active in the absence of GALAXY activity, use the keepalive tactic by sending an empty ping OSC message to the server.
OSC message syntax
An OSC message consists of an address, type tag string, and OSC argument(s). A type tag contains at least one character, a comma (,), followed by a sequence of characters corresponding to the sequence of OSC arguments in the OSC message.
OSC messages are sometimes compacted into bundles to conserve bandwidth. GALAXY accepts bundles or individual messages.
OSC arguments
OSC arguments may be any of the following types:
i | 32-bit integer |
f | 32-bit floating point |
s | OSC string |
F | Boolean false |
T | Boolean true |
h | 64-bit integer |
Note
Because some clients do not adhere to the OSC protocol governing argument types, GALAXY is programmed to type cast from integer to Boolean. For example, Boolean True is any positive non-zero integer.
Using the GALAXY server for ASCII
The GALAXY ASCII server is always listening on port 25003. When the message asks for a response, GALAXY will reply within the established connection to the client’s address.
Subscriptions for TCP clients remain active until they are revoked by an unsubscribe command, or until the client’s TCP connection is broken.
ASCII text messages are sent to port 25003 unless you address a virtual GALAXY procesor in normal mode, starting at port 50503. Decrement the port address by 100 for each virtual GALAXY processor in normal mode. Increment the port address by 100 for each virtual GALAXY processor in Spacemap mode.
All ASCII built-in functions are preceded by “:” as shown below:
:recall_snapshot 3
Note
All ASCII text commands must end with the newline character, which consists of a carriage return (CR) or line feed (LF): 0d
or 0a
Galaxy programming
This section describes how to:
construct built-in commands
query and set control points
Built-in functionality
All of GALAXY’s built-in, external control functions manipulate snapshots (except ping), and assume the specified snapshot already exists (except create_snapshot). Each function explanation includes ASCII and OSC examples.
recall_snapshot
Recalls the snapshot specified by the integer argument. For example, to recall snapshot 3 on a GALAXY module:
ASCII MSG | :recall_snapshot 3 |
---|---|
ASCII Hex | 3a 72 65 63 61 6c 6c 5f 73 6e 61 70 73 68 6f 74 20 33 0a |
OSC MSG | /recall_snapshot,i 3 |
UDP OSC | 2f 72 65 63 61 6c 6c 5f 73 6e 61 70 73 68 6f 74 00 00 00 00 2c 69 00 00 00 00 00 03 |
TCP OSC | 00 00 00 1c 2f 72 65 63 61 6c 6c 5f 73 6e 61 70 73 68 6f 74 00 00 00 00 2c 69 00 00 00 00 00 03 |
Excluding snapshot settings
It is possible to exclude some settings when recalling a snapshot. This is done by appending a second integer argument after the snapshot ID. A value of 1 enables exclusion. Add 1 to each exclusion code shown in the table below to exclude that entity.
For example:
If the second integer argument is 1, exclusion is enabled but nothing is excluded. The snapshot is recalled with all settings.
If the second integer argument is 9, mute information is excluded. 1 signifies that exclusion is active, and 8 is the exclusion code. To recall snapshot 3 without mute settings:
ASCII MSG | :recall_snapshot 3 9 |
---|---|
ASCII Hex | 3a 72 65 63 61 6c 6c 5f 73 6e 61 70 73 68 6f 74 20 33 20 39 20 0a |
OSC MSG | /recall_snapshot,i 3 9 |
UDP OSC | 2f 72 65 63 61 6c 6c 5f 73 6e 61 70 73 68 6f 74 00 00 00 00 2c 69 69 00 00 00 00 03 00 00 00 09 |
TCP OSC | 00 00 00 20 2f 72 65 63 61 6c 6c 5f 73 6e 61 70 73 68 6f 74 00 00 00 00 2c 69 69 00 00 00 00 03 00 00 00 09 |
The following table shows the exclusion codes to use for each setting.
Exclusion Code | Excluded Setting |
---|---|
1 | Exclusion enabled, but nothing excluded |
2 | Input Channel Types |
4 | Input and Output Voltage Ranges |
8 | Input and Output Mute |
16 | Update active snapshot before recall |
32 | SIM3 Bus Address |
64 | SIM3 Probe Point |
128 | Clock Sync Mode |
256 | AVB Configuration |
Exclusion codes can be added together to exclude multiple types. For example:
To exclude everything but still save the active snapshot before recall, add all exclusion codes, which corresponds to updating the active snapshot: 1+2+4+8+16+32+64+128+256 = 511
update_snapshot
Updates all settings in the specified snapshot to current values. To update snapshot 6 to current device settings:
ASCII MSG | :update_snapshot 6 |
---|---|
ASCII Hex | 3a 75 70 64 61 74 65 5f 73 6e 61 70 73 68 6f 74 20 36 0a |
OSC MSG | /update_snaphot,i 6 |
UDP OSC | 2f 75 70 64 61 74 65 5f 73 6e 61 70 73 68 6f 74 00 00 00 00 2c 69 00 00 00 00 00 06 |
TCP OSC | 00 00 00 1c 2f 75 70 64 61 74 65 5f 73 6e 61 70 73 68 6f 74 00 00 00 00 2c 69 00 00 00 00 00 06 |
create_snapshot
Creates a new snapshot that contains the current control point settings. If one string argument is present, it is used as the new snapshot’s name. If a second string argument is present, it is used as the new snapshot’s comment.
To create a new snapshot named Sample with comment Hello:
ASCII MSG | :create_snapshot Sample Hello |
ASCII Hex | 3a 63 72 65 61 74 65 5f 73 6e 61 70 73 68 6f 74 20 53 61 6d 70 6c 65 20 48 65 6c 6c 6f 0a |
OSC MSG | /create_snapshot,ss Sample Hello |
UDP OSC | 2f 63 72 65 61 74 65 5f 73 6e 61 70 73 68 6f 74 00 00 00 00 2c 73 73 00 53 61 6d 70 6c 65 00 00 48 65 6c 6c 6f 00 00 00 |
TCP OSC | 00 00 00 28 2f 63 72 65 61 74 65 5f 73 6e 61 70 73 68 6f 74 00 00 00 00 2c 73 73 00 53 61 6d 70 6c 65 00 00 48 65 6c 6c 6f 00 00 00 |
delete_snapshot
Deletes an existing snapshot identified by the integer argument. To delete snapshot 6 from GALAXY memory:
ASCII MSG | :delete_snapshot 6 |
---|---|
ASCII Hex | 3a 64 65 6c 65 74 65 5f 73 6e 61 70 73 68 6f 74 20 36 0a |
OSC MSG | /delete_snapshot,i 6 |
UDP OSC | 2f 64 65 6c 65 74 65 5f 73 6e 61 70 73 68 6f 74 00 00 00 00 2c 68 00 00 00 00 00 00 00 00 00 06 |
TCP OSC | 00 00 00 20 2f 64 65 6c 65 74 65 5f 73 6e 61 70 73 68 6f 74 00 00 00 00 2c 68 00 00 00 00 00 00 00 00 00 06 |
ping
Send a ping command without an argument to maintain a current subscription.
ASCII MSG | :ping Hello World |
---|---|
ASCII Hex | 3a 70 69 6e 67 20 48 65 6c 6c 6f 20 57 6f 72 6c 64 0a |
OSC MSG | /ping,s Hello World |
UDP OSC | 2f 70 69 6e 67 00 00 00 2c 73 00 00 48 65 6c 6c 6f 20 57 6f 72 6c 64 00 |
TCP OSC | 00 00 00 18 2f 70 69 6e 67 00 00 00 2c 73 00 00 48 65 6c 6c 6f 20 57 6f 72 6c 64 00 |
After issuing a ping command, you will receive a pong response. Note that you cannot send a pong command. Attach a keyword(s) so you can identify the pong response to your ping command.
ASCII MSG | :pong Hello World |
---|---|
ASCII Hex | 3a 70 6f 6e 67 20 48 65 6c 6c 6f 20 57 6f 72 6c 64 0a |
OSC MSG | /pong,s Hello World |
UDP OSC | 2f 70 6f 6e 67 00 00 00 2c 73 00 00 48 65 6c 6c 6f 20 57 6f 72 6c 64 00 |
TCP OSC | 00 00 00 18 2f 70 6f 6e 67 00 00 00 2c 73 00 00 48 65 6c 6c 6f 20 57 6f 72 6c 64 00 |
?
Defines built-in GALAXY functionality. The resultant list, while extensive, is a subset of the full GALAXY commands, but may be viewed as a developer’s quick reference.
ASCII MSG | :? |
---|---|
ASCII Hex | 3a 3f 0a |
OSC MSG | N/A |
UDP OSC | N/A |
TCP OSC | N/A |
?
Defines built-in GALAXY functionality. The resultant list, while extensive, is a subset of the full GALAXY commands, but may be viewed as a developer’s quick reference.
ASCII MSG | :? |
---|---|
ASCII Hex | 3a 3f 0a |
OSC MSG | N/A |
UDP OSC | N/A |
TCP OSC | N/A |
Control point functions
The table below shows the ASCII control character used to enact each Function that sets or retrieves a control point value.
ASCII control character | Function |
---|---|
= | Set control point Value |
Get control point Value | |
? | Get control point Description |
+ | Subscribe to control point |
- | Unsubscribe from control point |
Set control point value (=)
Sets one or more control points to one or more values. The arguments indicate a set of one or more control point addresses, followed by a list of one or more control point values. The control point values are assigned to the control point addresses in the order listed. Note that the “=” control character is appended at the end of the address.
To mute input 1:
ASCII MSG | /processing/input/1/mute=true |
---|---|
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 3d 74 72 75 65 0a |
OSC MSG | /processing/input/1/mute,T |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 54 00 00 |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 54 00 00 |
Get control point value
Retrieves the current value of a control point. Note that this function does not use a control character. Just specify the control point address as shown below.
To query the mute status of input 1:
ASCII MSG | /processing/input/1/mute |
---|---|
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 3d 74 72 75 65 0a |
OSC MSG | /processing/input/1/mute, |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 00 00 00 |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 00 00 00 |
The mute status of input 1 returns:
ASCII MSG | /processing/input/1/mute=false |
---|---|
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 3d 66 61 6c 73 65 0a |
OSC MSG | /processing/input/1/mute,F |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 46 00 00 |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 46 00 00 |
In OSC, if the get control point value was received from a:
TCP stream: The return packets are sent back to that TCP stream.
UDP packets: The return packets are sent back to the same IP address and port from which it was sent.
Get control point description (?)
Retrieves the current value and range of possible values of a control point. All control point types are shown in Control points, but this command lists all possible values, not just the default value.
To request the control point description for Input 1 Mute:
ASCII MSG | ?/processing/input/1/mute |
---|---|
ASCII Hex | 3f 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 0a |
OSC MSG | NA |
UDP OSC | NA |
TCP OSC | NA |
The control point description for Input 1 Mute is returned:
ASCII MSG | ?{'/processing/input/1/mute': { 'description' : 'Input 1 Mute', 'read_only' : 'false', 'name' : 'item_1_1', 'value' : 'false', 'minimum' : 'true', 'maximum' : 'false', 'default' : 'false', 'step' : '255', 'units' : ''}} |
---|---|
3f 7b 27 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 27 3a | |
20 7b 20 27 64 65 73 63 72 69 70 74 69 6f 6e 27 20 3a 20 27 49 6e 70 75 74 20 31 20 | |
4d 75 74 65 27 2c 20 27 72 65 61 64 5f 6f 6e 6c 79 27 20 3a 20 27 66 61 6c 73 65 27 | |
ASCII Hex | 2c 20 27 6e 61 6d 65 27 20 3a 20 27 69 74 65 6d 5f 31 5f 31 27 2c 20 27 76 61 6c 75 65 27 20 3a 20 27 66 61 6c 73 65 27 2c 20 27 6d 69 6e 69 6d 75 6d 27 20 3a 20 27 74 |
72 75 65 27 2c 20 27 6d 61 78 69 6d 75 6d 27 20 3a 20 27 66 61 6c 73 65 27 2c 20 27 | |
64 65 66 61 75 6c 74 27 20 3a 20 27 66 61 6c 73 65 27 2c 20 27 73 74 65 70 27 20 3a | |
20 27 32 35 35 27 2c 20 27 75 6e 69 74 73 27 20 3a 20 27 27 7d 7d 20 | |
OSC MSG | NA |
UDP OSC | NA |
TCP OSC | NA |
Subscribe to control point (+)
This command subscribes to a set of control point addresses for live updates, which allows the client to keep track of the current state of the specified addresses, without constantly querying their state.
Note that subscriptions are handled per control point address, so it is possible to build up your subscription set via multiple subscribe commands. You can also unsubscribe from a single control point or an arbitrary subset at any time.
A client cannot subscribe to the same control point more than once. Trying to subscribe to a control point to which you already subscribed causes the server to re-send the control point’s current value, but has no other effect.
Subscriptions for TCP clients remain active until they are countermanded by an unsubscribe command, or until the client’s TCP connection is broken.
A UDP subscription remains active until it is countermanded by an unsubscribe command, or the server does not receive any UDP packets from the client for at least 30 seconds. To keep a UDP subscription active in the absence of GALAXY activity, use the keepalive tactic by sending an empty ping OSC message to the server.
Subscribe commands can take an optional argument that sets the time between values being returned. If no value is included, the default update rate is 30 ms. The time range for updates can be 0-100 ms. If your control point changes at a faster rate than your setting, your update rate determines how often you receive new values. Conversely, if your control point changes at a slower rate than your setting, values are returned only when the control point value changes.
To subscribe to Input 1 Mute status with an update rate of 100 ms:
ASCII MSG | +/processing/input/1/mute 100 |
---|---|
ASCII Hex | 2b 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 20 31 30 30 0a |
OSC MSG | /subscribe/processing/input/1/mute,i 100 |
UDP OSC | 2f 73 75 62 73 63 72 69 62 65 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 2c 69 00 00 00 00 00 64 |
TCP OSC | 00 00 00 2c 2f 73 75 62 73 63 72 69 62 65 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 2c 69 00 00 00 00 00 64 |
Unsubscribe from control point (-)
This command has the same syntax as subscribe but the opposite effect: it unsubscribes from a set of control point addresses. Subscription records for all control point addresses specified in this command that are currently subscribed to by this client will be removed from the server. This command does not affect control points that your client is not currently subscribed to.
To unsubscribe from Input 1 mute state:
ASCII MSG | -/processing/input/1/mute |
---|---|
ASCII Hex | 2d 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 0a |
OSC MSG | /unsubscribe/processing/input/1/mute, |
UDP OSC | 2f 75 6e 73 75 62 73 63 72 69 62 65 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 00 00 00 |
TCP OSC | 00 00 00 2c 2f 75 6e 73 75 62 73 63 72 69 62 65 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 00 00 00 |
Command | Type | String |
---|---|---|
Mute Output 1 | ASCII MSG | /processing/output/1/mute=true |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 3d 74 72 75 65 0a | |
OSC MSG | /processing/output/1/mute, T | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 2c 54 00 00 | |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 2c 54 00 00 | |
Unmute Output 1 | ASCII MSG | /processing/output/1/mute=false |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 3d 66 61 6c 73 65 0a | |
OSC MSG | /processing/output/1/mute, F | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 2c 46 00 00 | |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 2c 46 00 00 | |
Mute Input 1 | ASCII MSG | /processing/input/1/mute=true |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 3d 74 72 75 65 0a | |
OSC MSG | /processing/input/1/mute, T | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 54 00 00 | |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 54 00 00 | |
Unmute Input 1 | ASCII MSG | /processing/input/1/mute=false |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 3d 66 61 6c 73 65 0a | |
OSC MSG | /processing/input/1/mute, F | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 46 00 00 | |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 46 00 00 | |
Set Input 1 gain to -90 dB (-inf) | ASCII MSG | /processing/input/1/gain=-90 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 3d 2d 39 30 0a | |
OSC MSG | /processing/input/1/gain,f -90.0 | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 00 2c 66 00 00 c2 b4 00 00 | |
TCP OSC | 00 00 00 24 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 00 2c 66 00 00 c2 b4 00 00 |
Command | Type | String |
---|---|---|
Set Input 1 gain to 0 dB (unity) | ASCII MSG | /processing/input/1/gain=0 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 3d 30 0a | |
OSC MSG | /processing/input/1/gain,f 0.0 | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 00 2c 66 00 00 00 00 00 00 | |
TCP OSC | 00 00 00 24 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 00 2c 66 00 00 00 00 00 00 | |
Set Output 1 gain to -90 dB (-inf) | ASCII MSG | /processing/output/1/gain=-90 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 3d 2d 39 30 0a | |
OSC MSG | /processing/output/1/gain,f -90.0 | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 2c 66 00 00 c2 b4 00 00 | |
TCP OSC | 00 00 00 24 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 2c 66 00 00 c2 b4 00 00 | |
Set Output 1 gain to 0 dB (unity) | ASCII MSG | /processing/output/1/gain=0 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 3d 30 0a | |
OSC MSG | /processing/output/1/gain,f 0.0 | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 2c 66 00 00 00 00 00 00 | |
TCP OSC | 00 00 00 24 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 2c 66 00 00 00 00 00 00 | |
All Outputs Mute Note: ([1-9]|1[0-6]) equals 1-9, 10-16 | ASCII MSG | /processing/output/([1-9]|1[0-6])/mute=1 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 3d 31 0a | |
OSC MSG | /processing/output/([1-9]|1[0-6])/mute, T | |
UDP OSC | ?2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 00 00 2c 69 00 00 00 00 00 00 | |
TCP OSC | ?00 00 00 30 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 00 00 2c 69 00 00 00 00 00 00 | |
Outputs 1-8 and 11- 16 Muted & Output 9-10 Unmuted | ASCII MSG | /processing/output/([1-8]|1[1-6])/mute=0 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 38 5d 7c 31 5b 31 2d 36 5d 29 2f 6d 75 74 65 3d 30 0a | |
OSC MSG | /processing/output/([1-8]|1[1-6])/mute, F | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 38 5d 7c 31 5b 31 2d 36 5d 29 2f 6d 75 74 65 00 00 2c 69 00 00 00 00 00 01 | |
TCP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 38 5d 7c 31 5b 31 2d 36 5d 29 2f 6d 75 74 65 00 00 2c 69 00 00 00 00 00 01 |
ASCII and OSC command examples
Command | Type | String |
---|---|---|
Mute output 1 | ASCII MSG | /processing/output/1/mute=true |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 3d 74 72 75 65 0a | |
OSC MSG | /processing/output/1/mute, T | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 2c 54 00 00 | |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 2c 54 00 00 | |
Unmute output 1 | ASCII MSG | /processing/output/1/mute=false |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 3d 66 61 6c 73 65 0a | |
OSC MSG | /processing/output/1/mute, F | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 2c 46 00 00 | |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 2c 46 00 00 | |
Mute input 1 | ASCII MSG | /processing/input/1/mute=true |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 3d 74 72 75 65 0a | |
OSC MSG | /processing/input/1/mute, T | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 54 00 00 | |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 54 00 00 | |
Unmute input 1 | ASCII MSG | /processing/input/1/mute=false |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 3d 66 61 6c 73 65 0a | |
OSC MSG | /processing/input/1/mute, F | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 46 00 00 | |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 6d 75 74 65 00 00 00 00 2c 46 00 00 | |
Set input 1 gain to -90 dB (-inf) | ASCII MSG | /processing/input/1/gain=-90 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 3d 2d 39 30 0a | |
OSC MSG | /processing/input/1/gain,f -90.0 | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 00 2c 66 00 00 c2 b4 00 00 | |
TCP OSC | 00 00 00 24 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 00 2c 66 00 00 c2 b4 00 00 |
Command | Type | String |
---|---|---|
Set input 1 gain to 0 dB (unity) | ASCII MSG | /processing/input/1/gain=0 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 3d 30 0a | |
OSC MSG | /processing/input/1/gain,f 0.0 | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 00 2c 66 00 00 00 00 00 00 | |
TCP OSC | 00 00 00 24 2f 70 72 6f 63 65 73 73 69 6e 67 2f 69 6e 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 00 2c 66 00 00 00 00 00 00 | |
Set output 1 gain to -90 dB (-inf) | ASCII MSG | /processing/output/1/gain=-90 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 3d 2d 39 30 0a | |
OSC MSG | /processing/output/1/gain,f -90.0 | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 2c 66 00 00 c2 b4 00 00 | |
TCP OSC | 00 00 00 24 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 2c 66 00 00 c2 b4 00 00 | |
Set output 1 gain to 0 dB (unity) | ASCII MSG | /processing/output/1/gain=0 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 3d 30 0a | |
OSC MSG | /processing/output/1/gain,f 0.0 | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 2c 66 00 00 00 00 00 00 | |
TCP OSC | 00 00 00 24 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 31 2f 67 61 69 6e 00 00 00 2c 66 00 00 00 00 00 00 | |
All outputs mute note: ([1-9]|1[0-6]) equals 1-9, 10-16 | ASCII MSG | /processing/output/([1-9]|1[0-6])/mute=1 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 3d 31 0a | |
OSC MSG | /processing/output/([1-9]|1[0-6])/mute, T | |
UDP OSC | ?2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 00 00 2c 69 00 00 00 00 00 00 | |
TCP OSC | ?00 00 00 30 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 00 00 2c 69 00 00 00 00 00 00 | |
Outputs 1-8 and 11- 16 muted & output 9-10 unmuted | ASCII MSG | /processing/output/([1-8]|1[1-6])/mute=0 |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 38 5d 7c 31 5b 31 2d 36 5d 29 2f 6d 75 74 65 3d 30 0a | |
OSC MSG | /processing/output/([1-8]|1[1-6])/mute, F | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 38 5d 7c 31 5b 31 2d 36 5d 29 2f 6d 75 74 65 00 00 2c 69 00 00 00 00 00 01 | |
TCP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 38 5d 7c 31 5b 31 2d 36 5d 29 2f 6d 75 74 65 00 00 2c 69 00 00 00 00 00 01 |
Control Points
Processing
Input
Input Processing control points
Note
Although shown using Input 1 to illustrate format, Input can be: 1-8.
Control Point | Default Value |
---|---|
/processing/input/1/delay | '0' |
/processing/input/1/delay_type | '0' |
/processing/input/1/eq/1/band_bypass | false' |
/processing/input/1/eq/1/bandwidth | '1' |
/processing/input/1/eq/1/frequency | 32' |
/processing/input/1/eq/1/gain | '0' |
/processing/input/1/eq/2/band_bypass | 'false' |
/processing/input/1/eq/2/bandwidth | '1' |
/processing/input/1/eq/2/frequency | '125' |
/processing/input/1/eq/2/gain | '0' |
/processing/input/1/eq/3/band_bypass | 'false' |
/processing/input/1/eq/3/bandwidth | '1' |
/processing/input/1/eq/3/frequency | 500' |
/processing/input/1/eq/3/gain | '0' |
/processing/input/1/eq/4/band_bypass | 'false' |
/processing/input/1/eq/4/bandwidth | '1' |
/processing/input/1/eq/4/frequency | '2000' |
/processing/input/1/eq/4/gain | '0' |
/processing/input/1/eq/5/band_bypass | 'false' |
/processing/input/1/eq/5/bandwidth | '1' |
/processing/input/1/eq/5/frequency | '8000' |
/processing/input/1/eq/5/gain | '0' |
/processing/input/1/eq/bypass | 'false' |
/processing/input/1/equalization_bypass | 'false' |
/processing/input/1/gain | '0' |
/processing/input/1/mute | 'true' |
/processing/input/1/ushaping/1/frequency | '62' |
/processing/input/1/ushaping/1/gain | '0' |
/processing/input/1/ushaping/1/slope | '2' |
/processing/input/1//ushaping/2/frequency | '250' |
/processing/input/1/ushaping/2/gain | '0' |
/processing/input/1/ushaping/2/slope | '2' |
/processing/input/1/ushaping/3/frequency | '1000' |
/processing/input/1/ushaping/3/gain | '0' |
/processing/input/1/ushaping/3/slope | '2' |
/processing/input/1/ushaping/4/frequency | '4000' |
/processing/input/1/ushaping/4/gain | '0' |
/processing/input/1/ushaping/4/slope | '2' |
/processing/input/1/ushaping/5/gain | '0' |
/processing/input/1/ushaping/bypass | 'false' |
Output
Note
Although shown using only Output 1 to illustrate processing control point format, Output can be: 1-16.
Control Point | Default Value |
---|---|
/processing/output/1/atmospheric/bypass | 'true' |
/processing/output/1/atmospheric/distance | '0' |
/processing/output/1/atmospheric/gain | '10' |
/processing/output/1/delay | '0' |
/processing/output/1/delay_type | '0' |
/processing/output/1/eq/1/band_bypass | 'false' |
/processing/output/1/eq/1/bandwidth | '1' |
/processing/output/1/eq/1/frequency | '32' |
/processing/output/1/eq/1/gain | '0' |
/processing/output/1/eq/2/band_bypass | 'false' |
/processing/output/1/eq/2/bandwidth | '1' |
/processing/output/1/eq/2/frequency | '63' |
/processing/output/1/eq/2/gain | '0' |
/processing/output/1/eq/3/band_bypass | 'false' |
/processing/output/1/eq/3/bandwidth | '1' |
/processing/output/1/eq/3/frequency | '125' |
/processing/output/1/eq/3/gain | '0' |
/processing/output/1/eq/4/band_bypass | 'false' |
/processing/output/1/eq/4/bandwidth | '1' |
/processing/output/1/eq/4/frequency | '250' |
/processing/output/1/eq/4/gain | '0' |
/processing/output/1/eq/5/band_bypass | 'false' |
/processing/output/1/eq/5/bandwidth | '1' |
/processing/output/1/eq/5/frequency | '500' |
/processing/output/1/eq/5/gain | '0' |
/processing/output/1/eq/6/band_bypass | 'false' |
/processing/output/1/eq/6/bandwidth | '1' |
/processing/output/1/eq/6/frequency | '1000' |
/processing/output/1/eq/6/gain | '0' |
/processing/output/1/eq/7/band_bypass | 'false' |
/processing/output/1/eq/7/bandwidth | '1' |
/processing/output/1/eq/7/frequency | '2000' |
/processing/output/1/eq/7/gain | '0' |
/processing/output/1/eq/8/band_bypass | 'false' |
/processing/output/1/eq/8/bandwidth | '1' |
/processing/output/1/8/frequency | '4000' |
/processing/output/1/eq/8/gain | '0' |
/processing/output/1/eq/9/band_bypass | 'false' |
/processing/output/1/eq/9/bandwidth | '1' |
/processing/output/1/eq/9/frequency | '8000' |
/processing/output/1/eq/9/gain | '0' |
/processing/output/1/eq/10/band_bypass | 'false' |
/processing/output/1/eq/10/bandwidth | '1' |
/processing/output/1/eq/10/frequency | '16000' |
/processing/output/1/eq/10/gain | '0' |
/processing/output/1/eq/bypass | 'false' |
/processing/output/1/equalization_bypass | 'false' |
/processing/output/1/gain | '0' |
/processing/output/1/highpass/bypass | true' |
/processing/output/1/highpass/frequency | 40' |
/processing/output/1/highpass/type | '11' |
/processing/output/1/lowpass/bypass | true' |
/processing/output/1/lowpass/frequency | 160' |
/processing/output/1/lowpass/type | '11' |
/processing/output/1/mute | 'false' |
/processing/output/1/polarity_reversal | 'false' |
/processing/output/1/ushaping/1/frequency | '62' |
/processing/output/1/ushaping/1/gain | '0' |
/processing/output/1/ushaping/1/slope | '2' |
/processing/output/1/ushaping/2/frequency | '250' |
/processing/output/1/ushaping/2/gain | '0' |
/processing/output/1/ushaping/2/slope | '2' |
/processing/output/1/ushaping/3/frequency | '1000' |
/processing/output/1/ushaping/3/gain | '0' |
/processing/output/1/ushaping/3/slope | '2' |
/processing/output/1/ushaping/4/frequency | '4000' |
/processing/output/1/ushaping/4/gain | '0' |
/processing/output/1/ushaping/4/slope | '2' |
/processing/output/1/ushaping/5/gain | '0' |
/processing/output/1/ushaping/bypass | 'false' |
Matrix
Note
Although shown using only matrix input 1 to illustrate processing matrix control point format, input can be: 1-32; outputs (cross points) can be: 1–16.
Only matrix input 1, cross points 1- 8 and input 2, cross points 9-16 have gain defaulting to ‘0’; all others default to a gain setting of ‘-90’ (2:).
The maximum number of matrix cross points that may be set simultaneously is 232.
Control Point | Default |
---|---|
/processing/matrix/Matrix | '' |
/processing/matrix/1/1/delay | '0' |
/processing/matrix/1/1/delay_bypass | ‘false’ |
/processing/matrix/1/1/delay_type | '0' |
/processing/matrix/1/1/gain | '0' |
System
System control points
control point | Default Value |
---|---|
/system/firmware/code | '0' |
/system/firmware/status_string | '' |
/system/firmware/status | '0' |
/system/hardware/front_panel_lockout | 'false' |
/system/meter/demo/active | 'false' |
/system/mode/running | 'true' |
/system/network/1/static/gateway | '192.168.0.1' |
/system/network/1/static/ip_address | '192.168.0.2' |
/system/network/1/static/net_mask | '255.255.255.0' |
/system/network/1/type | '0' |
/system/network/2/static/gateway | '192.168.0.1' |
/system/network/2/static/ip_address | '192.168.0.3' |
/system/network/2/static/net_mask | '255.255.255.0' |
/system/network/2/type | '0' |
Device
Control point | Default value |
---|---|
/device/preferences/brightness | '1' |
/device/preferences/display_color | '3' |
Control point | Default value |
---|---|
/device/sim/bus_address | '10' |
/device/sim/configured | 'false' |
/device/sim/mute_relay/1 | 'true' |
/device/sim/mute_relay/2 | 'true' |
/device/sim/mute_relay/3 | 'true' |
/device/sim/mute_relay/4 | 'true' |
/device/sim/probe/1/channel | '1' |
/device/sim/probe/1/point | '2' |
/device/sim/probe/2/channel | '1' |
/device/sim/probe/2/point | '4' |
Input
Processed inputs
Note
Although shown using only Input 1 to illustrate device input starting point format, input can be: 1-8; name defaults are correspondingly A-H
Control point | Default value |
---|---|
/device/input/1/aes/enable_asrc | 'true' |
/device/input/1/input_link_group | '0' |
/device/input/1/isolate | 'false' |
/device/input/1/mode | '1' |
/device/input/1/name | 'Input A' |
/device/input/1/scale | '26' |
/device/input/1/select | 'false' |
Note
Although shown using only ‘9’ to illustrate device matrix input control point format, matrix input number can be: 9—32.
Control point | Default value |
---|---|
/device/input/9/input_link_group | '0' |
/device/input/9/mode | '4' |
/device/input/9/name | 'Matrix In 9' |
/device/input/9/select | 'false' |
Control point | Default value |
---|---|
/device/input_link_group/1/bypass | 'true' |
/device/input_link_group/1/name | 'Group 1' |
/device/input_link_group/2/bypass | 'true' |
/device/input_link_group/2/name | 'Group 2' |
/device/input_link_group/3/bypass | 'true' |
/device/input_link_group/3/name | 'Group 3' |
/device/input_link_group/4/bypass | 'true' |
/device/input_link_group/4/name | 'Group 4' |
Control point | Default value |
---|---|
/device/input/avb/controller_mode | '0' |
Output
Note
Although shown using only output 1 to illustrate device output control format, output can be: 1-16.
Control point | Default value |
---|---|
/device/output/1/isolate | 'false' |
/device/output/1/mute_relay | 'false' |
/device/output/1/name | 'Output 1' |
/device/output/1/output_link_group | '0' |
/device/output/1/scale | '26' |
/device/output/1/select | 'false' |
/device/output/1/sim/trim | '0' |
Control point | Default value |
---|---|
/device/output_link_group/1/bypass | 'true' |
/device/output_link_group/1/name | 'Group 1' |
/device/output_link_group/2/bypass | 'true' |
/device/output_link_group/2/name | 'Group 2' |
/device/output_link_group/3/bypass | 'true' |
/device/output_link_group/3/name | 'Group 3' |
/device/output_link_group/4/bypass | 'true' |
/device/output_link_group/4/name | 'Group 4' |
/device/output_link_group/5/bypass | 'true' |
/device/output_link_group/5/name | 'Group 5' |
/device/output_link_group/6/bypass | 'true' |
/device/output_link_group/6/name | 'Group 6' |
/device/output_link_group/7/bypass | 'true' |
/device/output_link_group/7/name | 'Group 7' |
/device/output_link_group/8/bypass | 'true' |
/device/output_link_group/8/name | 'Group 8' |
Control point | Default value |
---|---|
/device/output/avb/presentation_time | '2000000' |
Note
Although shown using only output 1 to illustrate device output control format, output can be: 1-16.
Control point | Default value |
---|---|
/device/output/atmospheric/altitude | '0' |
Control point | Default value |
---|---|
/device/output/atmospheric/humidity | '50' |
/device/output/atmospheric/temperature | '293.15' |
Project
Note
Although shown using only Snapshot 0 and 1 to illustrate snapshot control point format, snapshots can be: 0-255.
Control Point | Default Value |
---|---|
/project/boot_snapshot_id | '3' |
/project/metadata/content_type | '2' |
/project/metadata/schema_version | '10' |
/project/name | 'Default' |
/project/project_firmware_version | 'none' |
/project/snapshot/0/comment | 'All settings are set to default values' |
/project/snapshot/0/created | '2018-11-05 22:58:07' |
/project/snapshot/0/last_updated | '2018-11-05 22:58:07' |
/project/snapshot/0/locked | 'true' |
/project/snapshot/0/modified | 'false' |
/project/snapshot/0/name | 'Factory Defaults' |
/project/snapshot/1/comment | '' |
/project/snapshot/1/created | '' |
/project/snapshot/1/last_updated | '' |
/project/snapshot/1/locked | 'false' |
/project/snapshot/1/modified | 'false' |
/project/snapshot/1/name | '' |
/project/snapshot/active/comment | '' |
/project/snapshot/active/created | '2018-11-05 22:58:08' |
/project/snapshot/active/id | '-1' |
/project/snapshot/active/last_updated | '2018-11-05 22:58:08' |
/project/snapshot/active/locked | 'true' |
/project/snapshot/active/modified | 'true' |
/project/snapshot/active/name | 'No snapshot selected' |
Entity
Note
Only input_channel_count, input_stream_count, output_channel_count, and output_stream_count default values are consistent across all GALAXY devices. All other entity default values are representative only, as this data will be unique to each GALAXY.
Control Point | Default Value |
---|---|
/entity/entity_id | 0x1cabfffe008d80' |
/entity/entity_model_id | '0x1cabb804004005' |
/entity/entity_name | 'GALAXY-18139889 |
/entity/firmware_version | '2.1.0-R4-1907032112' |
/entity/group_name | GALAXYs' |
/entity/input_channel_count | '64' |
/entity/input_stream_count | '18' |
/entity/output_channel_count | '24' |
/entity/output_stream_count | '14' |
/entity/serial_number | '18139889' |
Status
Beam control input source status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Although shown using only AVB Input 1 status to illustrate AVB Input Status control point format, inputs can be: 1–32.
/status/beam_control_input_source | '0' |
AES output clock status
Control point | Default value |
---|---|
/status/clock/aes_output/input_number | '1' |
/status/clock/aes_output/sample_rate | '96000' |
/status/clock/aes_output/source | '0' |
/status/clock/aes_output/sync | '2' |
gPTP clock status
Note
Status commands are read only results, which may differ from device to device; trying to set status will result in an error message.
Control point | Default value |
---|---|
/status/clock/gptp/1/as_capable | 'false' |
/status/clock/gptp/1/as_path/1/trace_id | '' |
/status/clock/gptp/1/as_path/2/trace_id | '' |
/status/clock/gptp/1/as_path/3/trace_id | '' |
/status/clock/gptp/1/as_path/4/trace_id | '' |
/status/clock/gptp/1/as_path/5/trace_id | '' |
/status/clock/gptp/1/as_path/6/trace_id | '' |
/status/clock/gptp/1/as_path/7/trace_id | '' |
/status/clock/gptp/1/as_path/8/trace_id | '' |
/status/clock/gptp/1/as_path/9/trace_id | '' |
/status/clock/gptp/1/as_path/10/trace_id | '' |
/status/clock/gptp/1/as_path/11/trace_id | '' |
/status/clock/gptp/1/as_path/12/trace_id | '' |
/status/clock/gptp/1/as_path/13/trace_id | '' |
/status/clock/gptp/1/as_path/14/trace_id | '' |
/status/clock/gptp/1/as_path/15/trace_id | '' |
/status/clock/gptp/1/as_path/16/trace_id | '' |
/status/clock/gptp/1/as_path/17/trace_id | '' |
/status/clock/gptp/1/as_path/18/trace_id | '' |
/status/clock/gptp/1/as_path/trace_length | '0' |
/status/clock/gptp/1/grand_master_id | '00-1C-AB-FF-FE-00-8D-80' |
/status/clock/gptp/1/peer_delay | '0' |
/status/clock/gptp/1/port_locked | 'true' |
/status/clock/gptp/1/port_role | '3' |
/status/clock/gptp/2/as_capable | 'false' |
/status/clock/gptp/2/as_path/1/trace_id | '' |
/status/clock/gptp/2/as_path/2/trace_id | '' |
/status/clock/gptp/2/as_path/3/trace_id | '' |
/status/clock/gptp/2/as_path/4/trace_id | '' |
/status/clock/gptp/2/as_path/5/trace_id | '' |
/status/clock/gptp/2/as_path/6/trace_id | '' |
gPTP clock status
Note
Status commands are read only results, which may differ from device to device; trying to set status will result in an error.
Input clock status
Control point | Default value |
---|---|
/status/clock/input/1/sample_rate | '0' |
/status/clock/input/1/sync | '3' |
/status/clock/input/2/sample_rate | '0' |
/status/clock/input/2/sync | '3' |
/status/clock/input/3/sample_rate | '0' |
/status/clock/input/3/sync | '4' |
/status/clock/rtc/date_and_time | '2019-08-08T05:23:11' |
/status/clock/system/input_number | '1' |
/status/clock/system/sample_rate | '96000' |
/status/clock/system/source | '0' |
/status/clock/system/sync | '2' |
/status/clock/word_clock/sample_rate | '0' |
/status/clock/word_clock/sync | '3' |
/status/clock/word_clock/termination | '0' |
Connected client status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error.
Although shown using only Status of Clock Inputs 1, 2, and 3 to illustrate clock input status control point format, inputs can be: 1–32. Default values for inputs 1 and 2 are identical; default values for inputs 3- 32 are identical.
Control point | Default value |
---|---|
/status/connected_client_count | '3' |
/status/connected_osc_tcp_client_count | '0' |
/status/connected_osc_upd_client_count | '0' |
/status/connected_text_tcp_client_count | '3' |
Hardware board status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Shown using format for primary_io status to illustrate, but these commands may also be used instead with “secondary_io” at the same location in the command stream to obtain secondary I/O status.
Front panel and model status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Values shown in Salmon can range from 1– 8, values shown in Cyan can range from 1–16, values shown in blue can range from 1–32
Network and snapshot status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Status - AVB Clock Status Settings
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Control Point | Default Value |
---|---|
/status/avb/clock/1/connected_talker/channel_index | '-1' |
/status/avb/clock/1/connected_talker/channel_name | '' |
/status/avb/clock/1/connected_talker/connection_error | ' |
/status/avb/clock/1/connected_talker/entity_id | '0x0' |
/status/avb/clock/1/connected_talker/entity_name | '' |
/status/avb/clock/1/connected_talker/group_name | '' |
/status/avb/clock/1/connected_talker/presentation_time | '0' |
/status/avb/clock/1/connected_talker/sample_rate | '0' |
/status/avb/clock/1/connected_talker/stream_format | '0x0' |
/status/avb/clock/1/connected_talker/stream_index | '-1' |
/status/avb/clock/1/connected_talker/stream_name | '' |
/status/avb/clock/1/listener/channel_index | '-1' |
/status/avb/clock/1/listener/channel_name | '' |
/status/avb/clock/1/listener/early_timestamp_count | '0' |
/status/avb/clock/1/listener/late_timestamp_count | '0' |
/status/avb/clock/1/listener/media_locked | 'false' |
/status/avb/clock/1/listener/media_reset_count | '0' |
/status/avb/clock/1/listener/msrp_accumulated_latency | '0' |
/status/avb/clock/1/listener/presentation_time_margin | '0' |
/status/avb/clock/1/listener/sequence_mismatch_count | '0' |
/status/avb/clock/1/listener/stream_format | '0x41060010000bb80' |
/status/avb/clock/1/listener/stream_index | 8' |
/status/avb/clock/1/listener/stream_name | 'Clock Sink 1' |
/status/avb/clock/1/listener/stream_reset_count | '0' |
/status/avb/clock/1/listener/timestamp_uncertain_count | '0' |
/status/avb/clock/1/listener/unsupported_format_count | '0' |
/status/avb/clock/1/redundant_connected_talker/channel_index | '-1' |
/status/avb/clock/1/redundant_connected_talker/channel_name | '' |
/status/avb/clock/1/redundant_connected_talker/connection_error | '' |
/status/avb/clock/1/redundant_connected_talker/entity_id | '0x0' |
/status/avb/clock/1/redundant_connected_talker/entity_name | '' |
/status/avb/clock/1/redundant_connected_talker/group_name | '' |
/status/avb/clock/1/redundant_connected_talker/presentation_time | '0' |
/status/avb/clock/1/redundant_connected_talker/sample_rate | '0' |
/status/avb/clock/1/redundant_connected_talker/stream_format | '0x0' |
/status/avb/clock/1/redundant_connected_talker/stream_index | '-1' |
/status/avb/clock/1/redundant_connected_talker/stream_name | '' |
/status/avb/clock/1/redundant-listener/channel_index | '-1' |
/status/avb/clock/1/redundant-listener/channel_name | '' |
/status/avb/clock/1/redundant-listener/early_timestamp_count | '0' |
/status/avb/clock/1/redundant-listener/late_timestamp_count | '0' |
/status/avb/clock/1/redundant-listener/media_locked | 'false' |
/status/avb/clock/1/redundant-listener/media_reset_count | '0' |
/status/avb/clock/1/redundant-listener/msrp_accumulated_latency | '0' |
/status/avb/clock/1/redundant-listener/presentation_time_margin | '0' |
/status/avb/clock/1/redundant-listener/sequence_mismatch_count | '0' |
/status/avb/clock/1/redundant-listener/stream_format | '0x41060010000bb80' |
/status/avb/clock/1/redundant-listener/stream_index | '17' |
/status/avb/clock/1/redundant-listener/stream_name | 'Clock Sink 1' |
/status/avb/clock/1/redundant-listener/stream_reset_count | '0' |
/status/avb/clock/1/redundant-listener/timestamp_uncertain_count | '0' |
/status/avb/clock/1/redundant-listener/unsupported_format_count | '0' |
Status - AVB Input Status Settings
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Although shown using only AVB Input 1 status to illustrate AVB Input Status control point format, inputs can be: 1–32.
Control point | Default value |
---|---|
/status/avb/input/1/connected_talker/channel_index | '-1' |
/status/avb/input/1/connected_talker/channel_name | '' |
/status/avb/input/1/connected_talker/connection_error | '' |
/status/avb/input/1/connected_talker/entity_id | '0x0' |
/status/avb/input/1/connected_talker/entity_name | '' |
/status/avb/input/1/connected_talker/group_name | '' |
/status/avb/input/1/connected_talker/presentation_time | '0' |
/status/avb/input/1/connected_talker/sample_rate | '0' |
/status/avb/input/1/connected_talker/stream_format | '0x0' |
/status/avb/input/1/connected_talker/stream_index | '-1' |
/status/avb/input/1/connected_talker/stream_name | '' |
/status/avb/input/1/listener/channel_index | '-1' |
/status/avb/input/1/listener/channel_name | '' |
/status/avb/input/1/listener/early_timestamp_count | '0' |
/status/avb/input/1/listener/late_timestamp_count | '0' |
/status/avb/input/1/listener/media_locked | |
/status/avb/input/1/listener/media_reset_count | '0' |
/status/avb/input/1/listener/msrp_accumulated_latency | '0' |
/status/avb/input/1/listener/presentation_time_margin | '0' |
/status/avb/input/1/listener/sequence_mismatch_count | '0' |
/status/avb/input/1/listener/stream_format | '0x41060010000bb80' |
/status/avb/input/1/listener/stream_index | '8' |
/status/avb/input/1/listener/stream_name | 'Clock Sink 1' |
/status/avb/input/1/listener/stream_reset_count | '0' |
/status/avb/input/1/listener/timestamp_uncertain_count | '0' |
/status/avb/input/1/listener/unsupported_format_count | '0' |
/status/avb/input/1/redundant_connected_talker/channel_index | '-1' |
/status/avb/input/1/redundant_connected_talker/channel_name | '' |
/status/avb/input/1/redundant_connected_talker/connection_error | '' |
/status/avb/input/1/redundant_connected_talker/entity_id | '0x0' |
/status/avb/input/1/redundant_connected_talker/entity_name | '' |
/status/avb/input/1/redundant_connected_talker/group_name | '' |
/status/avb/input/1/redundant_connected_talker/presentation_time | '0' |
/status/avb/input/1/redundant_connected_talker/sample_rate | '0' |
/status/avb/input/1/redundant_connected_talker/stream_format | '0x0' |
/status/avb/input/1/redundant_connected_talker/stream_index | '-1' |
/status/avb/input/1/redundant_connected_talker/stream_name | '' |
/status/avb/input/1/redundant-listener/channel_index | '-1' |
/status/avb/input/1/redundant-listener/channel_name | '' |
/status/avb/input/1/redundant-listener/early_timestamp_count | '0' |
/status/avb/input/1/redundant-listener/late_timestamp_count | '0' |
/status/avb/input/1/redundant-listener/media_locked | 'false' |
/status/avb/input/1/redundant-listener/media_reset_count | '0' |
/status/avb/input/1/redundant-listener/msrp_accumulated_latency | '0' |
/status/avb/input/1/redundant-listener/presentation_time_margin | '0' |
/status/avb/input/1/redundant-listener/sequence_mismatch_count | '0' |
/status/avb/input/1/redundant-listener/stream_format | '0x41060010000bb80' |
/status/avb/input/1/redundant-listener/stream_index | '17' |
/status/avb/input/1/redundant-listener/stream_name | 'Clock Sink 1' |
/status/avb/input/1/redundant-listener/stream_reset_count | '0' |
/status/avb/input/1/redundant-listener/timestamp_uncertain_count | '0' |
/status/avb/input/1/redundant-listener/unsupported_format_count | '0' |
Status - Beam Control Input Source Status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Control Point | Default Value |
---|---|
/status/beam_control_input_source | '0' |
Status - AES Output Clock Status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Control Point | Default Value |
---|---|
/status/clock/aes_output/input_number | '1' |
/status/clock/aes_output/sample_rate | '96000' |
/status/clock/aes_output/source | '0' |
Status - gPTP Clock Status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Control Point | Default Value |
---|---|
/status/clock/gptp/1/as_capable | 'false' |
/status/clock/gptp/1/as_path/1/trace_id | '' |
/status/clock/gptp/1/as_path/2/trace_id | '' |
/status/clock/gptp/1/as_path/3/trace_id | '' |
/status/clock/gptp/1/as_path/4/trace_id | '' |
/status/clock/gptp/1/as_path5/trace_id | '' |
/status/clock/gptp/1/as_path/6/trace_id | '' |
/status/clock/gptp/1/as_path/7/trace_id | '' |
/status/clock/gptp/1/as_path/8/trace_id | '' |
/status/clock/gptp/1/as_path/9/trace_id | '' |
/status/clock/gptp/1/as_path/10/trace_id | '' |
/status/clock/gptp/1/as_path/11/trace_id | '' |
/status/clock/gptp/1/as_path/12/trace_id | '' |
/status/clock/gptp/1/as_path/13/trace_id | '' |
/status/clock/gptp/1/as_path/14/trace_id | '' |
/status/clock/gptp/1/as_path/15/trace_id | '' |
/status/clock/gptp/1/as_path/16/trace_id | '' |
/status/clock/gptp/1/as_path/17/trace_id | '' |
/status/clock/gptp/1/as_path/18/trace_id | '' |
/status/clock/gptp/1/as_path/trace_length | '0' |
/status/clock/gptp/1/grand_master_id | '00-1C-AB-FF-FE-00-8D-80' |
/status/clock/gptp/1/peer_delay | '0' |
/status/clock/gptp/1/port_locked | 'true' |
/status/clock/gptp/1/port_role | '3' |
/status/clock/gptp/2/as_capable | 'false' |
/status/clock/gptp/2/as_path/1/trace_id | '' |
/status/clock/gptp/2/as_path/2/trace_id | '' |
/status/clock/gptp/2/as_path/3/trace_id | '' |
/status/clock/gptp/2/as_path/4/trace_id | '' |
/status/clock/gptp/2/as_path/5/trace_id | '' |
/status/clock/gptp/2/as_path/6/trace_id | '' |
/status/clock/gptp/2/as_path/7/trace_id | '' |
/status/clock/gptp/2/as_path/8/trace_id | '' |
/status/clock/gptp/2/as_path/9/trace_id | '' |
/status/clock/gptp/2/as_path/10/trace_id | '' |
/status/clock/gptp/2/as_path/11/trace_id | '' |
/status/clock/gptp/2/as_path/12/trace_id | '' |
/status/clock/gptp/2/as_path/13/trace_id | '' |
/status/clock/gptp/2/as_path/14/trace_id | '' |
/status/clock/gptp/2/as_path/15/trace_id | '' |
/status/clock/gptp/2/as_path/16/trace_id | '' |
/status/clock/gptp/2/as_path/17/trace_id | '' |
/status/clock/gptp/2/as_path/18/trace_id | '' |
/status/clock/gptp/2/as_path/trace_length | 0' |
/status/clock/gptp/2/grand_master_id | '00-1C-AB-FF-FE-00-8D-81' |
/status/clock/gptp/2/peer_delay | 0' |
/status/clock/gptp/2/port_locked | 'true' |
/status/clock/gptp/2/port_role | '3' |
Status - Input Clock Status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Although shown using only Status of Clock Inputs 1, 2, and 3 to illustrate Clock Input Status control point format, inputs can be: 1–32. Default values for inputs 1 and 2 are identical; default values for inputs 3- 32 are identical.
Control Point | Default Value |
---|---|
/status/clock/input/1/sample_rate | '0' |
/status/clock/input/1/sync | '3' |
/status/clock/input/2/sample_rate | '0' |
/status/clock/input/2/sync | '3' |
/status/clock/input/3/sample_rate | '0' |
/status/clock/input/3/sync | '4' |
/status/clock/rtc/date_and_time | '2019-08-08T05:23:11' |
/status/clock/system/input_number | '1' |
/status/clock/system/sample_rate | '96000' |
/status/clock/system/source | '0' |
/status/clock/system/sync | '2' |
/status/clock/system/sync | '0' |
/status/clock/word_clock/sync | '3' |
/status/clock/word_clock/termination | '0' |
Status - Connected Client Status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Control Point | Default Value |
---|---|
/status/connected_client_count | '3' |
/status/connected_osc_tcp_client_count | '0' |
/status/connected_osc_upd_client_count | '0' |
/status/connected_text_tcp_client_count | '3' |
Status - Hardware Board Status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Shown using format for primary_io status to illustrate, but these commands may also be used instead with “secondary_io” at the same location in the command stream to obtain secondary I/O status.
Control Point | Default Value |
---|---|
/status/hardware/board/digital/arm_temp | '299.15' |
/status/hardware/board/digital/fan/1/kickstarting | 'false' |
/status/hardware/board/digital/fan/1/stalled | 'false' |
/status/hardware/board/digital/fan/1/tach | '3750' |
/status/hardware/board/digital/fan/2/kickstarting | 'false' |
/status/hardware/board/digital/fan/2/stalled | 'false' |
/status/hardware/board/digital/fan/2/tach/ha | '4090.91' |
/status/hardware/board/digital/fan/3/kickstarting | 'false' |
/status/hardware/board/digital/fan/3/stalled | 'false' |
/status/hardware/board/digital/fan/3/tach/h | '3934.43' |
/status/hardware/board/digital/fan/4/kickstarting | '1.78662' |
/status/hardware/board/digital/fan/4/stalled | '0.995605' |
/status/hardware/board/digital/fan/4/tach | '3934.43' |
/status/hardware/board/digital/fpga_aux_voltage | '1.78662' |
/status/hardware/board/digital/fpga_main_voltage | '0.995605' |
/status/hardware/board/digital/fpga_ram_voltage | '0.99707' |
/status/hardware/board/digital/fpga_ref_voltage | '1.25146' |
/status/hardware/board/digital/fpga_temp | '313.5' |
/status/hardware/board/digital/main_5v0_voltage | '5.10677' |
/status/hardware/board/digital/vxco_pull | '50' |
/status/hardware/board/digital/vcxo_sample_rate | '96001' |
/status/hardware/board/primary_io/analog_out_temp | '309.15' |
/status/hardware/board/primary_io/i2c/aes_out_src_present/1 | 'false' |
/status/hardware/board/primary_io/i2c/aes_out_src_present/2 | 'false' |
/status/hardware/board/primary_io/i2c/analog_in_eeprom_present/1 | 'true' |
/status/hardware/board/primary_io/i2c/analog_in_relay_present | 'true' |
/status/hardware/board/primary_io/i2c/analog_out_da_present/1 | 'true' |
/status/hardware/board/primary_io/i2c/analog_out_da_present/2 | 'true' |
/status/hardware/board/primary_io/i2c/analog_out_da_present/3 | 'true' |
/status/hardware/board/primary_io/i2c/analog_out_da_present/4 | 'true' |
/status/hardware/board/primary_io/i2c/analog_out_eeprom_present | 'true' |
/status/hardware/board/primary_io/i2c/analog_out_mute_relay_present | 'true' |
/status/hardware/board/primary_io/i2c/analog_out_range_relay_present | 'true' |
/status/hardware/board/primary_io/i2c/analog_out_temp_sensor_present | 'true' |
/status/hardware/board/primary_io/i2c/line_mon_ad_present/1 | 'true' |
/status/hardware/board/primary_io/i2c/line_mon_ad_present/2 | 'true' |
/status/hardware/board/primary_io/i2c/sim_relay_present | 'true' |
/status/hardware/board/primary_io/trim/analog_in_ad/1/gain_comp | '0.386495' |
/status/hardware/board/primary_io/trim/analog_in_ad/1/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_in_ad/2/gain_comp | '0.386748' |
/status/hardware/board/primary_io/trim/analog_in_ad/2/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_in_ad/3/gain_comp | '0.38193' |
/status/hardware/board/primary_io/trim/analog_in_ad/3/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_in_ad/4/gain_comp | '0.386241' |
/status/hardware/board/primary_io/trim/analog_in_ad/4/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_in_ad/crc_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_out_da/1/gain_comp | '-0.121722' |
/status/hardware/board/primary_io/trim/analog_out_da/1/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_out_da/2/gain_comp | '-0.205185' |
/status/hardware/board/primary_io/trim/analog_out_da/2/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_out_da/3/gain_comp | '-0.269201' |
/status/hardware/board/primary_io/trim/analog_out_da/3/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_out_da/4/gain_comp | '-0.300976' |
/status/hardware/board/primary_io/trim/analog_out_da/4/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_out_da/5/gain_comp | '-0.04191827' |
/status/hardware/board/primary_io/trim/analog_out_da/5/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_out_da/6/gain_comp | '-0.103998' |
/status/hardware/board/primary_io/trim/analog_out_da/6/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_out_da/7/gain_comp | '-0.140829' |
/status/hardware/board/primary_io/trim/analog_out_da/7/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_out_da/8/gain_comp | '-0.191083' |
/status/hardware/board/primary_io/trim/analog_out_da/8/range_valid | 'true' |
/status/hardware/board/primary_io/trim/analog_out_da/crc_valid | 'true' |
/status/hardware/errors_exist | 'false' |
Status - Front Panel and Model Status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error message.
Control Point | Default Value |
---|---|
/status/identify_active | false' |
/status/lcd_log_message | '' |
/status/led/avb_sync | '0' |
/status/led/media_clock | '2' |
/status/led/network | '2' |
/status/led/sim_bus | '0' |
/status/log_message | 'TIME="2019-08-08T05:21:09" ERR_MJR=0 ERR_MIN=0 PRI=6 STR="Compass connected: Compass v4.6.0"' |
/status/matrix_crosspoints_used | 16' |
/status/meter/input/1 | '-90' |
/status/meter/input_split/1 | '0' |
/status/meter/line_mon/1/ideal | '0' |
/status/meter/line_mon/1/neg | '0' |
/status/meter/line_mon/1/pos | '0' |
/status/meter/matrix_input/1 | '-90' |
/status/meter/output/1 | '-90' |
/status/meter/sim/1 | '-90' |
/status/meter/sim/2 | '-90' |
/status/model_string | GX-816' |
Status - Network and Snapshot Status
Note
Status commands are read-only results, which may differ from device to device; trying to set status will result in an error.
Control Point | Default Value |
---|---|
/status/network/1/carrier | '1' |
/status/network/1/duplex | 'full' |
/status/network/1/gateway | '' |
/status/network/1/ip_address | '169.254.7.39' |
/status/network/1/mac_address | '00:1C:AB:00:8D:80' |
/status/network/1/net_mask | '255.255.0.0' |
/status/network/1/speed | '1000' |
/status/network/2/carrier | 0' |
/status/network/2/duplex | 'half' |
/status/network/2/gateway | '' |
/status/network/2/ip_address | '' |
/status/network/2/mac_address | '00:1C:AB:00:8D:81' |
/status/network/2/net_mask | '' |
/status/network/2/speed | '10' |
/status/snapshot/recall_in_progress | 'false' |
Regular expression commands
Examples of commands using regular expressions
Command | Type | String |
---|---|---|
Unmute all outputs method 1 | ASCII MSG | /processing/output/([1-9]|1[0-6])/mute=false |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 3d 66 61 6c 73 65 0a | |
OSC MSG | /processing/output/([1-9]|1[0-6])/mute, F | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 00 00 2c 46 00 00 | |
TCP OSC | 00 00 00 2c 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 00 00 2c 46 00 00 | |
Unmute all outputs method 2 | ASCII MSG | /processing/output/\d+/mute=false |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 5c 64 2b 2f 6d 75 74 65 3d 66 61 6c 73 65 0a | |
OSC MSG | /processing/output/\d+/mute, F | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 5c 64 2b 2f 6d 75 74 65 00 2c 46 00 00 | |
TCP OSC | 00 00 00 20 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 5c 64 2b 2f 6d 75 74 65 00 2c 46 00 00 | |
Unmute outputs 1-8 | ASCII MSG | /processing/output/([1-8])/mute=false |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 38 5d 29 2f 6d 75 74 65 3d 66 61 6c 73 65 0a | |
OSC MSG | /processing/output/([1-8])/mute, F | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 38 5d 29 2f 6d 75 74 65 00 2c 46 00 00 | |
TCP OSC | 00 00 00 24 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 31 2d 38 5d 29 2f 6d 75 74 65 00 2c 46 00 00 | |
Unmute outputs 9-16 | ASCII MSG | /processing/output/([9]|1[0-6])/mute=false |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 3d 66 61 6c 73 65 0a | |
OSC MSG | /processing/output/([9]|1[0-6])/mute | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 00 00 00 00 2c 46 00 00 | |
TCP OSC | 00 00 00 2c 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 28 5b 39 5d 7c 31 5b 30 2d 36 5d 29 2f 6d 75 74 65 00 00 00 00 2c 46 00 00 | |
Unmute a single digit output (d=1,2,3...9) | ASCII MSG | /processing/output/\d/mute=false |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 5c 64 2f 6d 75 74 65 3d 66 61 6c 73 65 0a | |
OSC MSG | /processing/output/\d/mute, F | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 5c 64 2f 6d 75 74 65 3d 66 61 6c 73 65 00 00 00 00 2c 46 00 00 | |
TCP OSC | 00 00 00 28 2f 70 72 6f 63 65 73 73 69 6e 67 2f 6f 75 74 70 75 74 2f 5c 64 2f 6d 75 74 65 3d 66 61 6c 73 65 00 00 00 00 2c 46 00 00 |
Examples of commands using regular expressions
Command | Type | String |
---|---|---|
Mute input 1 and output 1 | ASCII MSG | /processing/(in|out)put/1/mute=true |
ASCII Hex | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 28 69 6e 7c 6f 75 74 29 70 75 74 2f 31 2f 6d 75 74 65 3d 74 72 75 65 0a | |
OSC MSG | /processing/(in|out)put/1/mute, T | |
UDP OSC | 2f 70 72 6f 63 65 73 73 69 6e 67 2f 28 69 6e 7c 6f 75 74 29 70 75 74 2f 31 2f 6d 75 74 65 3d 74 72 75 65 00 2c 54 00 00 | |
TCP OSC | 00 00 00 28 2f 70 72 6f 63 65 73 73 69 6e 67 2f 28 69 6e 7c 6f 75 74 29 70 75 74 2f 31 2f 6d 75 74 65 3d 74 72 75 65 00 2c 54 00 00 |