DirectOut Technologies

Transcription

1 D.O.TEC M.1k2 Software Guide Version 1.2

2 Table of contents Table of contents Table of contents 2 Introduction 5 About 5 What is the M.1k2? 5 Controller 5 Modular 5 Quick overview 6 The status bar 6 The link section 6 Port status 7 Clock status 8 Device status 9 The menu 9 Sticky menu 9 Port configuration 9 Word clock configuration 9 Hardware 10 Front panel 10 Device state 10 RESET button 10 Word clock section 11 RS RS4xx 11 GPO 11 MIDI I/O 11 I/O boards 12 Routing 13 Overview 13 Audio Routing 13 Data Routing 13 Routing Port Matrix 14 Overview 14 Toolbar 15 Locking ports 15 Port gains 15 Channel gains, port gains and locks 16 Renaming and labelling ports 16 Routing Channel Matrix 17 Online and offline matrix 17 Moving around in the matrix 18 Manipulating crosspoints 19 Locking channels 21 User labels 21 Quickshots 21 Routing MIDI Matrix 22 Using the matrix 22 Toolbar 23 page 2 of 54

3 Table of contents Routing Serial Matrix 24 Using the matrix 24 Toolbar 25 Setting the bitrate 25 Snapshots 26 Creating a Snapshot 26 Choosing a Snapshot's Project 26 Loading a Snapshot 27 Snapshot Maintenance 28 Configuration 29 Configuration Ports 29 Title Bar 29 Input status 29 Clock Configuration 30 Follow Port 30 Master Override 30 Input Configuration 31 Output configuration 31 Channel Routing 32 Configuration WCK 33 Clock sources 33 PolySync 33 Master Clock: Using a single clock reference 33 Word clock inputs 33 Termination 34 Word clock output 34 PolySync : Using multiple clock references 35 Configuration Device 36 Network settings 36 Contact settings 39 GPO configuration 39 Temperature management 40 Status LED configuration 40 Firmware update 41 Backup, restore and wipe configuration 42 Backup 42 Restore 42 Wipe 42 Tools 43 Tools Monitoring 43 Input port speed and channel mode 43 Input signal/sync state 43 Signal present 44 Dead channels 44 Peeking into channels 44 Miscellaneous 45 Misc Version 45 System information 45 Device information 45 IO Boards 45 Plug-ins 45 Misc Livelog 46 Misc Support 47 Support archive 47 page 3 of 54

4 Table of contents User 48 User My files 48 User My account 48 Backup account 48 Restore account 48 Change password 48 Wipe user data 48 Plug-ins 49 Telnet 49 Using telnet manually 49 Using telnet with scripts 50 SWP08 protocol support 51 SWP08 parameters 51 Emergency Recovery 52 Network configuration reset 52 Index 53 Document History 54 page 4 of 54

5 Introduction - About Introduction This document gives an overview about the graphical user interface (GUI) of the D.O.TEC M.1k2. To familiarize yourself with the functions of the device - without having an connected M.1k2 next to you - you may thumb through the following pages. The GUI is accessed by an internet browser such as Chrome, Firefox, etc. (Chrome is recommended). About What is the M.1k2? The M.1k2 is a 16 port MADI router. It provides routing of whole ports down to single channel level offering a 1024 by 1024 crosspoint matrix. You can distribute MADI signals en bloc in a port matrix and you may also create your own MADI stream using the channel matrix. PolySync provides the ability to use different clock sources on individual ports. So the router may be divided into single clock groups that can run at different sample rates. Port redundancy may be applied to have a spare signal that will be used when an input signal breaks. Two extra matrices may route serial data and MIDI data - that is embedded into the MADI signal - independently from the audio signal. Controller The audio signals are processed through an FPGA which itself is controlled by an embedded controller. The controller runs a webserver for access of the GUI from anywhere within a network. Support for extra protocols (such as telnet or SWP08) offers integration within complex installations. Modular The host device may be equipped with three different types of modules with eight ports each (coaxial BNC, optical SC and SFP). The optical modules are multi-mode by default and may be customized to single-mode upon request. page 5 of 54

6 Quick overview - The status bar Quick overview The status bar The status bar is always present (except for the channel matrix, which uses its own window). It displays the current device state, provides short links to the device configuration and displays warnings. The link section Your account The left part is only visible when you are logged in. Your username (e.g. 'admin') is a link to a page where you access your user profile and change your password. The link labelled 'log out' does exactly that. Contact This link is always present and displays the information that was entered in the contact section of the device configuration (page 39). It is recommended to contain means for immediate contact with the administrator. Help This link is always present and opens a popup window with the help you are reading right now. Alternatively many sections of the GUI have -buttons that take you to the corresponding section of the manual directly. page 6 of 54

7 Quick overview - The status bar Port status The port status section consists of three rows: The upper row displays the port IDs. If any of these ports is configured to be the clock reference for the word clock output, the ID is inverted (as is port 11 in the example above). The middle row displays the sync state for each port. This can be off (no signal), green blinking (lock but no sync) and green (sync). The lower row shows the current port redundancy setting and state. It displays the number of the redundant port and uses colours to indicate an error or a warning. In the example above, two pairs of ports are configured to be redundant: a) port 2 and 3 b) port 6 and 11 Port 2 and 3 are in sync, so redundancy is available. Port 6 has no signal (sync LED off), so the redundancy failed on that port (red colour). On the redundancy port the state changed to a warning (orange) to indicate a problem with the redundancy. If you move the mouse over any port column, a popup will give you more details about its current state. If you click on any port column, the corresponding port configuration page is shown. page 7 of 54

8 Quick overview - The status bar Clock status The clock status section gives you a quick overview of the device's current clocking configuration and state. The video input at the front panel allows you to feed an analogue video signal (PAL or NTSC, autodetect) as clock source. The M.1k2 simultaneously derives a 44.1kHz and a 48kHz clock from that signal. The video LED displays the sync status of the video input: Off - no signal, green blinking - lock but no sync, green - sync. If you move the mouse over the LED, a popup gives you more details about the incoming signal. If you click on the LED image, the Word clock configuration page opens. If the video input is currently selected to be the source of the word clock output, its name is inverted. The video and word clock input on the front panel have a switchable termination. If the M.1k2 is the last device on a bus, termination should be activated. The termination always works on both inputs simultaneously. The term LED displays the current state of the termination. If lit orange, the termination is active. If you click on the LED image the Word clock configuration page opens where you can activate or deactivate the termination. The WCK section displays the status of any incoming word clock signal on the front panel's WCK input. The LED displays the sync status of the word clock input: Off - no signal, green blinking - lock but no sync, green - sync. If you move the mouse over the LED, a popup gives you more details about the incoming and outgoing signal. If you click on the LED image, the Word clock configuration page opens. If the word clock input is currently selected to be the source of the word clock output, its name is inverted. The 'intern' label is inverted if one of the built-in word clock generators (44.1kHz and 48kHz) is connected to the word clock output. The '44.1k' and '48k' labels are displayed inverted if the frequency currently routed to the word clock output is within 0.5% of the displayed frequency. The 'POLYSYNC' button displays the current PolySync setting. If there are different word clock sources in use, the button lights up. Click on the button to change the configuration on the Word clock configuration page. page 8 of 54

9 Quick overview - The menu Device status The four LEDs of the GPO section display the current state of the GPO 1..4 (in the order UL, UR, LL, LR). If you click on the GPO section, the device configuration page is shown where you can configure the GPOs. The two PSU LEDs give you the current state of the power supplies: Off - no power, green - on, red - fail. A PSU is considered to have failed if it was on once and now is off. The thermometer indicates the device's temperature class (green - normal, yellow - critical, red - over). If you move the mouse over the thermometer, the exact temperature is shown in a popup. If you click on the thermometer, the device configuration page is shown where you can configure the fan settings. The menu In the top section of every page you find the menu that gives you direct access to most of the pages. The first row contains the menu sections, the second row the pages inside each section. Sticky menu The default behaviour for the menu is to scroll with the page. If you want to see the menu all the times, click on the sticky pin (or press the 'm' button on your keyboard). If enabled, the menu will always be visible on top, but it will cost you screen real estate. The fixed state of the menu will be saved in your user account. Port configuration Configuration Ports (page 29) or click on the port columns in the status bar. Word clock configuration Configuration WCK (page 33) or click on the WCK section of the status bar. page 9 of 54

10 Hardware - Front panel Hardware Front panel Device state State LED Constant on Heartbeat Blinking 0.5s Blinking 0.1s The controller is idle. The configuration of the state LED when idle is covered in the Status LED configuration section (page 40). The controller is idle. The configuration of the state LED when idle is covered in the Status LED configuration section (page 40). The factory default network settings are active. This state should only be active when configuring the device for the first time, or after the recovery procedure (page 52) has been performed. There is unsaved configuration data. After the changes have been written safely to the flash, the state LED returns to the idle state. The configuration of the state LED when unsaved data is present is covered in the Status LED configuration section (page 40). PSU LEDs Constant off Constant on Blinking 0.1s The power supply has been off since the device was turned on. Note: An unlit LED does not guarantee that the device is free of voltage. The power supply is active. The power supply was active, and is now inactive. Wether this is a fault state depends on the circumstances. If both PSU LEDs are blinking and the fan is blowing at full speed, the FPGA is being programmed. This only happens during reboot after an update. RESET button The sole purpose of the RESET button is to activate the factory network settings in case you have locked yourself out. Please see the section Emergency Recovery (page 52) to learn how to perform the procedure. page 10 of 54

11 Hardware - Front panel Word clock section The word clock input, outputs and the video input are covered in detail in the Word clock configuration section (page 33). RS232 The RS232 port handles bitrates of 9600, 19200, and bps without RTS/CTS support. Pin Signal RX TX jack - male 5 GND Setting the bitrate and the routing of the serial data is covered in the section about the Serial Matrix (page 24). RS4xx The RS4XX port can be configured to handle RS422 or RS485 signals and bitrates of 9600, 19200, and bps. Pin Signal 1 GND RS422 RX RS422 TX- / RS485 RX - jack - female 4 GND 5 6 GND 7 RS422 RX- 8 RS422 TX+ / RS485 RX+ 9 Setting the bitrate and the routing of the serial data is covered in the section about the Serial Matrix (page 24). GPO The M.1k2 has four GPOs which can be switched manually or triggered by certain events. Switching is performed by Avago ASSR-1411-S optical MOSFETs, which can switch up to 60V, 0.6A AC or DC. Pin Signal /6 GPO /7 GPO 2 jack - female 3/8 GPO 3 4/9 GPO 4 Configuration of the GPOs is covered in the GPO configuration section (page 39). MIDI I/O Routing of the MIDI data is covered in the section MIDI Matrix (page 22). page 11 of 54

12 Hardware - I/O boards I/O boards The M.1k2 supports two IO boards which can provide up to eight MADI I/Os each. To get an overview of the different IO board configurations, please see the DirectOut web page ( To see the details of your current setup, please go to Misc Version (page 45). The IO boards can be added, swapped or removed during operation. page 12 of 54

13 Routing - Overview Routing Overview Audio Routing Depending on the task ahead of you, there are probably several ways to get it done. All methods can be used simultaneously. From coarse to fine: Port matrix allows you to route complete ports 1:1 Channel matrix - gives you access to the full matrix Data Routing Serial Matrix controls the routing of the serial data embedded in user bits 1-9 MIDI Matrix controls the routing of the MIDI data embedded in channel 56 ('MIDIoverMADI') page 13 of 54

14 Routing - Routing Port Matrix Routing Port Matrix Overview The port matrix allows you to set the audio routing for a complete port at once. It is perfect for simple setups or if you want to sketch a routing and do the fineprint later. If you make a connection in the port matrix, it will always connect all channels of the selected ports 1:1 except locked channels. To disconnect all output channels of a port, click the crosspoint again or click in the N/C row of the matrix. To make things even simpler, two buttons give you a unity matrix or disconnect all channels at once. If you move the mouse over the intersection of two ports with different speed modes, the port names are highlighted in yellow to warn you. Of course it is possible to make the connection anyway, if you whish to do so. Let s have a look at this setup: There are three different kinds of connection indications: Green indicates that all channels of the input port are connected 1:1 to the output port. Grey indicates that there are some connections from the input port to the output port. Red indicates that all the channels of this output port are disconnected. In the image above ports 3-12 are 1:1 connected. Output port 1 only contains connections with input port 1, but not all channels are 1:1 connected. Output port 2 contains input from port 1 and 2. Output ports are not connected. Note: You may notice a lag in the 100ms range between clicking on the matrix and the connection to show up. The matrix always shows the state inside the router and the transfer forth and back takes about this time. But that means also that you always see what is going on inside the device. page 14 of 54

15 Routing - Routing Port Matrix Toolbar A tool bar above the port matrix gives recalls a 1:1 or N/C preset for the whole matrix. This will only affect unlocked and accessible channels, of course. The combo cycler on the right switches between system and user defined labels. It can be operated either via mouse or the key d. Locking ports The port matrix allows to monitor and modify the channel lock state for full ports. A grey lock indicates that some, but not all channels on the port are locked. A dark lock indicates that all channels of that port are locked. To change the lock state of the port, hold down the shift key and click in the box below the port you want to lock. Holding down the shift key prevents locking/unlocking a whole port by accident. Note: Once you have locked individual channels in the matrix editor (grey padlock symbol) a click will lock all channels first then unlock all channels. Port gains In addition to the channel gains, you can select a port gain. Both gains will be added before being applied to the audio data. The row below the port locks displays the port gains. A green background indicates an attenuation, a yellow background colour a gain. To change the gain of one port, you can: use the mouse wheel over the box that displays the to change the gain coarsely use the mouse wheel in combination with the shift key to change the gain in small steps click with the middle mouse button in the box to reset the gain to 0dB click with the left button in the box to pop up a fader. Click again to remove the fader. Or press the key g and pop up all faders at once. page 15 of 54

16 Routing - Routing Port Matrix Channel gains, port gains and locks Port gains and channels gains are summed up and applied to each channel. Channel locks not only forbid modification of a channel's cross point state, but also the channel's gain. How the port gain is applied to a locked channel's gain can be set for each port via the port gain mode setting: To see or change the port gain mode, press the SHIFT key and keep it pressed. The row that previously contained the port gains now displays the port gain modes. Click on a port gain mode to toggle it: Combined - The port gain is applied to all channels on the port, locked or not. Unlocked only - The port gain is only applied to unlocked channels on this port. Attention: Toggling the port gain mode immediately affects the volume on the locked channels. Please be careful using this option! Renaming and labelling ports All ports can be renamed and labelled easily by double clicking on them. A small edit frame will pop up: Edit the label (up to 16 characters) and select an optional label. To exit the edit frame, click outside the frame. Any changes become effective immediately. If you need other coloring schemes than the ones provided by the eight labels, you can use the expert mode: Keep the key 'CTRL' pressed while double clicking on the label. Instead of displaying eight labels, two text fields allow you to enter the HEX values for the foreground and background colors: page 16 of 54

17 Routing - Routing Channel Matrix Routing Channel Matrix The channel matrix is one of the main workspaces of the M.1k2. Please take a few minutes to learn about its capabilities. Online and offline matrix The channel matrix provides access down to single channel level (1024 by 1024 crosspoints). That means you can create your own MADI stream by patching signals from several input ports to an output port. There are two matrices: offline - to prepare a scenario online - reflects the actual patching state, changes will be executed immediately Both matrices are shared between all users and protocols. That means that multiple persons or programs can modify the matrix from multiple sites simultaneously. You chose the matrix to work on by pressing SPACE or use top button in the matrix toolbox. The default view shows crosspoints (XPs) from both matrices in an overlay, dimming the inactive variant. You can toggle the display of the inactive matrix between 'dim' and 'off' by pressing the key 'v'. A toolbox in the top right corner lets you choose one of several tools or select the matrix for editing and affect the status of the matrix. To keep track of the matrix or for quick access in a navigation map (bottom left corner) your actual position is represented by a black rectangle. A bunch of shortcuts is available to ease up the operation. Press the key 'h' to call the dictionary (press again to hide it). page 17 of 54

18 Routing - Routing Channel Matrix Moving around in the matrix Via mouse Drag the matrix Use the mouse wheel to scroll Click in the map overview in the bottom left corner Via keyboard Use the cursor keys to scroll by one channel Use the cursor keys + SHIFT to scroll to the next eight channel group Use the cursor keys + CTRL to scroll by one port Use the Page Up/Page Down keys to jump quadrants POS1 jumps to the upper left corner END jumps to the lower right corner XP jump marker If there is a XP (crosspoint) in one row or column, the corresponding input or output labels display a small green square (for online XPs) or yellow triangle (for offline XPs). Click on those small XPs icons to jump to the XP. On the input side, multiple XPs are possible in each row. Repeated clicks on the same input will cycle you through all XPs. Info floater By pressing the key 'i' you can show or hide a small floater that will follow your mouse and display the current coordinates and channel labels. Crosspoint icons Crosspoint online matrix Crosspoint online matrix - locked Crosspoint online matrix - out of range Crosspoint online matrix - out of range, locked Crosspoint offline matrix Note: A crosspoint is marked out of range, if the channel is not available for patching at the MADI output. Possible reason: speed mode is higher than 1FS or 56 channel mode is used. page 18 of 54

19 Routing - Routing Channel Matrix Manipulating crosspoints Toolbox and operations Button Function Shortcut ONLINE / OFFLINE toggles between online and offline matrix Space SNAPSHOT RECALL ON OFF CLEAR COMMIT The XP tool sets or removes crosspoints beneath the cursor (Crosspoints are removed by clicking again on a set crosspoint). The locking tool locks the output channels beneath the cursor. A locked output channel cannot be modified until unlocked. The cutting tool removes crosspoints from the output channels beneath the cursor. Creates a snapshot. A dialog will open to name and label it. Recalls a snapshot. A dialog will open for selection. copies the online matrix to the offline matrix deletes all crosspoints of the current matrix - except locked ones of the online matrix copies the offline matrix to the online matrix - immediately affects the audio patching x l c s r C Return Cursor size and angle Select one of the tools and move the mouse over the matrix. You notice a cursor following the mouse and the input/output channels highlighting. The size of the cursor can be changed: Key Function 1-8 Cursor size 1..8 channels channels 0 64 channels a Cycle cursor angle - SE, E, NE Press key a to cycle cursor angle: page 19 of 54

20 Routing - Routing Channel Matrix Examples - Tools: Crosspoint tool - size 4 white ghost squares indicate a preview of the patch affected inputs and outputs are marked green Lock tool - size 4 a yellow bar indicates a preview of the outputs to be locked or unlocked Clear tool - size 4 a red square indicates a preview of the connections to be cleared page 20 of 54

21 Routing - Routing Channel Matrix Locking channels To lock channels, use the locking tool ( or press key 'l') and click in the matrix. Click again to toggle the state. Once a channel is locked, its current connection state is frozen and cannot be changed until the channel is unlocked again. A locked channel displays a small lock symbol in the output label section: Any crosspoint set in the locked channel's column will also show a small lock in its marker: User labels You can toggle between the system port/channel names and the user defined names by pressing key 'd'. Editing labels Once the user labels are shown, you can edit them by double clicking on a label. The label will be replaced by a text entry field. Once you have finished entering the label, you might use the Cursor Up/Down keys to move on to the next/previous label. This works for the input labels and the output labels as well. Quickshots Quickshots are an addition to the full-blown snapshot mechanism (see page 26), storing and recalling up to nine matrices at the push of a single button. To show or hide the quickshot toolbar, press key 'q'. There are nine slots for matrices; Green slots already hold a matrix, grey slots are empty. Click on a slot to load the stored matrix in the currently active matrix buffer. Shift-Click on a slot to store the currently active matrix buffer in that slot. Ctrl+Shift-Click on a slot to empty it. page 21 of 54

22 Routing - Routing MIDI Matrix Routing MIDI Matrix The device can embed MIDI data in the MADI stream using the user bits of channel 56. Embedded MIDI data is de-embedded inside the device and can be routed separately from the audio data. Note: If you have no MIDI routing active for an output port, but a routing on audio channel 56, the user bits will be routed as well (without being de-embedded and re-embedded in that case). But if you use the de-embedding and re-embedding process, you can route MIDI data between ports even if they are not synchronous. Note: In order to be able to transport the MIDI bits/s on a MADI stream, there is a lower bound for the word clock of that MADI stream (since it can only transport one bit per sample). MIDI routing is not possible if the clock is lower than 32kHz. Ports that have a lower clock are highlighted in yellow to warn you. Of course it is possible to make the connection anyway, if you whish to do so. Using the matrix To make a connection between an input port (rows) to an output port (columns), just click in the square that intersects both. If you press on the same square again, you can toggle between the N/C and connected state. Note: You may notice a lag in the 100ms range between clicking on the matrix and the connection to show up. The matrix always shows the state inside the router and the transfer forth and back takes about this time. But that means also that you always see what is going on inside the device. In this image you can see that only ports 3, 9 and 10 carry signals that allow you to embed MIDI data correctly. Although you can make connections on the other ports (yellow squares), the data output may be garbled. page 22 of 54

23 Routing - Routing MIDI Matrix Toolbar Above the matrix you have a small toolbar: All 1:1 sets a 1:1 routing on all ports. All N/C disconnects all ports. Note: This only affects the de-embedding and embedding process. If you have an audio routing active on channel 56, MIDI data can still show up on the output port. Display labels toggles between the system's names for the ports and your user defined names. This setting is automatically stored and used again in later sessions. You can change the label display by clicking on the cycler or by pressing key 'd'. Cycle sequence: page 23 of 54

24 Routing - Routing Serial Matrix Routing Serial Matrix This device can embed serial data in a MADI stream is using the user bits 1 9. The serial matrix allows you to de-embed and route this serial data separately from the audio routing. The MADI ports that take part in a serial routing do not have to be synchronous. If you connect audio channels 1 9 from one port to another port and disable serial routing in this matrix, you can achieve the same since channel user bits are routed as well. But in this case both channels have to be synchronous. Using the matrix To make a connection between an input port (rows) to an output port (columns), just click in the square that intersects both. If you press on the same square again, you can toggle between the N/C and connected state. Note: You may notice a lag in the 100ms range between clicking on the matrix and the connection to show up. The matrix always shows the state inside the router and the transfer forth and back takes about this time. On the plus side, you always see what is going on inside the device. page 24 of 54

25 Routing - Routing Serial Matrix Toolbar Above the matrix you have a small toolbar: All 1:1 sets a 1:1 routing on all ports. All N/C disconnects all ports. Note: This only affects the de-embedding and embedding process. If you have an audio routing active on channels 1 9, serial data can still show up on the output port. Display labels toggles between the system's names for the ports and your user defined names. This setting is automatically stored and used again in later sessions. You can change the label display by clicking on the cycler or by pressing key 'd'. Cycle sequence: Setting the bitrate Routing serial data from one MADI stream to another can be accomplished not knowing the bitrate of the underlying data stream. But if you want to route to or from a hardware port, the bitrate has to be set. In order to do this, choose the bitrate for (both directions of) the port you want to use in your routing from the corresponding checkbox on the left. You can chose between 9600, 19200, and bits/s for each port independently. page 25 of 54

26 Routing - Snapshots Snapshots A snapshot contains all routing, label, port and clock configuration settings in one single package. They can be grouped in projects, exchanged between different M.1k2 and individual parts of a snapshot restored at any time. The snapshots are stored in each user's individual directory. Creating a Snapshot To create a snapshot in the channel matrix, press the key 's' or push the 'SNAPSHOT' button in the toolbox. In the port matrix, serial matrix or MIDI matrix, use the icons in the upper left or press the key 's'. Project (mandatory) Select the project the snapshot is filed under. To choose a project, click on "Select..". Name (mandatory) Name for the snapshot, up to 64 characters. Comment (optional) Up to 512 characters helping you or others identifying the snapshot later on. Label (optional) You can choose a color to mark the snapshot's name. Choosing a Snapshot's Project In the list on top, you can see all projects that are currently present in your user directory. The projects are sorted by their creation date; the newest projects are on top. To choose an already existing project, double click its name or select it and click on "Select". To create a new project, enter the name of the new project. Additionally, you can select a color for the project's name. To create and select the new project, click on 'Create project'. page 26 of 54

27 Routing - Snapshots Loading a Snapshot In the channel matrix, press key 'r' or click on the 'RECALL' button in the matrix toolbox. In the port matrix, serial matrix or MIDI matrix, use the icons in the upper left or press key 'r'. Here you can browse through all projects and the snapshots they contain, which are stored in your M.1k2's user directory. Snapshots are sorted by their creation date; the newest snapshots are on top. If a snapshot has a comment, it is displayed in the lower area when the mouse moves over the snapshot's name in the list. Select the project and the snapshot you want to recall. Then select what items you want restored in the lower area. Both the online and offline matrix are stored in a snapshot. You have seven options what to do with the stores matrixes: Do nothing On On On Off Off On Off Off On On, Off Off On Off, Off On Don't restore any of the two. Restore the snapshot's online matrix into the device's online matrix. The device's offline matrix remains unaltered. Restore the snapshot's online matrix into the device's offline matrix. The device's online matrix remains unaltered. Restore the snapshot's offline matrix into the device's online matrix. The device's offline matrix remains unaltered. Restore the snapshot's offline matrix into the device's offline matrix. The device's online matrix remains unaltered. Restore both snapshot's matrixes as they were when the snapshot has been stored, aka I want everything as it was! Restore both matrixes, but swap on- and offline. page 27 of 54

28 Routing - Snapshots Snapshot Maintenance To delete, download or upload snapshots, go to User My files. In the upper section you find a list of all snapshots in your user directory: To download a snapshot from the M.1k2 to your computer, click on the disc symbol between the snapshot's timestamp and the check box. To delete a single snapshot, mark its check box and press the button 'Delete selected'. To delete a project, mark its check box (the check boxes of all snapshots inside the projects become marked as well) and press the button 'Delete selected'. A project is deleted of all its snapshots are deleted. To import a snapshot to the M.1k2, press 'Choose File', navigate to the file on your computer and click on 'Import!'. If the file was a valid M.1k2 snapshot file, it will appear immediately in your user account. Note: The snapshots created before the update do not have project or snapshot names. To import such a snapshot, please go into the channel matrix and press key 'R' (Shift- R) or Shift-Click on 'Recall', then store the imported data with the regular Store Snapshot function. page 28 of 54

29 Configuration - Configuration Ports Configuration A MADI signal contains information about its format (56ch / 64ch) and base sample rate. The M.1k2 will detect this information automatically. The scaling factor (speed mode 1FS / 2FS / 4FS) has to be configured to interpret the signal correctly. I.e. 1FS = 64 (56) audio channels, 2FS = 32 (28) audio channels, 4FS = 16 (14) audio channels If PolySync is enabled the clock source can be set for each port individually. The output signal of a port is defined separately to allow format conversions related to the input. E.g. 56ch signal to a 64ch signal or changing the frame structure of a 2FS signal from 48kFrame to 96kFrame. Note: There is no sample rate conversion provided inside the M.1k2. Configuration Ports Go to Configuration Ports or click on the port status LEDs in the status bar. Title Bar You can choose the port to configure by either clicking on the LED in the status bar, or by incrementing/decrementing the port number with the arrow buttons next to the title. Additionally you can use the cursor left/cursor right keys. If you have activated user labels, the title shows not only the port number, but also the input and output port names you have given, as seen above. Input status On the top of each port's configuration page, you can see details about the port input signal: Sync status shows you the current sync state (no signal, lock and sync), and when the last change occurred. Clock reference shows the clock reference that is currently in effect. Depending on wether Follow Port or Master clock override are active, this does not necessarily have to be the clock reference you have configured in the clock configuration section. Speed mode shows the speed mode that is in effect currently. Depending on whether Follow Port or Master FS override are active, this does not necessarily have to be the speed mode you have configured in the clock configuration section. Frequency is the measured sample rate currently present at the port's input. MADI channels shows the incoming MADI channel number, 56 or 64. MADI frame shows the incoming MADI frame mode, 48k or 96k. page 29 of 54

30 Configuration - Configuration Ports Clock Configuration The input and output of each port always use the same clock reference and speed mode. It is not possible to change them individually. The clock reference is used to check the incoming signal against for synchronicity, and it is the clock source for the outgoing MADI stream. Clock reference selects the clock source for the port. You cannot configure the clock reference if Master clock override or Follow Port are active. Speed mode sets the S/MUX mode for both the incoming and outgoing MADI streams. You can select 1FS, 2FS or 4FS. The number of channels will change to 64ch, 32ch and 16ch, accordingly. You cannot configure the clock reference if Master FS override or Follow Port are active. Follow port allows you to chain the clock configuration of this port to another clock configuration. Clock reference and speed mode of the source you choose here will be mirrored as long as this function is enabled. Follow Port If Follow Port is active, the clock configuration elements are disabled and clock reference as well as speed mode are copied from the respective port. This way you can easily create clock domains where multiple ports are guaranteed to always use the same clock setting, and you can configure them with one click. You can see the current settings in the input status section or on the configuration page for the clock source you have chosen to follow. Master Override If Master clock override or Master FS override are in effect, the corresponding configuration elements are disabled. You can see the current settings in the input status section or on the word clock configuration page (see page 33). page 30 of 54

31 Configuration - Configuration Ports Input Configuration The M.1k2 allows you to define any two MADI inputs to be redundant to each other. In case one of the incoming signals fails, the signal of the still working port is used instead. The current status of your input redundancy is always visible on each port's configuration pages and in the status bar: If the incoming signals differ in clock or MADI mode/frame, the indicators turn yellow and give you a description of the condition. In case of an error, they turn red: Output configuration The output configuration section allows you to set the properties of the outgoing MADI signal: MADI channels sets the number of audio channels MADI frame sets the frame type used for 2FS mode. Note: At 1FS there are 56/64 channels available for each MADI port, respective 28/32 channels at 2FS and 14/16 channels at 4FS. page 31 of 54

32 Configuration - Configuration Ports Channel Routing The channel routing panel lets you inspect all the sinks for the incoming channels and the sources for the outgoing channels at once. Locked channels are displayed dimmed, while connections with (probably) asynchronous ports are highlighted in red. Examples: A single route in the input channel section. This input channel is routed to port 1, channel 28. In the output channel section this would indicate that the source for this output channel is port 1, channel 28. No routes for this input/output channel active. This input channel is routed to multiple output channels, channel 1 on ports 1 3. The cycle box on the upper right lets you switch between system labels and user provided labels for the channels and ports. A click on the cycle box switches or pressing key 'd' cycles through the settings. page 32 of 54

33 Configuration - Configuration WCK Configuration WCK Clock sources The device offers 21 word clock sources: MADI inputs 1-16 Word clock input Video input (derives 44.1kHz and 48kHz simultaneously) Internal generators (44.1kHz and 48kHz) You can use any of these sources as main reference for the device. Alternatively you can use a separate clock reference for each port (PolySync ). PolySync You may run the M.1k2 with multiple clock sources at a time. Once PolySync is activated you may sync each port of the M.1k2 to an own clock source. This provides the possibility to setup clock groups. E.g. Port 1 and Port 2 are clocked by 44.1kHz and Port 3, Port 5 and Port 8 are clocked by word 48kHz. Note: There is no sample rate conversion provided by the M.1k2. Routing between ports that are not in sync to each other may result in unwanted signals at the output. Master Clock: Using a single clock reference In most situations, the M.1k2 will only use a single word clock source on all ports. This is also the default when you take the device out of the box. To create a single clock reference setup, select your preferred clock source in the section 'Master Clock' and activate the checkbox 'Use clock setting for all MADI ports + WCK' as well as 'Use FS setting for all MADI ports'. All inputs and outputs now run with the selected clock and speed mode. Word clock inputs On the top of the page the M.1k2 displays details about the word clock and video input. Erroneous states such as lock (instead of sync) and no signal are printed red. page 33 of 54

34 Configuration - Configuration WCK Video input for PAL or NTSC signals (left) and word clock input (right). The M.1k2 derives two word clocks from the incoming video signal simultaneously, 44.1kHz and 48kHz. Termination The word clock and video input both have a switchable 75 Ω termination. If the M.1k2 is the last device in a chain, enable the termination. It can only be activated for both inputs simultaneously. Word clock output The M.1k2 has two word clock output ports at the front panel. You can route any of the 21 word clock sources to those two ports. To route a word clock source to the output ports, simply select it in the word clock output section: Clock source selects the word clock reference you want for both word clock outputs. WCK FS The right port can have a different multiplier as the left one, based on the same clock reference. Follow You can let the word clock output join a clock domain to follow another port's clock reference and multiplier setting. The right word clock output port may have a different multiplier assigned to. page 34 of 54

35 Configuration - Configuration WCK PolySync : Using multiple clock references To select individual clock references for the MADI ports, make sure the master override function is disabled (see above). You can then select any clock reference you wish in the column Clock source of the table PolySync Clock References. Additionally, you can choose individual clock multipliers for each port in the row FS. In the picture above you can also see a clock domain created by the Follow Port function. Ports 2 and 3 are configured to follow port 1: Whatever clock reference and multiplier is selected for port 1 will be in effect instantly for port 2 and 3 as well. In the status columns you can see that the three ports have the same configuration regardless of the clock source configuration of ports 2 and 3. The column Frequency shows the measured word clock frequency. It is updated once per second. Note: Whenever different word clock references are in effect, the PolySync indicator in the status display lights up: page 35 of 54

36 Configuration - Configuration Device Configuration Device Network settings The device supports different network setting sets. With those you can define settings for different use case scenarios and switch between them with just one click. In order to change a network configuration, please log in as administrator, go to Configuration Device Network settings and press the 'Edit' button of the network configuration you want to edit. Note: After changing the network setting the IP address of the device may have changed. So the browser will not response until you enter the new IP address Emergency recovery If you somehow managed to create a configuration where you cannot access the device any longer, but are able to reach the device physically, you can perform an emergency procedure that resets the network configuration. See the section ' Emergency Recovery at page 52 for details. General settings Status Configuration name Host name If the shown network setting is not the active one, a button allows you to quickly activate it. A descriptive name for you to recognize the settings. Identifier for the system. Allowed characters are lower case characters, numbers and the underscore (a-z, 0-9, _). Changing the host name needs a reboot of the controller to take effect. page 36 of 54

37 Configuration - Configuration Device Network settings If you have a DHCP server in your LAN and want to use it to configure everything (including the IP address of the device) automatically, just select the DHCP option. If you cannot connect to the device after activating DHCP configuration, please check your DHCP server s configuration or reset the device to the factory preset as last resort. For manual configuration, select Full manual setup. If you don t know what those values are, please refrain from using this option or read the document 'Hardware & Installation Guide' (available at before set up. IP address Network mask Gateway address DNS 1 DNS 2 Address of the M.1k2 within your local network. Must be unique. defines number of available IP addresses within the network Address of the network router Address of first Domain Name Server Address of second Domain Name Server page 37 of 54

38 Configuration - Configuration Device NTP configuration The Network Time Protocol automatically adjusts the system s clock and keeps it synchronous to a master clock. In order to use it, you must either provide your own NTP service or provide an internet connection to facilitate one of the servers on the internet. Use NTP Timezone NTP Server If enabled, the system sets its time using the NTP settings you provided. If you disable NTP, the system starts on January, 1st 1970 every time it is booted. Select the time zone the device is located in. You can find a more detailed list of time zones here. Provide up to two NTP servers, either via IP address or host name. The NTP daemon connects to the first NTP server with a higher priority. Links NTP: Time zones: Syslog configuration Syslog is a standard service on UNIX systems to filter, forward and distribute messages from applications and the system itself. Using the options in this panel, you can easily setup a forward of all syslog messages to one of your syslog servers. Forward syslog Syslog server IP Syslog server port If enabled, a forwarding syslog daemon is set up using the settings you provided. Enter the IP address of your syslog server. Enter the UDP port of your syslog server. Verifying the syslog configuration After pressing the button, the device generates a series of syslog entries, one for each log level from 0 (EMERG) 7 (DEBUG). Links Syslog: RFC 5424: page 38 of 54

39 Configuration - Configuration Device Contact settings Purpose The contact information is supposed to be of service when local assistance is needed. It is always displayed at the login screen or accessible via the contact link in the status bar. Configuration Device name Contact Here you can give the device a unique name that helps you identify it if help requests arrive. You are free to name it any way you want. This is not the network host name. The host name is set in the network settings - page 37. Enter up to 500 characters with your contact data. It should contain immediate contact data of the administrator or help desk. Changing the contact data will become effective immediately. GPO configuration Electrical specification You can find the technical details about the four GPO ports in the front panel section (page 10). Configuration For each of the four GPOs, you have a row with the current status and three configuration options: Manual Event automation Polarity With this checkbox you can switch the GPO manually. Note: If you have an automation configured for that GPO, and the automation source triggers an event, the GPO will be switched, thus overriding your manual setting. Chose an event from the list which will then trigger the GPO. The switching is event triggered, so only if the state of the event source changes, the GPO's level will be updated. Until then it keeps the current value. Normally, the GPO will be turned on if the event's trigger source is active. With the polarity switch you can invert the GPO switch. page 39 of 54

40 Configuration - Configuration Device Temperature management Current state The 'Fan' panel gives you detailed information about the current temperature and fan state as well as a simple way to configure the device's fans. The current temperature is indicated by the horizontal position of the blue dot in the graph, the fan level by its vertical position. It travels along the line that connects the green, yellow and red dots. Configuring the fans You can either drag the green, yellow and red dots along the upper and lower horizontal borders of the graph, or enter the desired temperature levels in the text fields below. Changing the settings will become effective immediately. Status LED configuration Configuration The changes you make here will become effective immediately. Blink when unsaved data is present To lower the wear on the flash chips used to store the configuration data, changes are saved 10s after the last modification - or if the oldest unsaved data becomes 60 seconds old. In other words: If the power fails under heavy editing, you should never lose more than the last minute. To give you an indicator when it is safe to power down the device, you can activate this setting. Whenever there is unsaved data present, the status LED will flash with a 100ms period (for a visual aid see the front panel section (page 10). Enable heartbeat when idle Some people like beating status LEDs to know that a device is still alive, others tend to become nervous if they see a blinking light. Chose your personal favourite behaviour for the controller's status LED when idling. page 40 of 54

41 Configuration - Configuration Device Firmware update Offline update For the offline update, we provide update archives on the DirectOut web page. The update is a two-step process: In the first step, the update archive will be uploaded to the device, unpacked and its integrity checked. If the archive checks out ok, a new page gives you detailed information about the changes that are about to be made and asks for your confirmation. After you confirm, the update process begins. Please do not turn off the device during the update. Note: It is recommended to clear the browser cache after the update to ensure proper browser behaviour at next login. page 41 of 54

42 Configuration - Backup, restore and wipe configuration Backup, restore and wipe configuration Backup To backup the complete configuration data, just press the button. After a few seconds (in which the archive is compressed to save space), your browser will download an archive with the device settings and all user data. Restore When restoring a previously generated backup archive, you can chose what parts of the archive you whish to restore: Only the device configuration without replacing all the user accounts and data, only the user data, or both. Depending on your choice it might be possible to either reboot the device or log out and back in. Warning: Replacing the user data also overwrites the administrator's account. Make sure you have all the authentication credentials at hand! Note: If you replace the device's configuration, it will behave exactly the same way it did when the backup was made. That includes the network configuration. If you cannot find your device again after the reboot, it probably uses an old network configuration. See the section about recovery (page 52) on how to deal with that situation. Wipe This description says it all: If you want a fresh start or give back a rented device, press this button. A confirmation dialog will make sure you didn't click by accident. page 42 of 54

43 Tools - Tools Monitoring Tools Tools Monitoring The monitor tool allows you to see the signal status of all 1024 incoming channels at once, and select any mono channel/stereo pair of channels to listen to on your monitor bus. A lot of information is displayed at once in the monitoring tool. Lets break it down: Input port speed and channel mode The input speed mode is indicated by showing you how much space a single channel consumes in S/MUX mode. The placing of the channels is accurate in reference to 1FS. If the input signal is in 56 channel mode, the last 8/4/2 (depending on the speed mode) channels are blanked out. Input signal/sync state Different colours indicate the sync state of all inputs relative to the monitoring output port. Green signals and no background colour: The input uses the same word clock reference and speed mode as the monitor output port, and it is in sync state. A healthy signal! Yellow signals and yellow background colour: The input has the same nominal word clock and same speed mode as the monitor output, but a different word clock reference. That means it could possibly be asynchronously, but we do not know for certain. This is probably just a setup problem. Red signals on a red background: Different speed mode, different word clock reference, no signal or just locked. This signal, if present at all, is in no condition to be routed to your monitor output. page 43 of 54

44 Tools - Tools Monitoring Signal present The signal display is updated once per second. If a signal peaks -60 dbfs in that period, the corresponding channel is highlighted. Dead channels The router keeps track on which channels it has encountered a signal since the start or the last reset of the dead channel table. If you enable the dead channel layer, all channels that never carried a signal greater than -60 dbfs are darkened. Peeking into channels The channel(s) you currently listen to is highlighted. To change the monitor source, just move the mouse over any other channel and press the left mouse button. The routing will be changed permanently. If you want to peek into multiple channels, keep the left button pressed for longer than half a second. The cursor starts blinking to indicate this time out. While keeping the left button pressed, move the mouse around: The routing changes while you are moving over the channels. Once you release the left mouse button, the monitor routing returns to its previous setting. page 44 of 54

45 Miscellaneous - Misc Version Miscellaneous General information about the device, used licenses and supporting tools. Misc Version Technical details about the device configuration. System information This panel contains the version information for the base system. Device information This panel displays information about the FPGA's firmware, hardware version and serial number. IO Boards For every IO board that is present, its current state, serial and the type of IOs are listed. Plug-ins All installed plug-ins are listed with their version information. page 45 of 54

46 Miscellaneous - Misc Livelog Misc Livelog The livelog protocols all actions and state changes as long as the page is visible. Event types Status entries are generated if a monitored entity changes its value. Those entities are for example the device's temperature, the sync state of a port or frequency changes of the word clock. Status entries are displayed with a yellow background. Configuration entries include everything that involves interaction with a user or a controlling program. They are displayed with a white background. Warnings are status or configuration entries that lead to an erroneous state. They are displayed with a red background. Filtering Events can be filtered by checking and unchecking the corresponding checkboxes in the header. page 46 of 54

47 Miscellaneous - Misc Support Misc Support In the case of malfunction or unwanted behaviour of the device or a feature request you may contact us. Support archive In case you encounter a problem that needs support, we have added a function that produces an archive which contains your current configuration, log files and a dump of the current device status. The data in this archive can help us to reproduce software based problems or decide upon further steps. To produce a support archive, just press the button. Gathering all information takes a few seconds, after which the browser downloads the file. If you have a support case, please send us the following: this support archive (directly after the problem occurred, do not turn off or reboot the device), a step-by-step description how to reproduce the problem (if possible), if it is a display problem or visible effects appear: A screenshot and the browser's version. page 47 of 54

48 User - User My files User In the user section the local files - such as snapshots and user accounts - are organized. User My files Existing snapshots may be imported and deleted here. See Snapshot Maintenance at page 28 for more details. User My account User account data is organized here. Backup account Creates an archive containing all your user data, including snapshots and the way you configured the control surface. You can use this archive to backup your data or replicate it to another M.1k2. Restore account Restore a user profile or replicate settings from another M.1k2. Note: All your settings will be overwritten, with the exception of your name, password and other authentication credentials. Change password Change the login credentials for the current user. You need the current password to change it. Wipe user data Wipe all data except name, password and other authentication credentials. page 48 of 54

49 Plug-ins - Telnet Plug-ins Telnet The device offers a telnet interface that can be used interactively or for automation purposes, be it with scripts or programs. Most features can be configured through the telnet interface, and you can activate status feedback to monitor the device. Using telnet manually You need a telnet client to connect to the telnet service. On OS X and Linux, all you need is to open a terminal and connect to the service: You can get a list of the possible commands at any time by typing 'help': page 49 of 54

50 Plug-ins - Telnet Detailed help To get more details about the parameters and its values, enter the command without parameters: Feedback By default, configuration feedback is turned of. If you want to see feedback for your commands (and the configuration changes of other people working on the same device), turn it on with config on: A similar feature switches on status feedback, status on. Using telnet with scripts Since all you send to the telnet service is ASCII commands, you can easily type them in a text file in advance and then send the whole file to the telnet service. This way you can easily automate things. In this example we create a script that unlocks all channels, create a 1024 channel 1:1 matrix and set the clock source to word clock input. Since there is no command to unlock all channels, we simply create 1024 unlock commands in the terminal: The resulting file can now be sent to the device: page 50 of 54