Dn015978 116 en Global PDF Online a4

AQ - External Alarm ConnectionsHandling

DN015978Issue 1-1 en

# Nokia Siemens Networks 1 (26)

Nokia Siemens Networks WCDMA RAN, Rel.RU10, System Library, v. 1

The information in this document is subject to change without notice and describes only theproduct defined in the introduction of this documentation. This documentation is intended for theuse of Nokia Siemens Networks customers only for the purposes of the agreement under whichthe document is submitted, and no part of it may be used, reproduced, modified or transmitted inany form or means without the prior written permission of Nokia Siemens Networks. Thedocumentation has been prepared to be used by professional and properly trained personnel,and the customer assumes full responsibility when using it. Nokia Siemens Networks welcomescustomer comments as part of the process of continuous development and improvement of thedocumentation.

The information or statements given in this documentation concerning the suitability, capacity, orperformance of the mentioned hardware or software products are given “as is” and all liabilityarising in connection with such hardware or software products shall be defined conclusively andfinally in a separate agreement between Nokia Siemens Networks and the customer. However,Nokia Siemens Networks has made all reasonable efforts to ensure that the instructionscontained in the document are adequate and free of material errors and omissions. NokiaSiemens Networks will, if deemed necessary by Nokia Siemens Networks, explain issues whichmay not be covered by the document.

Nokia Siemens Networks will correct errors in this documentation as soon as possible. IN NOEVENT WILL NOKIA SIEMENS NETWORKS BE LIABLE FOR ERRORS IN THISDOCUMENTATION OR FOR ANY DAMAGES, INCLUDING BUT NOT LIMITED TO SPECIAL,DIRECT, INDIRECT, INCIDENTAL OR CONSEQUENTIAL OR ANY LOSSES, SUCH AS BUTNOT LIMITED TO LOSS OF PROFIT, REVENUE, BUSINESS INTERRUPTION, BUSINESSOPPORTUNITY OR DATA, THAT MAYARISE FROM THE USE OF THIS DOCUMENT OR THEINFORMATION IN IT.

This documentation and the product it describes are considered protected by copyrights andother intellectual property rights according to the applicable laws.

The wave logo is a trademark of Nokia Siemens Networks Oy. Nokia is a registered trademark ofNokia Corporation. Siemens is a registered trademark of Siemens AG.

Other product names mentioned in this document may be trademarks of their respective owners,and they are mentioned for identification purposes only.

Copyright © Nokia Siemens Networks 2009. All rights reserved.

2 (26) # Nokia Siemens Networks DN015978Issue 1-1 en

AQ - External Alarm Connections Handling

Contents

Contents 3

List of tables 4

List of figures 5

Summary of changes 7

AQ - EXTERNAL ALARM CONNECTIONS HANDLING 9

AQA DEFINE EXTERNAL ALARM 11

AQC TAKE EXTERNAL ALARM INPUT IN USE 13

AQD TAKE EXTERNAL ALARM INPUT OUT OF USE 15

AQM CHANGE EXTERNAL ALARM DEFINITION 17

AQP DISPLAY USED EXTERNAL ALARM INPUTS 19

AQR REMOVE EXTERNAL ALARM DEFINITION 21

AQT DISPLAY DEFINED EXTERNAL ALARMS 23

AQX CHANGE EXTERNAL ALARM INPUT CHARACTERISTICS 25



Contents

List of tables



List of figures



List of figures

Summary of changes

Changes between document issues are cumulative. Therefore, the latestdocument issue contains all changes made to previous issues.

Changes between issues 1-0 and 1-1

Editorial changes have been made, no changes to the technical content.



Summary of changes

AQ - EXTERNAL ALARM CONNECTIONSHANDLING

Menu of the command group:

EXTERNAL ALARM CONNECTIONS HANDLING COMMANDS

? ..... DISPLAY MENU

A: ..... DEFINE EXTERNAL ALARM

M: ..... CHANGE EXTERNAL ALARM DEFINITION

R: ..... REMOVE EXTERNAL ALARM DEFINITION

T: ..... DISPLAY DEFINED EXTERNAL ALARMS

C: ..... TAKE EXTERNAL ALARM INPUT IN USE

X: ..... CHANGE EXTERNAL ALARM INPUT CHARACTERISTICS

D: ..... TAKE EXTERNAL ALARM INPUT OUT OF USE

P: ..... DISPLAY USED EXTERNAL ALARM INPUTS

Z; ..... RETURN TO MAIN LEVEL



AQ - EXTERNAL ALARM CONNECTIONS HANDLING

AQA DEFINE EXTERNAL ALARMFunction Use this command to define a new external alarm into the system. After

this, the alarm can be connected to an external alarm input.

Parameters alarm number, alarm text;

Syntax AQA:<alarm number>,<alarm text>;

Parameterexplanations

alarm number

Use this parameter to define the external alarm number that should beadded into the system. The possible values are alarm numbers between4000 and 5999. This parameter is obligatory.

alarm text

Use this parameter to define the alarm text of the external alarm. Alarmtext can be max. 64 characters long. Give the text between quotationmarks. This parameter is obligatory.

Examples 1. Define a new external alarm with the alarm number 5500 and alarmtext "DOOR ALARM".

AQA:5500,"DOOR ALARM";

Additionalinformation

When giving this command, the system creates also default alarm valuesfor the external alarm.

Semantic errormessages

If an error occurs, the system outputs a general MML semantic errormessage.

Execution errormessages

/*** ALARM ALREADY EXISTS ***/

The given external alarm number already exists in the system.



AQA DEFINE EXTERNAL ALARM

Display information on all defined external alarms using the AQT commandwithout parameters. After this, give the AQA command again with anexternal alarm number that is not yet defined in the system.

The system may also output a general MML execution error message.



AQC TAKE EXTERNAL ALARM INPUT IN USEFunction Use this command to take an external alarm input into use. After this, the

system will set or cancel the external alarm connected to the inputaccording to the input's logic state.

Parameters alarm input, alarm number, active alarm polarity <option>, alarm inputdescription <option>;

Syntax AQC:<alarm input>,<alarm number>,

[<active alarm polarity>|<0>def],

[<alarm input description>|<no description>def];


alarm input

Use this parameter to define alarm input number that will be taken into use.The possible values are numbers between 0 and 39. This parameter isobligatory.

alarm number

Use this parameter to specify the external alarm number that will beconnected to the alarm input. The possible values are alarm numbersbetween 4000 and 5999. This parameter is obligatory.

active alarm polarity <option>

Use this parameter to define the active alarm polarity. The possible valuesare 0 and 1. Value zero (0) means that the alarm is active when the input'slogic state is zero (0). Value one (1) means that the alarm is active whenthe input's logic state is one (1). The default value is zero (0).

alarm input description <option>

Use this parameter to define the descriptive text concerning the usage ofthe alarm input. The alarm input description can be max. 80 characterslong. Give the description between quotation marks.



AQC TAKE EXTERNAL ALARM INPUT IN USE

Examples 1. Take alarm input 1 into use. Connect the external alarm number5500 to the input so that the alarm will be active with input's state 1.Furthermore, give the text "MAIN DOOR" as description for theinput's usage.

AQC:1,5500,1,"MAIN DOOR";

2. Take alarm input 2 into use. Connect the external alarm number4200 to the input so that the alarm will be active with input's state 0(default). Do not give any description for the input's usage.

AQC:2,4200;




/*** NONEXISTENT ALARM ***/

The given external alarm number is not defined in the system.

Display information on all defined external alarms using the AQT commandwithout parameters. After this, give the AQC command again with a correctalarm number.

/*** ALARM INPUT ALREADY IN USE ***/

The given alarm input number is already in use.

Display information on all defined alarm inputs in the system using the AQPcommand without parameters. After this, give the AQC command againwith a correct alarm input number.




AQD TAKE EXTERNAL ALARM INPUT OUT OFUSEFunction Use this command to take external alarm input out of use.

Parameters alarm input;

Syntax AQD:<alarm input>;


alarm input

Use this parameter to specify the alarm input number that is taken out ofuse. The possible values are numbers between 0 and 39. This parameteris obligatory.

Examples 1. Take alarm input 1 out of use.

AQD:1;




/*** GIVEN ALARM INPUT IS NOT IN USE ***/

The given alarm input number is not in use.

Display information on all defined alarm inputs in the system using the AQPcommand without parameters. After this, give the AQD command againwith a correct alarm input number.




AQD TAKE EXTERNAL ALARM INPUT OUT OF USE

AQM CHANGE EXTERNAL ALARM DEFINITIONFunction Use this command to change the alarm text of an external alarm.

Parameters alarm number, alarm text;

Syntax AQM:<alarm number>,<alarm text>;


alarm number

Use this parameter to specify the number of the external alarm whosealarm text should be changed. The possible values are alarm numbersbetween 4000 and 5999. This parameter is obligatory.

alarm text

Use this parameter to define the new alarm text to the external alarm.Alarm text can be max. 64 characters long. Give the text betweenquotation marks. This parameter is obligatory.

Examples 1. Change the alarm text of the external alarm 5500 to "MAIN DOORALARM".

AQM:5500,"MAIN DOOR ALARM";






Display information on all defined alarms in the system using the AQTcommand without parameters. After this, give the AQM command againwith a correct alarm number.



AQM CHANGE EXTERNAL ALARM DEFINITION

AQP DISPLAY USED EXTERNAL ALARMINPUTSFunction Use this command to display information on the used alarm inputs in the

system.

Parameters alarm input <option>;

Syntax AQP:[<alarm input>|<all inputs>def];


alarm input <option>

Use this parameter to specify the number of the alarm input whosecharacteristics will be displayed. The possible values are numbersbetween 0 and 39. The default value is all inputs.

Examples 1. Display information on all the used alarm inputs in the system.

AQP;

2. Display information on the alarm input number 10.

AQP:10;

Executionprintouts

The execution printout of command example 1 is:

EXTERNAL ALARM INPUTS

INPUT POLARITY ALARM NR

ALARM INPUT DESCRIPTION

1 1 5500

MAIN DOOR

2 0 4200

COMMAND EXECUTED



AQP DISPLAY USED EXTERNAL ALARM INPUTS






Display information on all defined alarm inputs in the system. Use the AQPcommand without parameters. After this, give the AQP command againwith a correct alarm input number.




AQR REMOVE EXTERNAL ALARM DEFINITIONFunction Use this command to remove the definition of an external alarm from the

system.

Parameters alarm number;

Syntax AQR:<alarm number>;


alarm number

Use this parameter to specify the external alarm whose definition you wantto remove from the system. The possible values are alarm numbersbetween 4000 and 5999. This parameter is obligatory.

Examples 1. Remove definition of the external alarm 4200 from the system.

AQR:4200;






Display information on all defined external alarms using the AQT commandwithout parameters.

After this, give the AQR command again with a correct alarm number.




AQR REMOVE EXTERNAL ALARM DEFINITION

AQT DISPLAY DEFINED EXTERNAL ALARMSFunction Use this command to display the definition of one or more external alarms

(external alarm number and text).

Parameters alarm number <option>;

Syntax AQT:[<alarm number>... 1–10|<all defined alarms>def];


alarm number <option>

Use this parameter to specify one or more external alarm numbers.Definition data of the given alarm numbers that are defined in the systemwill be displayed.

The possible values are alarm numbers between 4000 and 5999. Thecharacters & and && are allowed. It is possible to give max. 10 differentexternal alarm numbers separated with & or &&.

If no alarm number is given, all defined external alarm numbers and theiralarm texts will be displayed.

Examples 1. Display definition data of external alarms 4200 and 5500.

AQT:4200&5500;

2. Display definition data of all defined alarms in the alarm numberrange from 4000 to 5000.

AQT:4000&&5000;

3. Display definition data of all defined external alarms.

AQT;

Executionprintouts

The execution printout of command example 1 is:



AQT DISPLAY DEFINED EXTERNAL ALARMS

DEFINED EXTERNAL ALARMS

ALARM NR ALARM TEXT

4200 TEMPERATURE ALARM

5500 DOOR ALARM

COMMAND EXECUTED


/*** TOO MANY &-SEPARATORS ***/

You gave too many &-separators in the command.

Give max. eight &-separators.

/*** TOO MANY &&-SEPARATORS ***/

You gave too many &&-separators in the command.

Give max. one &&-separator.

/*** SAME ALARM NUMBER CANNOT BE GIVEN TWICE ***/

You gave the same external alarm number twice in the command..

Give the same external alarm number only once.

The system may also output a general MML semantic error message.



None of the given external alarm numbers is defined in the system.





AQX CHANGE EXTERNAL ALARM INPUTCHARACTERISTICSFunction Use this command to modify external alarm input characteristics.

Parameters alarm input: alarm number <option>, active alarm polarity <option>, alarminput description <option>;

Syntax

AQX:<alarm input>:

(<alarm number>|<active alarm polarity>|<alarm input description>)...;


alarm input

Use this parameter to define the number of the alarm input whosecharacteristics will be modified. The possible values are numbers between0 and 39. This parameter is obligatory.

alarm number <option>

Use this parameter to define the new external alarm number that will beconnected to the alarm input. The possible values are alarm numbersbetween 4000 and 5999.

This parameter is one of the optional parameters in the second parameterblock. If this parameter is omitted, its value will not be changed. However,one of the optional parameters must be given.

active alarm polarity <option>

Use this parameter to define the active alarm polarity. The possible valuesare 0 and 1. Value zero (0) means that the alarm is active when the input'slogic state is zero (0). Value one (1) means that the alarm is active whenthe input's logic state is one (1).



AQX CHANGE EXTERNAL ALARM INPUT CHARACTERISTICS


alarm input description <option>

Use this parameter to define a new description for the alarm input. Thealarm input description can be max. 80 characters long. Give thedescription between quotation marks.


Examples 1. Change the external alarm number to 4200, the alarm inputdescription to "MAIN DOOR" and the active alarm polarity to 0 for thealarm input 1.

AQX:1:4200,0,"MAIN DOOR";

2. Change the alarm input description to " " (no description) for thealarm input 2.

AQX:2:,," ";






Display information on all defined alarm inputs in the system using the AQPcommand without parameters.







Dn015978 116 en Global PDF Online a4

Documents

Transcript of Dn015978 116 en Global PDF Online a4