User's Manual

On connecting to the serial port, the client should send a carriage-return. The Videohub Server
will respond with a
> character prompt, which is not followed by a carriage-return or line-feed.
Receiving the prompt indicates that a connection has been established. The same prompt will
be issued after each command received by the Videohub Server.
In the following documentation, commands in
orange and values in blue must be typed
literally, including any spaces. In the following example of an immediate command using
destination port 7 and source port 3,
@ X:0/destination,source would be entered
as:
@ X:0/6,2
Notifications
Once connected, if status reporting is enabled, the client will receive a notification message
when a route changes on the Videohub Server. The notifications take one of two forms:
S:0destination,source Routing change
This message indicates that the specified source port is now routed to the specified
destination.
V:0 destination,source Preset routing notification
This message indicates that the current preset includes a route from the specified source to the
specified destination.
Global Commands
All pass-through commands are preceded by an
@ symbol and a space.
The following client commands are supported:
@ ! disable status reporting
Status reporting is disabled by default.
@ ? enable status reporting
Status reporting is enabled.
@ Z: reset routing table
Routing is reset so that the first source is routed to all destinations.
Immediate Commands
@ X:0/destination,source change route
@ X:0/destination,source/destination-2,source-2… change multiple routes
The specified source ports are routed to the specified destinations.
Any routing changes will trigger
S: notifications
@ X?0destination request individual route status
The source routed to a the specified destination will be returned as an
S: notification.
@ S?0 request all ports route status
Each source & destination port pair will be returned as
S: notifications
Salvo Commands
@ P:0/destination,source queue route change
@ P:0/destination,source/destination-2,source-2… queue multiple route changes
The specified routing changes are added to the current salvo for later execution.
@ P?0destination request individual port status in salvo
If a routing change for the specified destination port is queued, the route will be
returned as a
V: notification.
923Developer Information