Home

Bosch Auto Parts Automobile Alarm THE DCN User's Manual

Contents

1. Request C Cancel all speakers MM C RTS CLEAR ON PC MM C RTS CLEAR ON PC MM C RTS CLEAR ON PC MM C SPK CLEAR ON PC MM C SPK CLEAR ON PC MM C SPK CLEAR ON PC MM C CR CLEAR ON PC MM C SPK CLEAR ON PC MM C CS CLEAR ON PC C Cancel all requests MM C RTS CLEAR ON PC MM C RTS CLEAR ON PC MM C RTS CLEAR ON PC None MM C CR CLEAR ON PC Bosch Security Systems B V 2003 December MM Remote Interface Description en 28 Note that a delegate does not really turns on its microphone but he makes a Request to speak Depending on the operation mode and the current lists he is added to the SPK list or the RTS list On this Request to Speak event also a remark has to be made if the unit delegate is in the Speakerslist but with the microphone off which is possible with the function MM C SET MICRO ON OFF see section 3 3 1 In that case for all operation modes a MM C SPK REMOVE ON PC update notification is first given for the current unit after which the update notifications according to the event matrix are generated 4 2 MM General notifications 4 21 C SET MIC OPER MODE PC Purpose Notifies the remote controller that the microphone operation mode has changed on the CCU Notify structure with this update The update comes with a structure as defined in section 3 2 5 4 2 2 MM C SET ACTIVE MICS ON PC Purpose Notifies the remote controller that the number of active m
2. PC Notifies the remote controller that the CR list is cleared Notify structure with this update The update does not have any additional parameters 47 2 MM C CR ADD ON Purpose Notifies the remote controller that a delegate unit combination is added to the CR list Notify structure with this update The update comes along with a MM T RTS structure which indicates the delegate unit combination to be removed The structure MM T RTS is defined in section 3 6 4 7 3 MM CR REMOVE ON PC Purpose Notifies the remote controller that a delegate unit combination is removed from the CR list Notify structure with this update The update comes along with a MM T RTS structure which indicates the delegate unit combination to be removed The structure MM T RTS is defined in section 3 6 4 7 4 C CR REPLACE PC Purpose Notifies the remote controller that a delegate unit combination is replaced by a new CR entry Notify structure with this update The update comes along with a MM T RTS REPLACE structure which indicates the delegate unit combination to be removed and the delegate unit combination to be added The structure MM T RTS REPLACE is defined in section 4 6 6 4 8 MM Speechtime notifications The Microphone Management speechtime notifications report the remote controller the changes in the Speechtime setting 4 81 MM C TIMER ON OFF Purpose Notifies the controller that there is a change in using not usi
3. 11 3 25 C SET MIC OPER MODE 1 4 seen nennen nennen intererit nennen 11 3 206 MICS rira eniti diee He cea endet e e de ente I Reed 11 39 2 7 MM C GET SETTINQGS 5 tie Hn t bee ira Re e YU ee 12 3 2 8 MM G SET SETTINGS indict decet doc E He Pe RE Eee HL T dd 13 MM Speaker list functions 13 3 31 MM C SET MICRO ON 13 59 22 MM GC SPK APPEND iH perez e Rat abe Se eA al e ER d 14 3 33 MM GC SPK BEMOQOWME ert ia d e He a dva tnde 15 53 94 Ana 15 239 52 MMEO SPK GET avai cc eei eet aia Bede e pads 15 MM Comment Speaker list 16 39 4 65 Raab a eee pi deg Cea deoa d td dd 16 34 22 MMLC CS GET iiie me m dr dite ep oce aes A eed add dv e ota 16 MM Notebook list functions 2 eie Eee Po do eph me darent 17 3 5 MM CGENBKE REMOVE teet eret ose eae ceste dee 17 9 5 2 MM C NBK CLEAR etl tre t ee eter rea 17 3 5 3 MM GSNBK GET stant ae eerte denne peti f eA e iti ed 17 3 54 MM CANBK SET ate niet pen terret n td tret eae 18 MM Request to Speak list functions sess en
4. typedef struct WORD wSpeechTimeLimit BOOLEAN bTimerOn BOOLEAN bHoldOnChairPriority BOOLEAN bShowRemainingTime MM_T_SET_SPEECHTIME_SETTINGS where wSpeechTimeLinit Speech time limit in minutes bTimerOn TRUE use the speech timer FALSE don t use the speech timer bHoldOnChairPriority TRUE hold timer if one or more Chairman press their Prio button FALSE don t hold timer bShowRemainingTime TRUE downcounting timer FALSE upcounting timer Response structure from the function This function has no response parameters Error codes returned MM E NOERROR MM E FAILED Update notifications MM C TIMER ON OFF Related functions MM C LAST MINUTE WARNING MM C TIME FINISHED WARNING 3 8 2 MM C LAST MINUTE WARNING Purpose This function is used to inform a particular unit that it is in his last minute of speaking Parameter structure for the function This function has one parameter WORD wUnitId where wUnitld The unit on which to place the message Response structure from the function This function has no response parameters Error codes returned MM E NOERROR MM E UNKNOWN UNIT MM E SEND ACTION FAILED Related functions MM C SET SPEECHTIME SETTINGS MM C TIME FINISHED WARNING 3 8 3 MM C TIME FINISHED WARNING Purpose This function is used to inform a particular unit that its time to speak is run out Parameter structure for the function This function has one parameter WORD wUnitId Bos
5. In the unit event matrix for each event the corresponding update notifications are given depending on the operational mode and the type of unit user For the Voice Activated mode there are no update notifications generated at all so this mode isn t mentioned in the table either The update notifications themselves are described in the remaining sections of this chapter Note that the input events for Microphone and or Request to Speak are initiated by pressing the Micro button on a Delegate and or Chairman unit and the input event for Priority is initiated by pressing the Priority button on a chairman unit The input events for Comment Requests can only occur in the operation mode MM C OPERATOR WITH COMMENT LIST In that mode the main menu and the speakers menu of the delegate units have assigned softkey 3 to the response i e comment option This implies that this response option is only available when the unit has the main menu or the MM menus as current menu Thus if a voting round is running or a message is being read the comment option is not available When speaking of chairman or delegate we really mention the user in the conference hall acting on a chairman unit e g LBB3554 and on a delegate unit e g LBB3550 or LBB3551 respectively On units having softkeys but no display the working is equal as if it were units with display and always showing the main menu Bosch Security Systems B V 2003 December MM Remote Interfa
6. below wUnitld Unit Identifier wMicroType The type of microphone handling for the notebook entry The following microphone types are valid for the notebook entries e MM C VIP CHAIRMAN MM C VIP KEY MM C VIP OPERATOR MM C VOICE MM C VCHAIR MM C CHAIRMAN NO AC MM C KEY NO AC MM C OPERATOR NO AC MM C VOICE NO AC MM C VCHAIR NO AC bMicroOn TRUE if the microphone is currently on FALSE if the microphone is currently off In a typical stand alone configuration the notebook contains only the chairman units which appear as MM C VIP CHAIRMAN entries in the notebook list Other type of notebook entries can only be added using a DCN Control PC Error codes returned MM E NOERROR 3 5 4 MM C NBK SET Purpose Set the complete contents of the Notebook list Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wNrOfNbk MM_T_NBK tNbkList DBSC MAX NOTEBOOKLIST MM T NBKLIST Where the MM T NBK is defined as typedef struct WORD wUnitId WORD wMicroType MM T where wNrOfNbk The number of NBK list entries actual present in the tNbkList array Only this amount of array elements are transmitted This value never exceeds the constant DBSC MAX NOTEBOOKLIST tNbkList Array holding the NBK list information Each array element is defined as a MM T NBK MICRO structure which is defined below wUnitld Unit Identifier
7. if tMMSettings wOperationMode MM C OPERATOR WITH REQ LIST tMMSettings wOperationMode MM C OPERATOR WITH REQ LIST bMustSend TRUE if tMMSettings wActiveMics 4 tMMSettings wActiveMics bMustSend TRUE 4 if tMMSettings wMaxRTSListLen 50 Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 39 tMMSettings wMaxRTSListLen bMustSend TRUE 50 Set new settings if we have to if bMustSend rror MM Set Settings amp tMMSettings if error MM E NOERROR do error handling Setting new settings also results in an update notification so the last thing to do is to check if our settings are accepted by the CCU Therefor we need the following function void MM_Set_Settings_On_Pc MM_T_CCU_GLOBAL_SETTINGS tNotifiedSettings BOOLEAN bIdentical FALSE assume we have a user defined function to compare both settings structures bIdentical MyCompareSettings tNotifiedSettings tMMSettings if bIdentical FALSE If they are not the same Either update your local settings with the CCU settings or try to set them again Once the settings are known we could retrieve the current notebook speakers and RTS list and wait for the updates to monitor the microphone status in the conference hall or send remote functions to influence that status When the
8. define MM C NBK CLEAR MKWORD 44 DCNC APP MM define MM C NBK REMOVE MKWORD 45 DCNC APP MM define MM C SPK GET MKWORD 46 DCNC APP MM define MM C SPK CLEAR MKWORD 47 DCNC APP MM define MM C SPK APPEND MKWORD 48 DCNC APP MM define MM C SPK REMOVE MKWORD 49 DCNC APP MM define C SET MIC OPER MODE MKWORD 52 DCNC APP MM define MM C SET ACTIVE MICS MKWORD 53 DCNC APP MM define MM C SET SPEECHTIME SETTINGS MKWORD 59 DCNC APP MM define C LAST MINUTE WARNING MKWORD 60 DCNC APP MM define MM TIME FINISHED WARNING MKWORD 61 DCNC APP MM define MM C RTS APPEND MKWORD 62 DCNC APP MM define MM C CR REMOVE MKWORD 64 DCNC APP MM define C SHIFT CR MKWORD 65 DCNC APP MM define MM C CR GET MKWORD 66 DCNC APP MM define MM C CS REMOVE MKWORD 67 DCNC APP MM define C CS GET MKWORD 68 DCNC APP MM define MM C START MON MM MKWORD 69 DCNC APP MM define MM STOP MON MM MKWORD 70 DCNC APP MM define C PC MIC ON 1 define C_PC_MIC_OFF 2 Bosch Security Systems 2003 December MM Remote Interface Description MM Remote Interface Description 35 define C PC MIC NONE 3 define C PC PRIO 1 define GC PC PRIO OPE 2 define C PC PRIO NONE 3 define VIP CHAIRMAN 1 Chairman def
9. wMicroType The type of microphone handling for the notebook entry The following microphone types are valid for the notebook entries e MM C VIP CHAIRMAN MM C VIP KEY MM C VIP OPERATOR MM C VIP VOICE MM C VCHAIR Bosch Security Systems B V 2003 December MM Remote Interface Description en 19 MM C CHAIRMAN NO AC MM C KEY NO AC MM C OPERATOR NO AC MM C VOICE NO AC MM C VCHAIR NO AC In a typical stand alone configuration the notebook contains only the chairman units which appear as MM C CHAIRMAN entries in the notebook list Other type of notebook entries can only be added using a DCN Control PC Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E DELETE NOTEBOOK FAILED MM E INSERT NOTEBOOK FAILED MM E UPDATE NOTEBOOK FAILED Update notifications MM C NBK SET ON PC Related Functions MM C NBK GET 3 6 MM Request to Speak list functions This section describes the functions to manipulate the RTS list The RTS list is a list of delegates with their unit identifications which are waiting to get speech time Both the Unitld and the Delegateld are present in the RTS list because using access control with cards and free seating allows a delegate to leave its unit taking out his card and go to another unit inserting his card again During these actions a pending request of that delegate must remain in the RTS list and while the card is
10. from being added at the end of the normal RTS list Comment Requests are identified by the same MM T structure as normal RTS entries Comment Requests show the same behaviour in combination with access control and cards as normal RTS entries 3 7 4 C CR REMOVE Purpose Remove one delegate unit combination from the CR list on the CCU Parameter structure for the function This functions requires the structure MM T RTS as parameter This structure is defined in section 3 6 Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE MM E RTS LIST EMPTY MM E UNKNOWN UNITID AND DELID MM E UNIT NOT PRESENT MM E UNITID DELID MISMATCH Update notifications MM C CR REMOVE ON PC Related functions MM C CR GET 3 7 2 MM C CR GET Purpose Retrieve the complete contents of the CR list as present in the CCU Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure typedef struct Bosch Security Systems B V 2003 December MM Remote Interface Description en 23 WORD wNrOfCR MM T RTS tCRList DBSC MAX DELCR MM T CCU CRLIST where wNrOfCR The number of CR list entries actual present in the tCRList array This value never exceeds the constant DBSC_MAX_DELCR tCRList Array holding the CR list information Each arra
11. that a speaker is replaced by another speaker Notify structure with this update The update comes along with the following structure typedef struct MM_T_SPK tCurrSpk MM T SPK tNewSpk MM SPK REPLACE where tCurrSpk The SPK entry to search for This SPK entry is replaced by the new value given in the parameter tNewSpk tNewSpk The SPK entry holding the new contents 4 4 MM Comment Speaker list notifications The Microphone Management comment speaker list notifications report the changes in the comment speakers list 4 4 41 MM C CS CLEAR ON PC Purpose Notifies the remote controller that the CS list is cleared Notify structure with this update The update does not have any additional parameters 442 MM C CS ADD ON PC Purpose Notifies the remote controller that a unit is added to the CS list Notify structure with this update The update comes with the following structure MM T SPK tCSpkAdd Bosch Security Systems B V 2003 December MM Remote Interface Description en 31 where tCSpkAdd The speaker who is added to the comment speakers list The structure MM T SPK is defined in section 3 3 2 443 MM C CS REMOVE ON PC Purpose Notifies the remote controller that a unit is removed from the SPK list including turning off the microphone Notify structure with this update The update comes with the following structure MM T SPK tCSpkRemove where tCSpkRemove The speaker who is removed from the comme
12. update notifications to the remote controller A call to this function when the update use count is already zero will keep the use count to zero and nothing shall happen When the use count reaches zero then the microphone management application inside the CCU returns to its stand alone operation This return involves a change in the following settings of the MM application Setting Parameter E Destination of change wOperationMode When the operation mode is MM C OPERATOR WITH REQ LIST or MM C OPERATOR WITH COMMENT LIST the mode will be changed to MM C DELEGATE WITH REQ LIST All other modes will remain active wActiveMics 2 When the number of active microphones is 3 this will be extended to 4 as visible on the front panel This implies also changes of the SPK and RTS lists bAllowMicroOff 2 This value is set to TRUE Note that this value is only used in the modes MM_C_OPERATOR_WITH_REQ_LIST and MM C OPERATOR WITH COMMENT LIST All other MM settings remain active while functioning in stand alone mode Note that Upon communication lost this function will be activated if MM C START MM was activated The activation of this function is repeated till the update use count becomes zero Parameter structure for the function The function has no additional parameters Response structure from the function The function has the same response structure as the remote function MM C START MM section 3 2 1 Error codes returned MM E NOERROR MM E O
13. 8 4 21 C SET MIC OPER MODE 28 Bosch Security Systems B V 2003 December MM Remote Interface Description 4 2 2 MM C SET ACTIVE MICS ON PO ssssssssssseeeenneeeenn ener nnn nitent 28 423 C SET SETTINGS ON PO rnnt enne rini nennen 28 4 3 MM Speaker list notifications 28 43 1 MMC MICRO ON OFF iac nette eite aee tiet aede tiere eda 28 432 MM C NR CHAIR MICS ON rias aromia 29 43 3 MM C SPKCSET ON PG on dnte eet eerie tide dena 29 4 3 4 MM CG SPK CEEAR ON PO n anoche mettere ertet deis 29 43 5 MM GC SPK APPEND ON PO iet Pre eer ede fue tae ete i ts 29 4 3 6 MM SPK REMOVE ON 30 437 C INSERT 2 4444 0 0 0000 tents anth taste seen tss eaii Gaiaa 30 4 3 8 C SPK REPLACE ON PO sss eaaa 30 4 4 MM Comment Speaker list notifications ssssssssssssseneeeennene enne nnns 30 44 11 C CS CLEAR ON PG ettet ette ete eed tie deua 30 442 MM C GS ADD ON PG itn atte ertet os eet d tere ete qoi Pee tid dea 30 443 C GS REMOVE ON PO etian edere UG nnde tede ee Ede dena 31 4 5 MM Notebook list notifications enemies 31 4 5 1 C NBK REMOVE ON 22204 02222 0 0 000 0000000 0 nint enne 31 4 5 2 MM C NBK SET ON PO seanina i a ener en trennen inns inttr enne
14. KERS LIST FAILED 32 The CCU was not able to insert the SPK list entry into the internal database Probably an illegal value for the element Unitld is passed MM E SPEAKERS LIST FULL 34 The SPK list is full No more SPK entries can be added using the function MM C SPK APPEND MM E ILLEGAL MICRO TYPE 47 This unit is also present in the Notebook and has a microtype that is not allowed in the speakers list MM E UNIT NOT CONNECTED 48 The unit is not connected to the system any more MM E UNITID DELID MISMATCH 49 The unit and delegate do not match with each other according to the database on the CCU Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 38 APPENDIX C EXAMPLES In the example below the remote functions and update notifications that are defined in this document as constant values for the wFnld parameter of the message see SRS_INF are presented as functions described in a C syntax The parameter structures of these functions are according the input output or notify structures described in the appropriate section For every function is assumed that the function will create his structure transport the parameters to the CCU and waits for the result information coming from the CCU For both the remote functions as the update notifications the same names are used as their identifier but without the constant mark C and using mixed case names So
15. MM define C SPK APPEND ON PC MKWORD 14 DCNC APP MM define C 5 REMOVE ON PC MKWORD 15 DCNC APP MM define C 5 INSERT ON PC MKWORD 16 DCNC APP MM define MM C SPK REPLACE ON PC MKWORD 17 DCNC APP MM define C SET MIC OPER MODE ON PC MKWORD 18 DCNC APP MM define C SET ACTIVE MICS ON PC MKWORD 19 DCNC APP MM define C RTS FIRST ON PC MKWORD 20 DCNC APP MM define MM C SET SETTINGS ON PC MKWORD 21 DCNC APP MM define CR CLEAR ON PC MKWORD 22 DCNC APP MM define MM C CR ADD ON PC MKWORD 23 DCNC APP MM define CR REMOVE ON PC MKWORD 24 DCNC APP MM define CR REPLACE ON PC MKWORD 25 DCNC APP MM define CS CLEAR ON PC MKWORD 26 DCNC APP MM define C CS ADD ON PC MKWORD 27 DCNC APP MM define C CS REMOVE PC MKWORD 28 DCNC APP MM define MM START MM MKWORD 30 DCNC APP MM define MM STOP MM MKWORD 31 DCNC APP MM define MM GET SETTINGS MKWORD 32 DCNC APP MM define MM C SET SETTINGS MKWORD 33 DCNC APP MM define C SET MICRO ON OFF MKWORD 34 DCNC APP MM define MM C SHIFT MKWORD 35 DCNC APP MM define MM C RTS GET MKWORD 37 DCNC APP MM define MM C RTS CLEAR MKWORD 38 DCNC APP MM define MM C RTS REMOVE MKWORD 39 DCNC APP MM define MM C NBK SET MKWORD 42 DCNC APP MM define MM C NBK GET MKWORD 43 DCNC APP MM
16. MM Remote Interface Description las The DCN Security Systems en MM Remote Interface Description BOSCH en 2 Table of Contents 3 3 3 4 3 5 3 6 3 7 3 8 4 1 4 2 E ae UE T EE 4 ER er RUE te Dto ID A DE haps oe 4 feo IEEE 4 Definitions Acronyms and Abbreviations sssssssssssseess eee enne 4 i2 TEETH 4 OVOIVIGW necs cte ate e rtp irte das DX eee EXE tes 4 Microphone management for a Remote interface sss 5 5 Remote Microphone Management Control 5 Microphone List and Mode Management sse 5 Remote Functions 1 eee oec 9 9 Preconditlons he oae ciento teh eic 9 3 1 2 Remote function item explanation ssssssssseeeee eene nnns 9 MM General functions esssessssssssssssseseseeeen isis nnns etre nennen 9 g2 MM G STARTAMM sinite eot t ette dte ate D mete ens 9 3 20 25 MMEGCESTOB MM 57 ith tt end ts idee tete seta 10 3 23 MM C START MON 2 0 00 2 0 00000000000 10 3 24 MM C STOP MON MM sssseseeeeneeennneen
17. PEN CLOSE FAILED Related functions MM C START MM 3 23 C START MON Purpose Function to start the monitoring behaviour of the Microphone Management application It is not allowed possible to control settings of Microphone Management Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure WORD wNrOfInstances where wNrOfInstances The value of the update use count for the MM application at the end of the function handling It contains the number of times a remote PC has connected over the same communication medium E g the first time the MM C START MON MM Bosch Security Systems B V 2003 December MM Remote Interface Description en 11 function is called it contains the value 1 Error codes returned MM E NOERROR Related functions MM C STOP MM MM C STOP MON MM 3 2 4 MM C STOP MON MM Purpose Function to stop monitoring the behaviour of the Microphone Management application Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the same response structure as the remote function MM C START MON MM section 3 2 3 Error codes returned MM E NOERROR Related functions MM C START MM MM C START MON MM 3 2 5 MM C SET MIC OPER MODE Purpose This function allows the remote controller to change the microphone ope
18. S functions notifications e enables all CR functions notifications e enables all SPK functions notifications e enables all CS functions notifications The SPK functions and notifications mentioned in the table are described in respectively sections 3 3 and 4 3 The CS functions and notifications mentioned in the table are described in respectively sections 3 4 and 4 4 Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 8 The RTS functions and notifications mentioned in the table are described in respectively sections 3 5 4 and 4 6 The CR functions and notifications mentioned in the table are described in respectively sections 3 7 and 4 7 Bosch Security Systems B V 2003 December MM Remote Interface Description en 9 3 Remote Functions 3 1 Introduction This chapter describes the various remote functions needed to perform microphone management on the system 3 1 1 Preconditions The remote functions for the MM application acting on any of the microphone lists always use the Unitld to perform the requested functionality For the Request to speak list or Comment Request list functions also a Delegateld is required This Unitld and Delegateld must be retrieved respectively set using the appropriate functions of the SC SI Remote Interface as described in SRS_SCSIINF 3 1 2 Remote function item explanation Each description consists of the following i
19. Tone TRUE An attention tone is generated when the priority key is pressed on a chairman unit FALSE No attention is generated when the priority key is pressed bAmbientMicCtrl TRUE The ambient microphone control is enabled Ambient mic control means that the ambient mic is turned on when the last microphone of all units in the conference hall is switched off and it is turned off when the first microphone is switched on FALSE The ambient microphone control is disabled i e the ambient mic will always be switched off Error codes returned MM E NOERROR Related functions MM C SET SETTINGS 3 2 8 MM C SET SETTINGS Purpose Set the general operating settings of the MM application If the operation mode is set to MM C OPERATOR WITH COMMENT LIST the value for maximum number of active microphones will be omitted and the maximum number of active microphones will be set to 1 Parameter structure for the function The structure to be passed along with this function is the same structure as the structure received during the remote function MM C GET SETTINGS see 3 2 7 Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE MM E ILLEGAL MAX ACT MICS MM E ILLEGAL MAX RTS LIST LEN MM E RTS LIST CHANGED MM E DELETE RTS LIST FAILED Update notifications MM C SET SETTINGS ON PC and various SPK CS RTS and or CR updates depending on the settings made Related funct
20. as no response parameters Error codes returned MM E NOERROR MM E SPEAKERS LIST FULL MM E INSERT SPEAKERS LIST FAILED MM E NOT IN SPL OR NOB MM E UNIT NOT CONNECTED Update notifications MM C SPK APPEND ON PC delegate micro on and added to SPK MM C MICRO ON OFF micro on off and already in SPK Related functions MM C SPK APPEND MM C SPK REMOVE 3 3 C SPK APPEND Purpose Add a unit to the end of the speakers list on the CCU The addition of a unit to the SPK list automatically implies that the microphone will be turned on Note that this function always adds the unit to the speakers list Even if this unit is a chairman A good practice is to use the remote function MM C SET MICRO ON OFF for managing the microphones state When the unit is already present in the SPK list an error is reported and the current microphone status of the unit is unchanged The CS list if present will be cleared Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wUnitId MM T SPK where wUnitld Unit Identifier Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE MM E ILLEGAL MICRO TYPE MM E UNIT ALREADY PRESENT MM E SPEAKERS LIST FULL MM E INSERT SPEAKERS LIST FAILED MM E UNIT NOT CONNECTED Bosch Security Systems B V 2003 December MM Remote Interface Descrip
21. bAllowCancelRequests BOOLEAN bAllowMicroOff BOOLEAN bAttentionTone BOOLEAN bAmbientMicCtrl MM T CCU GLOBAL SETTINGS where wOperationMode The operation mode of the MM application which is one of the following e MM C OPERATOR WITH REQ LIST e MM C DELEGATE WITH REQ LIST e MM C DELEGATE WITH OVERRIDE e MM C DELEGATE WITH VOICE e MM C OPERATOR WITH COMMENT LIST For more information about the different modes see section 3 2 5 wActiveMics The number of active delegate microphones which can be on at the same time chairman micro s are not counted Range 1 4 wMaxRTSListLen The maximum Request To Speak list length Range 0 100 bAllowCancelRequest TRUE A Delegate is able to cancel a request to speak using the Micro key on the unit FALSE A Delegate is not able to cancel a request to speak This parameter is only valid within the operation modes MM OPERATOR WITH REQ LIST MM C DELEGATE WITH REQ LIST and MM C OPERATOR WITH COMMENT LIST Note A Delegate is always able to cancel a comment request bAllowMicroOff TRUE A Delegate is able to turn off the microphone on the unit FALSE A Delegate is not able to turn off the microphone This Bosch Security Systems B V 2003 December MM Remote Interface Description en 13 implies that the micro can only be turned off by the remote controller only valid for the operation modes MM_C_OPERATOR_WITH_REQ_LIST and MM C OPERATOR WITH COMMENT LIST bAttention
22. ce Description en 27 eo MATRIX Operational Mode meut event Chairman Delegate with Req List Operator with Req List Operator with Request an Response Delegate with Override Delegate List MM_C_NR_CHAIR_MICS_ON MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON C Priority On MM C MICRO ON OFF MM C MICRO ON OFF MM C MICRO ON OFF MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON D Request to Speak If the speakers list is not full if the RTS list is not full if the RTS list is not full If the speakers list is not full MM C SPK APPEND ON PC MM C RTS INSERT ON PC MM C RTS INSERT ON PC MM C SPK APPEND ON PC else if the RTS list is not full and if it is also the first in the RTS list and if itis also the first in the RTS list else MM C RTS INSERT ON PC MM C RTS FIRST ON PC MM C RTS FIRST ON PC MM C SPK REMOVE ON PC and if it is also the first in the RTS MM C SPK APPEND ON PC list MM C RTS FIRST ON PC D Cancel Req to Speak MM C RTS REMOVE ON PC MM C RTS REMOVE ON PC MM C RTS REMOVE ON PC and if it was the first in the RTS list and if it was the first in the RTS list and if it was the first in the RTS list o MM C RTS FIRST ON PC MM C RTS FIRST ON PC MM C RTS FIRST ON PC MM C CR ADD ON PC N A D Cancel Comment MM C CR REMOVE ON PC
23. ch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description 25 where wUnitld The unit on which to place the message Response structure from the function This function has no response parameters Error codes returned MM E NOERROR MM E UNKNOWN UNIT Related functions MM C SET SPEECHTIME SETTINGS MM C LAST MINUTE WARNING Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 26 4 Update Notifications 4 1 Introduction This chapter describes the various update notifications sent by the CCU All the update notifications of the MM application are listed in this chapter 4 1 1 Update notification item explanation Each update notification description consists of the following items e Purpose A global description of the purpose of the notification e Notify structure with this update The information passed with the update notification 4 1 2 Unit user event relations As we have mentioned in section 2 2 update notifications are not only the results of remote functions generated by the remote controller but can also be the results of unit user events To understand these relationships a unit event matrix is given in this section It is assumed that the remote controller is used with a stand alone configuration i e no DCN Control PC connected so only a distinction between chairman and delegate is made
24. congress is finished we must tell the CCU that we stopped monitoring the MM application using the following function WORD wNrOfInstances error MM Stop MM amp wNrOfInstances if error MM E NOERROR do error handling else switch wNrOfInstances case 0 OK break default 1 or more This means there are still remote controllers identified by the CCU Stop as many times as needed WORD wNewNumber do MM Stop MM amp wNewNumber while wNewNumber 0 break This ends controlling the MM application The remote controller and CCU can now safely be switched off Bosch Security Systems B V 2003 December MM Remote Interface Description For more information please visit www boschsecuritysystems com 2003 Bosch Security Systems B V Data subject to change without notice December 2003 MM Remote Interface Description BOSCH
25. e 19 3 621 MM C RIS APPEND oe reti t IR Ane ete aee ceste nus 19 3 6 2 MM G RTS REMOVE ett a ia be IO nose ee tina tana 20 39 6 9 MM G RATS GLEEAR einen detiene tates 20 3 6 4 MMC RIS GET ctw ne that t th i IH Een 20 3 6 5 MM CERIS SET eet eet neo te ee Reset 21 8 0 0 MMC SHIFT ett de eee te tn octal eee io etos eet ee e t be decla 21 MM Comment Request list functions sse eene nnne nennen nnne nennen 22 MM CCR REMOVE ts aiii trifft uh Orbe o apie 22 9 7 2 1MM GECBUSGET sitit iet qu ea eter eat ester ato dealt ovine 22 3 29 MM C o idi nee a De ERES EM cee 23 MM Speechtime functions tenen nnns 23 3 8 1 MM C SET SPEECHTIME 8 04 0 000000000000 nennen 24 3 8 2 C LAST MINUTE WARNING nennen nnne nennen snnt nennt 24 3 8 3 MM C TIME FINISHED WARNING essent 24 Wpdate Notificatioris 25 oria iere capes Pre Eee e Pests e P eden e E e Fe de esca 26 ER EP 26 4 1 1 Update notification item nnne 26 41 2 Unit user event 44 4084040000 26 MM General 240 00 2
26. e Description 29 e MM C PC PRIO OFF e MM C PC PRIO NONE The NONE values of the parameters wMicrold and wPriold indicate that the specific parameter is not used Examples To illustrate the values of the parameters wMicrold and wPriold the following value for these parameters are returned with the events Chairman micro ON no Prio Chairman micro OFF no Prio Chairman prio ON no micro Chairman prio OFF no micro Chairman prio ON with micro on Chairman prio OFF with micro on Chairman prio ON with other prio on Chairman prio OFF with other prio on 4 3 NR CHAIR MICS ON Purpose Notifies the remote controller that there are still chairmen which have pressed their micro or priority key on the unit Note This notification is used to handle speech time correctly controlled by the DCN control PC E g The delegates speech time must be held when at least one chairman is speaking Notify structure with this update The update comes with the following structure WORD wNrOfChairMicsOn where wNrOfChairMicsOn The number of chairmen which are speaking 4 3 3 MM C SPK SET ON PC Purpose Notifies the remote controller that the CCU has a complete new list of SPK entries Notify structure with this update The update comes with the structure defined in 3 3 5 4 3 4 MM C SPK CLEAR ON PC Purpose Notifies the remote controller that the SPK list is cleared Notify
27. e RTS list is cleared Notify structure with this update The update does not have any additional parameters Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 32 4 6 8 MM RTS REMOVE Purpose Notifies the remote controller that a delegate unit combination is removed from the RTS list Notify structure with this update The update comes along with a MM T RTS structure which indicates the delegate unit combination to be removed The structure MM T RTS is defined in section 3 6 4 6 4 C RTS FIRST ON PC Purpose Notifies the remote controller which delegate unit combination is the first in the list When the Unitld and Delegateld fields of the structure are filled with DBSC EMPTY UNIT and DBSC EMPTY DELEGATE respectively the first RTS entry becomes invalid The last results into a empty RTS list Note that this notification invalidates the previous notification about the first RTS list entry Notify structure with this update The update comes with the following structure MM T RTS tRtsFirst where tRtsFirst The RTS list entry which is now at the top of the RTS list 4 6 5 MM C RTS INSERT ON PC Purpose Notifies the remote controller that a delegate unit combination is inserted in the RTS list before another RTS entry This notification is sent for both an insertion between two RTS entries as a append of a RTS entry to the end of the RTS Notify s
28. e g remote function MM_C_SET_SETTINGS shall be referenced as function as MM Set Settings MM T GLOBAL SETTINGS tMMSettings C 1 Microphone Management Control This example shows the minimum steps to be taken for controlling the MM application First we have to start the MM application inside the CCU WORD wNrOfInstances error MM Start MM amp wNrOfInstances if error MM E NOERROR do error handling else switch wNrOfInstances case 0 something went wrong with registering for remote interface So do error handling break case 1 OK break default 2 or more This means there are more remote controllers identified by the CCU Stop as many times as needed WORD wNewNumber do MM Stop MM amp wNewNumber while wNewNumber 1 break If there are no errors on starting the MM application the next thing we are interested in are the settings Assume that we want the system to operate in a Operator with RTS list mode 4 active mics and a maximum RTS list length of 50 The first thing to do is retrieve the current settings then check them against the wanted settings and if they are not the same set the new settings The results in the following control flow declare variables MM_T_CCU_GLOBAL_SETTINGS tMMSettings BOOLEAN bMustSend FALSE retrieve the current settings MM Get Settings amp tMMSettings and check if they are what we want
29. e structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE MM E UNIT NOT PRESENT MM E UNKNOWN UNIT Update notifications MM C CS REMOVE ON PC 3 4 3 C CS GET Purpose Retrieve the complete contents of the Comment Speakers list as present in the CCU Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure typedef struct WORD wNrOfCS MM T SPK MICRO tCSList DBSC MAX DELCS MM T CCU CSLIST where wNrOfCS The number of CS list entries actual present in the tCSList array This value never exceeds the constant DBSC MAX DELCS tCSpkList Array holding the CS list information Each array element is defined as a MM T SPK MICRO structure which is defined in 3 3 5 Error codes returned MM E NOERROR Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 17 3 5 MM Notebook list functions This section describes the functions to manipulate the Notebook list 3 5 14 C REMOVE Purpose Remove one entry from the Notebook as present in the CCU Parameter Structure for the function The function requires the MM T NBK structure for input This structure is defined in section 4 5 1 Response structure from the function The function has no response parameters Error codes re
30. eceive update messages from the CCU Remote functions coming from either the DCN control PC or the remote controller initiates in the CCU an update of the internal lists During the update notifications are generated and sent to both the DCN control PC and the remote controller In this way both remote controllers get the update information about the actions performed on either the DCN control PC or the remote controller During the processing of remote functions on the CCU the update messages are created and transmitted This implies that the response information of a remote function can be received after the reception of an update notification The remote controller must wait for the response of the remote function After reception of the response appropriate action should be taken upon the error code returned The notifications received during the wait for the response may be processed directly Requests coming from a unit are processed and the lists updated During the update notifications are generated and sent to all registered PC s In the system mentioned above both the DCN control PC and the remote controller will receive the same update notifications This document gives the set of Remote Functions and the set of Update Notifications concerning Microphone Management The relation between Remote Function sent by the remote controller and Update Notifications is given in the description of each separate Remote Function The relation between unit e
31. es except for the mode Delegate with Voice activation Request to Speak The request to speak list contains the unit delegate combinations that list requested to have their microphone switched on so they can speak Depending on the operation mode an unit delegate is automatically promoted to the speakers list or by means of an operator action The request to speak list exists in the modes Operator with Request list Operator with Request and Response list and Delegate with Request list Comment The comment request list or response request list contains the Request list unit delegate combinations that wants to make an immediate response on the current speaker This comment request list is to prevent them from being added at the end of the normal request to speak list and thus loosing the urgency of the response The comment request list is only available in the mode Operator with Request and Response list Comment The comment speakers list or response speakers list contains the Speakers list units that are promoted from the comment request list to make their response i e they are allowed to speak now Promoting a unit from the comment request list to the comment speakers list can only be done by means of an operator action The comment speakers list is only available in the mode Operator with Request and Response list A full description about the operation modes is given in the user manuals USERDOC_MM and USERDOC SM In the table belo
32. f the DCN software which allows for another controlling entity outside the CCU not being the DCN Control PC to use the Microphone Management application 2 2 Remote Microphone Management Control Microphone Management is the application that allows for controlling the microphones in the conference hall Typical control issues are e g turning a Microphone On adding a delegate to the RTS list changing the Operation Mode etc More details on the complete MM application can be found in the user manual USERDOC Controlling microphones with a remote interface is by means of calling a defined set of Remote Functions and acting upon a defined set of Update Notifications The general concept of Remote Functions and Update Notifications is described in 585 INF 585 INF also describes the protocol and hardware conditions concerning the remote interface Together with this remote interface there are up to three locations in a full connected CCU where MM can be influenced These locations are e The remote interface or remote controller using the RS 232 interface The remote controller makes Remote Function calls for microphone management e A DON Control PC connected using a PC card This DCN control PC also uses Remote Function calls for microphone management e The actual units that handle their microphone keys To get a full operational system both the DCN control PC and the remote controller must register themselves to the CCU so they will r
33. ications are sent upon state changes due to actions from the control PC s and all microphone actions on the units During the time the Microphone Management application is controlled remotely i e the update use count is greater than zero the LED s on the control panel of the CCU are turned off and buttons on the control panel are disabled When you omit the execution of this remote function you can still execute remote functions but no update notifications will be sent to the remote controller Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure WORD wNrOfInstances where wNrOfInstances The value of the update use count for the MM application at the end of the function handling It contains the number of times a remote PC has connected over the same communication medium E g the first time the MM C START MM function is Bosch Security Systems B V 2003 December MM Remote Interface Description en 10 called it contains the value 1 Error codes returned MM E NOERROR MM E OPEN CLOSE FAILED Related functions MM C STOP MM 3 22 MM C STOP MM Purpose Indicates the CCU that the remote controller no longer requires updates from the MM application inside the CCU After receiving this function the CCU decrements the update use count As long as the update use count is still greater than zero the CCU remains sending the
34. icrophones has changed on the CCU Notify structure with this update The update comes with a structure as defined in section 3 2 6 4 2 5 MM C SET SETTINGS ON PC Purpose Notifies the remote controller that there is a change in the global settings on the CCU Notify structure with this update The update comes with a structure as defined in section 3 2 7 4 3 MM Speaker list notifications The Microphone Management speaker list notifications reports the changes in the speakers list 4 3 1 MM C MICRO ON OFF Purpose Notifies the remote controller that a microphone of a unit is turned on or off This notification will be sent when a delegate turns its microphone on or off Notify structure with this update The update comes with the following structure typedef struct WORD wUnitId WORD wMicroId WORD wPriold MM T MICRO ONOFF ON PC where wUnitld Unit Identifier wMicrold Passes the status of the microphone This parameter can be one of the following values e MM_C_PC_MIC_ON e MM_C_PC_MIC_OFF e MM C PC MIC NONE wPriold Passes the prio status of the chairman unit This priority information indicates to the remote controller that the delegate units can be muted due to a priority key pressed on this chairman unit Although the microphone is turned on the delegate can not yet speak This parameter can be one of the following values e MM C PC PRIO ON Bosch Security Systems B V 2003 December MM Remote Interfac
35. ine C KEY 2 Delegate set as Key activated notebooker define C VIP OPERATOR 3 Delegate set as Operator activated notebooker define MM C VOICE 4 Delegate set as Voice activated notebooker define MM VIP VCHAIR 5 Chairman set as Voice activated define MM C CHAIRMAN NO AC 6 Chairman exclude from Access Control define MM KEY NO AC 7 Key Activated Delegate excluded from Access Control define MM C OPERATOR NO AC 8 Operator Activated Delegate excluded from Access Control define VOICE NO AC 9 Voice Activated Delegate excluded from Access Control define VCHAIR NO AC 10 Voice Activated Chairman excluded from Access Control define C OPERATOR WITH REQ LIST 0 define MM C DELEGATE WITH REQ LIST 1 define C DELEGATE WITH OVERRIDE 2 define MM C DELEGATE WITH VOICE 3 define C OPERATOR WITH COMMENT LIST 4 define DBSC MAX SPEAKERLIST 4 define DBSC MAX NOTEBOOKLIST 15 define DBSC MAX DELRTS 100 define DBSC MAX DELCR 5 define DBSC MAX DELCS define DBSC EMPTY UNIT OxFFFF define DBSC EMPTY DELEGATE OxFFFF Bosch Security Systems B V 2003 December MM Remote Interface Description APPENDIX B ERROR CODES en 36 Responses returned upon a remote function request contain a error field wError In this appendix an overview is given of the possible errors and their values Microphone Management Error code Value Explanation MM E NOERROR 0 The executio
36. ions MM C GET SETTINGS 3 3 MM Speaker list functions This section describes the functions to manipulate the speakers list 3 3 1 SET MICRO ON OFF Purpose Control the microphone of a unit This function gives the ability to turn the microphone of a unit on or off To describe the functionality included with this function several cases of this function are described in the table below Action periormed Delegate unit micro on The unit is appended to the SPK list if possible Delegate unit micro off The units microphone is turned off but the unit still remains in the SPK list To remove the speaker also from the SPK list use the remote call MM C SPK REMOVE see section 3 3 3 Delegate unit micro on The units microphone is turned on The unit remains in Bosch Security Systems B V 2003 December MM Remote Interface Description en 14 already in the SPK list the SPK list The units microphone is turned on Chairman unit micro off The units microphone is turned off Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wUnitId BOOLEAN bMicroOn MM T MICRO ONOFF where wUnitld Unit Identifier Unit identifiers can be retrieved from the system using the remote functions for System Config SRS_SCSIINF bMicroOn TRUE to turn the microphone on FALSE to turn the microphone off Response structure from the function The function h
37. ly speakers in the list with their microphone on the first unit in the list will be turned off and removed from the list Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 12 When the microphone operation mode equals MM C OPERATOR WITH COMMENT LIST and the maximum number of active microphones is increased to more than 1 an error is returned Parameter structure for the function The function requires the following structure as parameter WORD wActiveMics where wActiveMics The number of active microphones which can be on at the same time Valid values are in the range 1 4 Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E ILLEGAL MAX ACT MICS Update notifications MM C SET ACTIVE MICS ON PC and various SPK CS RTS and or CR updates depending on the change in size of the speakers list length 3 2 7 C GET SETTINGS Purpose Retrieve the general settings from the MM application This function can be used to get the initial state of the operation mode and the number of active microphones as set using the button on the front panel of the CCU Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure typedef struct WORD wOperationMode WORD wActiveMics WORD wMaxRTSListLen BOOLEAN
38. me structure received by the function MM C RTS GET must be transmitted by this function Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE MM E RTS LIST TOO BIG MM E UNKNOWN UNITID AND DELID MM E INSERT RTS LIST FAILED MM E UNITID DELID MISMATCH Update notifications MM C RTS SET ON PC Related functions MM C RTS GET 3 6 6 MM C SHIFT Purpose Perform a shift function i e promote a delegate from the RTS list to the Speakers list The shift differs from other RTS list or Speakers list functions in such a way that the promoted delegate is always added to the speakers list whether this list is full or not Besides the CS list and CR list if present are also cleared This includes the following steps 1 Clear the CR list and the CS list if the mode is MM C OPERATOR WITH COMMENT LIST 2 Remove the indicated RTS entry from the RTS list When the indicated entry does not exist in the RTS list then the removal is skipped and the entry provided will be used Note that the latter also holds when the operation mode is MM C DELEGATE WITH OVERRIDE see also 3 2 5 3 Look if there is a entry free in the SPK list If not then a free entry will be created using on of the following rules e f there are SPK entries with their microphone off then first of these will be removed e When there are only SPK entries with their microphone on the first unit in the lis
39. n of the remote function was successful MM E OPEN CLOSE FAILED 5 The internal database on the CCU was not able to update the total use count for the MM application MM E UNIT ALREADY PRESENT 6 The unit to be added to the list RTS or SPK is already present in that list MM E NOT PRESENT 8 The record to search for in the list Comment Request is not present in the list MM E UNIT NOT PRESENT 9 The unit to search for in the list RTS or SPK is not present in the list MM E NOT IN SPL OR NOB 15 You tried to turn off a microphone of a unit which was not present in either the speakers list or the notebook list MM E ILLEGAL MAX ACT MICS 17 The number provided for the maximum number of active microphones is illegal with respect to the current Operation Mode Valid value for the mode MM C OPERATOR WITH COMMENT LIST is 1 Valid values for the mode MM C DELEGATE WITH VOICE are within the range 2 4 and for all other modes in the range 1 4 MM E ILLEGAL MIC OPER MODE 18 The function requested is illegal for the current operation mode The function is not executed MM E UNKNOWN UNITID AND DELID 19 You have provided a RTS list entry with both elements Unitld and Delegateld set to empty values DBSC EMPTY UNIT DBSC EMPTY DELEGATE At least one of the elements must be defined to fulfil the function MM E DELETE RTS LIST FAILED 21 A delete of a RTS list entry in the internal database failed Probably illegal values for either the element
40. ng of the speech timer Notify structure with this update The update does not have any additional parameters Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 34 APPENDIX A VALUES OF THE DEFINES In this document a lot of definitions are given which have values connected to them In this appendix all defines will be connected to their values The values are presented in C syntax define MKWORD 1b hb WORD WORD hb lt lt 8 WORD 1b define DCNC_APP_MM 0 define C MICRO ON OFF MKWORD 1 DCNC APP MM define MM C CHAIR 5 ON MKWORD 2 DCNC APP MM define MM C TIMER ON OFF MKWORD 3 DCNC APP MM define MM C RTS SET ON PC MKWORD 4 DCNC APP MM define C RTS CLEAR PC MKWORD 5 DCNC APP MM define RTS REMOVE ON PC MKWORD 6 DCNC APP MM define C 5 INSERT ON PC MKWORD 7 DCNC APP MM define MM C RTS REPLACE ON PC MKWORD 8 DCNC APP MM define MM C NBK SET ON PC MKWORD 9 DCNC APP MM define C NBK CLEAR ON PC MKWORD 10 DCNC APP MM define C NBK REMOVE ON PC MKWORD 11 DCNC APP MM define MM C SPK SET ON PC MKWORD 12 DCNC APP MM define C SPK CLEAR ON PC MKWORD 13 DCNC APP
41. nnn intrent 31 4 6 MM Request to Speak list notifications essssssssssssesseeerennee ene 31 4 6 1 C RTS SET 0 242 44 0000 0 000000000 000013 1000000 inns essen nnne 31 4 6 2 C RTS CLEAR 2 2 4 2 4 00 1000000 inns tr ns sn tene enne iners inten en 31 4 6 5 C RTS REMOVE ON 22 22 2 4 2 00 4 22 0000000000 senses enr sntrtr innen nensis nennen 32 4 6 8 C RTS FIRST ON PO sessi tnnren nennen inttr sette innen tenn en 32 4 6 5 C RTS INSERT ON nri nnns intense nnne nns nnne 32 466 C RTS REPLACE ON 02 2 22 2 4 400 1 00 0000 000 nnne en nennen innen nennen 32 4 7 MM Comment Request list notifications ssssssssseeseseneneneeen nennen nenne 33 4 7 4 MM C CR CLEAR 33 472 MM C CR ADD 280410 1 0000000000010000 ensi nnns estet enne nnns nnn nene 33 473 MM C CR REMOVE ON PO eene 33 474 C CR ON 33 4 8 MM Speechtime notifications eene eene enne nnne nnns 33 4 81 C TIMER ON 33 Appendix A Values of the 34 Appendix B Error CodeS s 2 oie od RE 36 Appendix Exam
42. not in the system the unit of the delegate is unknown For manipulation of the RTS list a special structure is used to identify a RTS list entry The structure is defined as follows typedef struct WORD wUnitId WORD wDelegateld MM_T_RTS where wUnitld Unit Identifier Must be unique in the RTS list wDelegateld Delegate Identifier May also have the value DBSC_EMPTY_DELEGATE when the delegate is unknown Delegate identifiers can be set in the system using the remote functions for System Config SRS_SCSIINF When a RTS list entry is passed with one of the RTS functions the CCU tries to complete the RTS information passed This means that when only the wUnitld is provided the CCU will search the correct delegate and when only the wDelegateld is provided the CCU will search for the correct unit Assumed is that not provided elements are filled with the according DBSC EMPTY UNIT or DBSC EMPTY DELEGATE value When both elements of the structure have empty values or the unit and the delegate contradict each other all functions except MM C SHIFT see section 3 6 6 generate an error MM E UNKNOWN UNITID AND DELID or MM E UNITID DELID MISMATCH 3 6 1 C RTS APPEND Purpose Add a delegate unit combination to the RTS list on the CCU Parameter structure for the function This function requires the structure MM T RTS as parameter This structure is defined in section 3 6 Response structure from the function The f
43. nt speakers list The structure is defined in section 3 3 2 4 5 MM Notebook list notifications The Microphone Management notebook notifications report the remote controller the changes in the NBK list 4 51 REMOVE ON purpose Notifies the remote controller that a notebook unit is removed from the NBK list Notify structure with this update The update comes with the following structure typedef struct WORD wUnitId WORD wMicroType MM T where wUnitld Unit identifier wMicroType The type of microphone handling for the notebook entry as defined in 3 5 3 4 5 2 MM NBK SET ON PC purpose Notifies the remote controller that the CCU has a complete new notebook list Note that all chairmen units will be included inside the notebook list Notify structure with this update The update comes with the structure defined as response structure in section 3 5 3 4 6 MM Request to Speak list notifications The Microphone Management request to speak notifications report the remote controller the changes in the RTS list 4 6 1 MM C RTS SET ON PC Purpose Notifies the remote controller that the CCU has a complete new list of request to speak delegates units Note that this notification implies a change of the first RTS entry in the list Notify structure with this update The update comes with the structure defined in 3 6 4 4 6 2 RTS CLEAR ON PC Purpose Notifies the remote controller that th
44. o disable the cancel of an request e enables all RTS functions notifications e enables all SPK functions notifications e disables all CR functions notifications e disables all CS functions notifications Override mode In this mode there is no RTS list Whenever a delegate presses his micro button he is directly able to speak When the SPK list was full then the oldest speaker will be removed to make place for the new delegate e disables all RTS functions notifications e enables all SPK functions notifications e disables all CR functions notifications e disables all CS functions notifications Voice mode The CCU automatic focus on the delegate currently speaking In this mode there is no RTS list and SPK list Also none of the chairmen microphones will be notified disables all RTS functions notifications disables all SPK functions notifications disables all CR functions notifications disables all CS functions notifications disables all microphone on off functions Comment mode The operator using the remote controller controls the RTS and CR lists Delegates are always added to the RTS list for normal requests and to the CR list for responses The operator determines which delegate may speak and or make a response In this mode the maximum number of active microphones must be set to 1 Special features are to disable the cancel of an request and to turn off the microphone by the delegates see section 3 2 7 e enables all RT
45. ples ait pipe t e e Lg i e Gena 38 C 1 Microphone Management Control sssssssssssssssssseeene enne enne entere ensis nennen nes 38 Bosch Security Systems B V 2003 December MM Remote Interface Description en 4 1 Introduction 1 1 Purpose The purpose of this document is to describe the remote interface for microphone management between the CCU and third party software 1 2 Scope This document describes the remote interface for microphone management It is meant for developers who want to use this remote interface to control the microphone management application present in the CCU remotely The Interface can be used to build a Microphone Management User interface or a Synoptic Microphone User interface For a complete description of the System Set up can be referred to SRS_INF 1 3 Definitions Acronyms and Abbreviations CCU Central Control Unit This can be either a single CCU system or a Multi CCU system ACN Audio Communication Network DCN Digital Congress Network MM Microphone Management SC System Configuration Sl System Installation RTS list Request To Speak list SPK list Speakers list NBK list Notebook list list of chairmen and special assigned delegates CR list Comment Request list An extra type of request to speak list to offer delegates the possibility to request for a comment on the current speaker On the units and on the Control PC a comment is indicated as Re
46. ration mode Parameter structure for the function The function requires the following structure as parameter WORD wOperationMode where wOperationMode The operation mode of the MM application which is one of the following MM C OPERATOR WITH REQ LIST MM C DELEGATE WITH REQ LIST MM C DELEGATE WITH OVERRIDE MM C DELEGATE WITH VOICE MM C OPERATOR WITH COMMENT LIST If the operation mode is set to MM C OPERATOR WITH COMMENT LIST the maximum number of active microphones will be set to 1 if not done by the operator Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE unknown mode selected Update notifications MM C SET MIC OPER MODE ON PC and various SPK CS RTS and or CR updates depending on the difference between the old and new mode set 3 2 6 C SET ACTIVE MICS Purpose This function allows the remote controller to change the maximum number of active microphones SPK list length When the number of active microphones is increased the created empty places will be filled with entries coming from the RTS list if the selected mode equals MM C DELEGATE WITH REQ LIST When the number of active microphones is reduced the following rules are applied if the number of speakers in the SPK list is greater than the final size e If there are speakers in the list with their microphone off then first of these will be removed e When there are on
47. re typedef struct WORD wNrOfSpk MM T SPK MICRO tSpkList DBSC MAX SPEAKERLIST MM T CCU SPKLISI Where the MM T SPK MICRO is defined as typedef struct WORD wUnitId BOOLEAN bMicroOn MM T SPK MICRO where wNrOfSpk The number of SPK list entries actual present in the tSpkList array Only this amount of array elements are transmitted This value never exceeds the constant Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 16 DBSC_MAX_SPEAKERLIST tSpkList Array holding the SPK list information Each array element is defined as a MM T SPK MICRO structure which is defined below wUnitld Unit identifier bMicroOn TRUE if the microphone is currently on FALSE if the microphone is currently off Error codes returned MM E NOERROR Related functions MM C SPK APPEND 3 4 MM Comment Speaker list functions This section describes the functions to manipulate the comment speakers list Note that a Comment Speaker can only be generated by shifting a Comment Request using the MM C SHIFT CR function see also section 3 7 3 3 4 1 C CS REMOVE Purpose Removes a speaker from the CS list on the CCU A removal of a unit from the CS list automatically implies that the units microphone will be turned off Parameter structure for the function This function requires the structure MM T SPK as parameter This structure is defined in section 3 3 2 Respons
48. s Unitld or Delegateld are passed MM E INSERT RTS LIST FAILED 22 The CCU was not able to insert the RTS list entry into the internal database Probably illegal values for either the elements Unitld or Delegateld are passed MM E RTS LIST FULL 24 The RTS list is full No more RTS entries can be added using the function MM C RTS APPEND MM E RTS LIST CHANGED 25 During a reduction of the maximum length of the RTS list the database was unable to retrieve the last RTS list entry The actual length is not changed To recover this error clear the RTS list set the new RTS list length and set the new contents in the RTS list MM E RTS LIST EMPTY 26 The RTS list is empty therefore the function cannot be fulfilled e g Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 37 Microphone Management Error code Value Explanation remove on a RTS list entry on an empty RTS list MM_E_ILLEGAL_MAX_RTS_LIST_LEN 27 The maximum length provided for the RTS list is out of range Valid values for the RTS list length are within the range 0 100 MM E RTS LIST TOO BIG 28 The RTS list provided is too big to store it None of the RTS entries provided is put into the RTS list and the old RTS list remains active MM E DELETE SPEAKERS LIST FAILED 31 A delete of a SPK list entry in the internal database failed Probably an illegal value for the element Unitld is passed MM E INSERT SPEA
49. s shifted the microphone of the current speaker in the SPK list is switched off and the current speaker in the CS list if present is removed to make place for the shifted CR entry Parameter structure for the function The function requires the structure MM RTS as parameter This structure is defined in section 3 6 Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E NOT PRESENT MM E UNIT NOT CONNECTED MM E ILLEGAL MIC OPER MODE MM E UNITID DELID MISMATCH MM E UNKNOWN UNITID AND DELID Update notifications MM C CR REMOVE ON PC MM CS REMOVE ON PC MM C CS APPEND ON PC 3 8 MM Speechtime functions This section describes the functions to manipulate the speechtime There is no synchronisation between different controllers e g Remote Control and Control PC The last controller which is used is the active one It is the responsibility of the controller to invoke the different functions when necessary The CCU won t do this for you The controller should check the speechtime for each individual speaker and invoke the relevant speechtime function Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 24 3 81 C SET SPEECHTIME SETTINGS Purpose This function stores the speechtime settings in the CCU Parameter structure for the function This function requires the following structure as parameter
50. se structure from the function The function has no response parameters Error codes returned MM E NOERROR Update notifications MM C RTS CLEAR ON PC MM C RTS CLEAR COMMENT ON PC Related functions MM C RTS APPEND MM C RTS REMOVE 3 6 4 RTS Purpose Retrieve the complete contents of the Request To Speak list as present in the CCU Parameter structure for the function The function has no additional parameters Bosch Security Systems B V 2003 December MM Remote Interface Description en 21 Response structure from the function The function returns the following structure typedef struct WORD wNrOfRts MM T RTStRtsList DBSC MAX DELRTS MM CCU RTSLIST where wNrOfRts The number of RTS list entries actual present in the tRtsList array Only this amount of array elements are transmitted This value never exceeds the constant DBSC MAX DELRTS tRitsList Array holding the RTS list information Each array element is defined as a MM T RTS structure which is defined in section 3 6 Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE Related functions MM C RTS SET 3 6 5 MM C RTS SET Purpose Set a new RTS list on the CCU The current RTS list will be cleared and the provided RTS list will be made current Parameter structure for the function The function needs as parameter a list of RTS entries as defined as response structure by the function MM C RTS GET section 3 6 4 The sa
51. sponse CS list Comment Speakers list An extra type of speakers list in which delegates can be placed to make a comment on the current speaker Unitld Unit identification also called unit number A unique identification of a unit within the CCU system PC Personal Computer remote controller Device e g PC connected to the CCU which remotely controls a part of the applications present in the CCU 1 4 References SRS_INF General Remote Interface Description SRS_SCSIINF SC amp SI Remote Interface Description USERDOC MM User Manual LBB 3570 USERDOC SM User Manual LBB 3571 This document should be referenced as 585 MMINF 1 5 Overview Chapter 2 describes the Microphone Management Remote Interface in general Chapter 3 and chapter 4 describe respectively the remote functions and the update notifications which can be used to control the microphones of the units connected to the CCU Appendix Appendix A gives an overview of the constants used in combination with the remote functions described in this document Appendix Appendix B gives an overview of the possible error s which could be returned upon a remote function Appendix Appendix C gives an example on using the remote interface for Microphone Management Bosch Security Systems B V 2003 December MM Remote Interface Description en 5 2 Microphone management for a Remote interface 2 1 Introduction The Microphone Management Remote Interface is part o
52. structure with this update The update does not have any additional parameters 4 3 5 MM C SPK APPEND ON PC Purpose Notifies the remote controller that a unit is added to the SPK list Notify structure with this update The update comes with the following structure T SPK tSpkAdd where tSpkAdd The speaker who is added to the speakers list The structure MM SPKis defined in section 3 3 2 Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 30 4 3 6 C SPK REMOVE ON Purpose Notifies the remote controller that a unit is removed from the SPK list including turning off the microphone Notify structure with this update The update comes with the following structure MM T SPK tSpkRemove where tSpkHemove The speaker who is removed from the speakers list The structure MM T SPK is defined in section 3 3 2 4 3 7 C SPK INSERT Purpose Notifies the remote controller that a speaker is inserted before another speaker Notify structure with this update The update comes with the following structure typedef struct MM_T_SPK tSearchSpk MM_T_SPK tNewSpk MM_T_SPK_INSERT where tSearchSpk The speaker entry to search for The new Speaker entry tNewSpk shall be inserted before this Speaker tNewSpk The Speaker entry to be added to the list 4 3 8 MM C SPK REPLACE PC Purpose Notifies the remote controller
53. t will be turned off and removed from the list 4 Create from the RTS entry a SPK entry and add this to the SPK list Bosch Security Systems B V 2003 December MM Remote Interface Description 22 Parameter structure for the function The function requires the structure MM_T_RTS as parameter This structure is defined in section 3 6 Normally the provided RTS list entry defines which delegate unit combination is candidate to shift to the speakers list When the provided RTS is filled with empty values wUnitld DBSC_EMPTY_UNIT and wDelegateld DBSC_EMPTY_DELEGATE the first RTS entry present in the RTS list is used If there are no RTS entries present or when the operation mode is MM_C_DELEGATE_WITH_OVERRIDE nothing happens Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E UNIT NOT CONNECTED MM E ILLEGAL MIC OPER MODE MM E RTS LIST EMPTY MM E UNITID DELID MISMATCH MM E UNKNOWN UNITID AND DELID Update notifications MM C CR CLEAR ON PC MM C CS CLEAR ON PC MM C SPK REMOVE ON PC MM C RTS REMOVE ON PC MM C SPK APPEND ON PC MM C RTS FIRST ON PC 3 7 MM Comment Request list functions This section describes the functions to manipulate the CR list The Comment Request list is a list of delegates with their unit identifications which are waiting to get speech time to respond to the current speaker This comment request list is to prevent the delegate
54. tems e Purpose A global description of the purpose of the function Parameter structure for the function The input parameters needed to fulfil the function When the function requires no parameters no structure is described here The type definitions of the basic types used to build up the input parameter structure are given 585 INF e Response structure from the function The output information coming from the function called This information is only valid when the wError field of the received response information equals MM E NOERROR e Error codes returned The possible error values returned in the wError field of the response information for this remote function All different error codes are described in appendix Appendix B e Update notifications The update notifications which are generated during the execution of the remote function When there are no notifications generated then this part will be omitted e Related functions The related function in conjunction with the function described It refers to other remote functions and to related update notifications 3 2 MM General functions 3 21 MM C START MM Purpose Indicates the CCU that the remote controller wants updates notifications from the MM application inside the CCU After receiving this function the CCU increments the update use count As long as the update use count is greater than zero the CCU will sent update notifications to the remote controller Update notif
55. tion MM Remote Interface Description 15 Update notifications MM_C_SPK_APPEND_ON_PC Related functions MM_C_SPK_REMOVE 3 3 3 SPK REMOVE Purpose Removes a speaker from the SPK list on the CCU A removal of a unit from the SPK list automatically implies that the units microphone will be turned off Parameter structure for the function This function requires the structure MM_T_SPK as parameter This structure is defined in section 3 3 2 Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE MM E UNIT NOT PRESENT MM E DELETE SPEAKERS LIST FAILED Update notifications MM C SPK REMOVE ON PC Related functions MM C SPK APPEND 3 3 4 SPK CLEAR Purpose Clear all entries in the SPK list on the CCU All delegate microphones are turned off The chairmen microphones remains in the same state Parameter structure for the function The function has no additional parameters Response structure from the function The function has no response parameters Error codes returned MM E NOERROR Update notifications MM C SPK CLEAR ON PC Related functions MM C SPK APPEND 3 3 5 MM C SPK GET Purpose Retrieve the complete contents of the Speakers list as present in the CCU Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structu
56. tructure with this update The update comes along with the following structure typedef struct MM T RTS tSearchRts MM T RTS tNewRts MM T RTS INSERT where tSearchRts The RTS entry to search for The new RTS entry tNewRts shall be inserted before this RTS entry When the elements of the entry are filled with empty values then the entry tNewRts will be added to the end of the list tNewRts The RTS entry to be added to the list Note that an append of the new RTS entry will be done when the elements of this parameter are filled with empty values like tSearchRts wUnitId DBSC EMPTY UNIT tSearchRts wDelegateld DBSC EMPTY DELEGATE 4 6 6 MM C RTS REPLACE ON PC Purpose Notifies the remote controller that a delegate unit combination is replaced by a new RTS entry Notify structure with this update The update comes along with the following structure typedef struct MM T RTS tCurrRts MM T RTS tNewRts MM T RTS REPLACE where tCurrRts The RTS entry to search for This RTS entry is replaced by the new value given in the parameter tNewRts tNewRts The RTS entry holding the new contents Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 33 4 7 MM Comment Request list notifications The Microphone Management Comment Request notifications report the remote controller the changes in the CR list 471
57. turned MM E NOERROR MM E DELETE NOTEBOOK FAILED Update notifications MM C NBK REMOVE ON PC Related Functions MM C NBK SET MM C NBK GET 3 5 2 MM C NBK CLEAR Purpose Clear the complete contents of the Notebook list Parameter structure for the function The function has no additional parameters Response structure from the function The function has no response parameters Error codes returned MM E NOERROR Update notifications MM C NBK SET ON PC Related Functions MM C NBK SET 3 5 3 MM C GET Purpose Retrieve the complete contents of the Notebook list as present in the CCU Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure typedef struct WORD wNrOfNbk MM T NBK MICRO tNbkList DBSC MAX NOTEBOOKLIST MM T CCU NBKMICROLIST Where the MM T NBK MICRO is defined as typedef struct WORD wUnitId WORD wMicroType BOOLEAN bMicroOn MM T NBK MICRO where WNrOfNbk The number of NBK list entries actual present in the tNbkList array Only this amount of array elements are transmitted This value never exceeds the constant DBSC MAX NOTEBOOKLIST tNbkList Array holding the NBK list information Each array element is defined as a MM T MICRO structure which is defined Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 18
58. unction has no response parameters Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 20 Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE MM E UNKNOWN UNITID AND DELID MM E UNIT ALREADY PRESENT MM E UNIT NOT CONNECTED MM E UNITID DELID MISMATCH MM E RTS LIST FULL Update notifications MM C RTS INSERT ON PC MM C RTS FIRST ON PC if appended delegate becomes the first in the list Related functions MM C RTS REMOVE MM C RTS CLEAR 3 6 2 C RTS REMOVE Purpose Remove one delegate unit combination from the RTS list on the CCU Parameter structure for the function This functions requires the structure MM T RTS as parameter This structure is defined in section 3 6 Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE MM E RTS LIST EMPTY MM E UNKNOWN UNITID AND DELID MM E UNIT NOT PRESENT MM E UNITID DELID MISMATCH Update notifications MM C RTS REMOVE ON PC MM C RTS FIRST ON PC if removed delegate was the first in the list Related functions MM C RTS APPEND MM C RTS CLEAR 3 6 3 MM C RTS CLEAR Purpose Clear all pending requests in the system This includes clearing all entries in the RTS list and clearing all entries in the CR list if present Parameter structure for the function The function has no additional parameters Respon
59. vents and Update Notifications is given in section 4 1 2 At last there is a relation between remote functions sent by the DCN control PC and update notifications Since both remote controller and DCN control PC receive all update notifications the set of update notifications therefor also contains those that are the result of a remote function from the DCN control PC 2 3 Microphone List and Mode Management Handling the microphones in the system is basically a way of managing the various microphone lists identified inside the CCU and choosing the appropriate operation mode The Microphone Management application has five microphone lists which will be explained in the table below Notebook The notebook contains units having special privileges for turning on their microphone This list always contains the Chairman units in the system Other units can only be added to the notebook from within the MM application on a DCN Control PC The notebook exists in all operation modes Speakers list The speakers list contains the normal delegate units that are currently allowed to speak Note that this does not mean that those units have Bosch Security Systems B V 2003 December MM Remote Interface Description MM Remote Interface Description en 6 their microphone switched on Depending on the operation mode it is possible that a unit is in the speakers list with its microphone switched off The speakers list exists in all operation mod
60. w the operation modes are identified by the value used in the remaining part of this document This table also describes the enabling disabling of sets of remote functions and update notifications as result of choosing a specific operation mode Bosch Security Systems B V 2003 December MM Remote Interface Description en 7 Mod Mode description amp Group enable disable OPERATOR WITH REQUEST LIST equals MM C OPERATOR WITH REQ LIST DELEGATE WITH REQUEST LIST equals MM C DELEGATE WITH REQ LIST DELEGATE WITH OVERRIDE equals MM C DELEGATE WITH OVERRIDE DELEGATE WITH VOICE ACTIVATION equals MM C DELEGATE WITH VOICE OPERATOR WITH REQUEST AND RESPONSE LIST equals MM C OPERATOR WITH COMMENT LIST Manual mode The operator using the remote controller controls the RTS list Delegates are always added to the RTS list and the operator determines which delegate may speak Special features are to disable the cancel of an request and to turn off the microphone by the delegates see section 3 2 7 e enables all RTS functions notifications e enables all SPK functions notifications e disables all CR functions notifications e disables all CS functions notifications Open delegate mode All functions can be done by either the operator or the delegates When a delegate turns his microphone off and there are still delegates present in the RTS list then an automatic shift will take place Special features are t
61. y element is defined as a MM_T_RTS structure which is defined in section 3 6 Error codes returned MM E NOERROR MM E ILLEGAL MIC OPER MODE Related functions MM C RTS CLEAR COMMENT 3 7 3 MM SHIFT CR Purpose Perform a shift function on the CR list i e promote a delegate from the CR list to the CS list The shift differs from other Comment Request list or Speakers list functions in such a way that the promoted delegate is always added to the comment speakers list whether this list is full or not Besides of all units present in the SPK list the microphones will be turned off This includes the following steps 1 Remove the indicated Comment Request entry from the CR list When the indicated entry does not exist in the CR list an error is returned 2 Turn off the microphones off all entries in the SPK list 3 Look if there is a entry free in the CS list If not then a free entry will be created by removing the first unit in the CS list 4 Create from the Comment Request entry a SPK entry and add this to the CS list If however the delegate was already present in the normal speakers list then the Comment Request entry is removed from the CR list and the microphone of the entry in the SPK list is switched on again Note Currently the operation mode MM C OPERATOR WITH COMMENT LIST is only allowed with a maximum number of active speakers of 1 Also the CS list has currently a maximum length of 1 This means that when a comment request i

Download Pdf Manuals

Related Search

Related Contents

    Cisco Aironet 3500 Series Lightweight Access Point  Agrodok-43-Recolha de água da chuva para uso doméstico  取扱説明書  

Copyright © All rights reserved. Failed to retrieve file