D&R AIRENCE Manual Download

Page: 40 / 64

A I R E N C E - U S B M a n u a l P a g e 40

HID Control Protocol for software engineers

Introduction

This chapter describes the protocol which is used to communicate with the control section and the USB channel controls of the

Airence mixer. For the communication between the PC (host) and Airence (device) the USB generic HID (Human Interface Device)

class protocol is used. HID devices are identified by their PID and VID. For the Airence the

PID=0x2402

, and the

VID=0x03EB

On top of the HID protocol, a custom message based protocol provides the commands to send and receive data which will be

described in more detail in this chapter.

Message format

Transmitting data through the USB bus using the HID class protocol is done by reports. A report always contains an ID and the

data inside the report. In order to successfully communicate with the Airence control section

only reportID 0

may be used.

More information about report descriptors can be found on

www.usb.org

. For now, remember that the Airence only will listen to

reports with reportID = 0.

A control message has a fixed size of 8 bytes containing a

SIZE

byte,

COMMAND

byte, and a

PAYLOAD

section of maximal 6 bytes.

The

SIZE

byte contains the number of bytes used (max. 8) in the message, including this

SIZE

byte.

byte

SIZE

COMMAND

PAYLOAD

cmd

Command byte

The command byte consists of a 2-bit

TYPE

and a 6-bit

field.

bit

TYPE

id5

id4

id3

id2

id1

id0

Bit

Symbol

Value

5:0

Command Identifier (ID)

7:6

TYPE

Write command, from host to device

Request command, from host to device

Response command, reply from device to host on a request

Event, from device to host (i.e. button pressed)

Command ID

A commandID can have a value between 0x01 and 0x3F. The following commandIDs are currently available in the Airence:

VALUE

DESCRIPTION

0x01

AIRENCE_FIRMWARE_VERSION

0x02

AIRENCE_LED

0x03

AIRENCE_LED_BLINK

0x04

0x05

AIRENCE_SWITCH_CHANGE

0x06

AIRENCE_ENCODER_INCREMENT

0x07

AIRENCE_ENCODER_DECREMENT

Summary of Contents for AIRENCE

Page 1: ...A I R E N C E U S B M a n u a l P a g e 1 MANUAL version 1 04 ...

Page 2: ...tion console in the most demanding production room We are confident that you will be using the AIRENCE USB mixer for many years to come and wish you much success We value suggestions from our clients and would be grateful if you could email us with your comments at info d r nl when you are familiar with the AIRENCE USB mixer We learn from the ideas and suggestions of customers like you and appreci...

Page 3: ...es PROGRAM mono switch AUX RETURN to CUE SUB PROG PHONES with PROGRAM CUE Balance control or split with CUE on the left and PROGRAM on the right RECORD OUT fed from PROGRAM SUB AUX ANNOUNCER OUTPUT fed from Follow Phones or Prog BUILT IN TALKBACK MIC routable to SUB AUX STUDIO ANNOUNCER NON STOP switch routes one of the 4 USB stereo inputs directly to the main pro gram XLR connectors AIRENCE EXTEN...

Page 4: ...n optional redundant power supply can be connected and the SUB D slave connection to the extender unit And of course the USB connector that carries all the 4 stereo audio signals to and from the PC for both Windows Macintosh computers as well as the Play out systems control info from the programmable Control section plus the Clock and meter infor mation This USB feature will allow to connect to th...

Page 5: ...led VR2 right and VR3 left This also can only be done with the frame dismantled and should be done at the same time that you do the jumper selections Also the source selector for the NON STOP switching is on the module as a jumper The main output XLR s on the mixer can directly receive a stereo signal from Program pre Program Post Sub or Aux A Picture will be shown in the manual how to achieve all...

Page 6: ...sends out HID signal over USB that can be programmed to do specific functions in your play out system In the Control section of the manual we will explain how FADER Final audio level control is the high quality 100 mm long throw K Alps stereo channel fader with integrat ed fader start switch At the beginning of the fader movement you will feel an integrated start switch that closes when you bring ...

Page 7: ...the USB CONTROL section of the manual INSERT This ring tip sleeve stereo jack socket let s you insert signal processors such as compressors gates or special voice processing units to improve your voice to sound like the ultimate announcer D J The Ring of the stereo jack sends the PRE FADER channel signal and the Tip accepts the return signal On the right you see the type of cable you need when you...

Page 8: ... OF YOUR MIXER First remove the 3 bolts below the faders that hold the cover then put the mixer upside down on a soft surface You see on the back panel side of the cover again 3 bolts that needs to be removed Also on the left and right side of the frame there are 2 bolts that needs to be removed Once you have done this you can lift the cover from the front and the back panel of the mixer Use a twe...

Page 9: ...r post selectable via Jumper J6 J16 J17 Start pulse Continuously Pulse Continuously Jumper J17 to change the start pulse from latching continu ously to pulse J10 NON STOP SELECTION prog post NON STOP Source selection These jump ers when placed make a connection from the output of the module s USB chip to the NON STOP switch in the master sec tion J5 USB OUTPUT Prog Pre Output USB source selector H...

Page 10: ...ON 5 6 CUE Module 2 Logic Port selector 7 8 START 9 10 ON 11 12 CUE Module 3 Logic Port selector 13 14 START 15 16 ON 17 18 CUE Module 4 Logic Port selector 19 20 START 21 22 ON 23 24 CUE J9 Module 1 USB Port Selector 1 2 and 3 4 Module 2 USB Port Selector 5 6 and 7 8 Module 1 USB Port Selector 9 10 and 11 12 Module 1 USB Port Selector 13 14 and 15 16 ...

Page 11: ...the level that is sent to the USB chip in the AIRENCE and thus adjust the outgoing level to your PC for left and right signal for the selected jumper setting discussed earlier This is especially important for Windows 7 that recognizes the AIRENCE USB chips we use as mic level signals A lower output level coming from the AIRENCE USB will greatly improve performance We have no experience with WINDOW...

Page 12: ...olutions for streaming audio You can start your own station fairly easily and the software is free to download http radio about com gi o htm zi 1 XJ zTi 1 sdn radio cdn gadgets tm 23 gps 562_409_1302_762 f 00 su p504 1 336 ip_ tt 2 bt 1 bts 1 zu http 3A www shoutcast com download Helix Server Basic Free streaming media server software which can distribute live and on demand video and other media R...

Page 13: ...ed in the AIRENCE Input Line level 0 dBu balanced internally connected in the AIRENCE R C balance fully adjustable Separation more than 30dB TELCO SEND With this control you adjust the level of the outgoing signal to the telephone line PHONE LINE INPUT SWITCH When switched to the stereo line input you have a high impedance line level input for connecting cart machines iPods tape machines or CD pla...

Page 14: ...hes a full cut off below 90dB When you are used to fully throw the fader in its top position when opening a channel it is advisable to set the fader gain jumper to 0dB factory default If you need a little bit of playground for your audio set the jumper to 10dB fader gain and see the 10dB 10 position as your unity gain position At the beginning of the fader movement you will feel an internally buil...

Page 15: ...able s first The following 3 jumper settings can be changed to adjust the AIRENCE Telco modules to your needs JUMPERS DEFAULT DESCRIPTION J11 J9 PST Stereo Aux send pre or post selectable via Jumper J11 9 post is default J4 J5 0dB Fader gain can be set to change the post fader gain from 0db to 10dB you need to do this for both left and right signals J17 Cont Pulse continuous Jumper J17 to change t...

Page 16: ...back of the outputs from stereo de vices such as CD players tape machines computer sound cards iPods or the OFF AIR signal to be routed to the CRM monitor buss Its sensitivity is 10dBv 300mV Note The Cue system from anywhere in the mixer will interrupt the EXT signal when activated RECORD OUTPUT Rec Out The AIRENCE has a Record output on Cinch connectors These outputs can be fed from SUB or from A...

Page 17: ...e is used by announcers and DJ s that do not want to use headphones all the time Also the CUE communication bus can be accessed to communicate with anyone connected to it CRM SECTION Control Room Monitor The CRM control is fed by the master outputs pre before the masterfaders This can be used as an extra stereo output for recording or a sound system in which you do not want the master faders to ch...

Page 18: ...ight output is heard until a Cue switch is activated from anywhere in the console By pressing a CUE switch you will hear the associated signal rather than the left right signal in the PHONES The led bar switches accordingly with this action We advise you to use headphones with an input impedance NO LOWER THAN 400 Ohms to avoid mismatch or distortion An 8 32 Ohm set of headphones will produce disto...

Page 19: ... inputs of a stereo audio recorder or any other analog or digital device Output level is 10dBv 7 8dBu 300mV the signal is post master fader AUX RETURN The Aux return connectors are controlled by the Aux return control on the master section The signal is connected directly to the master main mix busses You can connect reverb returns or other stereo signals without using any input modules The input ...

Page 20: ...is stereo jack is connected to a change over relay This relay is capable of controlling external Red light circuits as long as it doesn t take a higher voltage than 24 volt and the current doesn t exceed 50 mA Individual channels can be jumpered off from this buss NEVER CONNECT 115 230 AC VOLTAGE TO THIS JACK The C C Center Contact of the internal relay is connected to the Tip of the stereo jack T...

Page 21: ...The main unit of the AIRENCE works perfectly on one external power supply unit but incase redundancy is requested a second unit can be connected to the second power XLR connector If one fails the other takes over SUB D CONNECTOR TO SLAVE UNITS The AIRENCE has a Sub D connector where you can connect an input slave unit with 6 triple inputs to extend the number of inputs of your system All ON AIR an...

Page 22: ...6 dB to get a proper level on amplifiers or recording devices The LEDbar is a VU meter indicating the absolute level that enters the console It is calibrated to indicate 0 dB on the scale corresponding with a 6 dBu output level Release the CUE switch so the led bar can now read the output signal again Now push the ON button to connect the input signal to the fader Now move the fader to the 10 posi...

Page 23: ... good input level from the telephone line To be able to talk to the caller press the TB Talkback button and talk to him or use another MIC input of the mixer and push the CUE there too Adjust the Telco send potentiometer to increase or decrease the out going level to the caller Note This is all happening outside the broadcast If all is OK and both parties know what to do you can press the ON switc...

Page 24: ...icht belegt Pin 2 nicht belegt Pin 3 Amt Leitung A Pin 4 Amt Leitung B Pin 5 nicht belegt Pin 6 nicht belegt oder bei Nichtfunktion Pin I nicht belegt Pin 2 Amt Leitung B Pin 3 nicht belegt Pin 4 nicht belegt Pin 5 Amt Leitung A Pin 6 nicht belegt Ein Verbindungskabel ist durch ein Fachmann entsprechend anzupassen CONNECTION WIRING OF BOTH Wall LINE and PHONE RJ 11 CONNECTORS PHONE WALL RJ 11 FUNC...

Page 25: ... mikes The Mic pre circuitry uses the latest technology studio class components as used in high end recording consoles we use the That 1510 Mic pre which is highly acclaimed for its low noise distortion and transparent audio The low noise design and excellent phase spec that D R is known for is integrated throughout the AIRENCE USB which results in phase coherent signal path Using balanced microph...

Page 26: ...e for a unity gain position in the fully open position of the fader A jumper setting page will be shown further in this manual to customize your AIRENCE to your needs INPUT CONNECTORS 1 6 On the back of your AIRENCE EXTENDER modules 1 to 6 you will find the following seven connectors Two unbalanced line A input RCA Cinch connectors stereo input for connecting CD players or any play back devices su...

Page 27: ... your finger and the related channel fader is open into the processors output The other mono jack should be inserted into the processors input In case your processor has XLR inputs connect the tip of the stereo jack to pin 2 of the Female XLR and short pin 1 and 3 with each other and connect to ground sleeve this also goes for the other Male XLR connect the ring of the stereo jack which sends sign...

Page 28: ...5 J7 0dB Fader gain can be set to change the post fader gain from 0db to 10dB you need to do this for both left and right sig nals J6 J16 POST Stereo Aux send pre or post selectable via Jumper J6 J16 J5 Continuously Pulse Continuously Jumper J17 to change the start pulse from latching continuously to pulse J10 MIC ON ON select This J10 jumper allows you to mute the CRM speakers or the Studio speak...

Page 29: ...ro vide communication from the Presenter to the Studio room with the following possibilities 1 Switch 1 Comm When pressed the Mic input of the associate channel will be switched from Prog Sub or Aux to the Cue buss to be able to communicate with the technician 1 Switch 2 Cough When pressed the Mic input of the associate channel will be muted when the presenter need to Cough or sneeze 3 Rotary knob...

Page 30: ...P a g e 30 Control Module USB channel controls User Manual Control Section V 1 00 D R Electronica Weesp BV Rijnkade 15B 1382GS Weesp The Netherlands Phone 31 0 294 418014 Fax 31 0 294 416987 Website http www d r nl E mail info d r nl ...

Page 31: ...ftware application page 33 Airence virtual keyboard mapper page 34 Control signals Setting up your configuration Play out plug ins Quick function Learn page 36 Configuration viewer page 38 Let s get connected Presets Store preset Recall preset Settings Airence USB HID Control Protocol page 39 Introduction Message format page 40 Command byte Messages Write Request Response page 41 Events page 31 ...

Page 32: ...are by an external hardware device since the user prefer to have direct and accurate control over the controlled application In order to be able to control such a software applica tion from unlike mouse or keyboard one normally needs an external hardware device which is user friendly to operate and is able to communicate with the relevant application The Airence mixer benefits from an integrated c...

Page 33: ...als to the PC In order to keep things simple the HID Human Interface Device protocol is used for communication between the Airence mixer and PC On top of the HID protocol there is specific control protocol developed at D R which is discussed in depth in the chapter Airence USB HID Control Protocol for those who wants to go deeper Update rate When a state change of a control signal switch fader enc...

Page 34: ...thod uses a mapper application in between the HID messages and the controlled application and is created for the end user The Virtual Keyboard Mapper maps the control signals coming from the Airence mixer to standard keyboard key strokes In such a way pressing a switch on the control module will lead to a customized keystroke which controls a specific func tion inside the controlled application pl...

Page 35: ...rtual keyboard mapper Windows based application Control signals In total there are 39 control signals coming from the Airence mixer which can be mapped to keystrokes using the Airence virtual keyboard mapper application These 39 control signals are divided into the Control Module signals and USB Channel controls Control Module Switches 1 24 Encoder switch Encoder increment Encoder decrement USB Ch...

Page 36: ... the selection box All settings in this window are related to the selected source Source Action In the two action field groups the press and release events of a control signal can be configured If there is a play out plug in selected at the main window you can choose from predefined functions of that specific play out software When selecting one of those functions the remaining fields will be fill...

Page 37: ...plug in yourself Since the plug ins are represented in the XML format which is readable for machine as well as human beings it is not that hard to create one It is advisable to use another plug in as template and modify that file In the above figure a basic example plug in file is shown with two functions If more functions are needed simple copy and paste a function block line 9 16 The plug in sta...

Page 38: ...rectly the loaded functions are listed in the Quick Function Learn box Figure 8 Play out plug in required for using the Quick Function Learn Select one of the available functions from the Quick Function Learn box and press the Learn button The window as seen in the figure below will show up and waits for a control signal event coming from the Airence mixer If a control signal is received the selec...

Page 39: ...shown The indicator near the button indicates incoming messages Pressing the STOP button will stop the service and disconnect the Airence mixer When a control signal is received and is mapped to a keystroke this keystroke will be executed in real time To let the executed keystroke trigger a function in a software application you have to take care of giving this application Priority An application ...

Page 40: ...on about report descriptors can be found on www usb org For now remember that the Airence only will listen to reports with reportID 0 A control message has a fixed size of 8 bytes containing a SIZE byte COMMAND byte and a PAYLOAD section of maximal 6 bytes The SIZE byte contains the number of bytes used max 8 in the message including this SIZE byte byte 0 1 2 3 4 5 6 7 SIZE COMMAND PAYLOAD n cmd p...

Page 41: ...NE LED off 0x01 RED 0x02 GREEN 0x03 YELLOW AIRENCE_LED_BLINK_WRITE byte 0 1 2 3 4 5 6 7 SIZE COMMAND 0x06 0x03 lednum color_on color_off speed Byte Symbol Value Description 0 SIZE 0x06 Message size 1 COMMAND 0x03 AIRENCE_LED_BLINK_WRITE 2 lednum LED number 1 0x01 to 24 0x18 0xFF ALL LEDs 3 color_on 0x00 NONE LED off 0x01 RED 0x02 GREEN 0x03 YELLOW 4 color_off 0x00 NONE LED off 0x01 RED 0x02 GREEN ...

Page 42: ...SION_REQUEST Response A message of the type RESPONSE is transmitted from the Airence to the PC when prior a firmware version request message was received AIRENCE_FIRMWARE_VERSION_RESPONSE byte 0 1 2 3 4 5 6 7 SIZE COMMAND PAYLOAD 0x04 0x81 major minor Byte Symbol Value Description 0 SIZE 0x04 Message size 1 COMMAND 0x81 AIRENCE_FIRMWARE_VERSION_RESPONSE 2 major Firmware major revision 3 minor Firm...

Page 43: ...Byte Symbol Value Description 0 SIZE 0x04 Message size 1 COMMAND 0xC2 AIRENCE_LED_EVENT 2 lednum LED number 1 0x01 to 24 0x18 0xFF ALL LEDs 3 color 0x00 NONE LED off 0x01 RED 0x02 GREEN 0x03 YELLOW AIRENCE_LED_BLINK_EVENT byte 0 1 2 3 4 5 6 7 SIZE COMMAND PAYLOAD 0x06 0xC3 lednum color_on color_off speed Byte Symbol Value Description 0 SIZE 0x06 Message size 1 COMMAND 0xC3 AIRENCE_LED_BLINK_EVENT ...

Page 44: ... 1 ON 0 OFF bit 1 USB3 ON 1 pressed 0 released bit 2 USB3 CUE 1 pressed 0 released bit 3 USB4 faderstart 1 ON 0 OFF bit 4 USB4 ON 1 pressed 0 released bit 5 USB4 CUE 1 pressed 0 released AIRENCE_ENCODER_INCREMENT_EVENT byte 0 1 2 3 4 5 6 7 SIZE COMMAND PAYLOAD 0x03 0xC6 abs_value Byte Symbol Value Description 0 SIZE 0x03 Message size 1 COMMAND 0xC6 AIRENCE_ENCODER_INCREMENT_EVENT 2 abs_value Absol...

Page 45: ...A I R E N C E U S B M a n u a l P a g e 45 TROUBLESHOOTING USB Controller bandwidth exceeded in Windows 7 Version 1 0 2013 05 23 ...

Page 46: ...M a n u a l P a g e 46 1 Table of contents 1 TABLE OF CONTENTS 45 2 BACKGROUND 46 2 1 USB System Architecture 2 1 1 USB Host 2 1 2 USB Devices 2 2 Airence USB System Architecture 3 ANALYSIS 47 4 SOLUTION 49 5 USED TOOLS 50 ...

Page 47: ...ng the basic validity of bus transactions USB software layer is responsible for Handling USB devices and their connectivity USB devices enumeration and configuration Loading appropriate device drivers Managing the power on the bus and bus bandwidth Managing the data transfer between the software and hardware USB Host PC Controller A USB Host Controller is the hardware either on the computer mother...

Page 48: ...s problem is noticed in Windows 7 x64 operating system during test phase but could occur on other Windows versions as well If windows detects such a bandwidth overload it will show a warning message see figure on the next page The attached composite device has requested more than 15 of the available resources of the USB host controller Due to the fact the Airence is a composite USB device consisti...

Page 49: ...A I R E N C E U S B M a n u a l P a g e 49 Figure 2 Windows 7 generates warning message Figure 3 USB View Visualize the USB System Architecture ...

Page 50: ...ad simply make sure the Airence is exclusively connected to a Root Hub see figure above To do so a software program called USB View is used here to visualize the USB tree structure in your system With this tool you are able to check if the Airence is exclusively connected to a root hub If not you will see other devices con nected to the same Root Hub ...

Page 51: ...ot need to share the USB bandwidth with other devices To recognize the Airence device you can try to identify the internal USB Hub with the aid of the vendor and product id s 0x0451 and 0x2077 respectively Try to connect to another usb port on your PC if the Airence shares a Root Hub with other devices Figure 5 Visualisation of Airence USB Architecture 5 Used tools USB View http www ftdichip com S...

Page 52: ...playback and record mode 4x Stereo in and Main stereo or SUB signals out HID Functions Volume Mute Control USB CONTROL SECTION 24 free assignable illuminated switches plus encoder based on the HID protocol TELEPHONE HYBRIDS RJ 11 connectors for phone line dialler Mix Minus rejection 1kHz 40dB START REMOTE Stereo jack Tip is a change over contact between sleeve and ring NOT FOR 110 220 VOLT SWITCHI...

Page 53: ... S B M a n u a l P a g e 53 Firmware Update Procedure VERSION 1 0 D R Electronica Weesp BV Rijnkade 15B 1382GS Weesp The Netherlands Phone 31 0 294 418014 Fax 31 0 294 416987 Website http www d r nl E mail info d r nl ...

Page 54: ...nts INTRODUCTION 3 Bootloader mode 3 INSTALLATION 3 Airence Firmware Updatetool 3 USB bootloader drivers 7 FIRMWARE UPDATE PROCEDURE 9 Preparation 9 Flash firmware into device 9 TROUBLESHOOTING 10 Firmware update failed 10 Java virtual machine JVM 10 ...

Page 55: ...mode and is ready for use Bootloader mode To enter the bootloader mode a special startup sequence should be followed 1 Disconnect power 2 Push and hold down the encoder switch located on the control section 3 Connect power 4 Release the encoder switch Installation Airence Firmware Updatetool An Airence Firmware Updatetool is available which is required to perform the firmware update You can downlo...

Page 56: ...A I R E N C E U S B M a n u a l P a g e 56 Select a destination location for the update tool to be installed into and click Next Select a start menu folder and click Next ...

Page 57: ...A I R E N C E U S B M a n u a l P a g e 57 Enable the Create a desktop icon for a shortcut on the desktop and click Next If you agree with the configuration click Install to begin installation ...

Page 58: ...A I R E N C E U S B M a n u a l P a g e 58 Setup copies files to the destination install folder Click Finish to complete the installation ...

Page 59: ...tloader mode right click on the device and select properties On the Details tab select Hardware id s from the properties selection box and verify the VID and PID of the device VID Vendor ID 03EB PID Product ID 2FE4 To install the drivers right click on the device and select update drivers The drivers can be found in a subdirectory usb of the Airence Firmware Updatetool installation folder For exam...

Page 60: ...lation of the drivers was successful you should be able to see a screen similar to the one below In the device manager the unknown device is correctly installed and now shown as ATxmega32A4U The ATxmega32A4U device indicates the Airence is in bootloader mode ...

Page 61: ...nce Firmware Updatetool application Select the firmware hex from the extracted zip archive downloaded from the website Press the UPDATE button The progress bar gives an indication of the status of the update procedure When the update is successfully performed the Airence mixer automatically leaves the bootloader mode and reboots with the new firmware in normal operation mode The fol lowing message...

Page 62: ...ootloader mode open up the device man ager and look for the device Atmel USB Devices ATxmega32A4U Note Depending of your system it takes a certain amount of time to sign up and enumerate the device in the device manager after starting up the mixer in bootloader mode Java virtual machine JVM If you were prompted with the Java Virtual Machine JVM error it means JVM is not installed on your system Ja...

Page 63: ...ica Weesp b v Address Rijnkade 15B Zip Code 1382 GS City WEESP Country The Netherlands Phone 0031 0 294 418 014 Fax 0031 0 294 416 987 Website http www d r nl E mail info d r nl SUMMERY We hope this manual has given you sufficient information to use this new AIRENCE mixer in your studio If you require more info please contact your local dealer or send us an email at info d r nl and we will answer ...

Page 64: ...epartment for reliability in the HIGH VOLTAGE section CAUTION Never remove any panels or open this equipment No user serviceable parts inside Equipment power supply must be grounded at all times Only use this product as described in the user manual or brochure Do not operate this equipment in high humidity or expose it to water or other liquids Check the AC power supply cable to assure secure cont...

Search results

Summary of Contents for AIRENCE

Reviews:

Related manuals for AIRENCE

Brands by name

Popular brands

D&R AIRENCE, Manual

Search results

Summary of Contents for AIRENCE

Reviews:

Related manuals for AIRENCE

Brands by name

Popular brands