SVSi N8000 User Manual

Page 1
N8000 Series
Direct Control API
SVSi’s N-Command N8000 Series provides intuitive and powerful management of video over IP equipment configuration, content management, NVR recording and playback, bandwidth utilization, and matrix switching. The N8000 Series allows configuration control for each SVSi component. Use it to perform actions such as turning audio and video on/off, setting IP addresses, etc. Switch between live video streams and locally-stored LocalPlay and HostPlay. Timely informational messages (including audio content) can be instantaneously transmitted to all of the displays connected via the SVSi network.
Refer to this document to find the commands needed for your application. This document applies to the N8000 Series of controllers.
Note: The N8000 Software is based in part on the work of the Independent JPEG Group.
Note: The contents of this manual are current as of the date of publication. SVSi reserves the right to add/modify/remove commands and change the standard response packet as needed. Send commands with a semi-colon or Carriage Return Line Feed (CRLF) following the command. Refer to the examples given in the following tables.
Command List
N8001
The SVSi N-Command N8001 is a stand-alone, 1RU, web-based Controller which supports up to five users simultaneously and up to 50 devices. The N8001 includes a simplified ASCII interface for third-party control via telnet (for legacy control) or TCP/IP.
IP Addresses Eth1 port: 192.168.1.99 AND 169.254.10.99 Physical
7.5” x 7.5” x 1.5” 2 pounds Stand-Alone Unit
N8002
The SVSi N-Command N8002 is a rack-mount, 2RU, web-based Controller which supports unlimited users and devices simultaneously. The N8002 includes a simplified ASCII interface for third-party control via telnet (for legacy control) or TCP/IP and fail-over protocol for use with master/slave configurations.
IP Addresses Eth0 port: 192.169.1.99
Eth1 port: 169.254.10.99 Physical 17” x 15.5” x 3.5”
19 pounds Rack-Mount Unit
1 N8000 Series Direct Control API www.svsiav.com
Page 2

Accessing N-Command

N8012
The SVSi N-Command N8012 has all the functionality of the N8002. It also operates as an enterprise-level controller and includes redundant back-up power supply, mirrored SSD drives, and fail-over protocol for use with master/slave configurations.
IP Addresses Eth0 port: 192.169.1.99
Eth1 port: 169.254.10.99 Physical 18” x 17.5” x 3.5”
30 pounds Rack-Mount Unit
Note: The video, keyboard, mouse and additional ports on the back of the unit are not used for daily operation. You will not be able to access the N-Command software from the unit directly. There is no need to attach a keyboard/mouse or monitor to the unit.
Accessing N-Command
N-Command has a web-based interface. To access the interface, open a web browser and navigate to the unit’s IP address. SVSi recommends Google Chrome or Mozilla Firefox for this.
Default Username: admin Default Password: password

Enable Third-Party Control

The control system will need to establish a single persistent socket connection between the control system and the N-Command unit. The socket needs to connect to port 50020.

For Multiple Processors/Brands

There is virtually no limit to the number of connections that can be established between third-party control systems and the N-Command units. However, it is recommended if an application will require greater than 80 connections that a second unit be purchased for load balancing applications or master/slave setups. Please contact technical support about your application if you have questions about this process.

System Setup Using Push Notifications

N-Command supports push notification systems for third-party control systems as well as raw socket (versus telnet) connections. The advantages of this include:
No polling needed. When N-Command detects a change in one of the monitored fields, the unit sends a notice to the third-party control system with the update for the unit.
Simplified status packets for all monitored devices. Status packets contain all relevant information for sys- tem operation and monitoring. Details are provided in the tables found later in this document.
2 N8000 Series Direct Control API www.svsiav.com
Page 3

Telnet Sessions

To Enable Push Notifications for Devices
1. Every time a connection is initiated, a monitor command must be sent out from the third-party control system
with the IP address of the device to be monitored. The command is:
monitor <IPAddress> CRLF
2. After a device is monitored, the status of that device will be reported when a change occurs. To get the status of
a monitored device at any time (when no changes have occurred) send the following command:
monitornotify <ipAddress> CRLF
3. The simplified status responses are detailed later in this document.
4. If a connection is dropped, the monitor command must be present when the connection is re-established.
5. Simplified status packets are encapsulated in an XML block of <status>...</status>. Additional messages may
be sent from N-Command to the control system (verbose messages including switch confirmations and command acknowledgments).
Telnet Sessions
N-Command units may also be controlled via telnet sessions using port 50008. Legacy control system integration uses this method for control. Legacy programs will continue to function using telnet via port 50008. This is also a useful tool for system programmers to test commands prior to integrating with a third-party control system.

Command Structure

All commands detailed in this document follow the same general format. They can be generated from within N-Command software by going to Tasks > Scripts and using the drop-down menus to automatically generate control codes. For those pre-programming hardware, use the tables provided in this document to determine your commands following this structure:
<action> <destination> <requiredInformation>
OR
Switch 169.254.10.104 221
Note: All fields are separated by a space.

Panel Builder

N-Command units offer a GUI application called Panel Builder. You can use panels as a standalone control option or as an extension to a third-party control system. Generate panels for display on any mobile device or PC/Mac. The look and feel is completely customizable. Programming, design, and implementation are incredibly fast using the built in-controls. For more information on Panel Builder please visit our website: http://svsiav.com/video-over-
ip-products/n-control/management-systems/panel-builder//.
For more information on how to integrate Panel Builder as your control interface, please contact our Pre-Sales technical team for additional information and training resources.

Additional Help

For additional information or troubleshooting, please contact SVSi Technical Support between 8:00 AM and 5:00 PM Central Standard Time at 256-461-7143 or email support@svsiav.com.
3 N8000 Series Direct Control API www.svsiav.com
Page 4
Encoder Commands
Encoder Commands
Command Description
live Sets Encoder or Decoder to live play mode. Encoder IP live 169.254.104.1 <┘ Y Y
modeoff Disables the Encoder from broadcasting any
local Activates a Host playlist. Valid options are 1-8. Encoder IP and
serial Sends stored serial command (referenced by
serialhex Sends raw serial command (HEX) to device
serialhex Sends raw serial command (ASCII) to device
readresponse Reads the response from a serial command
sendir N-Series devices only: Executes IR command
sendirraw N-Series devices only: Executes IR command
audioon Enables audio output for Encoder or Decoder. Encoder IP audioon 169.254.30.238<┘ Y Y
audiooff Disables audio output for Encoder or Decoder. Encoder IP audiooff 169.254.30.238<┘ Y Y
enablecc Enables Color Space Correction (use if screen
disablecc Disables Color Space Correction (use if screen
autocc Sets Color Space Correction to Auto (N-Series
enablehdmiaudio Enables HDMI audio on Encoder (if video
disablehdmiaudio Disables HDMI audio, and will only use Analog
autohdmiaudio N-Series devices only: Encoder detects HDMI
uncompressedoff Turns compression on for V-Series Encoder. Encoder IP uncompressedoff 169.254.229.208<┘ N Y
traffic to the network. If any Encoders are viewing this stream, they will transition to local play (loss of stream).
CommandID #) to device at IP address. Command not valid for V-Series Encoders.
through N-Command. Wait time determines time for N-Command to automatically ask for the response from the attached device.
through N-Command. Wait time determines time for N-Command to automatically ask for the response from the attached device.
sent from N-Command where "Read Response" checkbox was enabled when command is saved, or serialhex command is used.
saved on Encoder/Decoder. Reference is by name, and is case sensitive.
without saving command on device. Uses long form Pronto HEX Codes provided by equipment manufacturer.
is pink or green).
is pink or green).
Encoders ONLY).
source is analog, this is disabled by default).
Audio connection.
audio support via Source EDID information and enables/disables as appropriate.
Required Varia bl es
Encoder IP modeoff 169.254.105.25<┘ Y Y
playlist number
Encoder IP and serial command ID
wait time (in seconds), Encoder IP, serial command HEX
wait time (in seconds), Encoder IP, serial command ASCII
Encoder IP readresponse 169.254.17.88<┘ Y N
Encoder IP, command name
Encoder IP, IR pronto code
Encoder IP enablecc 169.254.105.1<┘ Y Y
Encoder IP disablecc 169.254.105.1<┘ Y Y
Encoder IP autocc 169.254.105.1<┘ Y N
Encoder IP enablehdmiaudio 169.254.105.1<┘ Y Y
Encoder IP disablehdmiaudio 169.254.105.1<┘ Y Y
Encoder IP autohdmiaudio 169.254.105.1<┘ Y N
Example
local 169.254.30.238 1 <┘ Y Y
serial 169.254.17.88 29<┘ Y N
serialhex 1 169.254.17.88 43 4f 4d 4d 41 4e 44<┘
serialhex 1 169.254.17.88 "COMMAND"<┘
sendir 169.254.212.1 Play<┘ Y N
sendirraw 169.254.38.121 0000 006C 0022 0000 015B 00AD 016 0016 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0622<┘
N-Series Support
Y N
YN
Y N
V-Series Support
4 N8000 Series Direct Control API www.svsiav.com
Page 5
Decoder Commands
Decoder Commands
Command Description Required Variables Example
switch Switches Decoder video stream by IP
switch Switches Decoder video stream by
switchaudio Switches Decoder audio stream by IP
switchaudio Switches Decoder audio stream by
audiofollow Sets the Decoder back to audio follow
live Sets Decoder to live play mode. Decoder IP live 169.254.104.1 <┘ Y Y
local Activates a local playlist. Valid Options
serial Sends stored serial command
serialhex Sends raw serial command (HEX) to
serialhex Sends raw serial command (ASCII) to
readresponse Reads the response from a serial
volume Sets the Decoder’s volume level (0-100). Decoder IP volume 169.254.225.39 50<┘ Y Y
sendir Executes IR command saved on
address. If Decoder audio follows is enabled, this will switch the audio stream as well.
Encoder stream number. If Decoder audio follows is enabled, this will switch the audio stream as well.
address. This will only switch the audio stream.
Note: Decoder will have an * next to its name in the matrix when the device is not set to audio follow video.
Encoder stream number. This will only switch the audio stream.
Note: Decoder will have an * next to its name in the matrix when the device is not set to audio follow video.
mode. If currently listening to a different audio stream, box will immediately switch to current video stream’s audio. Can also be accomplished by sending a switchaudio command to set to stream 0.
are 1-8. Check device limitations (some devices only support playlist 1).
(referenced by CommandID #) to device at IP address.
device through N-Command. Wait time determines time for N-Command to automatically ask for the response from the attached device.
device through N-Command. Wait time determines time for N-Command to automatically ask for the response from the attached device.
command sent from N-Command where the "Read Response" checkbox was enabled when command is saved, or where serialhex command is used.
Decoder. Reference is by name and is case sensitive.
Decoder IP and Encoder IP
Decoder IP and Encoder stream number
Decoder IP and Encoder IP
Decoder IP and Encoder stream number
Decoder IP audiofollow 169.254.104.1 <┘ Y Y
Decoder IP AND playlist number
Decoder IP and serial command
wait time (in seconds) Decoder IP, serial command HEX
wait time (in seconds), Decoder IP, serial command ASCII
Decoder IP readresponse 169.254.17.88<┘ Y Y
Decoder IP, command name
switch 169.254.104.1 169.254.105.1 <┘ Y Y
switch 169.254.104.1 212 <┘ Y Y
switchaudio 169.254.104.1
169.254.105.1 <┘
switchaudio 169.254.104.1 212 <┘ Y Y
local 169.254.30.238 1<┘ Y Y
ID serial 169.254.17.88 29<┘ Y Y
serialhex 1 169.254.17.88 43 4f 4d 4d 41 4e 44<┘
serialhex 1 169.254.17.88 "COMMAND"<┘
sendir 169.254.212.1 Play<┘ Y N
N-Series Support
Y Y
Y Y
YY
V-Series Support
5 N8000 Series Direct Control API www.svsiav.com
Page 6
N6123 Network Video Recorder Commands
Decoder Commands (Continued)
Command Description Required Variables Example
sendirraw Executes IR command without saving
audioon Enables audio output for Decoder. Decoder IP audioon 169.254.104.1<┘ Y Y
audiooff Disables audio output for Decoder. Decoder IP audiooff 169.254.104.1<┘ Y Y
dvion Enables the DVI output of Decoder. Decoder IP dvion 169.254.104.1<┘ Y Y
dvioff Disables the DVI output of the Decoder. Decoder IP dvioff 169.254.104.1<┘ Y Y
enablehdmiaudio Enables digital audio output of Decoder. Decoder IP enablehdmiaudio 169.254.104.1<┘ Y Y
disablehdmiaudio Disables digital audio output of Decoder. Decoder IP disablehdmiaudio 169.254.104.1<┘ Y Y
autohdmiaudio Detects display support for digital audio
cropref Enables cropping functionality (scaler
getStatus Returns the current status of the device
command on device. Uses long form Pronto HEX Codes provided by equipment manufacturer.
and outputs digital audio if appropriate.
must be enabled) to the coordinates given in the command. X1Y1 are top-left corner. X2Y2 are bottom-right corner.
in an XML form.
Decoder IP, IR pronto code
Decoder IP autohdmiaudio 169.254.104.1<┘ Y N
Decoder IP, X1Y1, X2Y2 coordinates
Decoder IP getStatus 169.254.104.1<┘ Y Y
sendirraw 169.254.38.121 0000 006C 0022 0000 015B 00AD 016 0016 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0622<┘
cropref 169.254.104.1 10 10 20 20 <┘ Y N
N-Series Support
Y N
V-Series Support
N6123 Network Video Recorder Commands
Command Description Required Variables Example
record Starts a single channel recording. Record description cannot
dsrecord Starts a dual sync recording. Record description cannot exceed 250
dvrswitch1 Switches first stream on the DVR to a new selection during a
dvrswitch2 Switches second stream on the DVR to a new selection during a
mpeg Converts the latest specified stream on the DVR to mpeg. 1 for first
mpegall Converts all files on the DVR from a specified timeframe to mpeg.
deletempegfile Deletes the most recent mpeg file recording on the DVR. DVR IP, file index to delete
play Plays a specific file from a DVR. Start/stop offset in seconds. Offsets
stop Stops playback on DVR. DVR IP stop 169.254.178.49<┘
exceed 250 characters (no special characters are supported).
characters (no special characters are supported).
recording.
recording.
stream (in dual sync recording) 2 for second stream. Bitrate default is 7500000.
"24 0" indicates convert all files recorded from time of command execution back 24 hours.
start/stop recording by a specific time from the beginning or end of the file. Default is 0 0.
DVR IP, source IP, record duration (in minutes), record description
DVR IP, source 1 IP, source 2 IP, record duration, record description
DVR IP, new source IP OR stream number
DVR IP, new source IP OR stream number
DVR IP, file, bitrate mpeg 169.254.178.49 latest
DVR IP, beginning timeframe, ending timeframe, bitrate
(OR "latest" to delete the last recorded file)
DVR IP, file index to play (OR "latest" to play the last recorded file), looping, start offset, stop offset
record 169.254.178.49
169.254.30.238 5 MY RECORDING<┘
dsrecord 169.254.178.49
169.254.30.238
169.254.23.72 5 MY RECORDING 1 and MY RECORDING 2<┘
dvrswitch1 169.254.178.49
169.254.30.238<┘
dvrswitch2 169.254.178.49
169.254.30.238<┘
1 bitrate:7500000<┘
mpegall 169.254.178.49 24 0 bitrate:7500000<┘
deletempegfile
169.254.178.49 latest <┘
play 169.254.178.49 latest noloop 0 0<┘ play 169.254.178.49 f.528E37F2.index loop 0 0<┘
6 N8000 Series Direct Control API www.svsiav.com
Page 7
N2510 Windowing Processor
N6123 Network Video Recorder Commands (Continued)
Command Description Required Variables Example
pause Pauses playback on DVR. DVR IP pause 169.254.178.49<┘
unpause Resumes playback on DVR. DVR IP unpause 169.254.178.49<┘
fastforward Fast forwards playback on DVR. DVR IP fastforward
rewind Rewinds playback on DVR. DVR IP rewind 169.254.178.49<┘
deletefile Deletes specified file on DVR. DVR IP, file index to delete
stepforward Jumps playback forward. DVR IP stepforward
stepreverse Jumps playback in reverse. DVR IP stepreverse
stoprecord Stops recording on DVR. DVR IP stoprecord
recordhold Holds recording on DVR. DVR IP recordhold
recordrelease Releases recording on DVR. DVR IP recordrelease
playhold Holds play on DVR. DVR IP playhold 169.254.178.49<┘
playrelease Releases play on DVR. DVR IP playrelease
deleteallplaylist Deletes all recorded files on DVR. DVR IP deleteallplaylist
deleteallmpegs Deletes all MPEG files on DVR. DVR IP deleteallmpegs
remotecopy Copies all MPEG files to Designated Network Storage Array. DVR IP remotecopy 169.254.178.49
(OR “latest” to delete the last recorded file)
169.254.178.49<┘
deletefile 169.254.178.49 latest<┘
169.254.178.49<┘
169.254.178.49<┘
169.254.178.49<┘
169.254.178.49<┘
169.254.178.49<┘
169.254.178.49<┘
169.254.178.49<┘
169.254.178.49<┘
all<┘
N2510 Windowing Processor
Command Description Required Variables Example
wpswitch Switches streams on a specific window to a specified source. WP IP, window number,
wpaudioin Specifies which audio stream to listen to. WP IP, source IP wpaudioin 169.254.120.2
wpactive Activates a specific window. WP IP, window number wpactive 169.254.120.2 1<┘
wpinactive Deactivates a specific window. WP IP, window number wpinactive 169.254.120.2
wpaudioon Turns on Windowing Processor audio. WP IP wpaudioon 169.254.120.2<┘
wpaudiooff Turns off Windowing Processor audio. WP IP wpaudiooff 169.254.120.2<┘
wpmodeon Turns Windowing Processor mode on. WP IP wpmodeon
wpmodeoff Turns Windowing Processor mode off. WP IP wpmodeoff 169.254.120.2<┘
wparrange Arranges a specific window on the Windowing Processor. WP IP, window number,
wpbackground Chooses a background for the Windowing Processor. WP IP, background number wpbackground
wpcrop Adjusts the crop settings on a specific window. WP IP, window number, crop
source IP
window arrangement coordinates (in pixels)
coord.inates (in pixels)
wpswitch 169.254.120.2 1
169.254.30.238<┘
169.254.30.238<┘
1<┘
169.254.120.2<┘
wparrange 169.254.120.2 1 0 0 10 10<┘
169.254.120.2 1<┘
wpcrop 169.254.120.2 1 0 0 0 0<┘
7 N8000 Series Direct Control API www.svsiav.com
Page 8
N4321 Audio Transceiver
N2510 Windowing Processor (Continued)
Command Description Required Variables Example
wppriority Sets the priority for a specific window. WP IP, window number,
wpbordon Turns on the border on a specific window. WP IP, window number wpbordon 169.254.120.2
wpbordoff Turns off the border on a specific window. WP IP, window number wpbordoff 169.254.120.2
wppreset Activates an internal preset. WP IP, preset number wppreset 169.254.120.2 0<┘
priority number
wppriority 169.254.120.2 1 1<┘
1<┘
1<┘
N4321 Audio Transceiver
Command Description Required Variables Example
atrswitch Switches audio on the ATR to a specified source. ATR IP, source IP atrswitch 169.254.252.121
atrmute Mutes the ATR's output. ATR IP atrmute
atrunmute Turns off mute on the ATR's output. ATR IP atrunmute
atrtxmute Disables the ATR's transmit output. ATR IP atrtxmute
atrtxunmute Enables the ATR's transmit output. ATR IP atrtxunmute
atrhpvol Sets the ATR's headphone volume level (0-100). ATR IP, volume number atrhpvol 169.254.252.121
atrlovol Sets the ATR's lineout volume level (0-100). ATR IP, volume number atrlovol 169.254.252.121
atrlovolup Increments the lineout volume by the given value (e.g., if volume is
atrlovoldown Decrements the lineout volume by the given value. ATR IP, amount to decrease atrlovoldown
atrhpvolup Increments the headphone out volume by the give value. ATR IP, amount to increase atrhpvolup
atrhpvoldown Decrements the headphone out volume by the given value. ATR IP, amount to decrease atrhpvoldown
openrelay Opens a specific relay on the ATR (relay number = 1 or 2). ATR IP, relay number openrelay 169.254.43.21 1
closerelay Closes a specific relay on the ATR (relay number = 1 or 2). ATR IP, relay number closerelay 169.254.43.21 1
currently 40 and the command is to increment by 5, this will make the new volume 45).
ATR IP, amount to increase atrlovolup 169.254.252.121
169.254.30.238<┘
169.254.252.121<┘
169.254.252.121<┘
169.254.252.121<┘
169.254.252.121<┘
50<┘
75<┘
5<┘
169.254.252.121 5<┘
169.254.252.121 5<┘
169.254.252.121 5<┘
Video Wall Commands
Command Description Required Variables Example
videowall Changes a video wall layout (Decoders or with Windowing
videowall Changes one window within the video wall to a new source. Can be
Processors) to the new layout.
referenced by IP or stream number.
Name of video wall, name of layout
Name of video wall, name of layout, layer to switch, stream number (or IP of Encoder)
videowall "myVidWall" "fullScreen"<┘
videowall "myVidWall" "fullScreen" 1 123<┘
Miscellaneous Commands
Command Description Required Variables Example
script Executes the stored script. Script must be saved to N-Command
prior to executing.
8 N8000 Series Direct Control API www.svsiav.com
Script ID script 33<┘
Page 9
Encoder Status Packet Responses
Miscellaneous Commands (Continued)
goto In a panel builder project, switches to a different panel. Panel ID goto 50<┘
tcpclient Sends command to destination device (e.g., IP controlled projector).
udpclient Sends command to destination device (e.g., IP controlled projector).
reboot Reboots an SVSi device at the IP address specified. Device IP reboot 169.254.25.12<┘
gc_serial Sends a serial command through a Global Cache device. GC IP, serial port number,
gc_openrelay Opens a specific relay on a Global Cache device. GC IP, relay port number gc_openrelay
gc_closerelay Closes a specific relay on a Global Cache device. GC IP, relay port number gc_closerelay
gc_ir Sends an IR command through a Global Cache device. GC IP, IR Port number, GC IR
Command and port are provided by the device manufacturer.
Command and port are provided by the device manufacturer. Command is UDP.
IP address of device, port number, command
IP address of device, port number, command
serial command
command
tcpclient 192.168.10.20 5000 aa bb cc dd<┘
udpclient 192.168.10.20 5000 aa bb cc dd<┘
gc_serial 192.168.1.166 1:1 6b 61 20 30 20 30 31 0d<┘
192.168.1.166 3:1<┘
192.168.1.166 3:1<┘
gc_ir 169.254.250.240 4:3 sendir,1,38000,1,1,347,17 3,22,22,22,22,22,65,22,22, 22,22,22,22,22,22, 22,65,22,65,22,22,22,22,2 2,65,22,65,22,65,22,65,22, 22,22,22,22,65,22, 22,22,22,22,65,22,22,22,2 2,22,22,22,65,22,22,22,65, 22,65,22,22,22,65, 22,65,22,65,22,1570<┘
Encoder Status Packet Responses
Status Packet Resp <status>169.254.114.220;1;0;0;0;live;1;300;0;1;0;0;720p60</status> Status Packet Field <status>IP address; Communication; dvioff;scaler;source state; mode; audio state; stream#; stream#; playlist; colorspace;hdmiaudio;resolution;</status>
Field Value s Notes
Communications 1 = online | 0 = offline
dvioff Always 0 (Encoder DVI always enabled)
scaler 1 = on | 0 = off
Source State 1 = source detected | 0 = no source
mode live | local | off
Audio State 1 = enabled | 0 = disabled
Video Stream 0 - 40000 (stream assignment of Encoder)
Audio Stream Same as Video Stream
Playlist Playlist 1 - 8
colorspace auto | on | off
hdmiaudio auto | on | off
Resolution Scaler output resolution (720p60 | 1080p60)
Decoder Status Packet Responses
Status Packet Sample: <status>169.254.237.181;1;0;0;0;live;0;6995;0;1;0;0;720p60</status> Status Packet Order: <status>IP address; communication;dvioff;scaler;display state;mode;audio state;video stream;audiostream;playlist;colorspace;hdmiaudio;resolution</status>
Field Value s Notes
Communications 1 = online | 0 = offline
dvioff 1 = off | 0 = on
scaler 1 = on | 0 = off
9 N8000 Series Direct Control API www.svsiav.com
Page 10
N4321 Status Packet Responses
Decoder Status Packet Responses (Continued)
Status Packet Sample: <status>169.254.237.181;1;0;0;0;live;0;6995;0;1;0;0;720p60</status> Status Packet Order: <status>IP address; communication;dvioff;scaler;display state;mode;audio state;video stream;audiostream;playlist;colorspace;hdmiaudio;resolution</status>
displaystate 1 = display on | 0 = display off If simplified DVI detect is enabled, this will always be 1 unless display is
mode live | local
Audio State 1 = enabled | 0 = disabled
Video Stream 0 - 40000
Audio Stream 0 = follow video | 0 - 40000
Playlist Playlist 1 - 8
colorspace Always 0 for Decoders.
hdmiaudio Always auto for Decoders.
Resolution Scaler output resolution (720p60 | 1080p60)
physically not attached.
N4321 Status Packet Responses
Status Packet Resp<status>169.254.11.20;50;212;enabled;enabled;100;100;100;100;online</status> Status Packet Fields<status>IP address; EncodeStream#;DecodeStream#;TxAudioState;RxAudioState;Lineoutvol_L;lineoutvol_r;hpvol_L;hpvol_r;communication</status>
Field Value s Notes
Encode Stream # 1 - xxxxx
Decode Stream # 1 - xxxxx
TX Audio State enabled | disabled
RX Audio State enabled | disabled
Volumes 0 -100
communication online | offline
N2510 Status Packet Responses
Status Packet Resp <status>169.254.25.10;26;1080p;97;enabled;97;9998;98;98;online;</status> Status Packet Fields<status>IP address; EncodeStream#;Output Resolution;Input Audio Stream;Audio State;Win 1 V Source;Win 2 V Source;Win 3 V Source;Win 4 V
Source;communication;</status>
Field Value s Notes
Encode Stream # 1 - xxxxx
Output Resolution Output Resolution of the Windowing Processor (720p60
Input Audio Stream 1 - xxxxx
Audio State enabled | disabled
Win 1 - 4 V Source 1 - xxxxx
Communication online | offline
|1080p)
10 N8000 Series Direct Control API www.svsiav.com
Page 11

Third Party Command Library: Adding and Using Commands

Third Party Command Library: Adding and Using Commands
The third party command library is a feature exclusive to the N-Command control products. Use this library to define commands for third party devices (IR, RS-232, or IP based commands) in a spreadsheet program. Then import the command information into the centralized controller. The advantage of this approach is that the server stores all of the commands and allows you to bypass the process of loading commands to each individual units. Loading commands individually is still an available option, but using the command library is significantly faster to implement and easier to control.
You can import and export library files from N-Command for use at other locations, or for editing and archival purposes. The file is stored as a standard comma separated file (CSV) and is editable in any spreadsheet program.
Creating the File Externally
The first row of the file must contain the appropriate column headers for the import process to work. They are listed below (in order):

Header Value Data Value

ID User-defined number: 1 to X
MANUFACTURER Name of manufacturer (e.g., LG)
MODEL Model name of device
COMMANDTYPE ir | serial | network
COMMANDNAME User-friendly name for command (e.g., Power On)
COMMANDDATA Command data
IR = Pronto Long Form HEX code RS-232 and network = manufacturer-specific string
NETWORKPORT Port on destination device (applies if command is a network command)
TCPORUDP TCP or UDP command
Example Entries
11 N8000 Series Direct Control API www.svsiav.com
Page 12
Third Party Command Library: Adding and Using Commands
ASCII vs HEX
The library stores all data internally as HEX; however, data can be added to the spreadsheet in ASCII. To do this, add quotes around the ASCII data. HEX bytes, contained within quotes, are delimited with a backslash character (e.g., \0d\0a). During command setup, you can either pre-convert a command to HEX or use the quote method to create the command. If pre-converting to HEX, N-Able has a built-in ASCII to HEX utility. After import, all ASCII strings are converted to HEX. If exported again, the command will be in HEX.
Example of HEX Versus ASCII Entries
commandname commanddata
Power On (ASCII) ka 0 01\0d
Power On (HEX) 6b 61 20 30 20 30 31 0d
The examples above are identical commands. The top option is in ASCII and the bottom in HEX. If the command contains quotes, you can use single quotes on the outside of the ASCII command (e.g., ‘this is my
“command”\0d\0a’).
Importing/Exporting the CSV File
From the N-Command main page, navigate to Admin > Third Party Library.
To Import:
1. Select Choose File under the Import CSV header.
2. Browse to the file and click Open. The selected file name displays to the right of the Choose File button.
3. Click Upload Selected File.
The file uploads to the unit and processes through the commands.
12 N8000 Series Direct Control API www.svsiav.com
Page 13
Third Party Command Library: Adding and Using Commands
Step 2
Step 1
Step 3
To Export: Click the link to Download CSV Export under the Export CSV Header.
Adding Commands Manually
1. If command is from a new manufacturer, select the Manufacturer drop-down and enter the Name. Enable the
Add as New checkbox.
2. Click the Model drop-down and enter the Name of the device. Enable the Add as New checkbox.
3. Click the appropriate command type (Serial, IR, or Network). Enter a name for the command and the command
data.
4. Click Save. The manufacturer, model, and command are now available on the tree view on the left hand side of
the screen.
5. Repeat steps to add new commands as needed.
13 N8000 Series Direct Control API www.svsiav.com
Page 14
Third Party Command Library: Adding and Using Commands
Step 1
Step 2
Step 3
Step 4
Modifying Existing Commands
1. From the tree view, find the appropriate manufacturer/model/command type/command.
2. Modify the data in the appropriate field(s).
3. Enable the Add as New checkbox to create a new command, or disable this option to overwrite an existing
command.
4. Click Save.
Distribution Switching Recording Windowing Wall Processing Control
Southern Vision Systems, Inc.
SVSi is a trademark of Southern Vision Systems, Inc. in the United States and other countries. All other brand names, product names and trademarks are the property of their respective owners. Certain trademarks, registered trademarks, and trade names may be used to refer to either the entities claiming the marks and names or their products. SVSi disclaims any interest in the marks and names of others. 800DOC8KCMDREV1.1
256.461.7143  www.svsiav.com
Made in the USA.
Loading...