User manual

ManualsBrandsBosch ManualsComputer equipmentRS-232

DCN Next Generation

Open Interface Release 2.0

en User Manual

Summary of content (210 pages)

PAGE 1
DCN Next Generation Open Interface Release 2.
PAGE 2
PAGE 3
DCN Next Generation Open Interface Release 2.0 en | 3 Table of sections General Description.............................................................................................. 4 System Configuration, System Installation and Database .............28 Microphone Management................................................................................61 Simultaneous Interpretation .......................................................................105 Voting .....................................
PAGE 4
DCN Next Generation Open Interface Release 2.0 General Description General Description Bosch Security Systems B.V.
PAGE 5
DCN Next Generation Open Interface Release 2.0 General en | 5 Table of Contents 1. Introduction ............................................................................................................................................. 6 1.1 Purpose......................................................................................................................................... 6 1.2 Scope..............................................................................................................
PAGE 6
en | 6 DCN Next Generation Open Interface Release 2.0 General 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the general remote interface aspects for any application to be remotely controlled on the CCU by third party software. 1.2 Scope This Software Requirements Specification describes the general aspects for the remote interface. It is meant for developers who want to use this remote interface to control applications present in the CCU. 1.
PAGE 7
en | 7 DCN Next Generation Open Interface Release 2.0 General ‘#’ ‘@’ Number symbol At character (value 0x23) (value 0x40) 1.4 Overview Chapter 2 describes the general system setup to control the CCU using third party hardware. This chapter mainly handles the hardware aspects of the interface. Chapter 3 describes the format of the data message exchanged between the remote controller and the CCU.
PAGE 8
en | 8 DCN Next Generation Open Interface Release 2.0 General 2. SYSTEM SETUP To interface with applications present in the CCU, we will use a serial port present on the CCU (in case of a multi-CCU system, the serial port or the Ethernet port of the master CCU is used). DCN NG Control PC RS-232 ACN CCU RS-232 DCN NG network Remote Controller Figure 1 Hardware configurations remote controls The device (PC, embedded controller, etc.) connected to a serial port1.
PAGE 9
en | 9 DCN Next Generation Open Interface Release 2.0 General 2.2 Requirements As mentioned above the remote controller can only be connected to a serial port of the CCU. For the remote controller the following hardware requirements are needed for the systems2: An RS-232 cable with 1 to 1 wiring (RS-232 extension cable, see Figure 2) is used to connect the CCU to the remote controller. Note that these CCUs use hardware handshaking with the CTS and RTS signals.
PAGE 10
en | 10 DCN Next Generation Open Interface Release 2.0 General 3. 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. 3.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 sizes and usage.
PAGE 11
DCN Next Generation Open Interface Release 2.0 General en | 11 3.2.1 Format of type MDSC_REMOTEPROCEDURE_REQ 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; REQSTRUC tStructure; } RSMT_REMOTEPROCEDURE_REQ; // function identifier // function parameters if any! where: wFnId The function identifier.
PAGE 12
DCN Next Generation Open Interface Release 2.0 General en | 12 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. 3.2.3 Format of type MDSC_NOTIFY Upon a status change the CCU reports this change by sending an update notification to the remote controller.
PAGE 13
DCN Next Generation Open Interface Release 2.0 General en | 13 the range 0-1000. The value 0 (zero) implies that the heartbeat check will be turned off. Note that heartbeat message is still allowed (for synchronisation purposes). wNrRetries The number of retries to be done before the packet will be discarded. Valid values are in the range 0-10. Note that this count includes the retransmission upon the reception of a NAK-packet.
PAGE 14
en | 14 DCN Next Generation Open Interface Release 2.0 General 4. PROTOCOL DESCRIPTION The message described in the previous chapter must be transmitted between the CCU and the remote controller. The transmission mechanism uses a protocol to detect errors on the communication line. For the serial communication there are three protocols available: • a ‘terminal’ protocol This is not actually a protocol used for data communication. This setting is used to connect a standard ASCII terminal.
PAGE 15
DCN Next Generation Open Interface Release 2.0 General en | 15 ⇒ A message is expected to be sent as one block. The CCU checks if each byte is received within 50 ms of the previous byte. If not, a NAK-packet will be sent. ⇒ Upon reception of a NAK-packet the last transmitted message is resent again. ⇒ Each message includes a sequence number. The receiver may use this sequence to order the messages received.
PAGE 16
DCN Next Generation Open Interface Release 2.0 General en | 16 ledges the data-message identified with the sequence number passed within the header. ‘#’ Defines the negative acknowledge packet (NAK). The packet only consists of the header and the checksum. No data is present within this packet. This packet requests a retransmission of the data-message identified with the sequence number passed within the header. More information about the NAK-packet handling is given in §4.2.2.
PAGE 17
en | 17 DCN Next Generation Open Interface Release 2.0 General could also contain the escape value, this implies that the data must be scanned to translate the escape value into an escape sequence. The ‘full’ feature protocol uses the 0xC8 byte value as escape sequence. This escape sequence is always followed by another character-byte, which informs the actual function of the bytes. The following character-bytes (header type) are defined: 0xC8 The 0xC8 byte is defined.
PAGE 18
en | 18 DCN Next Generation Open Interface Release 2.0 General • Before accepting any data-messages a heartbeat packet must be received first. Because the heartbeat includes the sequence number of the next data packet, the receiver can only check if the received data packet is in sequence after the reception of a heartbeat. • The sequence number coming along with the message must be used to detect if a message is received twice (same sequence number). • Each message is sent with a checksum.
PAGE 19
en | 19 DCN Next Generation Open Interface Release 2.0 General Description Value The maximum message data length 5000 bytes Typical remote function execution time (exclusive the time needed for transmission of the data). < 0,5 sec. Note that the timing value for the ‘heartbeat-time’, the ‘retry-time’ and the ‘number of retries’ can be changed by sending the special message-type MDSC_COMMUNICATION_PARAMS. The layout for that message type is described in §3.2.4.
PAGE 20
en | 20 DCN Next Generation Open Interface Release 2.0 General then the receiver may assume that the connection is lost. The heartbeat check time should be reset whenever a message (of any type) is received. Note that during many message transmissions the transmission of the heartbeat message may be omitted, because any message received from the CCU is valid to be used as heartbeat. 4.3 ‘Simple’ feature protocol The ‘Simple’ feature protocol is meant to be used with small DCN NG systems.
PAGE 21
en | 21 DCN Next Generation Open Interface Release 2.0 General 4.3.3 Checksum calculation The packet is terminated with a checksum byte, which holds the checksum over all data inside the header and message. The Checksum is calculated using the following sequence: • Sum all bytes over the header and the message. • Take modulo 256 of the calculated checksum and do a bitwise invert of the checksum. This calculated checksum is sent along with the packet.
PAGE 22
DCN Next Generation Open Interface Release 2.0 General en | 22 • The NAK packet. This implies that the CCU had a checksum error found after the reception of the remote function request. The remote controller should respond on this NAK message by sending again the same request. • A time-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.
PAGE 23
DCN Next Generation Open Interface Release 2.0 General 5. REMOTE FUNCTIONS 5.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 a 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.
PAGE 24
DCN Next Generation Open Interface Release 2.0 General en | 24 APPENDIX A. PROTOCOL & SERIAL PORT SETTING A.1. Protocol Settings CCU In this Single CCU configuration two serial ports are available. Both ports can be individually configured. The default settings for both serial ports are: • 8 data bits • No parity check • 1 stop bit Port 1 The baudrate for port 1 can be set by setting Dip-Switches 3+4 of as shown in the following table: Switch Baudrate 3 4 off off 9.6k off on 19.2k on off 57.
PAGE 25
DCN Next Generation Open Interface Release 2.0 General en | 25 The protocol for port 2 can be set by setting Dip-Switches 5+6 as shown in the following table: Switch Protocol 5 6 off off Simple off on Terminal on off Full on on Camera control Remark The serial port is used with the ‘Simple’ feature protocol as described in §4.3. The serial port is used with an ASCII interface. Expected is a terminal to do diagnostics on the CCU.
PAGE 26
en | 26 DCN Next Generation Open Interface Release 2.0 General APPENDIX B. VALUES OF THE DEFINES In this document some definitions are given, which have values connected to them.
PAGE 27
en | 27 DCN Next Generation Open Interface Release 2.0 General APPENDIX C. ERROR CODES Responses returned upon a remote function request contain a error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Remote Function Services Error code Explanation RFSE_BADFUNCTIONID 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.
PAGE 28
DCN Next Generation Open Interface Release 2.0 SC, SI and DB System Configuration, System Installation and Database Bosch Security Systems B.V.
PAGE 29
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 29 Table of Contents 1. Introduction ........................................................................................................................................... 31 1.1 Purpose....................................................................................................................................... 31 1.2 Scope.........................................................................................................
PAGE 30
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 30 Appendix B. Error Codes ......................................................................................................................... 56 Appendix C. Examples ............................................................................................................................. 58 C.1. Assigning seats using global installation .................................................................................. 58 C.2.
PAGE 31
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 31 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for system configuration and system installation for the DCN NG system. The document specifies the interface between the CCU and third party software. 1.2 Scope This Software Requirements Specification describes the current state of the remote interface for system configuration and system installation.
PAGE 32
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 32 2. SC, SI AND DB 2.1 Introduction The System Configuration, System Installation and Delegate Database 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, System Installation and Database applications. 2.
PAGE 33
en | 33 DCN Next Generation Open Interface Release 2.0 SC, SI and DB Related functions The related function in conjunction with the function described. It refers to other remote functions and to related update notifications. 2.3 System Modes To understand the SC and SI functions, one should have some knowledge on the behavior of the CCU depending on the various so-called system modes. This section gives a brief, although complete, description of these modes.
PAGE 34
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 34 3. SYSTEM CONFIGURATION (SC) FUNCTIONS 3.1 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. • 3.
PAGE 35
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 35 Related functions SC_C_STOP_APP 3.4 SC_C_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.
PAGE 36
DCN Next Generation Open Interface Release 2.0 SC, SI and DB • • • • • szSwVersion en | 36 SC_C_EXTENDED SC_C_SINGLETRUNC SC_C_MULTITRUNC SC_C_MASTER SC_C_SLAVE The current operating mode of the CCU in readable text. The string is zero (‘\0’) terminated. If e.g. it is 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).
PAGE 37
DCN Next Generation Open Interface Release 2.0 SC, SI and DB WORD en | 37 wClusterIndex; where: wClusterIndex 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.
PAGE 38
DCN Next Generation Open Interface Release 2.
PAGE 39
en | 39 DCN Next Generation Open Interface Release 2.0 SC, SI and DB 4. SYSTEM CONFIGURATION (SC) NOTIFICATIONS 4.1 Introduction This chapter defines the set of update notifications concerning SC send by the CCU. 4.1.1 Update Notification item explanation Each description consists of the following items: • Purpose A global description of the purpose of the notification. • Notify structure with this update The information passed with the update notification. 4.1.
PAGE 40
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 40 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.6. 4.
PAGE 41
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 41 4.6 SC_C_DISCONNECT_SLAVE_CCU Purpose Notifies the remote controller that the master-CCU has lost connection to one of his slaveCCU’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.
PAGE 42
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 42 5. SYSTEM INSTALLATION (SI) FUNCTIONS 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 2.2.1. 5.
PAGE 43
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 43 Update Notifications SC_C_CCU_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 5.3 SI_C_STOP_INSTALL Purpose This function stops the installation started with the 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.
PAGE 44
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 44 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_T_SELECT_UNIT; where: wUnitId The unit identifier of the unit selected. bSelectOn TRUE: All LED’s of the unit will be flashing.
PAGE 45
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 45 Parameter structure for 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. 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_C_GET_EXT_CONTACT 5.
PAGE 46
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 46 wUnitId 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.
PAGE 47
en | 47 DCN Next Generation Open Interface Release 2.0 SC, SI and DB 6. SYSTEM INSTALLATION (SI) NOTIFICATIONS 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 4.1.1. 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.
PAGE 48
DCN Next Generation Open Interface Release 2.0 SC, SI and DB • DCNC_UNIT_CCU_CONTROL • DCNC_UNIT_AUDIO_IO Bosch Security Systems B.V.
PAGE 49
en | 49 DCN Next Generation Open Interface Release 2.0 SC, SI and DB 7. DELEGATE DATABASE (DB) FUNCTIONS 7.1 Introduction The system configuration functions allow users to compile a comprehensive database of information relating to participants at a conference or meeting. This chapter defines the set of remote functions for system configuration. 7.2 DB_C_START_APP Purpose Indicate the CCU that the remote controller wants to communicate with the delegate database in the CCU.
PAGE 50
DCN Next Generation Open Interface Release 2.0 SC, SI and DB 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 7.4 DB_C_MAINT_CCU Purpose The delegate database in the CCU can be changed 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.
PAGE 51
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 51 access control. lPin Delegate pin code. A numeric value in the range 111...555551. PIN codes or DB_C_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 UnitId retrieved with SC_C_GET_CCU_CONFIG or equal to DCNC_UNASSIGNED_UNIT. byiDeskLang Delegate display language.
PAGE 52
DCN Next Generation Open Interface Release 2.0 SC, SI and DB 7.5 DB_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 DB_C_MAINT_CCU. Response structure from the function The function has no response parameters.
PAGE 53
DCN Next Generation Open Interface Release 2.0 SC, SI and DB 7.7 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.
PAGE 54
en | 54 DCN Next Generation Open Interface Release 2.0 SC, SI and DB APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them. In this appendix all defines will be connected to their values. The values are presented in ‘C’-syntax and are grouped on related purpose.
PAGE 55
en | 55 DCN Next Generation Open Interface Release 2.
PAGE 56
en | 56 DCN Next Generation Open Interface Release 2.0 SC, SI and DB APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. System Configuration Error code Explanation SC_E_NOERROR The execution of the remote function was successful. System Installation Error code Explanation SI_E_NOERROR The execution of the remote function was successful.
PAGE 57
en | 57 DCN Next Generation Open Interface Release 2.0 SC, SI and DB Database Query Services Error code Value (hex.) Explanation (0x28A4) Updating the delegate database with the current DB_T_PERDELEGATE structure failed. DB_E_UPD_DEL_PIN_CHANGED Update failed because the PIN code changed. DB_E_UPD_DEL_CARD_CHANGED Update failed because the card code is changed.
PAGE 58
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 58 APPENDIX C. EXAMPLES In the examples below the remote functions and update notifications, that are defined in this document as constant values for the wFnId parameter of the message (see section General), 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.
PAGE 59
DCN Next Generation Open Interface Release 2.0 SC, SI and DB en | 59 /* ........ */ } 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.
PAGE 60
DCN Next Generation Open Interface Release 2.0 SC, SI and DB 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 controller.
PAGE 61
DCN Next Generation Open Interface Release 2.0 Microphone Management Microphone Management Bosch Security Systems B.V.
PAGE 62
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 62 Table of Contents 1. Introduction ........................................................................................................................................... 64 1.1 Purpose....................................................................................................................................... 64 1.2 Scope.................................................................................................
PAGE 63
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 63 4.1.2 Unit/user event relations................................................................................................ 89 4.2 MM General notifications ............................................................................................................ 91 4.2.1 MM_C_SET_MIC_OPER_MODE_ON_PC................................................................... 91 4.2.2 MM_C_SET_ACTIVE_MICS_ON_PC .......................
PAGE 64
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 64 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for microphone management between the CCU and third party software. 1.2 Scope This Software Requirement Specification describes the remote interface for microphone management. It is meant for developers who want to use this remote interface to control the microphone management application, present in the CCU, remotely.
PAGE 65
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 65 2. MICROPHONE MANAGEMENT FOR A REMOTE INTERFACE 2.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 Management application. 2.2 Remote Microphone Management Control Microphone Management is the application that allows for controlling the microphones in the conference hall.
PAGE 66
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 66 Microphone Management application has five microphone lists, which will be explained in the table below: List Notebook Explanation 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.
PAGE 67
DCN Next Generation Open Interface Release 2.0 Microphone Management Mode OPERATOR WITH REQUEST LIST equals MM_C_OPERATOR_WITH_REQ_LIST en | 67 Mode description & Group enable/disable Manual mode. The operator (using the remote controller) controls the RTS list. Delegates are always added to the RTS list and the operator determines which delegate may speak. Special features are to disable the cancel of an request and to turn off the microphone by the delegates (see section 3.2.
PAGE 68
DCN Next Generation Open Interface Release 2.0 Microphone Management The CS functions and notifications mentioned in the table are described in respectively, sections 3.4 and 4.4. The RTS functions and notifications mentioned in the table are described in respectively, sections 3.5.4 and 4.6. The CR functions and notifications mentioned in the table are described in respectively, sections 3.7 and 4.7. Bosch Security Systems B.V.
PAGE 69
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 69 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the various remote functions needed to perform microphone management on the system. 3.1.1 Preconditions The remote functions for the MM application acting on any of the microphone lists always use the UnitId to perform the requested functionality. For the Request to speak list or Comment Request list functions also a DelegateId is required.
PAGE 70
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 70 Response structure from the function The function returns the following structure: WORD wNrOfInstances where: wNrOfInstances The value of the update use count for the MM application at the end of the function handling. It contains the number of times a remote PC has connected over the same communication medium. E.g. the first time the MM_C_START_MM function is called, it contains the value 1.
PAGE 71
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 71 Error codes returned MM_E_NOERROR MM_E_OPEN_CLOSE_FAILED Related functions MM_C_START_MM 3.2.3 MM_C_START_MON_MM Purpose Function to start the monitoring behavior of the Microphone Management application. It is not allowed/possible to control settings of Microphone Management. Parameter structure for the function The function has no additional parameters.
PAGE 72
DCN Next Generation Open Interface Release 2.0 Microphone Management following: • • • • • en | 72 MM_C_OPERATOR_WITH_REQ_LIST MM_C_DELEGATE_WITH_REQ_LIST MM_C_DELEGATE_WITH_OVERRIDE MM_C_DELEGATE_WITH_VOICE MM_C_OPERATOR_WITH_COMMENT_LIST If the operation mode is set to MM_C_OPERATOR_WITH_COMMENT_LIST, the maximum number of active microphones will be set to 1 if not done by the operator. Response structure from the function The function has no response parameters.
PAGE 73
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 73 3.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.
PAGE 74
DCN Next Generation Open Interface Release 2.0 Microphone Management 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.
PAGE 75
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 75 Delegate unit micro on The unit is appended to the SPK list if possible. Delegate unit micro off The units’ microphone is turned off, but the unit still remains in the SPK list. To remove the speaker also from the SPK list, use the remote call MM_C_SPK_REMOVE (see section 3.3.3). Delegate unit micro on (already in the SPK list) The units’ microphone is turned on. The unit remains in the SPK list.
PAGE 76
DCN Next Generation Open Interface Release 2.0 Microphone Management Parameter structure for the function The function requires the following structure as parameter: typedef struct { WORD wUnitId; } MM_T_SPK; where: wUnitId Unit Identifier Response structure from the function The function has no response parameters.
PAGE 77
DCN Next Generation Open Interface Release 2.0 Microphone Management Error codes returned MM_E_NOERROR Update notifications MM_C_SPK_CLEAR_ON_PC Related functions MM_C_SPK_APPEND 3.3.5 MM_C_SPK_GET Purpose Retrieve the complete contents of the Speakers list as present in the CCU. Parameter structure for the function The function has no additional parameters.
PAGE 78
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 78 Parameter structure for the function This function requires the structure MM_T_SPK as parameter. This structure is defined in section 3.3.2. Response structure from the function The function has no response parameters. Error codes returned MM_E_NOERROR MM_E_ILLEGAL_MIC_OPER_MODE MM_E_UNIT_NOT_PRESENT MM_E_UNKNOWN_UNIT Update notifications MM_C_CS_REMOVE_ON_PC 3.4.
PAGE 79
DCN Next Generation Open Interface Release 2.0 Microphone Management Related Functions MM_C_NBK_SET MM_C_NBK_GET 3.5.2 MM_C_NBK_CLEAR Purpose Clear the complete contents of the Notebook list Parameter structure for the function The function has no additional parameters. Response structure from the function The function has no response parameters. Error codes returned MM_E_NOERROR Update notifications MM_C_NBK_SET_ON_PC Related Functions MM_C_NBK_SET 3.5.
PAGE 80
DCN Next Generation Open Interface Release 2.0 Microphone Management • • • • • • bMicroOn 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 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.
PAGE 81
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 81 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.
PAGE 82
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 82 Response structure from the function The function has no response parameters.
PAGE 83
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 83 Update notifications MM_C_RTS_CLEAR_ON_PC MM_C_RTS_CLEAR_COMMENT_ON_PC Related functions MM_C_RTS_APPEND MM_C_RTS_REMOVE 3.6.4 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.
PAGE 84
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 84 Related functions MM_C_RTS_GET 3.6.6 MM_C_SHIFT Purpose Perform a shift function, i.e. promote a delegate from the RTS list to the Speakers list. The shift differs from other RTS list or Speakers list functions in such a way that the promoted delegate is always added to the speakers list, whether this list is full or not. Besides, the CS list and CR list if present are also cleared. This includes the following steps: 1.
PAGE 85
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 85 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. 3.7.1 MM_C_CR_REMOVE Purpose Remove one delegate/unit combination from the CR list on the CCU.
PAGE 86
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 86 full or not. Besides, of all units present in the SPK list the microphones will be turned off. This includes the following steps: 1. Remove the indicated Comment Request entry from the CR list. When the indicated entry does not exist in the CR list an error is returned. 2. Turn off the microphones off all entries in the SPK list. 3. Look if there is an entry free in the CS list.
PAGE 87
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 87 where: wSpeechTimeLinit Speech time limit in minutes bTimerOn TRUE: use the speech timer FALSE: don’t use the speech timer bHoldOnChairPriority TRUE: hold timer if one or more Chairman press their Prio button. FALSE: don’t hold timer. bShowRemainingTime TRUE: down counting timer. FALSE: up counting timer.
PAGE 88
DCN Next Generation Open Interface Release 2.0 Microphone Management wUnitId The unit on which to place the message. Response structure from the function This function has no response parameters. Error codes returned MM_E_NOERROR MM_E_UNKNOWN_UNIT Related functions MM_C_SET_SPEECHTIME_SETTINGS MM_C_LAST_MINUTE_WARNING Bosch Security Systems B.V.
PAGE 89
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 89 4. UPDATE NOTIFICATIONS 4.1 Introduction This chapter describes the various update notifications sent by the CCU. All the update notifications of the MM application are listed in this chapter. 4.1.1 Update notification item explanation Each update notification description consists of the following items: • Purpose A global description of the purpose of the notification.
PAGE 90
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 90 UNIT-EVENT MATRIX Input event Operational Mode C: Chairman D: Delegate Delegate with Req.List Operator with Req.
PAGE 91
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 91 Note that a delegate does not really turns on its microphone, but he makes a Request to speak. Depending on the operation mode and the current lists, he is added to the SPK list or the RTS list. On this Request-to-Speak-event also a remark has to be made if the unit/delegate is in the Speakerslist but with the microphone off (which is possible with the function MM_C_SET_MICRO_ON_OFF, see section 3.3.1).
PAGE 92
en | 92 DCN Next Generation Open Interface Release 2.0 Microphone Management • MM_C_PC_MIC_NONE wPrioId Passes the prio-status of the chairman unit. This priority information indicates to the remote controller that the delegate units can be muted due to a priority key pressed on this chairman-unit. Although the microphone is turned on, the delegate can not yet speak.
PAGE 93
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 93 4.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. 4.3.5 MM_C_SPK_APPEND_ON_PC Purpose Notifies the remote controller that a unit is added to the SPK list.
PAGE 94
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 94 MM_T_SPK tNewSpk; } MM_T_SPK_REPLACE; where: tCurrSpk The SPK entry to search for. This SPK entry is replaced by the new value given in the parameter ‘tNewSpk’. tNewSpk The SPK entry holding the new contents. 4.4 MM Comment Speaker list notifications The Microphone Management comment speaker list notifications report the changes in the comment speakers list. 4.4.
PAGE 95
DCN Next Generation Open Interface Release 2.0 Microphone Management typedef struct { WORD wUnitId; WORD wMicroType; } MM_T_NBK; where: wUnitId Unit identifier wMicroType The type of microphone handling for the notebook entry as defined in 3.5.3 4.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.
PAGE 96
DCN Next Generation Open Interface Release 2.0 Microphone Management Notify structure with this update The update comes with the following structure: MM_T_RTS tRtsFirst; where: tRtsFirst The RTS list entry, which is now at the top of the RTS list. 4.6.5 MM_C_RTS_INSERT_ON_PC Purpose Notifies the remote controller that a delegate/unit combination is inserted in the RTS list before another RTS entry.
PAGE 97
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 97 4.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. 4.7.2 MM_C_CR_ADD_ON_PC Purpose Notifies the remote controller that a delegate/unit combination is added to the CR list.
PAGE 98
en | 98 DCN Next Generation Open Interface Release 2.0 Microphone Management APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them.
PAGE 99
DCN Next Generation Open Interface Release 2.
PAGE 100
DCN Next Generation Open Interface Release 2.0 Microphone Management APPENDIX B. ERROR CODES Responses returned upon a remote function request contain a error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Microphone Management Error code Value Explanation 0 MM_E_NOERROR The execution of the remote function was successful. 2 MM_E_UNKNOWN_UNIT The UnitId is unknown in the CCU.
PAGE 101
DCN Next Generation Open Interface Release 2.0 Microphone Management Microphone Management Error code Value Explanation 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. 26 MM_E_RTS_LIST_EMPTY The RTS list is empty; therefore the function cannot be fulfilled. E.g. remove on a RTS list entry on an empty RTS list. 27 MM_E_ILLEGAL_MAX_RTS_LIST_LEN The maximum length provided for the RTS list is out of range.
PAGE 102
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 102 APPENDIX C. EXAMPLES 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 section General), 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.
PAGE 103
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 103 if (tMMSettings.wActiveMics != 4) { tMMSettings.wActiveMics = 4); bMustSend = TRUE; } if (tMMSettings.wMaxRTSListLen != 50) { tMMSettings.
PAGE 104
DCN Next Generation Open Interface Release 2.0 Microphone Management en | 104 This ends controlling the MM application. The remote controller and CCU can now safely be switched off. Bosch Security Systems B.V.
PAGE 105
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation Simultaneous Interpretation Bosch Security Systems B.V.
PAGE 106
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 106 Table of Contents 1. Introduction ......................................................................................................................................... 107 1.1 Purpose..................................................................................................................................... 107 1.2 Scope............................................................................................
PAGE 107
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 107 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for Simultaneous Interpretation between the CCU and third party software. 1.2 Scope This Software Requirement Specification describes the current state of the remote interface for Simultaneous Interpretation.
PAGE 108
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 108 2. SIMULTANEOUS INTERPRETATION FOR A REMOTE INTERFACE 2.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. 2.
PAGE 109
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 109 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the remote functions used to control the Simultaneous Interpretation application on the CCU. 3.1.1 Remote function item explanation Each description consists of the following items: • Purpose A global description of the purpose of the function. • Parameter structure for the function The input parameters needed to fulfill the function.
PAGE 110
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 110 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 StandAloneIN is set to FALSE and the timer for controller update messages is deleted.
PAGE 111
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 111 Error codes returned IN_E_NOERROR IN_E_INCONTROL_OTHER_CHANNEL IN_E_INCONTROL_THIS_CHANNEL Update notifications IN_C_CCU_CONFIG IN_C_CHAN_STATUS IN_C_LANGUAGE_LIST IN_C_FLASHING_MIC_ON IN_C_SPEAKSLOWLY_SIGN IN_C_HELP_SIGN Related functions IN_C_STOP_IN_APP 3.2.3 IN_C_STOP_IN_APP Purpose Indicate the CCU that the remote controller no longer requires to communicate with the IN application inside the CCU.
PAGE 112
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation wNrOfInstances en | 112 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 IN_C_START_IN_APP also increases this update use count.
PAGE 113
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation struct { WORD WORD WORD DWORD }; en | 113 wBoothNr; wDeskNr; wAChannel; dwfBChannelSet; where: wBoothNr Booth number of the interpreter desk. Range: 1..31 wDeskNr Desk number of the interpreter desk. Range: 1..6 wAChannel The A out channel of the interpreter desk. Range: 1..
PAGE 114
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 114 IN_E_APP_NOT_STARTED IN_E_UNKNOWN_BOOTH_NR 3.2.8 IN_C_UPDATE_LCK Remarks This function is exported in the IN remote interface for compatible reasons only! Use IN_C_UPDATE_LOCK instead. This function will not be supported from version 3.0. Purpose This function changes both lock modes and the engaged Led indication.
PAGE 115
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 115 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.
PAGE 116
DCN Next Generation Open Interface Release 2.
PAGE 117
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 117 wUnitId 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 DCNC_UNASSIGNED_UNIT.
PAGE 118
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 118 the array holds less channel languages, this is marked by an array value 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.
PAGE 119
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 119 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_ID, else it is discarded. wAudioLangId 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.
PAGE 120
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 120 Parameter structure for the function The function requires the following structure as parameter: BOOLEAN bFloorDistribution; where: bFloorDistribution 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.
PAGE 121
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 121 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 3.2.
PAGE 122
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 122 3.2.19 IN_C_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.
PAGE 123
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation 4. UPDATE NOTIFICATIONS 4.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. 4.1.1 Update notification item explanation Each update notification description consists of the following items: • Purpose A global description of the purpose of the notification.
PAGE 124
en | 124 DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation 4.1.2 Unit/user event relations As we have mentioned in section 2.2, 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 2.2 that the relation between the unit/user events and the update notifications is indirect (i.e. asynchronous).
PAGE 125
en | 125 DCN Next Generation Open Interface Release 2.
PAGE 126
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 126 4.2 IN General notifications 4.2.1 IN_C_CHAN_STATUS Purpose Notifies the remote controller of a status update.
PAGE 127
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 127 4.2.2 IN_C_CCU_CONFIG Purpose Notifies the remote controller of a configuration update.
PAGE 128
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 128 4.2.3 IN_C_FLASHING_MIC_ON Purpose Notifies the remote controller of the flashing microphone button ring setting. Notify structure with this update The update comes with the following structure: BOOLEAN bFlashingWhenEngaged where: bFlashingWhenEngaged TRUE if the microphone button ring flashes when engaged FALSE if the microphone button ring does not flash when engaged. 4.2.
PAGE 129
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation 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).
PAGE 130
en | 130 DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation APPENDIX A. VALUES OF THE DEFINES In this document a lot of defines are used, which have values connected to them.
PAGE 131
en | 131 DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Simultaneous Interpretation Error code Explanation IN_E_NOERROR The execution of the remote function was successful. Value (hex.
PAGE 132
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 132 APPENDIX C. EXAMPLES 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 [SRS_INF]), are presented as functions described in a ‘C’ syntax. The parameter structures of these functions are according the input, output or notify structures described in the appropriate section.
PAGE 133
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 133 break; case IN_E_INCONTROL_OTHER_CHANNEL: /* Another remote controller has control over the IN application */ /* report error and terminate */ ........ break; case IN_E_NOERROR: /* function ended succesfully, check wNrOfInstances / if (wNrOfInstances == 0) { /* do error handling, this should be impossible / } else { /* * IN app is started by this remote controller.
PAGE 134
DCN Next Generation Open Interface Release 2.0 Simultaneous Interpretation en | 134 if (tCcuConfig.byBetweenLock != IN_C_OVERRIDE) { IN_T_UPDATE_LCK tUpdateLck; tUpdateLck.wWithin = (WORD)tCcuConfig.byWithinLock; tUpdateLck.byBetween = IN_C_OVERRIDE; tUpdateLck.bEngaged = TRUE; WORD wError; wError = IN_Update_Lck(&tUpdateLck); if (wError != IN_E_NOERROR) { /* do error handling */ } else { /* update local administration */ tCcuConfig.
PAGE 135
DCN Next Generation Open Interface Release 2.0 Voting Voting Bosch Security Systems B.V.
PAGE 136
DCN Next Generation Open Interface Release 2.0 Voting en | 136 Table of Contents 1. Introduction ......................................................................................................................................... 137 1.1 Purpose..................................................................................................................................... 137 1.2 Scope.................................................................................................................
PAGE 137
DCN Next Generation Open Interface Release 2.0 Voting en | 137 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the SW interface for parliamentary voting between the DCNNG system and third party software. 1.2 Scope This Software Requirements Specification describes the remote interface for parliamentary voting. It is meant for developers who want to use this SW interface to control the voting application, present in the DCNNG system, remotely. 1.
PAGE 138
DCN Next Generation Open Interface Release 2.0 Voting en | 138 2. INTERNAL FUNCTIONING VOTING APPLICATION The voting application present in the CCU is set up as an engine capable of handling parliamentary kind of votings. 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: • Subject of the voting • The kind of the voting (e.g.
PAGE 139
DCN Next Generation Open Interface Release 2.0 Voting en | 139 2.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.
PAGE 140
DCN Next Generation Open Interface Release 2.0 Voting en | 140 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 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.
PAGE 141
DCN Next Generation Open Interface Release 2.0 Voting en | 141 szVotingSubject = “”; szLegendSubject = “”; This means that there is no subject text available on the unit LCD’s. More information about the parameters can be found in section 3.2.7.
PAGE 142
DCN Next Generation Open Interface Release 2.0 Voting en | 142 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.
PAGE 143
DCN Next Generation Open Interface Release 2.0 Voting en | 143 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the various remote functions available to handle the voting application. A global description of the remote function handling is described in section General. section General also gives a description about the type used within this document. 3.1.
PAGE 144
DCN Next Generation Open Interface Release 2.0 Voting en | 144 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.
PAGE 145
DCN Next Generation Open Interface Release 2.0 Voting en | 145 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_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 3.2.4 VT_C_STOP_VOTING Purpose This function stops the running voting round.
PAGE 146
DCN Next Generation Open Interface Release 2.0 Voting en | 146 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 3.2.6 VT_C_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.
PAGE 147
DCN Next Generation Open Interface Release 2.0 Voting en | 147 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 3.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.
PAGE 148
en | 148 DCN Next Generation Open Interface Release 2.0 Voting See table below for explanation about setting values. bCompressedResults Identify if results will be sent in compressed form as described in section 2.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.
PAGE 149
en | 149 DCN Next Generation Open Interface Release 2.0 Voting BOOLEAN bReserved3; BOOLEAN bFirstVoteCount; } VT_T_GLOBAL_SETTINGS; // must be set to FALSE where: wVotingLedMode This setting is an indication whether soft LED’s on the delegate units will Remain on after casting a vote.
PAGE 150
en | 150 DCN Next Generation Open Interface Release 2.0 Voting the parameter bAutoAbstain. bAutoAbstain is then always considered to be FALSE. In the following table is described how the led-option operate: 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.
PAGE 151
DCN Next Generation Open Interface Release 2.0 Voting Note: If the Attendance application is started, but nothing is activated, all delegates have voting authorisation. 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 3.2.10 VT_C_GET_RESULTS Purpose This function allows the remote controller to retrieve the voting results during a vote round.
PAGE 152
DCN Next Generation Open Interface Release 2.0 Voting en | 152 Related functions VT_C_SET_ATTENTION_TONE VT_C_START_ATTENTION_TONE 3.2.12 VT_C_SET_ATTENTION_TONE Purpose This function allows the remote controller to set the configuration of the voting attention tone.
PAGE 153
DCN Next Generation Open Interface Release 2.0 Voting en | 153 4. UPDATE NOTIFICATIONS 4.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 section General. 4.1.1 Notification item explanation Each description consists of the following items: • Purpose A global description of the purpose of the notification.
PAGE 154
DCN Next Generation Open Interface Release 2.0 Voting 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 2.4.1 Note that only the totals are sent to the remote controller.
PAGE 155
en | 155 DCN Next Generation Open Interface Release 2.0 Voting APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them.
PAGE 156
en | 156 DCN Next Generation Open Interface Release 2.0 Voting #define VT_C_STANDALONE_VOTING 0 #define DBSC_NCHAR_SCREENLINE #define DBSC_MAX_DELEGATE 33 4000 Bosch Security Systems B.V.
PAGE 157
DCN Next Generation Open Interface Release 2.0 Voting APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Voting Error code Value Explanation 0 VT_E_NOERROR The execution of the remote function was successful. 276 VT_E_VOTE_RUNNING Indication that a vote round is running on this moment. 277 VT_E_VOTE_NOT_RUNNING No vote round running on this moment.
PAGE 158
en | 158 DCN Next Generation Open Interface Release 2.0 Voting APPENDIX C. EXAMPLES 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.
PAGE 159
en | 159 DCN Next Generation Open Interface Release 2.0 Voting /* 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 */ ......... break; case VT_E_NOERROR: /* function ended succesful, continue */ break; default: /* some unexpected error occurred.
PAGE 160
en | 160 DCN Next Generation Open Interface Release 2.0 Voting These two calls finish the preparation for the voting session. We can now start each vote round till the session is completed. 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”.
PAGE 161
en | 161 DCN Next Generation Open Interface Release 2.0 Voting 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); If (wError != VT_E_NOERROR) { /* do error handling */ } /* no parameters */ 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).
PAGE 162
DCN Next Generation Open Interface Release 2.0 Message Distribution Message Distribution Bosch Security Systems B.V.
PAGE 163
DCN Next Generation Open Interface Release 2.0 Message Distribution en | 163 Table of Contents 1. Introduction ......................................................................................................................................... 164 1.1 Purpose..................................................................................................................................... 164 1.2 Scope...................................................................................................
PAGE 164
DCN Next Generation Open Interface Release 2.0 Message Distribution en | 164 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for Message Distribution between the CCU and third party software. 1.2 Scope This Software Requirements Specification describes the remote interface for Message Distribution. It is meant for developers who want to use this remote interface to control the Message Distribution application, present in the CCU, remotely.
PAGE 165
DCN Next Generation Open Interface Release 2.0 Message Distribution en | 165 2. MESSAGE DISTRIBUTION FOR A REMOTE INTERFACE 2.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. 2.2 Remote Message Distribution Control The Message Distribution application provides a means of generating and distributing text messages in a DCN environment.
PAGE 166
DCN Next Generation Open Interface Release 2.0 Message Distribution en | 166 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the various remote functions needed to use the Message Distribution functionality of the system. 3.1.1 Remote function item explanation Each description consists of the following items: • Purpose A global description of the purpose of the function. • Parameter structure for the function The input parameters needed to fulfil the function.
PAGE 167
DCN Next Generation Open Interface Release 2.0 Message Distribution en | 167 softkeys will receive the message. It will not be displayed immediately. wDuration • MD_C_RCV_INTERPRETER: All units with LCD receive the message and it will be displayed immediately. • MD_C_RCV_HALL: The message will only be send to hall displays. Only for Hall displays: The number of seconds the message should be displayed, 0 to display permanently.
PAGE 168
DCN Next Generation Open Interface Release 2.0 Message Distribution 4. UPDATE NOTIFICATIONS Not applicable. Bosch Security Systems B.V.
PAGE 169
DCN Next Generation Open Interface Release 2.0 Message Distribution en | 169 APPENDIX A. VALUES OF THE DEFINES In this document definitions are given, which have values connected to them.
PAGE 170
DCN Next Generation Open Interface Release 2.0 Message Distribution APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Message Distribution Error code Value Explanation 0 MD_E_NOERROR The execution of the remote function was successful. 2576 MD_E_NO_MORE_MESSAGES_ALLOWED The maximum number of messages is reached (maximum is 10). Bosch Security Systems B.V.
PAGE 171
DCN Next Generation Open Interface Release 2.0 Message Distribution en | 171 APPENDIX C. EXAMPLES In the example below the remote functions, that are defined in this document as constant values for the wFnId parameter of the message (see section General), 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.
PAGE 172
DCN Next Generation Open Interface Release 2.0 Attendance Registration Attendance Registration Bosch Security Systems B.V.
PAGE 173
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 173 Table of Contents 1. Introduction..........................................................................................................................................174 1.1 Purpose .....................................................................................................................................174 1.2 Scope ................................................................................................
PAGE 174
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 174 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for attendance registration between the CCU and third party software. 1.2 Scope This Software Requirements Specification describes the remote interface for attendance registration. It is meant for developers who want to use this remote interface to control the attendance registration application, present in the CCU, remotely. 1.
PAGE 175
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 175 2. INTERNAL FUNCTIONING OF ATTENDANCE REGISTRATION 2.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.
PAGE 176
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 176 The Access Control options are set in combination with the attendance registration options. 2.1.3 Delegate Identification This functionality provides information about what delegate is seating on which unit. Delegate Identification, i.e. location information, is available as a result of inserting ID Cards in and/or withdrawing them from units.
PAGE 177
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 177 Authorization is a status identifying if a unit may be used or not by the delegate that currently resides on this unit. Note 2: When a delegate is marked 'Functioning', the application authorization stored in the delegate database controls whether access is allowed. 2.2.
PAGE 178
PAGE 179
Attendance Access Seat Attend Seat Access Control-Type OFF OFF - - - ON ENTRANCE 1 EXIT ONE_SEAT IDCARD (_PINCODE) ANY_SEAT IDCARD (_PINCODE) ONE_SEAT PIN CODE SEAT IDCARD (_PINCODE) ON OFF ENTRANCE EXIT SEAT ANY_SEAT IDCARD (_PINCODE) ONE_SEAT IDCARD (_PINCODE) ANY_SEAT IDCARD (_PINCODE) NONE PRESENTKEY ONE_SEAT PRESENTKEY Initial / Unit connected Absent Anywhere Functioning Absent Located Blocked Absent Anywhere Blocked Absent Located Blocked Absent Located Blocked Absent
PAGE 180
Attendance Access Seat Attend Seat Access Control-Type ON OFF SEAT ONE_SEAT PIN CODE IDCARD (_PINCODE) ON ENTRANCE EXIT SEAT ANY_SEAT IDCARD (_PINCODE) ONE_SEAT IDCARD (_PINCODE) ANY_SEAT IDCARD (_PINCODE) ONE_SEAT PIN CODE IDCARD (_PINCODE) ANY_SEAT IDCARD (_PINCODE) Initial / Unit connected Absent Located Functioning Absent Located Functioning Absent Anywhere Functioning 2 Absent Located Blocked 2 Absent Anywhere Blocked Absent Located Blocked Absent Located Blocked Absent Anywhere
PAGE 181
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.
PAGE 182
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 182 3. REMOTE FUNCTIONS 3.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 section General. 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 section SC, SI and DB. 3.1.
PAGE 183
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 183 • AT_C_APP_CONTROL The remote controller likes to have full control over the attendance registration application. This full control implies the right to change the attendance registration settings. • AT_C_APP_MONITOR The remote controller only wants to monitor the presence changes. No control of the settings is allowed. Note that the second start of the application (without a stop) always results in an error.
PAGE 184
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 184 typedef struct { BYTE bySeatAttend; BYTE bySeatAccess; 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: • AT_C_SEAT • AT_C_ENTRANCE_EXIT bySeatAccess Identify if a delegate can only use his own assigned unit or also another unit.
PAGE 185
DCN Next Generation Open Interface Release 2.0 Attendance Registration bAccessOn en | 185 Indication if access control must be on or off 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 3.2.
PAGE 186
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 186 dwCardCode ID-Card code of the delegate that should be registered. Valid ID-card codes are in the range 1MAX_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 §3.2.
PAGE 187
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 187 typedef struct { WORD wClusterIndex; } AT_T_GET_REGISTRATION; where: wClusterIndex An index that indicates which cluster of delegate registration information is to be retrieved. When wClusterIndex is 0 (zero), the response structure contains the first cluster, with a maximum of AT_C_MAX_DELEGATE, of delegate registration information. When wClusterIndex is 1 (one), the second cluster is returned etc.
PAGE 188
en | 188 DCN Next Generation Open Interface Release 2.
PAGE 189
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 189 4. UPDATE NOTIFICATIONS 4.1 Introduction This chapter describes the various update notifications send by the CCU. All the update notifications of the AT application are listed in this chapter. A global description of notifications is made in section General. 4.1.1 Preconditions The update notifications coming from the AT application use the UnitId and DelegateId to connect each other.
PAGE 190
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 190 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 the delegate database and who are not registered yet. Related functions AT_C_STORE_SETTING AT_C_ACTIVATE AT_C_HANDLE_IDENTIFICATION Bosch Security Systems B.V.
PAGE 191
DCN Next Generation Open Interface Release 2.0 Attendance Registration APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them.
PAGE 192
en | 192 DCN Next Generation Open Interface Release 2.0 Attendance Registration APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Attendance Registration Error code Value: Explanation AT_E_NOERROR The execution of the remote function was successful. AT_E_APP_NOT_STARTED The remote controller has not called the AT_C_START_AT_APP yet.
PAGE 193
en | 193 DCN Next Generation Open Interface Release 2.0 Attendance Registration Attendance Registration Error code Value: Explanation The fill-level passed along with the function AT_C_HANDLE_IDENTIFICATION exceeds the maximum array size. Bosch Security Systems B.V.
PAGE 194
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 194 APPENDIX C. EXAMPLES In the examples below the remote functions and update notifications, that are defined in this document as constant values for the wFnId parameter of the message (see section General), 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.
PAGE 195
DCN Next Generation Open Interface Release 2.0 Attendance Registration en | 195 ......... break; } 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; tSettings.bySeatAttend tSettings.bySeatAccess tSettings.
PAGE 196
DCN Next Generation Open Interface Release 2.0 Attendance Registration { /* do error handling */ } Finally, when the congress is ended, we can stop the Attendance registration and Access control by calling: AT_T_ACTIVATE tActivate; tActivate.bAttendanceOn = FALSE; tActivate.
PAGE 197
DCN Next Generation Open Interface Release 2.0 Intercom Intercom Bosch Security Systems B.V.
PAGE 198
DCN Next Generation Open Interface Release 2.0 Intercom en | 198 Table of Contents 1. Introduction ......................................................................................................................................... 199 1.1 Purpose..................................................................................................................................... 199 1.2 Scope...............................................................................................................
PAGE 199
DCN Next Generation Open Interface Release 2.0 Intercom en | 199 1. INTRODUCTION 1.1 Purpose The purpose of this document is to describe the remote interface for Intercom between the CCU and third party software. 1.2 Scope This Software Requirement Specification describes the remote interface for Intercom. It is meant for developers who want to use this remote interface to control the Intercom application, present in the CCU, remotely. The Interface can be used to build an Intercom User interface. 1.
PAGE 200
DCN Next Generation Open Interface Release 2.0 Intercom en | 200 2. INTERCOM FOR A REMOTE INTERFACE 2.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. 2.2 Remote Intercom Control Intercom is the application that allows for controlling intercom calls between delegates, chairmen and interpreters during a conference.
PAGE 201
DCN Next Generation Open Interface Release 2.0 Intercom en | 201 3. REMOTE FUNCTIONS 3.1 Introduction This chapter describes the various remote functions needed to use the intercom functionality of the system. 3.1.1 Remote function item explanation Each description consists of the following items: • Purpose A global description of the purpose of the function. • Parameter structure for the function The input parameters needed to fulfil the function.
PAGE 202
DCN Next Generation Open Interface Release 2.0 Intercom en | 202 Update notifications IC_UPD_AVAILABLE_LINES IC_UPD_OPERATOR_STATE Related functions IC_C_CLOSE_IC_APP 3.2.2 IC_C_CLOSE_IC_APP Purpose Indicates the CCU that the remote controller no longer requires updates from the IC application inside the CCU. Parameter structure for the function The function has no additional parameters. Response structure from the function The function has no response parameters.
PAGE 203
DCN Next Generation Open Interface Release 2.0 Intercom Response structure from the function The function has no response parameters. Error codes returned IC_E_NOERROR Bosch Security Systems B.V.
PAGE 204
DCN Next Generation Open Interface Release 2.0 Intercom 4. UPDATE NOTIFICATIONS 4.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. 4.1.1 Update notification item explanation Each update notification description consists of the following items: • Purpose A global description of the purpose of the notification.
PAGE 205
DCN Next Generation Open Interface Release 2.0 Intercom en | 205 where: byLines The number of available intercom lines. 4.2.2 IC_UPD_OPERATOR_STATE Purpose Notifies the remote controller about the state of the operator.
PAGE 206
DCN Next Generation Open Interface Release 2.0 Intercom UNITID wUnitId; WORD wUnitType; } IC_T_INCOMMING_CALL; where: wUnitId Unit Identifier of the unit initiating the call. wUnitType The type of the unit which initiates the call Bosch Security Systems B.V.
PAGE 207
en | 207 DCN Next Generation Open Interface Release 2.0 Intercom APPENDIX A. VALUES OF THE DEFINES In this document a lot of definitions are given, which have values connected to them.
PAGE 208
en | 208 DCN Next Generation Open Interface Release 2.0 Intercom APPENDIX B. ERROR CODES Responses returned upon a remote function request contain an error field (‘wError’). In this appendix an overview is given of the possible errors and their values. Intercom Error code Explanation IC_E_NOERROR The execution of the remote function was successful. IC_E_NO_AUDIO_CHANNELS There are no audio channels available for intercom. IC_E_NO_OPERATOR There is no operator assigned.
PAGE 209
DCN Next Generation Open Interface Release 2.0 Intercom en | 209 APPENDIX C. EXAMPLES 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 section General), 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.