Home

Installation Manual - Bosch Security Systems

1. se rid 103 0 91 INTOCUCUON vie oe u L pee Teen eee ten dro au ayasa das ai ye dang aep Ere en 103 6 3 1 1 Update notification item 103 6 3 1 2 Unit user event relations eese 104 6 3 2 CC General notifications nore e eet e etr t ere e p E liue 104 6 3 2 4 CCC BEGEIVE DATA LI I L dies dte a ciae a asya ias 104 Simultaneous Interpretation J J 105 Wa iloa S ui 105 7 1 1 Remote Simultaneous Interpretation Control sse 105 REMOTE FUNCUONS u u Em 105 re A cL ER 105 7 2 2 Remote function item explanation 2 105 Bosch Security Systems 2014 July 7 2 3 IN General functio NS neci ip Teac ipe 106 7 2 8 4 IN G SIGNAL GGU S pude he Le ERE i ea tiene 106 F202 IN C START IN AAPP a nnt tette tr ete ee e aede 107 7200 0 IN C STOP N AP P e r ettet ete 108 7 2 3 4 IN C START 2 108 7 2 3 5 INC STOP MON IN ie ttt REIHE eR DE a 109 Z 2 9 6 N 5O IDESK DPDATE tino E OR 109 7 2 3 TING BOOTHS UPDATE AEA ies 110 7 2 3 8 IN 3C UPDATE LOGK L u ree dr iad 111 7 2 3 9 IN
2. eene 164 10 3 2 1 LD SEND ANUM DATA eaa aa anaana aa aaa sen aaa nnn entren neni 164 11 Message Distribution for a Remote interface U u 165 ene 165 11 1 1 Remote Message Distribution 165 14 2 Bemote EUurnctloris 165 11 271 Introduction irent uet EG nee te Hec rv iaa eene Pu aX RU 165 11 2 1 1 Remote function item 165 Bosch Security Systems 2014 July 11 2 2 Message Distribution functions U 166 11 2 2 1 MD START 166 11 2 2 2 MD C STOP MON MD eere nete e 166 11 2 2 3 MD C SEND MESSAGE TO UNITS seen 167 11 2 2 4 MD CLEAR MESSAGE ON UNITS eee 168 11 2 2 5 MD AUX LED CONTROL sess nene 168 11 3 Update Notifications eene Enna se PR MEER asawa sata 169 Iireesteicm DEL 169 11 3 1 1 Update notification item explanation sene 169 11 3 1 2 Unit user event 169 11 3 2 MD General NotiflCationS uu u uu Lun De ete ttai ete aed 170 11 3 2 1 MD REQ BUTTON 170 12 Intercom for a Remote interface
3. 34 3 4 1 2 Unit user event relations 34 3 4 2 SG C CCU IREBOOQT uuu e edet eec mue ee pe Pec asuy 37 2 4 3 SCG C CONNEGT UNIT aoi En RAE E bawat ees 37 3 4 4 SC_C_DISCONNECT_UNIT 37 3 4 5 SC CONNECT SLAVE uuu uuu akaqa sasay qapas 37 3 4 6 5 DISCONNECT CCOU enne 38 3 4 7 SC MODE CHANQE u u u N ua ua treten reser sinn innere innen 38 2 48 SG C SERIAL NR eret nta atten eben a E Ee 39 3 449 SG C BATTERY STATUS 39 3 4 10 5 C BATTERY INFO 5 39 3 4 11 5 C BATTERY INFO COND sss inrer nens tne Kean i ade 40 3 4 12 SC SIGNAL STATUS yu u Gu a nnns enne nennen 40 3 4 13 SC SIGNAL QUALITY J n a u uQ ua enne neret 41 3 4 14 5 UNIT SIGNAL QUALITY 41 3 4 15 SC C CLOW BATTERY ipte d gc ded epe picea 41 3 4 16 SC C ENCRYPTION ENABLED trennen 41 3 5 System Installation SI functions sse eene Qina nnne enn 42 3 5 1 Introguctionz i ii teh 42 3 5 2 SL C START INSTALE A
4. 144 9 1 1 4 Combination Attendance and 144 9 1 2 Functioning with parameters U eene nennen nnne 144 9 1 2 1 State definitions uu Uu terr Ee eue Ern 144 9 1 2 2 Events definitions ruant en 145 9 1 2 3 Parameter definitions 145 9 1 2 4 Event state eui u a bae me Lee 145 9 2 Remote FUnctlons et ett en reste ter 150 92 1 Introduction reet Pt ER EPA ERE kanaq 150 9 2 1 1 Remote function item 150 9 2 2 Attendance Access functions l U nnne 150 9 2 2 START AT APB 150 9 2 2 2 5 AT 1 en dete 151 9 2 2 3 AT STORE SETTING hiirega entren sinn nannte enne 151 9 2 2 4 AT_ G ACTIVATE ers ate ae 152 9 2 2 5 AT C HANDLE 153 9 2 2 6 AT GET INDIV 5 154 9 3 Update Notifications eto Hee De 156 Te IMMOGUCUION eere Ml EI DEI 156 9 3 al Precornaditlotis s cui eo TREE UDINE 156 9 3 1 2 Notification
5. ON PC MM C SET MIC OPER MODE ON PC MKWORD 13 APP MM MKWORD 14 DCNC APP MM MKWORD 15 DCNC APP MM MKWORD 16 APP MM MKWORD 17 APP MM C SET ACTIVE MICS ON PC MKWORD 19 DCNC APP MM MM C FIRST ON PC MM C SET SETTINGS ON PC Bosch Security Systems 2014 July MKWORD 20 DCNC APP MM MKWORD 21 APP MM MKWORD 18 DCN C APP MM en 185 DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine MM C CR CLEAR ON PC MKWORD 22 DCNC APP MM MM C CR ADD ON PC MKWORD 23 DCNC APP MM MM C CR REMOVE ON PC MKWORD 24 DCNC APP MM MM C CR REPLACE ON PC MKWORD 25 DCNC APP MM MM C CS CLEAR ON PC MKWORD 26 DCNC APP MM MM C CS ADD ON PC MKWORD 27 DCNC APP MM MM C CS REMOVE ON PC MKWORD 28 DCNC APP MM MM C START MM MKWORD 30 DCNC APP MM MM C STOP MM MKWORD 31 DCNC APP MM MM C GET SETTINGS 32 DCNC APP MM MM C SET SETTINGS MKWORD 33 DCNC APP MM MM C SET MICRO ON OFF MKWORD 34 DCNC APP MM MM C SHIFT MKWORD 35 DCNC APP MM MM C RTS SET MKWORD 36 DC
6. 52 3 5 7 SI SET WIRELESS SETTINGS ii esiis iniii eia ieia iiaiai iiai 52 3 5 8 51 GET NETWORK MODE L m heini 53 3 5 9 S CSET NETWORK MODE ertt senec deter e HER ep egere 53 3 5 10 SI G START MON Slu rtt te et PE edge 54 3 54 MON attain canes seg 54 3 6 System Installation SI notifications 54 SO IMMOGUCTION M ME CE 54 3 6 1 1 Unit user event 54 3 6 2 SI G REGISTER UNIT e baee dep creen LEE tt eee es 55 3 6 3 SI MICROPHONE GAIN ssssssssssseseeeneeennenee nennen 55 3 6 4 SI C MICROPHONE GAIN _ 56 3 05 SI C WAP SETTINGS dete tme titre et tear ib db 56 3 6 6 SI C WIRELESS SETTINGS asap asia 56 3 6 7 SI C_NETWORK_MODE enne nri 57 4 Delegate rcr 58 C Introdletlons a a tette tette 58 4 2 Remote F nctlons oe Aimee rete tud 58 4 2 1 0 6 5 _ Maa daa dee He Hte dodo etia a 58 4 2 2 DB G ST P gt SAPPu ise eite rettet eite frei o tenait q usa u 58 4 2 3 DB C e nt tete utendi eta tiere bee daten 59 Bosch Security Systems 2014 Jul
7. such that wFillLevel and the tDisconnectedUnits array do inform the remote controller about units being disconnected together with this Slave CCU This implies that the units listed in the tDisconnectedUnits do not notify themselves as disconnected with DISCONNECT UNIT 3 4 7 SC C CCU MODE CHANGE Purpose Notifies the remote controller that the CCU changed its operation mode For more information about the different modes see 3 3 4 Notify structure with this update typedef struct WORD wCur rentMode WORD wNewMode SC T CCU MODE CHANGE where wCurrentMode The current CCU system mode so before the mode change Possible system mode values are defined in the bySystemMode field of the structure used within the Bosch Security Systems 2014 July 39 function SC C VERSIONINFO see section 3 3 4 wNewMode The new CCU system mode so after the mode change 3 4 8 SC C SERIAL NR Purpose Notifies the remote controller about the serial number of the unit This notification is send in response to SC C REQ SERIAL NR Notify structure with this update The update comes with the following structure struct UNITID tUnitId DWORD dwSer ialNr where tUnitld The unit identifier of a unit dwSerialNr Serial number of the unit Some units do not have actual serial numbers In that case the numbers are generated according to the current situation If this changes i e
8. VT C 100 AUTHORISED VOTES The number of Present delegates is equal to the number of delegates who have voting authorization The number of Not Bosch Security Systems 2014 July Voted delegates is equal to the number of Present delegates as long as nobody casts a vote When a delegate s functionality for voting is not authorized he will not be counted for the vote round VT C 100 PRESENT KEY AND FRAUD All delegates have to press both the present key and the fraud switch at the same time before actually casting a vote Only delegates that pressed both keys will count VT C 100 EXTERNAL PRESENT All delegates have to activate the external present contact before actually casting a vote Only delegates that activated the external present contact will count Note that this functionality of wPresentVotes depends on the use of the delegate database the external contact and or the attendance application see chapter 3 4 and 9 for more information Note If the Attendance application is started but nothing is activated all delegates have voting authorization Response structure from the function The function has no response parameters Error codes returned VT E NOERROR VT E VOTE RUNNING VT E NO NAMESFILE VT E WRONG PARAMETER VT E APP NOT STARTED 8 2 2 10 VT GET RESULTS Purpose This function allows the remote controller to retrieve the voting results during a vote round Parameter structure for the
9. byControlType Identify that the remote controller likes to perform actions on the database of the CCU Valid values are e DB C CONTROL The remote controller likes to have control over the database of the CCU Note that the second start of the application without a stop always results in an error Response structure from the function The function has no response parameters Error codes returned DB E NOERROR DB E INCONTROL OTHER CHANNEL DB E INCONTROL THIS CHANNEL DB E ILLEGAL CONTROL TYPE Related functions DB C STOP APP 4 2 2 DB C STOP APP Purpose Indicate the CCU that the remote controller no longer requires to access the database inside the CCU A call to this function does not clear the database The database present remains active till the CCU is restarted or accessed by the database functions after first calling DB C START APP Note that Upon communication loss this function will be activated if DB C START APP was activated Bosch Security Systems 2014 July 59 Availability This function is available in CCU system mode congress 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 DB E NOERROR DB E APP NOT STARTED DB E NOT INCONTROL Related functions DB C START APP 4 2 3 DB C MAINT Purpose The delegate database in the CCU can be chan
10. Bosch Security Systems 2014 July en 171 12 INTERCOM FOR A REMOTE INTERFACE 12 1 Introduction The Intercom Remote Interface is part of the DCN NG software which allows for another controlling entity outside the CCU not being the DCN NG Control PC to use the Intercom application 12 1 1 Remote Intercom Control Intercom is the application that allows for controlling intercom calls between delegates chairmen and interpreters during a conference It allows several types of calls to be made e From participant to operator or vice versa e Between participants via the operator or directly e From interpreter to operator or vice versa e Between interpreters via the operator or directly e From participant to interpreter or vice versa via the operator or directly More details on the complete IC application can be found in the user manual USERDOC_IC Setting up and controlling intercom calls 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 chapter 2 This chapter 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 IC can be influenced These locations are e The remote interface or remote controller using the
11. Error codes returned SI E NOERROR SI E UNIT NOT FOUND SI E INVALID UNITTYPE Related functions SI C SET MICROPHONE GAIN Bosch Security Systems 2014 July en 47 3 5 10 SI C MICROPHONE GAIN RESET Purpose Resets the microphone sensitivity of all units to the default gain setting Availability This function is available in CCU system modes config congress and maintenance Parameter structure for the function The function has no input parameters Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E NO UNITS FOUND Update notifications SI C MICROPHONE GAIN RESET 3 5 11 SI C SYSTEM ID Purpose Notifies the remote controller about the changed system ID Parameter structure for the function The function has no input parameters Response structure from the function BYTE bySystemld Update notifications SI C SYSTEM ID 3 5 12 SI DEINITIALIZE ALL Purpose Deinitializes a CCU and all the attached units Availability This function is available in CCU system modes CONFIG Parameter structure for the function The function has no input parameters Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E SYSTEM NOT READY 3 5 13 SI C GET OPERATION MODE Purpose Get the operation mode of the CCU Availability This function is available in all system mod
12. define VT C 100 PRESENT KEY 1 define VT C 100 PRESENT KEY AND FRAUD 4 Hdefine VT C 100 VALID VOTES 2 define VT C ATTENTION 1 1 define VT C ATTENTION 2 2 define VT C ATTENTION TONE 3 3 define C ATTENTION OFF 0 define VT C DOWNLOAD SUBJECT MKWORD 7 DCNC APP VD define VT C GET ATTENTION MKWORD 24 DCNC APP V define C GET RESULTS MKWORD 12 DCNC APP V define VT C HOLD VOTING MKWORD 5 DCNC APP V define VT C INT RES INDIV 2 define VT C INT RES INDIV PC ONLY 4 define C INT RES NONE 0 define VT C INT RES TOTAL 1 define VT C INT RES TOTAL PC ONLY 3 define C LED SECRET FLASH ON 2 define VT C LED SECRET ON OFF 1 Bosch Security Systems 2014 July en 218 DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine VT C LED SHOWOTE 0 VT C MAX ANSWER OPTIONS 25 VT C MAX LEN LEGEND 11 VT C MAX LEN SUBJECT 142 VT C MAX RESULT DELEGATE 2000 VT C MENU 123 5 VT C MENU ABC 6 VT C MENU AUDIENCE RESPONSE 4 VT C MENU 7 VT C MENU FOR AGAINST 3 C MENU YES NO 1 VT C MENU YES NO ABSTAIN 2 VT C MENU YES NO
13. l U 171 auge E 171 12 1 1 Remote Intercom Control nn nunana 171 12 2 Remote Fu rictioris eth a pO 171 12 21 Introdu ctioh y Qa u e cete reddet ipee kya gak etu rene Deer 171 12 2 1 1 Remote function item explanation u 171 12 2 2 Intercom fUnctlons cisci ite eri ite Bre Eee eee teer ec Bb te Gents 172 12222110207 START OIG APP uu uz uuu u sua oreet tette 172 12 2 2 2 IG CG GLOSE AIG APP rio itte deer aq ene fee td 172 12 2 2 3 1 6 CG SET LINKS Z ina it et e pr entis 173 12 2 2 4 IC_C_CLEAR_ 5 173 12 3 Update Notifications icenian iier ana EA E P 173 12 3 Introduction A spon eid ode dett eer ts 173 12 3 1 1 Update notification item 173 12 3 1 2 Unit user event relations uu EA ERE E 174 12 3 2 Intercom notifications ree tte get ene e rer 174 12 3 2 1 IC UPD AVAILABLE 5 174 12 3 2 2 IC UPD OPERATOR 5 174 12 3 2 3 UPD_CONNECTION_INFO a 175 12 3 2 4 IC UPD INCOMING CALL essent 175 Appendix A Protocol TCP IP setting U 176
14. 0x00 0x04 OxFF 1 2 3 VT C 100 PRESENT KEY AND FRAUD VT C 100 EXTERNAL PRESENT Bosch Security Systems 2014 July 5 4 en 194 DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine define def ine def ine def ine def ine define define VT_C_INT_RES_NONE 0 VT_C_INT_RES_TOTAL 1 VT_C_INT_RES_INDIV 2 VT_C_INT_RES_TOTAL_PC_ONLY 3 VT_C_INT_RES_INDIV_PC_ONLY 4 VT C MENU YES NO 1 VT C MENU YES NO ABSTAIN 2 VT C MENU FOR AGAINST 3 VT C MENU AUDIENCE RESPONSE VT C MENU 123 5 VT C MENU ABC 6 VT C MENU 7 VT C MENU YES NO ABSTAIN NPPV VT C STANDALONE VOTING 0 VT C ATTENTION OFF 0 VT C ATTENTION TONE 1 1 VT C ATTENTION TONE 2 2 VT C ATTENTION TONE 3 3 DBSC NCHAR SCREENLINE 33 DBSC MAX DELEGATE 4000 Bosch Security Systems 2014 July 4 8 en 195 DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine iidef ine def ine def ine def ine def ine def ine def ine itdef ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine AT C START AT APP 0 0901 C STOP AT APP 0x0902 AT C STORE SETTING 0 0903 AT C ACTIVATE 0 0904 AT C HANDLE IDENTIFICATION 0x0905 AT C GET
15. 2014 July The value of the update use count for the IN application at the end of the function handling It contains the number of times a remote controller has connected over the same communication medium E g the first time the IN C START MON IN function is called it contains the value 1 Note that calling 109 Error codes returned IN E NOERROR Update notifications IN C CCU CONFIG IN C CHAN STATUS IN C LANGUAGE LIST C FLASHING ON IN C SPEAKSLOWLY SIGN IN C HELP SIGN Related functions IN C STOP MON IN 7 2 3 5 IN C STOP MON IN Purpose IN C START IN APP also increases this update use count Function to stop monitoring the behavior of the Simultaneous Interpretation application Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure WORD wNrOf Instances where wNrOfinstances Error codes returned IN E NOERROR Related functions IN C START MON IN 7 2 3 6 IN C DESK UPDATE Purpose The value of the update use count for the IN application at the end of the function handling It contains the number of times a remote controller is connected over the same communication medium E g when there is only one connection registered for the IN application prior to calling the IN C STOP MON IN function the value of wNrOfInstances will be 0 when the function
16. AT E STORE SETTING FAILED 2306 0 902 Settings or a combination of settings is not correct AT E HANDLE IDENTIFICATION FAILED 2314 0 90 The eventld the ID card code and or length of PIN code are not correct to handle the requested action AT E SETTING NOT CORRECT 2315 0x90B Settings are not correct to handle the requested action AT E INCONTROL OTHER CHANNEL 2316 0 90 The AT C START AT APP function could not finish successfully because the attendance application is already controlled by another remote controller using another channel AT E INCONTROL THIS CHANNEL 2317 0 90 The attendance application is already under control by this remote controller on the same channel Probably you have called the AT C START AT APP function twice AT E INMONITOR THIS CHANNEL 2318 0 90 The attendance application is already monitored by this remote controller on the same channel Probably you have called the AT C START AT APP function twice AT E NOT INCONTROL 2319 Ox90F The remote function is not allowed because this remote controller has no control over the attendance registration application AT E CHANGE NOT ALLOWED 2321 0 911 A change of setting even if they are the same as the previous call is not allowed because attendance registration and or access control is currently active Or the setting is present contact but no external contact is configured as present contact in SI see SRS_SC
17. DCN Next Generation Open Interface Release 4 4 BOSCH en Interface Manual en 2 Table of Contents IMU OCU CEO I oe uA EE 10 1 1 PUFDOSO oreet ka m ka 10 1 2 960D0 i et etes oe ae 10 1 3 Definitions Acronyms and Abbreviations 10 14 emet pete pn ent Hp ai IEEE Us 12 2 General descrip O ae E 13 2 T1 Systemiselttlps 13 2 1 1 Use ot TGP IP pott e dee tee e Dae 13 2 172 RReQUIpermeniS u l i paqa quq eaa eve MOERS 13 2 1 3 Hardware connection 14 e re fette ine remitido te tiae afe n eun 14 2 2 Message Terma o eiie etm itii pinna eet 14 VIR Menus 14 2 2 2 DCN NG message layout sse enne ener enne 14 2 2 2 1 Format of type MDSC REMOTEPROCEDURE REQ 14 2 2 2 2 Format of type MDSC REMOTEPROCEDURE _ 15 2 2 2 3 Format of type 15 2 2 3 Ethernet message layout U U nennen ennt nnns 16 2 2 3 1 Format of type MESSAGET
18. IN C ORG LANG LIST ID original language list IN C CUS LANG LIST 1 ID custom language list 1 IN C CUS LANG LIST 2 ID custom language list 2 IN C CUS LANG LIST 3 ID custom language list 3 tLangList Array holding the actual language list information Each array element is defined as an IN T LANGLIST structure that is defined below If the version of the language list is IN C ENG LANG LIST ID or IN C FR LANG LIST ID this array will be filled with dummy values i e all language identifiers are 0 and all strings are empty If the version of the language list is IN ORG LANG LIST 10 the array can also be filled with dummy values This is the case if the version of the language list was set by an interpreter desk in its install menu in which case the predefined original language list is used In case the original language list was downloaded by a remote controller see IN C DOWNLOAD LANGLIST in 7 2 3 11 the array will contain the downloaded language list Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 enim information wAudioLangld The Identifier of the audio language szLangName Name of the audio language szLangAbbr Abbreviation of the audio language 7 3 2 6 IN C SPEAKSLOWLY SIGN Purpose Notifies the remote controller of the status of speak slowly signaling Notify structure with this update The update comes with the following structure BOOLEAN bSpeakS
19. def ine def ine DONC SUBTYPE RS232 0x02 DCNC SUBTYPE VOTING 0x09 DCNC TYPE AMBIENT MIC 0x50 DCNC_TYPE_CHAIRMAN 0x10 DCNC_TYPE_CHANNELSELECTOR 0x80 DCNC TYPE DDB 0x70 DCNC TYPE DELEGATE 0x00 DCNC TYPE ENTRANCE 0x30 DONC TYPE EXIT 0x40 DCNC TYPE INTERPRETER 0x60 en 206 define UNASSIGNED UNIT OxFFFF define UNASSIGNED UNIT UNITID OxFFFF define DCNC UNIT 2000 CHAIRMAN DCNC TYPE CHAIRMAN DCNC SUBTYPE CONCENTUS define UNIT 2000 DELEGATE DCNC TYPE DELEGATE DCNC SUBTYPE CONCENTUS define UNIT AMBIENT MIC DCNC TYPE AMBIENT MIC idefine DONC UNIT AUDIO IO DCNC TYPE INTERPRETER DCNC SUBTYPE AAEX itdefine DONC UNIT AUDIO IO DIGITAL DCNC TYPE INTERPRETER DCNC SUBTYPE DAEX idefine DONC UNIT COBRANET 00 0 TYPE INTERPRETER DCNC SUBTYPE CIN tdef ine DCNC UNIT DATA COMM DCNC TYPE DDB DCNC SUBTYPE ACTIVE DDB tdefine DCNC UNIT DATA COMM RS232 DCNC TYPE DDB DCNC SUBTYPE RS232 define DCNC UNIT DISC CHATRMAN DCNC TYPE CHAIRMAN DCNC SUBTYPE DISC define DCNC UNIT DISC DELEGATE DCNC DELEGATE DCNC SUBTYPE DISC define UNIT DISC DELEGATE DUAL DCNC DELEGATE DCNC SUBTYPE DISC DUAL define DONC UNIT DUAL MIC DCNC DELEGATE DCNC SUBTYPE FLUSH DUAL define define DCNC_UNIT_ENTRANCE DCNC_TYPE_ENTRANCE DCNC_UNIT_EXIT DONC TYPE EXIT Bosch Security Systems 2014 July DCN Next Generati
20. def ine def ine def ine MD C RTS LED 0 4 MD C SEND MESSAGE TO UNITS MKWORD 0 DCNC APP MD MD C SPEAKSLOWLY BUTTON 1 MD C START MON MD 2 DCNC APP MD MD C STOP MON MD MKWORD 3 DONC APP MD MDSC COMMUNICATION PARAMS 15 MDSC NAK 2 MDSC NOTIFY 5 MDSC REMOTEPROCEDURE REQ 3 MDSC REMOTEPROCEDURE RSP 4 MESSAGETYPE OIP KeepAlive 0x00447027 MESSAGETYPE OIP ResponseProtocolError 0x00447020 MKWORD LSB MSB WORD WORD MSB lt lt 8 WORD LSB MM C ATTENTION OFF 0 MM C ATTENTION TONE1 1 MM C ATTENTION TONE2 2 MM C ATTENTION TONE3 3 MM C CHAIR MICS ON MKWORD 2 DCNC APP MM MM C CHAIRMAN NO AC 6 Chairman exclude from Access Control MM C CR ADD ON PC MKWORD 23 DCNC APP MM MM C CR CLEAR ON PC MKWORD 22 DCNC APP MM C CR GET MKWORD 66 DCNC APP MM MM C CR REMOVE MKWORD 64 DCNC APP MM MM C CR REMOVE ON PC MKWORD 24 DCNC APP MM MM C CR ON PC MKWORD 25 DCNC APP MM MM C CS ADD ON PC MKWORD 27 DCNC APP Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 212 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine MM C CS CLEAR ON PC MKW
21. e Purpose A global description of the purpose of the function e 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 in chapter 2 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 IC 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 C Error Codes 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 12 2 2 Intercom functions 12 2 2 11C C START IC APP Purpose Indicates the CCU that the remote controller wants update notifications from the IC application inside the CCU Update notifications are sent upon state changes due to actions from all intercom actions on the units When you omit the execution of this remote function you can still execute
22. 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 SHIFT see section 5 2 6 6 generate an error MM E UNKNOWN UNITID AND DELID or MM E UNITID DELID MISMATCH 5 2 6 1 MM 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 5 2 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 UNKNOWN UNITID AND DELID MM E UNIT ALREADY PRESENT MM E UNIT NOT CONNECTED MM E UNITID DELID MISMATCH MM E RTS LIST FULL MM E INSERT RTS LIST FAILED MM E ILLEGAL MICRO TYPE 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 5 2 6 2 MM C RTS REMOVE Purpose Remove one delegate unit combination from the RTS list on the CCU Bosch Security Systems 2014 July 80 Parameter structure for the fu
23. 3 1 1 Remote functions System Configuration SC is the application that monitors the hardware configuration of the congress system and the link between hardware items and user information Typical SC issues are e g checking the communication status determining the system mode and replacing units System Installation SI is the application that allows for assigning seat numbers to units to create a one to one link between a unique user chosen identifier and a congress unit in the conference hall Maintaining the system configuration or performing a system installation with a remote interface is done 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 chapter 2 This chapter also defines the protocol and hardware conditions concerning the remote interface This document gives the set of remote functions and the set of update notifications concerning SC and SI The relation between remote function and update notifications is given in the description of each separate remote function The system configuration and system installation process however are also influenced by the actions of the users performed upon the actual units Actions such as pressing the microphone button or disconnecting a unit from the system also results in update notifications being sent to the remote controller The relation between unit
24. APP SC define 50 C CCU MODE CHANGE MKWORD 16 DONC APP SC define 50 C CHECK LINK MKWORD 18 DONC APP SC define 50 C BATTERY STATUS REQ MKWORD 39 DONC APP SC define 50 C BATTERY INFO REQ MKWORD 40 DONC APP SC define 50 C SIGNAL STATUS REQ MKWORD 41 DCNC APP SC define 50 C SIGNAL QUALITY REQ MKWORD 42 DONC APP SC define 50 C BATTERY STATUS MKWORD 43 DCNC APP SC define 56 C BATTERY INFO SERIAL MKWORD 44 DONC APP SC define 50 C BATTERY INFO COND MKWORD 45 DONC APP SC define 50 C SIGNAL STATUS MKWORD 46 DONC APP SC define 50 C SIGNAL QUALITY MKWORD 47 DONC APP SC define 50 C GET CCU CONFIG PROPERTY MKWORD 51 DONC APP SC Hdefine 56 C REQ SERIAL NR MKWORD 53 DCNC APP SC Hdefine 50 C GET SLAVE NODES MKWORD 54 DCNC APP SC Hdefine SC C GET UNIT IDS MKWORD 55 DCNC APP 56 Hdefine 50 C SERIAL NR MKWORD 56 DCNC APP SC define SC C UNIT SIGNAL QUALITY REQ MKWORD 57 DONC APP SC Hdefine SC C UNIT SIGNAL QUALITY MKWORD 58 DCNC APP SC Hdefine SC C SET ENCRYPTION ENABLED MKWORD 63 DCNC APP SC define 50 C GET ENCRYPTION ENABLED MKWORD 64 DONC APP SC define 50 C ENCRYPTION ENABLED MKWORD 65 DCNC APP SC Hdefine SC C LOW BATTERY MKWORD 68 DCNC APP SC Hdefine 50 C LOW BATTERY REQ MKWORD 69 DCNC APP SC Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 def ine def ine def ine
25. MM C ATTENTION or MM C ATTENTION TONE2 or MM C ATTENTION TONE3 An attention tone tone 1 2 or 3 is generated when the priority key is pressed on a chairman unit 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 bAutoMicOff TRUE Switches active microphones automatically off after 30 seconds no speech Chairman units and interpreter desks are excluded FALSE The auto mic off function is disabled bPrioCancelAll TRUE The microphone of delegates will stay off after the prio of the chairman is released FALSE The microphones of delegates will be turned on after the prio of the chairman is released Error codes returned MM E NOERROR Related functions MM C SET SETTINGS 5 2 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
26. Note that the heartbeat message is similar to the notification messages Parameter structure struct DWORD dwMessageType DWORD dwLength DWORD dwReser vedl DWORD dwReserved2 OIP KeepAl ive Where dwMessageType The message type indicator for the heartbeat message Constant value MESSAGETYPE OIP KeepAlive See Appendix A dwLength The total length of the Heartbeat message 16 bytes for this message dwReserved1 Session sequence number Currently the reserved is not used and should be set to the value zero 0 dwHReserved2 Message sequence number Currently the reserved2 is not used and should be set to the value zero 0 2 2 3 2 Format of type MESSAGETYPE OIP ResponseProtocolError Purpose Any message sent towards the DCN NG System is checked against its boundaries message size string size validity of the message type not logged in case a mismatch is detected regarding the size a universal error response message is returned Response message as described in section 2 2 3 3 cannot be used because the received message is not decoded nor processed Parameter structure struct DWORD dwMessageType DWORD dwLength DWORD dwReser vedl DWORD dwReserved2 DWORD dwErrorCode DWORD dwErrorPosition 01 ResponseProtocolError Where dwMessageType The message type indicator for the message Constant value MESSAGETYPE OIP ResponseProtocolError See Appendix B d
27. Presence is a delegate status identifying if a delegate is present or not Location is a delegate status which reflects on which unit the delegate resides Authorization is a status identifying if a unit may be used or not by the delegate that currently resides on this unit Bosch Security Systems 2014 July Note 2 When a delegate is marked Functioning the application authorization stored in the delegate database controls whether access is allowed 9 1 2 2 Events definitions The event definitions shown in the table below are all the events that can influence the presence authorization or location of a delegate Initial Unit connected Initial state after activation of settings or state after unit connection Unit disconnected Unit disconnects Present key pressed on presence menu or activating the external present contact PIN Code PIN Code is successfully entered using the soft keys This can either be e PIN Code entered after ID Card insertion ID Card plus PIN code control e PIN Code entered directly PIN Code control Insert card in seat Insert Card in delegate chairman unit check if card is inserted in the correct unit and if no other card with the same card code is already present in another unit check pin code if necessar Remove card from seat Remove card from seat after successful Insert card in seat Insert card in Entrance Insert Card in Entrance unit check if card in no other unit check PIN Code
28. a different addressing order after a de init then the serial number will change As long as the addressing stays the same the serial numbers are supposed to remain the same between single and multi systems 3 4 9 SC C BATTERY STATUS Purpose Notifies the remote controller the battery status of a unit This notification is send after the battery status of a unit has been changed or after SC C BATTERY STATUS REQ is executed Notify structure with this update The update uses the following structure typedef struct UNITID tUnitId BYTE byBatteryLevel WORD wRemainingT ime SC T BATTERY STATUS where tUnitld The unit identifier of a unit byBatteryLevel Level of the battery 26 from 0 to 100 96 When the unit has no battery the level will be 100 wRemainingTime Remaining time of the battery in minutes When the unit has no battery the remaining time will be OxFFFF 3 4 10 SC C BATTERY INFO SERIAL Purpose Notifies the remote controller the serial number of the battery located in the unit This notification is send after SC C BATTERY INFO REQ is executed Bosch Security Systems 2014 July 40 Notify structure with this update The update comes with the following structure typedef struct UNITID tUnitId DWORD dwSer ialNr SC T BATTERY INFO SERIAL where tUnitld The unit identifier of a unit dwSerialNr Serial number of the battery located in the unit When the unit has no battery the
29. break When we no longer need to be able to receive update notifications we can stop the communication with the LD application using the function wError LD_StopLDApp if wError LD_E_NOERROR This ends remotely controlling the LD application do error handling D 8 Message Distribution In the example below the remote functions that are defined in this document as constant values for the wFnld parameter of the message see chapter 2 are presented as functions described in a C syntax The parameter structures of these functions are according the input or output structures described in the appropriate section Bosch Security Systems 2014 July For every function it is assumed that the function will create these structures if needed transport the parameters to the CCU waits for the result information coming from the CCU and deletes the created structures if not needed anymore For the remote functions the same names are used as their identifier but without the constant mark C and using mixed case names So e g remote function MD C SEND MESSAGE TO UNITS shall be referenced as function as MD SendMessageToUnits MD T SEND MESS ptSendMessage D 8 1 Sending a Message This example shows the steps to be taken for using the MD application In this example we will send a message to a list of interpreter units We will assume that these units exist WORD wError typedef struct DCNC LCD
30. def ine def ine def ine def ine def ine def ine def ine def ine def ine itdef ine itdef ine C FLASHING MIC ON MKWORD 3 APP IN C FLOOR DISTRIBUTION MKWORD 4 DCNC APP IN IN C LANGUAGE LIST 5 DCNC APP C SPEAKSLOWLY SIGN MKWORD 6 DONC APP IN IN C HELP SIGN MKWORD 7 DCNC APP IN DESK UPDATE MKWORD 36 DCNC APP IN C BOOTH UPDATE 37 DONC APP IN C SIGNAL CCU MKWORD 38 APP IN C UPDATE LCK MKWORD 39 DCNC APP IN IN C LOAD INT DB MKWORD 40 DCNC APP IN IN C CHANNEL UPDATE MKWORD 41 DONC APP IN IN 0 DOWNLOAD LANGLIST MKWORD 50 DCNC APP IN C SET FLASH MIC ON MKWORD 51 DCNC APP IN C SET FLOOR DIST MKWORD 52 DONC APP IN IN C GET FLOOR DIST MKWORD 53 DONC APP IN C START MON IN MKWORD 54 DONC APP C STOP MON IN MKWORD 55 DCNC APP IN C START IN APP MKWORD 56 DONC APP IN C STOP APP MKWORD 57 DCNC APP IN IN C SET SPEAKSLOWLY SIGN 68 DCNC APP IN IN C GET SPEAKSLOWLY SIGN MKWORD 69 DCNC APP IN IN C SET HELP SIGN MKWORD 70 DCNC_APP_IN IN C GET HELP SIGN MKWORD 71 DCNC_APP_IN C UPDATE LOCK MKWORD 73 DCNC APP IN C ASSIGN UNIT MKWORD 74 DCNC APP IN C UNASSIGN UNIT MKWORD 77 DCNC APP IN Bosch Security Systems 2014 Ju
31. equipment This parameter can have value 1 DBSC MAX CAMERA If this parameter is outside of this range the error E INVALID CAMERA NUMBER is returned tCameralD Structure holding the actual camera ID The content of this structure is defined below szCameralD The camera ID which is a NULL terminated string Response structure from the function The function has no response parameters Error codes returned CC E NOERROR CC E NOT INCONTROL CC E INVALID CAMERA NUMBER 6 2 2 9 CC C CLEAR CAMERA IDS Purpose This function clears all camera IDs in the CCU 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 CC E NOERROR CC E NOT INCONTROL 6 2 2 10 CC C SEND DATA Purpose This function can be used to send data to the camera equipment connected to the CCU Allegiant Video Switcher or an AutoDome Camera If sending the data fails error CC E INVALID PORT OUT is returned Note that this function can be called even when the remote controller is not in control of the CC application CC C START CAMERA APP has not been called Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wLength BYTE byData CC C MAX DATA LEN CC T DATA FRAME where wLength Defines the size of the data sent i e the data is found in by
32. 00 Use the Download and Licensing Tool to enable the Open Interface This tool is present on the DVD delivered the DCN conference system 1 3 Definitions Acronyms and Abbreviations ACK ACN ACS ASCII AT AVS CC CCU CR list CS list DB DCC DCN DCN NG DDI FIFO IC IN IP DCN CCU LCD LD LED LSB MCCU MD Message data Message type MM Bosch Security Systems 2014 July Acknowledge of a packet Audio Communication Network Access Control Services American Standard for Character Information Interchange Attendance Registration Allegiant Video Switcher Camera Control Central Control Unit This can be either a single CCU system or a Multi CCU system 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 Response Comment Speakers list An extra type of speakers list in which delegates can be placed to make a comment on the current speaker Delegate Database Direct Camera Control Digital Congress Network Digital Congress Network Next Generation Dual Delegate Interface First In First Out Intercom Simultaneous Interpretation Internet Protocol Product number of the CCU Which can be one of the following e DCN CCU2 e DCN CCUB2 Liquid Crystal Display Text Status Display Light Emitting Diode Least Significant Byte Multi CCU system A DCN NG
33. 126 8 Parliamentary and Mutli Voting 127 8 1 Internal Functioning Voting AARTEN ERRANEN 127 VOllBO Sube uu y E 127 VOUNGIKING E 127 8 1 3 General Voting 127 8 1 4 Communication settings 127 8 1 4 1 Result structure format 128 8 1 5 Default settings voting 129 8 1 5 1 Standalone settings 130 8 1 6 Allowed settings without delegate database 130 8 2 Remote Functions l ee Dd em e een 131 8 2 Rae 131 8 2 1 1 Remote function item 131 8 2 2 Volirig fonmellonS u uu itta erue u S A kk se 131 9 224 MIT SO START DB uitis arii i Un Pan enden ie pacar eased 131 9 2 2 2 NT G STOP ADD praeda aaa bed eee Win due 132 8 2 2 3 VT O START VOTING iride tee ale deel ede top ec ttr a 133 8 2 2 4 VT C STOP VOTING ceret ete e Ene taeda 133 8 2 2 5 HOED VOTING ri thc Eee eM E aes 134 8 2 2
34. 2 4 AT ACTIVATE purpose This function allows the remote controller to start stop attendance registration and or access control As long as attendance registration and or access control is on the CCU will send update notifications of type AT C SEND TOTAL REGISTRATION to the remote controller Update notifications are sent upon state changes due to actions from the delegates on the units Parameter structure for the function The function requires the following structure as parameter typedef struct BOOLEAN bAttendanceOn BOOLEAN bAccessOn AT T ACTIVATE where bAttendanceOn Indication if attendance registration must be on or off bAccessOn Indication if access control must be on or off 13 Present contact can only be used when in SI the external contact is configured as present see SRS SCSIINF Bosch Security Systems 2014 July 153 Response structure from the function The function has no response parameters Error codes returned AT E NOERROR AT E APP NOT STARTED AT E NOT INCONTROL AT E ACTIVATION NOT ALLOWED Update notifications AT C SEND INDIV REGISTRATION AT C SEND TOTAL REGISTRATION Related Functions AT C STORE SETTING AT C HANDLE IDENTIFICATION 9 2 2 5 AT C HANDLE IDENTIFICATION Purpose This function allows the remote controller to do the registration with his own equipment After the local registration on the remote controller he should pass the registered del
35. 20 DCNC APP 51 MKWORD 33 DCNC APP ST SI C MICROPHONE GAIN RESET MKWORD 34 DCNC APP SI 51 C NETWORK MODE SI C NO FUNCTION 0 51 C OPERATIONAL INSTALL MODE 2 SI C PRESENT 1 SI C REGISTER UNIT MKWORD 9 DCNC APP SI 51 C RESET MICROPHONE GAIN MKWORD 17 DCNC APP SI SI C SELECT UNIT MKWORD 1 DCNC APP 51 51 C SET EXT CONTACT MKWORD 13 DONC APP SI 51 C SET MASTER VOL MKWORD 10 DONC APP SI 51 0 SET MICROPHONE GAIN 15 DCNC APP SI 51 C SET NETWORK MODE MKWORD 51 C SET OPERATION MODE MKWORD 32 DONC APP SI 51 C SET WAP SETTINGS MKWORD 51 C SET WIRELESS SETTINGS MKWORD SI C START INSTALL MKWORD 4 DCNC APP SI 51 C START MON SI MKWORD SI C STOP INSTALL 5 APP SI 51 C STOP MON SI MKWORD 51 C UNSUBSCRIBE REQ MKWORD 51 C WAP SETTINGS MKWORD 51 C WIRELESS SETTINGS MKWORD Bosch Security Systems 2014 July MKWORD 26 DCNC APP 51 23 APP SI 19 DCNC APP SI 21 APP SI 21 DONC APP SI 28 DCNC APP SI 29 DCNC APP SI 24 DONC APP SI 25 DONC APP SI en 217 DCN Next Generation Open Interface Release 4 4 Hdefine 51 C GET SYSTEM ID Hdefine SI C SET SYSTEM ID Hdefine 51 C SYSTEM ID Hdefine UNITID WORD Hdefine VERSION_C_LENGTH 11 Hdefine VT_C_100_AUTHORISED_VOTES 3 define VT_C_100_EXTERNAL_PRESENT 5 MKWORD 39 DCNC APP SD MKWORD 40 DCNC APP SI MKWORD 41 DCNC APP 51
36. 6 1 Using Attendance Registration and Access 242 0 7 Text amp Status Display LD u u a nu iya uwa atap 245 0 7 1 Controlling LD application 245 D 8 Message DistribUtions 246 0 8 1 Sending a Message 247 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 9 D 9 Intercom aos apa edd cte dee Dre HO e Do D ee E 249 D 9 1 Intercom without update notifications 249 Appendix E Open interface changes in DenNg 4 2 u u u 252 E 1 Changes with respect to DCNNG 4 0 U nnne enne 252 E 2 Changes with respect to DCNNG 3 1 U 252 Changes with respect to DCNNG 2 68 2 2 2 253 Bosch Security Systems 2014 July en 10 1 INTRODUCTION 1 1 Purpose The purpose of this document is to describe the general remote interface Open Interface aspects for any application to be remotely controlled on the CCU by third party software 1 2 Scope This document describes the remote interface It is meant for developers who want to use this remote interface to control applications present in the CCU The Open Interface must be licensed LBB4187
37. 76 Error codes returned MM E NOERROR 5 2 5 MM Notebook list functions This section describes the functions to manipulate the Notebook list Note if the operation mode is set to MM C DELEGATE WITH VOICE the notebook is not available See 5 2 2 5 for operation mode 5 2 5 1 MM C NBK 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 5 9 5 1 Response structure from the function The function has no response parameters Error codes returned 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 5 2 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 5 2 5 3 MM C NBK 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
38. ABSTAIN NPPV 8 VT C RESTART VOTING MKWORD 6 DCNC_APP_VT VT C RESULTSNOTIFY MKWORD 23 DCNC APP VD VT C SET ATTENTION MKWORD 25 DCNC APP V VT C SET GLOBAL SETTINGS MKWORD 9 DCNC_APP_VT VT C SET VOTINGPARAMS MKWORD 10 DCNC APP V VT C STANDALONE VOTING 0 VT 6 START APP MKWORD 1 DCNC_APP_VT VT C START ATTENTION MKWORD 26 DCNC APP VD VT C START VOTING MKWORD 3 DCNC APP VT VT C STOP APP 2 DCNC APP VT C STOP VOTING MKWORD 4 DCNC APP VD VT C VOTE 1 0x00 C VOTEA 0x00 Bosch Security Systems 2014 July en 219 DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine itdef ine itdef ine itdef ine def ine def ine VT C VOTE ABSTAIN 0x02 VT C VOTE AGAINST 0x01 VT C VOTE DOUBLE MINUS VT C VOTE DOUBLE PLUS VT C VOTE FOR 0x00 VT C VOTE MINUS 0x01 VT C VOTE NO 0x01 VT C VOTE NOT VOTED OxFE VT C VOTE NPPV 0x03 VT C VOTE NULL 0x02 VT C VOTE PLUS 0x03 VT C VOTE UNASSIGNED VT C VOTE YES 0x00 WAP ENABLE ENCRYPTION 0x00 0x04 OxFF 0x02 ENABLE LANGUAGE DISTRIBUTION 0 01 FALSE 0 TRUE 1 Bosch Security Systems 2014 July en 220 APPENDIX C ERROR CODES Responses returned upon a remote function request contain a error field wError In this appe
39. Bosch Security Systems 2014 July en 200 DCN Next Generation Open Interface Release 4 4 en 201 define C LEAVE 2 define C LEAVE NOCHANGE 4 define AT C MAX DELEGATE 250 define AT C MAX REGISTRATION 50 define C NOSTATUS 0 define C ONE SEAT 2 define C PINCODE 4 define C PRESENTCONTACT 5 define C PRESENTKEY 1 define C SEAT 1 define C SEND INDIV REGISTRATION 0x090A define AT_C_SEND_TOTAL_REGISTRATION 0x090B define AT_C_START_AT_APP 0 0901 define AT_C_STOP_AT_APP 0 0902 define AT_C_STORE_SETTING 0 0903 define CC_C_ALLEGIANT_VIDEO_SWITCHER 1 Hdefine C CLEAR CAMERA ASSIGNMENTS MKWORD 5 DCNC APP CC Hdefine C CLEAR CAMERA IDS MKWORD 8 DONC APP CC Hdefine CC C DIRECT CAMERA CONTROL 2 Hdefine C GET GLOBAL SETTINGS MKWORD 10 DCNC_APP_CC Hdefine C MAX CAMERA ASSIGNMENT CLUSTER 100 Hdefine C MAX CAMERA ID CLUSTER 10 Hdefine C MAX CAMERA ID LEN 17 Hdefine CC C MAX DATA LEN 60 Hdefine C MAX SEAT TEXT LEN 17 Hdefine 00 C NO CAMERA CONTROL TYPE 0 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine de
40. DATA MKWORD 7 DCNC APP CC CC C CLEAR CAMERA IDS MKWORD 8 DONC APP CC CC C SET CAMERA ID MKWORD 9 DCNC APP CC CC C GET GLOBAL SETTINGS 10 DCNC APP CC CC C RECEIVE DATA MKWORD 16 DCNC_APP_CC CC C SCREEN LINE 0 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 define define itdef ine itdef ine def ine def ine def ine def ine def ine def ine define define def ine def ine def ine def ine define define define define CC_C_SEAT_TEXT 1 CC_C_SCREEN_LINE_DOUBLE 2 CC_C_SEAT_TEXT_DOUBLE 3 CC_C_NO_CAMERA_CONTROL_TYPE 0 CC_C_ALLEGIANT_VIDEO_SWITCHER 1 CC_C_DIRECT_CAMERA_CONTROL 2 CC_C_MAX_CAMERA_ASSIGNMENT_CLUSTER 100 CC_C_MAX_CAMERA_ID_CLUSTER 10 CC_C_MAX_SEAT_TEXT_LEN 17 CC_C_MAX_CAMERA_ID_LEN 17 CC_C_MAX_DATA_LEN 60 CC C OVERVIEW ID UNITID 0x0000 DBSC MAX UNIT 576 DBSC EMPTY PREPOS 255 DBSC MAX CAMERA 256 DBSC MAX PREPOSITION 99 MKWORD Ib hb WORD CCOYORD hb 8 WORD 1b DCNC APP 2 IN C CHAN STATUS MKWORD 1 DCNC APP 6 CCU CONFIG MKWORD 2 DCNC APP IN Bosch Security Systems 2014 July en 190 DCN Next Generation Open Interface Release 4 4 en 191 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine
41. DCNC APP VT define VT C DOWNLOAD SUBJECT MKWORD 7 DONC APP VT Hdefine VT C SET GLOBAL SETTINGS MKWORD 9 DCNC APP VT define VT C SET VOTINGPARAMS MKWORD 10 DONC APP VT define C GET RESULTS MKWORD 12 DCNC APP V define C GET ATTENTION MKWORD 24 DONC APP VT define VT C SET ATTENTION MKWORD 25 DONC APP VT define C START ATTENTION TONE MKWORD 26 DCNC APP VT define VT 0 RESULTSNOTIFY MKWORD 23 DCNC APP VT define VT C MAX LEN SUBJECT 142 define VT C MAX LEN LEGEND 11 define VT C MAX ANSWER OPTIONS 25 define C MAX RESULT DELEGATE 2000 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine itdef ine itdef ine itdef ine def ine def ine def ine def ine def ine VT C VOTE YES 0x00 VT C VOTE NO 0x01 VT C VOTE ABSTAIN 0x02 VT C VOTE NPPV 0x03 VT C VOTE FOR 0x00 VT C VOTE AGAINST 0x01 VT C VOTE DOUBLE MINUS VT C VOTE MINUS 0x01 VT C VOTE NULL 0x02 VT C VOTE PLUS 0x03 VT C VOTE DOUBLE PLUS C VOTEA 0x00 VT C VOTE 1 0x00 VT C VOTE VOTED OxFE VT C VOTE UNASSIGNED VT C LED SHOWOTE 0 VT C LED SECRET ON OFF VT C LED SECRET FLASH ON VT C 100 PRESENT KEY VT C 100 VALID VOTES VT C 100 AUTHORISED VOTES
42. Generation Open Interface Release 4 4 define itdef ine itdef ine define define define def ine def ine def ine def ine def ine def ine define define define def ine def ine def ine def ine LD_C_MD_FLAG_DISPLAY 0 2 LD C MM FLAG DISPLAY 0x4 LD C MAX NR OF DISPLAY LINES 10 DCNC MAX DISPLAYDATA SIZE 512 MKWORD Ib hb WORD WORD hb lt lt 8 WORD Ib DCNC APP MD 10 MD C SEND MESSAGE TO UNITS MKWORD 0 DCNC_APP_MD MD C CLEAR MESSAGE ON UNITS MKWORD 1 APP MD MD C START MON MD MKWORD 2 DCNC APP MD MD C STOP MON MD MKWORD 3 DCNC APP MD MD C AUX LED CONTROL MKWORD 4 DCNC APP MD MD C REQ BUTTON ON OFF MKWORD 10 DCNC APP MD MD C RCV DELEGATE 0 MD C RCV INTERPRETER 2 MD C RCV 3 MD C AUXILIARY BUTTON 0 MD C SPEAKSLOWLY BUTTON 1 MD C HELP BUTTON 2 MD C EXTERNAL PRESENT CONTACT 3 Bosch Security Systems 2014 July en 198 DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine itdef ine itdef ine itdef ine Typedef itdef ine itdef ine itdef ine def ine def ine def ine def ine def ine def ine def ine def ine en 199 C IN NOTEBOOK LED 0 1 MD C MICRO LED 0x2 MD C RTS LED Ox4 MD C ALL LEDS OFF 0 0 DCNC MAX DISP CHARS 41 DCNC MAX LCD LINES 5 DBSC MAX ACT UNIT 576 char LCD TEXT B
43. ICard Delegate card code A unique number in the range 1 MAX CARD CODE or DB C NO CARD This is the numeric code present on the identification card handed over to the delegate and which is to be used in combination with attendance registration and access control IPin Delegate pin code A numeric value in the range 111 55555 PIN codes or DB NO PIN are used for attendance registration and access control but do not have to be unique wUnitNr The unit number that the delegate is assigned to by default This unit number must equal Unitld retrieved with SC C GET CCU CONFIG or equal to DCNC UNASSIGNED UNIT byiDeskLang Delegate display language One of e 0 DCNC VER ENGLISH e 1 5 Configurable IVWeight Delegate vote weight A value in the range 1 VOTE WEIGHT to be used by the voting application bMicAut TRUE this delegate has microphone authorization FALSE this delegate has no micro Authorization bVotingAut TRUE this delegate has voting authorization FALSE this delegate has no voting authorization binterAut TRUE this delegate has intercom authorization FALSE this delegate has no intercom authorization szSLine Delegate screen line A string to represent a delegate e g on a Hall Display If more than DB C MAX N DL DEL REC records should be send to the CCU more calls of this remote function will be needed In this case the bFirstCluster and bLastCluster indicate the start and termination of the compl
44. INDIV REGISTRATION 0x0906 AT C SEND INDIV REGISTRATION 0x090A AT_C_SEND_TOTAL_REGISTRATION 0x090B AT C APP CONTROL 1 AT C APP MONITOR 2 C SEAT 1 AT C ENTRANCE EXIT 2 AT C ANY SEAT 1 AT C ONE SEAT 2 C PRESENTKEY 1 AT C IDCARD 2 AT C IDCARD PINCODE 3 AT C PINCODE 4 AT C PRESENTCONTACT 5 AT C NOSTATUS 0 C ATTEND 1 AT C LEAVE 2 C ATTEND NOCHANGE 3 AT C LEAVE NOCHANGE 4 AT C MAX DELEGATE 250 AT C MAX REGISTRATION 50 Bosch Security Systems 2014 July en 196 DCN Next Generation Open Interface Release 4 4 en 197 def ine def ine def ine def ine define define def ine def ine def ine define define define define define define define define define define ACSC_EVENT_INSERT_CARD_ENTRANCE 5 ACSC_EVENT_INSERT_CARD_EXIT 6 DBSC_EMPTY_UNIT OxFFFF DBSC EMPTY DELEGATE OxFFFF TRUE 1 FALSE 0 MAX CARD CODE 999999999 MKWORD Ib hb WORD CCOYORD hb 8 WORD Ib DONC APP 10 12 LD C START LD APP MKWORD 12 DCNC APP LD LD C STOP APP gt MKWORD 13 DCNC APP LD LD C STORE DISPLAY SETTING MKWORD 14 DCNC APP LD C CLEAR DISPLAY NR MKWORD 11 DCNC APP LD LD C SEND ANUM DATA MKWORD 7 DCNC APP LD LD C DISPLAY ONE 0 LD C DISPLAY TWO 1 LD C DISPLAY THREE 2 LD C DISPLAY FOUR 3 LD C VT FLAG DISPLAY 0 1 Bosch Security Systems 2014 July DCN Next
45. INTERPRETER DCNC UNIT CCU CONTROL DCNC UNIT DATA COMM RS232 DCNC UNIT 2000 DELEGATE DCNC UNIT 2000 CHAIRMAN DCNC UNIT AUDIO IO DCNC UNIT AUDIO IO DIGITAL DCNC UNIT COBRANET DCNC UNIT DISC DELEGATE DCNC UNIT DISC DELEGATE DUAL DCNC UNIT DISC CHAIRMAN DCNC UNIT DUAL DCNC UNIT FLUSH CHR NODISPLAY DCNC UNIT FLUSH DEL NODISPLAY DCNC UNIT ENTRANCE DCNC UNIT EXIT DCNC UNIT AMBIENT MIC Note that future unit extensions of the DCN NG system can lead to new unit type not presented in this list 29 wUnitProperties Holds the properties of a unit This can be a combination of the following DCNC_HAS_MIC DCNC_HAS_AUX DCNC_HAS_KEYS DCNC_HAS_CARD DCNC_HAS_ DISPLAY DCNC_HAS_ GRAPHICAL DISPLAY DCNC HAS INTERCOM DCNC HAS EXTERNAL DCNC HAS BOOTH DESK DCNC HAS HELP DCNC HAS SPEAKSLOWLY DCNC HAS BATTERY DCNC HAS QUALITY LEVEL DCNC HAS DATACHANNEL SUPPORT DCNC HAS MOST INTERFACE DCNC HAS NEED FOR CARD SETTINGS Error codes returned SC E NOERROR 3 3 7 5 REQ SERIAL NR Purpose Request the serial numbers of the specified units of the system The master controller will return the serial numbers with the SERIAL NR notification Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function
46. 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 wNrOf Instances where wNrOflnstances 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 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 5 2 2 4 MM C STOP MON MM Purpose Function to stop monitoring the behavior 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 5 2 2 3 Error codes returned MM E NOERROR Bosch Security Systems 2014 July 69 Related functions MM C START MM MM C START MON MM 5 2 2 5 MM C SET MIC OPER MODE Purpose This function allows the remote controller to change the microphone operation mode Parameter structure for the function The function requires the following structure as parameter WORD wOperat i onMode where wOperationMode The operation mode of th
47. NETWORK MODE Purpose Retrieve the network mode of the system Availability This function is available in system mode CONGRESS Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure SI T NETWORK MODE tMode where tMode The network mode of the system which is one of the following e SI C NETWORK MODE ON e SI C NETWORK MODE SLEEP e SI C NETWORK MODE OFF e 51 C NETWORK MODE SUBSCRIPTION Error codes returned SI E NOERROR Related functions SI C SET NETWORK MODE 3 5 9 SI C SET NETWORK MODE Purpose Set the network mode of the system Availability This function is available in system mode CONGRESS Parameter structure for the function The function requires the following input parameters SI T NETWORK MODE where tMode The network mode of the system which is one of the following e SI C NETWORK MODE ON e SI C NETWORK MODE SLEEP e SI C NETWORK MODE OFF e SI C NETWORK MODE SUBSCRIPTION Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E WRONG PARAMETER Bosch Security Systems 2014 July 54 Related functions SI C GET NETWORK MODE Update notifications SI C NETWORK MODE 3 5 10 SI C START MON SI Purpose Function to start the monitoring behavior of the SI application Availability This function i
48. NOTEBOOKLIST MM T CCU NBKMICROLIST Bosch Security Systems 2014 July en 77 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 is transmitted This value never exceeds the constant DBSC MAX NOTEBOOKLIST INbkList 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 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_VIP_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 MM C VIP PTTCHAIRMAN MM C VIP PTT MM C VIP PTTCHAIRMAN NO AC MM C VIP PTT 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 DCNNG Control PC Error codes returned MM E NOERROR 5 2 5 4 MM C NBK SET Purpose Set the complete contents of the Notebook list Parameter struc
49. Parameter structure for the function The function requires the following input parameters typedef struct UNITID tUnitId SI T CARRIER byCarrier SI_T_WIRELESS_POWERLEVEL byPowerLevel BYTE byOptions SI T WAP SETTINGS where tUnild Reserved The unit identifier of a WAP Will be DCNC UNASSIGNED UNIT byCarrier The carrier of the WAP which is one of the following e SI C CARRIER BAND 1 e SI C CARRIER BAND 2 e SI C CARRIER BAND 3 byPowerLevel The coverage of the WAP which is one of the following e SI C POWERLEVEL OFF e SI C POWERLEVEL LOW e SI C POWERLEVEL MEDIUM e SI C POWERLEVEL HIGH byOptions The options field must at least be equal to e WAP ENABLE LANGUAGE DISTRUBUTION Additionally the following value can be added to the options field to enable Wireless encryption e WAP ENABLE ENCRYPTION Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E WRONG PARAMETER Related functions SI C GET WAP SETTINGS Bosch Security Systems 2014 July 52 Update notifications SI C WAP SETTINGS 3 5 6 SI C GET WIRELESS SETTINGS Purpose Retrieve all wireless system settings of the system Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the
50. RS 232 interface The remote controller makes Remote Function calls for Intercom e The actual units that handle their intercom handset e The interpreter units that handle their intercom or chairman call button It is not possible to receive update notifications on both the remote controller and the DCN NG Control PC 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 This document gives the set of Remote Functions and the set of Update Notifications concerning Intercom 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 events and Update Notifications is given in section 5 3 1 2 12 2 Remote Functions 12 2 1 Introduction This chapter describes the various remote functions needed to use the intercom functionality of the system 12 2 1 1 Remote function item explanation Each description consists of the following items Bosch Security Systems 2014 July en 172
51. SI C START INSTALL and run installation as described examo e 1 in Appendix D Bosch Security Systems 2014 July en 36 Even Update Notification Continue with remote function Slave or Single Mode Disconnect another CCU lt None gt Slave or Single Mode Connect a unit to CCU A SC C CONNECT UNIT Recommended before continuing SI C START INSTALL and run installation as described in example 2 in Appendix D Disconnect a unit from SC C DISCONNECT UNIT CCU A Connect a unit to another CCU Slave or Single Mode Disconnect a unit from lt None gt another CCU Slave or Sing e Mode Remote Controller connected to the Master CCU Switch On the Master CCU SC_C_CCU_REBOOT SC C START APP Recommended before continuing SC_C_GET_CCU_VERSIONINFO SC_C_GET_CCU_CONFIG SI C START INSTALL and run installation as described example 1 in Appendix D Switch On a Slave CCU SC C CONNECT SLAVE CCU Recommended before continuing on the unit connect updates SI START INSTALL and run installation as described examole 2 in Appendix D and a few seconds later for every unit connected to that Slave CCU separately SC C CONNECT UNIT Switch On another Single lt None gt Mode CCU Switch Off a Slave CCU SC C DISCONNECT SLAVE WEIW G XY ENS Switch Off another lt gt Single Mode CCU Disconnect a unit from lt None gt CCU A Connect a unit to a Slave SC_C_CONN
52. TEXT BLOCK tText WORD wRcvType WORD wDuration WORD wNumOfUni ts WORD wUnitList DBSC MAX ACT UNIT MD T SEND MESS typedef struct WORD wUnitlId BYTE byButtonType BOOLEAN bOn MD T REQ BUTTON ON OFF typedef struct WORD wUnitId BYTE byLedMask MD T AUX LED MD T SEND MESS tSendMessage tSendMessage wUnitList O 1 tSendMessage wUnitList 1 2 tSendMessage wUnitList 2 3 tSendMessage wUnitList 3 4 tSendMessage wNum0fUnits 4 List with unit id s of interpreters tSendMessage tText 0 Line 1 tSendMessage tText 1 Line 2 tSendMessage tText 2 Line 3 tSendMessage tText 3 Line 4 tSendMessage tText 4 Fifth line is a terminating line tSendMessage wRcvType MD C RCV INTERPRETER Send to interpreters tSendMessage wDuration 0 Only needed for hall displays Send the message to the listed interpreters wError MD SendMessageToUnits amp tSendMessage if wError MD E NOERROR If we are interested in receiving update notifications we must register with the CCU WORD wNrOfInstances 0 do error handling wError MD StartMonMD amp wNrOf Instances if wError MD_E_NOERROR Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 248 else do error handling switch wNrOf Instances case 0 Something went wrong handle error
53. also finished the operational installation mode so we can leave the installation mode error SI_Stop_Install 0 if error SI_E_NOERROR The remote controller can now continue with operation do error handling D 2 Microphone Management 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 chapter 2 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 e g remote function MM C SET SETTINGS shall be referenced as function as MM Set Settings MM T CCU GLOBAL SETTINGS tMMSettings D 2 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 wNrOf Instances error MM Start MM amp wNrOfInstances if error MM E NOERROR else do error handling switch wNrOf Instances case 0
54. 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 11 ST DELEGATE WITH PUSH TO TALK Bosch Security Systems 2014 July 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 5 2 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 Either the operator or the delegates can do all functions 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 to 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 direct
55. be divided into 4 lines Each line Bosch Security Systems 2014 July consists of DBSC NCHAR SCREENLINE characters It is the responsibility of the remote controller that each line is extended with spaces till DBSC_NCHAR_SCREENLINE characters per line szLegendSubject Voting number Legend This text is put before the voting number on the units LCD s The purpose of this legend is to clarify the meaning of the voting number e g Motion or Vote Nr Response structure from the function The function has no response parameters Error codes returned VT E NOERROR VT E VOTE RUNNING VT E APP NOT STARTED VT E WRONG PARAMETER 8 2 2 8 VT C SET VOTINGPARAMS Purpose This function allows the remote controller to set the kind of voting on the CCU for the next voting to be run These settings can only be sent to the CCU when no voting is running parameter structure for the function The function requires the following structure as parameter typedef struct WORD wVotingMenu WORD wNrOfAnswerOpt i ons BOOLEAN bOpenVoting WORD wInter imResultType BOOLEAN bCompressedResults VT T VOTINGPARAMS where wVotingMenu Identify which voting menu is displayed on the unit LCD s and LED s The setting is one of the following VT C MENU YES NO VT C MENU YES NO ABSTAIN VT C MENU FOR AGAINST VT C MENU AUDIENCE RESPONSE VT MENU 123 VT C MENU ABC VT C MENU CBA e VT C MENU YES NO ABSTAIN NPPV wNr
56. can be found in the user manual USERDOC CC Configuring Camera Control with a remote interface is achieved 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 chapter 2chapter 2 This chapter also describes the protocol and hardware conditions concerning the remote interface Together with this remote interface there are at the moment two locations in a fully connected CCU where CC can be influenced These locations are e Aremote controller which can be the control PC connected using an Ethernet in case of MCCU or RS 232 in case of SCCU connection This remote controller uses Remote Function calls to configure Camera Control e Chairman or delegate units influence Camera Control indirectly if their microphone is activated and a camera was assigned to their position the camera is activated To get a fully operational system the remote controller must register itself to the CCU in order for it to receive update messages from the CCU Remote functions coming from the remote controller can indirectly initiate update notifications in the CCU Note that these update notifications are actually generated in connected camera equipment Depending on the fact whether or not camera equipment is connected to the CCU and on which type of equipment is connected update notifications may be sent to the CCU Th
57. constant values for the wFnld parameter of the message see chapter 2 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 it is assumed that the function will create its structure transport the parameters to the CCU and wait for the result information coming from the CCU For both the remote functions and the update notifications the same names are used as their identifier but without the constant mark C and using mixed case names with less underscores So e g remote function LD C START LD APP shall as function be referenced as LD StartLDApp void D 7 1 Controlling LD application This example shows the minimum steps to be taken for controlling the LD application First we have to start controlling the LD application on the CCU typedef struct WORD wDisplaylId WORD wFlags WORD wNrOfSpeakerLines WORD wNrOfRequestL ines DWORD dwReser ved LD T DISPLAY REC typedef struct WORD wDisplaylId CHAR ssData DCNC MAX DISPLAYDATA SIZE WORD wNumOfChars LD T DISPLAY WORD wError wError LD StartLDAppO switch wError case LD E INCONTROL THIS CHANNEL I have the LD app already under control Is that correct Has the remote controller restarted For the moment assume to be correct and continue break case LD
58. document gives the set of Remote Functions and the set of Update Notifications concerning Text amp Status Display The indirect relation between Remote Function sent by the remote controller and Update Notifications is given in the description of each separate Remote Function The indirect relation between unit events and Update Notifications and the configuration needed to enable these updates is given in section 6 3 1 2 10 2 Remote Functions 10 2 1 Introduction This chapter describes the remote functions used to configure the Text amp Status Display application on the CCU 10 2 1 1 Remote function item explanation Each description consists of the following items Bosch Security Systems 2014 July 159 e Purpose A global description of the purpose of the function e Parameter structure for the function The input parameters needed to fulfill 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 in chapter 2 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 LD 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 co
59. function has no response parameters Error codes returned IN E NOERROR IN E WRONG PARAMETER IN E APP NOT STARTED IN E UNKNOWN INTSEAT 7 2 3 71 C BOOTH UPDATE Purpose This function updates an interpreter booth configuration in the CCU with a new configuration from the remote controller It only changes the auto relay flag for one booth All microphones in the booth will be turned off first The auto relay flag is then set No download takes place If the booth cannot be found an error is returned An interpreter unit that is being installed when this function is called will leave its installation menu Parameter structure for the function The function requires the following structure as parameter struct WORD wBoothNr WORD wAutoRelay J where wBoothNr wAutoRelay Booth number of the booth that needs to be updated Range 1 31 Auto relay flag If the high byte part of this parameter is not equal to 0 e g the parameter has a hexadecimal value 0x0100 the booth will be an auto relay booth If the high byte part of this parameter is equal to 0 e g the parameter has a hexadecimal value 0x0000 the booth will not be an autorelay booth Response structure from the function The function has no response parameters Error codes returned IN E NOERROR IN E WRONG PARAMETER IN E APP NOT STARTED IN E UNKNOWN BOOTH NR Bosch Security Systems 2014 July 111 7 2 3 8I
60. functions is explained to give an overview about the generation of updates during the execution The remote controller can sent a remote function request to the CCU After the transmission the remote controller must wait for the response coming from the CCU During the execution of that remote function in the CCU the internal Remote Controller state of e g microphones changes This results in the generation of update notifications which are transmitted to the remote controller Notify Notify Response immediately After the completion of the remote function execution the response of that function is sent back to the remote controller This flow of messages to and from the CCU is shown in Figure 2 two notification messages between the request and the response Request Figure 2 Message flow during a Remote function Bosch Security Systems 2014 July 20 The typical time between the request made and the response received is less than 0 5 seconds In the sequence described there is only one remote function request in execution on the CCU The remote controller waits for the completion of that remote function The remote controller can expect the following ending states of the remote request e The actual response of the remote function The remote function is ended and there were no transmission errors e The packet This implies that the CCU had a checksum error found after the receptio
61. has registered for an application The message type will be equal to the value MDSC NOTIFY Upon error the wError field is filled with an error code see Appendix C which references the source of the error Depending on the location of the error the tStructure data may not be present Therefore do not use the tStructure data when wError is not equal to zero When the error code has not been described the error must be reported Bosch Security Systems 2014 July 16 The message data received along the update notification follows the following format typedef struct WORD wFnId notification identifier NTFSTRUC tStructure update information if any RSMT NOTIFY where wFnld The notification identifier tStructure A structure containing the update information The wFnld and the tStructure are tightly coupled Therefore the parameter structure is not defined strictly with the basic types but a special type is used to identify that the structure depends on the notification identifier The actual structure definition to be sent along with the update notification is not described in this document The structures are presented along with the definition of the update notification in the interface documents for the application 2 2 3 Ethernet message layout Each message must have this layout Defined in c style structure format struct DWORD dwMessageType Me
62. have already cast a vote for the current vote round Note that a TRUE value of the parameter disables the value of the parameter bAutoAbstain bAutoAbstain is then always considered to be FALSE In the following table is described how the led option operates wVotingLedMode Description VT C LED SHOWVOTE The LED s next to the softkeys represents the last casted vote done VT C LED SECRET ON OFF When a delegate casts his vote all soft LED s will be on for about 1 second and then they will be turned off VT C LED SECRET FLASH ON When a delegate casts his vote all soft LED s will be flashing for about 2 seconds and then they will be turned on In the following table is described how the number of Present and Not Voted delegates is determined VT C 100 PRESENT KEY No database present Every unit is prompted for present Database is present All delegates who have voting authorization and a unit are asked to press the present key softkey 1 before they can vote The number of present delegates is equal to the delegates who have pressed the present key When a delegate has pressed his present key the number of Not Voted delegates will be increased with 1 When a delegate cast a vote the number of Not Voted will be decreased with 1 VT C 100 VALID VOTES The number of Present delegates is equal to the number of delegates who have casted a vote The number of Not Voted delegates is always equal to 0
63. his micro button he is MM C DELEGATE WITH PUSHTOTALK directly able to speak in case the SPK list is not full e disables all RTS functions notifications e enables all SPK functions notifications e disables all CR functions notifications e disables all CS functions notifications The SPK functions and notifications mentioned in the table are described in respectively sections 5 2 3 and 5 3 3 The CS functions and notifications mentioned in the table are described in respectively sections 5 2 4 and 5 3 4 The RTS functions and notifications mentioned in the table are described in respectively sections 5 2 5 4 and 5 3 6 The CR functions and notifications mentioned in the table are described in respectively sections 5 2 7 and 5 3 7 5 2 Remote Functions 5 2 1 Introduction This chapter describes the various remote functions needed to perform microphone management on the system 5 2 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 chapter 3 5 2 1 2 Remote function item explanation Each description consists of the following items e Purpose A global description of the purpose of
64. i e call to IN C SET SPEAKSLOWLY SIGN Configuration of the interpreter desks concerning the enabling of help signaling has changed i e call to IN C SET HELP SIGN Microphone off These update events will also occur when using IN C SIGNAL function with arguments IN C WITH PC 1 These update events will also occur when using IN C SIGNAL function with arguments IN STAND _ ALONE Bosch Security Systems 2014 July 122 Select A as active out channel Select B as active out channel Start install mode Stop install mode Select floor signal as incoming channel Select relay signal as incoming channel Select autorelay signal as incoming channel IN C CCU CON IN C CHAN STA IN C FLASHI IN C FLOO IN C LANGUA IN C SPEAKS IN C HELP SI FIG TUS NG MIC ON R DISTRIB GE LIST LOWLY SIGN GN UTION pog a a me p GN EI 74 RN NS E I a4 5 1 DNE CORN Pa sss CNET 11 This action only leads to the shown notification if the microphone of the interpreter desk is turned on when the action is performed If the microphone is off performing the action will not lead to any update notifications 12 If the CCU controls the IN application i e no remote controller connected the interpreter desks
65. 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 0 6 EMPTY UNIT DBSC EMPTY DELEGATE At least one of the elements must be defined to fulfill 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 elements 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 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
66. 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 Update notifications MM C SPK APPEND ON PC Related functions MM C SPK REMOVE 5 2 3 3 MM C 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 5 2 3 2 Bosch Security Systems 2014 July 74 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 5 2 3 4 MM C SPK CLEAR Purpose Clear all entries in the SPK list on the CCU All delegate microphones are turned off The chairmen microphones remain in the same st
67. not sent received to from optical devices In this case another master needs to be present in the optical network When a master is not present or cannot be found the DCN CCU will show the MASTER error The DCN CCU operates in multi master mode and is master of the optical network Interpretation channels from the DCN CCU are sent received to from optical devices The DCN CCU operates in slave mode and is fully controlled by the DCN CCU Master The DCN CCU is not master of the optical network Interpretation channels from the DCN CCU are send received to from optical devices In this case a DCN CCU Master needs to be present in the optical network When a DCN CCU Master is not present or cannot be found the DCN CCU will show the NO NETWORK error The unitld of units connected to this DCN CCU is defined as bySlaveld 0x200h gt unitld in single mode gt The DCN CCU operates in standalone mode and is master of the optical network Interpretation channels from the DCN CCU are sent received to from optical devices 49 Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E WRONG PARAMETER Related functions SI C GET OPERATION MODE 3 5 1 SI SYSTEM ID Purpose Get the system ID of the CCU Availability This function is available in all system modes Parameter structure for the function The function has
68. of the interpreter desk is active Note that this parameter is case sensitive i e if it is a or b the error code IN E WRONG PARAMETER will be returned Double word 32 bits of which the bits indicate which channels are enabled for the B out channel of the interpreter desk The least significant bit stands for channel 1 If a bit is equal to 1 the channel it stands for is enabled for the B out channel Response structure from the function The function has no response parameters Error codes returned IN E NOERROR IN E INTERLOCK NOT ALLOWED IN E WRONG PARAMETER IN E APP NOT STARTED IN E INCORRECT DESK CONFIG Related functions IN C DESK UPDATE IN C BOOTH UPDATE IN C UPDATE LCK 7 2 3 10 IN C CHANNEL UPDATE Purpose This function changes the channel languages and the number of channels The whole application is stopped and restarted in a default situation after the channel data is updated and downloaded to the desk Parameter structure for the function The function requires the following structure as parameter IN T CHANNELLANG tChannelLang Bosch Security Systems 2014 July 114 where IN T CHANNELLANG is defined as typedef BYTE T CHANNELLANG DBSC MAX INTERPRT CHANNELS where tChannelLang Array holding the channel languages This array can hold up to DBSC MAX INTERPRT CHANNELS channel languages If the array holds less channel languages this is marked by an array value
69. or if present it will not be used to start or stop the voting That is all controlling of the voting will be done by the remote controller Declaration of parameters For the C example code we need parameters In this part we declare the parameters used WORD Connecting to the voting application First the remote controller must get the control of the VT application Because we do not use the update notifications we directly can reduce the number of updates by turning off the automatic result updates coming from the voting application The time for showing the text End of voting after the stop of a voting round will be set to 20 seconds This results in the following function call WORD wError VT T COMCONTROL tComControl tComControl bResultNot i fy FALSE tComControl bReser ved FALSE must be FALSE tComControl wViewTimeAfterStop 20 wError VT StartApp amp tComControl switch wError Check the possible errors case VT E INCONTROL THIS CHANNEL I have the voting app already under control Is that correct Is the remote controller restarted For the moment assume to be correct and continue break case VT E INCONTROL OTHER CHANNEL Another remote controller has control over the voting application report error and terminate 14 Note that the interface to enable the attendance application is not described in this document For information about the
70. or released Note that the function is also used for the external present contact In this case no buttons is pressed but the contact is closed The closing and opening of the contact can be performed by means of a button though if a button is connected to the external present contact Notify structure with this update The update comes with the following structure typedef struct WORD wUnitId BYTE byButtonType BOOLEAN bOn MD T REQ BUTTON ON OFF where w Unitld Unit Identifier of the unit on which the request button was pressed Unit identifiers can be retrieved from the system using the remote functions for System Config chapter 3 byButtonType Identifies which button was pressed on the unit This can be one of the following types e MD C AUXILIARY BUTTON The auxiliary button was pressed This implies that the unit identified by wUnitld is a delegate unit e MD C SPEAKSLOWLY BUTTON The speak slowly button was pressed This implies that the unit identified by wUnitld is an interpreter desk e MD C HELP BUTTON The help button was pressed This implies that the unit identified by wUnitld is an interpreter desk e MD C EXTERNAL PRESENT CONTACT The external present contact was closed opened This implies that the unit identified by wUnitld is a delegate unit with an external present contact bOn TRUE The button is pressed and held or the contact is closed FALSE The button is released or the contact is opened
71. remote function MM C GET SETTINGS see 5 2 2 7 Response structure from the function The function has no response parameters Bosch Security Systems 2014 July en 72 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 MM E NOT IN CONTROL MM E ILLEGAL ATTENTION TONE Update notifications MM C SET SETTINGS ON PC and various SPK CS RTS and or CR updates depending on the settings made Related functions MM C GET SETTINGS 5 2 3 MM Speaker list functions This section describes the functions to manipulate the speakers list 5 2 3 1 MM C 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 performed 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 2 SPK list use the remote call MM C SPK REMOVE see section 5 2 3 3 Delegate unit micro on The units microphone is turned on The unit remains in com in the SPK list the SPK list The units microphone is turned on Chairman unit micro off The units microphone is tur
72. response parameters Error codes returned VT E NOERROR VT E VOTE NOT RUNNING VT E APP NOT STARTED Related functions VT C START VOTING VT C STOP VOTING VT C RESTART VOTING 8 2 2 6 VT RESTART VOTING Purpose This function allows the remote controller to restart a voting round 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 VT E NOERROR VT E VOTE NOT ON HOLD VT E APP NOT STARTED Update notifications VT C RESULTSNOTIFY Related functions VT C START VOTING VT C STOP VOTING VT C HOLD VOTING 8 2 2 7 VT C DOWNLOAD SUBJECT Purpose This function allows the remote controller to transmit a subject to the CCU while no voting round is running Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wVot ingNumber CHAR szVotingSubject VT C MAX LEN SUBJECT CHAR szLegendSub ject VT C MAX LEN LEGEND VT T SUBJECT REC where wVotingNumber The number of the voting which will be started This number will be used as reference during the update notifications The value range is 1 9999 The value VT C STANDALONE VOTING is reserved by the initial state on the CCU no subject download received sz VotingSubject Subject of the voting which will be displayed on the unit LCD s The subject will internally
73. returns Note that calling IN C STOP IN APP will also decrease this update use count This function updates an interpreter desk configuration in the CCU with a new configuration from the remote controller It only changes data for one desk If a microphone is on it will be turned off first The desk gets a download and will be brought up in its default state The default B out channel is the lowest channel enabled If no interpreter with the specified booth desk combination can be found an error is returned An interpreter unit that is being installed when this function is called will leave its installation menu Parameter structure for the function The function requires the following structure as parameter struct WORD wBoothNr WORD wDeskNr WORD wAChannel Bosch Security Systems 2014 July en 110 DWORD dwfBChannelSet E where wBoothNr wDeskNr wAChannel dwfBChannelSet Booth number of the interpreter desk Range 1 31 Desk number of the interpreter desk Range 1 6 The A out channel of the interpreter desk Range 1 current number of IN channels which is maximally DBSC MAX INTERPRT CHANNELS Double word 32 bits of which the bits indicate which channels are enabled for the B out channel of the interpreter desk The least significant bit stands for channel 1 If a bit is equal to 1 the channel it stands for is enabled for the B out channel Response structure from the function The
74. same update notifications if they are registered to the same application Remote functions coming from either the DCN NG Control PC or the Remote Controller initiate a function in the CCU During the function processing notifications are generated and sent to both the DCN NG Control PC and the Remote Controller In this way both remote controllers get the update information about the actions performed on request of the DCN NG Control PC or the Remote Controller see also Figure 2 Note that all remote functions are stored in a FIFO queue before execution This means that when both controllers call a remote function both remote functions will be executed one after another the time difference depends which function will be executed first 2 4 Remote Functions 2 4 1 Remote function handling On the CCU all incoming remote functions are handled by the Remote Function Services RFS During start up of the system applications register their remote controllable functions at the Remote Function Services When remote function request is received by the CCU that request is passed to the RFS sublink If the function is available the data structure will be prepared for the response data During this process general failures may occur The RFS sublink handles these failures by returning an empty response only containing the function identifier and the error code no extra data The error code informs the remote controller which general failure h
75. 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 5 3 7 MM Comment Request list notifications The Microphone Management Comment Request notifications report the remote controller the changes in the CR list 5 3 7 1 MM C CR CLEAR ON PC Purpose Notifies the remote controller that the CR list is cleared Notify structure with this update The update does not have any additional parameters 5 3 7 2 MM C CR ADD ON PC Purpose Notifies the remote controller that a delegate unit combination is added to the CR list Bosch Security Systems 2014 July 94 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 5 2 6 5 3 7 3 MM C 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 5 2 6 5 3 7 4 MM C CR REPLACE ON PC Purpose Notifies the remote controller that a delegate unit combination is replaced by a new CR entry Notify s
76. the compressed storage form 8 1 5 Default settings voting application As mentioned in the sections above setting of the voting application can be changed using remote functions But after successfully executing the VT C START APP remote function the remote controller could directly start a voting round without first setting the subject and or voting parameters global and voting kind In this particular case the voting is started with the settings as present during the standalone operation of the voting application During power on of the DCN Next Generation system all settings will get their default values When a remote controller already had called remote voting functions some setting still have their last values as set by that remote controller see also 8 1 5 1 The default power on values for the remote functions are Voting subject The voting number is set to zero and the subject text and legend texts are set to empty strings In C source lines wVotingNumber VT C STANDALONE VOTING szVotingSubject szLegendSub ject This means that there is no subject text available on the unit LCD s More information about the parameters can be found in section 8 2 2 7 Voting parameters voting parameters consist of various parameters which have the Bosch Security Systems 2014 July following default values wVotingMenu VT C MENU YES NO wNrOfAnswerOptions 3 bOpenVoting FALSE wInterimResul
77. the delegate database and who are not registered yet Related functions AT C STORE SETTING AT C ACTIVATE HANDLE IDENTIFICATION Bosch Security Systems 2014 July 158 10 TEXT amp STATUS DISPLAY FOR A REMOTE INTERFACE 10 1 Introduction The Text amp Status Display Remote Interface is part of the DCN Next Generation software that allows for another controlling entity outside the CCU not being the DCN Next Generation Control PC to use the Text amp Status Display application 10 1 1 Remote Text amp Status Display Control Text amp Status Display is the application that provides a means of displaying conference related information on character displays located in the conference venue Typical configuration issues are e g storing display settings clearing displays etc More details on the complete LD application can be found in the user manual USERDOC Configuring Text amp Status Display with a remote interface is achieved 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 chapter 2 This chapter also describes the protocol and hardware conditions concerning the remote interface Together with this remote interface there are at the moment two locations in a fully connected CCU where LD can be influenced These locations are e Aremote controll
78. the following items e Purpose A global description of the purpose of the function e Parameter structure for the function The input parameters needed to fulfill 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 in chapter 2 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 CC 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 C Error Codes e Update notifications The update notifications that are generated during the execution of the remote function When there are no notifications generated this part will be omitted Note that for CC all update notifications are generated indirectly and therefore will not always be sent depending on the configuration e Related functions The related function in conjunction with the function described It refers to other remote functions and to related update notifications When there are no related functions this part will be omitted 6 2 2 CC General functions 6 2 2 1 CC_C_START_CAMERA_APP Purpose This function indicates the CCU that the remote controller wants to
79. the function e Parameter structure for the function The input parameters needed to fulfill 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 in chapter 2 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 C Error Codes 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 Bosch Security Systems 2014 July 67 5 2 2 MM General functions 5 2 2 1 MM C START MM Purpose Indicates the CCU that the remote controller wants updates notifications from the MM applica tion 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 notifica
80. 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 5 2 2 5 3 Look if there is an entry free in the SPK list If not then a free entry will be created using on of the following rules e If 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 list 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 2014 July 82 Parameter structure for the function The function requires the structure MM T RTS as parameter This structure is defined in section 5 2 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 RT
81. the total number of present reports is sent Bosch Security Systems 2014 July 150 9 2 Remote Functions 9 2 1 Introduction This chapter describes the various remote functions needed to control the attendance registration application inside the CCU A global description of the remote function handling is described in chapter 2 The CCU can operate in multiple modes The use of the AT remote function is restricted to the Congress Mode An overview of modes can be found in chapter 3 9 2 1 1 Remote function item explanation Each description consists of the following items e Purpose A global description of the purpose of the function e Parameter structure for the function The input parameters needed to fulfil the function When the function requires no parameters no structure is described here 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 AT E NOERROR e Error codes returned The error values returned in the wError field of the response information All possible error codes are described in Appendix C Error Codes e Update notifications The update notifications that 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 conjun
82. this way both remote control lers get the update information about the actions performed on either the DCNNG 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 DCNNG 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 events and Update Notifications is given in section 5 3 1 2 At last there is a relation between remote functions sent by the DCNNG control PC and update notifications Since both remote controller and DCNNG control PC receive all update notifications the set of upd
83. update notification VT C RESULTSNOTIFY or the results are not automatically sent to the remote controller In the latter case the remote controller must collect the results using remote function C RESULTS Besides the selection of collecting the results automatic of manual these settings also includes the way results could be received A selection can be made to receive the results compressed or normal The next section explains the compressed result structure in more depth Bosch Security Systems 2014 July 8 1 4 1 Result structure format definition As stated in the communication settings the results could be received normally or compressed For both communication settings the same structure is used typedef struct WORD wVot ingNumber DWORD dwNrOfPresent DWORD dwNrOfNotVoted DWORD dwNrOfVotes VT C MAX ANSWER OPTIONS WORD wFillLevel BOOLEAN BYTE byDelegateVotes VT C MAX RESULT DELEGATE VT T RESULT REC where wVotingNumber The voting number as set during the VT C DOWNLOAD SUBUJECT remote function The value VT C STANDALONE VOTING indicates that no subject was downloaded before the start of the voting dwNrOfPresent Total number of delegates which are present for the voting round Range 0 DBSC MAX DELEGATE dwNrOfNot Voted Total number of delegates which have not voted yet For the record these delegates are present for the voting So dwNrOfNotVoted lt dwNrO
84. 0 RESTART 134 8 2 2 7 VT DOWNLOAD 5 134 8 2 2 8 SET 135 8 2 2 9 C SET GLOBAL 5 137 9 2 2 40 VT C GET RESULTS diii hd td inet eret aput ede dead 139 8 2 2 11 VT C GET ATTENTION 139 8 2 2 12 VT C SET ATTENTION 140 8 2 2 13 VT C START ATTENTION 140 Bosch Security Systems 2014 July 8 3 Update Notifications 141 8 34 Introduction 141 8 3 2 Notification item explanation l 141 8 3 2 1 Unit User Event relations 141 8 3 3 Voting notifications nennen nennen ener rennen 141 8 3 3 1 VT C RESULTSNOT EY itr itte nne Ee ERR CERERI Een ted 141 9 Attendance Registration and Access 143 9 1 Internal functioning of Attendance registration u 143 Meise 143 9 1 1 1 Attendance registration U 143 9 1 1 2 Access trier rn eren e Len Cu ne Penn Ee 143 9 1 1 3 Delegate
85. 014 July 44 DCNC UNIT FLUSH DEL NODISPLAY DCNC UNIT INTERPRETER When called during the installation mode SI C GLOBAL INSTALL MODE the microphone of the unit will be turned on as long as the unit is selected Availability This function is available in CCU system modes config and congress Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wUnitId BOOLEAN bSelectOn SI SELECT UNIT where wUnitld The unit identifier of the unit selected bSelectOn TRUE All LED s of the unit will be flashing FALSE All LED s of the unit will be off Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E INVALID UNITTYPE SI E WRONG PARAMETER SI E NO UNIT SELECTED Related functions SI C START INSTALL SI C STOP INSTALL 3 5 5 SI C SET MASTER VOL Purpose Sets the master audio volume The audio volume of the delegate loudspeakers lineout and rec out can be changed Availability This function is available in CCU system modes config and congress Parameter structure for the function WORD wMaster Volume where wMasterVolume The new overall volume setting for the system A number in the range 0 25 default DEFAULT MASTERVOLUME In this range a zero value means mute all delegate loudspeakers The values 1 up until 25 correspond with an audio am
86. 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 SPEAKERS 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 Bosch Security Systems 2014 July Microphone Management Error code Value Explanation 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 MM E NOT IN CONTROL 50 The remote function is not allowed because this remote controller has no control over the microphone management application MM E ILLEGAL ATTENTION TONE 54 The attention tone parameter has an illegal value Camera Control Error code Value hex Explanation CC E NOERROR 0 0x00 The execution of the remote function was successful CC E INCONTROL THIS CHANNEL 5377 0x1501 The CC a
87. 10406 0x28A6 Update failed because the card code is changed DB E UPD DEL UNIT IN USE 10407 0x28A7 Update of database failed because someone else is already using the proposed default seat DB E PENDING REQUEST 10408 0x28A8 Setting updating the Delegate Database failed because a delegate with a pending Request to Speak was tried to delete from the database Bosch Security Systems 2014 July Database Query Services Error code Value hex Explanation DB E DELEGATE DATA BLOCKED 10409 0x28A9 Updating the delegate database with the current DB T PERDELEGATE structure failed DB E NO DATABASE 10410 0x28AA The use of function C APPLY ONE is not possible because currently there is no database present in the CCU DB E APP NOT STARTED 10411 0x28AB The remote controller has not called the DB START APP yet Therefore any remote function call to access the database fails with this error DB E INCONTROL THIS CHANNEL 10412 0x28AC The database is already under control by this remote controller on the same channel Probably you have called the DB C START APP function twice DB E INCONTROL OTHER CHANNEL 10413 0x28AD The DB C START APP function could not finish successfully because the database is already controlled by another remote controller using another channel DB E ILLEGAL CONTROL TYPE 10414 0x28AE The control type passed to the function C START APP is not within range of valid valu
88. 2014 July covering its position FALSE Camera override mode is de activated meaning the camera of a newly switched on microphone is only activated when the current microphone is switched off Specifies the camera movement time in unit half a second To hide camera movement as a preposition camera moves from one position to the next the overview camera can be activated and displayed during the movement This parameter specifies the period for which the camera movement is hidden This parameter can have value 0 254 i e 0 127 seconds If this parameter has value 255 the error CC E INVALID PARAMETER is returned but only when wCameraControlType is equal to CC C ALLEGIANT VIDEO SWITCHER in all other cases the value of byMovementTime is not used Specifies the number of audience monitors that must show the images coming from the active camera if applicable This number is excluding the operator monitor This parameter can have value 1 4 If it has another value the error CC E INVALID PARAMETER is returned but only when wCameraControlType is equal to CC_C_ALLEGIANT_VIDEO_SWITCHER in all other cases the value of byMovementTime is not used Defines the seat text mode if applicable which defines what text is shown on the audience monitors and the operator monitors Refer to USERDOC_CC for details The mode can be one of the following e CC C SCREEN LINE The screenline as defined in the Delegate Database software is
89. 28 typedef struct WORD wUnitId BYTE byUnitType WORD wUnitProperties SC T UNIT DATA PROPERTY where wNumberOfSlaveCCUs The number of Slave CCU s connected within a Multi CCU system which ranges from 0 to 16 In case of a Single CCU System this number will be zero wNumberOfUnitsConnected wNumberOfUnits tUnitData w Unitld byUnitType Bosch Security Systems 2014 July The actual number of units present in the system even if the total number is larger than the maximum size of the tUnitData array wNumberOfUnitsConnected ranges from 0 to DBSC MAX ACT UNIT When there are more units than the size of the tUnitData structure the structure is completely filled and the unit data for the other units must be queried by using another clusterindex This number will be the same for all clusters requested The number of units present in the tUnitData array Only this amount of array elements is transmitted This number will be limited to the upper bound of the tUnitData array size Array holding the unit information of each unit Each array element is defined as a SC T UNIT DATA structure The elements of this structure are described below The unit identifier of a unit Also called unit number The type of the unit which is on of the following DCNC UNIT VOTING DCNC UNIT INTEGRUSA DCNC UNIT INTEGRUSS8 DCNC UNIT INTEGRUS16 DCNC UNIT INTEGRUS32 DCNC UNIT DATA COMM DCNC UNIT NG
90. 3 CCU System modes Per function is specificated what system modes are supported 3 2 System Configuration SC Functions 3 3 Introduction The system configuration functions described in this section are needed to query the set up of the DCN NG system from the CCU The system configuration functions allow the remote controller to monitor any changes in the DCN NG system configuration This chapter defines the set of remote functions for system configuration Bosch Security Systems 2014 July 24 3 3 1 SC C CHECK LINK Purpose Function which does no execution on the CCU This function is to check the communication link between the CCU and the remote controller When executed the function returns immediately Therefore quickly returning SC E NOERROR to the remote controller when there is a connection Availability This function is available in CCU system mode s init maintenance config and congress Parameter structure for the function The function has no additional parameters Response structure from the function The function has no response parameters Error codes SC E NOERROR 3 3 2 5 START APP Purpose Indicates the CCU that the remote controller wants update notifications from the SC 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 send update notifications to the remote con
91. A 1 TCP IP port setting DCN CCU sinn enne nnns 176 Appendix B Values of the defines J l esses 177 B 1 Defines sorted on application u la Suatu AE ERS A 177 B 2 Defines sorted on alphabet U Ua R aaa qasaq dana kaqa saka 200 Appendix G Error CodeS sspe i 221 Appendix D Examples S searr l l A y cedet eee tente t cete dette 230 D 1 System Configuration esses entente innen nnns a 230 0 1 1 Assigning seats using global installation e 230 0 1 2 Replacing defective units during operation 231 D 2 Microphone Ma agermmeni r u u l T Qk a ennt iq 232 0 2 1 Microphone Management Control n s a 232 0 3 Camera Gontrol zu idee tei de Dae prega ce bte hkias sau loea pa ei 234 0 3 1 Controlling CC application nnne 234 0 4 Simultaneous Interpretation 236 0 4 1 Simultaneous Interpretation Control 236 BE moon ade uy 238 0 5 1 Running a vote round without update notifications 239 0 6 Attendance Registration and Access Control a 242 0
92. ANNELLANG DBSC MAX INTERPRT CHANNEL where byBetweenLock Interlock mode between booths which can be one of the following values e C NONEMODE e C OVERRIDE e IN C INTERLOCK e IN C OVERRIDE ON B ONLY byWithinLock Interlock mode within a booth see byBetweenLock for the possible values except for the IN C OVERRIDE ON B ONLY interlock mode byMaxChans The number of assigned channels Range 1 DBSC MAX INTERPRT CHANNEL wVerLangList Version of the language list This can be one of the following constants IN C ENG LANG LIST ID standard English list IN C FR LANG LIST ID standard French list IN C ORG LANG LIST ID original language list IN C CUS LANG LIST 1 ID custom language list 1 IN C CUS LANG LIST 2 ID custom language list 2 IN C CUS LANG LIST 3 ID custom language list 3 tChanLang Array with language per channel Only the first byMaxChans values of this array are useful the rest of the elements hold the default value IN DEF LANG If the channel languages have been set using IN C CHANNEL UPDATE see 7 2 3 10 the channel languages shown in this array are equal to the values passed in IN C CHANNEL UPDATE E g if the channel language 1 was passed for channel 1 in IN C CHANNEL UPDATE tChannelLang 0 1 channel language 1 will also be shown for channel 1 in this structure tChanLang 0 1 Range 1 DBSC MAX LANGNAME 7 3 2 3 IN C FLASHING MIC ON Purpose Notifies the remote
93. AULT define DEFAULT MASTERVOLUME 12 define DB C NOPIN 0 define DB C NO CARD 0 define UNASSIGNED UNIT OxFFFF define MAX IND CHANNEL 26 define 50 C DCN CCU 1 define SC C DCN CCUB 2 define SC C DCN CCU2 3 define SC C DCN CCUB2 4 define 56 C STANDALONE 0x01 define SC C EXTENDED 0x02 define SC C SINGLETRUNC 0x04 define SC C MULTITRUNC 0x08 define 50 C MASTER 0x10 define SC C SLAVE 0x20 define SI C GLOBAL INSTALL MODE 1 define SI C OPERATIONAL INSTALL MODE define DB C CONTROL 1 define SC C MAX HARDWARE INFO 50 define SC C CLUSTER MAX 1500 define SC C MAX SOFTWARE INFO 29 define SC C MAX VERSION LENGTH 50 define DB C MAX N DL DEL REC 50 Bosch Security Systems 2014 July en 183 DCN Next Generation Open Interface Release 4 4 en 184 define VERSION C LENGTH 11 def ine CARD CODE 999999999 define MAX VOTE WEIGTH 99999999 Hdefine DCNC SM DOWN 0 define DCNC SM INIT 1 define DCNC_SM_CONFIG 2 define DCNC_SM_CONGRESS 3 define DCNC_SM_MAINTENANCE 4 define DCNC_SM_DOWNLOAD 5 define TRUE 1 define FALSE 0 define DCNC_HAS MIC 0 0001 define DCNC_HAS_AUX 0 0002 define DCNC_HAS_KEYS 0 0004 def ine DCNC_HAS CARD 0 0008 define DCNC_HAS DISPLAY 0 0010 define 5 GRAPHICAL DISPLAY 0x0020 define HAS INTERCOM 0 0040 define X DCNC HAS EXTERNAL 0 0080 define HAS BOOTH DESK 0x0100 define DCNC HAS
94. C APP SI DCNC APP SI DCNC APP SI DCNC APP SI DONC APP SI DCNC APP 51 DONC APP SI DCNC APP SI DONC APP SI DCNC APP SI MKWORD 30 DCNC APP 51 MKWORD 31 DCNC APP ST MKWORD 32 DCNC APP 51 MKWORD 33 DCNC APP 51 MKWORD 34 DCNC APP 51 en 179 DCN Next Generation Open Interface Release 4 4 en 180 define SI C FRAUD 2 Defines for Options field in Wap settings define WAP ENABLE LANGUAGE DISTRIBUTION 0x01 def ine WAP ENABLE ENCRYPTION 0x02 Defines for wireless carrier band define 51 C CARRIER BAND 1 0 define 51 C CARRIER BAND 2 1 define 51 C CARRIER BAND 3 2 Defines for wireless power level define SI C POWERLEVEL OFF 0 define SI C POWERLEVEL LOW 1 define 51 C POWERLEVEL MEDIUM 2 define SI C POWERLEVEL HIGH 3 Defines for network mode define SI 0 NETWORK MODE ON 0 define 51 C NETWORK MODE SLEEP 1 define SI C NETWORK MODE OFF 2 define 51 C NETWORK MODE SUBSCRIPTION 3 define DBSC MAX ACT UNIT 512 SCCU system define 0880 MAX DELEGATE DBSC MAX ACT UNIT Hdefine DBSC_NCHAR_SCREENLINE 33 define DCNC_TYPE_DELEGATE 0x00 define DCNC_TYPE_CHAIRMAN 0x10 define DCNC_SUBTYPE_CONCENTUS 0x00 define DCNC_SUBTYPE_FLUSH 0x01 define DCNC_SUBTYPE_FLUSH_DUAL 0 02 define DCNC_SUBTYPE_DISC 0x03 def ine SUBTYPE DISC DUAL 0x04 Bosch Security Systems 2014 July DCN Next Generation Open Inter
95. CCU that the remote controller no longer requires to communicate with the IN application inside the CCU After receiving this function the CCU takes over the control of IN The remote controller will no longer receive update notifications Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure WORD wNrOf Instances where wNrOfinstances Error codes returned IN E NOERROR IN E NOT IN CONTROL Related functions IN C START IN APP 7 2 3 41 C START MON IN Purpose The value of the update use count for the IN application at the end of the function handling It contains the number of times a remote controller is connected over the same communication medium E g when there is only one connection registered for the IN application prior to calling the IN STOP IN APP function the value of wNrOfInstances will be 0 when the function returns Note that calling IN C STOP MON IN will also decrease this update use count Function to start the monitoring behavior of the Simultaneous Interpretation application It is not allowed possible to control settings of Simultaneous Interpretation Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure WORD wNrOf Instances where wNrOfInstances Bosch Security Systems
96. CE 0 4000 DCNC HAS NEED FOR CARD SETTINGS 0x8000 DCNC HAS QUALITY LEVEL 0 1000 For wireless units DCNC HAS SPEAKSLOWLY 0x0400 Typedef char LCD TEXT BLOCK DCNC MAX LCD LINES DCNC MAX DISP CHARS define DCNC_MAX_DISP_CHARS 41 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine DCNC MAX DISPLAYDATA SIZE 512 DCNC MAX IND CHANNEL DCNC MAX LCD LINES 5 26 DCNC MICROPHONE GAIN DEFAULT DCNC SM CONFIG 2 DCNC SM CONGRESS 3 DCNC SM DOWN 0 DCNC SM DOWNLOAD 5 DCNC SM INIT 1 DCNC SM MAINTENANCE 4 DCNC SUBTYPE 16CHANNEL DCNC SUBTYPE 32CHANNEL DCNC SUBTYPE A4CHANNEL DCNC SUBTYPE 8CHANNEL DCNC SUBTYPE AAEX 0 01 DCNC SUBTYPE ACTIVE DDB DCNC SUBTYPE CIN 0x03 DCNC SUBTYPE CONCENTUS DCNC SUBTYPE DAEX 0x02 DCNC SUBTYPE DESK 0x00 DCNC SUBTYPE DISC 0x03 DCNC SUBTYPE DISC DUAL DCNC SUBTYPE FLUSH 0x01 DCNC SUBTYPE FLUSH DUAL DCNC SUBTYPE PASSIVE DCNC SUBTYPE PASSIVE DDB Bosch Security Systems 2014 July 0x03 0x04 0x01 0x02 0x01 0x00 0x04 0x02 0x00 0x00 en 205 DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine
97. COMING CALL e UPD OPERATOR STATE Put down the hook on The following notifications are sent 5 ae me e UPD AVAILABLE LINES e UPD OPERATOR STATE Operator picks up the The following notifications are sent MOOR e UPD AVAILABLE LINES e UPD OPERATOR STATE Operator puts down The following notifications are sent the hook UPD AVAILABLE LINES e UPD OPERATOR STATE 12 3 2 Intercom notifications 12 3 2 1 AVAILABLE LINES Notifies the remote controller about the number of lines that are available for intercom Notify structure with this update The update comes with the following structure BYTE byLines where byLines The number of available intercom lines 12 3 2 21 UPD OPERATOR STATE Purpose Notifies the remote controller about the state of the operator Notify structure with this update The update comes with the following structure BYTE byState where byState The state of the operator This can be one of the following Bosch Security Systems 2014 July en 175 values e C C NOT PRESENT e C C IDLE e 1 C NO OPER e C C CONNECTED e CONN BREAK e C C NO e RECEIVING e C C DIALING e C RETURN 12 3 2 3 UPD CONNECTION INFO Purpose Notifies the remote controller that there is a change in the intercom connections Notify structure with this update The update comes with the fol
98. CU system DBSC MAX ACT UNIT 576 DBSC MAX CAMERA 256 DBSC MAX DELCR 5 DBSC MAX DELCS 1 DBSC MAX DELEGATE DBSC MAX ACT UNIT DBSC MAX DELEGATE 4000 Multi CCU System DBSC MAX DELRTS 100 DBSC MAX DESK PER BOOTH DBSC MAX INTBOOTH 31 6 DBSC MAX INTERPRT CHANNEL 31 DBSC MAX INTSEAT DBSC MAX LANGNAME 53 DBSC MAX NOTEBOOKLIST DBSC MAX PREPOSITION DBSC MAX SPEAKERLIST DBSC MAX UNIT 576 DBSC NCHAR LANGABBR 4 DBSC NCHAR LANGNAME 13 DBSC NCHAR SCREENLINE DBSC NCHAR SCREENLINE DCNC APP CC 21 DCNC APP DB 3 Bosch Security Systems 2014 July DBSC MAX INTBOOTH DBSC MAX DESK PER BOOTH 15 99 4 33 33 DCN Next Generation Open Interface Release 4 4 en 204 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine DONC APP 1 7 DCNC APP 2 DONC APP ID 12 DCNC APP MD 10 DCNC APP SC 16 DCNC APP SI 17 DONC APP VT 1 DCNC DEFAULT MASTERVOLUME 12 DCNC HAS AUX 0 0002 DCNC HAS BATTERY 0 0800 For wireless units DCNC HAS BOOTH DESK 0x0100 DCNC HAS CARD 0 0008 DCNC HAS DATACHANNEL SUPPORT 0x2000 DCNC HAS DISPLAY 0 0010 DCNC HAS EXTERNAL 0 0080 DCNC HAS GRAPHICAL DISPLAY 0x0020 DCNC HAS HELP 0 0200 DCNC HAS INTERCOM 0 0040 DCNC HAS KEYS 0 0004 DCNC HAS MIC 0 0001 DCNC HAS MOST INTERFA
99. D DB E UPDATE DELEGATE FAILED DB E DELEGATE DATA BLOCKED DB E PENDING REQUEST DB E APP NOT STARTED DB E WRONG PARAMETER DB E NOT INCONTROL Related functions DB C START APP DB C MAINT CCU DB C CLEAR CCU DB C CCU APPLY ONE 4 2 5 DB C CLEAR CCU Purpose This function clears the delegate database in the CCU Availability This function is available in CCU system mode congress As with C this function returns the error DB E DELEGATE DATA BLOCKED if another application is currently using the delegate database in the CCU 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 DB E NOERROR DB E DELEGATE DATA BLOCKED DB E PENDING REQUEST DB E APP NOT STARTED DB E NOT INCONTROL Bosch Security Systems 2014 July 62 Related functions DB C START APP DB C MAINT CCU DB C DOWNLOAD CCU DB C CCU APPLY ONE 4 2 6 DB C CCU APPLY ONE Purpose With this function it is possible to add or update just one record in the delegate database in the CCU Note that using this function you can only add or update a record of an existing database on the CCU You cannot create a database using this function The delegateld as present in the structure is used to determine if the record will be added or updated e When the delegateld is not present in the databas
100. DCNC SUBTYPE CONCENTUS DONC UNIT 2000 CHAIRMAN DCNC TYPE CHAIRMAN DCNC SUBTYPE CONCENTUS def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine DCNC UNIT AUDIO 10 DCNC TYPE INTERPRETER DCNC SUBTYPE AAEX DCNC UNIT AUDIO IO DIGITAL DCNC TYPE INTERPRETER DCNC SUBTYPE DAEX DCNC UNIT COBRANET DCNC TYPE INTERPRETER DCNC SUBTYPE CIN DONC UNIT DISC DELEGATE DCNC TYPE DELEGATE DCNC SUBTYPE 0150 DCNC UNIT DISC DELEGATE DUAL DCNC DELEGATE DCNC SUBTYPE DISC DUAL DONC UNIT DISC CHAIRMAN DCNC CHAIRMAN DCNC SUBTYPE DISC DCNC UNIT DUAL MIC DCNC TYPE DELEGATE DCNC SUBTYPE FLUSH DUAL DCNC UNIT FLUSH CHR NODISPLAY DCNC TYPE CHAIRMAN DCNC SUBTYPE FLUSH DCNC UNIT FLUSH DEL NODISPLAY DCNC TYPE DELEGATE DCNC SUBTYPE FLUSH DONC UNIT ENTRANCE DCNC TYPE ENTRANCE DCNC UNIT EXIT DONC TYPE EXIT DONC UNIT AMBIENT MIC DCNC TYPE AMBIENT DCNC VER ENGLISH DCNC VER FRENCH DCNC VER GERMAN DONC VER ITALIAN DONC VER SPANISH DCNC VER SIXTH 5 Bosch Security Systems 2014 July 0 1 2 3 4 Depending on downloaded OMF file DCN Next Generation Open Interface Release 4 4 define VER DEFAULT OxFF Unit uses Default language define MICROPHONE GAIN DEF
101. Data 0 up and until byData wLength 1 This parameter must be in the range 0 C MAX DATA LEN byData Array holding the actual data Only the first wLength items actually hold relevant information the rest can be ignored Response structure from the function The function has no response parameters Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 103 Error codes returned CC E NOERROR CC E INVALID PORT OUT Update notifications CC C RECEIVE DATA 6 3 Update Notifications 6 3 1 Introduction This chapter describes the various update notifications sent by the CCU All the update notifications of the CC application are listed in this chapter 6 3 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 Bosch Security Systems 2014 July en 104 6 3 1 2 Unit user event relations As mentioned in section 5 1 1 update notifications are not only the result of remote functions generated by the remote controller but can also be the result of interpreter unit user events It was also mentioned in section 5 1 1 that the relation between the unit user events and the update notifications is indirect i e asynchronous This section gives informatio
102. Defines sorted on application H define MDSC 2 Hdefine X MDSC REMOTEPROCEDURE REQ 3 Hdefine X MDSC REMOTEPROCEDURE RSP 4 Hdefine X MDSC NOTIFY 5 Hdefine COMMUNICATION PARAMS 15 Hdefine SET COMMUNICATION PARAMS 0x0001 Hdefine COMMUNICATION PARAMS 0x0002 define MKWORD LSB MSB WORD WORD MSB lt lt 8 WORD LSB Hdefine MESSAGETYPE_OIP_KeepAlive 0x00447027 define OIP ResponseProtocolError 0x00447020 Hdefine DCNC APP DB 3 Hdefine DCNC APP SI 17 Hdefine DCNC_APP_SC 16 Hdefine DB C START APP MKWORD 1 DCNC APP DB Hdefine DB C STOP APP MKWORD 2 DCNC APP DB Hdefine DB C MAINT CCU MKWORD 3 DCNC APP DB Hdefine DB C CLEAR CCU MKWORD 4 DCNC APP DB Hdefine DB C CCU APPLY ONE MKWORD 5 DCNC APP DB Hdefine DB C DOWNLOAD CCU MKWORD 6 DCNC APP DB Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 178 Hdefine SC C GET CCU VERSIONINFO 6 DCNC APP SC define SC C START APP MKWORD 7 DCNC APP SC Hdefine 50 C STOP APP MKWORD 8 DCNC APP SC Hdefine 50 C CONNECT UNIT 9 DCNC APP SC define 50 C DISCONNECT UNIT MKWORD 10 DONC APP SC define 50 C GET CCU CONFIG MKWORD 12 DCNC APP SC define 50 C CONNECT SLAVE CCU MKWORD 13 DONC APP SC define 50 C DISCONNECT SLAVE 14 DONC APP SC define 50 C CCU REBOOT MKWORD 15 DCNC
103. E INCONTROL OTHER CHANNEL Another remote controller has control over the LD application report error and terminate case LD E NOERROR function ended succesfully break default some unexpected error occurred report the error Bosch Security Systems 2014 July We have now established communication with the LD application on the CCU Since controlling has now started update notifications may arrive Therefore we need the following functions void LD SendAnumData LD T DISPLAY DATA ptDisplayData Handle data of ptDisplayData Assume that we want to store display settings of LD_C_DISPLAY_TWO We then need the following functions and control flow LD T DISPLAY REC tSettings tSettings wDisplayId LD C DISPLAY TWO Enable VT and MM application tSettings wFlags LD C VT FLAG DISPLAY LD C MM FLAG DISPLAY tSettings wNrOfSpeakerLines 4 tSettings wNrOfRequestLines 6 WORD wError wError LD StoreDisplaySettings amp tSettings if wError LD E NOERROR switch wError case LD E APP NOT STARTED Application not started handle error break case LD E UNKNOWN DISPLAY Incorrect display handle error break case LD E WRONG PARAMETER Incorrect parameter handle error break case LD E LINES OVERFLOW wNrOfSpeakerLines wNrOfRequestLines gt LD C MAX NUMBER OF DISPLAY LINES break default Handle unknown error
104. ECT_UNIT Recommended before continuing CCU SI C START INSTALL and run installation as described examole 2 in Appendix D Disconnect a unit from a SC C DISCONNECT UNIT Slave CCU Connect a unit to another None Single Mode CCU Disconnect a unit from lt None gt another Single Mode CCU Bosch Security Systems 2014 July en 37 3 4 2 SC C CCU REBOOT Purpose Notifies the remote controller that the CCU has restarted This notification is always send at start up of the CCU and is the only notification message send by the CCU till the update request function SC C START APP is executed This notification should be monitored to detect a restart of the CCU The remote controller should take appropriate actions to restore the settings Notify structure with this update The update comes with the same structure as used for the response of the remote function SC C GET CCU VERSIONINFO section 3 3 4 3 4 3 SC C CONNECT UNIT Purpose Notifies the remote controller that a new unit has connected to the CCU The remote controller can use this notification to add this unit to its functionality Notify structure with this update The update uses the following structure SC T UNIT DATA tUnitData where tUnitData Information about the unit that is connected The elements present in the structure are defined in section 3 3 5 3 4 4 5 DISCONNECT UNIT Purpose Notifies the remote controller that
105. Error VT StopApp no parameters If wError VT_E_NOERROR do error handling D 6 Attendance Registration and Access Control In the examples below the remote functions and update notifications that are defined in this document as constant values for the wFnld parameter of the message see chapter 2 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 the required input parameter 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 some _ and using mixed case names For example remote function AT_C_STORE_SETTING shall be referenced as function AT_StoreSetting amp tSettings D 6 1 Using Attendance Registration and Access Control This example shows how the remote controller can perform attendance registration with the entrance and exit units by using ID Cards For this example we have defined the following DCN NG system e Aconference hall equipped with delegate units without ID card readers e Entrance and Exit units are present e The seat assignment has been done by the remote controller e A delegate database i
106. FF 2 MM C PC PRIO NONE 3 Defines for MM notebook MM C VIP CHAIRMAN 1 define Bosch Security Systems 2014 July MKWORD 52 DCNC_APP_MM MKWORD 53 DCNC APP MM 64 DONC APP MM 65 DONC APP MM 66 DONC APP MM 67 DONC APP MM 68 DONC APP MKWORD 69 DCNC APP MM MKWORD 70 DCNC APP MM MKWORD 32 DCNC APP MM MKWORD 33 DCNC APP MM Chairman C APP MM en 187 DCN Next Generation Open Interface Release 4 4 en 188 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine define def ine def ine def ine MM C VIP KEY 2 Delegate set as Button Activated MM C VIP OPERATOR 3 Delegate set as Operator activated MM C VIP VOICE 4 Delegate set as Voice activated MM C VIP VCHAIR 5 MM C CHAIRMAN NO AC 6 Chairman set as Voice activated Chairman exclude from Access Control MM C KEY NO AC 7 Button Activated Delegate excluded from Access Control MM C OPERATOR NO AC 8 MM C VOICE NO AC 9 MM C VCHAIR NO 10 C VIP PTTCHAIRMAN Operator Activated Delegate excluded from Access Control Voice Activated Delegate excluded from Access Control Voice Activated Chairman excluded from Access Control 11 Chairman as push to t
107. 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 e g remote function SC C CONNECT UNIT shall be referenced as function as SC Connect Unit SC T UNIT DATA tUnitData D 1 1 Assigning seats using global installation This example shows how the remote controller can assign his seats to the unit numbers present in the conference hall Assumed is that the conference hall has a number of seats numbered starting with 1 For this proposed installation one person must walk through the conference hall and press one of the soft keys on the units in order of the seats starting with seat 1 On each unit a soft key is only pressed once For this seat assignment the global installation mode of the CCU will be used Therefore we start with activating that mode error SI Start Install SI C GLOBAL INSTALL if error SI E NOERROR After this function the CCU is in global installation mode all displays are off and no applications are running do error handling We now initialize the current seat and unit number assuming seat numbers are chosen to be purely numeric wCurrentSeatNumber 1 The system is now ready to accept the ke
108. G LOAD INT DB iin ia a aede tn iaa aas 111 7 2 3 10 INC CHANNEL UPDATE tnnt Ett e rene her e Dee aeta 113 7 2 3 11 IN C DOWNLOAD LANGLIST sse 114 7 2 3 12 IN C SET FLASH 115 7 2 3 19 IN G SET FEOOR DIS sa erar rd iata coupure bee bees 116 7 2 3 14 IN FLOOR 116 7 2 3 15 IN SET SPEAKSLOWLY 116 7 2 3 16 IN SPEAKSLOWLY SIGN 117 7 2 8 47 IN G SET HELP u a unuq ote Pede pep 117 7 2 3 18 IN G GET HELP SIGN init ette err 118 1 2 3 19 IN C ASSIGN UNIT iini ttem ertet er ta 118 7 2 3 20 IN 5 119 7 3 Update Notifications ceiros ea qe rete ee HE Rec EHE 119 119 7 3 1 1 Update notification item 119 7 3 1 2 Unit user event 121 7 3 2 N General notifiCatioriS cu cero etie LER re toten ier Ee i 123 7 9 220 ING CHAN STATUS o Ere tae 123 7 3 2 2 ING GOU CONF IG Lu s dii od ameet 124 7 3 2 3 IN _C_FLASHING_MIC_ON 124 7 3 2 4 IN C FLOOR DISTRIBUTION sese 125 7 9 2 5 IN C LANGUAGE LIST eite ib et 125 7 3 2 6 IN SPEAKSLOWLY enne 126 7 3 2 7 IN G HELP SIGN rd eic a eee
109. HELP 0 0200 define DCNC_HAS_SPEAKSLOWLY 0x0400 define DCNC_HAS BATTERY 0 0800 For wireless units Hdefine DCNC_HAS_QUALITY_LEVEL 0 1000 For wireless units define DCNC HAS DATACHANNEL SUPPORT 0x2000 define DCNC_HAS MOST INTERFACE 0x4000 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 define HAS NEED FOR CA RD SETTINGS 0x8000 define KWORD Ib hb WORD WORD hb lt lt 8 WORD Ib define CNC_APP_MM 0 Hdefine C MICRO ON OFF Hdefine C CHAIR MICS ON Hdefine C TIMER ON OFF Hdefine C RTS SET ON PC MKWORD 1 APP MM MKWORD 2 APP MM MKWORD 3 APP MM MKWORD 4 APP MM def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine MM C RTS CLEAR ON PC MM C RTS REMOVE ON PC MM C RTS INSERT ON PC MM C ON PC MKWORD 5 DCNC APP MM MKWORD 6 DCNC APP MM MKWORD 7 DCNC APP MM MKWORD 8 APP MM MM C NBK SET ON PC MKWORD 9 DCNC APP MM MM C NBK CLEAR ON PC MM C NBK REMOVE ON PC MKWORD 10 APP MM MKWORD 11 APP MM MM C SPK SET ON PC MKWORD 12 DCNC_APP_MM MM C SPK CLEAR ON PC C SPK APPEND ON PC MM C SPK REMOVE ON PC C 5 INSERT ON PC MM C 5
110. I E NOERROR Related functions SI C SET EXT CONTACT 3 5 8 51 C SET MICROPHONE GAIN Purpose Adapts the microphone sensitivity of a unit Availability This function is available in CCU system modes config congress and maintenance Bosch Security Systems 2014 July 46 Parameter structure for the function WORD wUnitId WORD wGain where wUnitld The unit identifier of a unit Also called unit number wGain The microphone sensitivity gain setting for the unit in the range 0 15 The values 0 up until 15 correspond with a microphone sensitivity setting change of 6dB up until 9dB in steps of 1 dB The default value of the microphone sensitivity is DCNC MICROPHONE GAIN DEFAULT Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E WRONG PARAMETER SI E UNIT NOT FOUND SI E INVALID UNITTYPE Related functions SI C GET MICROPHONE GAIN Update notifications SI C MICROPHONE GAIN 3 5 9 SI C GET MICROPHONE GAIN Purpose Gets the microphone sensitivity of a unit Availability This function is available in CCU system modes config congress and maintenance Parameter structure for the function WORD wUnitId where wUnitld The unit identifier of a unit Also called unit number Response structure from the function WORD wGain where wGain The current microphone sensitivity gain setting for the unit in the range 0 15
111. INGS 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 e MM C DELEGATE WTH PUSHTOTALK For more information about the different modes see section 5 2 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 25 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 C OPERATOR WITH REQ LIST Bosch Security Systems 2014 July 71 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 implies that the remote controller can only turn off the micro only valid for the operation modes MM C OPERATOR WITH REQ LIST and MM C OPERATOR WITH COMMENT LIST wAttentionTone The following attention tones settings are available MM C ATTENTION OFF No attention is generated when the priority key is pressed
112. KWORD 13 DONC APP MM MKWORD 46 DCNC_APP def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine MM_C_SPK_APPEND C SPK APPEND ON PC MM C SPK CLEAR ON PC C SPK GET MM C SPK INSERT ON PC MM C SPK REMOVE MM C SPK REMOVE ON PC MM C SPK REPLACE ON PC MM C SPK SET ON PC MKWORD MM C START MON MM MM C STOP MM MM C STOP MON MM MKWORD MM C TIME FINISHED WARNING MM C TIMER ON OFF MKWORD MM C SET MAX RSP LIST LEN MM C GET MAX RSP LIST LEN MM C MAX RSP LIST LEN MM C VCHAIR NO 10 MM C VIP CHAIRMAN 1 MM C VIP KEY 2 MM C VIP OPERATOR 3 MM C VIP PIT 12 MM C VIP PTT NO AC 14 C VIP PTTCHAIRMAN MKWORD Bosch Security Systems 2014 July MM MM MKWORD 16 DONC APP MM MKWORD 49 DCNC APP MM MKWORD 15 DONC APP MM MKWORD 17 DONC APP MM 12 DCNC APP MM MM C START MM MKWORD 30 APP MM 69 DCNC APP MM MKWORD 31 DCNC APP MM 70 DCNC APP MM MKWORD 61 DCNC APP MM 3 DONC APP MM MKWORD 74 MKWORD 75 MKWORD 76 Voice Activated Chairman Chairman en 214 DCNC APP MM DCNC APP MM DCNC APP MM excluded from Access Control Delegate set as But
113. L Related functions CC C START CAMERA APP 6 2 2 3 CC C SET CAMERA ACTIVITY Purpose Indicates the CCU whether or not camera activity must be activated When activated the CCU transmits control commands to the connected camera equipment see USERDOC_CC If de activated the CCU does not transmit these control commands Parameter structure for the function The function requires the following structure as parameter typedef struct BOOLEAN bCameraActivity T CAMERA ACTIVITY where bCameraActivity TRUE Camera activity is activated FALSE Camera activity is de activated Response structure from the function The function has no response parameters Error codes returned CC E NOERROR CC E NOT IN CONTROL Update notifications CC C RECEIVE DATA 6 2 2 4 CC C SET GLOBAL SETTINGS Purpose Sets the global settings of the CC application Parameter structure for the function The function requires the following structure as parameter typedef struct BOOLEAN bCameraOverr ideMode BYTE byMovementT ime BYTE byNumOfAudi enceMon BYTE bySeatTextMode BYTE byCameraControlType T GLOBAL SETTINGS where bCameraOverrideMode TRUE Camera override mode is activated meaning a newly switched on microphone automatically activates the camera Bosch Security Systems 2014 July 98 byMovementTime byNumOfAudienceMon bySeatTextMode byCameraControlType Bosch Security Systems
114. LEAN bLedFollowMicLed 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 hold timer if one or more Chairman press their Prio button FALSE don t hold timer bShowRemainingTime TRUE down counting timer FALSE up counting timer bLedFollowMicLed TRUE the LED ring of the microphone follows the flashing microphone LED in the last minute of speech FALSE The LED ring does NOT follow the flashing mode of the microphone LED Response structure from the function This function has no response parameters Error codes returned MM E NOERROR Update notifications MM C TIMER ON OFF Related functions MM C LAST MINUTE WARNING MM C TIME FINISHED WARNING 5 2 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 Related functions MM C SET SPEECHTIME SETTINGS MM C TIME FINISHED WARNING 5 2 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 structu
115. LITY REQ is executed Notify structure with this update The update comes with the following structure BOOLEAN bBadSi gnal where bBadSignal TRUE Signal quality of the system is bad FALSE Signal quality of the system is ok 3 4 14 SC_C_UNIT_SIGNAL_QUALITY Purpose Notifies the remote controller of the quality of the signal of a unit This notification is send after the signal quality has been changed or after SC UNIT SIGNAL QUALITY REQ is executed Notify structure with this update The update comes with the following structure typedef struct UNITID tUnitId BOOLEAN bBadSignal SC T UNIT SIGNAL QUALITY where tUnitld The unit identifier of a unit bBadSignal TRUE Signal quality of the unit is bad FALSE Signal quality of the unit is ok 3 4 15 SC C LOW BATTERY Purpose Notifies the remote controller the overall battery status within the system This notification is send after the low battery has been changed or after SC C LOW BATTERY REQ is executed Notify structure with this update The update comes with the following structure BOOLEAN bLowBattery where bLowBattery TRUE At least one unit has a low battery status FALSE No units with a low battery status within the system 3 4 16 SC C ENCRYPTION ENABLED Purpose Notifies the remote controller of the current encryption enabled status of the wireless network This notification is send after the wireless encryption enabled status has b
116. LOCK DCNC MAX LCD LINES MAX DISP CHARS MKWORD Ib hb WORD CCOYORD hb lt lt 8 WORD 1b UNITID WORD DCNC APP IC 7 IC C START IC APP 1 DCNC_APP_IC IC C CLOSE IC APP MKWORD 2 DCNC_APP_IC IC C SET LINKS MKWORD 3 DCNC APP 10 IC C CLEAR LINKS MKWORD 5 DCNC_APP_IC IC UPD AVAILABLE LINES MKWORD 6 DCNC APP 10 IC UPD OPERATOR STATE MKWORD 7 DCNC APP 10 IC UPD CONNECTION INFO MKWORD 8 DCNC APP 1C IC UPD INCOMING CALL MKWORD 9 APP 10 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 define define def ine def ine def ine def ine def ine def ine def ine def ine def ine IC MAX LINKS IN RFC 512 IC C UNASSIGNED UNIT OxFFFF IC C NOT PRESENT 0 IC IDLE 1 IC 6 NO 2 IC C RETURN 5 IC C CONNECTED 6 IC C CONN BREAK 1 IC C NO REQ 8 IC C RECEIVING 9 IC 6 DAILING 10 B 2 Defines sorted on alphabet def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine ACSC EVENT INSERT CARD ENTRANCE 5 ACSC EVENT INSERT CARD EXIT 6 AT C ACTIVATE 0 0904 AT C ANY SEAT 1 AT C APP CONTROL 1 AT C APP MONITOR 2 C ATTEND 1 C ATTEND NOCHANGE 3 AT C ENTRANCE EXIT 2 AT C GET INDIV REGISTRATION 0x0906 C HANDLE IDENTIFICATION 0x0905 AT C IDCARD 2 AT C IDCARD PINCODE 3
117. MIC NONE wPriold Passes the prio status of the chairman unit This priority Bosch Security Systems 2014 July 89 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 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 i PC Chairman prio OFF with micro on MM C PC NONE MM C PC PRIO OFF Chairman prio ON with other prio on MM C PC ON MM C PC PRIO ON Chairman prio OFF with other prio on MM C MIC OFF MM C PC PRIO OFF 5 3 3 2 MM C 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 i Chairman prio ON with micro on MM_C_PC_MIC_NONE MM C PC PRIO ON i Note This notification is used to handle speech time correctly controlled by the DCNNG 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 foll
118. MM G CR REPLACE ON PCs reete ire uade qh 94 5 3 7 5 MM C LIST LEN 94 5 3 8 MM Speechtime notifications n nnne 94 5 3 8 1 MM C TIMER ON OFF nnne enne 94 GB Gamera Control PA MM 95 6 1 Introduction LEES 95 6 1 1 Remote Camera Control Control 95 0 2 Remote FUnCtlOnss eterne ettet erre tt a tee p vere erre yk bua TRAY Y cen 95 ejm M IMTOAUCTON EET 95 6 2 1 1 Remote function item 96 6 2 2 CC General functioris roseis od eee red e gie LE P nde dar ena 96 6 2 2 1 START 96 6 2 2 2 STOP CAMERA 96 6 2 2 3 C SET CAMERA 97 6 2 2 4 SET GLOBAL SETTINGS esee enne 97 6 2 2 5 C GET GLOBAL SETTINGS seen 99 6 2 2 6 C SET CAMERA ASSIGNMENT seen enne 99 6 2 2 7 CLEAR CAMERA 5 0 101 6 2 2 8 SET CAMERA 101 6 2 2 9 CLEAR CAMERA 5 102 6 2 2 10 SEND 0 080000 10 102 6 3 0
119. N C UPDATE LOCK Purpose This function changes both lock modes and the engaged Led indication The database is updated all microphones are turned off the unit in install mode will leave its installation menu and all configuration data is downloaded except for the language list If the slave configuration does not allow one of the interlock modes an error is returned Parameter structure for the function The function requires the following structure as parameter struct byWithin BYTE byBetween BOOLEAN bNormalEngaged hi where byWithin Interlock mode within a booth which can be one of the following values e IN_C_NONEMODE e C OVERRIDE e C INTERLOCK byBetween Interlock mode between booths see byWithin for the possible values Next to these the following interlock mode is also possible e C OVERRIDE ON B ONLY bNormalEngaged Engaged Led indication TRUE stands for normal mode If the microphone of an interpreter desk in a booth is switched on first desk the engaged LED of the output channel of the active desk will light up on all other interpreter desks of that booth FALSE stands for alternative mode In this case the engaged LED of the other interpreter desk in the booth will not light up It will be flashing when another interpreter desk in the booth also activates its microphone but this happens in normal mode too Response structure from the function The function has no response par
120. NC APP MM MM C RTS GET MKWORD 37 DCNC APP MM MM C RTS CLEAR MKWORD 38 APP MM MM C RTS REMOVE MKWORD 39 DCNC APP MM MM C RTS INSERT MKWORD 40 DCNC APP MM MM C NBK SET MKWORD 42 DCNC APP MM MM C NBK GET MKWORD 43 APP MM MM C NBK CLEAR MKWORD 44 DCNC APP MM MM C NBK REMOVE MKWORD 45 DCNC APP MM MM C SPK GET MKWORD 46 DCNC APP MM MM C SPK CLEAR MKWORD 47 DCNC APP MM MM C SPK APPEND MKWORD 48 APP MM Bosch Security Systems 2014 July en 186 DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine MM C SPK REMOVE MM C RTS APPEND MM C CR REMOVE C SHIFT CR MM C CR GET MM C CS REMOVE MM C CS GET MM C START MON MM MM C STOP MON MM MM C GET SETTINGS C SET SETTINGS MM C PC MIC ON 1 MM C PC MIC OFF MKWORD 49 DCNC APP MM MM C SET MIC OPER MODE MM C SET ACTIVE MICS MM C SET SPEECHTIME SETTINGS MKWORD 59 DCN MM C LAST MINUTE WARNING 60 APP MM MM C TIME FINISHED WARNING MKWORD 61 APP MM MKWORD 62 DCNC APP MM MKWORD MKWORD MKWORD MKWORD MKWORD MM C PC MIC 3 MM C PC _ ON MM C PC PRIO O
121. NES If it is out of this range the error LD E WRONG PARAMETER is returned Note that the added value of wNrOfSpeakerLines and wNrOfRequestLines may not exceed LD C MAX NUMBER OF DISPLAY LINES The error LD E LINES OVERFLOW is returned if this is detected dwReserved Reserved for possible future extensions Ignored at the moment may have any value Response structure from the function The function has no response parameters Error codes returned LD E NOERROR LD E APP NOT STARTED LD E UNKNOWN DISPLAY LD E WRONG PARAMETER LD E LINES OVERFLOW Update notifications LD C SEND ANUM DATA 10 2 2 4 LD C CLEAR DISPLAY NR Purpose This function clears the current request from the specified display If another request is available in the CCU it will automatically be shown If the specified display is an alphanumerical display the update notification LD SEND ANUM DATA may be sent Parameter structure for the function The function requires the following structure as parameter WORD wDisplayld where wDisplayld Identifies the display for which the current request is cleared This be one of the following see USERDOC 10 for details e LD C DISPLAY ONE The first display which is a numerical display e LD C DISPLAY TWO The second display which is an alphanumerical display e LD C DISPLAY THREE The third display which is an alphanumerical display e LD C DISPLAY FOUR The fourth display which is a graphic
122. NITTYPE 4353 0x1101 The selected unit represents no seat For example the entry exit unit and interpreter desks SI E ALREADY STARTED 4354 0x1102 Bosch Security Systems 2014 July System installation has already been started SI E NOT IN CONTROL 4355 0x1103 The remote function is not allowed because this remote controller has no control over the system installation SI E WRONG PARAMETER 4356 0x1104 The value of a parameter passed in a function call is invalid out of range SI E NO UNIT SELECTED 4357 0x1105 No unit has been selected SI E NO UNITS FOUND 4368 0x1110 There could not be found any unit SI E UNIT NOT FOUND 4371 0x1113 The unit does not exist Database Query Services Error code Value hex Explanation DB E NOERROR 0 0x00 The execution of the remote function was successful DB E SET PINSIZE FAILED 10401 0x28A1 Setting a new size for the PIN Code into the Delegate Database failed DB E DELEGATE LIST TOO BIG 10402 0x28A2 The wFillLevel parameter in DB C MAINT has a value larger then DB C MAX N DL DEL REC DB E INSERT DELEGATE FAILED 10403 0x28A3 Inserting the current T PERDELEGATE structure into the Delegate Database failed DB E UPDATE DELEGATE FAILED 10404 0x28A4 Updating the delegate database with the current DB T PERDELEGATE structure failed DB E UPD DEL PIN CHANGED 10405 0x28A5 Update failed because the PIN code changed DB E UPD DEL CARD CHANGED
123. 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 5 2 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 Bosch Security Systems 2014 July 79 must remain in the RTS list and while the card is 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 w Unitld 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 chapter 3 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
124. NotifiedLanguageList to tLanguageList bSpeakSlowlySign bNotifiedSpeakSlowl ySign bHelpSign bNotifiedHelpSign IN T UPDATE LCK tUpdateLck tUpdateLck wWithin WORD tCcuConf ig byWi thinLock tUpdateLck byBetween IN C OVERRIDE tUpdateLck bEngaged TRUE WORD wError IN Update Lck amp tUpdateLck if wError IN E NOERROR else do error handling update local administration tCcuConf ig byBetweenLock IN C OVERRIDE Once the settings are known we could wait for the updates to monitor the interpreter desks status updates or send remote functions to influence that status When we no longer need to be able to send remote functions and receive update notifications we can stop the communication with the IN application using the function wError IN Stop IN App amp wNrOf Instances if wError IN E NOERROR This ends remotely controlling the IN application Note that the value of wNrOflnstances can still be larger than 0 if there still are registered remote monitors do error handling D 5 Voting In the examples below the remote functions are seen as functions which can be called The parameters passed to the function form the input parameter structure When a function returns information the parameter list is finished with a structure parameter to store the information into Bosch Security Systems 2014 July For every function is
125. ORD 26 DCNC APP MM C CS GET MKWORD 68 DCNC APP MM MM C CS REMOVE MKWORD 67 DCNC APP MM MM C CS REMOVE ON PC MKWORD 28 DCNC APP MM MM C DELEGATE WITH OVERRIDE 2 MM C DELEGATE WITH PUSHTOTALK 5 MM C DELEGATE WITH REQ LIST 1 MM C DELEGATE WITH VOICE 3 MM C GET SETTINGS MKWORD 32 DCNC APP MM MM C GET SETTINGS MKWORD 32 DCNC APP MM MM C KEY NO AC 7 Button Activated Delegate excluded from Access Control MM C LAST MINUTE WARNING 60 APP MM C MICRO ON OFF MKWORD 1 DCNC APP MM MM C NBK CLEAR MKWORD 44 DCNC_APP_MM MM C NBK CLEAR ON PC MKWORD 10 APP MM MM C GET MKWORD 43 DCNC APP MM MM C NBK REMOVE MKWORD 45 APP MM MM C NBK REMOVE ON PC MKWORD 11 APP MM MM C NBK SET MKWORD 42 DCNC APP MM MM C NBK SET ON PC MKWORD 9 DCNC APP MM MM C OPERATOR NO AC 8 Operator Activated Delegate excluded from Access Control MM C OPERATOR WITH COMMENT LIST 4 MM C OPERATOR WITH REQ LIST 0 MM C PC MIC NONE 3 MM C PC MIC OFF 2 MM C PC MIC ON 1 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 213 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine de
126. OWERLEVEL MEDIUM2 SI 6 POWERLEVEL OFF 0 SC C REQ SERIAL NR MKWORD 53 DCNC APP SC SC C SERIAL NR MKWORD 56 DCNC APP SC SC C SET ENCRYPTION ENABLED MKWORD 63 DCNC APP SC SC C SIGNAL QUALITY MKWORD 47 DCNC APP SC SC C SIGNAL QUALITY REQ MKWORD 42 DCNC APP SC SC C SIGNAL STATUS MKWORD 46 DCNC APP SC SC C SIGNAL STATUS REQ MKWORD 41 DCNC APP SC SC C SINGLETRUNC 0x04 SC C SLAVE 0x20 SC C STANDALONE 0x01 SC C START APP MKWORD 7 DCNC APP SC SC C STOP APP MKWORD 8 DCNC APP SC SC C UNIT SIGNAL QUALITY MKWORD 58 DCNC APP SC SC C UNIT SIGNAL QUALITY REQ MKWORD 57 DCNC APP SC 51 DEINITIALIZE ALL MKWORD 30 DCNC APP 51 51 C FRAUD 2 Bosch Security Systems 2014 July en 216 DCN Next Generation Open Interface Release 4 4 def ine def ine define define define define define define define define define define define define define define define define define define define define define define define define define define define define 51 C GET EXT CONTACT MKWORD 14 DCNC APP 51 SI 0 GET MICROPHONE GAIN 16 DCNC APP SI 51 C GET NETWORK MODE MKWORD 22 DCNC APP 51 51 C GET OPERATION MODE MKWORD 31 DCNC APP ST 51 C GET WAP SETTINGS 51 C GET WIRELESS SETTINGS SI C GLOBAL INSTALL MODE 1 51 C MICROPHONE GAIN MKWORD 18 DCNC APP ST MKWORD
127. OfAnswerOptions This parameter is coupled to wVotingMenu and identifies how many answer options are available for the chosen voting menu The following table gives an overview of the valid range of answer options Menu answers range VT C MENU YES NO 2 VT C MENU YES NO ABSTAIN 3 VT C FOR AGAINST 2 VT AUDIENCE RESPONSE 5 VT C MENU 123 1 24 Bosch Security Systems 2014 July VT C MENU ABC 1 24 VT C MENU CBA 1 24 VT C MENU YES NO ABSTAIN NPPV 4 bOpenVoting Identify if individual results are available during the vote round Possible settings are TRUE Open voting Individual result can be collected by the remote controller All values of the parameter winterimResultType are valid FALSE Closed voting No individual results are available This implies that the individual values of the parameter winterimResultType are invalid winterimResultType Identify if results will be sent during the vote round and how If interim results are available then they will be sent regularly if the bResultNotify parameter of the VT START APP remote function is set to TRUE The setting is one of the following VT C INT RES NONE VT C INT RES TOTAL VT C INT RES INDIV VT C INT RES TOTAL PC ONLY VT C INT RES INDIV PC ONLY See table below for explanation about setting values bCompressedResults Identify if results will be sent in compressed f
128. PODUCHON ERES 23 92 50 OC CHECK LINK err 24 3 3 2 SG OG START APP va a cvi eterne retta dee nue exe dena Beale 24 3 3 9 9 G G STOP APP u a ate eir oer t Dad Yap Pe eque de ee 24 39 2 4 SC G GET VERSIONINFOQ 22 r reet tte tr tte etae 25 3 3 5 SC CONFIG lt deprecated gt b 26 3 3 6 5 GET CONFIG_PROPERTY a 27 3 9 7 SO G REQZSERIAL NR iiie aee ere HE e cba dne ET 29 3 3 8 5 C GET SLAVE NODES a 29 3 3 9 SC G GET UNIT IDS x het her Ear eas 30 3 3 40 5 BATTERY STATUS 31 3 3 11 5 BATTERY INFO huuu ha entere innen 31 3 3 12 86 C SIGNAL STATUS REQ ii mire ete ele inte terea 32 3 3 1386 G SIGNAL QUALITY dine ertet it ette 32 3 3 14 SC UNIT SIGNAL QUALITY 33 3 3 15 SC C LOW BATTERY REQ L un usya sisaqa 33 3 3 16 SC GET ENCRYPTION ENABLED senes 33 3 3 17 SC SET ENCRYPTION ENABLED eese 34 Bosch Security Systems 2014 July 3 4 System Configuration SC notifications sse 34 3 4 4 Introduction oin ei dace d agaist 34 3 4 1 1 Update Notification item
129. PONERLEVEL byPowerLevel BYTE byOptions SI T WAP SETTINGS where tUnild Reserved The unit identifier of a WAP Will be DCNC UNASSIGNED UNIT byCarrier The carrier of the WAP which is one of the following e SI C CARRIER BAND 1 e SI C CARRIER BAND 2 e SI C CARRIER BAND 3 byPowerLevel The coverage of the WAP which is one of the following e SI C POWERLEVEL OFF e SI C POWERLEVEL LOW e SI C POWERLEVEL MEDIUM e SI C POWERLEVEL HIGH byOptions The options field is at least equal to e WAP ENABLE LANGUAGE DISTRUBUTION Additionally the following value can be set when Wireless encryption is enabled e WAP ENABLE ENCRYPTION 3 6 6 SI C WIRELESS SETTINGS Purpose Notifies the remote controller the wireless settings of the system This notification is send after the wireless settings of the system has been changed Notify structure with this update The update comes with the following structure Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 57 typedef struct bySystemId BYTE byRepetitions SI T WIRELESS SETTINGS where bySystemld The system identifier Range 0 15 NOTE The system identifier is not only the wireless system identifier but the system identifier used throughout the entire system byRepetitions The number of repetitions within the wireless communication path Range 0 2 3 6 7 51 C NETWORK MODE Purpose Notifies the remote contro
130. RROR MM E UNIT NOT PRESENT Update notifications MM C CR REMOVE ON PC Related functions MM C CR GET Bosch Security Systems 2014 July 83 5 2 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 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 array element is defined as a MM T RTS structure which is defined in section 5 2 6 Error codes returned MM E NOERROR Related functions MM C RTS CLEAR COMMENT 5 2 7 3 MM C 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
131. 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 Bosch Security Systems 2014 July 93 5 3 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 structure 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 welegateId DBSC DELEGATE 5 3 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
132. S 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 5 2 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 from being added at the end of the normal RTS list Comment Requests are identified by the same MM T RTS structure as normal RTS entries Comment Requests show the same behavior in combination with access control and cards as normal RTS entries 5 2 7 1 MM 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 5 2 6 Response structure from the function The function has no response parameters Error codes returned MM E NOE
133. SIGNAL QUALITY o SC C UNIT SIGNAL QUALITY o SC C LOW BATTERY o SC C ENCRYPTION ENABLED o SI C GET WAP SETTINGS o SI C SET WAP SETTINGS o SI C GET WIRELESS SETTINGS o SI C SET WIRELESS SETTINGS o SI C GET NETWORK MODE o SI C SET NETWORK MODE o SI C UNSUBSCRIBE REQ o SI C START MON SI o SI C STOP MON SI o C UNASSIGN UNIT e Removed in DcnNg 4 0 o Support for DON CCU DCN CCUB DCN NCO Bosch Security Systems 2014 July e Changed in DenNg 4 0 o Definition of OIP DON MSGTYPE o SI C GET OPERATION MODE Value set of byStartupMode Translation of Startup Mode and Slave ld to multi mode standalone multi master multi slave and single Ccu o SI C SET OPERATION MODE Value set of byStartupMode Translation of Startup Mode and Slave ld to multi mode standalone multi master multi slave and single Ccu E 3 Changes with respect to DcnNg 2 68 e Added in DcnNg 4 0 o Support for DON CCU2 and DCN CCUB2 o SC C LOW BATTERY REQ o SC C LOW BATTERY o N C ASSIGN UNIT IN C UNASSIGN UNIT e Removed in DcnNg 4 0 o Support for DON CCU DCN CCUB DCN WCCU and DCN NCO e Changed in DenNg 4 0 o Definition of OIP DON MSGTYPE o SI C GET OPERATION MODE value set of byStartupMode o SI GET SYSTEM MODE renamed to SI C GET NETWORK MODE o SI SET SYSTEM MODE renamed to SI C SET NETWORK MODE o SI C GET OPERATION MODE Value set of byStartupMode Translation of Startup Mode and Slave ld to multi mode s
134. SIGNED UNIT wError IC Set links amp tLinks switch wError case IC E NOERROR links are set break case IC C WRONG PARAMETER do error handeling break default report error break Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 280 When the handset of unit 3 is picked up a call is made to unit 7 If unit 7 picks up the handset the call will be established and vice versa When unit 5 picks up its handset the operator will be called and not unit 2 On the other hand when unit 2 starts a call the call will be made to unit 5 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 Bosch Security Systems 2014 July APPENDIX E OPEN INTERFACE CHANGES IN DCNNG 4 2 E 1 Changes with respect to DcnNg 4 0 e Added in DcnNg 4 2 o SI C GET SYSTEM ID o SI C SET SYSTEM ID o SI C SYSTEM ID o MM C SET MAX RSP LIST LEN o GET RSP LIST LEN o LIST LEN E 2 Changes with respect to DcnNg 3 1 e Added in DcnNg 4 0 o Support for DON CCU2 and DCN CCUB2 o SC C BATTERY STATUS REQ o SC C BATTERY INFO REQ o SOC C SIGNAL STATUS REQ o SC C SIGNAL QUALITY REQ o SC C UNIT SIGNAL QUALITY REQ o SC C LOW BATTERY REQ o SC C GET ENCRYPTION ENABLED o SC C SET ENCRYPTION ENABLED o SC C BATTERY STATUS o SC C BATTERY INFO SERIAL o SC C BATTERY INFO CONDITION o SC C SIGNAL STATUS o SC C
135. SIINF AT E ACTIVATION NOT ALLOWED 2322 0x912 The settings made by the remote function AT C STORE SETTING are conflict with the activation or deactivation of attendance registration and or access control See chapter 9 for more information AT E ILLEGAL CONTROL TYPE 2333 0 91 The control type passed to the function AT C START AT APP is not within range of valid values see Appendix B Values of the defines for the correct control type values AT E ILLEGAL EVENT 2334 Ox91E The event type passed to the function AT C HANDLE IDENTIFICATION is not within range of valid values see Appendix B Values of the defines for the correct event values AT E ILLEGAL ARRAY SIZE 2335 Ox91F The fill level passed along with the function AT C HANDLE IDENTIFICATION exceeds the maximum array size Text amp Status Display Error code Value hex Explanation LD E NOERROR 0 0x00 Bosch Security Systems 2014 July Text amp Status Display Error code Value hex Explanation The execution of the remote function was successful LD E INCONTROL THIS CHANNEL 3074 0 02 The LD application is already controlled by this remote controller on the same channel Probably the LD START LD APP is called for the second time LD E INCONTROL OTHER CHANNEL 3075 0 03 The LD application is already controlled by another remote controller on another channel LD E UNKNOWN DISPLAY 3076 0 04 The display id passed in the remote function i
136. T 89 5 3 3 4 MM SPK CLEAR i enne 89 5 3 3 5 MM C SPK APPEND 90 5 3 3 6 MM C SPK REMOVE 90 5 3 3 7 MM_C_SPK_INSERT_ON_PC 90 5 3 3 8 MM C SPK REPLACE ON _PC 90 5 3 4 MM Comment Speaker list notifications sssssseeeeennen 91 5 3 4 1 C8 CLEAR ON 91 5 3 4 2 MM G CS ADD ON PG eerte uet ette i E aL theese end 91 5 3 4 3 MM CS REMOVE 91 5 3 5 MM Notebook list notifications u enne 91 5 3 5 1 MM C NBK REMOVE 91 5 3 5 2 MM_C_NBK_SET_ON_PC 92 5 3 6 MM Request to Speak list notifications 92 5 3 6 1 C RTS SET ON PG aaa aa aa aaa 92 5 3 6 2 MM C RTS CLEAR 92 5 3 6 3 MM C RTS REMOVE PG u a u naa D 92 5 3 6 4 MM RTS FIRST PO p a na naa 92 5 3 6 5 MM C RTS INSERT ON 93 5 3 6 6 MM C RTS REPLACE 93 5 3 7 MM Comment Request list 93 5 3 7 1 MM G CR CLEAR ON 220 50 iingie iaei a 93 5 3 7 2 MM CR ADD ON eder ee tine ente de eda ined e dee 93 5 3 7 3 MM C CR REMOVE ON 94 5 3 7 4
137. TID is defined as typedef WORD UNITID where dwfAutoSet byBetweenLock byWithinLock byMaxChans byChannels bNormalEngaged tDeskConf Bosch Security Systems 2014 July Autorelay flag The bits of this DWORD indicate which booths are autorelay booths The least significant bit stands for booth 1 If a bit is equal to 1 the corresponding booth is an autorelay booth Interlock mode between booths which can be one of the following values IN C NONEMODE IN C OVERRIDE IN C INTERLOCK IN C OVERRIDE ON B ONLY Interlock mode within a booth see byBetweenLock for the possible values except for the IN C OVERRIDE ON B ONLY interlock mode The number of assigned channels Range 1 DBSC MAX INTERPRT CHANNEL Array with language per channel Only the first byMaxChans values of this array are used Engaged Led indication TRUE stands for normal mode If the microphone of an interpreter desk in a booth is switched on first desk the engaged LED of the output channel of the active desk will light up on all other interpreter desks of that booth FALSE stands for alternative mode In this case the engaged LED of the other interpreter desk in the booth will not light up It will be flashing when another interpreter desk in the booth also activates its microphone but this happens in normal mode too Matrix holding the desk configuration Each matrix element is defined as an IN T DESKCONFIG structure that is de
138. TION Purpose Notify the remote controller the individual status of the delegates which de registers themselves The presence and location results will be sent every second if changes have been detected on the CCU Also the initial state directly after activation is sent to the remote controller using this notification The notification is sent to every controller who started the attendance registration application with AT START APP before Notify structure with this update The update comes with the same structure as used for the response of the remote function AT C GET INDIV REGISTRATION section 9 2 2 6 Note that only the changes are sent to the remote controller Related functions AT C STORE SETTING AT C ACTIVATE AT C HANDLE IDENTIFICATION 9 3 2 2 AT C SEND TOTAL REGISTRATION Purpose Notify the remote controller the total number of present and absent delegates This information will be sent every second by the CCU if changes have been detected on the CCU Also the initial totals directly after activation are sent to the remote controller using this notification These results will only be sent if attendance registration is activated Notify structure with this update The update comes with the following structure typedef struct WORD wAttend WORD wLeave AT T REGISTER TOTAL where wAttend Number of delegates who have registered themselves present wLeave Number of delegates who are known in
139. TOP MON MD function the value of wNrOfInstances will be 0 when the function returns 11 2 2 3 MD C SEND MESSAGE TO UNITS Purpose This function sends the message prepared on the Remote Controller to the specified list of units Parameter structure for the function The function has the following parameters typedef struct DONC LCD TEXT BLOCK tText WORD WORD WORD WORD MD T SEND MESS where tText wHcvType wDuration wNumoOfUnits wUnitList Bosch Security Systems 2014 July wRcvType wDuration wNum0fUnits wUnitList DBSC MAX ACT UNIT The message to be sent NOTE The fifth line is a terminating line and will not be displayed The type of units for which the message is meant This can be one of e MD C ROCV DELEGATE The message is meant for delegate units with LCD and softkeys The message is sent to units of this type that are present in wUnitList The message will not be displayed immediately e MD C ROV INTERPRETER The message is meant for interpreter desks The message will be sent to interpreter desks present in wUnitList and it will not be displayed immediately e MD C The message is meant for and will only be sent to hall displays Only for Hall displays The number of seconds the message should be displayed 0 to display permanently This parameter is ignored if wRcvType is not equal to MD C HALL The number of units present in wUnitList A l
140. TORE SETTING AT C ACTIVATE 9 2 2 6 AT C GET INDIV REGISTRATION Purpose This function allows the remote controller to retrieve the current registration status of each individual delegate The function is meant for remote controllers who called the function AT C START AT APP with AT C APP MONITOR as control type while attendance registration and or access control was already activated The function enables the remote controller to create his own start up status of the delegate registrations which is to be used to handle the registration changes send by the application specific update notifications Parameter structure for the function The function requires the following structure as parameter typedef struct Bosch Security Systems 2014 July en 154 155 WORD wC luster Index AT T GET REGISTRATION where wClusterlndex An index that indicates which cluster of delegate registration information is to be retrieved When wClusterlndex is O zero the response structure contains the first cluster with a maximum of AT C MAX DELEGATE of delegate registration information When wClusterlndex is 1 one the second cluster is returned etc Response structure from the function The function returns the following structure typedef struct WORD wFillLevel AT T DEL ATTEND tDelegate AT C MAX DELEGATE AT T REGISTER INDIV where the AT T DEL ATTEND is defined as typedef stru
141. TTENTION TONE 1 e VT C ATTENTION TONE 2 e VT C ATTENTION TONE 3 Response structure from the function The function has no response parameters Error codes returned VT E NOERROR VT E WRONG PARAMETER VT E APP NOT STARTED Related functions VT C GET ATTENTION TONE VT C START ATTENTION TONE 8 2 2 13 VT C START ATTENTION TONE Purpose This function allows the remote controller to start the voting attention tone The chime configured with VT C SET ATTENTION TONE will be played 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 VT E NOERROR VT E APP NOT STARTED Bosch Security Systems 2014 July Related functions VT C GET ATTENTION TONE VT C SET ATTENTION TONE 8 3 Update Notifications 8 3 1 Introduction This chapter describes the various update notifications send by the CCU All the update notifications of the VT application are listed in this chapter A global description of notifications is described in chapter 2 8 3 2 Notification item explanation Each 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 e Related functions The related function in conjunction with the notification described 8 3 2 1 Unit User Event relations The v
142. The function requires the following structure as parameter typedef struct WORD wNrOfUnits UNITID tUnitId DBSC MAX ACT UNIT SC T UNIT LIST where wNrOfUnits The number of unit list entries actual present in the tUnitld array Only this amount of array elements is transmitted This value never exceeds the constant DBSC MAX ACT UNIT tUnitld Array holding the list of unit ids Unitld 0x0000 will return the serial number of the master controller Response structure from the function The function has no response parameters Error codes returned SC E NOERROR SC E WRONG PARAMETER Update notifications SC C SERIAL NR 3 3 8 SC C GET SLAVE NODES Purpose Retrieve the slave nodes of a unit with the specified serial number The serial number can only be from the current master controller CCU or any slave CCU or WAP The current master controller returns a list of all serial numbers of all the directly attached units Bosch Security Systems 2014 July en 30 Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function DWORD dwSer ialNr where dwSerialNr The serial number of a unit of CCU type Response structure from the function The function returns the following structure typedef struct WORD wNrOfSer ialNrs DWORD dwSer ialNr DBSC MAX ACT UNIT SC T SERIAL NR LIST where wNrOfSerialNrs The number of slave node
143. The voting kind determines the kind of voting to run by the voting application The voting kind is controlled by the remote function VT C SET VOTINGPARAMS This remote function passes the kind of the voting e g parliamentary the number of answer options e g 3 the answer menu settings e g Yes Abstain No etc to the CCU More parameters to complete the identification of the voting kind must be passed to the CCU A complete list of parameters can be found at the remote function description in section 8 2 2 8 8 1 3 General Voting setting The general voting settings are mostly common for multiple voting rounds done over different kind of voting s These settings include settings like e Voting time limit Shows how many minutes and seconds the delegates have to complete their vote e Voting LED s Shows the vote done using the LED s on the delegate s unit or use one of the secret voting sequences available e First vote counts Informs that the first vote entered TRUE or the last vote entered FALSE by the delegate counts Detailed information about all the general voting settings can be found at the description for the remote function VT C SET GLOBAL SETTINGS section 8 2 2 9 8 1 4 Communication settings Not mentioned by the common aspects are the communication settings These settings are used to control how the communication of the results should take place The results can be sent to the remote controller using
144. Together with this remote interface there are up to two locations in a full connected CCU where MD can be influenced These locations are e A remote controller which can be the control PC connected using an Ethernet in case of MCCU or RS 232 in case of SCCU connection This remote controller uses Remote Function calls to configure Message Distribution e Delegate units on which the auxiliary button is pressed or interpreter desks on which the help or speak slowly key is pressed To get a fully operational system the remote controller must register itself to the CCU in order for it to receive update messages from the CCU 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 Events coming from a unit delegate or interpreter are processed and the CCU is updated Some of the events lead to update notifications The notifications are sent on by the CCU to the remote controller This document gives the set of MD Remote Functions and the set of Update Notifications concerning Message Distribution The relation between unit events and Update Notifications is given in section 11 3 1 2 11 2 Remote Functions 11 2 1 Introduction This chapter describes the various remote functions needed to use the Message Distribution functionality of the system 11 2 1 1 Remote function item explanation Each description consists of th
145. U depending on the various so called system modes This section gives a brief although complete description of these modes The CCU system as a whole is always running in one of the system modes Each application on the CCU has its own behavior in each system mode The purpose of the system mode is to have a clear division of functions and an easy way of separating them It should be impossible for instance to start the installation mode while the CCU is still booting i e the CCU is in the Init mode The following system modes are used Init One time mode after start up of the CCU The CCU can start with default data defined as cold start or with data the last time used so called warm start Config In this system mode the DCN NG configuration can be changed for instance installing units assigning seat numbers assigning audio channels etc Congress This is the normal system mode In this mode most applications will do their work for instance starting a voting round turning on a microphone interpreting etc Maintenance n this system mode the DCN NG system can be maintained for instance factory testing Download In this system mode new CCU software can be downloaded Down One time system mode just before shutdown of the CCU Figure 3 below gives an overview of possible system mode changes Congress Download Maintenance B Figure
146. YPE OIP 17 2 2 3 2 Format of type MESSAGETYPE OIP ResponseProtocolError 17 2 2 3 3 Format of type MESSAGETYPE OIP Don sese 18 2 3 Protocol description inet mete pee 19 2 3 1 Ethernet Protocol Description nennen nnnm enn 19 2 3 1 1 Open interface protocol L nnns 19 2 3 1 1 1 Set up a connection 19 2 9 5 1 2 Heartbeat cete eee et eerte 19 2 9 4 TMO Values ay atten o eerte 19 2 3 2 Remote function execution 19 2 3 3 Control flow with multiple remote controllers a 20 2 4 Remote Functioris aiat it ede a 20 2 4 1 Remote function handling UL E R nene nennen nnne nns 20 2 4 2 Simultaneous operation from Control PC and Remote Controller 21 3 SYSTEM CONFIGURATION AND SYSTEM INSTALLTION 22 3 4 E 22 Sl Remote T nctioris edo p ine et eere do et ae ea a 22 3 1 1 1 Remote function item explanation sene 22 3 1 2 System Modes eaten ne pae Pere rk Re eed e Pad 23 3 2 System Configuration SC Functions n n nanas 23 S S IMM
147. a unit has lost his connection with the CCU i e the unit is disconnected from the ACN trunk or MOST trunk This notification informs the remote controller that the unit is no longer available Notify structure with this update The update comes along with the same structure as defined in section 3 4 3 3 4 5 SC C CONNECT SLAVE CCU Purpose Notifies the remote controller that a slave CCU has connected to the master CCU Notify structure with this update The update comes with the following structure typedef struct bySlaveld WORD wFillLevel SC T UNIT DATA tConnectedUnits SC C CLUSTER MAX SC CONNECT where bySlaveld The identification number of the slave CCU involved wFillLevel The number of units present in the tConnectedUnits array Only this amount of array elements is transmitted tConnectedUnits A list of units that are connected to the slave in question This means that all units reported in the list are also connected Each list element is defined as a SC T UNIT DATA structure which is defined in section 3 3 5 Note Although the list is defined with C CLUSTER elements only the maximum number of units possible for Bosch Security Systems 2014 July 38 one slave will be transmitted Currently the wFillLevel parameter will always be zero Due to the nature of the units and the control flow used with the CCU slave and master each unit will conn
148. additional parameters Response structure from the function The function has no response parameters Error codes returned VT E NOERROR VT E VOTE RUNNING VT E APP NOT STARTED Update notifications VT C RESULTSNOTIFY Related functions VT C STOP VOTING VT C HOLD VOTING VT C RESTART VOTING 8 2 2 4 VT C STOP VOTING Purpose This function stops the running voting round Parameter structure for the function The function requires the following structure as parameter typedef struct BOOLEAN bShowResults VT T SHOW RESULTS where bShowResults Indicate if the voting results will be displayed on the unit LCD s This is only functioning if the results are sent to the remote controller only see remote function VT_C_SET_VOTINGPARAMS for details Possible values are TRUE The total result will be sent to all units LCD s FALSE The unit LCD s only reports the sentence End of voting Response structure from the function The function has no response parameters Error codes returned VT E NOERROR VT E VOTE NOT RUNNING VT E APP NOT STARTED Related functions VT C START VOTING VT C HOLD VOTING VT C RESTART VOTING Bosch Security Systems 2014 July 8 2 2 5 VT C HOLD VOTING Purpose This function allows the remote controller to hold a running vote round Parameter structure for the function The function has no additional parameters Response structure from the function The function has no
149. al display The error LD E UNKNOWN DISPLAY is returned if wDisplayld is not within the specified range Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 162 Response structure from the function The function has no response parameters Error codes returned LD E NOERROR LD E APP NOT STARTED LD E UNKNOWN DISPLAY Update notifications LD C SEND ANUM DATA 10 3 Update Notifications 10 3 1 Introduction This chapter describes the various update notifications sent by the CCU All the update notifications of the LD application are listed in this chapter 10 3 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 Bosch Security Systems 2014 July 163 10 3 1 2 Unit user event relations As mentioned in section 5 1 1 update notifications may not only be the result of remote functions generated by the remote controller but can also be the result of unit user events It was also mentioned in section 5 1 1 that the relation between the unit user events and the update notifications is indirect i e asynchronous This section gives information about the situations which will lead to the update notification LD C SEND ANUM DATA The situations for
150. alk notebooker MM C VIP 12 Delegate as push to talk notebooker MM C VIP PTTCHAIRMAN NO AC 13 Chairman as push to talk notebooker excluded from access control MM C VIP PTT NO AC 14 Delegate as push to talk notebooker excluded from access control MM C OPERATOR WITH REQ LIST 0 MM C DELEGATE WITH REQ LIST 1 MM C DELEGATE WITH OVERRIDE 2 MM C DELEGATE WITH VOICE 3 MM C OPERATOR WITH COMMENT LIST 4 MM C DELEGATE WITH PUSHTOTALK 5 DBSC MAX SPEAKERLIST 4 DBSC MAX NOTEBOOKLIST 15 DBSC MAX DELRTS 100 DBSC MAX DELCR 5 DBSC MAX DELCS 1 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 189 define define def ine def ine def ine def ine itdef ine define def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine define define DBSC_EMPTY_UNIT OxFFFF DBSC EMPTY DELEGATE OxFFFF MM C ATTENTION OFF 0 0 ATTENTION 1 1 C ATTENTION TONE2 2 C ATTENTION TONES 3 MKWORD Ib hb WORD CCOYORD hb 8 WORD Ib DCNC APP CC 21 CC C START CAMERA APP MKWORD 1 DCNC APP CC CC C STOP CAMERA APP MKWORD 2 APP CC C SET CAMERA ACTIVITY MKWORD 3 DCNC APP CC C SET GLOBAL SETTINGS 4 DCNC APP CC CC C CLEAR CAMERA ASSIGNMENTS MKWORD 5 DCNC APP CC CC C SET CAMERA ASSIGNMENT MKWORD 6 DCNC APP CC 06 C SEND
151. all applications that can be enabled are explained Note that the notifications are only generated for the alphanumerical displays i e LD C DISPLAY TWO and LD C DISPLAY THREE and they are only generated if the application is enabled for the display see 10 2 2 3 MM application The LD update notification may be sent when e The speaker list changes e Therequest to speak list changes MD application The LD notification may be sent when e Amessageis sent to hall displays e message is cleared from hall displays VT application The LD notification may be sent when e voting session is started e During a voting a vote is cast or changed e voting session is stopped Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 164 10 3 2 LD General notifications 10 3 2 1 LD C SEND ANUM DATA Purpose This notification sends the current updated contents of a display to the remote controller Notify structure with this update The update comes with the following structure typedef struct WORD wDisplayId CHAR szData DCNC MAX DISPLAYDATA SIZE WORD wNumO0fChars LD T DISPLAY DATA where wDisplayld Identifies the display for which the settings are sent This can be one of the following e LD C DISPLAY TWO The second display which is an alphanumerical display e LD C DISPLAY THREE The third display which is an alphanumerical display szData The current upda
152. allation System Installation System Installation Synoptic Microphone Control Speakers list Startup DCN Next Generation Shielded Twisted Pair Trunc Communication Board Transmission Control Protocol Unit identification also called unit number A unique identification of a unit within the CCU system Unit identification also called unit number A unique identification of a unit within the DCNNG system Unshielded Twisted Pair Video Display Voting application Definition RS 232 signals Carrier Detect Received Data Transmitted Data Data Terminal Ready signal Ground Data Set Ready Request To Send Clear To Send Ring Indicator Definition ASCII characters used Bosch Security Systems 2014 July Carriage Return ASCII character value OxOD Escape ASCII character value 0x1B Dollar sign value 0x24 Question mark value Ox3F Number symbol value 0x23 At character value 0x40 DCN Next Generation Open Interface Release 4 4 en 12 1 4 References USERDOC CC User Manual Camera Control Application LBB 4188 USERDOC 1 User Manual Intercom Application LBB 4173 USERDOC IN User Manual Simultaneous Interpretation Application LBB 4172 USERDOC LD User Manual Text Status Display LBB 4183 USERDOC MD User Manual Message Distribution Application LBB 4182 Bosch Security Systems 2014 July en 13 2 GENERAL DESCRIPTION 2 1 System setup To interface with applications present i
153. allowed Note that the second start of the application without a stop always results in an error This implies that you cannot change from control to monitor mode by calling the AT C START AT APP again You have to call the function AT C STOP AT APP first to stop the previous mode Response structure from the function The function has no response parameters Error codes returned AT E NOERROR AT E INCONTROL OTHER CHANNEL AT E INCONTROL THIS CHANNEL AT E INMONITOR THIS CHANNEL AT E ILLEGAL CONTROL TYPE Related functions AT C STOP AT APP 9 2 2 2 AT STOP AT APP Purpose Indicate the CCU that the remote controller no longer requires to communicate with the AT application inside the CCU When the remote controller which has the control ability stops the communication the CCU takes over the control for AT and turns attendance registration and access control off if they were still on Note Upon a communication lost this function will be activated if AT C START AT APP was activated 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 AT E NOERROR AT E APP NOT STARTED Related functions AT C START AT APP 9 2 2 3 AT C STORE SETTING Purpose This function allows the remote controller to pass the new setting for attendance registration and access control to the attendance re
154. ameter structure for the function The function has no additional parameters Response structure from the function The function has no response parameters Error codes returned SC E NOERROR Update notifications SC C SIGNAL QUALITY Bosch Security Systems 2014 July 33 3 3 14 5 C UNIT SIGNAL QUALITY REQ Purpose This function will request the signal quality of all units in the parameter list After executing this function a notification will be send for each known unit Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wNrOfUnits UNITID tUnitList DBSC MAX UNIT SC T UNIT LIST where wNrOfUnits The number of unit list entries actual present in the tUnitList array Only this amount of array elements is transmitted This value never exceeds the constant DBSC MAX UNIT tUnitList Array holding the list of unit ids Response structure from the function The function has no response parameters Error codes returned SC E NOERROR Update notifications SC C UNIT SIGNAL QUALITY 3 3 15 SC C LOW BATTERY REQ Purpose This function will request the global low battery status of the system Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function has
155. ameters Error codes returned IN E NOERROR IN E INTERLOCK NOT ALLOWED IN E WRONG PARAMETER IN E APP NOT STARTED 7 2 3 9IN C LOAD INT DB Purpose This function changes the whole installation of the IN application If the slave configuration does not allow the installation data nothing happens and an error is returned If the installation data is allowed it changes the autorelay booths the interlock modes the channel languages and the number of channels and per interpreter desk the incoming and outgoing channels and which B out channels are enabled The whole application is stopped and restarted in a default situation after all data is updated and downloaded to the desk If the passed parameters exactly correspond to the current situation in the CCU nothing happens and IN E NOERROR is returned Parameter structure for the function The function requires the following structure as parameter Bosch Security Systems 2014 July en 112 typedef struct DWORD dwfAutoSet BYTE byBetweenLock BYTE byWithinLock BYTE byMaxChans BYTE byChannels DBSC MAX INTERPRT CHANNEL IN T DESKCONFIG tDeskConf DBSC MAX INTBOOTH DBSC MAX DESK PER BOOTH BOOLEAN bNormal Engaged IN T DB DATA where the IN T DESKCONFIG is defined as typedef struct BOOLEAN bInstalled UNITID wUnitId BYTE byIncoming BYTE byOutgoing CHAR cOutSelect DWORD dwfBChannelSet IN T DESKCONFIG in which a UNI
156. amp wNewNumber while wNewNumber 0 break This ends controlling the MM application The remote controller and CCU can now safely be switched off D 3 Camera Control 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 chapter 2 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 it is assumed that the function will create its structure transport the parameters to the CCU and wait for the result information coming from the CCU For both the remote functions and the update notifications the same names are used as their identifier but without the constant mark C and using mixed case names So e g remote function CC C START CAMERA APP shall as function be referenced as CC Start Camera App void D 3 1 Controlling CC application This example shows the minimum steps to be taken for controlling the CC application First we have to start controlling the CC application on the CCU Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 eni285 typedef struct WORD wLength BYTE byData CC C MAX DATA LEN CC T DATA FRAME typedef struct BOOLEAN byCameraActivity CC T CAMERA ACTIVITY WORD wError wErro
157. ample when a delegate has no Voting authority he will not be requested to cast his vote The authority settings are part of the delegate database which should be downloaded using the remote functions as described in chapter 4 9 1 1 1 Attendance registration Attendance registration is an application that allows the remote controller to keep track of the delegates present in the system To accomplish this the delegate must register himself present by using one of the selectable options e Pressing his Present key on his unit No leave option e Activating the external present contact No leave option e Entering his PIN Code on his unit No leave option e Inserting his ID card in his or any unit To leave he withdraws the ID card e Inserting his ID card in the entrance unit of the system To leave he has to insert his ID card in the exit unit of the system One of the above options is selectable for registration of a delegate Note 1 Activating the external present contact will act the same as pressing the Present key Note 2 The use of the ID card can as an extra option be combined with entering a pin code Note 3 The ID card insertion in a unit can be selected to be in his own unit only fixed seating or in any unit of the system free seating In the latter situation the attendance application connects the current seat to the delegate The new seat delegate combination is used within the system The a
158. ang IN T CCU CONFIG typedef struct WORD wAudioLanglId CHAR szLangName DBSC_NCHAR_LANGNAME CHAR szLangAbbr DBSC_NCHAR_LANGABBR IN T LANGLIST typedef struct WORD wVersionOfLangL ist struct IN T LANGLIST tLangList DBSC LANGNAME IN T LANGUAGE LIST T CHAN STATUS tChanStatus T CONFIG tCcuConf ig Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 237 IN T LANGUAGE LIST tLanguageList BOOLEAN bF lashingWhenEngaged BOOLEAN bFloordistribution BOOLEAN bSpeakSlowl ySign BOOLEAN bHelpSign WORD wNrOf Instances WORD wError wNrOfInstances will hold the nr of remote controllers connected wError IN Start IN App amp wNrOf Instances switch wError case IN E INCONTROL THIS CHANNEL I have the IN app already under control Is that correct Has the remote controller restarted For the moment assume to be correct and continue break case IN E INCONTROL OTHER CHANNEL Another remote controller has control over the IN application report error and terminate case IN E NOERROR function ended succesfully check wNrOfInstances if wNrOfInstances 0 do error handling this should be impossible else IN is started by this remote controller Note that wNrOfInstances can be larger than 1 since remote monitors may also have registered v
159. appropriate action should be taken upon the error code returned The notifications received during the wait for the response may be processed directly See chapter 2 for details on this mechanism Events coming from a unit interpreter desk are processed and the CCU is updated Although there are no events that directly lead to generating and sending notifications there are unit events that indirectly lead to notifications These notifications are sent to the registered remote controller This document gives the set of Remote Functions and the set of Update Notifications concerning Simultaneous Interpretation The relation between Remote Function sent by the remote controller and Update Notifications is given in the description of each separate Remote Function The indirect relation between unit events and Update Notifications is given in section 6 3 1 2 7 2 Remote Functions 7 2 1 Introduction This chapter describes the remote functions used to control the Simultaneous Interpretation application on the CCU 7 2 2 Remote function item explanation Each description consists of the following items Bosch Security Systems 2014 July 106 e Purpose A global description of the purpose of the function e Parameter structure for the function The input parameters needed to fulfill the function When the function requires no parameters no structure is described here The type definitions of the basic types used to bui
160. as occurred Bosch Security Systems 2014 July 21 Possible error codes are RFSE BADFUNCTIONID The remote function is not available RFSE ALLOCFAILED Response space allocation failure RFSE NOACCESSPERMISSION The remote function is not authorized These error codes are described in Appendix C 2 4 2 Simultaneous operation from Control PC and Remote Controller In some cases it is possible to have the same application running on the DCN Next Generation Control PC and simultaneously having that application running on a remote controller Some applications can only be active on one place at a time In the table below all possible combinations are depicted All legal combinations are marked All illegal combinations are marked If an illegal combination is created the proper working of DCN is not guaranteed anymore Remote Interface apps DCN SW DCN SWSMV SI DB gt SC MM CC IN Control IN Monitoring VT MD IC Control IC Monitoring Bosch Security Systems 2014 July 22 3 SYSTEM CONFIGURATION AND SYSTEM INSTALLTION 3 1 Introduction The System Configuration and System Installation Remote Interface is part of the DCN NG software which allows another controlling entity not being the DCN NG Control PC to use the System Configuration and System Installation
161. 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 update notifications is assumed that the examples create a update function that will be called whenever the CCU has sent the notification For both the remote functions as the update notifications the same names are used as their identifier but without the constant mark C some and using mixed case names For example remote function C RESTART VOTING shall be referenced as function as VT RestartVoting D 5 1 Running a vote round without update notifications In this example we consider to have prepared a voting script holding multiple parliamentary voting motions Each motion is of the same kind with the following settings e Parliamentary with answer options Yes Abstain and No e Theresults will be collected using remote functions initial we do not use the update notifications using compressed results e The first vote casted counts e No voting timer will be used e The Attendance application inside the CCU must decide which delegate may cast his vote This means that only authorized delegates may vote e The casted vote may not be visible by means of the soft LED s After a vote the LED s must flash for several seconds and all LED s must be turned on For the simplicity of this example we assume that there is no chairman unit present in the congress hall
162. ate 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 5 2 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 structure typedef struct WORD wNrOfSpk MM T SPK MICRO tSpkList DBSC MAX SPEAKERLIST MM T CCU SPKLIST Where the MM T SPK MICRO is defined as typedef struct WORD wUnitId BOOLEAN bMicroOn T SPK MICRO where wNrOfSpk The number of SPK list entries actual present in the tSpkList array Only this amount of array elements is transmitted This value never exceeds the constant 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 Bosch Security Systems 2014 July en 75 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 5 2 4 MM Comment Speaker list functions This section describes the functi
163. ate notifications therefore also contains those that are the result of a remote function from the DCNNG control PC 5 1 2 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 Bosch Security Systems 2014 July 64 Notebook Speakers list SPK Request to Speak list RTS Comment Request list CR Comment Speakers list CS In the table below the 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 DCNNG Control PC The notebook exists in all operation modes The speakers list contains the normal delegate units that are currently allowed to speak Note that this does not mean that those units have 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 modes except for the mode Delegate with Voice activation The request to speak list contains the unit delegate combinations that requested to have their microphone switched on so they
164. ation in which the possible user events are linked with the corresponding update notification s For some Bosch Security Systems 2014 July 55 events also the required remote functions to continue the System Installation process are given The update notifications themselves are described in the remaining sections of this chapter UNIT EVENT MATRIX Evet Update Notification Continue with remote function Installation not yet started Press a Soft key on a lt None gt unit Started Installation with 51 C START INSTALL SI C GLOBAL INSTALL MODE Press a Soft key ona SI C REGISTER UNIT SI C SELECT UNIT unit See example 1 in Appendix D Started Installation with 51 C START INSTALL SI C OPERATIONAL INSTALL MODE Press a Soft key on a None unit 3 6 2 SI C REGISTER UNIT Purpose Notifies the remote controller that during global installation which implies that the CCU is in config mode see SI START INSTALL section 3 5 2 a soft key is pressed on an installable unit An installable unit is a unit which can be assigned with a seat number An overview of installable unit types is given in section 3 5 4 The remote controller should use this update to assign a seat number to the unit identifier given with this update notification Notify structure with this update The update comes with the following structure typedef struct WORD wUnitId BYTE byUnitType SI T UNIT STRUCT wher
165. attendance application and the use of the attendance interface see chapter 9 Bosch Security Systems 2014 July break case VT E NOERROR function ended succesful continue break default some unexpected error occurred report the error We have now established communication with the voting application on the CCU and can start with the preparation of the voting session Preparing the voting For the preparation of the voting we must set the global settings the voting parameters and the subject of the first voting round to be started The setting of the global parameters is done in the code below VT T GLOBAL SETTINGS tGlobalSettings tGlobalSettings wotingLedMode VT C LED SECRET FLASH ON tGlobalSettings wPresentVotes VT C 100 AUTHORISED VOTES AT decides who tGlobalSettings bShowVoteT imer FALSE we do not use the vote timer tGlobalSettings wVoteTimerLimit 0 tGlobalSettings bReservedl FALSE Must be FALSE tGlobalSettings bAutoAbstain FALSE We are using firstVoteCounts so false tGlobalSettings bReserved2 TRUE Must be TRUE tGlobalSettings bVoteWe ight ing0n FALSE Everyone has the weight 1 tGlobalSettings bReserved3 FALSE Must be FALSE tGlobalSettings bFirstVoteCount TRUE the first cast of a delegate counts wError VT SetGlobalSettings amp tGlobalSettings if wError VT E NOERROR The second part of th
166. ble as a result of inserting ID Cards in and or withdrawing them from units For this functionality neither the attendance registration nor the access control process need to be active The only restriction is that a names file should be downloaded When the location of a delegate is determined the new location is sent to the remote controller The Delegate Identification functionality keeps track of the location where a delegate is located The differences if any are reported to the remote controller every second For Delegate Identification two definitions can be made e Located delegate a delegate which resides on a unit e Dislocated delegate a delegate which doesn t reside on a unit yet A delegate who is assigned a seat in the current names file is using that seat unless that delegate inserts his card in another unit In those cases the delegate is a located delegate If another delegate inserts his card in that particular unit the delegate who resides default on that unit will become a dislocated delegate When a delegate withdraws his card the delegate will be assigned to his default unit if nobody else is using that unit and the delegate who has withdrawn his card has no pending request to speak else he will become a dislocated delegate The delegate who is by default assigned to the unit from which the card was withdrawn will be assigned to that unit again if the delegate itself is a dislocated delegate If the delegate is a locat
167. break case 1 OK break default two or more stop rest until we have one left WORD wNewNrOfInstances 0 do MD StopMonMD amp wNewNrOf Instances while wNewNrOfInstances gt 1 break Now we can receive update notifications We need a function to receive the update void MD ReqButtonOnOff MD T REQ BUTTON ON ptReqButton switch ptReqButton byButtonType case MD C AUXILIARY BUTTON if ptReqButton gt b0n Aux button pressed and held switch on notebook LED and switch off other LEDs MD T AUX LED tAuxLedCt tAuxLedCt wUnitId ptRegButton wUnitlId tAuxLedCt byLedMask MD C IN NOTEBOOK LED MD AuxLedControl amp tAuxLedCt 1 handle message further else Aux button released switch off notebook LED and all other LEDs MD_T_AUX_LED_CTL tAuxLedCtI tAuxLedCt wUnitId ptRegButton wUnitId tAuxLedCt byLedMask 0 MD AuxLedControl amp tAuxLedCt 1 handle message further break case MD C SPEAKSLOWLY BUTTON Handle message break case MD C HELP BUTTON Handle message break Bosch Security Systems 2014 July Finally if we are no longer interested in update notifications we can deregister with the CCU wError MD StopMonMD amp wNrOf Instances if wError MD E NOERROR do error handling D 9 Intercom In the example below the remote functio
168. 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 The comment request list or response request list contains the unit delegate combinations A delegate who responses immediate on the current speaker will come in the comment list 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 The comment speakers list or response speakers list contains the 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 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 2014 July 65 y qR Mode Mode description
169. cation inside the CCU After receiving this function the CCU takes over the control of LD The remote controller will no longer receive update notifications Parameter structure for the function The function has no additional parameters Response structure from the function The function has no response parameters Bosch Security Systems 2014 July 160 Error codes returned LD E NOERROR LD E APP NOT STARTED Related functions LD C START LD APP 10 2 2 3LD C STORE DISPLAY SETTING Purpose This function stores the settings of a display If the settings concern an alphanumerical display the update notification LD C SEND ANUM DATA may be sent depending on the settings Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wDisplayId WORD wFlags WORD wNrOfSpeakerLines WORD wNrOfRequestL ines DWORD dwReserved LD T DISPLAY REC where wDisplayld wFlags wNrOfSpeakerLines Bosch Security Systems 2014 July Identifies the display for which the settings are sent This can be one of the following see USERDOC 10 for details e LD C DISPLAY ONE The first display which is a numerical display e LD C DISPLAY TWO The second display which is an alphanumerical display e LD C DISPLAY THREE The third display which is an alphanumerical display e LD C DISPLAY FOUR The fourth display which is a graph
170. ch matrix element is defined as IN T MICSTAT structure that is defined below Every element holds the information of one particular desk in one particular booth The position in the matrix defines the desk and booth number of the unit interpreter desk Adding the value 1 to the indexes of the matrix retrieves the booth and desk number e g tIntMics 0 1 hold the data of the interpreter desk located in booth 1 with desk number 2 tinActiveChan Matrix holding the active out channels of the connected units The value of the matrix elements is either A or B tAChannels Matrix holding the A out channels of the connected units tBChannels Matrix holding the B out channels of the connected units tinChannels Matrix holding the incoming channels of the connected units wUnitld Unit Identifier If there is no unit assigned to the desk and booth number this identifier belongs to it will have the value DCNC_UNASSIGNED_ UNIT bMicStatus TRUE if the microphone of the unit is on FALSE if the microphone of the unit is off Bosch Security Systems 2014 July 7 3 2 2 IN_C_CCU_CONFIG Purpose Notifies the remote controller of a configuration update Notify structure with this update The update comes with the following structure struct BYTE byBetweenLock BYTE byWithinLock BYTE byMaxChans WORD wVerLangL ist T CHANNELLANG tChanLang 1 where the structure IN T CHANNELLANG is defined as typedef BYTE IN T CH
171. chapter describes the various remote functions available to handle the voting application A global description of the remote function handling is described in chapter 2 This chapter also gives a description about the type used within this document 8 2 1 1 Remote function item explanation Each description consists of the following items e Purpose A global description of the purpose of the function e Parameter structure for the function The input parameters needed to fulfill the function When the function requires no parameters no structure is described here 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 VT E NOERROR e Error codes returned The error values returned in the wError field of the received response information All possible error codes are described in appendix Appendix C Error Codes e Update notifications The update notifications which are generated after 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 8 2 2 Voting functions 8 2 2 1 C START APP Purpose Indicate the CCU that the remote controller wants to communicate with the VT app
172. communicate with the CC application inside the CCU After receiving this function the CCU gives the control of CC to the remote controller It is now impossible for another remote controller e g DCNNG Control to gain control of the application After this function has been called the remote controller will receive update notifications from the CC application see section 6 3 1 2 When the execution of this function is omitted all other remote functions except CC C GET GLOBAL SETTINGS and CC C SEND DATA will have no effect and will return an error code E NOT INCONTROL 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 CC E NOERROR CC E INCONTROL OTHER CHANNEL CC E INCONTROL THIS CHANNEL Related functions CC C STOP CAMERA APP 6 2 2 2 CC C STOP CAMERA APP Purpose Indicate the CCU that the remote controller no longer requires to communicate with the CC application inside the CCU After receiving this function the CCU takes over the control of CC Bosch Security Systems 2014 July 97 The remote controller will no longer receive update notifications 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 CC E NOERROR CC E NOT INCONTRO
173. controller has taken over the voting control from the CCU VT E WRONG PARAMETER 287 Settings or a combination of settings is not correct VT E INCONTROL OTHER CHANNEL 288 The VT C START APP function could not finish because the voting application is already controlled by another remote controller using another channel VT E INCONTROL THIS CHANNEL 289 The voting application is already controlled by this remote controller on the same channel Probably you have called the VT C START APP function twice VT E NOT IN CONTROL 290 The VT C STOP APP function cannot function because this remote controller has no control for the voting application VT E NO RESULTS 291 The collection of results using the remote function VT C GET RESULTS failed This can happen if never a vote round was started or the interim result setting was set to VT C INT RES NONE VT E NO NAMESFILE 292 The combination of settings passed to the remote function requires that a delegate database is downloaded into the CCU Refer to 88 1 6 for the possible settings when no delegate database is present Bosch Security Systems 2014 July Attendance Registration Error code Value Dec Hex Explanation AT E NOERROR 0 0x000 The execution of the remote function was successful AT E APP NOT STARTED 2305 0 901 The remote controller has not called the AT C START AT APP yet Therefore any remote function call to the attendance registration application fails with this error
174. controller of the flashing microphone button ring setting Notify structure with this update The update comes with the following structure BOOLEAN bFlashingWhenEngaged where Bosch Security Systems 2014 July bFlashingWhenEngaged TRUE if the microphone button ring flashes when engaged FALSE if the microphone button ring does not flash when engaged 7 3 2 4 IN C FLOOR DISTRIBUTION Purpose Notifies the remote controller of the floor distribution setting Notify structure with this update The update comes with the following structure BOOLEAN bFloordistribution where bFloorDistribution TRUE if the floor signal is distributed on the outgoing channel when no interpretation is performed FALSE if no signal is distributed on the outgoing channel when no interpretation is performed 7 3 2 5 IN C LANGUAGE LIST Purpose Notifies the remote controller of a language list update Notify structure with this update The update comes with the following structure struct WORD wVersionOfLangList struct IN T LANGLIST tLangList DBSC MAX LANGNAME where the struct IN T LANGLIST is defined as struct IN T LANGLIST WORD wAudioLanglId CHAR szLangName DBSC_NCHAR_LANGNAME CHAR szLangAbbr DBSC_NCHAR_LANGABBR 1 where wVersionOfLangList Version of the language list This can be one of the following constants IN C ENG LANG LIST ID standard English list IN C FR LANG LIST ID standard French list
175. crophone 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 Bosch Security Systems 2014 July 70 where wActiveMics The number of active microphones which can be on at the same time Valid values are in the range 1 25 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 5 2 2 7 MM 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 wOperat ionMode WORD wActiveMics WORD wMaxRTSL i stLen BOOLEAN bAllowCancelRequests BOOLEAN bAllowMicroOff WORD wAttentionTone BOOLEAN bAmbientMicCtr BOOLEAN bAutoMicOff BOOLEAN bPrioCancelAl l MM_T_CCU_GLOBAL_SETT
176. ct WORD wUnitId WORD wDelegateld BYTE byAttend AT T DEL ATTEND where wFillLevel Number of delegates in tDelegate maximum of AT C MAX DELEGATE If wFillLevel is less than AT C MAX DELEGATE then the last cluster with delegate registration information is returned tDelegate Structure containing the delegate information w Unitld Unit on which the delegate is located The wUnitid be the value DBSC EMPTY UNIT when the delegate is not located anywhere wDelegateld Delegate for which the presence status is given byAttend Presence status of the delegate The setting is one of the following AT C NOSTATUS C ATTEND AT C LEAVE AT C ATTEND NOCHANGE AT C LEAVE NOCHANGE How the presence status is determined can be seen in the following status diagram Bosch Security Systems 2014 July 156 Start attendance registration Deregister V Delegate g C NOSTATUS Register Delegate Register Register V Delegate V V Delegate AT_C_ATTEND_NOCHANGE Deregister Delegate V V V V AT C LEAVE 2 LEAVE NOCHANGE Deregister Register Delegate Register Delegate Delegate Deregister Delegate Figure 4 Presence status changes diagram Internally it is possible that a delegate which is already present will be registered present again In this case he inserts his ID card in another unit which implies that the delegate changed seat This seat change is also reported
177. ction with the function described It refers to other remote functions and to related update notifications 9 2 2 Attendance Access functions 9 2 2 1 C START AT APP Purpose Indicate the CCU that the remote controller wants to communicate with the AT application inside the CCU Depending on the control type passed the remote controller gets the opportunity to start attendance registration and or access control When no control is needed but the remote controller likes to know which delegates are present i e for microphone display information the remote controller can monitor the presence changes from the CCU When you omit the execution of this remote function all other remote functions have no effect and will return an error Parameter structure for the function The function requires the following structure as parameters typedef struct BYTE byRemoteControlType AT T APPCONTROL where byRemoteControlType Identify what function the remote controller likes to perform in combination with the attendance application Valid values are e AT C APP CONTROL The remote controller likes to have full control over the attendance registration Bosch Security Systems 2014 July en 151 application This full control implies the right to change the attendance registration settings e AT C APP MONITOR remote controller only wants to monitor the presence changes No control of the settings is
178. d error 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 Therefore 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 Bosch Security Systems 2014 July 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 congress is finished we must tell the CCU that we stopped monitoring the MM application using the following function WORD wNrOf Instances error MM_Stop_MM amp wNrOf Instances if error MM E NOERROR else do error handling 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
179. def ine def ine def ine def ine def ine def ine itdef ine def ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine 51 C SELECT UNIT MKWORD 1 DONC APP 51 SI C START INSTALL MKWORD 4 DCNC APP 51 51 C STOP INSTALL MKWORD 5 DONC APP 51 SI C REGISTER UNIT MKWORD 9 DCNC APP SI SI C SET MASTER VOL MKWORD 10 DCNC APP 51 MKWORD 13 DCNC APP ST MKWORD 14 DCNC APP 51 MKWORD 15 DCNC APP ST MKWORD 16 DCNC APP 51 MKWORD 17 51 C SET EXT CONTACT 51 C GET EXT CONTACT 51 C SET MICROPHONE GAIN 51 C GET MICROPHONE GAIN 51 0 RESET MICROPHONE GAIN 51 C GET WAP SETTINGS 51 C SET WAP SETTINGS 51 C GET WIRELESS SETTINGS 51 C SET WIRELESS SETTINGS 51 C GET NETWORK MODE 51 C SET NETWORK MODE 51 C SETTINGS 51 C WIRELESS SETTINGS 51 C NETWORK MODE 51 C START MON SI 51 C STOP MON SI SI 0 UNSUBSCRIBE REQ 51 C DEINITIALIZE ALL 51 C GET OPERATION MODE 51 C SET OPERATION MODE 51 C MICROPHONE GAIN 51 0 MICROPHONE GAIN RESET Defines for external contact itdef ine itdef ine SI C NO FUNCTION 0 SI C PRESENT 1 Bosch Security Systems 2014 July MKWORD MKWORD MKWORD MKWORD MKWORD MKWORD MKWORD MKWORD MKWORD MKWORD MKWORD MKWORD 18 19 20 21 22 23 24 25 26 21 28 29 DCNC APP SI DCNC APP SI DCNC APP SI DCN
180. def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine itdef ine itdef ine def ine def ine def ine def ine def ine def ine IN C HELP SIGN MKWORD 7 DCNC APP IN INTERLOCK 2 IN C LANGUAGE LIST 5 DCNC APP C LOAD INT DB MKWORD 40 DCNC APP IN IN 0 NOMORE CHANNELS 255 C NONEMODE 0 C ORG LANG LIST ID 3 C OVERRIDE 1 IN C OVERRIDE ON B ONLY 3 C SET FLASH MIC ON MKWORD 51 DCNC APP IN C SET FLOOR DIST MKWORD 52 DCNC APP IN IN C SET HELP SIGN MKWORD 70 DCNC_APP_IN IN C SET SPEAKSLOWLY SIGN 68 DCNC APP IN C SIGNAL CCU MKWORD 38 DCNC APP IN IN C SPEAKSLOWLY SIGN MKWORD 6 DONC APP IN IN C STANDALONE 0 C START IN APP MKWORD 56 DCNC_APP_IN C START MON IN MKWORD 54 DCNC_APP_IN C STOP APP MKWORD 57 DCNC APP IN IN C STOP MON IN MKWORD 55 DCNC APP IN C UNASSIGN UNIT MKWORD 77 DCNC APP IN C UPDATE LCK MKWORD 39 DCNC APP IN C UPDATE LOCK MKWORD 73 DCNC APP IN C WITHPPC 1 MKWORD Ib hb WORD WORD hb lt lt 8 WORD Ib C CLEAR DISPLAY NR MKWORD 11 DCNC APP LD LD C DISPLAY FOUR 3 Bosch Security Systems 2014 July DCN Next G
181. def struct UNITID tUnitId BYTE byBooth BYTE byDesk IN T UNIT ASSIGN where wNrOfUnits The number of unit list entries actual present in the tUnitAssignList array Only this amount of array elements is transmitted This value never exceeds the constant DBSC MAX INTSEAT tUnitAssignL ist Array holding the list of unit assignments see notes below wUnitld Unit Identifier of the interpreter byBooth The assigned booth number with the values 1 31 byDesk The assigned desk number with the values 1 6 Bosch Security Systems 2014 July en 119 The assignment list cannot contain duplicate entries e g unit id s or booth desk combinations At most one unit can be assigned to a booth desk combination Units can be assigned to already occupied booth desk combinations If the current occupant is not in the assignment list then it will be overwritten and the settings will be discarded If it is in the list then the settings remain untouched This includes the settings for the output channels such as the A and B channels Only units that have not been assigned before get the default settings The order of the list is also irrelevant Response structure from the function The function has no response parameters Error codes returned IN E NOERROR IN E APP NOT STARTED IN E WRONG PARAMETER IN E UNKNOWN UNIT IN E MEMORY ALLOC FAILED Related functions IN C UNASSIGN UNIT 7 2 3 20 IN C UNASSIGN UNIT Purpos
182. des are described in Appendix C Error Codes e Update notifications The update notifications that are generated during the execution of the remote function When there are no notifications generated 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 When there are no related functions this part will be omitted 10 2 2 LD General functions 10 2 2 1 LD START LD APP Purpose This function indicates the CCU that the remote controller wants to communicate with the LD application inside the CCU It is now impossible for another remote controller e g DCNNG Control PC to gain control of the application After this function has been called the remote controller will receive update notifications from the LD application see section 6 3 1 2 When the execution of this function is omitted all other remote functions will have no effect and will return an error code LD E APP NOT STARTED 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 LD E NOERROR LD E INCONTROL OTHER CHANNEL LD E INCONTROL THIS CHANNEL Related functions LD C STOP LD APP 10 2 2 210 C STOP LD APP Purpose Indicate the CCU that the remote controller no longer requires to communicate with the LD appli
183. dwLength DWORD dwReser vedl DWORD dwReserved2 BYTE byData OIP Don Where byMessageTypeHeader Message type byte with a fixed value of 0x43 wFnld The function identifier Note that the data in this message also starts with a function identifier see the description of the data in paragraph 2 2 2 1 2 2 2 2 2 2 2 3 this function identifier and the function identifier in the data should be identical byDcnMsgType Is equal to the byType value described in 2 2 2 Currently the following types are defined for communication with the CCU e MDSM REMOTEPROCEDURE e MDSM REMOTEPROCEDURE RSP e MDSM NOTIFY dwLength The total length of the command structure dwReserved1 Session sequence number Currently the reserved is not used and should be set to the value zero 0 dwReservea2 Message sequence number Currently the 2 is not used and should be set to the value zero 0 byData Data corresponding to the description of the message type Bosch Security Systems 2014 July The data here is the data described in paragraph 2 2 2 1 2 2 2 2 2 2 2 3 and starts with a function identifier en 19 2 3 Protocol description 2 3 1 Ethernet Protocol Description 2 3 1 1 Open interface protocol 2 3 1 1 1 Set up a connection After DCN NG has been started the CCU listens to port 9451 The set up of the TCP IP connection must originate from your system using the IP address of the CCU and port 9451 The connect
184. e wUnitld The unit identifier of a unit Also called unit number byUnitType The type of the unit The different unit types possible are the installable unit types given in section 3 5 4 3 6 3 SI C MICROPHONE GAIN Purpose Notifies the remote controller the microphone gain of a unit has been changed where wUnitld The unit identifier of a unit Also called unit number wGain The microphone sensitivity gain setting for the unit in the range 0 15 The values 0 up until 15 correspond with a microphone sensitivity setting change of 6dB up until 9dB in steps of 1 dB The default value of the microphone sensitivity is Bosch Security Systems 2014 July 56 DCNC MICROPHONE GAIN DEFAULT 3 6 4 SI C MICROPHONE GAIN RESET Purpose Notifies the remote controller that the microphone gain for all units has been reset where wGain The microphone sensitivity gain setting for the unit in the range 0 15 The values 0 up until 15 correspond with a microphone sensitivity setting change of 6dB up until 9dB in steps of 1 dB The default value of the microphone sensitivity is DCNC MICROPHONE GAIN DEFAULT 3 6 5 51 C WAP SETTINGS Purpose Notifies the remote controller the settings of WAP This notification is send after the settings of a WAP has been changed Notify structure with this update The update comes with the following structure typedef struct UNITID tUnitId 51 T CARRIER byCarrier SI T WIRELESS
185. e This function is used to unassign unit s to the given booth and desk numbers Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wNrOfUnits UNITID tUnitList DBSC MAX INTSEAT IN T RFS UNIT LIST where wNrOfUnits The number of unit list entries actual present in the tUnitAssignList array Only this amount of array elements is transmitted This value never exceeds the constant DBSC MAX INTSEAT tUnitList Array holding the list of unit ids Response structure from the function The function has no response parameters Error codes returned IN E NOERROR IN E APP NOT STARTED IN E WRONG PARAMETER IN E UNKNOWN UNIT IN E UNKNOWN INTSEAT Related functions IN C ASSIGN UNIT 7 3 Update Notifications 7 3 1 Introduction This chapter describes the various update notifications sent by the CCU All the update notifications of the IN application are listed in this chapter 7 3 1 1 Update notification item explanation Each update notification description consists of the following items Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 120 e Purpose A global description of the purpose of the notification e Notify structure with this update The information passed with the update notification Bosch Security Systems 2014 July 121 7 3 1 2 Unit user event relations As we have mentio
186. e the record will be added to the database e When the delegateld already exist in the database the record of that delegate will be updated Only the following fields may be changed wUnitNr Unit number where the delegate resides byDesklang Desk language of the delegate IVWeight Voting weight of the delegate bMicAut Microphone authorization bVotingAut Voting authorization bInterAut Intercom authorization szSline The screen line of the delegate All other fields of the structure must have the same value as the information stored in the database Availability This function is available in CCU system mode congress Parameter structure for the function DB T PERDELEGATE tDelegate for description see section 4 2 3 Response structure from the function The function has no response parameters Error codes returned DB E NOERROR DB E UPD DEL UNIT IN USE DB E UPD DEL CARD CHANGED DB E UPD DEL PIN CHANGED DB E UPDATE DELEGATE FAILED DB E INSERT DELEGATE FAILED DB E NO DATABASE DB E APP NOT STARTED DB E WRONG PARAMETER DB E NOT INCONTROL Related functions DB C START APP DB C MAINT CCU DB C DOWNLOAD CCU DB C CLEAR CCU Bosch Security Systems 2014 July 63 5 MICROPHONE MANAGEMENT 5 1 Introduction The Microphone Management Remote Interface is part of the DCNNG software which allows for another controlling entity outside the CCU not being the DCNNG Control PC to use the Microphone Ma
187. e CCU then forwards these to the remote controller Since the update notifications are only generated indirectly they will always be received after the reception of response information of a remote function 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 Events coming from a unit chairman or delegate are processed and the CCU is updated Although there are no events that directly lead to generating and sending notifications there are unit events that can indirectly lead to notifications Again note that it depends on the type of equipment used and its connection state whether or not the notifications are sent The notifications are sent on by the CCU to the registered remote controller This document gives the set of Remote Functions and the set of Update Notifications concerning Camera Control The relation between Remote Function sent by the remote controller and Update Notifications is given in the description of each separate Remote Function The indirect relation between unit events and Update Notifications is given in section 6 3 1 2 6 2 Remote Functions 6 2 1 Introduction This chapter describes the remote functions used to configure the Camera Control application on the CCU Bosch Security Systems 2014 July 96 6 2 1 1 Remote function item explanation Each description consists of
188. e 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 MM C DELEGATE WITH PUSHTOTALK 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 5 2 2 6 MM 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 fthere are speakers in the list with their microphone off then first of these will be removed e When there are only speakers in the list with their microphone on the first unit in the list will be turned off and removed from the list When the mi
189. e following items e Purpose A global description of the purpose of the function Bosch Security Systems 2014 July 166 e 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 in chapter 2 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 MD E NOERROR 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 C Error Codes e Update notifications The update notifications which are generated during the execution of the remote function When there are no notifications generated 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 When there are no related functions this part will be omitted 11 2 2 Message Distribution functions 11 2 2 1 MD C START MON MD Purpose Function to start the monitoring behavior of the Message Distribution application This function must be called by the remote controller in o
190. e last link in the list wDestld The unitld of the receiver of the intercom call Response structure from the function The function has no response parameters Error codes returned IC E NOERROR IC E WRONG PARAMETER 12 2 2 41C C CLEAR LINKS Purpose This function allows the remote controller to remove all the existing special links between units 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 IC E NOERROR 12 3 Update Notifications 12 3 1 Introduction This chapter describes the various update notifications sent by the CCU All the update notifications of the IC application are listed in this chapter 12 3 1 1 Update notification item explanation Each update notification description consists of the following items Bosch Security Systems 2014 July en 174 e Purpose A global description of the purpose of the notification e Notify structure with this update The information passed with the update notification 12 3 1 2 Unit user event relations This section gives information about the events coming from the units and the processing done for the events In the table below and overview is made about the events and the actions performed Event Action performed Pick up the hook on a The following notifications are sent 1 me IC_UPD_AVAILABLE_LINES e UPD IN
191. e organized in a list of delegate s whereby the Delegateld is used as index in the list The complete list is stored in the byDelegateVotes array using either normal or compressed storage Because the Delegateld is used as index within the list the minimum length of the list is equal to the highest Delegateld present in the downloaded delegate database This implies that the list may contain holes in the Delegateld numbering For each not used Delegateld in of the delegate database the voting result is set to C VOTE UNASSIGNED Example The downloaded delegate database consists of the Delegateld s 1 2 3 and 8 This implies that the highest Delegateld s is equal to 8 and therefore the list gets the length of 8 delegates For each Delegateld not in the delegate database Delegateld s 4 7 the voting result is set to VT C VOTE UNASSIGNED The other used Delegateld s can get the following values for Parliamentary Voting type with 3 answers VT C VOTE NOT VOTED _ The delegate is present but has not casted a vote yet VT C VOTE YES The delegate is present and has casted the Yes vote VT C VOTE NO The delegate is present and has casted the No vote VT C VOTE ABSTAIN The delegate is present and has casted the Abstain vote VT C VOTE NPPV The delegate is present and has chosen the NPPV vote Note that for the result values only the lower nibble is used when the voting result is stored in the byDelegateVotes array using
192. e preparation is setting the voting kind as used during all the vote rounds VT T VOTINGPARAMS tVotingControl WORD wIndex do error handling tVotingControl wVotingMenu VT C MENU YES NO ABSTAIN tVotingControl wNrOfAnswerOpt ions 3 Yes No and Abstain tVotingControl bOpenVoting TRUE Individual results Only send the results to the remote controller tVotingControl winter imResultType VT C INT RES INDIV PC ONLY tVotingControl bCompressedResults TRUE results must be compressed wError VT SetVotingParams amp tVotingParams if wError VT E NOERROR These two calls finish the preparation for the voting session We can now start each vote round till the session is completed do error handling Running each vote round For running the vote round we expect an external function present which collects the subject text for the next voting This external function returns TRUE if a new subject has been found and returns FALSE when no more subjects are present As subject legend we will use the fixed text Voting Bosch Security Systems 2014 July For controlling the time mechanism and the interaction with the operator we use another two external functions The first function returns TRUE when a second has passed and the second function returns TRUE when the operator has decided to stop the vote round Another external function is assumed to store the voting result This
193. e second time IN E INCONTROL OTHER CHANNEL 530 0x212 The IN C START IN APP function could not finish because the IN application is already controlled by another remote controller using Bosch Security Systems 2014 July Simultaneous Interpretation Error code Value hex Explanation another channel IN E NOT IN CONTROL 531 0x213 The IN C STOP IN APP function cannot function because this remote controller does not control the IN application IN E WRONG PARAMETER 532 0x214 The value of a parameter passed in a function call is invalid out of range IN E APP NOT STARTED 533 0x215 Indicates that no remote controller has taken over the IN application control from the CCU and therefore the remote controller is not allowed to call the remote function IN E INCORRECT DESK CONFIG 534 0x216 Indicates that the desk configuration is incorrect i e the mapping of unit identifiers to booth and desk numbers passed in the remote function does not correspond to the actual mapping inside the CCU IN E UNKNOWN BOOTH NR 535 0x217 Booth is not known in the system Voting Error code Value Explanation VT E NOERROR 0 The execution of the remote function was successful VT E VOTE RUNNING 276 Indication that a vote round is running on this moment VT E VOTE NOT RUNNING 277 No vote round running on this moment VT E VOTE NOT ON HOLD 278 No vote round on hold on this moment VT E APP NOT STARTED 286 Indicate that no remote
194. e 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 5 3 3 8 MM_C_SPK_REPLACE_ON PC Purpose Notifies the remote controller 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 T SPK where tCurrSpk The SPK entry to search for This SPK entry is replaced by the new value given in the parameter tNewSpk Bosch Security Systems 2014 July en 91 tNewSpk The SPK entry holding the new contents 5 3 4 MM Comment Speaker list notifications The Microphone Management comment speaker list notifications report the changes in the comment speakers list 5 3 4 1 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 5 3 4 2 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 where tCSpkAdd The speaker who is added to the comment speak
195. eat from Seat Entrance Exit ON OFF SEAT ONE SEAT CODE Absent Located Functioning IDCARD Absent PINCODE Located Functioning ANY SEAT Absent Functioning Absent Located Blocked Absent Located Blocked Absent Anywhere Blocked No change Located Blocked No change ed Blocked Absent Located Blocked Absent Located Blocked Absent Anywhere Blocked Present Located IDCARD PINCODE Absent Located Blocked ANY SEAT IDCARD Absent PINCODE Anywhere Blocked The notes mentioned in the table are ON ENTRANCE ONE SEAT IDCARD Absent EXIT PINCODE Located Blocked ANY SEAT 5 Absent Blocked ONE SEAT PIN CODE Absent Located Blocked Present Located Functioning Functioning No change Located Functioning Present Located Functioning Present Located Functioning No change Located Functioning No change price Functioning No change Located Functioning Present Located Functioning Present Located Functioning No change Anywhere Functioning Absent Anywhere Functioning Absent Anywhere Functioning No change Anywhere Functioning No change Anywhere Blocked No change Anywhere Functioning Absent Located Blocked Absent Anywhere Blocked Absent Located Blocked Absent Anywhere Blocked Present Located Functioning Present Anywhere Blocked 1 There are several rows showing the same states on the same events e
196. eated till the update use count becomes zero Availability This function is available in CCU system modes config and congress 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 START APP section 3 3 2 Error codes returned SC E NOERROR Related functions SC C START APP 3 3 4 SC C GET CCU VERSIONINFO Purpose This function is used to query the CCU version information Usually this will be the first function called after start up of the remote controller to check the correct version of the CCU software Availability This function is available in all CCU system modes 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 tOperatingMode CHAR szSwVersion SC C MAX VERSION LENGTH BYTE byMa jorVersionOfDownloadedSw BYTE byMinorVersionOfDownloadedSw BYTE byMa jorVersionOfResidentSw BYTE byMinorVersionOfResidentSw BYTE bySystemMode BYTE byReservedForSwInfo SC C MAX SOFTWARE INFO WORD tCCUType BYTE byTCBVersion BYTE byReservedForHwInfo SC C MAX HARDWARE INFO CHAR szSWRe Num VERSION C LENGTH SC VERSION INFO where tOperatingMode The current operating mode of the CCU It gives information about the environment the CCU i
197. ect itself using the notification SC C CONNECT UNIT Therefore no units are reported in this list Future extension in the software could build a list of units connected to a slave That list should then be reported in the tConnectedUnits list 3 4 6 DISCONNECT SLAVE CCU Purpose Notifies the remote controller that the master CCU has lost connection to one of his slave CCU s Along with this notification a list of all units connected to that slave is send This notification tells the remote controller that the listed units are no longer available Notify structure with this update The update comes with the following structure typedef struct bySlaveld WORD wFillLevel SC T UNIT DATA tDisconnectedUnits SC C CLUSTER MAX SC T CCU DISCONNECT where bySlaveld The identification number of the slave CCU involved wFillLevel The number of units present in the tDisconnectedUnits array Only this amount of array elements is transmitted tDisconnectedUnits A list of units that are connected to the slave in question at the moment of disconnecting the slave This means that all units reported in the list are also disconnected Each list element is defined as a SC T UNIT DATA structure which is defined in section 3 3 5 Note Although the list is defined with SC C CLUSTER MAX elements only the maximum number of units possible for one slave will be transmitted This notification differs from SC C CONNECT SLAVE
198. ed CC E NOERROR CC E NOT INCONTROL CC E INVALID CONTROL TYPE CC E INVALID PARAMETER Related functions CC C GET GLOBAL SETTINGS CC C SET CAMERA ASSIGNMENT 6 2 2 5 CC C GET GLOBAL SETTINGS Purpose This function gets the global settings of the CC application Note that this function can be called even when the remote controller is not in control of the CC application CC C START CAMERA APP has not been called Parameter structure for the function The function has no additional parameters Response structure from the function The structure returned by this function is the same structure as sent with the remote function CC C GET GLOBAL SETTINGS see 6 2 2 4 Error codes returned CC E NOERROR Related functions CC C SET GLOBAL SETTINGS CC C SET CAMERA ASSIGNMENT 6 2 2 6 CC C SET CAMERA ASSIGNMENT Purpose This function sets the camera assignment of one or more connected cameras Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wLength CC T INDEXED CAMERA ASSIGNMENT tIndexedCameraAss i gnment CC C MAX CAMERA ASSIGNMENT CLUSTER CC T SET CAMERA ASSIGNMENT where CC T INDEXED CAMERA ASSIGNMENT is defined as typedef struct UNITID wUnitId T CAMERA ASSIGNMENT tCameraAssignment CC T INDEXED CAMERA ASSIGNMENT Bosch Security Systems 2014 July en 100 where CC T CAMERA ASSIGNMENT is defined as t
199. ed delegate nobody will be assigned to that unit 9 1 1 4 Combination Attendance and Access From the previous sections it will be clear that the settings for attendance registration and access control are combined because the ways to register and to get access are the same for both parts of the application Due to the combination of the settings of the two parts there are some restrictions e When the Present key or the external present contact is selected to gain attendance Access Control cannot be activated e When delegates may sit on any chair Free seating attendance registration using the Present key or the external present contact is not possible Also registration and or Access Control using the PIN Code is not possible with this setting 9 1 2 Functioning with parameters When starting with the attendance application we must use parameters to set the different options According to the settings made several events can occur with the DCN NG system which influences the presence and access of a delegate In this section we define the parameters and create a matrix that defines the changes when a certain event within the system occurs 9 1 2 1 State definitions The state definitions define the current state of a delegate in the DCN NG system There will be a state definition per combination of the different settings The following states are defined Stateitem Values Present or Absent Note 1
200. een changed or after SC C SET ENCRYPTION ENABLED is executed Notify structure with this update The update comes with the following structure Bosch Security Systems 2014 July 42 BOOLEAN bEnabled where bEnabled TRUE Wireless network is encrypted FALSE Wireless network is not encrypted 3 5 System Installation SI functions 3 5 1 Introduction The system installation functions provide functionality to connect unit identification with the seat numbers used within the congress hall This process is also called seat assignment This chapter defines the set of remote functions needed for system installation Each description is according to the definition given in section 3 1 1 1 3 5 2 SI C START INSTALL Purpose Start the installation mode The remote controller can choose between 2 modes of installation which are Mode Description SI C GLOBAL INSTALL MODE Global installation mode When activating this mode the CCU stops all applications running and only runs the installation application When the function is successfully executed the CCU has changed the system mode from congress to config Entering the system mode config enables the update notification SI C REGISTER UNIT which informs the remote controller about someone pressing a soft key on a unit The remote controller must use this notification message to link the unit with a seat By pressing a soft key on all units in order of the seat numb
201. ef ine SC_C_DCN_CCUB 2 def ine SC C DCN CCUB2 4 define 50 C DCN CCU2 3 Hdefine 560 C DISCONNECT SLAVE MKWORD 14 DCNC APP SC define 50 C DISCONNECT UNIT MKWORD 10 DCNC APP SC define 50 C ENCRYPTION ENABLED MKWORD 65 DCNC APP SC define 50 C EXTENDED 0x02 define 50 C GET CCU CONFIG MKWORD 12 DCNC APP SC define 50 C GET CCU CONFIG PROPERTY MKWORD 51 DCNC APP SC Hdefine SC C GET CCU VERSIONINFO 6 DCNC APP SC define 50 C GET ENCRYPTION ENABLED MKWORD 64 DCNC APP SC Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 define itdef ine itdef ine itdef ine def ine def ine def ine def ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine itdef ine def ine def ine def ine def ine itdef ine itdef ine itdef ine itdef ine itdef ine SC C GET SLAVE NODES MKWORD 54 DCNC APP SC SC C GET UNIT IDS MKWORD 55 APP SC SC C LOW BATTERY MKWORD 68 DCNC APP SC SC C LOW BATTERY REQ MKWORD 69 DCNC APP SC SC C MASTER 0x10 SC C MAX HARDWARE INFO 50 SC C MAX SOFTWARE INFO 29 SC C MAX VERSION LENGTH 50 SC C MULTITRUNC 0x08 51 C NETWORK MODE OFF 2 51 C NETWORK MODE ON 0 51 C NETWORK MODE SLEEP 1 51 C NETWORK MODE SUBSCRIPTION 3 51 6 POWERLEVEL HIGH 3 51 C POWERLEVEL LOW 1 51 C P
202. egate to the DCN NG system The registration from the remote controller emulates the insertion of the ID card in the entrance or exit unit Therefore the ID card code and optional the PIN code must be passed along with this function Note that both the ID card codes and the PIN codes are downloaded from the remote controller into the CCU during the download of the delegate database see chapter 4 for details Together with the registration of the delegates at the unit on which the delegate resides all LED s will be turned on if the delegate becomes present The LED s are turned off again when the delegate is registered absent Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wEvent WORD wFillLevel AT T DEL IDENTIFICATION tDelIdenfication C MAX REGISTRATION AT T IDENTIFICATION where the AT T DEL IDENTIFICATION is defined as typdef struct DWORD dwCar dCode WORD wP i nCode AT T DEL IDENTIFICATION where wEvent Identify on which type of unit attendance registration will take place The setting is one of the following e ACSC EVENT INSERT CARD ENTRANCE e ACSC EVENT INSERT CARD EXIT wFillLevel Number of delegates in tDelldentification ranges from 1 to AT C MAX REGISTRATION If more than AT C MAX REGISTRATION delegates should be registered this function must be called more than once tDelldentification S
203. emote controller no longer requires to communicate with the VT application inside the CCU After receiving this function the CCU takes over the control for VT If a voting is running the CCU will stop the voting All Settings for the voting kind the global settings and subject settings are reset to their default values as described in section 8 1 5 Note that Upon communication lost this function will be activated if VT C START APP was activated 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 VT E NOERROR VT E NOT IN CONTROL Related functions VT C START APP Bosch Security Systems 2014 July 8 2 2 3 START VOTING Purpose This function starts the voting The parameters for the voting must be set using the setting functions VT C DOWNLOAD SUBJECT C SET VOTINGPARAMS and VT C SET GLOBAL SETTINGS When one or more of these remote functions are not called the previous or default values will be used As a result of starting the voting the update notification will be sent to the remote controller As long as the VT C STOP VOTING remote function is not called the CCU will send update notifications to the remote controller if the bResultNotify parameter of VT T COMCONTROL structure of the VT C START APP was set to TRUE Parameter structure for the function The function has no
204. eneration Open Interface Release 4 4 en 210 define C DISPLAY 0 define C DISPLAY THREE 2 Hdefine C DISPLAY TWO 1 Hdefine C MAX NR OF DISPLAY LINES 10 Hdefine LD C MD FLAG DISPLAY 0x2 Hdefine LD C MM FLAG DISPLAY 0 4 define LD C SEND ANUM DATA MKWORD 7 DCNC APP 10 Hdefine LD C START LD APP MKWORD 12 DCNC APP LD Hdefine LD C STOP LD APP 13 DCNC APP LD define LD C STORE DISPLAY SETTING MKWORD 14 DCNC APP LD define LD C VT FLAG DISPLAY 0 1 def ine CARD CODE 999999999 define CARD CODE 999999999 define MAX VOTE WEIGTH 99999999 define C ALL LEDS OFF 0 0 Hdefine C AUX LED CONTROL MKWORD 4 DCNC APP MD Hdefine C AUXILIARY BUTTON 0 Hdefine C CLEAR MESSAGE ON UNITS MKWORD 1 APP MD Hdefine C EXTERNAL PRESENT CONTACT 3 Hdefine C HELP BUTTON 2 define C IN NOTEBOOK LED 0 1 define C MICRO LED 0x2 define C RCV DELEGATE 0 define C RCV 3 define C RCV INTERPRETER 2 define C REQ BUTTON ON OFF MKWORD 10 DCNC APP MD Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 211 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine
205. equal to the constant IN C NOMORE CHANNELS All values in the array after this special value are ignored this way the number of channels is determined The range of the channel languages is 1 DBSC MAX LANGNAME Also note that the range of the number of channels is 1 DBSC MAX INTERPRT CHANNELS Therefore if the constant IN C NOMORE CHANNELS is found in tChannelLang 0 implying the number of channels is equal to 0 the error code IN E WRONG PARAMETER will be returned Response structure from the function The function has no response parameters Error codes returned IN E NOERROR IN E WRONG PARAMETER IN E APP NOT STARTED 7 2 3 11 IN C DOWNLOAD LANGLIST Purpose This function sends a new language list from the remote controller to the CCU If it is not the standard English or French list the database is updated If the language list number changes or if the new one is not the standard English or French list all desks are downloaded for configuration and language list data All microphones are turned off in that case and the units are brought back in a default state Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wVersionOfLangList struct IN T LANGLIST tLangList DBSC LANGNAME IN T RF LANGLIST where the struct IN LANGLIST is defined as struct IN T LANGLIST WORD wAudioLanglId CHAR szLangName LDBSC_NCHAR_LANGNAME CHAR szLa
206. er which can be the control PC connected using an Ethernet in case of MCCU or RS 232 in case of SCCU connection This remote controller uses Remote Function calls to configure Text amp Status Display e Updates in applications for which LD displays text and or status MM VT and MD may lead to updates in text status displays and or update notifications depending on the configuration To get a fully operational system the remote controller must register itself to the CCU in order for it to receive update messages from the CCU Remote functions coming from the remote controller can indirectly initiate an update in the CCU During the update notifications are generated and sent to the remote controller Unit and user events causing changes in applications MM VT and MD can lead to LD update notifications in the CCU Depending on the configuration of LD update notifications may be sent to the remote controller During the processing of remote functions on the CCU update messages may be 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 See chapter 2 for details on this mechanism This
207. ere wNrOfRts The number of RTS list entries actual present in the tRtsList array Only this amount of array elements are transmitted This Bosch Security Systems 2014 July 81 value never exceeds the constant DBSC MAX DELRTS tRtsList Array holding the RTS list information Each array element is defined as a MM T RTS structure which is defined in section 5 2 6 Error codes returned MM E NOERROR Related functions MM C RTS SET 5 2 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 5 2 6 4 The same 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 MM E ILLEGAL MICRO TYPE Update notifications MM C RTS SET ON PC Related functions MM C RTS GET 5 2 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
208. ers list The structure MM T SPK is defined in section 5 2 3 2 5 3 4 3 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 comment speakers list The structure MM T SPK is defined in section 5 2 3 2 5 3 5 MM Notebook list notifications The Microphone Management notebook notifications report the remote controller the changes in the NBK list Note if the operation mode is set to MM_C_DELEGATE_WITH_VOICE the notebook is not available See 5 2 2 5 for operation mode 5 3 5 1 MM_C_NBK_REMOVE_ON PC 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 Bosch Security Systems 2014 July 92 wUnitld Unit identifier wMicro Type The type of microphone handling for the notebook entry as defined in 5 2 5 3 5 3 5 2 MM C 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 a
209. ers the remote controller can build a list of units with the seat numbers as index An example using this mode is presented in Appendix D SI C OPERATIONAL INSTALL MODE Operational installation mode During this mode all applications keep on running The CCU remains in the congress mode No special update notification for registration will be enabled The remote controller must select a proposed unit and the seat number must be searched to link them together To finish the installation the remote controller must execute the function SI C STOP INSTALL Availability This function is available in CCU system mode congress Parameter structure for the function The function requires the following information as parameter WORD wInstal Mode where winstallMode The installation mode to be used This parameter can have one of the following values e SI C GLOBAL INSTALL MODE e SI C OPERATIONAL INSTALL MODE Response structure from the function The function has no response parameters Bosch Security Systems 2014 July 43 Error codes returned SI E NOERROR SI E ALREADY STARTED SI E MODE CHANGE FAILED Update Notifications SC C MODE CHANGE if the remote controller is registered to receive SC update notifications i e it has called SC C START APP Related functions SI C STOP INSTALL SI C SELECT UNIT 3 5 3 SI C STOP INSTALL Purpose This function stops the installation started with t
210. es Parameter structure for the function The function has no input parameters Response structure from the function The function has the following response parameters BYTE byStartupMode BYTE bySlaveld where Bosch Security Systems 2014 July 48 byStartupMode bySlaveld Error codes returned SI E NOERROR SI E WRONG PARAMETER Related functions The startup mode of the CCU 0 single mode 1 multi mode 2 standalone mode The slave id of the CCU between 0 and 31 51 C SET OPERATION MODE 3 5 14 SI C SET OPERATION MODE Purpose Set the operation mode of the CCU Availability This function is available in all system modes Parameter structure for the function The function requires the following input parameters BYTE byStartupMode BYTE bySlaveld where byStartupMode bySlaveld byStartupMode 0 bySlaveld 1 31 byStartupMode 1 bySlaveld 1 byStartupMode 1 bySlaveld 2 31 byStartupMode 2 bySlaveld 1 31 Bosch Security Systems 2014 July The startup mode of the CCU 0 single mode 1 multi mode 2 standalone mode The slave id of the CCU between 0 and 31 When setting the startup mode to multi the slave id cannot be 0 Change the slave id from 0 to another value and visa versa will trigger a soft reset The DCN CCU operates in single mode and is not master of the optical network Interpretation channels from the DCN CCU are
211. es see appendix 0 for the correct control type values DB E NOT INCONTROL 10415 0x28AF The remote function is not allowed because this remote controller has no control over the delegate database DB E WRONG PARAMETER 10417 0x28B1 Settings or a combination of settings is not correct Microphone Management Error code Value Explanation MM E NOERROR 0 The execution of the remote function was successful MM E UNKNOWN UNIT 2 The Unitld is unknown in the CCU 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 Bosch Security Systems 2014 July Microphone Management Error code Value Explanation 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
212. ete delegate database download Response structure from the function The function has no response parameters Error codes returned DB E NOERROR DB E SET PINSIZE FAILED DB E DELEGATE LIST TOO BIG DB E INSERT DELEGATE FAILED DB E UPDATE DELEGATE FAILED DB E DELEGATE DATA BLOCKED DB E PENDING REQUEST DB E APP NOT STARTED DB E WRONG PARAMETER DB E NOT INCONTROL i Although the PIN code is identified as a variable of the type long the real PIN code is a 6 based number This means that only digits 1 5 are allowed to be part of the PIN code Besides the PIN code also depends on the iPinSize variable If e g iPinSize is 3 the possible values for IPin range from 111 to 555 If iPinSize is 5 then IPin ranges from 11111 to 55555 So IPin must always contain iPinSize digits in the range 1 5 Bosch Security Systems 2014 July 61 Related functions DB C START APP DB C DOWNLOAD CCU DB C CLEAR CCU DB C CCU APPLY ONE 4 2 4 C DOWNLOAD CCU Purpose The delegate database in the CCU can be filled using this remote function Availability This function is available in CCU system mode congress Parameter structure for the function The same structures are used as in the function C MAINT CCU Response structure from the function The function has no response parameters Error codes returned DB E NOERROR DB E SET PINSIZE FAILED DB E DELEGATE LIST TOO BIG DB E INSERT DELEGATE FAILE
213. eturns to its stand alone operation This return involves a change in the following settings of the MM application Setting Parameter Section 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 DELEGATE WITH LIST All other modes will remain active wActiveMics 5 2 2 6 When the number of active microphones is this will be extended to 4 This implies also changes of the SPK and RTS lists bAllowMicroOff 5 2 2 7 This value is set to TRUE Note that this value is only used in the modes Bosch Security Systems 2014 July 68 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 5 2 2 1 Error codes returned MM E NOERROR MM E OPEN CLOSE FAILED Related functions MM C START MM 5 2 2 3 MM C START MON MM Purpose Function to start the monitoring behavior of the Microphone Management application
214. f ine def ine def ine MM C PC PRIO 3 MM C PC PRIO OFF 2 MM C PC PRIO ON 1 MM C RTS APPEND MKWORD 62 DCNC APP MM MM C RTS CLEAR MKWORD 38 APP MM MM C RTS CLEAR ON PC MKWORD 5 00 0 APP MM MM C RTS FIRST ON PC MKWORD 20 DCNC APP MM MM C RTS GET MKWORD 37 APP MM MM C RTS INSERT MKWORD 40 DCNC APP MM C RTS INSERT ON PC MKWORD 7 DCNC APP MM MM C RTS REMOVE MKWORD 39 DCNC APP MM MM C RTS REMOVE ON PC MKWORD 6 00 0 APP MM MM C RTS REPLACE ON PC MKWORD 8 00 0 APP MM MM C RTS SET MKWORD 36 DCNC APP MM MM C RTS SET ON PC MKWORD 4 DCNC APP MM MM C SET ACTIVE MICS MKWORD 53 DCNC APP MM MM C SET ACTIVE MICS ON PC MKWORD 19 DCNC APP MM MM C SET MIC OPER MODE MKWORD 52 DCNC APP MM MM C SET MIC OPER MODE ON PC MKWORD 18 DCNC APP MM MM C SET MICRO ON OFF MKWORD 34 DCNC APP MM MM C SET SETTINGS MKWORD 33 DCNC_APP_MM MM C SET SETTINGS MKWORD 33 DCNC APP MM C SET SETTINGS ON PC MKWORD 21 DCNC APP MM MM C SET SPEECHTIME SETTINGS MKWORD 59 DCNC APP MM 0 SHIFT MKWORD 35 DCNC APP MM MM C SHIFT CR MKWORD 65 DCNC APP MM Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 MKWORD 48 DCNC APP MM MKWORD 14 DONC APP MM MM C SPK CLEAR MKWORD 47 DCNC APP M
215. f ine def ine def ine CC C OVERVIEW ID UNITID 0x0000 CC C RECEIVE DATA MKWORD 16 DCNC APP CO CC C SCREEN LINE 0 CC C SCREEN LINE DOUBLE 2 CC C SEAT TEXT 1 CC C SEAT TEXT DOUBLE 3 06 C SEND DATA MKWORD 7 DCNC_APP_CC CC C SET CAMERA ACTIVITY CC C SET CAMERA ASSIGNMENT MKWORD MKWORD 3 DCNC APP CC 6 DONC APP CC CC C SET CAMERA ID MKWORD 9 DCNC APP CO CC C SET GLOBAL SETTINGS CC C START CAMERA APP CC C STOP CAMERA APP CNC APP MM 0 MKWORD MKWORD MKWORD 4 DCNC APP CC DONC APP CC 2 DCNC APP CC DB C CCU APPLY ONE MKWORD 5 DCNC APP DB DB C CLEAR CCU MKWORD 4 DCNC APP DB DB C CONTROL 1 DB C DOWNLOAD 6 DCNC APP DB DB C MAINT CCU MKWORD 3 DCNC APP DB DB C MAX N DL DEL REC 5 DB C NO CARD 0 DB C NOPIN 0 0 DB C START APP MKWORD 1 DCNC APP DB DB C STOP APP MKWORD 2 DCNC APP DB DBSC EMPTY DELEGATE OxFFFF DBSC EMPTY DELEGATE OxFFFF Bosch Security Systems 2014 July en 202 DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine DBSC EMPTY PREPOS 255 en 203 DBSC EMPTY UNIT OxFFFF DBSC EMPTY UNIT OxFFFF DBSC MAX ACT UNIT 512 SC
216. f ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine IC C SET LINKS MKWORD 3 DCNC APP 10 IC C START IC APP MKWORD 1 DCNC_APP_IC IC C UNASSIGNED UNIT OxFFFF IC MAX LINKS IN RFC 512 IC UPD AVAILABLE LINES MKWORD 6 DONC APP 10 IC UPD CONNECTION INFO MKWORD 8 APP 1C IC UPD INCOMING CALL MKWORD 9 DCNC APP 10 IC UPD OPERATOR STATE MKWORD 7 DCNC APP 10 C ASSIGN UNIT MKWORD 74 DCNC APP IN IN C BOOTH UPDATE MKWORD 37 DCNC APP IN C CCU CONFIG MKWORD 2 DCNC APP IN C CHAN STATUS MKWORD 1 DCNC APP IN IN C CHANNEL UPDATE MKWORD 41 DONC APP IN 6 CUS LANG LIST 1 ID 4 6 CUS LANG LIST 2 ID 5 C CUS LANG LIST 3 ID 6 C DEF LANG 1 C DESK UPDATE MKWORD 36 DCNC APP IN 0 DOWNLOAD LANGLIST MKWORD 50 DCNC APP IN C ENG LANG LIST ID 1 6 FLASHING MIC ON MKWORD 3 DCNC APP IN FLOOR DISTRIBUTION MKWORD 4 DCNC APP IN C FR LANG LIST ID 2 IN C GET FLOOR DIST MKWORD 53 DCNC APP IN IN C GET HELP SIGN MKWORD 71 DCNC_APP_IN IN C GET SPEAKSLOWLY SIGN MKWORD 69 DCNC APP IN Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 209 def ine
217. fPresent dwNrOfVotes Array with in each array element the total of casted votes for that answer option whereby the last item in the array holds the total voting weight of the not voters The total is calculated by taking the sum of the delegates who have casted this particular vote multiplied by their vote weight wFillLevel Highest array index available in the byDelegateVotes array Range 0 C MAX RESULT DELEGATE bCompressed Inform that the byDelegateVotes is compressed or not Possible values are TRUE The array is compressed and holds the results of two delegates in each array element FALSE The array is not compressed One delegate information in each array element byDelegate Votes Array containing the vote per delegate The index is based on the Delegateld 1 When the results are not compressed each element contains the vote of one delegate If the results are compressed each element contains the vote of two delegates The high nibble of the element contains the vote of an even Delegateld and the low nibble of the element contains the vote of an uneven Delegateld Note that for this array only the number of array elements as stored in the parameter wFillLevel is actual transmitted between the CCU and the remote controller Note when using compressed results the lower nibble of the possible answer values is also taken This means that the nibble value OxE means VT C VOTE VOTED nibble
218. face Release 4 4 def ine def ine def ine def ine def ine def ine define define define define define define define define define define define define define define define DCNC SUBTYPE VOTING 0x09 DCNC TYPE ENTRANCE 0x30 DCNC TYPE EXIT 0x40 DCNC TYPE AMBIENT MIC DCNC TYPE INTERPRETER DCNC SUBTYPE DESK 0x00 DCNC SUBTYPE AAEX 0x01 DCNC SUBTYPE DAEX 0x02 DCNC SUBTYPE CIN 0x03 DCNC TYPE DDB 0x70 DCNC SUBTYPE PASSIVE DDB DCNC SUBTYPE ACTIVE DDB DCNC SUBTYPE RS232 0x02 DCNC TYPE CHANNELSELECTOR DCNC SUBTYPE PASSIVE DCNC SUBTYPE A4CHANNEL DCNC SUBTYPE 8CHANNEL DCNC SUBTYPE 16CHANNEL DCNC SUBTYPE 32CHANNEL DCNC UNIT VOTING DCNC DELEGATE DCNC SUBTYPE VOTING DCNC UNIT INTEGRUSA4 TYPE CHANNELSELECTOR DCNC SUBTYPE 4CHANNEL Bosch Security Systems 2014 July 0x50 0x60 0x00 0x01 0x80 0x00 0x01 0x02 0x03 0x04 en 181 DCN Next Generation Open Interface Release 4 4 en 182 DCNC_UNIT_INTEGRUS8 DCNC_TYPE_CHANNELSELECTOR DCNC_SUBTYPE_8CHANNEL DCNC_UNIT_INTEGRUS16 DCNC_TYPE_CHANNELSELECTOR DCNC_SUBTYPE_16CHANNEL DCNC_UNIT_INTEGRUS32 DCNC_TYPE_CHANNELSELECTOR DCNC_SUBTYPE_32CHANNEL DCNC_UNIT_DATA_COMM DCNC_TYPE_DDB DCNC_SUBTYPE_ACTIVE_DDB DCNC_UNIT_NG_INTERPRETER DCNC_TYPE_INTERPRETER DCNC_SUBTYPE_DESK DCNC UNIT DATA COMM RS232 DCNC TYPE DDB DCNC SUBTYPE RS232 DCNC UNIT 2000 DELEGATE DCNC TYPE DELEGATE
219. fier WORD wError return error code from the function RSPSTRUC tStructure response information if any RSMT REMOTEPROCEDURE where wFnld The function identifier The same value as passed with the remote function request wError The return error code of the function called Note that if this value is non zero the content of the tStructure parameter is not tStructure A structure containing the response information after the processing of the remote function if any The wFnld and the tStructure are tightly coupled Therefore the response information structure is not defined strictly with the basic types but a special type is used to identify that the structure depends on the function identifier The actual structure definition to be received after handling a remote function request is not described in this document The structures are presented along with the definition of the remote function in the interface documents for the application 2 2 2 3 Format of type MDSC NOTIFY Upon status change the CCU reports this change by sending an update notification to the remote controller It is up to the remote controller to use the information received from the CCU The CCU sends the information to the remote controller and does not expect any reply from the remote controller on these notifications The update notifications are always coming from the CCU and are only sent to the remote controller if he
220. fined below The position in the matrix defines the desk and booth number of the unit interpreter desk Adding the value 1 to the indexes of the matrix retrieves the booth and desk number e g 113 tDeskConf 2 3 hold the data of the interpreter desk located in booth 3 binstalled wUnitld bylncoming byOutgoing cOutSelect dwfBChannelSet with desk number 4 TRUE if the interpreter desk is installed FALSE if the interpreter desk is not installed In this case all other parameters of this IN T DESKCONFIG structure are discarded Unit Identifier Valid values are 1 231 and 233 242 note that the unit identifier must be unique for every active unit i e not only for interpreter desks If there is no unit assigned to the desk and booth number this identifier belongs to see tDeskConf explanation it must have the value DONC UNASSIGNED UNIT The mapping of unit identifiers to booth and desk numbers must be the same as the mapping received in the last IN C CHAN STATUS notification see 6 3 2 1 tIntMics If this is not the case the error IN E INCORRECT DESK CONFIG will be returned The incoming channel of the interpreter desk This value is ignored floor is set as incoming channel of the interpreter desk to start in a default situation The A out channel of the interpreter desk Range 1 byMaxChans A if the A out channel of the interpreter desk is active B if the B out channel
221. following parameters typedef struct WORD wUnitId BYTE byLedMask MD T AUX LED where wUnitld Unit Identifier of the unit for which the LED states must be updated Unit identifiers can be retrieved from the system using the remote functions for System Config chapter 3 If the unit corresponding to the unit identifier does not have an auxiliary button the error MD E NO AUX BUTTON is returned byLedMask Bit mask identifying the state of the three delegate unit LEDs The LEDs are defined as following e MD C IN NOTEBOOK LED The notebook LED a lighted amber LED ring Bosch Security Systems 2014 July 169 e MD C MICRO LED The microphone LED a lighted red LED ring e MD C RTS LED The request to speak LED a lighted green LED ring If the bit corresponding to a LED is present in the bit mask the LED state must be on If it is not present the LED state must be off E g if the notebook and rts LED need to be on the bit mask MD RTSLED MD C IN NOTEBOOK LED must be sent If all LEDs must be turned off the following define can be used e MD C ALL LEDS OFF Response structure from the function The function has no response parameters Error codes returned MD E NOERROR MD E NO AUX BUTTON Related functions MD C REQ BUTTON ON OFF 11 3 Update Notifications 11 3 1 Introduction This chapter describes the various update notifications sent by the CCU All the upda
222. following structure typedef struct bySystemId BYTE byRepetitions SI T WIRELESS SETTINGS where bySystemld The system identifier Range 0 15 NOTE The system identifier is not only the wireless system identifier but the system identifier used throughout the entire system byRepetitions The number of repetitions within the wireless communication path Range 0 2 Error codes returned SI E NOERROR Related functions SI C SET WIRELESS SETTINGS 3 5 7 SI C SET WIRELESS SETTINGS Purpose Set all wireless system settings of the system Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function requires the following input parameters typedef struct bySystemId BYTE byRepetitions SI T WIRELESS SETTINGS where bySystemld The system identifier Range 0 15 NOTE Changing the system identifier will change not only the wireless system identifier but will change the system identifier throughout the entire system byRepetitions The number of repetitions within the wireless communication path Range 0 2 Bosch Security Systems 2014 July 53 Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E WRONG PARAMETER Related functions SI GET WIRELESS SETTINGS Update notifications SI C WIRELESS SETTINGS 3 5 8 Sl C GET
223. for each known unit Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wNrOfUnits UNITID tUnitList DBSC MAX UNIT SC T UNIT LIST where wNrOfUnits The number of unit list entries actual present in the tUnitList array Only this amount of array elements is transmitted This value never exceeds the constant DBSC MAX UNIT tUnitList Array holding the list of unit ids Response structure from the function The function has no response parameters Error codes returned SC E NOERROR SC E UNIT NOT CONNECTED SC E UNIT NOT FOUND Update notifications SC C BATTERY STATUS 3 3 11 SC C BATTERY INFO REQ Purpose This function will request the battery information of all units in the parameter list After executing this function two notifications will be send for each known unit Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wNrOfUnits UNITID tUnitList DBSC MAX UNIT SC T UNIT LIST where wNrOfUnits The number of unit list entries actual present in the tUnitList array Only this amount of array elements is transmitted This value never exceeds the constant DBSC MAX UNIT tUnitList Array ho
224. function The function has no additional parameters Response structure from the function The function returns the structure VT T RESULT REC This structure is defined in section 8 1 4 1 Error codes returned VT E NOERROR VT E NO RESULTS VT E APP NOT STARTED Related functions VT C START VOTING VT C STOP VOTING 8 2 2 11 VT C GET ATTENTION TONE Purpose This function allows the remote controller to retrieve the current configuration of the voting attention tone Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure BYTE byAttentionTone where byAttentionTone Configured voting attention tone which can be one of the Bosch Security Systems 2014 July following values e VT C ATTENTION TONE OFF e VT C ATTENTION TONE 1 e VT C ATTENTION TONE 2 e VT C ATTENTION TONE 3 Error codes returned VT E NOERROR VT E APP NOT STARTED Related functions VT C SET ATTENTION TONE VT C START ATTENTION TONE 8 2 2 12 VT C SET ATTENTION TONE Purpose This function allows the remote controller to set the configuration of the voting attention tone Parameter structure for the function The function requires the following structure as parameter BYTE byAttentionTone where byAttentionTone New value of the voting attention tone configuration which can be one of the following values e VT C ATTENTION TONE OFF e VT C A
225. function accepts the voting results as used for collecting the results from the CCU The function declarations are extern BOOLEAN MyFunction GetSubject WORD wVotingNumber CHAR szSubject extern BOOLEAN MyFunction SecondTick void extern BOOLEAN MyFunction OkToStopVoting void extern void MyFunction StoreResults VT T RESULT REC tResults Because we are going to run multiple voting rounds we must set up a looping mechanism VT T SUBJECT REC tSub ject VT RESULT REC tResults start the loop to run all voting rounds while MyFunction GetSubject tSubject wVotingNumber tSubject szVotingSub ject We have now received the voting number and the voting subject All we have to do is extend the structure with the legend and pass the information to the CCU strcpy tSubject szLegendSub ject Voting wError VT DownloadSubject amp tSub ject If wError VT_E_NOERROR The subject is downloaded to the CCU The CCU is now ready to start this voting round Let s start the voting do error handling wError VT StartVoting 0 no parameters If wError VT E NOERROR The voting round is running During the run of the vote round the program must wait for the operator to stop the voting In the mean time we collect the voting results from the CCU and store them do error handling while MyFunction OkToStopVoting 0 if MyFunction SecondTick co
226. g Attendance Off Access On and Seat Attend on Entrance Exit units is functional the same for both Seat Access on One seat and Seat Access on Any seat Although it seems doubled information all allowed combinations are shown amongst others to understand the changes in settings 2 Initial State No change at connection of the unit 3 The delegate must be present to come to this state otherwise no acceptation Combinations of settings that are not present in the table are not allowed Bosch Security Systems 2014 July 149 In case that no delegate database is downloaded into the CCU settings for ID card or PIN Code are not possible There is simply no information about which delegate has which ID card or PIN Code Therefore when no delegate database is downloaded into the CCU only one event state combination is legal Attendance Access Seat Attend Seat Access Control Type Initial Unit Unit Present Key Code Insert Card Remove Card Insert Card in Insert Card in connected Disconnected Seat from Seat Entrance Exit ON OFF SEAT NONE PRESENT Absent Absent Present KEY Anywhere Anywhere Anywhere Functioning Blocked Functioning Note that in this situation the activation of the present key only registers the seat because the system does not know which delegate should be seated on that seat Thus in this specific situation no delegate unit information will be sent to the remote controller Only
227. g Simultaneous Interpretation with a remote interface is achieved 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 chapter 2 This chapter also describes the protocol and hardware conditions concerning the remote interface Together with this remote interface there are at the moment two locations in a fully connected CCU where IN can be influenced These locations are e Aremote controller which can be the control PC connected using an Ethernet in case of MCCU or RS 232 in case of SCCU connection This remote controller uses Remote Function calls to control Simultaneous Interpretation e The actual interpreter units that handle their interpreter desk control keys To get a fully operational system the remote controller must register itself to the CCU in order for it to receive update messages from the CCU Remote functions coming from the remote controller can initiate an update in the CCU During the update notifications are generated and sent to 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
228. ged using this remote function Availability This function is available in CCU system mode congress However if another application is making use of the delegate database inside the CCU e g Voting or Access Control this function will return the error code DB E DELEGATE DATA BLOCKED Parameter structure for the function typedef struct BOOLEAN bFirstCluster BOOLEAN bLastCluster BYTE byPinSize WORD wFillLevel DB PERDELEGATE DelCluster DB C MAX N DL DEL REC DB T CCUMAINREC with DB T PERDELEGATE defined as typedef struct WORD IDel Id DWORD ICard DWORD WORD wUnitNr BYTE byDeskLang DWORD IVWeight BOOLEAN bMicAut BOOLEAN bVotingAut BOOLEAN bInterAut CHAR szSLine DBSC_NCHAR_SCREENLINE DB PERDELEGATE where bFirstCluster Indicates if this block is the first cluster bLastCluster Indicates if this block is the last cluster byPinSize Indicated current pin code size Possible values are 3 4 and 5 wFillLevel The DelCluster array is filled with wFillL evel entries DelCluster If an item in this array has an invalid value the error DB E WRONG PARAMETER is returned The following items per array entry are available Bosch Security Systems 2014 July 60 IDelld Delegate identification number A unique number in the range 1 DBSC MAX DELEGATE It is recommended to use Delegate Id s in an increasing order starting from 1
229. gistration application on the CCU The attendance registration application checks the validity of the parameters passed and stores the new settings Note This function may only be called if both attendance registration and access control are off See the C ACTIVATE function 89 2 2 4 Parameter structure for the function The function requires the following structure as parameter typedef struct BYTE bySeatAttend BYTE bySeatAccess Bosch Security Systems 2014 July 152 BYTE byControlType AT T SETTINGS where bySeatAttend Identify on which type of unit attendance registration will take place The setting is one of the following e AT C SEAT AT C ENTRANCE EXIT bySeatAccess Identify if a delegate can only use his own assigned unit or also another unit The setting is one of the following e AT C ANY SEAT e AT C ONE SEAT byControlType Identify how attendance registration and or access control will take place The setting is one of the following AT C PRESENTKEY PRESENTCONTACT AT C PINCODE AT C IDCARD AT C IDCARD PINCODE The meaning of the different parameter setting is described in 9 1 2 3 Response structure from the function The function has no response parameters Error codes returned AT E NOERROR AT E APP NOT STARTED AT E STORE SETTING FAILED AT E CHANGE NOT ALLOWED AT E NOT INCONTROL Related functions AT C ACTIVATE AT C HANDLE IDENTIFICATION 9 2
230. have a full installation menu Therefore more settings than present in the IN C CHAN STATUS notification can be changed Due to this reason the IN C CCU CONFIG IN C FLASHING MIC ON IN C SPEAKSLOWLY SIGN and IN C HELP SIGN update notification are also sent but only when there is no remote controller Bosch Security Systems 2014 July 7 3 2 IN General notifications 7 3 2 1 IN C CHAN STATUS Purpose Notifies the remote controller of a status update Notify structure with this update The update comes with the following structure struct BOOLEAN bConnectChanges T MICSTAT tIntMics T ACTIVECHAN tInActiveChan IN T CHANNELS tAChannels IN_T_CHANNELS tBChannels IN_T_CHANNELS tInChannels 1 where the structures IN T MICSTAT IN T ACTIVECHAN and IN T CHANNELS defined as typedef struct UNITID wunitld BOOLEAN bMicStatus IN T MICSTAT DBSC MAX INTBOOTH DBSC DESK PER BOOTH typedef CHAR IN T ACTIVECHAN DBSC MAX INTBOOTH DBSC MAX DESK PER BOOTH typedef BYTE IN T CHANNELS DBSC MAX INTBOOTH DBSC MAX DESK PER BOOTH in which a UNITID is defined as typedef WORD UNITID where bConnectChanges TRUE if there was a change in connected units i e interpreter desks were connected or disconnected since the last status update FALSE if there was no change in connected units since the last update tintMics Matrix holding the microphone status information of the connected interpreter desks Ea
231. he function SI C START INSTALL The CCU will return to congress mode if that is not the current system mode The selected units will be deselected Note that Upon communication loss this function will be activated if SI C START INSTALL was activated Availability This function is available in CCU system mode config 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 SI E NOERROR SI E NOT IN CONTROL Update Notifications SC C MODE CHANGE if the remote controller is registered to receive SC update notifications i e it has called SC START APP Related functions SI C START INSTALL SI C SELECT UNIT 3 5 4 SI C SELECT UNIT Purpose Select a unit for linking to a seat by means of flashing all LED s on the unit Only one unit can be selected at the same time When the second unit is selected the first unit is deselected automatically before the selection of the second This function will only select a unit if the unit selected represents an installable unit An installable unit is a unit which can be assigned with a seat number Installable unit types are DCNC UNIT VOTING DCNC UNIT 2000 DELEGATE DCNC UNIT 2000 CHAIRMAN DCNC UNIT DISC DELEGATE DCNC UNIT DISC DELEGATE DUAL DCNC UNIT DISC CHAIRMAN DCNC UNIT DUAL MIC DCNC UNIT FLUSH CHR NODISPLAY Bosch Security Systems 2
232. howVoteTimer Identify if a timer is used during the vote round Valid values are TRUE The vote timer must be displayed on each unit LCD and shall count down to zero FALSE No voting timer is shown wVoteTimerLimit The vote time limit On all displays the remaining time will be displayed If the timer reaches 0 it s the responsibility of the remote controller to stop hold the vote round The range of the voting time is 0 3600 seconds bReversed1 Must be set to FALSE bAutoAbstain Identify if the initial vote of all participating delegates automatically will change from Not Voted to Abstain for a Bosch Security Systems 2014 July Parliamentary voting with 3 answer options Abstain Yes For all other voting kinds this flag will be ignored Valid values are TRUE The initial vote is automatically set to abstain FALSE The initial vote is set to not voted bReserved2 Must be TRUE bVoteWeightingOn If this setting is on the votes will be weighted Only the answer option will be weighted The numbers of Present and Not Voted delegates are absolute Valid values are TRUE The voting is weighted Each delegate uses its vote weight as set in the downloaded names file see chapter 4 FALSE The voting is not weighted Each delegate has the weight of 1 one bReserved3 Must be set to FALSE bFirstVoteCount If this setting is set to TRUE delegates do not have the opportunity to change their vote when they
233. ia IN C START MON IN Continue normal operation break default some unexpected error occurred report the error We have now established communication with the IN application on the CCU Since controlling has now started we could wait for the updates to monitor the interpreter desks status updates Therefore we need the following functions void IN Chan Status IN T CHAN STATUS tNotif iedChanStatus copy the values of tNotifiedChanStatus to tChanStatus void IN_Ccu_Config IN_T_CCU_CONFIG tNotif iedCcuConf ig copy the values of tNotifiedCcuConfig to tCcuConfig void IN Flashing Mic On BOOLEAN bNotifiedFlashingWhenEngaged bFlashingWhenEngaged bNotifiedFlashingWhenEngaged Bosch Security Systems 2014 July void IN_Floor_Distribution BOOLEAN bNotifiedFloordistribution bFloordistrubution bNotifiedFloordistribution void IN_Language_List IN_T_LANGUAGE_LIST tNotifiedLanguageL ist void IN_SpeakSlowly_Sign BOOLEAN bNotifiedSpeakSlowl ySi gn void IN_Help_Sign BOOLEAN bNotif iedHel pSign Assume that we want a system with an interlock mode between booths IN C OVERRIDE and a normal engaged Led indication We can check these settings after having received the update notifications and change them if needed Therefore we need the following functions and control flow if tCcuConfig byBetweenLock IN C OVERRIDE copy values of t
234. iaste aeaa aa aea a e qe ed fe eR Ere e glans 42 3 5 9 INSTALL s iz poii tert t eui ii hn E xd Fede Rx EHE E Ln cR asia SE a kiska 43 3 54 SIG SELEGT UNIT a en vade c na 43 3 5 5 SI C SET MASTER QE eater eee dite tege ainda od a rege do egies 44 3 5 6 SI C SET EXT CONTA O e tte i sere 45 39 5 7 SE G iet ter irte ere rient i ee e pida egets 45 3 5 8 51 SET MICROPHONE uuu u uya iaia iani daaa nda 45 3 5 9 SI GET MICROPHONE GAIN sseneseneneeeenennn enne nnne nennen neis 46 3 5 10 S C MICROPHONE GAIN 5 47 23 5 dd SI OC SYSTEM ID 47 3 512 SI G DEINITIALIZE nee P ei dee 47 3 5 13 51 OPERATION nennen sinere enne 47 3 5 14 SI C SET OPERATION MODE a u GS rnnt 48 3 5 Ole GET SYSTEM IDe d tote ertt ie Satie tton 49 3 5 2 SI GCSET SYSTEM DU iiie d acer lied cee Pee ent e asua 49 3 5 8 SI UNSUBSCRIBE 04 1 0 0 etae nennen heata nennen nes 49 3 5 4 51 5 0 4 50 3 5 5 SIE G SET WAP E SETTINGS Sane 51 3 5 6 SI GET WIRELESS 5
235. ical display The error LD E UNKNOWN DISPLAY is returned if wDisplayld is not within the specified range Bit mask indicating which application s must be enabled for the display If an application is enabled changes in the application can lead to updates on the display see USERDOC LD A change in enabled applications for an alphanumerical display may lead to an update notification The bit mask can consist of a combination of the following flags e LD C VT FLAG DISPLAY The VT application is enabled for the display e LD C MM FLAG DISPLAY The MM application is enabled for the display e LD C MD FLAG DISPLAY The MD application is enabled for the display Indicates how many lines of the display are used to show the speaker list If this value is changed for an alphanumerical display an update notification may be generated This parameter may range from 0 LD C MAX NR OF DISPLAY LINES If it is out of this range the error LD E WRONG PARAMETER is returned Note that 161 the added value of wNrOfSpeakerLines and wNrOfRequestLines may not exceed LD C MAX NUMBER OF DISPLAY LINES The error LD E LINES OVERFLOW is returned if this is detected wNrOfRequestLines Indicates how many lines of the display are used to show the request to speak list If this value is changed for an alphanumerical display an update notification will be generated This parameter may range from 0 LD C MAX NUMBER OF DISPLAY LI
236. ication e Notify structure with this update The information passed with the update notification 3 4 1 2 Unit user event relations In the previous chapter a description is given of each remote function with a summary of update notifications being the result of executing that function However update notifications are also the results of user actions done on the actual units or CCU s This section gives unit user event matrices for the SC application in which the possible user events are linked with the corresponding update notification s depending on the system set up For some events also the required remote functions to continue SC monitoring and maintaining are given The update notifications themselves are described in the remaining sections of this chapter The recommended functions from the SI group are described in chapter 3 4 8 UNIT EVENT MATRIX Single CCU System Remote Controller connected as specified in chapter 2 Event Update Notification Continue with remote function s s On CCU SC C CCU REBOOT SC C START APP Bosch Security Systems 2014 July Recommended before continuing SC_C_GET_CCU_VERSIONINFO 35 Even Update Notification Continue with remote function C C GET CONF IG SI C START INSTALL and run installation as described examo e 1 in Appendix D Connect a unit SC C CONNECT UNIT Recommended before continuing SI C START INSTALL and run installa
237. ier eot 82 5 2 7 2 MMEG GRE GET ttt oet reete iit ed atia 83 5 2 7 3 SHIFT GR iit Pere 83 5 2 7 4 MM C GET MAX RSP LIST 84 5 2 7 5 MM SET 84 5 2 8 MM Speechtime functions 84 5 2 8 1 SET SPEECHTIME 5 84 5 2 8 2 MM LAST MINUTE 85 5 2 8 3 MM C TIME _FINISHED_WARNING aa 85 5 3 Update Notificatioris y uy uqa ee ret er ete i ertet e ett ate v on x tet pe eR BEER RR 86 5 3 4 Introduction iiri eem y 86 5 3 1 1 Update notification item explanation u 86 5 3 1 2 Unit user event 86 5 3 2 MM General 88 5 3 2 1 MM C SET OPER MODE ON 88 5 3 2 2 MM C SET ACTIVE MICS ON_PC 88 5 3 2 3 MM C SET SETTINGS ON PO E 88 5 3 3 MM Speaker list notifications I n nasus 88 Bosch Security Systems 2014 July 5 3 3 1 MM C MICRO ON OFF uuu 88 5 3 3 2 MM C NR CHAIR MICS ON 89 5 3 3 3 MM G SPKCSE
238. if necessary Insert card in Exit Insert Card in Exit unit check if card in no other unit check PIN Code if necessar 9 1 2 3 Parameter definitions Besides the ability to turn on and off the two parts of the attendance application the following parameters are available for setting the options Parameter Explanation SeatAttend Determine where the registration must take place On the seat unit or on the entrance exit units Determine if access is allowed on just one seat as stored in the names file or on any seat Seat access None means that no names file is currently opened ControlType Determine how the delegate must register himself to the system Possible options are Present Key Present Contact PIN Code ID Card and ID Card plus PIN Code 9 1 2 4 Event state matrix The table on the next page presents the event state matrix for the different settings of the parameters Present Contact will react the same as Present Key Bosch Security Systems 2014 July en 147 Attendance Access Seat Attend Seat Access Control Type Initial Unit Unit Present Key PIN Code Insert Card Remove Card Insert Card in Insert Card in 2214 connected Disconnected Seat from Seat Entrance Exit Absent Absent Absent Absent Anywhere Anywhere Located Anywhere Functioning Blocked Functioning Functioning ENTRANCE Absent Absent EN Absent Absent EXIT PINCODE Located Located Located Anywhere B
239. ime this timer times out Parameter structure for the function The function requires the following structure as parameter struct WORD wDummy WORD wPCActive where wDummy Dummy value not used in the function wPCActive The controller state This controller state is a bit shifted version 8 bit left shift of one of the states IN C STANDALONE or IN C WITHPC In case of IN C STANDALONE the database system setting StandAlonelN is set to FALSE and the timer for controller update messages is deleted In case of IN C WITHPC StandAlonelN is set to TRUE an update timer is inserted and both a configuration and states notification is sent Bosch Security Systems 2014 July en 107 Response structure from the function The function returns the following structure WORD wNrOfInstances where wNrOfinstances Error codes returned IN E NOERROR Update notifications IN C CHAN STATUS IN C CCU CONFIG 7 2 3 21N C START IN APP Purpose The value of the update use count for the IN application at the end of the function handling It contains the number of times a remote controller other than the remote PC has connected over the same communication medium Therefore the first time the IN C START MON function is called it contains the value 1 Indicates the CCU that the remote controller wants to communicate with the IN application inside the CCU After receiving this function the CCU gives the con
240. ion between the DCN NG System and your System is based on a stream connection This implies that messages may be transferred using multiple packets 2 3 1 1 2 Heartbeat After the connection between your system and DCN NG has been established the CCU of DCN NG starts the heartbeat checks of your system The CCU checks if a message is received within 15 seconds after the last message When the time between two messages is more than 15 seconds the CCU considers the connection to be broken and closes the TCP IP connection to your system It is advised to also run heartbeat checks of DCN NG on your system To signal that the connection is still present you must transmit a MESSAGETYPE_OIP_KeepAlive message refer to section 2 2 3 1 to the CCU every 5 seconds when no other messages are ready for transmission 2 3 1 1 3 Timing values This section presents the different value and time limits needed for handling the protocol Description Value Transmit timeout for transmission heartbeat message Check timeout to verify whether a message is received reset after each 15 seconds message reception Maximum command response time Minimum message size message type length 8 bytes Maximum message size 8000 bytes 2 3 2 Remote function execution Beside the protocol used for transmitting the data between the remote controller and the CCU the CCU executes the remote function requests In this section the execution of the remote
241. is ends the global seat assignment The remote controller has now a complete list of all seats and their corresponding unit numbers do error handling D 1 2 Replacing defective units during operation This example shows how the remote controller can assign a seat to a unit in the conference hall which is replaced by a new unit due to failure of the old unit Assumed is that previously all units have been assigned a seat number on the remote controller After detecting that a unit fails the following actions are performed by the technical staff of the conference hall 1 The defective unit is removed from the system Note that disconnecting the unit also may disconnect other chained units 2 A new unit is inserted into the unit chain and connected to the system 3 The new unit is de initialized and initialized again to be sure that the added unit has no address conflict with other units During these actions the following notifications are reported to the remote controller assumed is that the application SC is registered by the CCU e Microphone off notifications if any of the disconnected units has their microphone on or had a pending request present in the Request To Speak list e SC C DISCONNECT UNIT for all units in the chain disconnected The remote controller remembers these units to disable the functionality e SC C CONNECT UNIT for all units connected Most of the unit numbers are known in the disconnect list a
242. is returned 2 Turn off the microphones off all entries in the SPK list 3 Look if there is an entry free in the CS list If not then removing the first unit in the CS list will create a free entry 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 is 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 T RTS as parameter This structure is defined in section 5 2 6 Response structure from the function The function has no response parameters Bosch Security Systems 2014 July 84 Error codes returned MM E NOERROR MM E NOT PRESENT MM E UNIT NOT CONNECTED MM E ILLEGAL MIC OPER MODE MM E UNKNOWN UNITID AND DELID Update notifications MM C CR REMOVE ON PC MM C CS REMOVE ON PC MM C CS APPEND ON PC 5 2 7 4 MM C GET MAX RSP LIST LEN Purpose Thi
243. ist of unitlds that identifies which units should receive the message Note that the units must be of type specified in wRcvType If wRcvType has value MD RCV wUnitList and wNumOfUnits are ignored 168 Response structure from the function The function has no response parameters Error codes returned MD E NOERROR MD E NO MORE MESSAGES ALLOWED 11 2 2 4 MD C CLEAR MESSAGE ON UNITS Purpose This function clears all the messages on the units of the specified type Parameter structure for the function The function has the following parameter WORD wRcvType where wHcvType The type of units for which the messages should be cleared This can be one of e MD C DELEGATE e MD C INTERPRETER e MD C Response structure from the function The function has no response parameters Error codes returned MD E NOERROR 11 2 2 5 MD C AUX LED CONTROL Purpose This function is used to switch one or more LEDs of a delegate unit on or off This can be used to acknowledge the press release of the auxiliary button to the user of the delegate unit Note that this function only influences the LEDs around the auxiliary button of a unit The LEDs around the microphone button are not affected by this function If this function is called for a unit that does not have an auxiliary button the error MD E NO AUX BUTTON is returned Parameter structure for the function The function has the
244. item 156 9 3 2 Attendance Registration and Access Control notifications 157 9 3 2 1 AT C SEND INDIV 157 9 3 2 2 AT C SEND TOTAL 5 157 10 Text amp Status Display for a Remote interface 158 orte xe ER 158 10 1 1 Remote Text amp Status Display Control 158 10 2 Remote FUnCtiOrts s n m eret ut a RT 158 305722 M Loirero Benet MC 158 10 2 1 1 Remote function item 158 10 22 LD General TUNCHONS uuu y D S ayy ay e e Enea cere dg 159 10 2 2 1 EDO START ED AP Paare um aus n asi atau Asuy aaa ien 159 10 2 2 2 ED CG STOP LD APP u uu Danau sus 159 10 2 2 3 LD C STORE DISPLAY SETTING sees 160 10 2 2 4 LD CLEAR 161 10 3 Update Notifications ee bte a e a vna be daten aa ki usaha det 162 16 9 tastes tee EE e Es 162 10 3 1 1 Update notification item 162 10 3 1 2 Unit user event relations 163 10 3 2 LD General notifications
245. ld up the input parameter structure are given in chapter 2 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 IN 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 C Error Codes e Update notifications The update notifications that are generated during the execution of the remote function When there are no notifications generated 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 When there are no related functions this part will be omitted 7 2 3 IN General functions 7 2 3 1 IN C SIGNAL CCU Remarks This function is exported in the IN remote interface for compatible reasons only Use IN C START IN APP IN C STOP IN APP instead This function will not be supported from version 3 0 Purpose Function to update the controller state on the CCU Depending on the state the database system setting StandAlonelN is updated a timer for controller update messages is inserted or deleted a configuration notification and or a states notification is forced When a timer is inserted a states notification is sent every t
246. lding the list of unit ids Bosch Security Systems 2014 July 32 Response structure from the function The function has no response parameters Error codes returned SC E NOERROR SC E UNIT NOT CONNECTED SC E UNIT NOT FOUND Update notifications SC C BATTERY SERIAL SC C BATTERY COND 3 3 12 SC C SIGNAL STATUS REQ Purpose This function will request the signal status of all units in the parameter list After executing this function a notification will be send for each known unit Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wNrOfUnits UNITID tUnitList DBSC MAX UNIT SC T UNIT LIST where wNrOfUnits The number of unit list entries actual present in the tUnitList array Only this amount of array elements is transmitted This value never exceeds the constant DBSC MAX UNIT tUnitList Array holding the list of unit ids Response structure from the function The function has no response parameters Error codes returned SC E NOERROR SC E UNIT NOT CONNECTED SC E UNIT NOT FOUND Update notifications SC C SIGNAL STATUS 3 3 13 SC C SIGNAL QUALITY REQ Purpose This function will request the signal quality of the system Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Par
247. lication inside the CCU After receiving this function the CCU gives the control for VT to the remote controller When you omit the execution of this remote function all other remote functions will have no effect and will return an error VT E APP STARTED Parameter structure for the function The function requires the following structure as parameter Bosch Security Systems 2014 July typedef struct BOOLEAN bResultNotify BOOLEAN bReser ved WORD wViewTimeAfterStop VT T COMCONTROL where bResultNotify Informs the voting application to send update notifications for the interim results processed The following settings are valid TRUE When Update notifications are created they will be sent to the remote controller using update notifications FALSE No update notifications are sent to the remote controller The remote controller can however collect the result using remote functions bReserved Must be FALSE wViewTimeAfterStop The time in seconds that the End of voting text remains on the display of the delegate units After this time the current main menu e g Microphone menu becomes active again The value range is 0 200 seconds Response structure from the function The function has no response parameters Error codes returned VT E NOERROR VT E INCONTROL OTHER CHANNEL VT E INCONTROL THIS CHANNEL Related functions VT C STOP APP 8 2 2 2 VT C STOP APP Purpose Indicate the CCU that the r
248. llect the interim results wError VT GetResults amp tResults If wError VT_E_NOERROR do error handling store the results MyFunction StoreResults amp tResults Note that after the collection of the results the voting number present in the result structure should be the same as set during the download of the subject The vote round should be finished by stopping the VT application on the CCU We do not allow that the results are shown on the units LCD s so no show results wError VT StopVoting FALSE no parameters If wError VT E NOERROR Bosch Security Systems 2014 July do error handling After successful completion the final results are ready on the CCU to be collected Note that the CCU sends an update notification with the final results if activated But in this example we have stated that we do not use the update notifications Therefore we collect the final result using the remote function wError VT GetResults amp tResults If wError VT_E_NOERROR do error handling store the results MyFunction StoreResults amp tResults This completes the vote rounds so we can start the next vote round to complete the voting session terminating the loop for each voting round Terminating the voting applications After done all vote rounds we can stop the communication with the voting application using the function w
249. ller the network mode of the system This notification is send after the network mode of the system has been changed Notify structure with this update The update comes with the following structure SI NETWORK MODE tMode where tMode The network mode of the system which is one of the following e SI C NETWORK MODE ON e SI C NETWORK MODE SLEEP e SI C NETWORK MODE OFF e SI C NETWORK MODE SUBSCRIPTION Bosch Security Systems 2014 July 58 4 DELEGATE DATABASE 4 1 Introduction The Delegate Database Remote Interface is part of the DCN Next Generation software that allows for another controlling entity outside the CCU not being the DCN Next Generation Control PC to use the Delegate Database application The Database DB application allows users to compile a comprehensive database of information relating to participants at a conference or meeting 4 2 Remote Functions 4 2 1 DB START APP Purpose Indicate the CCU that the remote controller wants to communicate with the delegate database in the CCU When the execution of this remote function is omitted all other remote database functions have no effect and will return the error DB E APP NOT STARTED Availability This function is available in CCU system mode congress Parameter structure for the function The function requires the following structure as parameters typedef struct BYTE byControlType DB T APP CONTROL where
250. locked Blocked Functioning Blocked ANY_SEAT IDCARD Absent Absent Absent Absent PINCODE Anywhere Anywhere Located Anywhere Blocked Blocked Functioning Blocked SEAT ONE SEAT PIN CODE Absent Absent Absent Absent Absent Located Located Located Located Anywhere Blocked Blocked Functioning No change change IDCARD Absent Absent Absent Absent _PINCODE Located Located Located Anywhere Blocked Blocked Functioning Blocked Absent Absent Located Anywhere Functioning Blocked No change Nochange Present Absent Located Anywhere Located Located Functioning Functioning Functioning Functioning No change Nochange Present Absent Located Anywhere Anywhere Anywhere Functioning Functioning Functioning Functioning ANY SEAT CENO Absent Absent Blocked Blocked ENTRANCE Absent No change EXIT PINCODE Located Located Functioning Blocked ANY_SEAT IDCARD Absent No change Functioning Blocked NONE PRESENT Absent Absent Present KEY Anywhere Anywhere Anywhere Functioning Blocked Functioning ONE SEAT Absent Absent Present No change change KEY Located Located Located Located Anywhere Functioning Blocked Functioning Functioning Functioning Bosch Security Systems 2014 July 148 Attendance Access Seat Attend Seat Access Control Type Initial Unit Unit Present Key PIN Code Insert Card Remove Card Insert Card Insert Card connected Disconnected S
251. lowing structure typedef struct UNITID wCallerId UNITID wReceiverld BOOLEAN bLinked IC T CONNECTION INFO where wCallerld Unit Identifier of the calling unit wReceiverld Unit Identifier of the receiving unit bLinked Indication of the status of the link TRUE if the connection has been made FALSE if the connection is disconnected 12 3 2 4 1C UPD INCOMING Purpose Notifies the remote controller that a handset of a unit has been picked up Notify structure with this update The update comes with the following structure typedef struct UNITID wUnitId WORD wUnitType IC T INCOMMING CALL where wUnitld Unit Identifier of the unit initiating the call wUnitType The type of the unit which initiates the call Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 176 APPENDIX A PROTOCOL TCP IP SETTING A 1 TCP IP port setting DCN CCU The TCP IP port number used for the communication between the CCU and the remote controller is fixed set to the following value TCP IP Port 9451 DCN NGOpen Interface protocol port number Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 177 APPENDIX B VALUES OF THE DEFINES In this document some 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 B 1
252. lowl ySi gn where bSpeakSlowlySign TRUE if speak slowly signaling is enabled FALSE if speak slowly signaling is disabled 7 3 2 7 IN C HELP SIGN Purpose Notifies the remote controller of the status of help signaling Notify structure with this update The update comes with the following structure BOOLEAN bHelpSign where bHelpSign TRUE if help signaling is enabled FALSE if help signaling is disabled Bosch Security Systems 2014 July 8 PARLIAMENTARY AND MUTLI VOTING 8 1 Internal Functioning Voting application The voting application present in the CCU is set up as an engine capable of handling parliamentary kind of voting s For all voting rounds to be carried out you can identify common aspects for each different kind of voting The voting application uses the common aspects to control the voting requested Some of these common aspects are e Subject of the voting e The kind of the voting e g parliamentary voting with Yes No amp Abstain answers e General setting e g voting time limit etc More details on the complete parliamentary voting application can be found in the appropriate user manuals 8 1 1 Voting subject The Voting subject is controlled by the remote function VT C DOWNLOAD SUBJECT This remote function passes the subject text along with a motion number as subject identifier to the CCU The CCU in his turn uses the motion number to identify the subject handled 8 1 2 Voting kind
253. ly DCN Next Generation Open Interface Release 4 4 def ine def ine def ine def ine def ine def ine def ine def ine def ine def ine itdef ine itdef ine def ine def ine def ine def ine def ine def ine def ine itdef ine itdef ine C NONEMODE 0 IN C OVERRIDE 1 C INTERLOCK 2 IN C OVERRIDE ON B ONLY C ENG LANG LIST ID C FR LANG LIST ID C ORG LANG LIST ID C CUS LANG LIST 1 ID 6 CUS LANG LIST 2 ID 6 CUS LANG LIST 3 ID IN 0 NOMORE CHANNELS C DEF LANG 1 DBSC INTERPRT CHANNEL DBSC MAX INTBOOTH 31 DBSC MAX DESK PER BOOTH en 192 N 255 3 6 DBSC MAX DBSC MAX INTBOOTH DBSC MAX DESK PER BOOTH DBSC MAX LANGNAME 53 DBSC NCHAR LANGNAME 13 DBSC NCHAR LANGABBR 4 IN 6 STANDALONE 0 C WITHPC 1 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 193 define UNASSIGNED UNIT UNITID OxFFFF define MKWORD 1b hb WORD WORD hb lt lt 8 WORD 1b Hdefine DCNC_APP_VT 1 Hdefine VT C START APP MKWORD 1 DCNC APP VD define VT 0 STOP APP MKWORD 2 DCNC APP VD define VT C START VOTING MKWORD 3 DCNC APP VD Hdefine VT C STOP VOTING MKWORD 4 DCNC APP VD Hdefine VT C HOLD VOTING MKWORD 5 DCNC APP V Hdefine VT C RESTART VOTING MKWORD 6
254. ly 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 disables all notebook functions notifications 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 5 2 2 7 e enables all RTS functions notifications e enables all CR functions notifications e enables all SPK functions notifications e enables all CS functions notifications Push to talk mode In this mode there is no RTS list 66 Equals Whenever a delegate presses
255. memory as two consecutive bytes where the LSB is stored on the lowest address and the MSB on the next address Bosch Security Systems 2014 July 15 function defined by the function identifier if any The wFnld and the tStructure are tightly coupled Therefore the parameter structure is not defined strictly with the basic types but a special type is used to identify that the structure depends on the function identifier The actual structure definition to be sent along with the remote function is not described in this document The structures are presented along with the definition of the remote function in the interface documents for the application After the remote function request is sent to the CCU the CCU will always send back a response upon the reception of a remote function see 2 2 2 2 The remote controller should wait for the response to be sure that the function ended successfully before sending another remote function to the CCU Note that the CCU does not generate this kind of messages 2 2 2 2 Format of type MDSC REMOTEPROCEDURE RSP Upon receipt of a remote function the CCU shall process the requested function and create a response as result of that function The message type will be equal to the value MDSC REMOTEPROCEDURE The message data received for the response of a remote function follows the following format typedef struct WORD wFnId function identi
256. n about the events coming from a unit user and the possible processing done for the events In the table below an overview is made about the events and the possible actions performed Note that it depends on the type of equipment used and its connection state whether or not the notifications are sent Event CC C RECEIVE DATA Microphone on delegate chairman Microphone off delegate chairman 6 3 2 CC General notifications 6 3 2 1 CC C RECEIVE DATA Purpose This notification sends data received from the connected equipment to the remote controller Notify structure with this update The update comes with the same structure as described in 6 2 2 10 CC T DATA FRAME Bosch Security Systems 2014 July 105 7 SIMULTANEOUS INTERPRETATION 7 1 Introduction The Simultaneous Interpretation Remote Interface is part of the DCN Next Generation software that allows for another controlling entity outside the CCU not being the DCN Next Generation Control PC to use the Simultaneous Interpretation application 7 1 1 Remote Simultaneous Interpretation Control Simultaneous Interpretation is the application that allows preparation and monitoring over the functionality of the interpreter desks Typical control issues are e g setting a desk configuration changing the interlock mode changing the channel languages etc More details on the complete IN application can be found in the user manual USERDOC_IN Controllin
257. n of the remote function request The remote controller should respond on this NAK message by sending again the same request e Atime out of the request pending This means that the CCU does not respond any more The remote controller must wait upon the completion of his remote function request But in rare circumstance it is possible that there are two remote function requests pending In that case the CCU handles both remote function requests after each other order is maintained 2 3 3 Control flow with multiple remote controller s In a DCN NG system as shown in Figure 1 CCU with both a remote controller and the DCN NG Control PC connected there are up to three locations where events can be generated The locations are e The actual units E g microphone keys soft keys voting e The DCN NG Control PC connected using Ethernet This DCN NG Control PC uses Remote Function calls to trigger functionality e The remote controller connected using Ethernet This Remote Controller also uses Remote Function calls to trigger functionality To get a fully operational system both the DCN NG Control PC and the remote controller must register themselves to the CCU so they will receive update messages from the CCU Events coming from a unit are processed During the processing notifications are generated and sent to all registered controllers In the system mentioned above both the DCN NG Control PC and the Remote Controller will receive the
258. n the CCU we will use the Ethernet port present on the CCU DCN NG Control PC TCP IP Controller Figure 1 Hardware configurations remote controls The device PC embedded controller etc connected to the Ethernet port is the second controlling system to the CCU This device is called remote controller in the remaining part of the document The PC on the top right in Figure 1 is the DCN NG control PC A control PC can be connected via Ethernet The remote controller on the right controls an application remotely using the Ethernet port of the CCU This remote controller can be for instance a mimic panel a computer that controls and presents voting results etc Third parties can build their own remote controller software to serve several SW applications Each SW application on the remote controller can control the corresponding application on the CCU using the remote interface protocol 2 1 1 Use of TCP IP port The communication between the CCU and the remote controller is message based remote functions and update notification The messages are transported as binary streams of bytes The remote control interface must be configured according to the specifications in Appendix A 2 1 2 Requirements As mentioned above the remote controller can be connected to the TCP IP port of the CCU For the remote controller the following hard
259. nagement application 5 1 1 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 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 chapter 2 This chapter 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 the remote controller customer build client or DCNNG Control PC uses the TCP IP interface The remote controller makes Remote Function calls for microphone management e The actual units that handle their microphone keys To get a full operational system both the DCNNG control PC and the remote controller must register themselves to the CCU so they will receive update messages from the CCU Remote functions coming from either the DCNNG 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 DCNNG control PC and the remote controller In
260. nction This functions requires the structure MM T RTS as parameter This structure is defined in section 5 2 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 MM E DELETE RTS LIST FAILED 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 5 2 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 Response 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 5 2 6 4 MM C RTS GET 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 Response structure from the function The function returns the following structure typedef struct WORD wNrOfRts MM_T_RTS tRtsList DBSC MAX DELRTS MM T CCU RTSLIST wh
261. nd can be restored e g the functionality will be enabled The new unit s connected to the system is not known For these units the remote controller must start the operational installation mode The operational installation mode is activated using the following remote function request error SI Start Install SI C OPERATIONAL INSTALL MODE if error SI E NOERROR After this the CCU has enabled the operational installation mode The remote controller can start the sequence to assign the new unit numbers to seats not yet assigned do error handling while there are new units and unassigned seats WORD wUnitId wUnitId First new unit available select the unit Bosch Security Systems 2014 July error SI Select Unit wUnitId if error SI E NOERROR do error handling Let the operater determine which seat should be assigned to the selected unit Normally the operator will view which unit is flashing checks the seat number and pass the seat number found to the remote control ler The seat number is stored in the variable wSeatNumber assign the current seat to the unit MyAssignSeat wSeatNumber wUnitId assignment finished deselect the unit error SI Select Unit wUnitId FALSE if error SI E NOERROR do error handling After this sequence handling the newly added units are again assigned to seats This
262. nding 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 and on a delegate unit respectively 7 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 2014 July en 87 UNIT EVENT MATRIX Operational Mode Chairman Delegate with Req List Operator with Req List Operator with Request an Resp
263. ndividual settings are only possible if also open voting is selected When open voting equals false then only the totals will be sent to the Remote Controller Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 enu Note also that if bResultNotify is set to TRUE this notification is sent to the Remote Controller after a hold or stop of the voting round Notify structure with this update The update comes with the structure VT T RESULT REC The structure is defined in section 8 1 4 1 Note that only the totals are sent to the remote controller This wFillLevel parameter of the structure which holds the number of individual delegate information present in the byDelegateVotes array holds the value zero indicating that no individual results are present Related functions VT C START VOTING VT C RESTART VOTING Bosch Security Systems 2014 July 9 ATTENDANCE REGISTRATION AND ACCESS CONTROL 9 1 Internal functioning of Attendance registration 9 1 1 Introduction The Attendance Registration application is divided into three closely related parts a Attendance registration b Access control c Delegate identification In the following section an explanation is given about the three parts Note that if the attendance registration application is not active in the CCU however the authority settings as present in the delegate database are used to accept or reject actions of the delegates For ex
264. ndix an overview is given of the possible errors and their values Remote Function Services Error code Value hex Explanation RFSE BADFUNCTIONID 10901 0x2A95 The remote function called is not registered by the Remote Function Services Either the function does not exist or the CCU is operating in a wrong mode RFSE ALLOCFAILED 10904 0x2A98 The requested data area for the function response could not be allocated The CCU went out of memory during the remote function call RFSE NOACCESSPERMISSION 10907 0x2A9B The remote function called is not authorized for use meaning no license key enabling use of the remote interface function is present on the CCU IPME INVALID MESSAGELENGTH 4485152 0x00447 020 The overall message length of the data is too small below 8 bytes or too large above 8000 bytes Please not that this error code is used only in conjunction with the MESSAGETYPE OIP ResponseProtocolError message System Configuration Error code Value hex Explanation SC E NOERROR 0 0x00 The execution of the remote function was successful SC E WRONG PARAMETER 4106 0x100A The value of a parameter passed in a function call is invalid out of range SC E UNIT NOT FOUND 4107 0x100B The unit does not exist SC E UNIT NOT CONNECTED 4109 0x100D The unit is not connected System Installation Error code Value hex Explanation SI E NOERROR 0 0x00 The execution of the remote function was successful SI E INVALID U
265. ned in section 5 1 1 update notifications are not only the result of remote functions generated by the remote controller but can also be the result of interpreter unit user events It was also mentioned in section 5 1 1 that the relation between the unit user events and the update notifications is indirect i e asynchronous This section gives information about the events coming from a unit user or a remote controller and the processing done for the events In the table below an overview is made about the events and the actions performed IN C CCU CON IN C CHAN STA IN C FLASHI IN C FLOO IN C LANGUA IN C SPEAKS IN C HELP SI TUS NG MIC ON R DISTRIB GE LIST LOWLY SIGN GN UTION Start remote control i call to IN C START IN APP Stop remote control i e call to IN C STOP IN APP Start remote monitoring i e call to IN C START MON IN Stop remote monitoring i e call to IN C STOP MON IN CCU receives a new language list from the remote controller i e call to IN C DOWNLOAD LANGLIST Configuration of the interpreter desks concerning the microphone bar when engaged has changed i e call to IN C SET FLASH MIC ON Configuration of the interpreter desks concerning distribution of the floor signal on the outgoing channel in case no interpretation is performed has changed i e call to IN C SET FLOOR DIST Configuration of the interpreter desks concerning the enabling of speak slowly signaling has changed
266. ned 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 w Unitld Unit Identifier Unit identifiers can be retrieved from the system using the remote functions for System Config chapter 3 bMicroOn TRUE to turn the microphone on FALSE to turn the microphone off Response structure from the function The function has no response parameters Error codes returned MM E NOERROR MM E SPEAKERS LIST FULL MM E INSERT SPEAKERS LIST FAILED Bosch Security Systems 2014 July en 73 MM E NOT IN SPL OR NOB MM E UNIT NOT CONNECTED MM E ILLEGAL OPER MODE MM E ILLEGAL MICRO TYPE 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 5 2 3 2 MM 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
267. ngAbbr DBSC_NCHAR_LANGABBR E where wVersionOfLangList Version of the language list This can be one of the following constants IN C ENG LANG LIST ID standard English list IN C FR LANG LIST ID standard French list C ORG LANG LIST 10 original language list IN C CUS LANG LIST 1 ID custom language list 1 8 Is the default value when wVersionOfLangList argument is incorrect Bosch Security Systems 2014 July 115 e N C CUS LANG LIST 2 ID custom language list 2 e IN C CUS LANG LIST 3 ID custom language list 3 tLangList Array holding the actual language list information Each array element is defined as an IN T LANGLIST structure that is defined below This array is only read and stored when wVersionOfLangList is not equal to IN C ENG LANG LIST or IN C FR LANG LIST else it is discarded wAudioLangld The Identifier of the audio language This parameter is ignored the actual identifier is derived from the array index of tLangList by adding 1 to this index E g the identifier of the audio language in tLangList 2 is 3 szLangName Name of the audio language This must be a null terminated string i e maximum length of the name is DBSC LANGNAME 1 characters followed by the 40 character szLangAbbr Abbreviation of the audio language This must be a null terminated string i e maximum length is DBSC_NCHAR_LANGABBR 1 characters follo
268. ngs bySeatAttend tSettings bySeatAccess tSettings byControlType C ENTRANCE EXIT AT C ONE SEAT AT C IDCARD error AT StoreSetting amp tSettings if error AT E NOERROR Starting attendance registration and access control will be done by calling the following function AT_T_ACTIVATE tActivate do error handling tActivate bAttendanceOn TRUE tActivate bAccessOn TRUE error AT Activate amp tActivate if error AT E NOERROR The CCU is now running attendance registration and access control When a delegate inserts his ID card into an entrance unit the AT application on the CCU sends an individual registration and total registration notification do error handling This result in the following two functions Bosch Security Systems 2014 July void AT SendIndivRegistration T REGISTER INDIV tIndivResul ts WORD wIndex get presence of delegates for wIndex 0 wIndex lt tIndivResults wFillLevel wlndex handle the presency of each delegate separately void AT SendTotalRegistration AT T REGISTER TOTAL tTotalResults update the local results with the new total present and absent information from the CCU When the remote controller is also equipped with a card reader then the delegates may use that card reader to register themselves In that specific case the remote controller reads the ID card and
269. nne 72 5 2 3 1 MM C SET MICRO ON_OFF 72 5 2 3 2 MM C SPK 73 5 2 3 3 MM SPK REMONWE aa qawa 73 5 2 3 4 MM G SPK CGLEAR L epi een 74 5 2 3 5 MM G SPKGET tives iie eee Tiere hentai ge 74 5 2 4 MM Comment Speaker list functions eene 75 5 2 4 1 MM G GS REMOVE stented meet erbe bester 75 524 2 MM OG GS GEM aiit ide eer ie oe ieee ELE RR Ap abe 75 5 2 5 MM Notebook list 76 5 2 5 1 MM REMOVE saria uuu aun aaia aaae DaRi trennen 76 5 2 5 2 MNM G NBK CLEAR era eae ua aa suy 76 5 2 5 3 MNM G NBK GET uno ee vesc S u Qh y uw aa a A Qa eg 76 5 2 5 4 MM G NBK SET akal au aus as aaa kasa ls 77 5 2 6 MM Request to Speak list functions essent 78 5 2 6 MM G RIFS APPEND uci neta E E EE EP re a EOD 79 5 2 6 2 MM G RTS REMOVE tede od e ipe tr sad pte c o n dies eoo add 79 5 2 6 3 MM G RIS CLEAR sci uiid iiec 80 5 2 6 4 MM COCRTS GET iiid iun pte pin nito 80 5 2 6 5 MMSGSRBITS SET Susana sunsu ua Eres 81 5 2 6 6 MM G SHIFT inii erp eed Eee aa ya qua asas aqu sa PRX ees 81 5 2 7 MM Comment Request list functions 82 5271 MM G CF REMOVE in
270. no additional parameters Response structure from the function The function has no response parameters Error codes returned SC E NOERROR Update notifications SC C LOW BATTERY 3 3 16 GET ENCRYPTION ENABLED Purpose Retrieve the current encryption enabled status Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure Bosch Security Systems 2014 July 34 BOOLEAN bEnabled Error codes returned SC_E NOERROR 3 3 17 SC C SET ENCRYPTION ENABLED Purpose Set the current encryption enabled status Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function requires the following structure as parameter BOOLEAN bEnab led Response structure from the function The function has no response parameters Error codes returned SC E NOERROR SC E INVALID CHANNEL SE E FAILED Update notifications SC C ENCRYPTION ENABLED 3 4 System Configuration SC notifications 3 4 1 Introduction This chapter defines the set of update notifications concerning SC send by the CCU 3 4 1 1 Update Notification item explanation Each description consists of the following items e Purpose A global description of the purpose of the notif
271. no input parameters Response structure from the function The function has the following response parameters BYTE bySystemId where bySystemld The system id of the CCU between 0 and 15 Error codes returned SI E NOERROR SI E WRONG PARAMETER Related functions C SET SYSTEM ID 3 5 2 SI C SET SYSTEM ID Purpose Set the system ID of the CCU Availability This function is available in all system modes Parameter structure for the function The function requires the following input parameters BYTE bySystemId where bySystemld The system id of the CCU between 0 and 15 Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E WRONG PARAMETER Related functions SI C GET SYSTEM ID 3 5 3 SI C UNSUBSCRIBE REQ Purpose Unsubscribe one of more units Availability This function is available in all system modes Bosch Security Systems 2014 July 50 Parameter structure for the function The function requires the following input parameters WORD wNrOfUnits UNITID tUnitList DBSC MAX UNIT where wNrOfUnits Number of units to unsubscribe tUnitList List of unit id s to unsubscribe Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E SYSTEM NOT READY Related functions SI C DEINITIALIZE ALL 3 5 451 GET WAP SETTINGS Purpose Retrieve all
272. ns and update notifications that are defined in this document as constant values for the wFnld parameter of the message see chapter 2 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 e g remote function IC C SET LINKS shall be referenced as function as IC Set Links amp tLinks D 9 1 Intercom without update notifications This example shows the steps to be taken for controlling the IC application In this example we will setup a link between some units We will assume an operator has been assigned WORD wError IC T LINKINFO LIST tLinks Set up a bi directional link between units 3 and 7 and one way link from unit 2 to unit 5 tLinks 0 wSourceld 3 from unit 3 tLinks 0 wDestId 7 to unit 7 tLinks 1 wSourceld 7 from unit 7 tLinks 1 wDestId 3 to unit 3 tLinks 2 wSourceld 2 tLinks 2 wDestId 5 End of list tLinks 3 wSourceId IC C UNASSIGNED UNIT tLinks 3 wDestId IC C UNAS
273. nt matrix are generated 5 3 2 MM General notifications 5 3 2 1 MM C SET MIC OPER MODE ON 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 5 2 2 5 5 3 2 2 MM C SET ACTIVE MICS ON PC Purpose Notifies the remote controller that the number of active microphones has changed on the CCU Notify structure with this update The update comes with a structure as defined in section 5 2 2 6 5 3 2 3 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 5 2 2 7 5 3 3 MM Speaker list notifications The Microphone Management speaker list notifications reports the changes in the speakers list 5 3 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 wMicrold 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
274. on Open Interface Release 4 4 en 207 define UNIT FLUSH CHR NODISPLAY DCNC TYPE CHAIRMAN DCNC SUBTYPE FLUSH define UNIT FLUSH DEL NODISPLAY DCNC TYPE DELEGATE DCNC SUBTYPE FLUSH define UNIT INTEGRUS16 DCNC TYPE CHANNELSELECTOR DCNC SUBTYPE 16CHANNEL define UNIT INTEGRUS32 DCNC TYPE CHANNELSELECTOR DCNC SUBTYPE 32CHANNEL define DONC UNIT INTEGRUS4 DCNC TYPE CHANNELSELECTOR DCNC_SUBTYPE_4CHANNEL define DONC UNIT INTEGRUS8 DONC TYPE CHANNELSELECTOR DCNC SUBTYPE 8CHANNEL Hdefine DONC UNIT NG INTERPRETER TYPE INTERPRETER DCNC SUBTYPE DESK Hdefine DONC UNIT VOTING DCNC TYPE DELEGATE DCNC SUBTYPE VOTING define VER DEFAULT OxFF Unit uses Default language define VER ENGLISH 0 define VER FRENCH 1 define VER GERMAN 2 Hdefine DCNC_VER_ITALIAN 3 define VER SIXTH 5 Depending on downloaded OMF file define DCNC VER SPANISH 4 Hdefine C CLEAR LINKS 5 DCNC_APP_IC Hdefine 1 C CLOSE IC APP 2 DCNC_APP_IC define IC C CONN BREAK 1 define 10 C CONNECTED 6 Hdefine IC C DAILING 10 define IC C IDLE 1 define IC C NO 2 define 1 C NO REQ 8 define IC C NOT PRESENT 0 Hdefine 10 C RECEIVING 9 Hdefine 10 C RETURN 5 Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 208 def ine def ine def ine def ine de
275. ons 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 5 2 7 3 5 2 4 1 MM 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 5 2 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 UNKNOWN UNIT Update notifications MM C CS REMOVE ON PC 5 24 2 MM 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 M 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 5 2 3 5 Bosch Security Systems 2014 July
276. onse Delegate with Override and D Delegate List Delegate with Push to Talk C Microphone On MM C MICRO ON OFF MM C MICRO ON OFF MM MICRO ON OFF MM C MICRO ON OFF MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON MM NR CHAIR 5 MM NR CHAIR MICS C Microphone Off MM C MICRO ON OFF 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 5 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 MICRO ON OFF MM C NR CHAIR MICS ON MM C NR CHAIR MICS ON MM C NR CHAIR 5 ON MM C NR CHAIR MICS ON C Priority Off MM C MICRO ON OFF 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 5 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 and if it is also the first in the RTS list and if it is also the first in the RTS list else if the RTS list is not full else MM C RTS INSERT ON PC MM_C_RTS_FIRST_ON_PC MM_C_RTS_FIRST_ON_PG 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 fir
277. orm as described in section 8 1 4 1 Possible settings are TRUE The voting results will be sent in compressed format FALSE The voting result will be sent in normal format How results are displayed on the unit LCD s and when they are automatically sent to the remote controller are described in the following table winterimResultType Description VT C INT RES NONE Results are only available when the vote round is stopped or on hold So when the vote round is running no interim results are shown on the unit LCD s Also the remote controller can only collect the results when the voting is stopped or on hold VT C INT RES TOTAL Only total results are available These results will be shown on the unit LCD s during the complete vote round The total results can be collected by the remote controller VT C INT RES INDIV Individual and total results are available and the totals will be shown on the unit LCD s The results can be collected by the remote controller This setting is only valid during an open voting VT C INT RES TOTAL PC ONLY Total results are available but can only be collected by the remote controller The unit LCD s will not show any results VT C INT RES INDIV PC ONLY Individual and total results are available but can only be collected by the remote controller The unit LCD s will not show any results This setting is only valid during an open voting Response structure from the function The function has no respon
278. oting application controls on the CCU a voting round and passes the results back to the units the hall display and to the remote controller depending on the different settings made This section gives information about the events coming from the units and the processing done for the events In the table below an overview is made about the events and the actions performed Action performed Cast a vote The cast is stored in the voting application and the marker Delegate Chairman votes changed is set 1 second timer tick The marker votes changed is checked When set the update passed notification VT C RESULTSNOTIFY is sent to the remote controller Finally the marker is reset 8 3 3 Voting notifications 8 3 3 1 VT C RESULTSNOTIFY Purpose Notify the remote controller with the total and individual results of the delegates who participate in the current running voting These results will be sent every 2 seconds by the DCN Next Generation system if changes have been detected Further it depends on parameters in the VT C START APP and VT C SET VOTINGPARAMS functions In the following table is described under which circumstances this notification is sent Parameters VT C START APP remote function bResultNotify TRUE VT_C_SET_VOTINGPARAMS remote function winterimResultT ype VT_C_INT_RES_TOTAL VT C INT RES INDIV VT C INT RES TOTAL PC ONLY or VT C INT RES INDIV PC ONLY Note that of the wInterimResultType setting the i
279. outside of this range the error CC E INVALID CAMERA NUMBER is returned The preposition of the camera This preposition is assigned to the unit with unit identifier wUnitld If this parameter is equal to 0 or DBSC EMPTY PREPOS the camera is a fixed camera i e has no prepositions only one fixed position Therefore this parameter can have value 0 DBSC MAX PREPOSITION or DBSC EMPTY PREPOS If it is outside of this range the error CC E INVALID PARAMETER is returned First line of the seat text configured for the camera Note that this parameter may or may not be used depending on the global setting bySeatTextMode see CC C SET GLOBAL SETTINGS This is a NULL terminated string Second line of the seat text configured for the camera Note that this parameter may or may not be used depending on the global setting bySeatTextMode see CC C SET GLOBAL SETTINGS This is a NULL terminated string Response structure from the function The function has no response parameters Bosch Security Systems 2014 July 101 Error codes returned CC E NOERROR CC E NOT INCONTROL CC E INVALID UNITID CC E INVALID CAMERA NUMBER CC E INVALID PARAMETER Related functions CC C SET GLOBAL SETTINGS CC C GET GLOBAL SETTINGS 6 2 2 7 CC C CLEAR CAMERA ASSIGNMENTS Purpose This function clears all camera assignments in the CCU Parameter structure for the function The function has no additional parameters Response st
280. owing structure WORD wNrOfChairMicsOn where wNrOfChairMicsOn The number of chairmen which are speaking 5 3 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 5 2 3 5 5 3 3 4 MM C SPK CLEAR ON PC Purpose Notifies the remote controller that the SPK list is cleared Notify structure with this update The update does not have any additional parameters Bosch Security Systems 2014 July 90 5 3 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 MM T SPK tSpkAdd where tSpkAdd The speaker who is added to the speakers list The structure MM T SPKis defined in section 5 2 3 2 5 3 3 6 MM C SPK 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 tSpkRemove where tSpkRemove The speaker who is removed from the speakers list The structure MM T SPK is defined in section 5 2 3 2 5 3 3 7 MM C SPK INSERT ON PC Purpose Notifies the remote controller that a speaker is inserted before another speaker Notify structure with this update Th
281. plification of 12dB up until 12dB in steps of 1 dB Response structure from the function The function has no response parameters Error codes returned SI E NOERROR SI E WRONG PARAMETER Bosch Security Systems 2014 July 45 3 5 6 SI C SET EXT CONTACT Purpose Sets the usage of the external present contact The external present contact can be used to register present or used as a fraud contact Availability This function is available in CCU system mode config Parameter structure for the function 51 T EXT CONTACT byExtContact where byExtContact The usage of the external present contact which can be SI C NO FUNCTI ON SI C PRESENT or SI C FRAUD SI T EXT CONTACT typedef BYTE SI T EXT CONTACT Response structure from the function The function has no response parameters Error codes returned SI E NOERROR Related functions SI GET EXT CONTACT 3 5 7 SI GET EXT CONTACT Purpose Gets the usage of the external present contact Availability This function is available in CCU system mode config and congress Parameter structure for the function The function has no additional parameters Response structure from the function SI T EXT CONTACT byExtContact where byExtContact The usage of the external present contact which can be SI C NO FUNCTION SI C PRESENT or SI C FRAUD Default behavior is Sl C NO FUNCTION SI T EXT CONTACT typedef BYTESI T EXT CONTACT Error codes returned S
282. pplication is already controlled by this remote controller on the same channel Probably the CC C START CAMERA APP is called for the second time CC E INCONTROL OTHER CHANNEL 5378 0x1502 The CC application is already controlled by another remote controller on another channel CC E NOT INCONTROL 5379 0x1503 The remote controller does not control the application did not call CC C START CAMERA APP CC E INVALID UNITID 5380 0x1504 A unit identifier passed as parameter in the function is invalid CC E INVALID CAMERA NUMBER 5381 0x1505 A camera number passed as parameter in the function is invalid CC E INVALID PORT OUT 5382 0x1506 Sending data to the connected camera equipment failed CC E INVALID CONTROL TYPE 5383 0x1507 The control type passed as a parameter in the function is invalid CC E INVALID PARAMETER 5384 0x1508 A parameter passed in the function is invalid Simultaneous Interpretation Error code Value hex Explanation IN E NOERROR 0 0x00 The execution of the remote function was successful IN E UNKNOWN INTSEAT 514 0x202 The combination Booth and Desk was not recognized as an interpreter seat in the system IN E INTERLOCK NOT ALLOWED 528 0x210 The requested interlock mode is not allowed in the current configuration IN E INCONTROL THIS CHANNEL 529 0x211 The IN application is already controlled by this remote controller on the same channel Probably the IN C START IN APP is called for th
283. r CC Start Camera App switch wError case CC E INCONTROL THIS CHANNEL I have the CC app already under control Is that correct Has the remote controller restarted For the moment assume to be correct and continue break case CC E INCONTROL OTHER CHANNEL Another remote controller has control over the CC application report error and terminate case CC E NOERROR function ended succesfully break default some unexpected error occurred report the error We have now established communication with the CC application on the CCU Since controlling has now started update notifications may arrive Therefore we need the following functions void CC Receive Data CC T DATA FRAME tDataFrame Handle data of tDataFrame Assume that we want to activate camera activity We then need the following functions and control flow CC T CAMERA ACTIVITY tCameraActivity tCameraActivity bCameraActivity TRUE WORD wError wError CC Set Camera Activity amp tCameraActivity if wError CC E NOERROR do error handling We can now send remote functions to configure camera control Bosch Security Systems 2014 July When we no longer need to be able to send remote functions and receive update notifications we can stop the communication with the CC application using the function wError CC Stop Camera AppO if wError CC E NOERROR Thi
284. r the power is turn off or a remote controller is started which changes the settings 8 1 6 Allowed settings without delegate database present The standard use of the voting application will be in combination with a downloaded delegate database However it is possible to start a voting round without a downloaded delegate database In this case the parameter value ranges are limited because some settings require the presence of a delegate database In the table below an overview is given of the parameters with reduced setting due to the absence of the delegate database The table shows the parameters of the remote functions VT C SET VOTINGPARAMS and VT C SET GLOBAL SETTINGS When a parameter is not present in the table the value range as described with the remote function remains valid VT C SET VOTINGPARAMS remote function Bosch Security Systems 2014 July bOpenVoting Only a closed voting is valid therefore FALSE winterimResultT ype VT_C_INT_RES NONE VT_C_INT_RES_TOTAL VT_C_INT_RES_TOTAL_PC_ONLY VT C SET GLOBAL SETTING remote function wPresentVotes VT C 100 PRESENT KEY VT C 100 VALID VOTES VT C 100 PRESENT KEY AND FRAUD VT C 100 EXTERNAL PRESENT bVoteWeightingOn FALSE Note that when no delegate database is present in the DCN Next Generation system and other parameter settings are used the remote function returns with the error code VT E NO NAMESFILE 8 2 Remote Functions 8 2 1 Introduction This
285. rder to receive update notifications Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure WORD wNrOf Instances where wNrOflnstances The value of the update use count for the MD application at the end of the function handling It contains the number of times a remote controller has connected over the same communication medium E g the first time the MD C START MON MD function is called it contains the value 1 Error codes returned MD E NOERROR Related functions MD C STOP MON MD 11 2 2 2 MD C STOP MON MD Purpose Function to stop monitoring the behavior of the Message Distribution application Update notifications will no longer 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 wNrOf Instances Bosch Security Systems 2014 July 167 where wNrOfinstances Error codes returned MD E NOERROR Related functions MD C START MON MD The value of the update use count for the MD application at the end of the function handling It contains the number of times a remote controller is connected over the same communication medium E g when there is only one connection registered for the MD application prior to calling the MD C S
286. re for the function This function has one parameter Bosch Security Systems 2014 July 86 WORD wUnitId where w Unitld 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 5 3 Update Notifications 5 3 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 5 3 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 5 3 1 2 Unit user event relations As we have mentioned in section 5 1 1 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 DCONNG Control connected so only a distinction between chairman and delegate is made In the unit event matrix for each event the corresponding update notifications are given depe
287. registers the delegate to the Attendance application by using the AT C HANDLE IDENTIFICATION remote function For example when two delegates with card code 16824 and 6823 have registered themselves using the remote controller the remote controller performs the following actions AT T IDENTIFICATION tIdentification tldentification wEvent ACSC EVENT INSERT CARD ENTRANCE tIdentification wFillLevel 2 tIdentification tDel Identification 0 dwCardCode 16824 tIdentification tDel Identification 0 wPinCode 0 not used tIdentification tDel Identification 1 dwCardCode 6823 tIdentification tDel Identification 1 wPinCode 0 not used wError AT HandleIdentification amp tIdentification if wError AT E NOERROR Finally when the congress is ended we can stop the Attendance registration and Access control by calling AT_T_ACTIVATE tAct i vate do error handling tActivate bAttendanceOn FALSE tAct ivate bAccessOn FALSE error AT Activate amp tActivate if error AT E NOERROR Now the control can be given back to the CCU by calling the following function error AT_StopATApp 0 if error AT_E_NOERROR do error handling do error handling Bosch Security Systems 2014 July D 7 Text amp Status Display LD In the example below the remote functions and update notifications that are defined in this document as
288. 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 has no response parameters Error codes returned IC E NOERROR IC E NO OPERATOR IC E INCONTROL THIS CHANNEL IC E INCONTROL OTHER CHANNEL IC E NO AUDIO CHANNELS Update notifications UPD AVAILABLE LINES IC UPD OPERATOR STATE Related functions IC C CLOSE IC APP 12 2 2 21C C CLOSE IC APP Purpose Indicates the CCU that the remote controller no longer requires updates from the IC applica tion inside the CCU Parameter structure for the function The function has no additional parameters Response structure from the function Bosch Security Systems 2014 July en 173 The function has no response parameters Error codes returned IC E NOERROR Related functions IC C START IC APP 12 2 2 3 IC SET LINKS Purpose This function allows the remote controller to set special links Parameter structure for the function The function requires the following structure as parameter typedef struct IC T LINKINFO LIST tList 1C_MAX_LINKS_IN_RFC IC T LINKINFO LIST with typedef struct UNITID wSourceld UNITID wDestId IC T LINKINFO STRUCT where wSourceld The unitld of the initiator of the intercom call If the wSourceld is IC C UNASSIGNED UNIT then this is th
289. ructure from the function The function has no response parameters Error codes returned CC E NOERROR CC E NOT INCONTROL 6 2 2 8 CC C SET CAMERA ID Purpose This function sets the ID of one or more cameras Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wLength CC T INDEXED CAMERA ID tIndexedCameraID CC C MAX CAMERA ID CLUSTER CC T SET CAMERA 10 where INDEXED CAMERA is defined as typedef struct UNITID wCamer aNumber CC T CAMERA ID tCameraID T INDEXED CAMERA ID where CAMERA 10 defined as typedef struct CHAR szCameralD CC C MAX CAMERA ID LEN T CAMERA ASSIGNMENT where wLength The number of cameras for which the ID is set in this structure The details and IDs of these cameras can be found in tlndexedCameralD 0 up and until tlndexedCameralD wLength 1 This parameter must be in the range 0 CC C MAX CAMERA ID CLUSTER If it is outside this range the error CC E INVALID CAMERA NUMBER is returned tindexedCameralD Array holding the camera ID information Only the first wLength items actually hold relevant information the rest can be ignored Each array element is defined as a Bosch Security Systems 2014 July en 102 CC T INDEXED CAMERA 10 structure which is defined below wCameraNumber Identifier of the camera as it is known on the connected
290. s and usage The following data types will be used BOOLEAN 1 byte unsigned value with the range 0 1 FALSE and TRUE CHAR a 1 byte type representing ASCII characters Strings are represented as array of CHAR and are terminated with a zero 0 character BYTE a 1 byte unsigned value with the range 0 255 SBYTE a 1 byte signed value with the range 128 127 WORD a 2 byte unsigned value with the range 0 65535 SWORD a2 byte signed value with the range 32768 32767 DWORD a4 byte unsigned value with the range 0 25 1 SDWORD a 4 bytes signed value with the range 2 2 1 Note that all number representation in the data are presented in little endian format 2 2 2 DCN NG message layout 2 2 2 1 Format of type REMOTEPROCEDURE Remote functions are messages which are always transmitted to the CCU The message type must be equal to the value MDSC_REMOTEPROCEDURE_REQ The message data transmitted for a remote function follows the following format typedef struct WORD wFnId function identifier REQSTRUC tStructure function parameters if any RSMT_REMOTEPROCEDURE_REQ where wFnld The function identifier tStructure A structure containing the parameters needed to process the Little endian is a storage mechanism where the least significant byte is stored on the lowest address followed by the more significant bytes E g a WORD is represented in
291. s available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure WORD wNrOf Instances where wNrOfInstances The value of the update use count for the SI application at the end of the function handling It contains the number of times a remote PC has connected over the same communication medium Error codes returned SI E NOERROR SI E REGISTER HRFS FAILED Related functions SI C STOP MON SI 3 5 11 SI C STOP MON SI Purpose Function to stop monitoring the behavior of the SI application Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the number of instances Error codes returned SI E NOERROR SI E NOT INCONTROL Related functions MM C START MON SI 3 6 System Installation SI notifications 3 6 1 Introduction This chapter defines the set of update notifications concerning SI send by the CCU Each description is according to the definition given in section 3 4 1 1 3 6 1 1 Unit user event relations As for the SC application update notifications for SI are also the results of user actions done on the actual units This section gives a unit user event matrix for the SI applic
292. s downloaded into the CCU Using this system we like to use the ID cards for registration and access control for all delegates Because the system does not have an ID card reader in the units we use card readers in the entrance and exit units to register the delegates First the remote controller must register himself to the AT application error AT StartATApp AT C APP CONTROL switch error Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 en 243 case AT E INCONTROL THIS CHANNEL have the attendance registration app already under control Is that correct Is the remote controller restarted For the moment assume to be correct and continue case AT E INCONTROL OTHER CHANNEL Another remote controller has control over the attendance registration app report error and terminate return case AT E INMONITOR THIS CHANNEL tried to open the application for control but it seems that I have the attendance registration application already opened for Monitoring attendance report error and terminate return case AT E NOERROR function ended succesful continue break default some unexpected error occurred report the error We now have control over the attendance registration application and may change the settings but first the input parameter structure must be filled in AT T SETTINGS tSettings tSetti
293. s ends remotely controlling the CC application do error handling D 4 Simultaneous Interpretation In the example below the remote functions and update notifications that are defined in this document as constant values for the wFnid parameter of the message see chapter 2 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 it is assumed that the function will create its structure transport the parameters to the CCU and wait for the result information coming from the CCU For both the remote functions and the update notifications the same names are used as their identifier but without the constant mark C and using mixed case names So e g remote function IN C START IN APP shall as function be referenced as IN Start IN App void D 4 1 Simultaneous Interpretation Control This example shows the minimum steps to be taken for controlling the IN application First we have to start controlling the IN application on the CCU typedef struct BOOLEAN bConnectChanges IN T MICSTAT tIntMics IN T ACTIVECHAN tInActiveChan IN T CHANNELS tAChannels T CHANNELS tBChannels T CHANNELS tInChannels IN T CHAN STATUS typedef struct byBetweenLock BYTE byWithinLock BYTE byMaxChans WORD wVerLangList T CHANNELLANG tChanL
294. s function is used to get length of the request to respond list Parameter structure for the function This function has one parameter WORD wNewMax where wNewMax The length of the request to respond list Related functions MM C SET MAX RSP LIST LEN 5 2 7 5 MM C SET MAX RSP LIST LEN Purpose This function is used to set the request to respond list Parameter structure for the function This function has one parameter WORD wNewMax where wNewMax The length of the request to respond list Related functions MM C GET MAX RSP LIST LEN 5 2 8 MM Speechtime functions This section describes the functions to manipulate the speech time There is no synchronization 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 speech time for each individual speaker and invoke the relevant speech time function 5 2 8 1 MM C SET SPEECHTIME SETTINGS Purpose This function stores the speech time settings in the CCU Parameter structure for the function This function requires the following structure as parameter typedef struct WORD wSpeechT imeL imi t BOOLEAN bTimerOn Bosch Security Systems 2014 July 85 BOOLEAN bHoldOnChairPriority BOOLEAN bShowRemainingT ime BOO
295. s functioning The value is an OR mask of the following settings e SC C STANDALONE e SC C EXTENDED e SC C SINGLETRUNC e SC C MULTITRUNC e SC C MASTER e SC C SLAVE szSwVersion The current operating mode of the CCU in readable text The Bosch Security Systems 2014 July 26 string is zero 40 terminated If e g itis a Single CCU running extended software this string would read EXTENDED SingleTrunc Version byMajorVersionOfDownloadedSw byMinorVersionOfDownloadedSw The major and minor version numbers of the downloaded software OMF file If no downloaded software is present then both will be zero If e g the downloaded software is DCN NG 4 0 byMajorVersionOfDownloadedSw will be 4 and byMinorVersionOfDownloadedSw will be 0 byMajorVersionOfResidentSw byMinorVersionOfResidentSw bySystemMode byReservedForSwinfo tCCUType byTCBVersion byReservedForHwInfo szSWHelNum Error codes returned SC E NOERROR The major and minor version numbers of the resident software Boot software If e g the resident software is of version 1 0 byMajorVersionOfResidentSw will be 1 and byMinorVersionOfResidentSw will be 0 The Current System Mode of the CCU Value according to following type e DCNC_SM_DOWN DCNC_SM_INIT DCNC_SM_CONFIG DCNC_SM_CONGRESS DCNC_SM_MAINTENANCE DCNC_SM_DOWNLOAD Reserved space for extra software information Type of CCU connected to Value according
296. s not contain the wUnitProperties which is available in SC T UNIT DATA PROPERTY For explanation of the parameters see SC GET CONFIG PROPERTY Error codes returned SC E NOERROR 3 3 6 SC C GET CCU CONFIG PROPERTY Purpose Retrieve information about all units connected to the congress network This function returns for each unit connected its unit number type and capabilities of the unit Availability This function is available in CCU system mode congress Parameter structure for the function The function requires the following structure as parameter WORD wC luster Index where wClusterlndex Determines which cluster is to be returned as response Zero 0 to retrieve the first cluster of SC C CLUSTER MAX units One 1 for the second cluster of SC C CLUSTER MAX units etc When the cluster is not completely filled then that cluster is the last cluster available All cluster indexes greater than this one will have an empty tUnitData array However the other three elements of the response structure will still contain correct data Response structure from the function The function returns the following structure typedef struct WORD wNumberOfS aveCCUs WORD wNumber 0fUni tsConnected WORD wNumberOfUni ts SC T UNIT DATA PROPERTY tUnitData SC C CLUSTER MAX SC T CCU CONFIGURATION where the SC T UNIT DATA PROPERTY is defined as Bosch Security Systems 2014 July
297. s present in the dwSerialNr array Only this amount of array elements is transmitted This number will be limited to the upper bound of the dwSerialNr array size dwSerialNr Array holding the serial number of each slave node Error codes returned SC E NOERROR SC E WRONG PARAMETER SC E UNIT NOT FOUND Related functions SC C REQ SERIAL NR 3 3 9 SC C GET UNIT IDS Purpose Retrieve the unit identification s of the unit with the specified serial number A unit can have one or more unit identifications Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function DWORD dwSer ialNr where dwSerialNr The serial number of a unit Response structure from the function typedef struct WORD wNrOfUni ts UNITID tUnitId DBSC_MAX_ACT_UNIT SC T UNIT LIST where wNrOfUnits The number of unit list entries actual present in the tUnitld array Only this amount of array elements is transmitted This value never exceeds the constant DBSC MAX ACT UNIT tUnitld Array holding the list of unit ids Error codes returned SC E NOERROR SC E WRONG PARAMETER SC E UNIT NOT FOUND Bosch Security Systems 2014 July 31 Related functions SC C REQ SERIAL NR 3 3 10 SC BATTERY STATUS REQ Purpose This function will request the battery status of all units in the parameter list After executing this function a notification will be send
298. s response structure in section 5 2 5 3 5 3 6 MM Request to Speak list notifications The Microphone Management request to speak notifications report the remote controller the changes in the RTS list 5 3 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 5 2 6 4 5 3 6 2 MM C RTS CLEAR ON PC Purpose Notifies the remote controller that the RTS list is cleared Notify structure with this update The update does not have any additional parameters 5 3 6 3 MM RTS REMOVE ON PC 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 structure which indicates the delegate unit combination to be removed The structure MM T RTS is defined in section 5 2 6 5 3 6 4 MM 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 5 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
299. s unknown i e not in the range LD C DISPLAY ONE LD C DISPLAY FOUR LD E WRONG PARAMETER 3077 0 05 A parameter passed in the remote function has an invalid value LD E LINES OVERFLOW 3078 0xC06 The total number of lines configured for MM display information exceeds the maximum of LD C MAX NUMBER OF DISPLAY LINES i e the number of speaker lines added tot the number of request to speak lines exceeds LD C MAX NUMBER OF DISPLAY LINES LD E APP NOT STARTED 3079 0 07 Indicates that no remote controller has taken over the LD application control from the CCU and therefore the remote controller is not allowed to call the remote function Message Distribution Error code Value hex Explanation MD E NOERROR 0 0x00 The execution of the remote function was successful MD E NO MORE MESSAGES ALLOWED 2576 0xA10 The maximum number of messages is reached maximum is 10 Note that this holds for messages of type MD DELEGATE and of type MD ROV INTERPRETER for the type MD C HALL only one message at a time is possible and a new message overwrites the previous message Messages can be cleared by calling MD C CLEAR MESSAGE ON UNITS with type MD C DELEGATE or MD C ROV INTERPRETER Note that there is only one queue of size 10 that holds whatever kind of messages are sent any mix of messages of type MD C DELEGATE and MD C ROV INTERPRETER is possible In order to completely empty the que
300. sabled or enabled Bosch Security Systems 2014 July 117 Parameter structure for the function The function requires the following structure as parameter BOOLEAN bSpeakSlowlySign where bSpeakSlowlySign TRUE if speak slowly signaling must be enabled FALSE if speak slowly signaling must be disabled Response structure from the function The function has no response parameters Error codes returned IN E NOERROR IN E APP NOT STARTED Update notifications IN C SPEAKSLOWLY SIGN Related functions IN C GET SPEAKSLOWLY SIGN 7 2 3 16 IN C GET SPEAKSLOWLY SIGN Purpose This function is used to retrieve the interpreter desks configuration concerning the enabling of speak slowly signaling There are two possibilities either the function is disabled or enabled Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure BOOLEAN bSpeakSlowl ySign where bSpeakSlowlySign TRUE if speak slowly signaling is enabled FALSE if speak slowly signaling is disabled Error codes returned IN E NOERROR IN E APP NOT STARTED Related functions IN C SET SPEAKSLOWLY SIGN 7 2 3 17 IN SET HELP SIGN Purpose This function is used to configure the interpreter desks concerning the enabling of help signaling There are two possibilities either the function is disabled or enabled Parameter structure for the f
301. se parameters Bosch Security Systems 2014 July Error codes returned VT E NOERROR VT E VOTE RUNNING VT E NO NAMESFILE VT E WRONG PARAMETER VT E APP NOT STARTED Related functions VT C START VOTING 8 2 2 9 VT C SET GLOBAL SETTINGS Purpose This function allows the remote controller to set the global voting settings on the CCU No voting may be running during the call to this function Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wVot ingLedMode WORD wPresentVotes BOOLEAN bShowVoteT imer WORD wVoteTimerL imit BOOLEAN bReser ved1 must be set to FALSE BOOLEAN bAutoAbstain BOOLEAN bReserved2 must be set to TRUE BOOLEAN bVoteWeightingOn BOOLEAN bReserved3 must be set to FALSE BOOLEAN bFirstVoteCount VT T GLOBAL SETTINGS where wVotingLedMode This setting is an indication whether soft LED s on the delegate units will Remain on after casting a vote Valid values are e VT C LED SHOWVOTE VT C LED SECRET ON OFF VT C LED SECRET FLASH ON See the table below for explanation about the setting values wPresentVotes This setting tells how to determine the number of participants in a voting The setting is one of the following e VT C 100 PRESENT KEY e VT C 100 VALID VOTES e VT C 100 AUTHORISED VOTES e VT C 100 PRESENT KEY AND FRAUD e VT C 100 EXTERNAL PRESENT See the table below for explanation about setting values bS
302. serial number will be OxFFFFFFFF 3 4 11 SC C BATTERY INFO COND Purpose Notifies the remote controller the condition of the battery located in the unit This notification is send after SC C BATTERY INFO REQ is executed Notify structure with this update The update comes with the following structure typedef struct UNITID tUnitlId WORD wChar geCount SC T BATTERY INFO COND where tUnitld The unit identifier of a unit wChargeCount Number of charges discharges for the battery which has been passed located in the unit When the unit has no battery the number of charges discharges will be 0 3 4 12 SC C SIGNAL STATUS Purpose Notifies the remote controller the signal status of a unit This notification is send after the signal status of a unit has been changed or after SC C SIGNAL STATUS REQ is executed Notify structure with this update The update uses the following structure typedef struct UNITID tUnitId SC T SIGNAL LEVEL tSignalLevel SC T SIGNAL STATUS where tUnitld The unit identifier of a unit tSignalLevel The signal level of the unit which is one of the following e SC_C_SIGNAL_EXCELLENT e SC C SIGNAL GOOD e SC C SIGNAL POOR Bosch Security Systems 2014 July 41 3 4 13 SC C SIGNAL QUALITY Purpose Notifies the remote controller the quality of the signal within the system This notification is send after the signal quality has been changed or after SC C SIGNAL QUA
303. settings of the WAP Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS Parameter structure for the function The function has one parameter UNITID tUnitId where tUnitld Reserved The unit identifier of a WAP Must be DCNC UNASSIGNED UNIT Response structure from the function The function returns the following structure typedef struct UNITID tUnitId SI T CARRIER byCarr ier SI T WIRELESS POWERLEVEL byPowerLevel BYTE byOptions SI WAP SETTINGS where tUnild The unit identifier of a WAP This will be DCNC UNASSIGNED UNIT if there is no WAP connected to the CCU byCarrier The carrier of the WAP which is one of the following e SI C CARRIER BAND 1 e SI C CARRIER BAND 2 e SI C CARRIER BAND 3 byPowerLevel The coverage of the WAP which is one of the following e SI C POWERLEVEL OFF e SI C POWERLEVEL LOW e SI C POWERLEVEL MEDIUM e SI C POWERLEVEL HIGH Bosch Security Systems 2014 July 51 byOptions The options field is at least equal to e WAP ENABLE LANGUAGE DISTRUBUTION Additionally the following value can be set when Wireless encryption is enabled e WAP ENABLE ENCRYPTION Error codes returned SI E NOERROR Related functions SI C SET WAP SETTINGS SI E WRONG PARAMETER 3 5 5 51 C SET WAP SETTINGS Purpose Set all settings of the WAP Availability This function is available in system mode MAINTENANCE CONFIG and CONGRESS
304. shown on one line of 16 characters e CC C SCREEN LINE DOUBLE The screenline as defined in the Delegate Database software is shown on two lines of 16 characters e CC C SEAT TEXT The first line of the seat text configured for the camera see CC C SET CAMERA ASSIGNMENT is shown on one line of 16 characters e CC C SEAT TEXT DOUBLE Both lines of the seat text configured for the camera see CC C SET CAMERA ASSIGNMENT is shown on two lines of 16 characters If this parameter has another value the error CC E INVALID PARAMETER is returned but only when wCameraControlType is equal to CC C ALLEGIANT VIDEO SWITCHER in all other cases the value of byMovementTime is not used Defines the type of camera control used i e the type of equipment connected to the CCU that interfaces to the cameras This can be one of the following e CC C NO CAMERA CONTROL TYPE No equipment is used to control the cameras i e camera control is not possible e CC C ALLEGIANT VIDEO SWITCHER An Allegiant Video Switcher is used to control the cameras 99 see USERDOC CC for details e CC C DIRECT CAMERA CONTROL One AutoDome camera is used to control the camera positions the CCU directly interfaces to the camera see USERDOC CC for details If this parameter has another value the error CC E INVALID CONTROL TYPE is returned Response structure from the function The function has no response parameters Error codes return
305. something went wrong with registering for remote interface Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 eni23 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 gt 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 tMMSett ings BOOLEAN bMustSend FALSE retrieve the current settings MM Get Settings amp tMMSettings and check if they are what we want if tMMSettings wOperationMode MM C OPERATOR WITH REQ LIST tMMSettings wOperationMode MM C OPERATOR WITH REQ LIST bMustSend TRUE if tMMSettings wActiveMics 4 tMMSett ings wActiveMics 4 bMustSend TRUE if tMMSettings wMaxRTSListLen 50 tMMSettings wMaxRTSListLen 50 bMustSend TRUE Set new settings if we have to if bMustSen
306. ssage Type DWORD dwLength Message Length BYTE byData Message Data Length 8 bytes 1 Where dwMessageType The message type which describes the content of the actual data passed dwLength The total length of the message in number of bytes including the sizes of the message type and length The length must match the actual transmitted size of bytes Since the MessageT ype and the Length are always present the minimum size of the message is 8 bytes The maximum size of a message is 8000 bytes byData Data here is the data described in paragraph 2 2 3 1 2 2 3 2 and 2 2 3 3 Registration for an application is done by calling a start application remote function call This function call enables the transmission of update notification for that application The update can be stopped again by calling the stop application remote function call Bosch Security Systems 2014 July en 17 2 2 3 1 Format of type MESSAGETYPE OIP KeepAlive Purpose The heartbeat message is a special message which can be sent to the DCN NG System at any time In normal circumstances the heartbeat message is transmitted every 5 seconds when nothing else to transmit The message is used to notify the DCN NG System that your system is still alive The DCN NG System also sends heartbeat messages to indicate that the DCN NG System is still operational You must check if two successive messages are received within 15 seconds
307. st in the RTS list and if it was the first in the RTS list and if it was the first in the RTS list MM C RTS FIRST ON PC MM C RTS FIRST ON PC MM C RTS FIRST ON PC D Microphone Off MM C SPK REMOVE ON PC MM C MICRO ON OFF MM C MICRO ON OFF MM C SPK REMOVE ON PC D Comment Request if the CR list is not full MM C CR ADD ON D Cancel Comment MM C CR REMOVE ON PC 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 MM C CR CLEAR ON PC Bosch Security Systems 2014 July 88 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 5 2 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 eve
308. system consisting of multiple slave CCU s and one master CCU Message Distribution Data transmitted along with a specific message type The data is needed to fulfill the purpose of the message Specifies the purpose of the message e g remote function call etc Microphone Management en 11 MSB MTB MV NAK Names file NBK list NG NPPV OMF File PC PCB Present Key PV Remote Controller RFS RTS list SM SPK list ST STP TCB TCP Unitld Unitld UTP VD VT Most Significant Byte Multi Trunc Board Multi Voting Negative acknowledge of a packet Permanent store for delegate data that are related identifiable within DCN NG Notebook list list of chairmen and special assigned delegates Next Generation Ne Prennent pas Poart an Vote delegate is present and does not want to take part with the current voting round An executable file in a special format that can be programmed or downloaded into the Read Only Memory on the CCU Personal Computer Printed Circuit Board The leftmost softkey of the delegate or chairman unit softkey 1 with 5 softkeys present in case the settings and activation for attendance registration request for that functionality Parliamentary Voting Device e g PC connected to the CCU that remotely controls one or more of the applications present in the CCU Remote Function Services Request To Speak list System Configuration Single CCU system System Inst
309. tType VT C INT RES NONE More information about the parameters can be found in section 8 2 2 8 General voting The general voting settings consists of many parameters which have settings the following default values wVotingLedMode VT C LED SHOWVOTE wPresentVotes VT C 100 PRESENT KEY bShowVoteTimer FALSE wVoteTimerLimit 0 bReservedl FALSE bAutoAbstain FALSE bReserved2 TRUE bVoteWeightingOn FALSE bReserved3 FALSE bFirstVoteCount FALSE More information about the parameters can be found in section 8 2 2 9 8 1 5 1 Standalone settings During startup of the DCN Next Generation system power on the voting settings are set to their initial values as described in 8 1 5 However when the DCN Next Generation system was controller by a Remote Controller and new settings were enabled After stopping the voting application Call to function VT C STOP APP some voting settings remain active during the standalone period These settings are VT C SET GLOBAL SETTING remote function wVotingLedMode This setting remains unchanged wPresentVotes In case VT C 100 AUTHORISED VOTES was selected the value of wPresentVotes will change to VT C 100 VALID VOTES For the others of wPresentVotes the settings remains unchanged bFirstVoteCounts This setting remains unchanged All other settings will return to their default values as described in 8 1 5 The settings remain valid until eithe
310. tandalone multi master multi slave and single Ccu o SI C SET OPERATION MODE Value set of byStartupMode Translation of Startup Mode and Slave ld to multi mode standalone multi master multi slave and single Ccu o SI C GET WAP SETTING Value set of byOptions o SI C SET WAP SETTING Value set of byOptions o SI C WAP SETTING Value set of byOptions Bosch Security Systems 2014 July
311. te notifications of the MD application are listed in this chapter 11 3 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 11 3 1 2 Unit user event relations As mentioned in section 5 1 1 update notifications can be the result of unit user events This section gives information about the events coming from a unit and the processing done for the events In the table below an overview is made about the events and the actions performed X Press and hold auxiliary button Delegate unit Release auxiliary button Delegate unit Press and hold speak slowly button interpreter desk Release speak slowly button interpreter desk Press and hold help button interpreter desk Release help button interpreter desk Close external present contact Delegate unit with external present contact Bosch Security Systems 2014 July en 170 MD C REQ BUTTON ON OFF Open external present contact Delegate unit X with external present contact 11 3 2 MD General Notifications 11 3 2 1 MD C REQ BUTTON ON OFF Purpose This notification informs the remote controller that a request button on a unit is pressed and held or released The notification specifies which button on which unit is pressed
312. ted text on the display wNumOfChars The size of the current text on the display in characters The text in szData therefore is found in szData 0 szData wNumOfChars 1 This parameter can have value 0 DCNC MAX DISPLAYDATA SIZE Bosch Security Systems 2014 July 165 11 MESSAGE DISTRIBUTION FOR A REMOTE INTERFACE 11 1 Introduction The Message Distribution Remote Interface is part of the DCN software which allows for another controlling entity outside the CCU not being the DCN Control PC to use the Message Distribution application 11 1 1 Remote Message Distribution Control The Message Distribution application provides a means of generating and distributing text messages in a DCN environment The message can be distributed to the following destinations e Delegates e Interpreters e Conference hall displays The user can specify exactly which delegates or interpreters the message has to be distributed to If the message has to be distributed to more than one destination for example delegates and interpreters it is sent to each destination in turn More details on the complete MD application can be found in the user manual USERDOC MD Using MD with a remote interface is achieved by means of calling a defined set of Remote Functions The general concept of Remote Functions is described in chapter 2 This chapter also describes the protocol and hardware conditions concerning the remote interface
313. tion as described examole 2 in Appendix D Multi CCU System Remote Controller connected to the Master as specified in chapter 2 Even Update Notification Continue with remote function Switch On a Slave CCU lt None gt while Master CCU is still off Switch On Master CCU SC C CCU REBOOT SC C START APP Recommended before continuing SC_C_GET_CCU_VERSIONINFO SC_C_GET_CCU_CONFIG SI C START INSTALL and run installation as described example 1 in Appendix D Switch On a Slave CCU SC C CONNECT SLAVE CCU Recommended before continuing on the unit connect updates SI C START INSTALL and run installation as described example 2 in Appendix D and a few seconds later for every unit connected to that Slave CCU separately SC_C_CONNECT_UNIT Switch Off a Slave CCU SC_C_DISCONNECT_SLAVE_CCU eee Connect a Unit SC C CONNECT UNIT Recommended before continuing SI C START INSTALL and run installation as described examole 2 in Appendix D Single Multi System i e a Multi CCU system but one or more of the Slave CCU s configured to run in Single Mode Even Update Notification Continue with remote function Remote Controller connected to CCU A a CCU configured to run in Remote Controller connected to CCU A a CCU configured to run in Single CCU mode On CCU A SC C CCU REBOOT SC C START APP Recommended before continuing SC_C_GET_CCU_VERSIONINFO SC_C_GET_CCU_CONFIG
314. tions to the remote controller Update notifications are sent upon state changes due to actions from the control PC s and all microphone actions on the units 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 wNrOflnstances 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 called it contains the value 1 Error codes returned MM E NOERROR MM E OPEN CLOSE FAILED Related functions MM C STOP MM 5 2 2 2 MM C STOP MM Purpose Indicates the CCU that the remote controller no longer requires updates from the MM applica tion 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 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 r
315. to following type e SC_C_DCN_CCU2 e SC_C_DCN_CCUB2 Hardware version of the CCU Reserved space for extra hardware information Software version number as ASCII string The string is zero 407 terminated This is the string representation of byMajorVersionOfDownloadedSw plus byMinorVersionOfDownloadedSw e g if the version of the downloaded software is 4 0 this string will read 4 0 3 3 5 SC GET CONFIG lt deprecated gt Purpose Retrieve information about all units connected to the congress network This function returns for each unit connected its unit number and type Availability This function is available in CCU system mode congress Do not use this function because this function becomes deprecated in next major release Parameter structure for the function The parameter structure is the same as SC C GET CCU CONFIG PROPERTY Response structure from the function The function returns the following structure Bosch Security Systems 2014 July en 27 typedef struct WORD wNumberOfsS aveCCUs WORD wNumberOfUn tsConnected WORD wNumberOfUni ts SC T UNIT DATA tUnitData SC C CLUSTER MAX SC T CCU CONFIGURATION where the SC T UNIT DATA is defined as typedef struct WORD wUnitId BYTE byUnitType SC T UNIT DATA The respons structure is almost the same as SC C GET CONFIG PROPERTY with the exception of the T UNIT DATA structure which doe
316. to the remote controller using this update notification His status will then be changed to AT C ATTEND NOCHANGE to inform that the presence has not changed The same situation can occur when the delegate has already left the system Error codes returned AT E NOERROR AT E APP NOT STARTED Update notifications C SEND INDIV REGISTRATION AT C SEND TOTAL REGISTRATION Related functions AT C START AT APP 9 3 Update Notifications 9 3 1 Introduction This chapter describes the various update notifications send by the CCU AII the update notifications of the AT application are listed in this chapter A global description of notifications is made in chapter 2 9 3 1 1 Preconditions The update notifications coming from the AT application use the Unitld and Delegateld to connect each other The valid Unitld s in the DCN NG system can be queried and the Delegateld s can be set using remote functions described in chapter 4 9 3 1 2 Notification item explanation Each 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 e Related functions The related function in conjunction with the notification described Bosch Security Systems 2014 July 157 9 3 2 Attendance Registration and Access Control notifications 9 3 2 1 AT C SEND INDIV REGISTRA
317. ton Activated Delegate set as Operator activated Delegate as push to talk notebooker Delegate as push to talk notebooker excluded from access control Chairman as push to talk notebooker DCN Next Generation Open Interface Release 4 4 en 215 define C VIP PTTCHAIRMAN NO AC 13 Chairman as push to talk notebooker excluded from access control define C VIP VCHAIR 5 Chairman set as Voice activated define C VIP VOICE 4 Delegate set as Voice activated define C VOICE NO AC 9 Voice Activated Delegate excluded from Access Control H define COMMUNICATION PARAMS 0x0002 def ine RSMC SET COMMUNICATION PARAMS 0x0001 H define SC C BATTERY INFO COND MKWORD 45 DCNC APP SC SC C BATTERY INFO REQ MKWORD 40 DCNC APP SC SC C BATTERY INFO SERIAL MKWORD 44 DCNC APP SC SC C BATTERY STATUS MKWORD 43 DCNC APP SC SC C BATTERY STATUS REQ MKWORD 39 DCNC APP SC def ine SI C CARRIER BAND 1 0 def ine SI C CARRIER BAND 2 1 def ine SI C CARRIER BAND 3 2 def ine SC C CCU MODE CHANGE MKWORD 16 DCNC APP SC def ine SC 6 CCU REBOOT MKWORD 15 DCNC APP SC def ine SC C CHECK LINK MKWORD 18 DCNC APP SC def ine SC C CLUSTER MAX 1500 def ine SC C CONNECT SLAVE CCUMKWORD 13 DCNC_APP_SC itdefine SC C CONNECT UNIT MKWORD 9 DCNC APP SC def ine SC C DCN CCU 1 d
318. trol of IN to the remote controller It is now impossible for another remote controller e g DCNNG Control PC to gain control of the application After this function has been called the remote controller will receive update notifications from the IN application see section 6 3 1 2 When the execution of this function is omitted all other remote functions except the other start and stop functions will have no effect and will return an error code IN E APP NOT STARTED Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure WORD wNrOf Instances where wNrOfinstances Error codes returned IN E NOERROR The value of the update use count for the IN application at the end of the function handling It contains the number of times a remote controller has connected over the same communication medium E g the first time the IN START IN APP function is called it contains the value 1 Note that calling IN C START MON IN will also increase this update use count IN E INCONTROL OTHER CHANNEL IN E INCONTROL THIS CHANNEL Bosch Security Systems 2014 July 108 Update notifications IN C CCU CONFIG IN C CHAN STATUS IN C LANGUAGE LIST C FLASHING ON IN C SPEAKSLOWLY SIGN IN C HELP SIGN Related functions IN C STOP IN APP 7 2 3 31 STOP IN APP Purpose Indicate the
319. troller The returned update use count can be used to detect if the remote controller is connected too often When you omit the execution of this remote function you can still execute remote functions but no update messages will be sent to the remote controller Availability This function is available in CCU system modes config and congress Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure WORD wNrOf Instances where wNrOflnstances The value of the update use count for the SC application at the end of the function handling It contains the number of times a remote PC has been connected over the same communication medium E g the first time the function SC_C_START_APP is called it contains the value 1 Error codes returned SC E NOERROR Related functions SC C STOP APP 3 3 3 SC STOP APP Purpose Indicates the CCU that the remote controller no longer requires updates from the SC application inside the CCU After receiving this function the CCU decrements the update use count As long as the update use count is greater than zero the CCU remains sending the update notifications to the remote controller Bosch Security Systems 2014 July 25 Note that Upon communication loss this function will be activated if SC C START APP was activated The activation of this function is rep
320. tructure containing the delegate identification Bosch Security Systems 2014 July dwCardCode ID Card code of the delegate that should be registered Valid ID card codes are in the range 1 MAX CARD CODE the ID card code must be unique for every delegate in the DCN NG system wPinCode PIN code of the delegate hat should be registered The PIN code is only used when the Control Type is set to the value AT C IDCARD PINCODE see 9 2 2 3 Valid PIN codes are in the range 111 55555 whereby each digit must be in the range of 1 5 Set the field wPinCode to 0 zero if PIN codes are not used The number of digits to be used is also stored into the delegate database PIN codes do not have to be unique This function will handle the request only if the function AT_C_STORE_SETTINGS is called before with the settings bySeatAttend AT_C_ENTRANCE_ EXIT bySeatAccess AT_C_ONE_SEAT byControlType AT C IDCARD or AT_C_IDCARD_PINCODE and the function AT ACTIVATE is called before to activate either Attendance Registration or Access Control or both Response structure from the function The function has no response parameters Error codes returned AT E NOERROR AT E HANDLE IDENTIFICATION FAILED AT E APP NOT STARTED AT E SETTING NOT CORRECT AT E NOT INCONTROL AT E ILLEGAL EVENT AT E ILLEGAL ARRAY SIZE Update notifications C SEND INDIV REGISTRATION AT C SEND TOTAL REGISTRATION Related functions AT C S
321. tructure 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 5 3 6 6 5 3 7 5 MM C MAX RSP LIST LEN Purpose Notifies the controller that the length of the request to respond list has changed Notify structure from the function WORD wNewMax Update notifications MM C MAX RSP LIST LEN 5 3 8 MM Speechtime notifications The Microphone Management speechtime notifications report the remote controller the changes in the Speechtime setting 5 3 8 1 MM C TIMER ON OFF Purpose Notifies the controller that there is a change in using not using of the speech timer Notify structure with this update The update does not have any additional parameters Bosch Security Systems 2014 July 95 6 CAMERA CONTROL 6 1 Introduction The Camera Control Remote Interface is part of the DCN Next Generation software that allows for another controlling entity outside the CCU not being the DCN Next Generation Control PC to use the Camera Control application 6 1 1 Remote Camera Control Control Camera Control is the application that allows configuration of Automatic Camera Control Typical configuration issues are e g setting camera assignments setting camera acticity setting global settings etc More details on the complete CC application
322. ttendance registration application keeps track of the delegate which enters the system become present and leaves the system become absent The differences if any are reported to the remote controller every second 9 1 1 2 Access Control Access Control keeps track of the delegate s accessibility for the applications Microphone Management Intercom and Voting as stored in the delegate database Note that the content of the delegate database is controlled by the remote functions available in the System Configuration application More information can be found in chapter 3 A delegate can get control for an application if he has access according to the authority settings in the delegate database using one of the following options e Entering his PIN Code on his unit e Inserting his ID card in his or any unit e Inserting his ID card in the entrance unit to get access for his seat as stored in the delegate database Inserting the ID card in the exit unit disables the accessibility One of the above options is selectable for access control Note The use of the ID card can as an extra option be combined with entering a pin code Bosch Security Systems 2014 July The Access Control options are set in combination with the attendance registration options 9 1 1 3 Delegate Identification This functionality provides information about what delegate is seating on which unit Delegate Identification i e location information is availa
323. ture for the function The function requires the following structure as parameter typedef struct WORD wNrOfNbk MM T NBK tNbkL i st DBSC MAX NOTEBOOKL IST MM T CCU NBKLIST Where the MM T NBK is defined as Bosch Security Systems 2014 July 78 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 is transmitted This value never exceeds the constant DBSC MAX NOTEBOOKLIST INbkList 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 wMicroType The type of microphone handling for the notebook entry The following microphone types are valid for the notebook entries e MM C CHAIRMAN MM C VIP KEY MM C VIP OPERATOR MM C VIP VOICE MM C VIP 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 MM C VIP PTTCHAIRMAN MM C VIP PTT MM C VIP PTTCHAIRMAN NO AC MM C VIP PTT NO AC 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 DCNNG Control PC Response structure from the function The function has no response parameters Error codes returned MM E
324. ue MD C CLEAR MESSAGE ON UNITS must be called twice once messages of type MD C DELEGATE and once for messages of type MD C ROV INTERPRETER MD E NO AUX BUTTON 2578 0xA12 A function relating to the auxiliary button is called for a unit that does not have an auxiliary button Intercom Error code Value hex Explanation IC E NOERROR 0 0x00 The execution of the remote function was successful IC E NO AUDIO CHANNELS 1796 0x704 There are no audio channels available for intercom Bosch Security Systems 2014 July DCN Next Generation Open Interface Release 4 4 eni29 Intercom Error code Value hex Explanation IC E NO OPERATOR 1797 0x705 There is no operator assigned IC E INCONTROL THIS CHANNEL 1810 0x712 The CCU is already in control with this channel IC E INCONTROL OTHER CHANNEL 1811 0x713 The CCU is already in control by another channel IC E WRONG PARAMETER 1812 0x714 The value of a parameter passed in a function call is invalid out of range Bosch Security Systems 2014 July APPENDIX D EXAMPLES D 1 System Configuration In the examples below the remote functions and update notifications that are defined in this document as constant values for the wFnld parameter of the message see chapter 2 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
325. unction The function requires the following structure as parameter BOOLEAN bHelpSign where bHelpSign TRUE if help signaling must be enabled FALSE if help signaling must be disabled Response structure from the function The function has no response parameters Error codes returned IN E NOERROR IN E APP NOT STARTED Bosch Security Systems 2014 July en 118 Update notifications IN C HELP SIGN Related functions IN C GET HELP SIGN 7 2 3 18IN GET HELP SIGN Purpose This function is used to retrieve the interpreter desks configuration concerning the enabling of help signaling There are two possibilities either the function is disabled or enabled Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure BOOLEAN bHelpSign where bHelpSign TRUE if help signaling is enabled FALSE if help signaling is disabled Error codes returned IN E NOERROR IN E APP NOT STARTED Related functions IN C SET HELP SIGN 7 23 19 IN C ASSIGN UNIT Purpose This function is used to assign unit s to the given booth and desk numbers Parameter structure for the function The function requires the following structure as parameter typedef struct WORD wNrOfUnits IN T UNIT ASSIGN tUnitAssignList DBSC MAX INTSEAT IN T UNIT ASSIGN LIST where the IN T UNIT ASSIGN is defined as type
326. user events and update notifications can be found in the user event matrices in sections 3 4 1 2 en 3 6 1 1 3 1 1 1 Remote function item explanation Each description consists of the following items e Purpose A global description of the purpose of the function e Availability CCU System modes in which the function is available See section 3 1 2 e Parameter structure for the function The input parameters needed to fulfill the function When the function requires no parameters no structure is described here e Response structure from the function The output information returned by the function called This information is only valid when the wError field of the received response information equals SC E NOERROR SI E NOERROR or DB E NOERROR e Error codes returned The error values returned in the wError field of the response information All different error codes are described in Appendix C Error Codes 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 Related functions The related function in conjunction with the function described It refers to other remote functions and to related update notifications Bosch Security Systems 2014 July 23 3 1 2 System Modes To understand the SC and SI functions one should have some knowledge on the behavior of the CC
327. ution TRUE if the floor signal must be distributed on the outgoing channel when no interpretation is performed FALSE if no signal must be distributed on the outgoing channel when no interpretation is performed Response structure from the function The function has no response parameters Error codes returned IN E NOERROR IN E APP NOT STARTED Update notifications IN C FLOOR DISTRIBUTION Related functions IN C GET FLOOR DIST 7 2 3 14 IN GET FLOOR DIST Purpose This function is used to retrieve the current setting concerning distribution of the floor signal on the outgoing channel in case no interpretation is performed There are two possibilities either the floor signal is distributed or no signal is distributed Parameter structure for the function The function has no additional parameters Response structure from the function The function returns the following structure BOOLEAN bFloorDistribution where bFloorDistribution TRUE if the floor signal is distributed on the outgoing channel when no interpretation is performed FALSE if no signal is distributed on the outgoing channel when no interpretation is performed Error codes returned IN E NOERROR IN E APP NOT STARTED Related functions IN C SET FLOOR DIST 7 2 3 15 IN C SET SPEAKSLOWLY SIGN Purpose This function is used to configure the interpreter desks concerning the enabling of speak slowly signaling There are two possibilities either the function is di
328. value OxF means VT C VOTE UNASSIGNED Due to the limitation of the data length of the structure both communication settings have their restrictions which are Normal The byDelegateVotes holds for each element read byte the vote result of one delegate This means that the structure can hold information for VT C MAX RESULT DELEGATE delegates When there are more Bosch Security Systems 2014 July delegates in the system you cannot use this way of receiving Compressed The byDelegateVotes holds for each element read byte the vote result of two 2 delegates Using the compressed way of receiving results the structure can hold 2 VT C MAX RESULT DELEGATE delegates which is large enough to hold all delegates However the vote result is now stored in the upper or lower nibble of a byte This implies that the total number of possible answers is limited to 14 answers 2 answer values are always reserved for not present and present and not voted This limitation of the number of answers inhibits certain voting kinds which are not discussed further in this document Note that the parliamentary type of voting only uses 3 answer options As a result of both restrictions we can take the conclusion that we cannot receive the voting result of voting kinds which use more that 14 answer options and if the system holds more than VT C MAX RESULT DELEGATE delegates Delegate voting result organization The delegate voting results ar
329. wLength The total length of the Heartbeat message 24 bytes for this message dwReserved1 Session sequence number Currently the reserved is not used and should be set to the value zero 0 dwHReserved2 Message sequence number Currently the reserved2 is not used and should be set to the value zero 0 dwErrorCode The error code of the received message For the possible error Bosch Security Systems 2014 July 18 dwErrorPosition Related messages codes see Appendix C The byte offset in the message stream where the fault is detected Any message received by the DCN NG System and is not conform the message guideline as described in 2 2 3 2 2 3 3 Format of type MESSAGETYPE OIP Dcn Command messages can be sent to control the DCN NG System Commands always result in a response from the DCN NG System The expected response is referenced with each command or the generic response MESSAGETYPE OIP ResponseProtocolError iS returned in case the message is corrupted Each command message starts with a fixed number of fields which are presented below in structure format NOTE In the time between the transmission of the command message and the reception of the response message the DCN NG System can receive notification messages struct BYTE WORD BYTE 0 DCN MSGTYPE byDcnMsgType wFnId byMessageTypeHeader Fixed value 0x43 struct OIP DCN MSGTYPE tMessageType DWORD
330. ware requirements are needed for the systems We assume that the DCN NG Control PC connected to an Ethernet port is the primary controller for the CCU The remote controller is then the secondary controller Only one remote controller is needed to control remotely Both controllers may be present and operate concurrent controlling different parts of the CCU Bosch Security Systems 2014 July 14 Single Multi CCU system DCN CCU This type of CCU has 1 TCP IP port An UTP or STP cable is used to connect the master CCU CCU to the remote controller The TCP IP port number used for the communications is described in Appendix A 1 2 1 3 Hardware connection 2 1 3 1 CCU The hardware connection between the CCU and remote controller is made by using an UTP or STP cable The maximum cable length between the CCU and the remote controller may be approximately 100 meter When longer distances are needed we advise the use of a repeater which ensures the transmission between two systems 2 2 Message format The communication used between the remote controller and the CCU is based on messages This chapter describes the format of the message and the different message types used to transport data between the remote controller and the CCU 2 2 1 Conventions In the sections and chapters below several structures are defined To prevent problems these structures are defined using standard data types which have defined size
331. wed by the O character Response structure from the function The function has no response parameters Error codes returned IN E NOERROR IN E APP NOT STARTED Update notifications IN C LANGUAGE LIST 7 2 3 121 C SET FLASH Purpose This function is used to configure the interpreter desks concerning the microphone button ring when engaged The microphone button ring can be set to be flashing or non flashing stays on when engaged Parameter structure for the function The function requires the following structure as parameter BOOLEAN bFlashingWhenEngaged where bFlashingWhenEngaged TRUE if the microphone button ring must be flashing when engaged FALSE if the microphone button ring must not be flashing when engaged Response structure from the function The function has no response parameters Error codes returned IN E NOERROR IN E APP NOT STARTED Update notifications IN C FLASHING ON Bosch Security Systems 2014 July en 116 7 2 3 13 IN C SET FLOOR DIST Purpose This function is used to configure the interpreter desks concerning distribution of the floor signal on the outgoing channel in case no interpretation is performed There are two possibilities either the floor signal is distributed or no signal is distributed Parameter structure for the function The function requires the following structure as parameter BOOLEAN bFloorDistribution where bFloorDistrib
332. y 4 2 4 C DOWNLOAD 61 4 2 5 DB G CEEAR CGU siie a pep d ap dul saa Aca ce 61 4 2 6 DB C CCU APP Y ONE au da ree tr ea etate ede 62 5 Microphone managemoent nnmnnn nnmnnn nnmnnn nnmnnn nnmnnn nnmnnn annann 63 S T iniroretfei m 63 5 1 1 Remote Microphone Management Control 63 5 1 2 Microphone List and Mode Management 63 5 2 Remote Functions eter ee mno eni e 66 5 2 4 Introduction 66 5 21 1 Preconditions u y ei dee HER deep I ea eee de ore HER a ev beg kus 66 5 2 1 2 Remote function item 66 5 2 2 MM General functions isei taret am dete oontra 67 5 2 2 4 MMC START MM iecit repetere Erebi epe pate bett ka fe beau 67 5 2 2 2 MM C STOP 00440 000000000000 oup sayaq nennen enne 67 5 2 2 3 MM_C_START_MON_MM n nennen nennen nnne nene 68 5 2 2 4 MM C STOP 22 00044 nnne asss 68 5 2 2 5 MM C SET MIC OPER 69 5 2 2 6 MM C SET ACTIVE iia 69 5 2 2 7 MM GET SETTING S Bree tee e n eet Eri 70 5 2 2 8 MM G SET SETTINGS ture Rite ant cte 71 5 2 3 MM Speaker list functions e
333. y presses on the units in order of the seats When a soft key is pressed the CCU sends a notification During the processing of that function we select the unit where the key is pressed and assign the current seat number to the provided unit number This result in the following function void SI Register Unit SI T UNIT STRUCT tUnitStruct First turn off the previous selected unit PR uen error SI Select Unit tUnitStruct wUnitId TRUE if error SI E NOERROR do error handling assign the current seat to the unit MyAssignSeat wCurrentSeatNumber tUnitStruct gt wUnitId Increment to the next seat wCurrentSeatNumber wCurrentSeatNumber 1 and save the unitId to turn off during the assignment of the next seat Bosch Security Systems 2014 July Note that this function is only an example to shown how the interaction between update notifications and remote functions can appear For instance when you press a soft key the second time this function will fail Better is to look if the selected unit has already a seat assigned If not the assign and increment if assigned just keep the assignment When done with all seats present in the conference hall we can leave the global installation mode This is done using the following sequence first turn off the last selected unit error SI Stop Install 0 if error 51 E NOERROR Th
334. ypedef struct WORD wCameraNumber BYTE byPreposNumber CHAR szSeatText 1 CC C MAX SEAT TEXT LEN CHAR szSeatText 2 CC C MAX SEAT TEXT LEN T CAMERA ASSIGNMENT where wLength tindexedCameraAssignment wUnitld tCameraAssignment wCameraNumber byPreposNumber szSeatText 1 szSeatText 2 The number of cameras for which an assignment is set in this structure The assignment of these cameras can be found in tlndexedCameraAssignment 0 up and until tlndexedCameraAssignment wLength 1 This parameter must be in the range 0 C MAX CAMERA ASSIGNMENT CLUSTER If it is outside this range the error CC E INVALID UNITID is returned Array holding the camera assignment information Only the first wLength items actually hold relevant information the rest can be ignored Each array element is defined asa CC T INDEXED CAMERA ASSIGNMENT structure which is defined below Unit identifier of the unit delegate or chairman to which the camera is assigned If this identifier is equal to C OVERVIEW ID the assignment of the overview camera will be set If this parameter is larger than or equal to DBSC MAX UNIT the error CC E INVALID UNITID is returned Camera information and settings belonging to the camera assignment The content of this structure is defined below Identifier of the camera as it is known on the connected equipment This parameter can have value 1 DBSC MAX CAMERA If it is

Installation Manual - Bosch Security Systems

Contents

Download Pdf Manuals

Related Search

Related Contents