How it Works
Bosch Appliances
Loading...
THE DCN
User Manual
31 pgs140 Kb0
Table of contents
Loading...

Bosch Appliances THE DCN User Manual

SC & SI Remote Interface Description
en SC & SI Remote
Interface Description
SC & SI Remote Interface Description en | 2
Table of Contents
1.1 Purpose ..........................................................................................................................................3
1.2 Scope..............................................................................................................................................3
1.3 Definitions, Acronyms and Abbreviations.......................................................................................3
1.4 References .....................................................................................................................................3
1.5 Overview.........................................................................................................................................3
2.1 Introduction.....................................................................................................................................4
2.2 Remote System Configuration and System Installation.................................................................4
2.3 System Modes................................................................................................................................4
3.1 Introduction.....................................................................................................................................6
3.1.1 Remote function item explanation.......................................................................................6
3.2 SC_C_CHECK_LINK .....................................................................................................................6
3.3 SC_C_START_DCN ......................................................................................................................6
3.4 SC_C_STOP_DCN ........................................................................................................................7
3.5 SC_C_GET_CCU_VERSIONINFO................................................................................................7
3.6 SC_C_GET_CCU_CONFIG...........................................................................................................9
3.7 SC_C_START_DQS ....................................................................................................................10
3.8 SC_C_STOP_DQS ......................................................................................................................11
3.9 SC_C_MAINT_CCU_DB..............................................................................................................11
3.10 SC_C_DOWNLOAD_CCU_DB....................................................................................................12
3.11 SC_C_CLEAR_CCU_DB.............................................................................................................13
3.12 SC_C_CCU_APPLY_ONE...........................................................................................................14
4.1 Introduction...................................................................................................................................15
4.1.1 Update Notification item explanation.................................................................................15
4.1.2 Unit/user event relations....................................................................................................15
4.2 SC_C_CCU_REBOOT.................................................................................................................17
4.3 SC_C_CONNECT_UNIT..............................................................................................................17
4.4 SC_C_DISCONNECT_UNIT........................................................................................................17
4.5 SC_C_CONNECT_SLAVE_CCU.................................................................................................17
4.6 SC_C_DISCONNECT_SLAVE_CCU...........................................................................................18
4.7 SC_C_CCU_MODE_CHANGE....................................................................................................18
5.1 Introduction...................................................................................................................................19
5.2 SI_C_START_INSTALL...............................................................................................................19
5.3 SI_C_STOP_INSTALL.................................................................................................................19
5.4 SI_C_SELECT_UNIT...................................................................................................................20
5.5 SI_C_SET_MASTER_VOL ..........................................................................................................21
6.1 Introduction...................................................................................................................................22
6.1.1 Unit/user event relations....................................................................................................22
6.2 SI_C_REGISTER_UNIT...............................................................................................................22
C.1. Assigning seats using global installation...........................................................................................27
C.2. Replacing defective units during operation........................................................................................28
Bosch Security Systems B.V. | 2003 December | SC & SI Remote Interface Description
SC & SI Remote Interface Description en | 3
1 Introduction
1.1 Purpose
The purpose of this document is to describe the remote interface for system configuration and system installation. The document specifies the interface between the CCU and third party software.
1.2 Scope
This document describes the remote interface for system configuration and system installation. It is meant for developers who want to use this remote interface to control/access system configuration and system installation, present in the CCU, remotely. For a complete description of the System Set-up can be referred to [SRS_INF].

1.3 Definitions, Acronyms and Abbreviations

CCU Central Control Unit. This can be either a Single-CCU system or a
Multi-CCU system. DCN Digital Congress Network SC System Configuration SI System Installation DQS Database Query Services OMF File An executable file in a special format that can be programmed or
downloaded into the ReadOnlyMemory on the CCU TCB Trunc Communication Board MTB Multi Trunc Board UnitId Unit identification, also called unit-number. A unique identification of
a unit within the CCU system. remote controller Device (e.g. PC) connected to the CCU which remotely controls a
part of the applications present in the CCU.
1.4 References
[SRS_INF] General Remote Interface Description [USERDOC_DB] User Manual LBB 3580 [USERDOC_SI] User Manual LBB 3585
This document must be referenced as [SRS_SCSIINF].
1.5 Overview
Chapter 2 gives a brief explanation on System Configuration and System Installation. Also a short description of the different CCU system modes is given in this chapter. For system configuration, the remote functions and update notifications are described in chapters 3 and 4. For system installation, the remote functions a nd update notifications are described in chapters 5 and 6. Appendix Appendix A gives an overview of the constants used in combination with the remote functions and update notifications described in this document. Appendix Appendix B gives an overview of the possible error’s that could be returned upon execution of a remote function. Appendix Appendix C shows some examples on typical System Configuration or System Installation topics.
Bosch Security Systems B.V. | 2003 December | SC & SI Remote Interface Description
SC & SI Remote Interface Description en | 4

2 System configuration and system installation

2.1 Introduction
The System Configuration and System Installation Remote Interface is part of the DCN software which allows another controlling entity, not being the DCN Control PC, to use the System Configuration and System Installation applications.

2.2 Remote System Configuration and System Installation

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 seatnumbers 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 [SRS_INF]. [SRS_INF] also defines the protocol and hardware conditions concerning the remote interface. This docu ment 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 pressi ng 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/user events and update notifications can be found in the user event matrices in sections 4.1.2 en 6.1.1.
2.3 System Modes
To understand the SC and SI functions, one should have some knowledge on the behaviour of the CCU 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 behaviour 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 configuration can be
changed, for instance installing units, assigning seatnumbers, 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 In this system mode the DCN system can be maintained,
for instance testing microphones, testing audio channels, factory testing and equalisation.
download In this system mode new CCU software can be
downloaded.
down One time system mode just before shutdown of the CCU.
Figure 1 below gives an overview of possible system mode changes.
Bosch Security Systems B.V. | 2003 December | SC & SI Remote Interface Description
SC & SI Remote Interface Description en | 5
Init
Config
Download Maintenance
Down
Figure 1: CCU System modes
Congress
Some remote functions are supported in more than one system mode, or in an other mode than the congress system mode.
Bosch Security Systems B.V. | 2003 December | SC & SI Remote Interface Description
SC & SI Remote Interface Description en | 6
3 System Configuration Functions
3.1 Introduction
The system configuration functions described in this section are needed to query the set-up of the DCN­system from the CCU. The system configuration functions allow the remote controller to monitor any changes in the DCN system configuration. This chapter defines the set of remote functions for system configuration.

3.1.1 Remote function item explanation

Each description consists of the following items:
• Purpose A global description of the purpose of the function.
• Availability CCU System modes in which the function is available. See section 2.3.
• Parameter structure for the function The input parameters needed to fulfil the function. When the function requires no parameters, no structure is described here.
• 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 DQSE_NOERROR.
• Error codes returned The error values returned in the ‘wError’ field of the response information. All different error codes are described in appendix Appendix B.
• 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.
3.2 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. Therefor quickly returni ng 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 SC_C_START_DCN
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 controller. 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 send 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.
Bosch Security Systems B.V. | 2003 December | SC & SI Remote Interface Description
SC & SI Remote Interface Description en | 7
Response structure from the function
The function returns the following structure:
WORD wNrOfInstances
where:
wNrOfInstances
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_DCN is called, it contains the value 1.
Error codes returned
SC_E_NOERROR
Related functions

SC_C_STOP_DCN

3.4 SC_C_STOP_DCN
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.
Note that: Upon communication lost this function will be activated, if SC_C_START_DCN was
activated. The activation of this function is repeated 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 SC_C_START_DCN (section 3.3 ).
Error codes returned
SC_E_NOERROR
Related functions
SC_C_START_DCN
3.5 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 CCU all system modes.
Parameter structure for the function
The function has no additional parameters.
Response structure from the function
The function returns the following structure:
where:
typedef struct { WORD tOperatingMode; CHAR szSwVersion [SC_C_MAX_VERSION_LENGTH]; BYTE byMajorVersionOfDownloadedSw; BYTE byMinorVersionOfDownloadedSw; BYTE byMajorVersionOfResidentSw; BYTE byMinorVersionOfResidentSw; BYTE bySystemMode; BYTE byReservedForSwInfo [SC_C_MAX_SOFTWARE_INFO]; SC_T_CCU_TYPE tCCUType; BYTE byMTBVersion; BYTE byTCBVersion; BYTE byReservedForHwInfo [SC_C_MAX_HARDWARE_INFO]; CHAR szSWRelNum[VERSION_C_LENGTH]; } SC_T_CCU_VERSION_INFO;
tOperatingMode
The current operating mode of the CCU. It gives information
Bosch Security Systems B.V. | 2003 December | SC & SI Remote Interface Description
SC & SI Remote Interface Description en | 8
about the environment the CCU is functioning. The value is an ‘OR’ mask of the following settings:
• SC_C_STANDALONE
• SC_C_EXTENDED
• SC_C_SINGLETRUNC
• SC_C_MULTITRUNC
• SC_C_MASTER
• SC_C_SLAVE
szSwVersion
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). If no downloaded software is present, then both will be zero. If e.g. the downloaded software is DCN 7.0, byMajorVersionOfDownloadedSw will be ‘7’ and byMinorVersionOfDownloadedSw will be ‘0’
byMajorVersionOfResidentSw, byMinorVersionOfReside ntSw
The major and minor version numbers of the resident software (Boot-software). If e.g. the resident software is of version 2.1, byMajorVersionOfResidentSw will be ‘2’ and byMinorVersionOfResidentSw will be ‘1’.
bySystemMode
The Current System Mode of the CCU. Value according to following type:
• DCNC_SM_DOWN
• DCNC_SM_INIT
• DCNC_SM_CONFIG
• DCNC_SM_CONGRESS
• DCNC_SM_MAINTENANCE
• DCNC_SM_DOWNLOAD
byReservedForSwInfo tCCUType
byMTBVersion
byTCBVersion
byReservedForHwInfo szSWRelNum
Error codes returned
SC_E_NOERROR
Reserved space for extra software information. Type of CCU connected to. Value according to following type:
• SC_C_LBB3500_00
• SC_C_LBB3500_10
• SC_C_LBB3500_30
• SC_C_LBB3511_00
Hardware version of the Multi-Trunk Board inside the CCU. (zero if not present.)
Hardware version of the Trunk Communication Board inside the CCU.
Reserved space for extra hardware information. Software version number as ASCII string. The string is zero
(‘\0’) terminated. Normally this is the string representation of byMajorVersionOfDownloadedSw plus byMinorVersionOfDownloadedSw, e.g. if the version of the downloaded software is 7.00, this string will read “7.00”
Bosch Security Systems B.V. | 2003 December | SC & SI Remote Interface Description
SC & SI Remote Interface Description en | 9
3.6 SC_C_GET_CCU_CONFIG
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.
Parameter structure for the function
The function requires the following structure as parameter:
where:
The function returns the following structure:
WORD wClusterIndex;
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. However, the other three elements of the response structure will still contain correct data.
Response structure from the function
typedef struct { WORD wNumberOfSlaveCCUs; WORD wNumberOfUnitsConnected; WORD wNumberOfUnits; 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;
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
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.
wNumberOfUnits
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.
tUnitData []
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.
wUnitId byUnitType
The unit identifier of a unit. Also called unit-number. The type of the unit, which is on of the following:
• DCNC_UNIT_DELEGATE
Bosch Security Systems B.V. | 2003 December | SC & SI Remote Interface Description
SC & SI Remote Interface Description en | 10
• DCNC_UNIT_CHAIRMAN
• DCNC_UNIT_DELEGATE_CARD
• DCNC_UNIT_INTERPRETER
• DCNC_UNIT_DUAL_MIC
• DCNC_UNIT_PC
• DCNC_UNIT_DATA_COMM
• DCNC_UNIT_CCU_CONTROL
• DCNC_UNIT_FLUSH_CHAIRMAN
• DCNC_UNIT_FLUSH_DELEGATE
• DCNC_UNIT_AMBIENT_MIC
• DCNC_UNIT_DATA_COMM_RS232
• DCNC_UNIT_2000_DELEGATE
• DCNC_UNIT_2000_CHAIRMAN
• DCNC_UNIT_2000_DELEGATE_CARD
• DCNC_UNIT_AUDIO_IO
• DCNC_UNIT_DAI_CHAIRMAN
• DCNC_UNIT_DISC_DELEGATE
• DCNC_UNIT_DISC_CHAIRMAN
• DCNC_UNIT_ENTRANCE
• DCNC_UNIT_EXIT
• DCNC_UNIT_FLUSH_DEL_NODISP
• DCNC_UNIT_FLUSH_CHR_NODISP
Note that future unit extensions of the DCN system can lead to new unit-type, not presented in this list.
Error codes returned
SC_E_NOERROR
3.7 SC_C_START_DQS
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 DQSE_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.
where:
Note that the second start of the application (without a stop) always results in an error. The function has no response parameters. DQSE_NOERROR
DQSE_INCONTROL_OTHER_CHANNEL DQSE_INCONTROL_THIS_CHANNEL DQSE_ILLEGAL_CONTROL_TYPE
SC_C_STOP_DQS
typedef struct { BYTE byControlType; } DQST_APP_CONTROL;
byControlType
Identify that the remote controller likes to perform actions on the database of the CCU. Valid values are:
• SC_C_DQS_CONTROL
Response strcuture from the function Error codes returned
Related functions
The remote controller likes to have control over the database of the CCU.
Bosch Security Systems B.V. | 2003 December | SC & SI Remote Interface Description
Loading...
+ 21 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use