Home

Kiss-Box Software manual (includes protocol description)

1. e f you will set On the Fihft relay in slot 4 you sent A5 03 04 01 e f you will read the status of the same relay you sent A2 03 04 01 and the I O Box reply the answer A3 03 04 01 e f you will set On the 8 relay in the slot 7 you sent A4 06 01 01 01 01 01 01 01 01 10 2 1 0 Kiss Box with ArtNet protocol The I O Kiss Box can also run an ArtNet compliant firmware With this firmware the I O Kiss Box uses incoming ArtNet messages to control the output cards Input cards are used to produce outgoing ArtNet messages To have a complete description of the ARTNET protocol please consult chapter 11 1 6 This firmware is different from the Kiss Box protocol firmware You will need to use the Uploader to modify the firmware in the I O Kiss Box Double click on the ArtNet icon the bulb in the Network Tree on the main window to open the configuration window ArtNet I O Master Setup D DMX Base Channel 189 v Universe In TR lt a Monitoring Universe Out 38 v a Monitoring Upload Restart box 29 52 Software user s manual Revision 1 5 The ArtNet I O Kiss Box can be placed on any DMX channel within a given DMX universe Each slot uses eight consecutive DMX channels whatever the number of I O points of the card The DMX Base Channel parameter in the configuration dialog defines the DMX channel used for the first input or output in the first slot
2. E g if the DMX Base Channel is 89 the card in the first slot will use DMX channels 89 90 91 92 93 94 95 and 96 The card in the second slot will use DMX channels 97 to 104 and so on To activate an output the value to send on the corresponding DMX channel must be greater or equal than 128 otherwise the output is deactivated An activated input produces a DMX value of 255 A deactivated output produces a DMX value of 0 Universe numbers are seen from ArtNet controller point of view e Universe In is the universe number of which inputs statuses will be sent e Universe Out is the universe number used to control the outputs 10 3 Digital Output card configuration When UDP protocol is chosen for the I O Master card it is possible to activate a specific option on output cards the Automatic Timed Control This mode is not available if the Master is configured in TCP or with the ArtNet firmware When Automatic Timed Control is activated the control software must send command messages to the Output card on a regular basis If the controller stops to send the control messages all the outputs of the card are deactivated after the selected time Output configuration UID 253 Slot 3 I Automatic timed control 0 ms time out value max 65000 a Monitoring E g if time out value is set to 1000 milliseconds the control software must send a command message to the corresponding output card at least once every sec
3. IN cSt Pancene enen n ral rallada 33 11 1 4 MORON 22 a do 33 MRS TOPIP USer Protocol reeter eee dii 34 11 1 6 TCP IP Description of Command sese eee eee 35 11 1 7 ARTNET Protocol Description cccccoccocnooonncononcconococcnannnnnnnnos 35 11 1 8 ARTNET Good PAC cunt ad A 36 11 1 9 ESTA Informati n enee a an 36 12 CemurMIDIKISS BOA scott todos 37 Aled OSM AMS AAA A A a Eds 37 121 2 gt ESMUESCUID rada cta AAA AENA AAA 37 121 3 P TTS Esi s LT 38 12 14 MONTORO O A AA A 39 13 APENAS ieee eat att else ete 40 13 1 Specific addressing modes for advanced network USEIS eeee 40 13 1 1 Duplicate IP addresses ncidoscenx ates ds BIE 40 Seles Mulata ee ee eas 40 13 1 3 SUDNEU BIOAUCAS iia yl AA ASA AAA AAA AA seeneen 40 13 1 4 Global BIGAdGAast iii A A nnne neee 41 14 APpenoo B aos dto beds 42 14 1 Resetting the Kiss Box to the default factory settingS cccccccccccc 42 14 1 1 Factory T TT 42 141 2 le ts AA tee nn Bie eet ei st 42 15 APPLE T een te ron terre err ney iter epee ere eer ree A 43 15 1 Installing Kiss Box RTP MIDI WinXP drer 43 15 1 1 Recommended configuration sss sese 43 15 2 Kiss Box RTP MIDI WinXP driver Configuration sese eee eee eee eee eee 47 15 3 Removing Kiss Box RTP MIDI WinXP der eee eee 49 16 REVISION STO solas 52 Software user s manual Revision 1 5 3 1 1 Requirements In order to be used the Kiss Box Editor requires e PC with Win
4. Box will not work properly If you load the wrong firmware in a Kiss Box it will not block the Bootloader You can then load the correct firmware at any moment without any risk When the firmware file has been selected you will be asked to do a final check Press Next button to start the file transfer The Editor will then transfer the firmware file into the Kiss Box Once the file is transferred the Editor will read back the Kiss Box memory to verify that the transfer was completed and correct These steps are completely automatic When the firmware transfer and check are completed the Kiss Box will restart automatically in firmware mode A New versions of firmware may include new parameters that did not exist in the previous configuration memory The new firmware may then consider the configuration as corrupted and have a weird behavior It is then recommended to make a factory reset of an upgraded Kiss Box followed by a reconfiguration using the Editor 16 52 Software user s manual Revision 1 5 7 1 Some things you need to know A Dual MIDI Kiss Box offers four MIDI ports e Two MIDI IN ports namely MIDI IN 1 2 e Two MIDI OUT ports namely MIDI OUT 1 2 Each MIDI port uses the RTP MIDI protocol as defined by the IETF Internet Engineering Task Force RTP stands for Real Time Protocol which is a UDP based protocol already widely used for real time audio and video applications Note that RTP MIDI is
5. Monitors T 89 Network adapters HY Ports COM amp LPT Y Processors 7 9 Sound video and game controllers Audio Codecs O ME 0 Legacy Audio Drivers Legacy Video Capture Devices 9 Media Control Devices Realtek AC 97 Audio for VIA R Audio Controller video Codecs Y z Storage volumes 4 Select the KISS BOX Midi entry then click on the Uninstall driver button the computer with a red cross on it or open menu Action and choose Uninstall Confirm that you want to remove the device The KISS BOX Midi driver is then removed from the system You will need to reinstall it if you want to use the KISS BOX Midi driver again in your applications 51 52 Software user s manual Revision 1 5 16 Revision history Issue Date Comments 1 0 11 2006 First release Added section for Lemur Kiss Box 1 1 03 2008 Added details for KB2 file upload Added details for MIDI driver under Vista New layout Added WIN driver procedures 1 3 26 10 2008 Added COM4 section 1 4 26 01 2009 Added DMX TCP IP protocol 1 5 27 02 2009 Added DMX TCP IP command description 1 2 10 2008 52 52
6. Out the Kiss Box will recognize and respond to Please note that In and Out are given from controller direction so Universe In is the Universe to which incoming DMX data will be sent Reciprocally Universe Out is the universe number on which the Kiss Box will listen for data to be sent to DMX Out 32 52 Software user s manual Revision 1 5 Note that Kiss Box uses the modern Universe numbering with only one number but it supports also the old numbering subnet universe concept Please refer to ArtNet technical description for details about the translation between subnet universe numbering and direct universe numbering The selected mode and associated parameters are stored in EEPROM Once configured the Kiss Box will restart using the selected mode Note that you need to restart the Kiss Box to activate the selected mode 11 1 2 DMX OUT setup You can modify the DMX OUT timing parameters using the DMX OUT control section Note that the values are not stored in EEPROM since standard values are used at reset 11 1 3 DMX IN setup You can modify the DMX In Start Code using the DMX IN control section Note that the value is not stored in EEPROM since standard value is used at reset 11 1 4 Monitoring The DMX IN and DMX OUT streams can be monitored in real time Click on the Monitoring button for the desired direction DMX IN or DMX OUT to display the monitoring window This window displays DMX values f
7. box 25 52 Software user s manual Revision 1 5 9 1 4 Control protocol Send serial data to port command Port number 1 byte Reserved Number of data byte to send 1 byte Data bytes to send n bytes A8 00 to 03 00 00 to FF 1 to 255 Your data The number of data bytes in the message must match the value given in the header Read data from serial port command A9 Port number 1 byte 00 to 03 The Box then answers with the following message command SAA Port number 1 byte 00 to 03 Number of data byte that have been received 2 bytes 0 to 1024 Data bytes received Your data 26 52 Software user s manual Revision 1 5 The I O Kiss Box is a modular model that offers 3 or 8 extension slots which supports various digital and analog inputs and outputs I O cards This I O Kiss Box supports two different firmwares to command the output cards and read the inputs cards e the Kiss Box protocol e the ArtNet protocol You will need to load a different firmware two different firmwares exist if you want to change the protocol used to communicate with the I O Kiss Box Please refer to chapter 5 for details about changing updating the Kiss Box firmware 10 1 I O Kiss Box with proprietary Kiss Box I O protocol This section describes the settings applicable to the Kiss Box protocol firmware The protocol configuration is ma
8. current s ix Sound Effect Ma AC97 Audio Control sounds and Audi Change the sound s dl Speech Change settings for Tavan See information aho Installs and troubleshoots hardware 4 2 Double click on System icon The System Properties dialog then opens Click on Hardware tab System Properties Ax System Restore Automat Remote General Computer Name Advanced r Device Manager The Device Manager lists all the hardware devices installed on your computer Use the Device Manager to change the properties of any device Device Manager p Drivers a Driver Signing lets you make sure that installed drivers are compatible with Windows Windows Update lets you set up how Windows connects to Windows Update for drivers Driver Signing Windows Update m Hardware Profiles Hardware profiles provide a way for you to set up and store different hardware configurations Hardware Profiles 50 52 Software user s manual Revision 1 5 3 Click on Device Manager button then click on Sound video and game controllers entry to expand the corresponding tree level AE File Action View Help gt 10498 9 R8 Y 2 Computer 2 T e Disk drives Y Display adapters FQ DVD CD ROM drives Y Floppy disk controllers HG Floppy disk drives H E IDE ATA ATAPI controllers H 5 Keyboards H Mice and other pointing devices E a
9. for example at 192 168 0 253 254 5 2 4 Scan Delay The Editor can automatically locate all Kiss Boxes connected to the network by scanning them To do this the Editor sends a specific message to all Boxes and waits for a given time to receive an answer If no answer is received during this time the Editor considers that there is no Kiss Box at the tested address and passes on to the next Kiss Box UID The Kiss Boxes independently always answers very quickly to the Scan message sent by the Editor less than one millisecond But in cases of larg networks or networks heavily loaded the message can take a non negligible time to reach the Boxes The answer can also take some time before it returns back The Scan Delay value lets you define the time you want the Editor to wait for an answer before scanning the next address The minimal value 50 milliseconds is generally quite adequate for most LAN applications The maximal value 500 milliseconds should be used for very large networks or when you experience problems to detect some Kiss Boxes during network scan Note that scanning a complete network group can take a long time E g scanning all UIDs between 0 and 254 with a 500 milliseconds Scan Delay takes 128 seconds You should then set the Scan Delay to the minimum value compatible with your network configuration or restrict the Scan Range to fit your needs 5 2 5 Blocking Scan The blocking scan feature can be used i
10. is the Box address in our example Take a look to computer s MIDI OUT Port 1 you can see that it is configured to send MIDI data to port 5004 In networks world this is written as 192 168 0 253 5004 Now look at Box MIDI OUT 1 parameter you can see that it is listening on port 5004 while the Box is configured to be at address 192 168 0 253 All messages received on this port will then be transmitted to MIDI OUT 1 connector Technically speaking we say that computer s MIDI OUT Port 1 is logically connected to Kiss Box MIDI OUT 1 since the IP address and port parameters are the same It is exactly done the sameway with MIDI Port 2 using network port 5006 You can ask yourself what will happen if the computer is configured to send data on a port let s say 5040 with a Box listening on a different port let s say port 5060 The answer is nothing The Box will simply ignore any data received on a port that it doesn t listen to even if the IP address is the same 18 52 Software user s manual Revision 1 5 In the reverse direction the principle is exactly the same The Box is configured to send MIDI data received on MIDI IN 1 connector will be sent to 192 168 0 3 5008 remember that this notation means IP address 192 168 0 3 port 5008 Since the computer is located at this address and configured to listen on port 5008 it will receive MIDI data sent by the Box from MIDI IN 1 And it s the same for MIDI I
11. s MIDI port is then connected to the corresponding physical MIDI port on the Kiss Box gt Save the configuration before exiting the setup page The MIDI Kiss Box shall be displayed in bold black characters on the Lemur setup screen A grayed name means that the Kiss Box daemon can not be reached by the Lemur 12 1 3 MIDI merge In order to simplify Lemur s integration in a MIDI setup the Lemur MIDI firmware performs a merge between the MIDI stream produced by the Lemur and the incoming MIDI stream received on the MIDI IN connector MIDI messages received on a MIDI IN connector are transferred directly to the corresponding MIDI OUT connector The same MIDI OUT connector will provide the MIDI messages produced by the Lemur A typical application is to connect a master keyboard to the MIDI IN connector of the Kiss Box and a sound generator to the MIDI OUT connector The sound generator will then be controller transparently by the keyboard and the Lemur in parallel Note that MIDI merge function works even if a MIDI OUT port is not connected to a Lemur s daemon port This allows your MIDI setup to remain usable even if your Lemur is not powered or disconnected from the network 38 52 Software user s manual Revision 1 5 12 1 4 Monitoring The Kiss Box Editor includes a monitoring function for the Lemur MIDI Kiss Box firmware To open the monitor window double click the Lemur MIDI Kiss Box in the Box tree on the main win
12. the only existing and actively supported open implementation proposed to be a worldwide standard Major manufacturers like Apple have already chosen it for their own products Each RTP MIDI port is associated internally with a network port number It is necessary to understand the link between MIDI and network ports to be able to understand how to configure your RTP MIDI network completely A good image to help you understand the concept of ports is to compare the IP address to a building address in a city the city is the network here Inside the same building you can have different apartments each of them with its own number In the networking world the building addresses are the IP addresses and the apartment numbers are the port numbers A MIDI Kiss Box can be seen as two independent MIDI sub units each one with one MIDI IN connector and one MIDI OUT connector Each MIDI sub unit uses two network ports e The Session Control Port e The Data Port If you want to send MIDI data to MIDI OUT 1 connector on a given box you need to know the Box IP address and the Data Port on which the Box listens to the MIDI data The same requirement applies to MIDI OUT 2 of course Note that MIDI OUT 1 and MIDI OUT 2 must have different port numbers otherwise the Box would not be able to distinguish what data should go to what MIDI OUT port You should understand now that the Box must also know where to send the MIDI data it receives o
13. 2 52 Software user s manual Revision 1 5 Clicking the Restart Box button will restart the CPU of the selected Kiss Box This will perform a soft reset on the selected Kiss Box In case you cannot see the Kiss Box you ve reset the Editor provides you feedback by using the following dialog box to confirm that the Kiss Box has been reset Kiss Box reset ES e 1 The Kiss Box has restarted 5 9 3 Restart To restart a running Kiss Box without the use of the Editor software simply disconnect the RJ45 Ethernet connector As the unit is powered with P O E disconnecting the network jack will also interrupt the power supply Wait 2 seconds and reconnect the Network POE cable the Kiss Box will now restart with its last uploaded setting 13 52 Software user s manual Revision 1 5 6 Updating Kiss Box firmware Any Kiss Box contains two programs the application firmware dedicated to a specific extension module MIDI DMX I O LTC etc and a protected program named the Bootloader The Bootloader allows the user to update or change the application firmware For example when there is a new version is available This avoids sending the Kiss Box back to the factory The Kiss Box firmware is updated through the Ethernet network using the Upload function of the Editor When uploading a Kiss Box make sure that no other Kiss Box is in Bootloader mode on the same network and that no other node is usin
14. ATP messages correctly received 0 RTP messages received with error MIDI OUT 2 5477 ATP messages correctly received 0 ATP messages received with error 21 52 Software user s manual Revision 1 5 The LTC MTC Kiss Box is a derivative of Dual MIDI Kiss Box The main difference is that MIDI IN 1 and MIDI OUT 1 are replaced by a LTC coprocessor producing receiving LTC signals MIDI Time Code received on MIDI IN 1 is transformed into the corresponding LTC analog signal output All other MIDI messages are ignored on this channel The incoming LTC signal is converted into MTC messages sent on MIDI OUT 1 RTP port This MIDI port does not produce any other MIDI message MIDI IN and MIDI OUT ports behave exactly as MIDI IN 2 and MIDI OUT 2 ports on the Dual MIDI Kiss Box The LTC MTC Kiss Box uses exactly the same protocol as the Dual MIDI thus installing and configuring the drivers on PC and Mac computers are exactly the same The LTC MTC Kiss Box RTP configuration is also exactly the same as for the Dual MIDI Kiss Box however some specific parameters have been included for the LTC channel Double click on the LTC MTC icon the MIDI connector in the Network Tree on the main window in order to open the configuration window Application profile C Peer to Peer C MacDS X RTP Configuration LTC MIDI Control port MIDIIN MIDI OUT Target IP address 192 168 0 252 T Full MTC message Sysex for LTC I
15. N 2 port which is transferred to 192 168 0 3 5010 7 2 Application profiles A Box can be used in different ways depending on some protocol details E g a peer to peer configuration Kiss Box talking directly to another Kiss Box will not use a session initiation protocol but the Apple Mac OS X driver uses it To simplify Kiss Box integration you will not need to define all protocol details The Editor just needs to know the configuration in which the Kiss Box will be used and it will automatically compute the maximum number of related parameters There are three application profiles defined e Peer to peer e Mac OS X e Windows XP The next chapter will describe to you what application profile you need to choose depending on your network setup 7 3 RTP MIDI Kiss Box configuration Double click on the RTP MIDI icon of the selected MIDI Kiss Box in the Network Tree to open the configuration window As explained before many RTP MIDI parameters are computed automatically in most cases to simplify network installation You just need to choose the correct application profile The parameter values are however displayed since you will need them to configure the device located at the other side of the network RTP MIDI Dual Channel x Application profile C Peer to Peer C MacOS e WinxP RTP MIDI RTP Configuration MIDI 1 MIDI 2 Control port 4995 1997 mori 4995 asso MipI OUT sos fasce Target IP address 192 fiee f
16. Software user s manual Revision 1 5 The network answer A Software user s manual A This symbol is intended to alert the user of important operating and maintenance servicing instructions in the literature provided with the equipment A This symbol is intended to alert the user of the presence of uninsulated dangerous voltage within the produc s enclosure that may present a risk of electric shock Read Instruction Read and understand all of the safety and operating instructions before using this equipment Retain Instructions The safety instructions should be kept for future reference Follow Warnings Follow all warnings and instructions marked on the equipment or in the user manual Avoid Attachments Do not use tools or attachments that are not recommended by KISS BOX Company because they may be hazardous A Power Source This equipment should only be operated from the power source indicated on the product This equipment is intended to be used with a main power system with a Neutral conductor The third Earth pin is a safety feature do not attempt to bypass or disable it Never install or use electrical equipment in a wet location or during a lightning storm A Servicing Refer all servicing to qualified service personnel There are no user serviceable parts inside To prevent the risk of shock do not attempt to service this equipment yourself because opening or removing covers may expos
17. clare more than 32 MIDI ports in your system the exceeding devices will not work For example if your system is already equipped with an MPU401 compatible MIDI device and three USB MIDI devices then you will not be able to create more than 28 Kiss Box MIDI ports the four last ports will be unavailable for the applications We highly recommend declaring and configuring only the needed number of Kiss Box MIDI ports since you may need to install other MIDI devices on your system in the future Note that you can change the number of Kiss Box MIDI ports at any moment to give room to other MIDI devices if needed Note also that the driver is reset when the configuration of any port is changed lt is then mandatory to close any MIDI application using the MIDI Kiss Box driver before changing the configuration 47 52 Software user s manual Revision 1 5 You can create change delete the configuration of any Kiss Box port at any moment using the Control Panel To access to driver configuration screen 1 Open Control Panel Start Settings Control Panel CA a Ele Edit View Favorites Tools Help amp Oe T ete E Address D gt Control Panel ELE va ees 4 Accessibility Opti Adjust your comput Installs and trouble T Add or Remove P Install or remove pr H Administrative Tools Configure administr AD Automatic Updates Set up Windows to See Also A P Date and Time Se
18. de using a dedicated window in the Editor Double click on the I O Master icon in the Network Tree on the main window in order to open the I O Master configuration window 1 0 Master Module Ixe Mode C UDP Destination IP address Joss 255 255 255 Destination Data port 9817 Upload Restart box The Kiss Box I O protocol can be transported over the network either on UDP or on TCP 10 1 1 TCP IP Protocol When used with TCP the Kiss Box is a server It awaits for connections from client and never sends data on its own inputs must be read by a specific command to know their status The main advantage of TCP is the reliability of the connection in case of a network problem if a message is not delivered correctly the TCP protocol will automatically repeat the message The main disadvantage of TCP is that the complete protocol cycle can be considered as long over a heavily loaded or huge network more than 100 milliseconds in some case 27 52 Software user s manual Revision 1 5 If you choose TCP protocol you do not need to define any further network settings since the Kiss Box is always a server and will automatically know all necessary parameters from the remote client 10 1 2 UDP IP Protocol With UDP protocol there is no client and no server This protocol has many advantages against the TCP e Multiple computers can control the same I O Kiss Box e g one computer controls the first ou
19. ding a Box manually does not clear the previous entries in the Network Tree Note that the entered UID does not need to be in the defined scan range 5 7 Network Tree The Network Tree on the left side of the main screen will show all the detected Kiss Boxes after a network scan or Boxes added manually Kiss Box Editor als ES Network Upload firmware About 241 DMX 1 0 Box Properties VY DMX Application type i 251 Dual MIDI Firmware version Vendor ID o RTP MIDI MAC Address H 253 1 0 8 slots ArtNet pro 52 ArtNet Network configuration a sate KissBox address TCP Port mpty NX DO4R Subnet Mask TCP Mirror Port Dx Empty Gateway address UDP Port x Empty Dx Empty Editor port Zb Upload Restart box Empty Trying to connect to box 251 Found box 251 Trying to connect to box 252 Trying to connect to box 253 Found box 253 Trying to connect to box 254 Network scan done Trying to connect to box 253 Found box 253 gt e Scan network A single click on a Kiss Box in the Network Tree will display the Box properties on the right side of the window A double click on the extension module extension modules are DMX RTP MIDI ArtNet etc will open the corresponding Editor window for the specific firmware 11 52 Software user s manual Revision 1 5 5 8 The Log Window The Log window on the lower part of the main screen reports the status of the communication wit
20. dow Click the Monitoring button on the edition window The monitoring window is then displayed This window is continuously refreshed so you can see directly what happens on the MIDI lines Lemur Daemon MIDI Monitoring E x MIDI IN T 29 message s sent to Lemur MIDI IN 1 is linked to a remote Lemur MIDI IN 2 0 message s sent to Lemur No Lemur connected to MIDI IN 2 MIDI OUT 1 42 message s received from Lemur MIDI OUT 1 is linked to a remote Lemur MIDI OUT 2 58 message s received from Lemur MIDI OUT 2 is linked to a remote Lemur The monitor window displays the connection status of each Lemur s daemon port When a daemon port is not connected no message can be exchanged on this port with the Lemur Refer to Lemur setup procedure to activate the daemon port The monitor window also displays message counters for each port You can see the MIDI messages produced by the Lemur and sent to MIDI OUT ports and the MIDI messages received on a MIDI IN port and forwarded to a Lemur s daemon port Note that messages are counted only when a port is connected to a Lemur Receiving MIDI messages on a non connected daemon s port does not increment the counter Receiving messages from the Lemur on a non connected MIDI OUT port does not increment the counter since the MIDI messages produced by the Lemur are not sent to MIDI OUT in this case 39 52 Software user s manual Revision 1 5 13 1 Sp
21. dows 2000 or Windows XP Operating System The Editor should also work with Windows 98 98SE and Me but full compatibility has not been tested e 10 100Base T Ethernet interface e CD Rom drive or Internet connection for software installation 3 1 2 Installation To install the Editor software gt Insert the installation CD that came with the Kiss Box in to your PC s CD ROM drive and browse the root directory gt Double click the Kiss Box Editor Setup icon gt Follow Installation Wizard indications to install the Editor If you do not have the original installation CD at hand gt Open your Internet browser and surf to http www kiss box com to download the latest version of the Editor Installation Package gt Unzip the downloaded file gt Double click the Kiss Box Editor Setup icon located in the unzipped directory gt Follow Installation Wizard indications to install the Editor 3 1 3 Uninstalling To uninstall any previous version of the Editor Software gt Go to the windows Start menu and select Control Panel Add or Remove Programs gt Scroll to find the Kiss Box Editor entry and click the Remove button Software user s manual Revision 1 5 To be able to connect to a Kiss Box the computer running the Editor must be configured with correct IP Parameters A Kiss Box can be configured to use with any valid IP address Remember that the computer must not only be connected to the same network but must also
22. e Quad Serial Box never transmits anything on its own When the Box is in one of Automatic modes it transmits automatically to the computer what is received on the different serial ports The computer does not need to send a command to retrieve what has been received but it must be ready to receive data at any moment 9 1 2 Monitoring The serial streams can be monitored in real time from this window Click on the Monitoring button to display the monitoring window 9 1 3 Port configuration Each port can be configured separately Click on the port you want to configure in the Network Tree on the main window to open the configuration window This window allows you to select the physical layer RS232 RS422 or RS485 Please note that RS485 requires a special firmware which handles the validation signals automatically Report to installation manual to get the SUB D pinout for each mode The port configuration panel allows you to choose the serial stream parameters speed and format The most current serial speeds are pre programmed but you can enter manually a different one if needed When all configuration parameters have been selected click Upload to store them into the Box then press Restart button to activate them Quad Serial port setup x Physical layer e R5232 C R5422 C R5485 M Port configuration Speed b s Data bits Stop bits Parity bits None Upload Restart
23. e Lemur to communicate with each of them but it will be impossible for the user to identify precisely each Kiss Box The Kiss Box hostname can be changed using the dedicated window in the Editor Double click on the MIDI Daemon icon in the Network Tree on the main window S Target name for Lemur MIDI Kiss Box1 1 Upload Restart box Type the desired hostname in the dialog box then click on Upload to transfer it into the Kiss Box Click then Restart in order to activate the new hostname by restarting the Kiss Box 12 1 2 Lemur setup Please refer to Lemur s user s manual for the detailed MIDI daemon s configuration procedure The basic steps are the following gt Start the Lemur gt Press the Lemur s setup button top left orange button gt Go to MIDI setup page touch the MIDI button on the screen The list of the daemons connected to each Lemur MIDI port is displayed A Lemur can connect up to 8 input daemon ports and 8 output daemon ports gt Select the daemon port you want to connect to a Kiss Box A new page with a list of all MIDI daemons available on the network is then displayed on the Lemur 37 52 Software user s manual Revision 1 5 gt Locate the Kiss Box to use and touch the corresponding line on the screen in order to display the two Kiss Box MIDI ports Select the Kiss Box MIDI port to connect to the Lemur daemon s port gt Touch the Connect button on the screen The Lemur
24. e a complete explanation of ports setup you have to consider here that the computer used in the explanation is the reciprocal Kiss Box 7 3 2 MAC OS X application profile This application profile must be selected when you want to use the Kiss Box as a MIDI device for an Apple Macintosh computer running Mac OS X RTP MIDI driver When this application profile is selected all networks parameters are computed automatically Take note of them since you will need them to configure the Apple s driver Note that a given Kiss Box can only communicate with only one Mac computer The computer will see in fact two MIDI devices one corresponding to MIDI IN 1 MIDI OUT 1 and the other one corresponding to MIDI IN 2 MIDI OUT 2 You will then need to declare two devices in the computer Note also that you do not need to enter the data port number in the Apple s driver This driver just needs to know the control port number the related data port number is computed automatically This application profile shall also be used when the Kiss Box is used as a MIDI peripheral for the Expandium and Effektor real time digital audio workstations 7 33 Windows XP application profile This application profile must be selected when you want to use the Kiss Box as a MIDI device for a PC compatible computer running Windows XP or Vista with the Kiss BOX RTP MIDI driver 20 52 Software user s manual Revision 1 5 When this application profile is select
25. e you to dangerous voltage or other hazards Software user s manual Revision 1 5 T SR AWGN rat cated II ANO 1 2 e lt a 11101 iii 2 3 Editor Software Installation rca sees 4 3 1 1 Req irementS td AAA Renal nd id A 4 3 1 2 INSTA a A AAA AAA 4 3 1 3 Uninstalling correa 4 4 Setting up Ethernet on the PC eee 5 4 1 Configuring IP with Windows XP sese eee eee 5 4 1 1 Network SS MNOS e tek bee ha NI Ns 5 Se EMO lt T Le 7 ool Starting The SoftWare cts 7 5 2 The Network MON E DAA A A AAA AA 7 5 2 1 AN 7 5 2 2 AAA Ste 8 52 37 End A Ss di2s tater tater a date t tates data tata tase 8 5 2 4 DCAM DO SAA cua sha A T 9 TA S a e Tae LAN conte ee en O O O A A A 9 526 Scan 0 T a AS 9 92 A O 10 5 3 The Upload Firmware Menu esse sese 10 5 4 The About MU A A nnn nrneeent 10 5 5 Scanning th NetWork a0 ioc tescsuteteeadvenspesrenecesecens sa 10 5 6 Adding a Box manually sese eee eee 10 57 Network Tree erein old cada e TEA an ea TAREA cai LAIA ASA 11 B B The Log VV cacti E E E ar ede 12 5 9 BOX PhOPGMICS essa ncaniatted ee a 12 5 9 1 The Upload DUO strain 12 5 9 2 The Restart Button eee 12 5 9 3 S T RIA AA RAR EA AA talked EA AR ANA 13 Updating h Kiss Box firmware ai eese eese E a 14 6 1 Procedure to upload a firmware file in the Kiss BOX cccceeeeeeeeeeeeeees 14 62 OWT PV ZIRIGS ta es aed A ati boas arenas BAD Sea EER 16 fs DU al MID BOX a A A lon nen E A E A dus sand AA 17 7 1 Some things yo
26. ecific addressing modes for advanced network users The IP addressing methodology implies that there must be only one node with a given IP address on a given network 13 1 1 Duplicate IP addresses Beware not to have two or more nodes with the same IP address on a network Note that there is absolutely no way for a Kiss Box to detect if there is another node with the same IP address on the network If this situation arises the network will not work properly If you need to send data from one node to more than one receiver you must use one of the specific addressing modes available on IP Ethernet networks These modes are e multicast addressing e subnet broadcast e global broadcast 13 1 2 Multicast Multicast addressing uses specific addresses to create groups of nodes By sending data to this specific address all nodes that belong to the group will receive the message Kiss Box nodes do not support multicast addressing 13 1 3 Subnet Broadcast Subnet broadcast allows a program to send data to all nodes that are in the same subnet For example with a class C network e g 192 168 0 xx IP addresses you can have up to 254 nodes on the 192 168 0 sub network The corresponding subnet broadcast address is 192 168 0 255 If you send data to this specific address all nodes in the sub network will receive the corresponding message Of course it is forbidden to have a node with this address Note that due to a specific design
27. ed all networks parameters are computed automatically Take note of them you will need them to configure the Windows driver see below for detailed configuration procedure The difference between Windows and Apple RTP MIDI implementation is that the Kiss Box driver uses a simplified session control protocol You have to enter the computer s IP address into Target IP address edition boxes 7 3 4 Node name for RTP session Some RTP drivers like the Apple s one are able to display the remote node name during the configuration phase You can enter the name you want the Kiss Box to have on the driver in the Node name for RTP session edition box 7 3 5 Monitoring The RTP MIDI Kiss Box continuously monitors incoming and outgoing RTP streams Each time a message is sent to or received from the network a counter is incremented You can then easily know if the Box you are installing exchanges expected messages with the remote computer RTP protocol also permits the detection of lost packets The Kiss Box is then able to repeat a message if a network problem is detected Click on Monitoring button on MIDI configuration window to display the monitor statistics and status of the selected Kiss Box RTP MIDI Monitoring x Session status Session opened or no session MIDI IN 1 414 RIP messages correctly sent 1 RTP messages repeated MIDI IN 2 1057 RTP messages correctly sent D ATP messages repeated MIDI OUT 1 1436
28. ems since Windows is unable to determine the correct version of the driver it has to use 49 52 Software user s manual Revision 1 5 If you find two or more KISS BOX Midi entry in the Device Manager see below to know how to reach the System Device Manager then you have to remove all installed drivers and reinstall the correct version To remove a KISS BOX Midi driver from your computer 1 Open Control Panel Start Settings Control Panel File Edit view Favorites Tools Help Que O P Dawe ieee EF Address O Control Panel ies Adjust your comput Installs and trouble Install or remove pr Configure administr W Automatic Updates Set up Windows to See Also Date and Time Set the date time Windows Update Sh Display Change the appear Folder Options Customize the displ 9 Help and Support Fonts id candi ands E Game Controllers Add remove and c WP Internet Options Configure your Inte p Java Plugin Java Plug in Control Sakeyboard Customize your key Mouse Customize your mo AD Network Connect Connects to other Network Setup W Launch the Network Bao Phone and Mode Configure your tele T Power Options Configure eneray s Printers and Faxes Shows installed prin Regional and Lan Customize settings Syscanners and Ca Add remove and c Scheduled Tasks Schedule computer securty Center view your
29. f the Editor encounters difficulties to detect connected Kiss Boxes in extremely large networks or when Kiss Boxes are accessed through Internet In these cases it is possible that the response from a node takes too much time to come back even with the Scan Delay set to a maximum Check Use Blocking Scan in the Network menu to activate the blocking mode With blocking scan you ask Windows to wait until a network error occurs e g there is no node at the requested address or an answer is received which can take up to 30 seconds Please note that if the Windows gets no answer from a Kiss Box it might appear to be hanging the Editor until a network error is detected by Windows Activating the blocking mode is only advised if you cannot connect to a remote node even with the maximum Scan delay setting 500 milliseconds 5 2 6 Scan Network Scans the network for connected Kiss Boxes within the defined Scan Range see below Software user s manual Revision 1 5 5 2 7 Add Box Manually Lets you manually enter a specific address of a connected Kiss Box and has the Editor try to find it on the Network see below 5 3 The Upload Firmware Menu This menu allows you to update upgrade the firmware used by a Kiss Box Please report to section 5 to know how to use this menu 5 4 The About Menu Here you can find the software version number To be sure that you are using the most recent version of the Kiss Box Editor s
30. g the same IP address 6 1 Procedure to upload a firmware file in the Kiss Box 1 Click on Upload firmware menu on main Editor window This will launch the Upload Firmware Wizard Firmware upload wizard x elcome to the KissBox firmware upload Wizard Please click on the Next button to proceed Remember that you can exit this Wizard at any moment using Cancel button 2 Follow instructions given by the Wizard At any given moment you can stop the procedure by clicking on Cancel button Click on Next button each time you are ready to perform the next step If necessary you can go back in the procedure 14 52 Software user s manual Revision 1 5 by clicking on Back button The steps described hereafter are the same given by the Wizard Take the Kiss Box you want to reprogram but DO NOT CONNECT IT TO NETWORK IMMEDIATELY Press the button behind the small hole in the Kiss Box front panel using for example a pen tip Maintain the button depressed while you connect the Kiss Box to the Midspan When the blue LED starts to blink wait 2 to 3 seconds then release the button Do not keep the button depressed for more than 4 seconds otherwise the Kiss Box parameters will be reset to factory settings If the blue LED stops blinking or blinks slower when the button is released just disconnect the KissBox from the Midspan and restart from step 3 When the Kiss Box is in Bootloader mode indicated by
31. h the connected Kiss Boxes Trying to connect tc box 250 Trying to connect tc box 251 Trying to connect tc box 252 Trying to connect tc box 253 Trying to connect tc box 254 Network scan done 5 9 Box Properties When you click on a Kiss Box in the Network Tree the Editor will show you the current network parameters used by the Box The upper parameters are fixed and depend on firmware loaded and factory settings of the Kiss Box The network configuration window allows you to change the network related parameters of the Kiss Box Box Properties Application type 1 0 8 slots KissBox protocol Firmware version 2 4 Vendor ID 1 MAC Address 00 06 1F BF C0 4D Network configuration KissBox address fis2 fies Jo 253 TCP Port 9812 Subnet Mask 255 255 255 fo TCP Mirror Port 9814 Gateway address 1192 168 lo 1 UDP Port 19813 Editor port Upload Restart box Note that the port numbers for TCP Port TCP Mirror Port and UDP Port are always defined but not all the Kiss Boxes use them If any address changes have been made to the network configuration you might also need to adapt the IP settings on your PC to be able to have communication with the box again 5 9 1 The Upload Button Upload Clicking the Upload button will send the current editor settings to the selected Kiss Box A restart of the box is required after uploading new settings 5 9 2 The Restart Button Restart box 1
32. have a compatible IP configuration As an example if the computer network card is configured to have 10 0 0 1 255 0 0 0 address subnet mask it will not be able to connect to a Kiss Box with IP address 192 168 0 1 255 255 255 0 If you are not familiar with IP addresses network classes subnet masks and related topics please familiarize yourself bij reading one of the numerous books available on this subject This manual assumes that you are familiar with IP network related parameters 4 1 Configuring IP with Windows XP 4 1 1 Network Settings Open the Control panel from the start menu d BATES gt Double click on Network Connections to open the network properties dialog Software user s manual Revision 1 5 gt Select the network used for the Kiss Box connection In most cases you have to choose a Local Area Connection Double click on it and then click on Properties button gt Highlight Internet Protocol TCP IP General Authentication Advanced Connect using 19 VIA Rhine Il Fast Ethemet Adapter Insta ME Properties Descripti 1 Transmission Control Protocol Intemet Protocol The default wide area network protocol that provides communication a di yetworks Y Show icon in notification area when connected Y Notify me when this connection has limited or no connectivity Ok Cancel Click the Pro
33. he Quad Serial KISS BOX allows to control serial devices through a network making it possible to manage them from distant computers Each port of the Quad Serial KISS BOX is fully independant and can be configured differently from the others 9 1 1 Mode selection The Quad Serial Box can operate under four different modes e Polled UDP e Automatic UDP e Polled TCP e Automatic TCP All protocols may not be available in depending on firmware versions Please contact Kiss Box to check their availability The mode selection and port configuration are made using the dedicated window in the Editor Double click on the TCP UDP icon in the Network Tree on the main window Quad Serial global setup E Application profile Polled UDP C Polled TCP C Automatic UDP Automatic TCP Target definition for automatic mode Target IP address 192 168 10 1 Destination port 9820 Monitoring Upload E Restatbor The mode selection applies to serial input only receiving from serial port Transmission protocol sending to serial port is the same in all cases Each mode is available for UDP and TCP sockets The port number for the socket is defined in the main configuration screen of the Kiss Box Editor 24 52 Software user s manual Revision 1 5 The Polled modes require the computer to send a specific command to the Quad Serial Box to retrieve what has been received since last polling In this mode th
34. n the two MIDI IN ports In the other direction we then have three important parameters e Target IP address where MIDI IN data are sent e MIDI IN 1 target data port e MIDI IN 2 target data port Note that there is only one target IP address That means that a Box can send MIDI data to only one device if you need to send the same data to many nodes you must use specific addressing modes See related section at the end of this section This restriction does not apply to MIDI OUT ports which can receive MIDI data from two different sources 17 52 Software user s manual Revision 1 5 Dual MIDI KissBox IP address 192 168 0 253 Computer IP address 192 168 0 3 Target address 192 168 0 3 MIDI IN 1 C Port 5008 target gt gt MIDI IN 2 Target Address Port 5010 target O gt 192 168 0 253 MIDI In Port 1 5008 Driver setup MIDI OUT 1 MIDI In Port 2 5010 A Port 5004 reception MIDI Out Port 1 MIDI OUT 2 5004 O 4 Port 5006 reception MIDI Out Port 2 5006 A Typical network setup to connect a Dual MIDI Kiss Box with a computer over an Ethernet network In the above diagram you can see two devices or nodes that are connected to the same Ethernet network The Kiss Box has IP address 192 168 0 253 and the computer has IP address 192 168 0 3 Below each device you can see the related network parameters Computer is configured to send messages to IP address 192 168 0 253 which
35. nced users for a class C network Kiss Box network group is the same as subnet The rightmost number is the UID Unit Identifier which identifies a specific Box on a given network group Since the UID can have any value between 0 and 254 255 is a reserved value you can install up to 255 Boxes on the same network group It is possible ofcourse to install more than 255 Boxes on the same Ethernet network You just need to change the network group number using this dialog box when you need to work with Boxes installed on another network group 192 168 1 for example Note that the default Kiss Box address out of factory is 192 168 0 253 The default configuration of the Editor matches this configuration 5 2 2 Start Address The Start Address boxes let you define K the Network Group with the three leftmost numbers the first UID the Editor will scan when Scan Network menu or button is clicked 5 2 3 End Address The End Address box lets you define the last UID the Editor will scan when Scan Network button is clicked In the above example the Editor will scan the 255 possible addresses in the 192 168 0 network group If you know the exact addresses of the connected Kiss Boxes you may want to set these parameters to a smaller range e g if there is only one connected Kiss Box and Software user s manual Revision 1 5 it is set to its Out Of Factory IP address 192 168 0 253 you can set the Scan range
36. nd then click Next If you A have a disk that contains the driver you want to install click Have Disk Standard system devices Aztech Systems Aureal Vortex Game Port CH Products Game Ports 3 AR Creative Technology Ltd Pants falo ofl EF Legacy Video Capture Devices R kiaia Canton Da sl EY This diver is digtal signed Have Disk Tell me why driver signing is important cmos 10 Locate the directory where you copied the driver files provided by Kiss Box with the Browse button instal rrom pisk x Insert the manufacturer s installation disk and then make sure that the corect drive is selected below o Copy manufacturer s files from E kiss box KISS BOX Midi 20060625 Release f 11 Select Kiss Box MIDI in the device list and click on Next button Add Hardware Wizard Select the device driver you want to install for this hardware Y Select the manufacturer and model of your hardware device and then click Next If you 4 have a disk that contains the driver you want to install click Have Disk KISS BOX Midi amp This driver is not digitally signed Have Disk Tell me why driver signing is important 12 If the computer warns you about the lack of digital signature of the driver simply ignore the message by clicking on Continue anyway button A The software you are installing for this hardware KISS B0X Midi has not passed Windows Logo testing to verif
37. nput Node name for ATP session MIDI Kiss Box1 a Monitoring Upload Restart box The parameters on this window are similar to those used for the Dual MIDI Kiss Box Please report to previous chapter for all details related to them 8 1 1 Full MTC Message The only difference with Dual MIDI Kiss Box is a MTC specific parameter that allows defining how the MIDI Time Code generated from LTC IN is sent over the network 22 52 Software user s manual Revision 1 5 When Full MTC message is unchecked the Kiss Box will transform the incoming LTC into MIDI Quarter Frame messages When Full MTC message is checked the Kiss Box will transform the incoming LTC into MIDI MTC Full Message a System Exclusive message defined in MIDI specification This message allows for greater precision since it does not have do two frames to define a complete time code but it also uses more bandwidth Since RTP MIDI bandwidth is much higher as standard MIDI this is not a problem with the Kiss Box If you want to use this message you have to be sure that the receiving application supports this MIDI message 23 52 Software user s manual Revision 1 5 9 COM4 Box Many devices integrate serial ports for control DVD CD players video projectors etc However many modern computers do not integrate serial ports anymore Moreover in most cases serial links between computers and devices must be short T
38. o 2 Node name for RTP session MIDI Kiss Box1 Upload Restart box 19 52 Software user s manual Revision 1 5 7 3 1 Peer to peer application profile The peer to peer application profile must be chosen when you want to use the Kiss Box as a MIDI gateway over Ethernet network In this application profile two Kiss Boxes are virtually connected together over the network Any MIDI message received on the MIDI IN connector of the first Kiss Box is sent automatically to the corresponding MIDI OUT connector of the other Kiss Box This application profile does not use any session control protocol As soon as the Kiss Box is powered and receives MIDI data it will send them to the IP address and port number provided in the edition boxes Please note that a Kiss Box can talk with only one other Kiss Box in this application profile It means that the two MIDI IN ports of a Kiss Box are redirected to the two MIDI OUT ports of the reciprocal Kiss Box The parameters you need to provide to the Editor in this configuration are e The IP address of the reciprocal Kiss Box with what the MIDI data will be exchanged e The two MIDI IN port numbers These are the port numbers where the incoming MIDI data will be sent e The two MIDI OUT port numbers These are the port numbers on which the Kiss Box will receive the data to transfer to its MIDI OUT connectors Please report to the previous section to hav
39. oftware please check our website regularly for updates About Kiss Box Editor x Kiss Box Editor de Version 8 2 Build 1 Copyright 2004 2006 KissBox B Y Developed by B Bouchez 5 5 Scanning the network The Scan Network function permits to locate automatically all Kiss Boxes located in a given Network Group within a given range The Network Group and range are given in the Network Scan Range menu Click on the Scan Network button or use the Network Scan network menu to start a network scan procedure e Scan network The Editor will then try to contact all Kiss Boxes within the specified range If a Kiss Box answers to the request it is automatically added in the Network Tree The Scan Network function also clears all previous entries in the Network Tree so it can be used to refresh the tree 5 6 Adding a Box manually If you know the UID of a Box you want to access on your network you can manually add the Box by entering its UID the last byte of the IP address Press the Add a Box button on the main page gt Add a Box 10 52 Software user s manual Revision 1 5 Or use the Network Add Box manually menu The Manual UID entry dialog is then displayed Enter Box UID X coca Type the Kiss Box UID you want to add in the tree The editor will then try to connect to the given address If a Kiss Box is found at the corresponding address it will be added to the network tree Ad
40. on of command FREEZE DMX OUT The DMX output continues to transmit the stream but data is not updated through IP nor can it be mergedMerge Freezing an already freezed output has no effect UNFREEZE DMX OUT Resumes DMX output after a FREEZE command and channels can be merged Sending this command when the output is not freezed has no effect CLEAR DMX OUT When the DMX board receives this command it clears all the channels being send sent out the DMX output Channels in Merge mode are not affected START DATA DMX IN The data received on DMX Input are sent to the User program on a regular basis If this command is send to a box already sending data it has no effect STOP DATA DMX IN Stops the transmission of the received DMX data to the User program If this command is send to a box which is not sending data it has no effect MERGE CHANNEL When the DMX board receives this value it switches the requested channel in Merge Mode The output of the channel is copied from entering DMX stream Switching in Merge mode a channel which was already in Merge has no effect UNMERGE CHANNEL When the DMX board receives this value it switches back the requested channel in normal Mode The output of the channel stays at the last value received from entering DMX stream until receiving a SET CHANNEL command Switching a channel which is already in normal mode has no effect 11 1 7 ARTNET Protocol Description For ARTNET specificati
41. ond If more than one second elapses between two consecutive commands the outputs of the card are deactivated automatically you can activate the time out control differently for each output card of a given I O Kiss Box 30 52 Software user s manual Revision 1 5 10 4 Digital Input card configuration When UDP protocol is used with I O Kiss Boxes a specific function becomes available for input cards when the state of an input changes or when a specific time elapses the Kiss Box is able to automatically send an Input State message without needing the receive a previous reading request Input configuration UID 253 Slot 1 ES T Automatic timed control 0 ms time out value 7 max 65000 Monitoring This function can be activated deactivated as wanted on any input card If this function is activated the Kiss Box has to know the destination IP address and port where the message has to be delivered These parameters are defined in the Master configuration window 10 5 Analog Input card configuration 10 6 Analog Output card 10 7 I O monitoring Each input or output card located in a I O Box slot can be monitored from the Editor whatever the protocol used to control the Kiss Box and whatever the I O card settings The Editor will automatically display the correct monitoring window depending on I O card type and numbers of I O To monitor a given I O card status gt Double click on the desired I O ca
42. onfiguration KissBox address TCP Port Subnet Mask TCP Mirror Port Gateway address UDP Port Editor port BE Upload Restart box af Scan network W Add a Box 5 2 The Network Menu When it starts up for the first time the Editor uses a default configuration You may need to check and change if necessary these settings to fit your own needs The settings are defined using the Network menu Note that your settings are saved automatically when you close the Editor 5 2 1 Scan Range This sets the IP base address see below and the range of IP addresses the Editor will use to connect to Kiss Boxes during the scanning procedure Software user s manual Revision 1 5 Network scan setup xi Scan range Start address 192 fies jo jo 1 End address haz EN fo 254 Scan delay C 50 ms 200 ms 100 ms e 500 ms X Cancel Kiss Boxes comply with IPv4 addressing standard Any device connected to an IP network must have an address between 0 0 0 0 and 238 254 254 254 Simply speaking each number between the dots can have any value between 0 and 254 apart from the leftmost one it has a limited to 238 To simplify installation the Kiss Boxes use a slightly modified addressing scheme where the three leftmost numbers are fixed for a given network That s what we call network group In the screenshot above you can see that the network group is set to 192 168 0 For adva
43. ons see on web site from www artisticlicence com ARTNET OEM CODE 7003 35 52 Software user s manual Revision 1 5 11 1 8 ARTNET Good practice IN Universe 2 o AN OUT Universe 0 y N 28 OUT Universe O ZN OUT Universe 2 EA AO IN Universe 1 OUT Universe 1 KISS BOX IN Universe 1 IN Universe 1 OUT Universe 1 11 1 9 ESTA information ESTA Code 4B 42 http www esta org tsp working_groups CP mfctrIDs php 36 52 Software user s manual Revision 1 5 The Jazz Mutant s Lemur control surface www jazzmutant com can produce MIDI messages but it does not integrate any MIDI interface In order to retrieve the MIDI messages produced by the Lemur it normally requires to run the JazzMutant s MIDI Daemon on a PC or a Macintosh computer The Lemur MIDI Kiss Box firmware takes the place of the JazzMutant s daemon and allows controlling MIDI devices without requiring a computer to run the daemon 12 1 1 Hostname The Lemur MIDI Kiss Box appears directly in the Lemur s MIDI setup page like any other daemon Each daemon must be named in order to identify it on the Lemur screen When a factory reset is made the Lemur MIDI Kiss Box takes the default name MIDI Kiss Box 1 It is recommended to change the Kiss Box name hostname in order to identify each of them on the Lemur s screen multiple MIDI Kiss Box with the same name do not prevent th
44. or 16 consecutive channels You can select the desired channel group using the scroll box at the bottom Values displayed are between 0 and 255 not in Monitor DMX Out D 1 2 3 4 5 6 7 8 3 10 11 12 13 14 15 16 111 58 203 134 80 165 229 247 8 36 49 TS IAS 33 52 Software user s manual Revision 1 5 11 1 5 TCP IP User protocol Commands String Comments Write DMX Data Out A0 DD DD DD data for DMX channel 1 512 The command must be followed by exactly 512 bytes of data Write DMX data Block SAB BH BL CH CL DD DD BH BL base channel 1 512 MSB first CH CL Number of Channels 1 512 MSB first DD data for DMX channel 1 512 There must be exactly the same number of data bytes DD tahn number given in CH CL not Box Reset 84 Freeze DMX Out A2 Unfreeze DMX Out A3 Clear DMX Out A4 See chapter 11 1 6 Start DMX In A5 Stop DMX In A7 CH CL DMX In channal to merge sent directly to DMX Out 1 512 Merge Channel A8 CH CL MSB first See chapter 11 1 6 CH CL DMX In channal to Unmerge Channel A9 CH CL unmerge See chapter 11 1 6 AA only in TCP Read DMX In When the Box receives this command it sends back a packet formed of 513 bytes A6 DD DD DD data for DMX channel 1 512 34 52 Software user s manual Revision 1 5 11 1 6 TCP IP Descripti
45. perties button 2x1 Internet Protocol TCP IP Properties General You can get IP settings assigned automaticaly if your network supports this capability Otherwise you need to ask your network administrator for appropriate IP setting T Obtain an IP address automatically Use the following IP address IP address 92 168 0 200 Subnet mask 255 255 255 0 Default gateway L Obtain DNS server address automaticall Use the following DNS server addresses Preferred DNS server Alemate DNS server Advanced gt Select the option Use the following IP address Enter the desired settings For example you can configure the PC to use the following settings chosen for compatibility with Kiss Box default settings P address 192 168 0 200 Subnet mask 255 255 255 0 gt You can ignore the default gateway and DNS settings just leave them blank gt Click OK buttons on the opened dialogs The PC will now use the new network address on the selected network card Software user s manual Revision 1 5 5 Editor Basics 5 1 Starting The software gt Double click the icon placed on your desktop by the installer Or gt Open Windows Start menu and select Programs Kiss Box Kiss Box Editor You will then get the main Editor screen Network Upload firmware About Box Properties Application type Firmware version Vendor ID MAC Address Network c
46. rd in the Network Tree Click on monitoring button in the configuration window Ing monitoring UID 253 Slot 1 E Out4 monitoring UID 253 Slot 3 Ed 069090000 a o o e 2 DO A 8 1 F 3 4 31 52 Software user s manual Revision 1 5 11 DMX ArtNet BOX The DMX ArtNet Kiss Box integrates one DMX input and one DMX output fully compliant to USITT DMX512A 1990 specification This Kiss Box supports two protocols to control the DMX output stream and read back the incoming DMX stream e TCP IP e Artnet The protocol selection and DMX configuration are made using the dedicated window in the Editor Double click on the DMX icon the bulb in the Network Tree on the main window Universe In o y Universe Out fi y Upload Restart box Start Code 0 y Break Time us 100 y A Monitoring Upload MaB Time us 10 v DMX OUT DMX IN Start Code 0 v a Monitoring Upload 11 1 1 Mode selection The protocol used to exchange DMX data over the Ethernet network is selected by the radio buttons in the Mode panel The Kiss Box protocol is TCP IP based The dialog with the controller takes place on the TCP port selected on the main window Universe In and Universe Out parameters are not used under TCP mode To have a complete description of the Kiss Box TCP protocol for DMX please consult the chapter 11 1 5 amp 11 1 6 When ArtNet protocol is selected you need to define the Universe In and Universe
47. s two MIDI ports in each direction Note that a given computer can talk with up to sixteen Midi Kiss Boxes To disable a Kiss Box port click on the Clear button The network parameters will be erased The corresponding MIDI ports are suppressed from system resources Since there are only 32 ports available for a XP computer you can then allocate only the needed ports to Kiss Box devices A Before configuring any data make sure you have clicked the clear and the reset button The driver configuration is quite easy just copy the port numbers given by the Editor when you ve configured and addressed the Midi Kiss Box and copy the same values in the edition boxes of the driver configuration panel The only difference with the values given within the Editor is that the IP address here must be the address of the Kiss Box in the Editor the address entered is the computer s address Do not forget that the Kiss Box must use the WinXP application profile in the Editor When the driver is configured click on OK button to restart the driver with the new parameters 15 3 Removing Kiss Box RTP MIDI WinXP driver The Kiss Box MIDI driver for Windows can normally be upgraded at any moment by installing a new version over the previous one However it has been reported on some systems that Windows was not replacing the old driver by the new one but was adding a new driver entry in the system registry This can lead to potential probl
48. t the date time 49 Windows Update Sh Display Change the appear Folder Options Customize the displ O espeor rats Add change and E Game Controllers Add remove and WP internet options Configure your Int ava Plugin Java Plug in Control akeyboard Customize your key Mouse Customize your mo WD Network Connect Connects to other c Network Setup W Launch the Network Ba Phone and Mode Configure your tele Power Options Configure eneray s Ey Printers and Faxes Shows installed prin Regional and Lan Customize settings Syscanners and Ca Add remove and c scheduled Tasks Schedule computer security Center en your current s t Sound Effect Ma AC97 Audio Contr 9 Sounds and Audi Change the sounds dl Speech Change settings for As tem Bav El Installs and troubleshoots hardware A 2 Double click on System icon The System Properties dialog then opens Click on Hardware tab System Properties Axl System Restore Automatic Updates a Remote General Computer Name Lape Advanced r Device Manager The Device Manager lists all the hardware devices installed on your computer Use the Device Manager to change the properties of any device Device Manager p Drivers Driver Signing lets you make sure that installed drivers are compatible with Windows Windows Update lets you set up how Windo
49. the Kiss Box network chip doesn t handle these broadcast addresses You cannot use subnet broadcasting with the KissBox 40 52 Software user s manual Revision 1 5 13 1 4 Global Broadcast Global broadcast is an addressing method that allows sending data to all nodes of all networks connected altogether The IP global broadcast address is 255 255 255 255 The Kiss Box supports broadcast addressing When a message is sent by one node to this address all nodes on the same network will receive it whatever their own address Broadcast addressing may require higher processing power especially on PC and Macintosh computers since they do not have a specific network processing chip Use this addressing mode only in case of necessity Broadcast addressing is often filtered by many routers If your network uses this kind of device you may not be able to use the broadcast apart if all nodes are on the same side of the routers Take special care not to configure a Box to listen on a broadcast port a port that you use on other Boxes for broadcasting apart if you want this Box to behave like a MIDI THRU Box In conclusion we would say that you should only use the broadcast addressing in case of absolute necessity many software offer so called soft MIDI THRU that should be use preferably to network broadcast 41 52 Software user s manual Revision 1 5 14 1 Resetting the Kiss Box to the default factory set
50. the fast blinking LED click Next button The Wizard will then try to connect to the Kiss Box to reprogram If the Editor cannot connect to the Kiss Box to reprogram check your computer network settings as well as the network connection to the Kiss Box Once the connection to the Kiss Box is established the Wizard will display the characteristics of the connected Kiss Box You will be then asked to choose the firmware file to upload in the Kiss Box 15 52 Software user s manual Revision 1 5 6 2 V1 V2 Files There are currently two different Kiss Box hardware platforms named V1 and V2 These two platforms use different components and they require different firmware To avoid confusion when loading a firmware file into a Kiss Box the V1 firmware files are named with HEX extension hex and V2 firmware files are named with KB2 extension kb2 When the upload wizard connects to a CPU it recognizes automatically the type of CPU The dialog that is displayed then automatically displays the correct extension depending upon the detected CPU It is possible however to force the Wizard to load a file with a different extension Also make sure that the firmware you want to upload is adapted to the target Kiss Box do not try to load a MIDI firmware in a DMX Kiss Box for example Note that loading the wrong firmware wrong application file or wrong CPU type in a Kiss Box will not destroy anything but the Kiss
51. tings 14 1 1 Factory Reset The Kiss Box can be reset to its default settings This is useful if the box has been user configured and the settings are not known anymore In this case it might be impossible to connect to the box with the editor software or any other software To reset a Kiss Box to its default settings make sure the box is on and running the blue running status LED flashing approx once per second Insert a paperclip or small pointed tool into the small hole underneath the blue LED Press and hold the reset switch for approx 5 sec Please be careful not to use excessive force When the blue LED on the front panel stops flashing release the reset switch The box will restart with its original settings 14 1 2 Factory setting The factory default setting are e P Address 192 168 0 253 e Subnet Mask 255 255 255 0 e Gateway 192 168 0 1 e TCP User Port 9812 e TCP User Mirror Port 9814 e UDP User Port 9813 42 52 Software user s manual Revision 1 5 15 1 Installing Kiss Box RTP MIDI WinXP driver The RTP MIDI WinXP driver turns the MIDI compatible Kiss Boxes Dual MIDI LTC MTC etc into standard Windows MIDI peripherals You can then use the Kiss Box with all your favorite MIDI software under Windows The driver works only under Windows2000 Windows XP Home Edition and Windows XP Pro It is not compatible with Windows 95 Windows 98 and Windows Me versions It is also compatible with Vista 32 bi
52. tput cards another computer controls the second one etc e The Kiss Box always executes requests coming from the remote computer whatever its IP address Multiple computers can then read the inputs status for example e UDP protocol is considered as fast Message delivery is generally achieved in less than 10 milliseconds on an heavily loaded network UDP is sometimes considered as less reliable as TCP since there is no guarantee for a sender that its message has been delivered correctly to a receiver The current versions of firmware do not allow to change the IP destination address the Kiss Box always use a global broadcast address See Appendix for complementary information on this addressing method 10 1 3 TCP UDP IP User Protocol description From User Software to 1 0 Box String commands Read all Write all Read one Write one channels channels channel channel command A0 A4 A2 A5 Slot 00 to 02 for 1 03 00 to 07 for I O 8 Box Channel 00 to 07 Digital 8X 00 or 01 00 or 01 Value Analog 8 bits 8 consecutive Bytes 1 Byte 28 52 Software user s manual Revision 1 5 From 1 0 Box to User Software answer String commands All e Single channel value answer command A1 A3 Slot 00 to 02 for 1 03 00 to 07 for I O 8 Box Channel 00 to 07 Digital 8X 00 or 01 00 or 01 Value Analog 8 bits 8 consecutive Bytes 1 Byte
53. ts editions but it will not work with Vista 64 bits edition 15 1 1 Recommended configuration Networking requires high processing power to maintain synchronization and keep the latency as low as possible The Kiss Box uses a dedicated chip and a fast processor to handle the network load that s why the global latency of a Dual MIDI Kiss Box is less than 900 microseconds but the PC has only one processor to do everything e Use a PCI network card for communication with the Kiss Box network USB FireWire and PCMCIA network adapters generally give bad results e Use a dedicated network card for the Kiss Boxes network avoid to connect devices like printers or xDSL modem on the same network e f possible use a fast dedicated machine for your MIDI applications e Ina general way follow the same guidelines for the computer controlling the RTP MIDI Kiss Boxes as for any computer used as a Digital Audio Workstation You must have Administrator rights to install a new driver Close all MIDI applications before installing or upgrading the driver 1 Open Control Panel Start Settings Control Panel Control Panel 2 5 x L 180 ale 43 52 Software user s manual Revision 1 5 2 Double click on Add new hardware in the applet list Add Hardware Wizard Welcome to the Add Hardware Wizard This wizard helps you Install software to support the hardware you add to your comp
54. u need to KNOW cio iii 17 2 gt Appi atO POE SS ta ii 19 7 3 RTP MIDI Kiss Box Configuration ccccccceceeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeees 19 7 3 1 Peer to peer application profile ccccccccceeeeeeeeeeeeeeeeeeeeeseeeeees 20 7 3 2 MAG OS X application prohile eee 20 7 3 3 Windows XP application profile sss eee 20 7 3 4 Node name for RTP session eee eee 21 re A MONON A ices eee wkd eet uh eres to uk E ceed tA cAI Aa 21 O ETE MIE Box cc acs ada 22 8 1 1 Full MTC Message ita a dd dd do dd do dd do dd 22 Y COMA BOE AAA AA 24 9 1 1 Mode SGleCHON ay AS 24 9 1 2 Monitorning str etek eet asec ed 25 Software user s manual Revision 1 5 9 1 3 Port contiguratiO neta dt tds 25 9 1 4 Control elese Ada 26 10 VOS He 8 aT 27 10 1 I O Kiss Box with proprietary Kiss Box I O protocol eee 27 OTAN TEPARPTOTOCO T 2 ctnic05 ces usta cael de a le cl alata to 27 LO D IDR AP PrOTOCOL 21100200400 UIT Dn te ot nh A nl ae te 28 10 1 3 TCP UDP IP User Protocol description sse eee eee 28 10 2 1 0 Kiss Box with ArtNet protocol eee 29 10 3 Digital Output card configuration sss sese 30 10 4 Digital Input card configuration oocccccccccccccccccccccnncnnnnnnnnononononcnnnnnnncnnnannnos 31 10 5 Analog Input card configuration 0d A A AAA 31 10 6 Analog OUIpUL CAN eene aeea aaa e a aap anh 31 10 7 I O MORON eee 31 11 DMX AnNet BOX 00 nn O ls 32 T111 Mode seleciona 32 MZ DMX QUT Set cta lciciote 33 alo DMA
55. uter Troubleshoot problems you may be having with your A If your hardware came with an installation CD it is recommended that you click Cancel to close this wizard and use the manufacturer s CD to install this hardware To continue click Next 3 Click on Next button in the Welcome dialog that opens The computer will start an analysis sequence to find the new hardware Add Hardware Wizard Please wait while the wizard searches e This wizard is searching for hardware that has been connected to your computer recently but has not yet been installed 4 Wait untill the end of the automatic hardware recognition A new dialog will then ask you if the hardware is already connected 5 Click on Yes have already connected the hardware then click on Next button Add Hardware Wizard Is the hardware connected ey Have you already connected this hardware to your computer No have not added the hardware yet 44 52 Software user s manual Revision 1 5 6 In the next window scroll the list down to Add a new hardware device generally at the bottom of the list Click on Add a new hardware device and click on Next button Add Hardware Wizard The following hardware is already installed on your computer Y From the list below select an installed hardware device then click Next to check properties or troubleshoot a problem you might be ha
56. ving To add hardware not shown in the list click Add a new hardware device Installed hardware USB Root Hub amp amp USB Root Hub USB Root Hub E USB Mass Storage Device e Generic volume Add a new hardware device 7 On the next dialog choose Install the hardware that manually select from a list Advanced then click on Next button Add Hardware Wizard The wizard can help you install other hardware SS The wizard can search for other hardware and automatically install it for you Or if you know exactly which hardware model you want to install you can select it from a list What do you want the wizard to do Search for and install the hardware automatically Recommended edi lt Back Next gt Cancel 8 Choose Sound video and game controllers in the hardware type list then click on Next button Add Hardware Wizard From the list below select the type of hardware you are installing SS If you do not see the hardware category you want click Show All Devices Common hardware types 8 PCMCIA adapters a PCMCIA and Flash memory devices a Ports COM amp LPT 5 Printers 45 52 Software user s manual Revision 1 5 9 In the next window click on Have Disk button Add Hardware Wizard Select the device driver you want to install for this hardware Y Select the manufacturer and model of your hardware device a
57. ws connects to Windows Update for drivers Driver Signing Windows Update r Hardware Profiles Lm Hardware profiles provide a way for you to set up and store different hardware configurations Hardware Profiles 3 Click on Device Manager button then click on Sound video and game controllers entry to expand the corresponding tree level JIS 2 Display adapters b DYD CD ROM drives 13 Floppy disk controllers B Floppy disk drives IDE ATAJATAPI controllers H Keyboards Mice and other pointing devices Monitors E9 Network adapters A Ports COM amp LPT MB Processors 7 9 Sound video and game controllers 0 audio C Legacy Audio Drivers Legacy Video Capture Devices Media Control Devices Realtek AC 97 Audio for VIA R Audio Controller 0 Video Codecs m s Storage volumes z 48 52 Software user s manual Revision 1 5 4 Double click on KISS BOX Midi item to open the configuration dialog You can then alter all parameters for the corresponding MIDI ports Propri t s de KISS BOX Midi G n ral Propri t s Configuration Pilote KISS BOX Midi EN Y IP Address 168 fo 253 Data Port MIDI In 1 5004 Data Port MIDI In 2 5006 Data Port MIDI Out 1 5004 Data Port MIDI Out 2 5006 Clear Reset KISS J0 4 THE NETWORK ANSWER The scroll box on the top allows you to select a MIDI group since each Kiss Box ha
58. y its compatibility with Windows XP Tell me why this testing is important Continuing your installation of this software may impair or destabilize the correct operation of your system either immediately or in the future Microsoft s strongly recommends that you stop this installation now and contact the hardware vendor for software that has passed Windows Logo testing STOP Installation 46 52 Software user s manual Revision 1 5 13 Click again on Next button to start the installation The driver will then be copied in the system directory and registered as a system file Add Hardware Wizard The wizard is ready to install your hardware om Hardware to install O KISS BOX Midi To start installing your new hardware click Next 14 When installation is done click on Finish button to exit the installation procedure Add Hardware Wizard Completing the Add Hardware Wizard The following hardware was installed O KISS BOX Midi Windows has finished installing the software for this device To close this wizard click Finish 15 2 Kiss Box RTP MIDI WinXP driver Configuration Windows XP supports only 32 MIDI ports in each direction MIDI IN and MIDI OUT The Kiss Box driver allows you to access up to 16 Dual MIDI Kiss Box devices thus 32 MIDI ports since each box has two ports in each direction If you have other MIDI devices installed on your system and you try to de

Kiss-Box Software manual (includes protocol description)

Contents

Download Pdf Manuals

Related Search

Related Contents