is a selector from 1 to 4. Example: GET MAD Reply: means that address number three is the main address. Example: SET MAD 2 changes main address to two. Note! When communication is done via Data Call (refer to attribute DEV), attribute MAD is obsolete. Common Commands and Attributes 42/123 Document Name: Common Commands and Attributes v1.3.0 8.10 Revision: 1.2 MCT – Modem Connect Time 8.10.1 Overview Used to configure timeout when attempting to setup a modem connection. 8.10.2 Usage Attribute type: Read and Write When a repeater is dialling the OMC to deliver an alarm or a report, the controller will wait up to MCT seconds for the call to be established. If no communication is established within this time, the call will be hung up. Format: is the maximum connection time in seconds. Example: GET MCT Reply: 45 meaning that the repeater will wait up to 45 seconds for a call to be established. Example: SET MCT 50 changes the timeout to 50 seconds. 8.11 MIS – Modem Initialization String 8.11.1 Overview This is used to configure the modem initialization string. 8.11.2 Usage Attribute type: Read and Write In order for some modems to work correctly in a network, they might require different configurations. The configuration is modified with this attribute. Format: is the actual modem initialization string. Example: GET MIS Reply: AT+CBST=7,0,1 which is the modem specific modem initialization string. Example: SET MIS AT+CBST=71,0,1 Common Commands and Attributes 43/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 modifies the modem initialization string. Note 1! Modem string must NOT contain any white space (blanks). Note 2! If logged in remotely, the changes will not take effect until the user logs out from the controller. As soon as the user logs out and disconnects, the initialization of the modem will be initiated. 8.12 MPE – Automatic Power Cycling Enabled 8.12.1 Overview By configuring this, the modem can be automatically power cycled once per day. 8.12.2 Usage Attribute type: Read and Write The controller can be configured to automatically turn off and turn on the modem once per day. This feature can be used to ensure that the modem parameters when using for example GSM modems contain the latest network parameters such as HLR update interval etc. This attribute configures whether automatic power cycling should be enabled or not. Format: = 1 means modem power cycling is enabled = 0 means modem power cycling is disabled Example: GET MPE Reply: means that the modem power cycling is enabled. Example: SET MPE 0 disables the automatic modem power cycling. Timepoint for when to power cycling the modem can be set with attribute MPT. In order to read out modem Power Cycling timepoint, use attribute LPC. In order to perform an instant modem power cycling, please refer to attribute ACT RCD. 8.13 MPT – Automatic Power Cycling Timepoint 8.13.1 Overview Configures at what time of the day automatic modem power cycling should be performed. 8.13.2 Usage Attribute type: Read and Write Common Commands and Attributes 44/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 The controller can be configured to automatically turn off and turn on the modem once per day. This feature can be used to ensure that the modem parameters when using for example GSM modems contain the latest network parameters such as HLR update interval etc. This attribute configures at what timepoint the modem power cycling should be performed. Format: HHMMSS HH is the hours (in 24 hour notation), MM is minutes and SS is seconds specifying the modem power cycling timepoint. Example: GET MPC Reply: 010000 means that the modem power cycling is performed att one in the morning. Example: SET MPC 160000 configures modem power cycling to be performed at 4 in the afternoon. Enabling / Disabling of the automatic power cycling can be configured with attribute MPE. Timepoint for when to power cycling the modem can be set with attribute MPT. In order to read out Last modem Power Cycling timepoint, use attribute LPC. In order to perform an instant modem power cycling, please refer to attribute ACT RCD. 8.14 NCT – Network Connect Time 8.14.1 Overview This configures how long to wait for modem initialization after a modem power up. 8.14.2 Usage Attribute type: Read and Write This attribute is used to configure how long to wait before trying to initialize a modem after power up or a modem power cycle. Format: is in seconds. Example: GET NCT Reply: 15 meaning modem connect time is set to 15 seconds. Example: SET NCT 30 sets this time to 30 seconds. Common Commands and Attributes 45/123 Document Name: Common Commands and Attributes v1.3.0 8.15 Revision: 1.2 PIN – PIN-code for communications device 8.15.1 Overview This configures the PIN code used to unlock the communications equipment. 8.15.2 Usage Attribute type: Write-Only This attribute is used to configure the PIN code used to unlock the communications equipment (GSM modems etc). Format: SET PIN XXXXXXXX XXXXXXXX is a number, up to 8 characters long, representing the PIN code of the SIM card. Note! If wrong PIN code is entered, the controller will only try to open it up once. After that it will not try to lock it up again until the PIN code is changed. This is to avoid that the SIM card is blocked if wrong PIN code is configured. 8.16 PIS – PIN-code Supported by device 8.16.1 Overview This attribute is used to determine if configured modem supports SIM PIN-code. 8.16.2 Usage Reading this attribute displays if the configured modem supports SIM PIN-code. If PIN-code is supported it can be configured using the attribute SET PIN. Format: where = 0 means no PIN-code is supported and = 1 means modem type does not support PIN-code. Example: GET PIS Reply: means that this modem type supports PIN-code. Note! Supporting PIN-code does not mean that PIN-code necessarily is required by SIM, since this can be configured on a SIM by SIM basis. Common Commands and Attributes 46/123 Document Name: Common Commands and Attributes v1.3.0 8.17 Revision: 1.2 PPO – Primary Port Number 8.17.1 Overview This configures what port number to use on primary address when using TCP/IP. 8.17.2 Usage Attribute type: Read and Write This attribute is used together with ASC to build complete connection parameters when using TCP/IP to connect to the Axell Element Manager. Attribute configures what port number on the Axell Element Manager should be connected to. Format on getting parameter: GET PPO Reply: where is the port number that Axell Element Manager on IP address as defined by attribute ASC is listening on. Valid values are 1-65 535. Example: GET PPO Reply: 23 meaning that controller will attempt to connect on port 23 on the Axell Element Manager when delivering alarms and reports. Example: SET PPO 4711 changes this port number to 4711. 8.18 ROP – Repeater to OMC password 8.18.1 Overview This configures what password the controller should use when logging in to the OMC. 8.18.2 Usage Attribute type: Write-Only When the controller is configured for data call, and alarms or reports are to be transmitted to the repeater OMC / Axell Element Manager, the controller needs to supply a user name and password. The user name is the equipment ID (attribute RID), and the password is set with this attribute, ROP. Format: Common Commands and Attributes 47/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 is the password, up to 8 characters, no space allowed. Example: SET ROP REPEATER sets the password to REPEATER. Note! This password should normally be changed from the Element Manager, since a wrong configured password will cause the login to the Element Manager to fail. 8.19 SAC – SMS Acknowledge Configuration 8.19.1 Overview This configures in what way alarms sent via SMS should be acknowledged. 8.19.2 Usage Attribute type: Read and Write This command affects controllers using SMS for alarm transmission. SAC configures how the controller determines whether an alarm is acknowledged or not. Format: = 0 means that the alarm is considered acknowledged when an acknowledge message is received from the OMC. = 1 means that an alarm is considered acknowledged when the alarm is successfully transmitted to the Short Message Service Center (SMSC), i.e. when the message is successfully delivered to the network. Example: GET SAC Reply: meaning that the controller requires an acknowledge message back from the OMC (if the individual alarm source is configured for that). Example: SET SAC 1 changes the behavior to consider the alarm acknowledged when the message is sent successfully to the SMSC. Note! This configuration will work in conjunction with the other alarm attributes (ALA XXX, RCA and MNR). If for example SAC is set to “1”, and RCA is set to 3 and MNR 3, the controller will try to send the message to the SMSC center up to 3 times with 3 minute intervals. If the individual alarm source is configured to not require an acknowledge, it will only try to send it once to the SMSC. 8.20 SFT – Secondary Fallback Timer 8.20.1 Overview This defines after how long the controller should fall back primary AEM address in Common Commands and Attributes 48/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 case switched over to secondary address. 8.20.2 Usage Attribute type: Read and Write This configures how many minutes the controller will wait before going back to the primary address again after calling the secondary OMC address. If this parameter is set to zero, no fallback will be done, i.e., the controller will toggle between the addresses for every failure to deliver messages. See also attributes SSC, ASC and command ACT UPA. Format: is number of minutes to wait before fall back to primary OMC address, and allowed interval is from 0 to 1440 minutes. Example: GET SFT Reply: 15 meaning that the controller will use the secondary address for 15 minutes before going back to primary/normal OMC address. Example: SET SFT 10 changes this value to 10 minutes. 8.21 SMC – Address of SMS Service Center 8.21.1 Overview This configures the address of the SMS Center when using SMS for remote communication. 8.21.2 Usage Attribute type: Read and Write When using SMS for alarming purposes, it is necessary to configure the address of the Short Message Service Center, which is a network node to which all messages are sent before being transmitted to its final destination. The SMSC is an MSISDN number which is written to the communications equipment during initialization. Format:

where address is a number with a maximum length of 20 characters. Example: GET SMC Reply: +46705008990 meaning that the secondary address is set to +46705008990. Example: Common Commands and Attributes 49/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 SET SMC +46705008999 changes the SMSC address to +46705008999. 8.22 SPO – Primary Port Number 8.22.1 Overview This configures what port number to use on secondary address when using TCP/IP. 8.22.2 Usage Attribute type: Read and Write This attribute is used together with SSC to build complete connection parameters when using TCP/IP to connect to the Axell Element Manager. Attribute configures what port number on the Axell Element Manager should be connected to. Format on getting parameter: GET SPO Reply: where is the port number that Axell Element Manager on IP address as defined by attribute SSC is listening on. Valid values are 1-65 535. Example: GET SPO Reply: 1025 meaning that controller will attempt to connect on port 1025 on the Axell Element Manager when delivering alarms and reports. Example: SET SPO 8087 changes this port number to 8087. 8.23 SSC – Secondary Service Center 8.23.1 Overview Used to configure the backup OMC address in case it is not possible to contact primary address. 8.23.2 Usage Attribute type: Read and Write When controller is configured for data call or if TCP/IP is used (GPRS or Ethernet), and the controller fails to connect to the primary service center (configured with the attribute ASC), the controller will automatically switch over to the secondary service Common Commands and Attributes 50/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 center address. If secondary address is not set, it will be neglected. Furthermore, if controller experiences problems connecting to secondary address, it will switch back to primary address. A fallback timer can be configured so that the controller goes back to primary address after a specified interval (please refer to attribute SFT for details). Format:

where address is a number or server name (if using TCP/IP or GPRS) with a maximum length of 30 characters. Note! The controller will always check if first address is set. If not, the secondary address will be ignored. Example: GET SSC Reply: 118118 meaning that the secondary address is set to 118118. Example: SET ASC backup_aem_address uses the address backup_aem_addres for delivery of alarms and reports (assuming TCP/IP or GPRS communication and that DNS is configured properly). Example: SET SSC Disables the use of a secondary address. 8.24 ACT MDS - Poll for Modem Status 8.24.1 Overview This command is used to poll the modem with pre-configured modem strings. 8.24.2 Usage To be implemented in later versions. 8.25 ACT RCD – Reset Communications Device 8.25.1 Overview This command forces a power cycling of the communications device / modem. 8.25.2 Usage Attribute type: Write-Only Action This command is used to perform a power cycle of the modem. In case command is launched when logged in remotely, the power cycling will be performed after after the next logout. Format: Common Commands and Attributes 51/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 ACT RCD [Delay] where the optional delay parameters denotes how many seconds from entering the command the modem should be power cycled. If Delay is left out, an immediate power cycling of the modem will be performed (assuming local login). Example: ACT RCD will, if logged in locally, perform an immediate power cycling of the modem. Note! The controller can also be configured to automatically turn off and turn on the modem once per day. This feature can be used to ensure that the modem parameters when using for example GSM modems contain the latest network parameters such as HLR update interval etc. Attribute MPE is used to configure if automatic modem power cycling should be enabled. Time point for when to power cycling the modem can be set with attribute MPT. In order to read out Last modem Power Cycling time point, use attribute LPC. 8.26 ACT UPA – Use Primary Address 8.26.1 Overview This forces an immediate fall back to dial primary AEM address in case of alarms or reports. 8.26.2 Usage Attribute type: Write-Only Action The controller can be configured to use both primary and the backup address (as configured with attribute ASC and SSC) for delivery of alarms and reports to the Axell Element Manager. In case connection to the first address fails, the controller automatically attempts to connect to the secondary address instead. Using the attribute SFT (Secondary fall back Timer) it is possible to configure after how long the controller will go back to the primary address again. By using this attribute it is possible to force an immediate fall back to the primary address again. This can for example be used if the primary address has been down for any reason to force all network elements to go back to primary address again. Format: ACT UPA causes the immediate fall back to the primary address. Note! Executing this action when controller is already dialing primary address has no effect. 8.27 ACCESS MODEM 8.27.1 Overview This command can be used for advanced trouble shooting of the modem configurations. Common Commands and Attributes 52/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 8.27.2 Usage When typing ACCESS MODEM, the controller will send all the characters typed directly out the modem port. All characters replied back from the modem will be presented directly to the user. This command is useful for advanced remote communication trouble shooting issues. Format: ACCESS MODEM [-B Baud Rate] where the optional switch -B allows to connect to the modem using any of the standard baud rates 1200, 2400, 4800, 9600, 19200, 38400, 57600, 115200 or 230400. Using other baud rates than the default will only work if modem is configured for this speed or is using auto bauding. If the modem is busy dialing to the Axell Element Manager, or if someone is logged in remotely to the repeater, the controller will attempt to access the modem for a limited amount of time before giving up. This might also happen if the controller is busy initializing the modem. If this is the case, it is normally possible to access the modem again after a short while. To abort an ACCESS MODEM session, press three ‘-‘ in a row (all three within one second) to come back to the repeater command prompt. Note 1! When accessing the modem port the modem might be configured with “echo off”, meaning that the characters entered will not be echoed back to the screen. In order to enable “echo”, press Enter. After that, type ATE1 (invisible), followed by Enter. The modem should then reply with OK indicating that the echo is enabled. All characters entered will now be echoed back to the user. Note 2! Command will not work when logged in to the controller remotely over the modem connection, since modem is busy communicating. 8.28 MODEM 8.28.1 Overview This command gives an overview of the actual modem settings. 8.28.2 Usage By launching the command MODEM, all modem configuration settings are displayed. Common Commands and Attributes 53/123 Document Name: Common Commands and Attributes v1.3.0 8.29 Revision: 1.2 MP – Modem Power 8.29.1 Overview This command enables or disables the modem power. 8.29.2 Usage For trouble shooting purposes it is possible to disable or enable the power to the modem by using the commands MP OFF and MP ON Note 1! Since controller regularly polls the status of the modem, it will power up and initialize the modem in case it is left without powered. Note 2! Use this command with extreme caution, since it will kick out any remotely logged in users, or disconnect any remote connections to the Axell Element Manager. 8.30 TRACE MODEM 8.30.1 Overview This command gives a trace of the modem initialization procedure. 8.30.2 Usage For troubleshooting purposes it is possible to trace the actual progress of initializing the modem. This trace is useful when having problems with the modem initialization. For example, when remote initialization is enabled (SET CDE 1), it is useful to see that modem registers properly onto the network. To abort TRACE MODEM session, press Ctrl-C. Example: AVITEC AB>set mis at+cbst=71,0,1 AVITEC AB>trace modem Starting modem trace. To abort, press Ctrl-C. -----------------------------------------------------Modem initialization completed successfully! Modem initialization string changed, re-initializing modem. Initializing modem... Disabling modem echo... Modem echo successfully disabled. Checking PIN status... SIM already unlocked. Checking Network Registration... Registered on home network. Initializing modem specific parameters.... Sending modem initialization string at+cbst=71,0,1 Modem initialization completed successfully! Common Commands and Attributes 54/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 HEARTBEAT REPORT CONFIGURATIONS This section defines all attributes related to the heartbeat transmissions of the repeater. 9.1 HIT – Heartbeat Log Item 9.1.1 Overview This attribute returns information about entries in the heartbeat log. 9.1.2 Usage Attribute type: Read only This attribute returns an entry in the heartbeat log, Format: GET HIT Reads heartbeat log entry number from the heartbeat log, where the oldest entry in the heartbeat log is number 1. might be from 1 to value replied by GET HLN. Reply format in NON Node Masters: - Time on the format HHMMSS when message was generated. - Date on the format DDMMYY when message was generated. - Unique identifier for the system event in the interval 0..231. - Number of Retransmissions Left before giving up to try transmitting alarm to the AEM. - Time on the format HHMMSS when heartbeat was successfully transmitted to the OMC. If heartbeat is not yet delivered, a '-' (dash) is replied. - Date on the format DDMMYY when heartbeat was successfully transmitted to the OMC. If heartbeat is not yet delivered, a '-' (dash) is replied. - A quoted string containing the actual heartbeat message. Reply format in Node Masters: - indicates node that heartbeat was generated on. Node Master is always node zero. - Time on the format HHMMSS when message was generated. - Date on the format DDMMYY when message was generated. - Unique identifier for the system event in the interval 0..231. - Number of Retransmissions Left before giving up to try transmitting alarm to the AEM. - Time on the format HHMMSS when heartbeat was successfully transmitted to the OMC. If heartbeat is not yet delivered, a '-' (dash) is Common Commands and Attributes 55/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 replied. - Date on the format DDMMYY when heartbeat was successfully transmitted to the OMC. If heartbeat is not yet delivered, a '-' (dash) is replied. - A quoted string containing the actual heartbeat message. Note! If no log entry exists in log at this position, a single '-' (dash) is replied. 9.2 HLN – Heartbeat Log Length 9.2.1 Overview This replies with number of heartbeats in the heartbeat log at the moment. 9.2.2 Usage Attribute type: Read only Format: where is an integer indicating how many heartbets are currently in the heartbeat log. Example: GET HLN Returns: 42 meaning that there are 42 heartbeats that can be read out from the log, starting with log item 1. 9.3 HOS – Heartbeat on System Startup 9.3.1 Overview This configures whether an heartbeat should be sent on system startup. 9.3.2 Usage Attribute type: Read and Write When the controller is integrated to the Axell Element Manager it sends heartbeat reports on regular intervals to let the AEM know the repeater is up and running. In case of a long power failure, or when the equipment has been down for maintenance, the controller can be configured to send a heartbeat directly on power on, to ensure that the Axell Element Manager is aware that the system is back online. In most cases this is handled by the controller sending an end of power supply alarm, but in certain applications it might be useful to have the controller sending a heartbeat on system boot. Format: Common Commands and Attributes 56/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 where = 0 means that no heartbeat will be transmitted on startup, and = 1 means heartbeat will be transmitted on startup. Example: GET HOS Reply: means that no heartbeat will be transmitted on startup. Example: SET HOS 1 configures the heartbeat to be transmitted on system startup. 9.4 MRR – Maximum Report Retransmission 9.4.1 Overview This defines maximum number of retransmissions that will be attempted when sending reports to the AEM. 9.4.2 Usage Attribute type: Read and Write Every report is sent to the Axell Element Manager up to MRR number of times, or until it is successfully delivered. The reports are retransmitted with RCR minutes intervals. When using data call, report is considered successfully delivered when the controller has successfully logged in to the AEM, and delivered the report. In case of SMS, report is considered successfully delivered when it has been successfully transmitted to the SMSC. Format: where denotes maximum number of attempts that will be made to deliver the report. Allowed interval is from 0 to 9 retransmissions. Example: GET MRR Reply: meaning that the repeater will try to retransmit a report 3 times. Example: SET MRR 2 sets maximum number of retransmissions to 2. 9.5 RCH – Repetition Cycle for Heartbeats 9.5.1 Overview The repetition cycle for heartbeats defines with what interval the reports should be Common Commands and Attributes 57/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 transmitted to the AEM. 9.5.2 Usage Attribute type: Read and Write Sets the interval for how often the heartbeat reports are sent to the Axell Element Manager. The heartbeat report is a report containing all relevant status parameters of the system. If a report fails to be sent, attempts will be made to retransmit the reports with a settable interval. Refer to attributes RCR and MRR for information on how to change the number of retransmissions and retransmit interval. Format: is the heartbeat interval in minutes. Valid values are from 0 to 100 000 minutes. Setting the interval to 0 (zero) means no heartbeat reports will be transmitted. Example: GET RCH Reply: 1440 meaning that a heartbeat will be sent to the Axell Element Manager every 1440 minutes (once per day), starting from when last report was successfully transmitted to the AEM. Example: SET RCH 10080 changes this interval to 10080 minutes (once per week) Note! As soon as the heartbeat interval is changed, and the user is logged out, a new heartbeat will be sent to the Axell Element Manager in order to cause resynchronization of the heartbeat intervals between the controller and the AEM. 9.6 RCR – Repetition Cycle for Reports 9.6.1 Overview This configures with what intervals the controller will attempt to retransmit reports to the AEM. 9.6.2 Usage Attribute type: Read and Write Every report is sent to the Axell Element Manager up to MRR number of times, or until it is successfully delivered. The reports are retransmitted with RCR minutes intervals. When using data call, report is considered successfully delivered when the controller has successfully logged in to the OMC, and delivered the report. In case of SMS, report is considered successfully delivered when it has been successfully transmitted to the SMSC. Format: where is the retransmit interval in minutes. Valid intervals range from 1 Common Commands and Attributes 58/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 to 20 minutes. Example: GET RCR Reply: meaning that after a failed report transmission, a new attept will be made after 3 minutes. Example: SET RCR 2 sets the time between retransmissions to 2 minutes. 9.7 ACT HBT – Request Heartbeat Transmission 9.7.1 Overview This command forces a transmission of a heartbeat report. 9.7.2 Usage Attribute type: Write-Only Action This command is used to transmit heartbeat reports to the Axell Element Manager. This can be used to force a heartbeat synchronization. Format: ACT HBT caused the heartbeat report to be transmitted as soon as the configured communications interface is available. Example: ACT HBT will, if logged in locally, perform an immediate connection to the Axell Element Manager, and the heartbeat report to be delivered. 9.8 ACT CHB – Clear Heartbeat Log 9.8.1 Overview This command is used to clear all the entries in the heartbeat log. 9.8.2 Usage Attribute type: Write-Only Action This action clears all heartbeats from the heartbeat log, and requires Read and Write access when logged in. Via SMS, this can only be performed by the Main Address. Common Commands and Attributes 59/123 Document Name: Common Commands and Attributes v1.3.0 9.9 LOGDUMP HEARTBEAT 9.9.1 Overview Revision: 1.2 This command generates a list of heartbeat reports. 9.9.2 Usage By using the command LOGDUMP HEARTBEAT, it is possible to read out heartbeat report log entries. The format of each line is exactly the same as for the HIT attribute. Format: LOGDUMP HEARTBEAT where is the first entry that should be read from the log, must be greater than 0. is the last entry that should be read from the log, and must be greater than or equal to . Example: LOGDUMP HEARTBEAT 1 5 Reply: 040843 030120 030105 025740 025718 221206 231206 241206 251206 261206 379 367 366 365 364 -1 000001 010170 "17 14 0 0 0 0 0 0 0 0 0 0 0 0 1111 1440" 3 030617 020100 "17 14 0 0 - - - - - 0 - - - - ---- 1440" 3 030546 020100 "17 14 0 0 0 0 0 0 0 0 0 0 0 0 1111 1440" 0 025916 020100 "17 14 0 0 0 0 0 0 0 0 0 0 0 0 1111 1440" 1 025914 020100 "17 14 0 0 0 0 0 0 0 0 0 0 0 0 1111 1440" which are the 5 latest heartbeat reports. Note 1! A maximum of 100 log items can be read out at a time. If item does not exist, no reply is given. Note 2! If this is a repeater system node master, HIT will contain a leading node number, indicating what node this heartbeat was collected from. Node master is always node number zero. Common Commands and Attributes 60/123 Document Name: Common Commands and Attributes v1.3.0 10 Revision: 1.2 SYSTEM ADMINISTRATION AND INVENTORY MANAGEMENT This section defines attributes related to system configuration and inventory management, such as hardware lists and software versions. 10.1 ADC – Active Devices Count 10.1.1 Overview This attribute returns number of active devices in the system, and is used for inventory management. 10.1.2 Usage Attribute type: Read only Active Device Count indicates how many active devices configured in and monitored by the controller. An active device is a hardware device containing a microprocessor which is polled by the controller, such as a Power Supply, Reference Generator or different interface boards. Format: where returns number of active devices in the system . Example: GET ADC Replies: meaning that there are 4 active devices configured in the system. Please refer to attribute HDI and DDI on how to retrieve information about the different devices. 10.2 DAT – System Date 10.2.1 Overview Used to get and set the system date. 10.2.2 Usage Attribute type: Read and Write The controller contains a real time clock, which is used to keep track of when certain events occurs, and to be able to send reports on configurable times of the day. This attribute reads and sets the date of the system clock. Format: Common Commands and Attributes 61/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 DDMMYY where DD=Date, MM=Month, YY=Year Example: GET DAT Replies: 181005 means the repeater date is set to 18’th of October, 2005. Example: SET DAT 241205 sets the repeater date to 24’th of December, 2005. Note! When setting the date, a heartbeat will be sent immediately (or if logged in via modem, as soon as user logs out), the traffic / uplink activity logs (if supported) will be cleared and all alarms in the log will have the number of retransmissions of non-acknowledged alarms set to the value MNR. 10.3 DDI – Detailed Device Information 10.3.1 Overview This is used to read out details of a device / node that is monitored by the controller, and is used for inventory management. 10.3.2 Usage Attribute type: Read only Each node monitored by the controller contains a number of parameters that are common between all the nodes. This attribute displays all common parameters. Format: GET DDI where is a number from 1 to max number of attributes (as read out by ADC attribute). Format on reply: where is the Serial Number of the device is Article Number / Hardware Revision is a string delimited by “ (double quote) signs, containing software version of the device/node. is a string delimited by “(double quote) signs, containing software build time. is a string delimited by “(double quote) signs, software build date. is a string delimited by “(double quote) signs, containing manufacturing specific information. If no information is available, a ‘-‘is reported. contains the repeater initialization time on the format HHMMSS, with 24 hours notation. If no information is available, a ‘-‘(dash) is reported. contains the repeater initialization date on the format DDMMYY. If no information is available, a ‘-‘(dash) is reported. shows how many seconds the device has been up and running since last Common Commands and Attributes 62/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 reset. shows how many times the device has been started since device was initialized. shows how many times the watchdog has forced the device to reset since device initialization is a string delimited by “(double quote) signs, containing a textual description of the hardware device. Note! If is greater than ADC, a single '-' (dash) will be reported. 10.4 HDC – Hardware Device Count 10.4.1 Overview This attribute returns number of hardware devices in the system, and is used for inventory management. 10.4.2 Usage Attribute type: Read only Hardware Device Count indicates how many hardware items are configured in the system monitored by the controller. Format: where returns number of hardware devices in the system (including controller itself). Example: GET HDC Replies: 12 meaning that there are 12 hardware devices (both active and passive) configured in the system. Please refer to attribute HDI on how to retrieve information about the different devices. 10.5 HDI – Hardware Device Item 10.5.1 Overview This attribute gives information about the different hardware devices in the system, and is used for inventory management. 10.5.2 Usage Attribute type: Read only This command returns device information about a specific device. Format: GET HDI Common Commands and Attributes 63/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 is from 1 to HDC. Reply format: is 4 characters containing the device serial number. is the Axell Article Number, up to 12 characters. contains a quoted textual description of the hardware device. String can be up to 40 characters wide. Example: GET HDI 1 Reply: 4711 H411001A "Control Module" which indicates that this is a control module with serial number 4711 and article number H411001A. Note! If doesn't exist, a dash '-' is replied. Example: GET HDI 4000 Reply: 10.6 HWV - Hardware Version 10.6.1 Overview This attribute returns hardware version of the controller. 10.6.2 Usage Attribute type: Read only Using this attribute it is possible to determine the hardware version of the control module. Format: which is a string identifying hardware version and revision. Example: GET HWV Replies: H421001C meaning that the controller version is H121001C. 10.7 LTG – Lock Tag 10.7.1 Overview This configures if the TAG should be possible to modify or not. Common Commands and Attributes 64/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 10.7.2 Usage Attribute type: Read and Write When commissioning the repeater, the actual site ID is often of high importance, and is normally configured by using the attribute TAF. During integration of the repeater into the Axell Element Manager, it is possible to set the TAG from the AEM itself. By using the attribute LTG (Lock Tag) it is possible to lock the tag from accidently being modified. Format: where = 0 means that it is possible to modify the tag, and = 1 means that the Tag is locked from modification. Example: GET LTG Reply: means that no tag is unlocked and that it is possible to change the tag. Example: SET LTG 1 disables the possibility to change the tag. 10.8 MDL – Target Model Identification 10.8.1 Overview This attribute returns a string containing the equipment type being monitored by the controller. 10.8.2 Usage Attribute type: Read only The model identification string is a unique identifier indicating exactly what kind of equipment is monitored by the controller. This information is essential for the Repeater Maintenance Console and for the Axell Element Manager integration to know exactly what parameters are supported by the controller. Format: uniquely identifying the equipment type. Example: GET MDL Reply: CSFT922-ER indicating that this is a Channel Selective Frequency Translating 2-channel repeater for the 900 band of Remote type with External combining. For a textual description of the equipment model, please refer to attribute MDD. Note! For detailed information on the different models and their interpretation, refer to corresponding product manual. Common Commands and Attributes 65/123 Document Name: Common Commands and Attributes v1.3.0 10.9 Revision: 1.2 MDD – Target Model Description 10.9.1 Overview This attribute returns a textual string, describing the type of equipment being controlled. 10.9.2 Usage Attribute type: Read only The target model description replies with a verbose output of the type of equipment being monitored by this controller. Format: being a string with a maximum length of 140 characters. Example: GET MDD Reply: Channel Selective EDGE/GSM 4-channel Repeater on 900 MHz band being a detailed description of the actual equipment type. 10.10 MSG - Message Counter 10.10.1 Overview This displays the value of the system event counter. 10.10.2 Usage Attribute type: Read only For each report or alarm being transmitted to the Axell Element Manager, a message counter is increased, giving each alarm and report a unique system event number in the system. This attribute displays current value of the counter. Format: where the value is from 0 to 231. Example: GET MSG Reply: 16471 indicating that the value of the system event counter currently is 16471. Common Commands and Attributes 66/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 10.11 RID – Repeater ID 10.11.1 Overview The repeater ID is a unique identifier for the element within the network, and is set by the AEM. 10.11.2 Usage Attribute type: Read and Write The repeater ID gives the Axell Element Manager a way to give the each network element a unique number in the network. Format: 10.11.3 XX-YY-ZZZZ XX,YY,ZZZZ are unique numbers to identify the element. The length of the repeater ID is exactly 10 characters. Example: GET RID Reply: 01-01-0334 which is the unique ID for this element. Example: SET RID 02-01-0077 Modifies the repeater ID. Note! If the element is installed into and controlled by the Axell Element Manager, this attribute should NEVER be modified. This ID is unique in the Element Manager database. Changing this ID will cause the Axell Element Manager database to be corrupted, and monitoring of the network element to fail. 10.12 SHW – Supported Hardware 10.12.1 Overview This attribute informs about some of the supported hardware in the system. 10.12.2 Usage Attribute type: Read only This attribute displays if certain system functionality is supported by the hardware configurations. This function is mainly used by Repeater Maintenance Console and Axell Element Manager to adjust user interface depending on configurations. Format: where each field can be Common Commands and Attributes 67/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 0 – meaning that corresponding functionality is not supported by target. 1 – meaning that corresponding functionality is supported by target. Example: GET SHW Reply: 111101 meaning that EX1-EX4 and RLY are supported by target, while DOO is not supported. 10.13 SIS – System Information String 10.13.1 Overview This attribute displays miscellaneous information about the controller. 10.13.2 Usage Attribute type: Read only This compact string containing various controller and system versions and system dates. The string contains the following data, separated by spaces: is a string delimited by “ (double quote) signs, containing the controller Boot version. If no information is available, an empty string (“”) is replied. reports the serial number of the controller (4 characters). If no information is available, a ‘-‘ (dash) is reported. is a string delimited by “ (double quote) signs, containing the controller hardware version. reports the serial number of the equipment being controlled (4 characters). If no information is available, a ‘-‘ (dash) is reported. contains the article number of the product in which the controller is mounted. contains the controller initialization time on the format HHMMSS, with 24 hours notation. If no information is available, a ‘-‘ (dash) is reported. contains the controller initialization date on the format DDMMYY. If no information is available, a ‘-‘ (dash) is reported. contains the equipment initialization time on the format HHMMSS, with 24 hours notation. If no information is available, a ‘-‘ (dash) is reported. contains the equipment initialization date on the format DDMMYY. If no information is available, a ‘-‘ (dash) is reported. is a string delimited by “ (double quote) signs, containing information entered during manufacturing. Example: GET SIS Reply: “AviBoot 1.02” 42JG H501001A 4JF3 A1013410A 120333 051101 174200 051220 “MWTST” Common Commands and Attributes 68/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 indicating that Boot version is “AviBoot 1.02”, control module has the serial number 4JG5 and hardware version H501001A, the equipment serial is 4JF3 and article number A1013410A, the controller was initialized at 12:03.33 on Nov 1, 2005 the system (equipment) was initialized at 17:42.00 on Dec 20, 2005,. Finally, factory information is “MWTST”. 10.14 SIT – System Initialization Timepoint 10.14.1 Overview This displays the time point for initialization when controller/system was first initialized. 10.14.2 Usage Attribute type: Read only Returns a string containing the system initialization time, i.e. when the controller was initialized for the first time. Format: HHMMSS DDMMYY where HHMMSS is the time point, with 24 hours notation, and DDMMYY is the date of the initialization. Example: GET SIT Reply: 135207 211005 indicating that the controller was initialized on Oct 21 2005, 13:52:07 Note! By supplying the switch -n a numeric reply is given where the time point is represented in seconds from the 00:00:00 1970-01-01. Example: GET SIT -N Reply: 1129895527 which indicates number of seconds that elapsed from 00:00:00 1970-01-01 until the system was initialized (which converts to Oct 21 2005, 13:52:07). 10.15 SUT – System Uptime 10.15.1 Overview This displays the system uptime, which is defined as the time elapsed since last system startup. 10.15.2 Usage Attribute type: Read only Common Commands and Attributes 69/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 The system uptime is defined as the time that has elapsed since last system startup. Format: where is the number of seconds that has elapsed since last system reset, or since last power up. Example: GET SUT Reply: 10987735 meaning that the system booted up 10 987 735 seconds ago. Note! By supplying the switch -f a formatted reply is given where the elapsed time is converted to format Example: GET SUT -F Reply: 127 days, 4:08.55 which indicates an uptime of 127 days, 4 hours, 8 minutes and 55 seconds. 10.16 SWV – Software Versions 10.16.1 Overview This attribute replies with the different software versions in the system. 10.16.2 Usage Attribute type: Read only The software system consists of three different software versions. Format: where is a quoted string indicating what version of the core system. is a quoted string displaying the version for the so called common libraries used. indicates the version of the target software is configured on the system. Example: GET SWV Reply: “1.0.1” “1.1.1” “OnBoard1.1.3” indicating that system version is 1.0.1, common version is 1.1.1 and the target version being OnBoard1.1.3. Common Commands and Attributes 70/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 10.17 TAG – Repeater Tag 10.17.1 Overview The TAG allows to give each Axell element a textual name in the network. 10.17.2 Usage Attribute type: Read and Write The TAG allows for giving each Axell element an easy to understand name within the network. This can for example be the network site ID or the name of the location where equipment is installed. By using the attribute LTG (Lock Tag) it is possible to lock the tag from accidently being modified during for example the AEM integration. Format: where is a text string up to 30 characters long. Example: GET TAG Replies: SiteID:VF37 Sundbyberg Metro identifying the TAG. Example: SET TAG SiteID:VF3777 Sumpan Metro modifies the tag. Example: SET TAG Testing Tag Lock Reply: Error: Cannot modify tag, tag locked (unlock using LTG attribute). Note! Any extra spaces between words will be removed, ensuring that only one space separates each word in the tag. If extra spaces are required between words, the description can be put in double quotes, such as SET TAG “Tag with many spaces” 10.18 TIM – System Time 10.18.1 Overview Used to get and set the system time. 10.18.2 Usage Attribute type: Read and Write The controller contains a real time clock, which is used to keep track of when certain events occurs, and to be able to send reports on configurable times of the day. This attribute reads and sets the time of the system clock. Common Commands and Attributes 71/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 Format: HHMMSS where HH is 24-hour representation of the hours, MM is minutes, and SS is seconds. Example: GET TIM Reply: 145000 meaning the repeater time is 10 minutes to three in the afternoon. Example: SET TIM 150542 modifies the time to 15:05.42. Note! When changing the time, a heartbeat will be sent immediately (or if logged in via modem, as soon as user logs out), the traffic / uplink activity logs (if supported) will be cleared and all alarms in the log will have the number of retransmissions of non-acknowledged alarms set to the value MNR. 10.19 ACT RHW – Action Reset Hardware 10.19.1 Overview This is used to perform a reset of all active modules monitored by the controller. 10.19.2 Usage By executing ACT RHW, a hard reset of all active devices monitored by the system is performed. Example: ACT RHW will cause the software in all active devices to be reset immediately. Note! Reset of the hardware devices will be almost immediate, and certain radio devices might cause a short disruption of service, why this command should only be used with caution. 10.20 HARDWARE REPLACE 10.20.1 Overview This command is used to reconfigure a system after replacing a physical hardware device. 10.20.2 Usage This command is used to change the configuration in a system when a hardware device has been changed. This is normally performed when replacing a failing module to ensure that inventory list matches the devices, and to get the communication between the controller and the hardware to work properly. Hardware can be of two different kinds: Common Commands and Attributes 72/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 - Active devices. These devices contains a microprocessor for monitoring of parameters. Active devices contain the article number and hardware revision in the device. Typical active devices are radio boards, opto modules, reference generators etc. The controller communicates with active devices using the device serial number as an address, why it is important to configure the exact serial number for the communication to work. - Passive devices. These do not have a microprocessor, and hence article number and hardware revision has to be configured manually. Serial Numbers are always exactly four characters long. Letter 'o' is not used (to avoid confusion between letter 'o' and digit zero). Article Numbers are between 8 and 12 characters long. Letter 'o' is not used (to avoid confusion between letter 'o' and digit zero). Format on replacing Active devices: HARDWARE REPLACE where is the serial number of replaced module, and is the serial number of the new module. Example: HARDWARE REPLACE 4711 56AR replaces serial number of active device with serial number 4711 with a new hardware having serial number 56AR. Format on replacing Passive devices: HARDWARE REPLACE where is the serial number of replaced module, and is the serial number of the new module and is article number of new hardware. Example: HARDWARE REPLACE 540R 56UU J691030A Each change of hardware is kept in a log. In order to read out the log, use command HARDWARE LOG which displays all hardware changes that has been made to the system, including local time point for replacement. Example: HARDWARE LOG Reply: 2007-10-12 14:45:35 Replaced active device serial 4711 with 56AR. Device type: Reference Generator. 2007-10-12 14:50:03 Replaced passive device serial 540R with 56UU article number J691030A. Device type: External Alarm Interface Note! In order to read out current hardware configuration, refer to attributes HDC, HDI, ADC and DDI. 10.21 SYSADMIN – Log in as system administrator 10.21.1 Overview Enters System Administration mode with full user access to all system aspects Common Commands and Attributes 73/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 10.21.2 Usage Certain operations on the controller, such as installing new firmware and rebooting the system requires system administration privileges. In order to enter system administration mode, enter command SYSADMIN This will prompt for the System Administration password. If entered correctly, system administration mode is entered. In order to leave system administration mode, use command exit 10.22 REBOOT – Reboot the system 10.22.1 Overview Reboot the controller 10.22.2 Usage This command is used when rebooting the system. Only system administrator is allowed to do this, so run command sysadmin and enter system administrator password. After this, enter reboot to reboot the system. Rebooting the system normally leaves the system non accessible for roughly 45 seconds. However, RF performance of the equipment will remain fully operational during that time. In order to reset hardware devices in the system, please refer to attribute ACT RHW (reset hardware). Common Commands and Attributes 74/123 Document Name: Common Commands and Attributes v1.3.0 11 Revision: 1.2 USER ADMINISTRATION AND SESSION CONFIGURATIONS This chapter defines all commands, attributes and actions related to user administration and repeater access. 11.1 LIU – Logged In Users 11.1.1 Overview Gives a list of all users currently logged in to the controller. 11.1.2 Usage Attribute type: Read only The LIU attribute replies with all list of all users currently logged in to the system. Format: ... where all users are separated by a space. If no user is logged in, a '-' is reported. Example: GET LIU Reply: omcuname zaphod indicating that users omcuname and zaphod are logged in to the system. 11.2 LMT – Login Timeout 11.2.1 Overview Indicates after how long inactivity a logged in user should be logged out from the system. 11.2.2 Usage Attribute type: Read and Write If a logged in user does not perform any activity within LMT minutes, the controller will initiate an automatic logout of the user. This attribute configures the automatic interval. Format: where is the interval in minutes of inactivity. Allowed interval is from 1 to 99 minutes. Example: Common Commands and Attributes 75/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 GET LMT Reply: 20 meaning that the user will be logged out after 20 minutes of inactivity. Example: SET LMT 15 changes this time to 15 minutes of inactivity before user is automatically logged out. 11.3 MNU – Maximum Number of Users 11.3.1 Overview This attribute defines maximum number of users allowed to add to the system. 11.3.2 Usage Attribute type: Read only This attribute displays maximum numbers of users accounts that can be added to the system (excluding the omcuname and useradmin account). Format: where is an integer defining maximum number of user accounts allowed. Example: GET MNU Reply: 10 meaning that a maximum of 10 user accounts can be added to the system. 11.4 UAC - User Account Count 11.4.1 Overview This defines number of user accounts that are added to the system. 11.4.2 Usage Using the UAC attribute it is possible to read out how many user accounts are currently configured in the system, not including the omcuname and useradmin accounts. Format: indicates current number of accounts in the system. Example: GET UAC Reply: Common Commands and Attributes 76/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 meaning that there are 3 user accounts currently configured in the system, not including the useradmin and omcuname accounts. 11.5 UAI - User Account Item 11.5.1 Overview This gives information about a certain user account in the system, including access level. 11.5.2 Usage Reading the User Account Items it is possible to get information about all users added to the system. Format: GET UAI reads user account entry number from the user account list, where first account is 1. might be from 1 to value replied by GET UAC. Reply format: where is the login username and replies ReadOnly or ReadWrite, depending on user previleges. Note! If no log entry exists in log at this position, a single '-' (dash) is replied. Example: GET UAI 5 Reply: Arthur ReadWrite which means that user Arthur has ReadWrite access to the system. 11.6 ACT USERADD 11.6.1 Overview This attribute is used to add users to the system. 11.6.2 Usage Attribute type: Write-Only Action This attribute is used to add a user to the system. Only users “useradmin” and “omcuname” are allowed to administer users on the system. Any other user will be prompted for the “useradmin” password when launching ACT USERADD. The system has an upper limit for how many user accounts can be added to the system. Please refer to attribute MNU (Max Number of Users) for details. Format: ACT USERADD [-rw] Common Commands and Attributes 77/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 where must be at least 6 characters long. is case sensitive, meaning that it is important to differ between upper and lowercase. Valid user names follow these rules: * First character must be a letter (a-z, A-Z) * Allowed characters in the rest of the user name are a-z, A-Z, 0-9 and special characters '-' (dash), '_' (underscore) and '.' (dot). * Length of user name must be from 6 is 32 characters. If command switch -rw is used, the user will be added with read and write access, otherwise user will be added with read-only access. In order to escalate user to read and write access at a later stage, use ACT USERPROMOTE. [user name]. Example 1 , user is not useradmin: AVITEC AB> ACT USERADD Marvin Password: ********* User Marvin added. AVITEC AB> Example 2, user is useradmin (see USERADMIN command for details): USERADMIN> ACT USERADD Marvin Error: User already exists. USERADMIN> ACT USERADD Zaphod User Zaphod added. USERADMIN> Note 1! When adding the user to the system, the password is not set, and the user cannot login. In order to activate the account, use command ACT PASSWORD. Note 2! Adding a user to the system will cause an alarm to be posted to the Axell Element Manager informing about this new user (except for when omcuname adds the user). 11.7 ACT USERDEL 11.7.1 Overview This attribute is used to delete a current user from the system. 11.7.2 Usage Attribute type: Write-Only Action Only users “useradmin” and “omcuname” are allowed to administer users on the system. Any other user will be prompted for the “useradmin” password when launching ACT USERDEL. Format: ACT USERDEL where is one of the users in the system. is case sensitive, meaning that the system differs between uppercase and lowercase characters. Users currently logged in to the system cannot be deleted. Note! Users omcuname and useradmin cannot be deleted from the system. Example 1 , user is not useradmin: AVITEC AB> ACT USERDEL Trillian Password: ********* User Trillian deleted. AVITEC AB> Common Commands and Attributes 78/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 Example 2, user is useradmin (see USERADMIN command for details): USERADMIN> ACT USERDEL zaphod Error: User does not exist. USERADMIN> ACT USERDEL Zaphod User Zaphod deleted. USERADMIN> Note! Deleting a user to the system will cause an alarm to be posted to the Axell Element Manager informing about the removed user (except for when omcuname deletes the user). 11.8 ACT USERPROMOTE 11.8.1 Overview Promoting a user means to increase user access from read-only to read-write access. 11.8.2 Usage Attribute type: Write-Only Action Only users “useradmin” and “omcuname” are allowed to administer users on the system. Any other user will be prompted for the “useradmin” password when launching ACT USERPROMOTE. Format: ACT USERPROMOTE where is one of the users in the system. is case sensitive, meaning that the system differs between uppercase and lowercase characters. Note! Users omcuname and useradmin cannot be promoted within the system. Example 1 , user is not useradmin: AVITEC AB> ACT USERPROMOTE Arthur Password: ********* User Arthur promoted to read and write access. AVITEC AB> Example 2, user is useradmin (see USERADMIN command for details): USERADMIN> ACT USERPROMOTE Slartibartfast Error: User does not exist. USERADMIN> ACT USERPROMOTE slartibartfast User slartibartfast promoted to read and write access. USERADMIN> Note! Promoting a user in the system will cause an alarm to be posted to the Axell Element Manager informing about this new user access level (except for when omcuname promotes the user). 11.9 ACT USERDEMOTE 11.9.1 Overview Demoting a user means to decrease user access from read and write to read-only access. Common Commands and Attributes 79/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 11.9.2 Usage Attribute type: Write-Only Action Only users “useradmin” and “omcuname” are allowed to administer users on the system. Any other user will be prompted for the “useradmin” password when launching ACT USERDEMOTE. Format: ACT USERDEMOTE where is one of the users in the system. is case sensitive, meaning that the system differs between uppercase and lowercase characters. Users currently logged in to the system cannot be demoted. Note! Users omcuname and useradmin cannot be promoted within the system. Example 1 , user is not useradmin: AVITEC AB> ACT USERDEMOTE Ford Password: ********* User Ford demoted to read-only access. AVITEC AB> Example 2, user is useradmin (see USERADMIN command for details): USERADMIN> ACT USERDEMOTE FordPerfect Error: User does not exist. USERADMIN> ACT USERDEMOTE Ford_Perfect User Ford_Perfect demoted to read-only access. USERADMIN> Note! Demoting a user in the system will cause an alarm to be posted to the Axell Element Manager informing about this new user access level(except for when omcuname demotes the user). 11.10 ACT PASSWORD 11.10.1 Overview This is used to change passwords of a user. 11.10.2 Usage Attribute type: Write-Only Action Format on changing own password: ACT PASSWORD which will prompt for old password and new password. Passwords may include any printable characters, but must be at least 5 characters long. Example (assuming user Rutger): AVITEC AB> ACT PASSWD Changing password for Rutger Old password: New password should be at least 5 characters long, and preferably contain a combination of upper and lower case letters and numbers. Enter new password: Re.enter new password: Password changed. AVITEC AB> Common Commands and Attributes 80/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 Format on changing other users password: ACT PASSWORD [user name] which will change the password for [user name]. If [user name] is the same as currently logged in user, this will behave in the same way as changing own password. If not being logged in as useradmin, the useradmin password will first be prompted for, after which the password can be changed. Example (assuming user is not useradmin): AVITEC AB> ACT PASSWORD Rutger User Admin Password: ****** New password should be at least 5 characters long, and preferably contain a combination of upper and lower case letters and numbers. Enter new password: Re-enter new password: Password changed. AVITEC AB> Example (user is useradmin): USERADMIN> ACT PASSWORD Rutger New password should be at least 5 characters long, and preferably contain a combination of upper and lower case letters and numbers. Enter new password: Re-enter new password: Password changed. Note! For user account omcuname, changing passwords have slightly different behavior. Format on changing password when user is omcuname: ACT PASSWORD [user name] [password] This will change password of the [user name] instantly. Example (user is omcuname): AVITEC AB> ACT PASSWORD Rutger Wibba45Res Password for Rutger changed successfully. AVITEC AB> Note! Changing a user password in the system will cause an alarm to be posted to the Axell Element Manager informing about the changed password. Alarm message will not include the password itself, but only inform about the change (except for when omcuname changes the password). 11.11 USERADMIN 11.11.1 Overview This command is used to escalate rights and run the system with useradmin rights. 11.11.2 Usage This command is used to enter the system in as user administrator. Running the controller with useradmin rights is especially useful when configuring many user accounts in a row to avoid having to enter the useradmin password for each administration task being performed. Format: USERADMIN will prompt the user for the useradmin password. Example: Common Commands and Attributes 81/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 AVITEC AB> USERADMIN Password: USERADMIN> where the prompt indicates that escalating to useradmin was successful. Note! In order to leave user administration mode use command EXIT. 11.12 EXIT 11.12.1 Overview This command is used to leave user administration mode. 11.12.2 Usage This command is used to leave the user administration mode. Note! Being in user administration mode is indicated by having the prompt USERADMIN> rather than the normal AVITEC AB> Format: EXIT leaves the user administration mode. Executing the exit command when being in normal user mode will cause an error. Example: USERADMIN> EXIT AVITEC AB> where the Avitec prompt indicates that the function is exited. Note! Command LOGOUT might also be used to leave the user administration mode. 12 AXELL WIRELESS REPEATER SYSTEM SETTINGS This chapter defines commands and attributes related to repeaters being masters or slaves in an Axell Wireless Repeater System. An Axell Wireless Repeater System contains two different node types: Node Master is the node containing the communications interface towards the Axell Element Manager. The node master is responsible for polling all slave nodes for new alarms and events that should be transmitted to the Axell Element Manager. Slaves are nodes that does not have an interface towards the Axell Element Manager. Slaves contain a slave interface allowing for a node master to communicate with the system slave. A typical example of an Axell Wireless Repeater System is an Optical Master Unit (OMU) containing a remote communications device such as a modem, and which monitors a number of fiber optic fed repeaters using the fiber as a data communications channel (using a sub carrier in the fiber). Common Commands and Attributes 82/123 Document Name: Common Commands and Attributes v1.3.0 12.1 Revision: 1.2 System Node Identification Node Masters and Repeater System Slaves can always be identified using the GET MDL command, where node masters always replies with a trailing -M and system slaves always replies with a trailing -S. Example 1: GET MDL Reply: OMU-M indicating that this is an optical master unit, also being a node master in an Axell Wireless Repeater System. Example 2: GET MDL Reply: BSF424-S indicating that this is BSF424 (Band Selective FiberOptic Fed 400MHz repeater) acting as a repeater system slave. As an exception to the above identification, the first generation of Axell Node Masters, the HUB-unit always replies as: GET MDL Reply: HUB even though the HUB unit is a node master. 12.2 Node Addressing When addressing nodes in a Axell Wireless Repeater System, three different methods can be used: 12.2.1 Numeric Addressing Each node in the network gets a unique ID-number in the Node List as they are added to the system. Node 0 is always the master node. Addressing is on the format @K where K is from 0 to N where N is number of nodes. Reading a parameter from node 3 is entered as: AVITEC AB> @3 GET ATD 14 AVITEC AB> 12.2.2 Serial Number Addressing Node can be accessed using the serial number of the node. Example: AVITEC AB> @3J34 GET MDL BSF414 AVITEC AB> Common Commands and Attributes 83/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 12.2.3 Node ID Addressing Node can also be addressed using the full Node ID. Example: AVITEC AB> @01-01-5S45 GET TAG SITE3_TUNNEL_OPENING AVITEC AB> 12.3 Master Slave Common Configurations 12.3.1 DNA – Direct Node Access 12.3.1.1 Overview Sets the user interface in direct node access to another node in a repeater system. 12.3.1.2 Usage Attribute type: Write only This attribute is only used in repeaters / elements being a part of an Axell Wireless repeater system (this can be determined with command GET SNI). When many attributes are sent to another node, the user can enter Direct Node Accessing mode, where the node where the user is logged in redirects all commands to another node. This mode is configured by sending the command: SET DNA [Node Address] where node address can be any of the following addressing modes: * Numeric Addressing using the node number, such as @3 * Serial Addressing using node serial number, such as @5TTR * Full Node ID Addressing using the complete node ID, such as @01-10-5TTR When going into direct node access, the destination address is displayed in the prompt in the same way as they where addressed, for example AVITEC AB@5TTR> Leaving the direct access node is done using the SET DNA command with the node address left out, or by entering the command EXIT. AVITEC AVITEC AVITEC AVITEC AB>SET DNA @01-10-5TTR AB@01-10-5TTR>GET DOO AB@01-10-5TTR>SET DNA AB> Other nodes can still be addressed when using the Direct Node Addressing mode. For example, being at node 3 and having direct node access to node 0, node 5 can still be accessed: AVITEC AB>SET DNA @0 AVITEC AB@0>GET ASC +46705008999 AVITEC AB@0>@3 GET DOO AVITEC AB@0>EXIT AVITEC AB> Common Commands and Attributes 84/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 12.3.2 MID – Master ID 12.3.2.1 Overview If part of an Axell Wireless Repeater System, this displays ID of the master node. 12.3.2.2 Usage Attribute type: Read only If node is part of an Axell Wireless Repeater System, this attribute replies with the ID of the master node of the entire system. Format: XX-YY-ZZZZ where XX, YY and ZZZZ are numbers. These numbers are assigned by the Axell Element Manager during integration of the repeater system to the Axell Element Manager. Example: GET MID Reply: 01-17-0042 meaning that the node ID for the master unit is 01-17-0042. Note 1! On node masters, Master ID (MID) is always the same as Repeater ID (RID). Note 2! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” 12.3.3 NIN – Node Information 12.3.3.1 Overview Displays information about a certain node in an Axell Wireless Repeater System. 12.3.3.2 Usage Attribute type: Read only This is a read only parameter, returning information about a certain node. Format: GET NIN N N is one of the Node Addressing Modes without the leading @ sign. Reply format: is 0 if node is OK, or 1 if node has one or more errors. If node communication is in error, a ‘-‘ (dash) is reported, indicating that node status is Common Commands and Attributes 85/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 unknown. is the serial number of the node / repeater. is the repeater model identifier, as replied by attribute MDL. is the name of the node site, as replied by attribute TAG, wrapped in two “”. replies with the software version of the node controller, as replied in SWV attribute. This consists of three tokens, all wrapped in two ‘”’. Example: GET NIN 1 gets information about node 1. Reply: 1 56FR BSF424-S “Emergency exit 7” “1.1.0” “1.0.2” “BSF424 1.0.0” Note! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” 12.3.4 NNO – Node Number 12.3.4.1 Overview Displays node number for this node in an Axell Wireless Repeater System. 12.3.4.2 Usage Attribute type: Read only This is a read only parameter determining the node number for this node in an Axell Wireless Repeater System. Format: GET NNO Reply: N determines this node’s number in the node list Note 1! For master nodes, this will always reply '0' (zero). Note 2! If this parameter is read from a slave node and the master has not yet updated the node, a ‘-‘ is replied. Note 3! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” 12.3.5 NON – Number Of Nodes 12.3.5.1 Overview This attribute displays number of nodes configured in an Axell Wireless Repeater System. Common Commands and Attributes 86/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 12.3.5.2 Usage Attribute type: Read only This attribute is used in Axell Repeater systems to determine how many nodes are configured in the Repeater System. Format: GET NON Reply: where N determines the number of nodes configured in the system, including the master. Note 1! If this parameter is read from a slave node, and the master has not yet updated the node, 0 is replied. Note 2! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” 12.3.6 NST – Node Status 12.3.6.1 Overview Displays summary status for each node configured in an Axell Wireless Repeater System. 12.3.6.2 Usage Attribute type: Read only Node status attribute is used to give an overview of the status for all nodes in the network, including the master unit. Format: … is the summary status for the Master unit. Status is 0 if node is OK,or 1 if node has one or more errors. is status for node k. Status is 0 if node is OK or 1 if node has one or more errors. If node is not installed, or node status is unknown (such as communications alarm between node master and slave), a ‘-‘ is reported. Example: GET NST Reply: 000100------------------- This means that the system is configured with 6 nodes, and that slave node number 3 is in error. Note! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” Common Commands and Attributes 87/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 12.3.7 SNI – System Node Identification 12.3.7.1 Overview This parameter can be used to identify if this is a node in an Axell Wireless Repeater System. 12.3.7.2 Usage Attribute type: Read only This is a read only parameter that can be used to identify if this is part of an Axell Wireless Repeater system, or if this is a standalone node. Format: GET SNI Reply: N = ‘-‘ means that this node is NOT part of a repeater system N = ’M’ means that this node acts as a Master node in a repeater system N = ‘S’ means that his node acts as a Slave node in a repeater system 12.3.8 NODES 12.3.8.1 Overview Prints information about all nodes configured in an Axell Wireless repeater system. 12.3.8.2 Usage nodes is a command printing out configuration for all repeaters in the network. The Node Master is responsible for informing all repeaters in the repeater system about status, model and firmware version of all other nodes in the network. Executing this command on a slave that is not yet integrated to the repeater network, or that is recently started might report some nodes to be unkown. 12.4 Slave Specific Configurations 12.4.1 DSA – Direct Slave Access 12.4.1.1 Overview Enables direct access to the slave from the node master. 12.4.1.2 Usage Attribute Type: Action-Only Common Commands and Attributes 88/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 When performing advanced configurations on a node, it is sometimes desirable to have a direct access mode to the node, where all commands are available rather than just GET, SET and ACT commands. This attribute pauses the slave from listening to data packets from the master and launches a login prompt on the slave interface instead. Format: ACT DSA causes the controller to pause the slave interface and launch a login session via the slave interface instead. Example: ACT DSA Reply: Direct Slave Access initiated. displaying that Direct Slave Access is initiated. Note 1! When running direct access, no alarm polling is made from the master to any of the slave nodes connected to this bus. Note 2! If launching the login prompt via slave interface and no login have been made within one minute, the controller goes back to normal operations again. Note 3! The inactivity timeout for idle activity when accessing the slave from the node master is three minutes, meaning that if no activity has been detected during this time, the slave will go back to normal operation. Note 4! Please refer to command DIRECT ACCESS on how to obtain direct access from the node master to the slave. 12.4.2 NLS – Network Login Status 12.4.2.1 Overview Determines if it is possible to send commands to other nodes in a repeater system. 12.4.2.2 Usage Attribute Type: Read-Only This attribute determines if Node Master has detected login to this node and granted access to read and set parameters on other nodes in the repeater network. Format: where N=0 means node master has not yet granted us network access, or, if node master is the HUB unit, someone else is logged in to the network either from a HUB or from elsewhere in the network. It is not possible to read or write parameters from other parts of the network. N=1 means node has granted us access to the network, and it is possible to read or write parameters from other nodes in the network. Example: Common Commands and Attributes 89/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 GET NLS Reply: means that we have full access to the repeater network, and can get and set parameters on other nodes. Note! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” 12.4.3 NMC – Node Master Capabilities 12.4.3.1 Overview Display capabilities of the Node Master from a communications point of view. 12.4.3.2 Usage Attribute Type: Read-Only This attribute determines if master unit is a HUB (old) or a new generation Node Masters with enhanced performance and functionality. This parameter is used by System Slave to adjust certain parameters and behaviors to the capabilities of the Node Master. Format: where N=0 indicates that Node Master is a HUB unit with first version of controller. N=1 indicates that Node Master is the enhanced Node Master with capabilities matching the capabilities of the System Slave. Example: GET NMC Reply: meaning that node master has the full capabilities. Note! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” 12.4.4 RXQ – Status of Received Data Quality Displays status of the RXQ alarm source. 12.4.4.1 Usage Attribute Type: Read-Only The system slave constantly runs statistics on the last 1000 data packets received from the Node Master, and once per second calculates number of packets with errors (such as CheckSum errors or illegal length of received data packets). If percentage of correctly received packets decreases below a configurable threshold, Common Commands and Attributes 90/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 an RXQ alarm is triggered. This attribute reply with status of the Received Data Quality alarm source. Format: where is status of the received data quality. 0 if status is OK 1 if status is ERROR - (dash) if measured data is not available (for example, not sufficient data available). Example: GET RXQ Reply: indicating that received data packets contains a too high percentage of errors. Note! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” 12.4.5 RQL – Received Data Quality Level 12.4.5.1 Overview Displays quality of the received data packets from node master. 12.4.5.2 Usage Attribute Type: Read-Only The system slave constantly runs statistics on the last 1000 data packets received from the Node Master, and once per second calculates number of packets with errors (such as CheckSum errors or illegal length of received data packets). If percentage of correctly received packets decreases below a configurable threshold, an RXQ alarm is triggered. This attribute replies with the last measured level of the Received Data Quality. Format: where N is the value in % * 10 for valid data packets received. Example: GET RQL Reply: 998 meaning that 99.8% of data packets were error free/correctly received. Note! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” Common Commands and Attributes 91/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 12.4.6 ACT SSP – System Slave Pause 12.4.6.1 Overview This action causes a temporary stop in accepting packets from node master. 12.4.6.2 Usage Attribute type: Write-Only Action This command is used to temporarily stop handling data packets from the node master, and is mainly used for testing purposes. Format: ACT SSP [N] where the optional parameter N determines number of seconds that the interface should pause the remote communications. N is from 1 to 120 seconds. If N is not provided, slave will pause communications for 5 seconds. Example: ACT SSP 12 will pause the system slave interface for 12 seconds. Note 1! When executing this command, no communication with other nodes in the network will be possible. Note 2! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” 12.4.7 SST – System Slave Statistics 12.4.7.1 Overview Displays detailed statistics of the system slave interface. 12.4.7.2 Usage Attribute Type: Read-Only This attribute replies with statistics on the System Slave, and is mainly intended for troubleshooting during system setup. Two different packets can be received by the node, a broadcast, which is sent to all nodes in the system and a data packet, which his intended for a specific node. Broadcasts never requires replies back to the master, while all data packets expects a reply to be transmitted back to the node master (assuming packet destination was this slave node). For each packet received, a number of error checks are performed to see that data packets are not corrupted, such as Checksum Errors and Length Errors. Format: Common Commands and Attributes 92/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 where is total number of received bytes since slave started. is total number of transmitted bytes since slave started. is total number of received valid broadcasts. is total number of valid data packets. is total number of received data packets addressed to this node. is total number of packets received, where a checksum error is detected. is total number of packets received where length did not match expected length. is total number of packets received with unspecified errors. is number of received error free broadcasts where actual packet format is unknown (typically this is where node master contains a newer software version with enhanced command structure that slave doesn't understand). is number of received error free data packets where actual packet format is unknown. is total number of packets transmitted to the node master. is total number of packets that for some reason failed to be transmitted to the node master. is number of packets / second sent by the master with one decimal resolution. is time point of last error free received packet. Time point is on the format HHMMSS DDMMYY, where time is on 24 hours notation. is time point of last successfully transmitted packet to the node master. Time point is on the format HHMMSS DDMMYY, where time is on 24 hours notation. For any parameter not detectable, a '-' is presented in corresponding position, except time points, which are displayed as 000000 010170. Example: 123444 10023 1234 2233 839 2 0 0 0 0 839 0 3.4 122334 070507 122331 070507 displaying all statistics as described above. Note! If node is not part of a repeater system, an error message will be produced: “Error: Node not part of a repeater system, parameter not supported.” 12.5 Node Master Configurations This section describes attributes only available when configuring the repeater / element as a Node Master, monitoring a number of slave nodes in an Axell Wireless Repeater System 12.5.1 NCO – Node Communications Status 12.5.1.1 Overview Displays status of communication with nodes. 12.5.1.2 Usage Attribute type: Read only Common Commands and Attributes 93/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 This attribute replies with status of communication with all nodes in the repeater system. Format: .. is the status for communication with node X. 0 means communication is OK 1 means communication failure with node (ERROR). - (dash) means node is not configured. Example: GET NCO Reply: 00100000---------------- meaning that the system is configured for 8 remote nodes, and that communication with node 3 is in ERROR state (no contact with node). Note! If node is not configured as a node master, an error message will be produced: “Error: Node not a System Node Master, parameter not supported.” 12.5.2 NLU – Nodes With Logged In Users 12.5.2.1 Overview Displays what nodes have a user currently logged in to the repeater system. 12.5.2.2 Usage Attribute type: Read only This attribute gives information about what nodes in the repeater system that currently has a user logged in. Format: .. is the login status for node X. 0 means no user is logged in to node. 1 means user logged in to node. - (dash) means node is not configured or status unknown (communications error with node). Example: 00100000---------------- meaning that the system is configured with 8 remote nodes, and that a user is logged in to node 3. Note! If node is not configured as a node master, an error message will be produced: “Error: Node not a System Node Master, parameter not supported.” Common Commands and Attributes 94/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 12.5.3 NST – Node Statuses 12.5.3.1 Overview Displays status of all nodes in the network. 12.5.3.2 Usage Attribute type: Read only Node status attribute is used to give an overview of the status for all nodes in the network, including the Node Master. Format: .. is the summary status for the Master unit and is status for node X. 0 if status is OK 1 if status is ERROR - (dash) if measured data is not available, or there is a communications error with node. Example: GET NST Reply: 000100------------------- This means that the system is configured with Master plus 5 nodes, and that slave node number 3 is in error. Note! If node is not configured as a node master, an error message will be produced: “Error: Node not a System Node Master, parameter not supported.” 12.5.4 NSC – Node Status Configuration 12.5.4.1 Overview Configures if an error in node status should affect relay and/or LED in Node Master. 12.5.4.2 Usage Attribute type: Read and write This attribute is used to configure if status of slave nodes should be reflected in controller Error LED and / or in controller relay status. Format: where is 0 means that slave node errors not should be reflected in LED, and 1 means that an error in a slave node should cause the controller Error LED to indicate an error. is 0 means that slave node errors not should affect the relay output, and 1 Common Commands and Attributes 95/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 means that an error in a slave node should cause the controller relay output to indicate an error. Example 1: GET NSC Reply: 00 meaning that neither the LED or Relay will affect status in the slave nodes. Example 2: SET NSC 01 reconfigures the settings so that an error in a slave node will cause the controller relay to indicate an error. Note! If node is not configured as a node master, an error message will be produced: “Error: Node not a System Node Master, parameter not supported.” 12.5.5 ACCESS NODE 12.5.5.1 Overview This is used to get a direct access to a system slave such as a fiber optic repeater. 12.5.5.2 Description Communications between the master and a slave is normally performed using GET, SET and ACT attribues that are sent between the nodes. For more advanced troubleshooting and in order to perform firmware upload, it is required to get a transparent channel between the node master and the system slave, for example between the OMU and the fiberoptic fed repeater in a fiber optic repeater system. Format: ACCESS NODE where is any of the node addressing modes (list position, serial or RepeaterID). An ACCESS NODE session can always be aborted using the escape sequence Wait 1 s, three dash within one second and Wait 1 s, which will bring the standard userprompt back. However, if logging in is completed into the remote node it is recommended to perform a logout from the remote node instead. Otherwise the remote node might stay logged in and cause the node to be unavailable for a while. Note 1! ACCESS NODE is only available from master nodes to system slaves. Note 2! When having direct access to a system slave, no communication will occur to slaves on the same bus, meaning that no alarms will be monitored in the system until logged out from the system slave. Example of an ACCESS NODE session AVITEC AB>access node 2 Use escape sequence --- to abort. Entering Direct Access mode. Common Commands and Attributes 96/123 Document Name: Common Commands and Attributes v1.3.0 Avitec Controller Repeater ID: 01-10-624T 1/23/2009 23:43:23 login: avitec Password: You are now logged in to the Avitec Control Module. Time: 23:43:30 Date: 2009-01-23 RID: 01-10-624T SYSEVENT: User logged in with full access AVITEC AB>get mdl MBF-S-9-S AVITEC AB> AVITEC AB>exit User logged out from Control Module. Revision: 1.2 Tag: Repeater/Site Name Remote node logged out, aborting. Shutting down connection. Over and out. AVITEC AB>access node 2 12.5.6 NODE 12.5.6.1 Overview Command node is used to add or remove nodes from a master slave system, and can only be ran on node masters. 12.5.6.2 Description When setting up a repeater system, the node master needs to have information on all the nodes in the network. By using the node command, nodes can be added to or removed from the repeater system. In order to get an overview of configured nodes in the network, refer to command nodes. Format on adding nodes: NODE ADD : [Baud Rate] where is the serial number of the node (controller or repeater / element serial number) that should be added. Serial Numbers are always exactly four characters long. Letter 'o' is not used (to avoid confusion between letter 'o' and digit zero). determines which one of the two data communication channels in the controller that should be used (refer to target documentation for details). Valid values are 0 and 1. is used in some targets (such as Optical Master Unit) to specify what communications device is used for communication with remote node. If not used, a '-' (dash) should be entered instead. is used in some targets (such as Optical Master Unit) to specify what communications device is used for communication with remote node. is used to determine what kind of network element is to be monitored. This should be set to 1 for H40/H50-controller based slaves, and 0 for older slave types (H30/H12-controller based). [Baud Rate] is an optional parameter that defines what baud rate to use on communication between node master and actual nodes / slaves. If not supplied, 57600 is assumed. Baud rate is normally configured when adding nodes with set to 0, where data rate between node master and slaves is lower. Example on adding node: Common Commands and Attributes 97/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 NODE ADD 60FY 0 -:- 1 which adds node 60FY on bus zero. and are ignored, and is set to 1, meaning that node is probably using a H40 or H50 based controller. Format on deleting nodes: NODE DEL | DELETE where identifies the node using one of the node addressing methods (serial number, node number or full Node ID) Example on deleting node: NODE DELETE 12 deletes the 12'th node in the node list. Note 1! Command NODES gives an overview of all commands configured in the system. Note 2! If node is not configured as a node master, an error message will be produced: “Error: Node not a System Node Master, command not supported.” 13 NETWORK CONFIGURATIONS Depending on hardware configuration, the controller might be equipped with an Ethernet interface. This section describes commands and attributes configure and trouble shoot IP settings and how to get remote communication to the controller via the network up and running. 13.1 DAS – Dynamic Address Status 13.1.1 Overview Determines if an address has been received from the DHCP server or not. 13.1.2 Usage Attribute type: Read only When configuring an interface for dynamic IP-address (using DHCP), this parameter indicates if an IP address has been received. Format: GET DAS Reply: = 0 means no address has been received yet. = 1 means address is received (and can be read using NIC attribute). = '-' (dash) means that interface is not configured for DHCP. Example: GET DAS Reply: Common Commands and Attributes 98/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 which means that no address has yet been received from the DHCP server. Note! In order to re-request an IP-address, refer to attribute NRS. 13.2 DNS – DNS Address Configurations 13.2.1 Overview This displays and configures the DNS server(s). 13.2.2 Usage Attribute Type: Read and Write This attribute is used to read and configure the DNS servers for the controller. Note! If using DHCP for address configuration (as configured using the NIC attribute), the DNS servers are normally supplied from the DHCP server. Format on getting parameters: GET DNS Reply: ... where is the IP address to the DNS servers. Example: GET DNS Reply: 192.168.1.45 192.168.1.46 which are the IP-addresses for the two configured DNS addresses. Format on setting parameters: SET DNS [DNS 1] [DNS 2] [DNS 3] where [DNS x] are IP-addresses for the DNS servers on the format X.Y.Z.W 0 where Enabled = 0 means Ethernet interface is disabled. Enabled = 1 means Ethernet interface is enabled. Format on setting parameter: SET EEN where Enabled = 0 disables the Ethernet Interface. Enabled = 1 enables the Ethernet Interface. Example: GET EEN Reply: meaning that Ethernet Interface is disabled and that no communication can be established using Ethernet interface. Example: SET EEN 1 enables the Ethernet Interface. Note! Enabling the Ethernet interface still requires proper IP configuration in order to be able to communicate with the controller over the network. 13.4 GWY – Default Gateway 13.4.1 Overview This configures the default gateway to use for the controller. 13.4.2 Usage Attribute Type: Read and Write This attribute is used to configure the default gateway for the system. Format on getting parameters: GET GWY Reply: where is the IP address for the default gateway. Format on setting parameters: SET GWY Common Commands and Attributes 100/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 where is the IP address on the format X.Y.Z.W, where 0 replies with a textual description of the actual interface. Example: GET NID ETH0 Reply: Common Commands and Attributes 101/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 Ethernet Interface 10/100 Mbit/s describing the requested interface. Note! Attribute NIL gives a list of all available interfaces. 13.7 NIL – Network Interface List 13.7.1 Overview This attribute replies with the different interfaces supported in the controller. 13.7.2 Usage Attribute type: Read only This attribute replies with a list of supported interfaces supported in the controller. For a textual description of each of the interfaces, refer to attribute NID. Format: GET NIL Reply: .. where interfaces is the list of available interfaces. Example: GET NIL Reply: lo eth0 indicating that the controller supports a Loopback and an Ethernet interface. Note 1! What interfaces are available mainly depends on hardware version of the controller. Note 2! The GPRS interface will be added dynamically once the GPRS attach is performed successfully. 13.8 NIC – Network Interface Configuration 13.8.1 Overview This attribute displays and configures the IP settings for a certain interface. 13.8.2 Usage Attribute Type: Read and Write This attribute is used to configure IP address of a certain interface. Depending on interface type, both dynamic and static IP can be configured. Format on getting parameters: GET NIC Common Commands and Attributes 102/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 where is the network interface to read configuration for. Reply: where is DYNAMIC for interfaces using DHCP, and STATIC for interfaces using static IP-address assignment. is the IP address of the interface (0.0.0.0 if not configured or not received by DHCP) on the format X.Y.Z.W, where 0 is the net mask for the interface on the format X.Y.Z.W 0 is the broadcast address for the interface on the format X.Y.Z.W 0 DYNAMIC causing to automatically attempt to retrieve an IP address from the DHCP server. Format on setting static IP: SET NIC STATIC configuring to use the static IP address where is the on the format X.Y.Z.W, where 0 is the net mask on the format X.Y.Z.W 0 is the broadcast address for the interface on the format X.Y.Z.W 0 where is one of the supported interfaces (attribute NIL can be used to display all available interfaces). Example: ACT NRS ETH0 restarts the ethernet interface. Note 1! It is not possible to perform a restart of the loopback interface. Note 2! If interface is disabled, no restart will be performed. Note 3! If dynamic address is used, status of interface can be obtained using attribute DAS. Note 4! Refer to attribute GPRS RESTART of restarting of GPRS interface. 13.10 SSR – Supported Services 13.10.1 Overview This displays a list of supported network services in the system. 13.10.2 Usage Attribute type: Read only This attribute displays all supported network services in the system. Format: .. were is a textual description of the network service ( defined in RFC1700 ). Example: GET SSR Reply: ssh telnet indicating that network services supported are Secure Shell and Telnet. Common Commands and Attributes 104/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 In order to configure the use of the services, refer to attribute SRV. 13.11 SRV – Service Configurations 13.11.1 Overview This reads and configures usage of network services in the system. 13.11.2 Usage This attribute can be used to enable or disable the different network service in the controller, and also to change port numbers. Format on getting service configurations: GET SRV where is the network service to display configuration for. Reply: where is 0 if this service is disabled, and 1 if service is enabled. is the port that this service is listening on. Format on setting / configuring service: SET SRV where is the service to reconfigure (must be one of the services as displayed using attribute SSR). is 0 if this service should be disabled, and 1 if service should be enabled. is the port that this service should be listening on. Example on getting parameter: GET SRV SSH Reply: 0 22 indicating that the service is disabled, and that if it was enabled should listen on port 22 (which is the standard SSH port). Example on setting parameter: SET SRV TELNET 1 16455 enables the telnet service but reconfigures it to listen on port 16455. Note 1! In order for the system to work with the Axell Element Manager, the telnet service must be enabled (but not necessarily on default port 23). Note 2! Port numbers 10 000 and 10 001 are used by internal systems in the controller, why they cannot be used for network services. Note 3! If performing these configurations remotely, connection might be lost when applying changes to the system. Common Commands and Attributes 105/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 13.12 IFCONFIG 13.12.1 Overview Displays an overview of configured network interfaces. 13.12.2 Usage This command gives an overview of configured interface(s), and can be used for advanced IP trouble shooting. Format: ifconfig [interface] where the optional [interface] is one of the network interfaces in the system. If no parameter is supplied, all interfaces are printed. Example: AVITEC AB> ifconfig eth0 eth0 Link encap:Ethernet HWaddr 00:14:B1:01:03:E5 inet addr:126.1.24.131 Bcast:126.255.255.255 Mask:255.255.255.0 UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1 RX packets:61833 errors:0 dropped:0 overruns:0 frame:0 TX packets:15743 errors:0 dropped:0 overruns:0 carrier:0 collisions:0 txqueuelen:100 RX bytes:0 (0.0 B) TX bytes:0 (0.0 B) Interrupt:24 Base address:0xc000 AVITEC AB> 13.13 PING 13.13.1 Overview Tool to verify that communications path to remote peer is operational. 13.13.2 Usage This command is used to ping (send an ICMP packet) to other addresses, and can be used during connection troubleshooting. For example, successfully pinging the configured IP address of the Axell Element Manager is a good way of knowing that communication between controller and AEM is set up correctly, and that the AEM hardware is up and running. Format: ping [-c Count] where is either the IP address or the host name to ping. The optional parameter -c can be used to provide number of pings. Note! If parameter -c is not provided, ping will proceed until Ctrl-C is pressed. Example: AVITEC AB> ping -c 5 192.168.1.42 Pinging 192.168.1.42 5 times. Press to abort. PING 192.168.1.42 (192.168.1.42): 56 data bytes 64 bytes from 192.168.1.42: icmp_seq=0 ttl=64 time=1.4 64 bytes from 192.168.1.42: icmp_seq=1 ttl=64 time=0.9 64 bytes from 192.168.1.42: icmp_seq=2 ttl=64 time=0.9 64 bytes from 192.168.1.42: icmp_seq=3 ttl=64 time=0.9 64 bytes from 192.168.1.42: icmp_seq=4 ttl=64 time=0.8 --- 192.168.1.42 ping statistics --- Common Commands and Attributes ms ms ms ms ms 106/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 10 packets transmitted, 10 packets received, 0% packet loss round-trip min/avg/max = 0.7/0.8/1.4 ms AVITEC AB> 13.14 TRACEROUTE 13.14.1 Overview Tool to trouble shoot connection problems with remote peers. 13.14.2 Usage This command can be used for troubleshooting when there is a problem establishing a connection between the controller and the Axell Element Manager. By running a traceroute it is possible to see where communications link is broken. Format: traceroute where is either the IP address or the host name to run a trace to. Note! Trace can be aborted by pressing . 13.15 NETWORK 13.15.1 Overview Command to get an overview of network settings. 13.15.2 Usage This command displays an overview of network configurations in the system. Format: network displays miscellaneous information related to the network configurations. 14 GPRS CONFIGURATIONS 14.1 GPR – GPRS attribute This attribute is used to configure all parameters in the GPRS functionality. 14.1.1 GPR AAD – Authorization address 14.1.1.1 Overview This lists the IP-addresses that are acceptable for the clients named in the ACL parameter. Common Commands and Attributes 107/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 14.1.1.2 Usage Attribute Type: Read / Write The addresses may be given in dotted quad notation or as hostnames that are looked up with the resolver. Usage for setting parameter: SET GPR AAD [ ... ] This will sett the acceptable address list to the addresses indicated. To allow ANY address use an asterisk instead “*”. Example: SET GPR AAD 126.1.24.1 126.1.24.2 Sets the accebable addresses to 126.1.24.1 and 126.1.24.2. Usage for getting parameter : GET GPR AAD Reply: 126.1.24.1 126.1.24.2 Indicating the acceptable addresses set. 14.1.2 GPR ACL – Authorization Client 14.1.2.1 Overview Controls the client authorization parameter. 14.1.2.2 Usage Attribute Type: Read / Write This should be the name of the controller if it is used. In most cases an asterisk “*” is used to indicate that ANY name is acceptable. Setting this to the wrong name will make the authentication process to fail. This name is only used in the CHAP/PAP negotiation process. If authorization method is set to None it does not matter. Usage for setting parameter: SET GPR ACL This will set as the client name for the CHAP/PAP negotiation Example: SET GPR ACL voyager.local.system Sets the client name to voyage.local.system. Usage for getting parameter: GET GPR ACL Reply: Indicating that ANY name should be acceptable. Common Commands and Attributes 108/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 14.1.3 GPR APN – Access Point Name 14.1.3.1 Overview Sets the Access Point Name to attach to when negotiating a GPRS attach. 14.1.3.2 Usage Attribute Type: Read / Write. IMPORTANT: This parameter is different from network to network and operator to operator. Make sure this string is correct, otherwise the GPRS modem will not attach to the network properly! This information should be given by the operator of the network. Format on setting parameter: SET GPR APN Where should be the APN (Access Point Name) given by the network operator to get a GPRS attach properly. Example: SET GPR APN internet.provider.com This will set the APN to “internet.provider.com”. Format in getting parameter: GET GPR APN Reply: Where is the currently configured Access Point Name. Example: GET GPR APN Reply: network.bbdb.com Indicating that the current APN is set to “network.bbdb.com”. 14.1.4 GPR APPLY – Apply changes made to the GPRS configurations 14.1.4.1 Overview Used to apply changes made to the GPRS configurations. 14.1.4.2 Usage Attribute Type: Action When configuring the GPRS interface, lots of changes normally needs to be made at the same time without having to restart the GPRS interface for every configuration. Common Commands and Attributes 109/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 Running command ACT GPR APPPLY means that all changes are stored to the system and that they will be used with the next GPRS detach/attach cycle 14.1.5 GPR ASC – Authorisation Secret 14.1.5.1 Overview Sets the “secret” for negotiating CHAP/PAP authentication. 14.1.5.2 Usage Attribute Type: Read -Only This sets the authorization “secret” for negotiating a PAP or CHAP authentication with the server. This is also known as “password” or “passphrase”. To set a blank secret use a dash “-” instead of the secret. Format on setting parameter: SET GPR ASC Where is the secret enclosed in quotes if it is more than one word. Example: SET GPR ASC secret Sets the PAP/CHAP secret to the word “secret”. Example: SET GPR ASC “another day in paradise” Sets the PAP/CHAP secret to the phrase “another day in paradise”. Format on getting parameter: GET GPR ASC Reply: The command replies with 10 '*' if a passphrase is set and a '-' if no passphrase is set. Example: GET GPR ASC Reply: ********** meaning that passphrase is configured in the controller. 14.1.6 GPR ASV – Authorization server 14.1.6.1 Overview Controls the server authorization parameter. Common Commands and Attributes 110/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 14.1.6.2 Usage Attribute Type: Read / Write This should be the name of the server to authenticate with if it is used. In most cases an asterisk “*” is used to indicate that ANY name is acceptable. Setting this to the wrong name will make the authentication process to fail. This name is only used in the CHAP/PAP negotiation process. If authorization method is set to None it does not matter. Usage for setting parameter: SET GPR ASV This will set as the client name for the CHAP/PAP negotiation Example: SET GPR ASV voyager.local.system Sets the client name to voyage.local.system. Usage for getting parameter: GET GPR ASV Reply: Indicating that ANY name should be acceptable. 14.1.7 GPR ATH – Authentication method 14.1.7.1 Overview Sets the GPRS authentication method to be used. 14.1.7.2 Usage Attribute type: Read / Write This attribute is used to set the authentication method used to authenticate the PPP/LCP connection with the server. There are three possible settings for this attribute, none, PAP and CHAP. They are represented by a single letter (N, P, C) describing the authentication method. Usage for setting parameter SET GPR ATH Where can be one of the following: N: None, no authentication method will be used when negotiating a PPP connection with the server. P: PAP authentication mechanism will be used when negotiating a PPP connection with the server. C: CHAP authentication mechanism will be used when negotiating a PPP connection. This is probably the default setting that most networks will use today. Example: Common Commands and Attributes 111/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 SET GPR ATH C Sets the authentication method to CHAP. Usage for getting parameter: GET GPR ATH Reply: Where is either N, P or C. N means no authentication method will be used, C indicated CHAP authentication will be used and P indicates PAP authentication method should be used. Example: GET GPR ATH Reply: Indicating that CHAP is the method to be used when negotiating a PPP connection with the peer server. 14.1.8 GPR CHANGES – Changes made in GPRS configuration 14.1.8.1 Overview Indication if there are parameters changed in the GPRS configurations 14.1.8.2 Usage Attribute Type: Read-only This parameter indicates if there has been changes made to the GPRS interface that requires the parameters to be applied and interface to be restarted Format: where = 0 means that no changes made and = 1 means that changes are made to the GPRS configuration and that ACT GPR APPLY and ACT GPR RESTART should be performed to get the new parameters operational. Example: GET GPR CHANGES Reply: indicating that changes have been made to the GPRS configuration and that they need to be applied and GPRS interface to be restarted. Note! This will be cleared by the ACT GPR APPLY command, but some changes might require a restart of the connection why it is recommended to perform the restart after each ACT GPR APPLY. Common Commands and Attributes 112/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 14.1.9 GPR CPI – CHAP Interval 14.1.9.1 Overview Set the CHAP interval timer. 14.1.9.2 Usage Attribute type: Read / Write. This attribute is used to set a timer that can be used to force a re-negotiation of the CHAP authentication every seconds. This is used for two reasons, if there is not traffic the GPRS can be detached so it serves as a keep-alive function. It also checks that the connection is actually valid and working. If the negotiation fails for whatever reason the PPP is dropped. If the GPRS functionality is started as “PERSISTENT” it will then restart and attempt to re-negotiate the whole PPP link with the server. A good starting point for this parameter is to set it somewhere between 1-3 minutes (60-180 seconds). Usage for setting parameter: SET GPR CPI Where should be in the interval of 10-300 seconds. Example: SET GPR CPI 90 Sets the CHAP renegotiation interval to 90 seconds. Usage for getting parameter : GET GPR CPI Reply: 90 Indicating that the interval has been set to 90 seconds previously. Example: GET GPR CPI Reply: 90 14.1.10 GPR CTY – GPRS connection type 14.1.10.1 Overview Sets the connection type of GPRS to either PPP or IP. 14.1.10.2 Usage Attribute Type: Read / Write. The link to the GPRS network can use different type of protcols. Normally the Common Commands and Attributes 113/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 protocol used is “IP” but in rare cases it may be necessary to change this to “PPP” in order to connect. This information should be given by the network operator. Format on setting the parameter: SET GPR CTY Where can be one of either IP or PPP determining the connection type. Default is IP which should work in most networks. Example: SET GPR CTY IP Sets the connection type to “IP”. Format on getting parameter: GET GPR CTY Reply: Where format may be either PPP or IP in the reply. Example: GET GPR CTY Reply: PPP Indicating that the current method of communicating is PPP. 14.1.11 GPR EXF – GPRS extra flags 14.1.11.1 Overview This sets any extra flags for the GPRS negotiations. 14.1.11.2 Usage Attribute Type: Read / Write. If you need this please contact Axell Wireless for more information on the various flags that can be used. Usage for setting parameter : SET GPR EXF [“ ... ”] where and so on are the various flags. Example: SET GPR EXF noauth Which will set set use no authorization with the peer when connecting (CHAP/PAP disabled). Usage for getting parameter : GET GPR EXF Reply: Returns any flags set or blank if there are none. Common Commands and Attributes 114/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 Example: GET GPR EXF Reply: noauth Meaning that the noauth flag has been set. 14.1.12 GPR MDS – GPRS modem dial string 14.1.12.1 Overview Sets / displays the current modem dial string for GPRS attach. 14.1.12.2 Usage Attribute Type: Read / Write. This attribute sets the dialstring used to attach to the GPRS network with the proper PDP context. This should normally not have to be changed. It is by default set to “ATDT*99***1#” which indicated PDP Context #1 which is always the context used by this controller. Do not change the profile number 1 to something else unless you know exactly what you are doing. Format on setting parameter: SET GPR MDS Where is the new string replacing the old one. Example: SET GPR MDS ATDT*99# Will set the dial string to the “short form” of attaching with the default profile. Normally the dialstring should be “ATDT*99***1#” to indicate the we are using profile number 1. Format on getting parameter: GET GPR MDS Reply: ATDT*99***1# Meaning that the dial string is set to “*99***1#” currently. 14.1.13 GPR MDT – Modem timeout 14.1.13.1 Overview This set the communication timeout with the modem. 14.1.13.2 Usage Attribute type: Read / Write Common Commands and Attributes 115/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 This attribute handles the communication timeout with the modem. It is not the connection timeout with the network but the time allowed for the modem to respond to an settings command. Normally this is set to 10 seconds which should be fine for most environments. Format on setting parameter: SET GPR MDT Where range from 5-30 seconds. Example: SET GPR MDT 15 This will sett the timeout to 15 seconds. Format on getting parameter: GET GPR MDT Reply: Where the is the current modem timeout setting. Example: GET GPR MDT Reply: 15 Meaning the current timeout is set to 15 seconds. 14.1.14 GPR MRU – Maximum Receive Unit 14.1.14.1 Overview Configures maximum receive unit for the GPRS interface. 14.1.14.2 Usage Attribute Type: Read/Write The maximum receive unit is a part of the configuration that determines largest data packet that can be sent over the GPRS interface before defragmentation is required. In certain cases this can be used to optimize communications interface speeds. Providing value zero normally works, but some networks might require some tweaking. Recommended values for the various communication types are GPRS over GSM/GMSK: 576 GPRS over GSM/EDGE: 1476 GPRS over UMTS/WCDMA: 1500 Format on getting parameter: where is the maximum receive unit, >= 0. Common Commands and Attributes 116/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 Example: GET GPR MRU Reply: 576 indicates that default value is used. Format on setting parameter: SET GPR MRU Example: SET MRU 0 changes Maximum Transmission Unit to 0. 14.1.15 GPR MTU – Maximum Transmission Unit 14.1.15.1 Overview Configures maximum transmission unit for the GPRS interface. 14.1.15.2 Usage Attribute Type: Read/Write The maximum transmission unit is a part of the configuration that determines largest data packet that can be sent over the GPRS interface before defragmentation is required. In certain cases this can be used to optimize communications interface speeds. Providing value zero normally works, but some networks might require some tweaking. Recommended values for the various communication types are GPRS over GSM/GMSK: 576 GPRS over GSM/EDGE: 1476 GPRS over UMTS/WCDMA: 1500 Format on getting parameter: where is the maximum transmission unit, >= 0. Example: GET GPR MTU Reply: indicates that default value is used. Format on setting parameter: SET GPR MTU Example: SET MTU 1500 changes Maximum Transmission Unit to 1500. Common Commands and Attributes 117/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 14.1.16 GPR PTR – Persistence timer 14.1.16.1 Overview Sets the timer on how often the system should check for a GPRS interface. 14.1.16.2 Usage Attribute Type: Read / Write This timer sets the time how often the system should check that the network is enabled and operational. Valid values are between 5 seconds to 600 seconds. Format on setting parameter: SET GPR PTR Where is 5 to 600 indicating the check timer interval in seconds. Example: SET GPR PTR 90 Sets the timer to 90 seconds (1½ minute) intervals. Format on getting parameter: GET GPR PTR Reply: Where time is the current time of the interval to check for the existence of a GPRS interface. Example: GET GPR PTR Reply: 35 Indicating that the system should check for an existing interface every 35 seconds. 14.1.17 GPR RTE – Default route enable 14.1.17.1 Overview This tells the system to use network default route to GPRS or not. 14.1.17.2 Usage Attribute Type: Read / Write. Format on setting parameter: SET GPR RTE Where is 1 to enable default route through this interface and 0 is to disable the default route through this interface. Common Commands and Attributes 118/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 Example: SET GPR RTE 1 This will enable default route through the interface as soon as it is connected to the GPRS network. Format on getting parameter : GET GPR RTE Reply: Where is either 1 for default route enable or 0 for no default route through this interface. 14.1.18 GPR STATUS – Reports status of GPRS interface 14.1.18.1 Overview Indication if GPRS interface is operational. 14.1.18.2 Usage Attribute Type: Read-only This attribute is used to see if the GPRS interface is operational and that the GPRS attach has been successfully made. Format: where = 0 means GPRS is not up and running and = 1 that GPRS is operational. Example: GET GPR STATUS Reply: meaning that GPRS interface is not operational. Note! If interface is configured and supposed to work, the system will poll the status every 15 seconds and then try to reattach again. 14.1.19 GPR RESTART – Restart GPRS 14.1.19.1 Overview Restarts the GPRS interface. 14.1.19.2 Usage Attribute Type: Action When changing parameters to the GPRS configuration, the GPRS interface normally Common Commands and Attributes 119/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 have to be restarted for the parameters to take effect. Running the command ACT GPR RESTART will cause a GPRS detach followed by a GPRS attach session. 14.2 GPRS – Handle GPRS functionality 14.2.1 Overview Commands to alter the GPRS interface. 14.2.2 Usage 14.2.2.1 GPRS CONFIGURE – GPRS Configurations Wizard The GPRS CONFIGURE simplifies the GPRS configuration by providing a simple text based wizard. The configrations dialog is issued by entering command GPRS CONFIGURE which will guide through the configuratioins process. Once the configuration is completed, the settings are stored and will be activated on next GPRS attachs. Note 1! All parameters can configured with the GPR attributes, but this guide simplifies the setup. Note 2! In order to perform a new attach to the GPRS network, please refer to attribute ACT GPR RESET. 14.2.2.2 GPRS DOWN – Perform a GPRS detatch Will perform a temporary detach from the GPRS network. The GPRS interface will be brought up again when the modem processing daemon performs a new modem check, which normally happens within one minute. Format: GPRS DOWN This will initiate the GPRS detach procedure. 14.2.2.3 GPRS UP – Perform a GPRS attach This will perform an attach to the GPRS network with the settings currently configured. Format: GPRS UP brings up the interface. In order to read out GPRS status, please refer to attribute GPR STATUS. Common Commands and Attributes 120/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 14.2.2.4 GPRS APPLY – Apply changes made to GPRS settings When configuring GPRS parameters using attribute GPR, these parameters are stored in the system. However, in order to make them permanent, they need to be applied, meaning that the parameters will be used in the next GPRS attach procedure. Format: GPRS APPLY applies the currently changed parameters. Note 1! In order to determine if there are parameters that needs to be applied refer to attribute GPR CHANGES. Note 2! This functionality is also available by executing ACT GPR APPLY. Note 3! In order to perform a GPRS detach/attach procedure to run the new parameters, refer to attribute ACT GPR RESTART. 14.3 TRACE GPRSDEBUG – Debug GPRS attach 14.3.1 Overview Command used to perform advanced debugging of the GPRS attach procedure. 14.3.2 Usage If problems arise when attempting to get the GPRS attach to work properly, it is possible to reconfigure the interface to provide debug output on the PPP connection setup between the controller and the GPRS network. In order to enable the debugging, add the parameter DEBUG to the GPR EXF attributes, apply changes using ACT GPR APPLY and then restart the GPRS attach procedure using ACT GPR RESTART. After this, issuing the command TRACE GPRSDEBUG will provide detailed information about progress of the GPRS attach procedure. Note! Once debugging is completed, make sure to disable debugging. Leaving debugging enabled can cause the system to fill up with files and to slow down. Run GPRS CONFIGURE or reconfigure using attribute GPR EXF, remove debug flag and perform ACT GPR RESTART 15 FIRMWARE UPGRADE 15.1 Overview From Common firmware version 1.2.0 of the controller, it is possible to upload and Common Commands and Attributes 121/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 install firmware into the controller using normal terminal emulation programs and Z-modems protocols. Axell Firmware Upload files have the file extension .arf2, and the name should normally reveal upgrade information such as OMU-1.0.1_to_OMU-1.0.2.arf2 The firmware package itself contains all information on version compatibilities, meaning that it is not possible to install firmware unless criterias on current software versions and available memory in the controllers are met. Normally, the firmware upgrade consists of uploading the firmware using Z-modem, and then issue an installation of the firmware. The installer reads through the packet and calculates the checksums to ensure that the uploaded packet is valid for installation. It also checks a number of prerequisites prior to installing the firmware, such as correct System, Common and Target firmwares version for this upgrade packet and enough space to install the packet. Once the installation procedure is started, the system will reboot after completing the installation procedure, successful or unsuccessful. Once booting up again, the new controller will if firmware upgrade was successful be executed, and a FWU (Firmware Upgraded) alarm posted to the Axell Element Manager containing information about the new firmware version. If firmware upgrade failed, a FWF (Firmware Upgrade Failure) alarm is posted to the Axell Element Manager informing about the upgrade failure. 15.2 Upgrade Procedure The firmware upgrade procedure consists of a few different steps 1. Log in to the controller using any terminal emulation program supporting Zmodem such as HyperTerminal for Windows or minicom for Unix/Linux/OS X. 2. Initiate firmware upload by issuing the command firmware upload and then start the file transmission from the terminal emulation program. HyperTerminal: Menu item Transfer->Send file, browse to correct arf2 file. MiniCom: File transfer dialog normally is brought up automatically. 3. Once file is uploaded correctly, switch to System Administrator mode using command sysadmin and provide the sysadmin password. 4. Enter firmware list to get a list of all uploaded packages. 5. Issue installation of desired packet by issuing firmware install such as firmware install OMU-1.0.1_to_OMU-1.0.2.arf2 Common Commands and Attributes 122/123 Document Name: Common Commands and Attributes v1.3.0 Revision: 1.2 6. Wait for installation procedure to complete. After this the controller will reboot and start executing the new firmware. Firmware upgrade completed. 15.3 Upgrading Fibre Optic Repeaters In order to perform a firmware upgrade to a fibre optic repeater over the fibre, a direct access to the node has to be performed. This is done by issuing the command ACCSS NODE which will establish a transparent channel to the node. Log in to the controller as usual and perform the standard firmware upload / firmware install procedure as described in previous chapter. Please refer to ACCESS NODE command for details on the direct access over fibre. 15.4 Firmware Command Reference The following firmware command options are available firmware - replies with current firmware version. firmware help – prints help text on the screen. firmware cleanup – performs cleanup of the system, removes old packages and log files. This command can be issued if the installer informs that there is not enough memory to install file. change - change versions of common and/or target from current to older or to new version. Fallback functionality. Note! This functionality is only for testing purposes and might severely destroy the entire system. delete - removes a specific upgrade package. This command is to be used if a package was not possible to install due to checksum errors in the package. upload - starts a Z-Modem transfer in order to facilitate uploading of a new firmware to the controller using any type of terminal software such as Microsoft Windows Hyper Terminal. status - displays status of controller resources available for firmware upgrade such as application and system free flash memory and free RAM. list - displays uploaded firmware packages currently available for installation. verify - validates that this is a firmware that can be installed. Note! This will also be performed prior to performing an installation. It is not possible to install an invalid/broken firmware packet. version - displays current firmware version (running version). install - installs the firmware pointed to by on the target. Install also verifies the packet so it is not necessary to run both verify and install in the same session. Common Commands and Attributes 123/123 Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 Axell Wireless OMU Commands and Attributes Document Revision: 1.0 Firmware Version: OMU 1.0.0 Document Release Date: 2007-10-23 Note! Avitec and AFL have merged to form the new company Axell Wireless. In this manual the name Avitec still appears in prompts etc. 1(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 REVISION LOG Revision Date 1.0 07-10-23 Author MW Description First release. Copyright © 2008 Axell Wireless All rights reserved. No part of this document may be copied, distributed, transmitted, transcribed, stored in a retrieval system, or translated into any human or computer language without the prior written permission of Axell Wireless. The manufacturer has made every effort to ensure that the instructions contained in the documents are adequate and free of errors and omissions. The manufacturer will, if necessary, explain issues which may not be covered by the documents. The manufacturer's liability for any errors in the documents is limited to the correction of errors and the aforementioned advisory services. This document has been prepared to be used by professional and properly trained personnel, and the customer assumes full responsibility when using them. The manufacturer welcomes customer comments as part of the process of continual development and improvement of the documentation in the best way possible from the user's viewpoint. Please submit your comments to the nearest Axell Wireless sales representative. 2(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 INDEX 1OVERVIEW......................................................................................................................................................................7 2VERSION COMPATIBILITY........................................................................................................................................7 3USING COMMANDS AND ATTRIBUTES..................................................................................................................7 4BUILT IN HELP SYSTEM............................................................................................................................................. 8 4.1HELP command.................................................................................................................................................... 8 4.2INF command........................................................................................................................................................ 8 5OMU COMMANDS.........................................................................................................................................................9 5.1.1Overview.............................................................................................................................................................. 9 5.1.2Usage....................................................................................................................................................................9 5.2STATUS............................................................................................................................................................... 10 6ALARM CONFIGURATIONS..................................................................................................................................... 11 6.1AC2 – Compressed Alarm Severity and Alarm Class Configurations...........................................................11 6.1.1Usage..................................................................................................................................................................11 6.2AL4 - Compressed Alarm Format ................................................................................................................... 11 6.2.1Usage..................................................................................................................................................................11 6.3AL5 - Compressed Alarm Format ................................................................................................................... 11 6.3.1Usage..................................................................................................................................................................11 6.4AL6 - Compressed Alarm Format ................................................................................................................... 11 6.4.1Usage..................................................................................................................................................................11 6.5 ALL - Compact Message Status Parameters in Optical Master Unit........................................................... 12 6.5.1 Usage.................................................................................................................................................................12 6.6BAT – Status of battery charge......................................................................................................................... 12 6.6.1Usage..................................................................................................................................................................12 6.7COM – Status of Communication with Active Devices................................................................................... 12 6.7.1Usage..................................................................................................................................................................12 6.8CRC – Status of EEPROM CRC.......................................................................................................................13 6.8.1Usage..................................................................................................................................................................13 6.9PW1 - Status of Power Supply 1........................................................................................................................14 6.9.1Usage..................................................................................................................................................................14 6.10PW2 - Status of Power Supply 2......................................................................................................................14 6.10.1Usage................................................................................................................................................................14 6.11PW3 - Status of Power Supply 3......................................................................................................................15 6.11.1Usage................................................................................................................................................................15 6.12PW4 - Status of Power Supply 4......................................................................................................................16 6.12.1Usage................................................................................................................................................................16 6.13RBT – Status of Radio Board Temperatures................................................................................................. 16 6.13.1Usage................................................................................................................................................................16 6.14RSP – Optical Master Unit Status Parameters.............................................................................................. 17 6.14.1Usage................................................................................................................................................................17 6.15RXO – Status of Received Optical Level........................................................................................................ 19 6.15.1Usage................................................................................................................................................................19 6.16SZP – Status of Pilot Tone Generator Synthesizer........................................................................................ 19 6.16.1Usage................................................................................................................................................................19 6.17TEM – Status of Controller Temperature...................................................................................................... 20 6.17.1Usage................................................................................................................................................................20 6.18TXO – Status of Transmitted Optical Level...................................................................................................20 3(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 6.18.1Usage................................................................................................................................................................20 7OPTO INTERFACE CONFIGURATIONS................................................................................................................ 21 7.1OLA – Optical Loss Adjustment ...................................................................................................................... 21 7.1.1Usage..................................................................................................................................................................21 7.2OLC – Optical Loss Compensation................................................................................................................... 22 7.2.1Usage..................................................................................................................................................................22 7.3OLV – Optical Level........................................................................................................................................... 22 7.3.1Usage..................................................................................................................................................................22 7.4OMP – Opto Master Parameters.......................................................................................................................23 7.4.1Usage..................................................................................................................................................................23 7.5PTL – Pilot Tone Level....................................................................................................................................... 23 7.5.1Usage..................................................................................................................................................................23 7.6PTN – Pilot Tone Nominal Level....................................................................................................................... 24 7.6.1Usage..................................................................................................................................................................24 8RF-RELATED CONFIGURATIONS.......................................................................................................................... 24 8.1ATD – Attenuation Downlink............................................................................................................................ 24 8.1.1Usage..................................................................................................................................................................24 8.2ATU – Attenuation Uplink................................................................................................................................. 25 8.2.1Usage..................................................................................................................................................................25 8.3ILD – Status of Input Level Downlink.............................................................................................................. 25 8.3.1Usage..................................................................................................................................................................25 8.4ILV – Input Levels Downlink.............................................................................................................................26 8.4.1Usage..................................................................................................................................................................26 8.5RFC – Radio Frequency Parameters for Combiner ....................................................................................... 26 8.5.1Usage..................................................................................................................................................................26 8.6RFS – Radio Frequency Parameters for Splitter ............................................................................................ 27 8.6.1Usage..................................................................................................................................................................27 9TEMPERATURE AND POWER SUPPLY LEVELS ............................................................................................... 27 9.1PLV – Power Supply Levels...............................................................................................................................27 9.1.1Usage..................................................................................................................................................................27 9.2TEL – Temperature Levels................................................................................................................................ 28 9.2.1Usage..................................................................................................................................................................28 10DATA COMMUNICATION SETTINGS.................................................................................................................. 28 10.1NCP – Node Communications Path.................................................................................................................28 10.1.1Usage................................................................................................................................................................29 10.2OCP – Opto Communication Path Configurations....................................................................................... 29 10.2.1Usage................................................................................................................................................................29 10.3RCP - Rack Communications Path Configuration........................................................................................ 30 10.3.1Usage................................................................................................................................................................30 11ALARM ATTRIBUTE THRESHOLDS.................................................................................................................... 31 11.1BAT – Battery Level......................................................................................................................................... 31 11.1.1Description....................................................................................................................................................... 31 11.1.2Threshold Usage.............................................................................................................................................. 31 11.1.3Time................................................................................................................................................................. 31 11.1.4Upper................................................................................................................................................................31 11.1.5Lower............................................................................................................................................................... 31 11.2COM – Communications with Active Devices................................................................................................31 11.2.1Description....................................................................................................................................................... 31 11.2.2Threshold Usage.............................................................................................................................................. 31 4(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 11.2.3Time................................................................................................................................................................. 31 11.2.4Upper................................................................................................................................................................31 11.2.5Lower............................................................................................................................................................... 32 11.3CRC – EEPROM CRC Check in Active Devices...........................................................................................32 11.3.1Description....................................................................................................................................................... 32 11.3.2Threshold Usage.............................................................................................................................................. 32 11.3.3Time................................................................................................................................................................. 32 11.3.4Upper................................................................................................................................................................32 11.3.5Lower............................................................................................................................................................... 32 11.4ILD – Input Signal Level Downlink................................................................................................................ 32 11.4.1Description....................................................................................................................................................... 32 11.4.2Threshold Usage.............................................................................................................................................. 32 11.4.3Time................................................................................................................................................................. 32 11.4.4Upper................................................................................................................................................................32 11.4.5Lower............................................................................................................................................................... 32 11.5NCO – Node Communications Status............................................................................................................. 33 11.5.1Description....................................................................................................................................................... 33 11.5.2Threshold Usage.............................................................................................................................................. 33 11.5.3Time................................................................................................................................................................. 33 11.5.4Upper................................................................................................................................................................33 11.5.5Lower............................................................................................................................................................... 33 11.6PW1 – Power Supply 1..................................................................................................................................... 33 11.6.1Description....................................................................................................................................................... 33 11.6.2Threshold Usage.............................................................................................................................................. 33 11.6.3Time ................................................................................................................................................................ 33 11.6.4Upper ...............................................................................................................................................................33 11.6.5Lower............................................................................................................................................................... 33 11.7 PW2 – Power Supply 2.................................................................................................................................... 33 11.7.1Description....................................................................................................................................................... 33 11.7.2Threshold Usage.............................................................................................................................................. 34 11.7.3Time ................................................................................................................................................................ 34 11.7.4Upper ...............................................................................................................................................................34 11.7.5Lower............................................................................................................................................................... 34 11.8PW3 – Power Supply 3..................................................................................................................................... 34 11.8.1Description....................................................................................................................................................... 34 11.8.2Threshold Usage.............................................................................................................................................. 34 11.8.3Time ................................................................................................................................................................ 34 11.8.4Upper ...............................................................................................................................................................34 11.8.5Lower............................................................................................................................................................... 34 11.9PW4 – Power Supply 4..................................................................................................................................... 34 11.9.1Description....................................................................................................................................................... 34 11.9.2Threshold Usage.............................................................................................................................................. 34 11.9.3Time ................................................................................................................................................................ 35 11.9.4Upper ...............................................................................................................................................................35 11.9.5Lower............................................................................................................................................................... 35 11.10RBT – Radio Board Temperature................................................................................................................. 35 11.10.1Description..................................................................................................................................................... 35 11.10.2Threshold Usage............................................................................................................................................ 35 11.10.3Time............................................................................................................................................................... 35 11.10.4Upper..............................................................................................................................................................35 11.10.5Lower............................................................................................................................................................. 35 11.11RXO - Recieved Optical Level....................................................................................................................... 35 11.11.1Description..................................................................................................................................................... 35 11.11.2Threshold Usage............................................................................................................................................ 35 11.11.3Time .............................................................................................................................................................. 35 11.11.4Upper .............................................................................................................................................................36 11.11.5Lower............................................................................................................................................................. 36 5(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 11.12SZP – Synthesizer Pilot Tone Generator...................................................................................................... 36 11.12.1Description..................................................................................................................................................... 36 11.12.2Threshold Usage............................................................................................................................................ 36 11.12.3Time............................................................................................................................................................... 36 11.12.4Upper..............................................................................................................................................................36 11.12.5Lower............................................................................................................................................................. 36 11.13TEM – Controller Temperature.................................................................................................................... 36 11.13.1Description..................................................................................................................................................... 36 11.13.2Threshold Usage............................................................................................................................................ 36 11.13.3Time .............................................................................................................................................................. 36 11.13.4Upper .............................................................................................................................................................36 11.13.5Lower............................................................................................................................................................. 37 11.14TXO – Transmitted Optical Level.................................................................................................................37 11.14.1Description..................................................................................................................................................... 37 11.14.2Threshold Usage............................................................................................................................................ 37 11.14.3Time............................................................................................................................................................... 37 11.14.4Upper..............................................................................................................................................................37 11.14.5Lower............................................................................................................................................................. 37 12HEARTBEAT FORMAT............................................................................................................................................ 38 6(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 OVERVIEW All Axell Wireless network elements* equipped with a controller contains a Local Maintenance Terminal (LMT) port, and optionally a modem. This allows for configuration of the element locally and optionally remotely. Using a terminal emulation software, such as HyperTerminal (Windows) or MiniCom (Linux/Unix) it is possible to configure the equipment using a simple command structure (terminal emulation should be set to VT100 or ANSI). Axell Wireless Repeater Command and Attributes documentation consists of two parts; – the Common part defines all functionality available for all Axell Wireless repeaters with the new generation of controllers (H40 and H50 series). – the Target part defines all commands and attributes available for the specific repeater type in a separate document. This document specifies the functionality for all commands and attributes available in the OMU target implementation. * Network elements are for instance repeaters, Optical Master Units, etc. VERSION COMPATIBILITY Commands and attributes described in this document refers to Optical Master Units with Target firmware version OMU 1.0.0. Firmware version of the controller can be obtained (once logged in) by using the attribute SWV. USING COMMANDS AND ATTRIBUTES When logged in to the repeater, a number of different commands and attributes are available. Commands have interaction with the user, or displays the reply on multiple rows, while attributes are worked on using GET, SET or ACT syntax which gives a reply normally on a maximum of one row. Read-only attributes are read using GET. Example: AVITEC AB> GET MDL BSF424-S AVITEC AB> Read and write attributes are either read or written Example: AVITEC AB> GET TAG Repeater Name: Earl AVITEC AB> SET TAG Site at Sundbyberg Centrum AVITEC AB> GET TAG Site at Sundbyberg Centrum AVITEC AB> Actions are used to perform actions. Example: AVITEC AB> ACT RCD AVITEC AB> which resets the communications device/modem. 7(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 BUILT IN HELP SYSTEM 4.1 HELP command By entering the command HELP a list of all attributes and their modes of operation are displayed in alphabetic order. Three different columns are displayed. First column is the actual attribute. Second column displays valid attribute access methods. r – this means attribute can be GET w – this means attribute can be SET x – means attribute can be worked on with ACT (action). Each row ends with a brief description of the attribute. Example: AVITEC AB>help AC1 r Displays alarm severity and class for a number of alarm sources. AC2 r Displays alarm severity and class for a number of alarm sources. ACK x Acknowledges alarm log entries. ACL rw Displays and changes default alarm classes. ADC r Returns number of active devices in the system. ADD rw Configures SMS access list to communicate with the repeater. AGC r This displays status of the AGC in uplink and downlink. AL1 r Displays alarm configurations for EX1, EX2, EX3, EX4 and DOO. AL2 r Displays alarm configurations for VLI, LGO, CLR, FWU and FWF. AL3 r Displays alarm configurations for UAD, UDE, UPM, UDM and UPW. AL4 r Retrieving alarm configurations for AMU, AMD, SZU, SZD, COM and TEM. AL5 r Retrieving alarm configurations for OTM, PW1, PSU, WRM and CFC. ALA rw Used for reconfiguration of the alarm settings / thresholds. ALL r Replies with the same information as in the heartbeat sent to the AEM. ... 4.2 INF command The INF attribute gives detailed information about a specific attribute (similar to information in this document). Example: AVITEC AB> INF DOO This read-only attribute displays the status of the door, 0=OK, 1=ERROR. Reply format: X=0 means status is OK X=1 means status is ERROR X=- (dash) means status is indeterminable, or alarm source is not measured. Example: GET DOO Replies: meaning status is OK. 8(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 OMU COMMANDS 5.1.1 Overview NODEPNP command is used to automatically identify new nodes in the network. 5.1.2 Usage The OMU communicates with slave repeaters over the optical fibers, and all communication is master/slave based where the OMU is the master polling all slave nodes/FiberOptic repeaters. When communicating with the repeaters, the serial number of the repeater (or repeater controller) is used as an address. This means that the node master must have knowledge of the serial numbers of all repeaters in the network. When adding new nodes in an existing repeater system (or when configuring a new system), nodes are configured using the NODE ADD command, which requires knowledge of the serial number for the installed repeater, and what opto module the fiber is connected to. The NODEPNP command is used to find nodes/repeaters connected to the different fiber optic modules. Older generation of Axell Wireless repeaters (H30 or H12 controllers) do not support NODEPNP, why address needs to be determined at repeater site. Format: NODEPNP [--maxwait ] [--reset] [--noack] [--verbose] : where the following applies: --maxwait - this optional parameter defines number of milliseconds that the node master should wait on reply from the slave nodes (slave nodes wait a random number of milliseconds before replying to a request). If not supplied, 2000 milliseconds will be used. --reset - A node will only reply to PnP requests if node has not been communicated with before. If supplying this flag, all nodes will have the PnP functionality reset, meaning that all nodes will be answering on the request. --noack – when a node is found, the PnP routine will send a message to this node to ensure that it will not answer to the next PnP request. By supplying this optional parameter, no message will be sent, meaning that replies will be made to consecutive requests too. --verbose – by supplying this parameter, progress on the Plug and Play activities will be printed out. This is normally used for advanced trouble shooting. is the rack containing the Opto Module performing plug and play for. is the slot number within to perform plug and play for. Example 1: NODEPNP 1:3 Reply: Found node 5644 in rack 1, slot 3. This example showed a successful retrieving of node data. Command NODE ADD 5644 1:3 1 should be used to add node to the system. Example 2: NODEPNP 1:3 Reply: No nodes found in rack 1, slot 3. No nodes available, or nodes answered at the same time. You might want to try again. This either means that all nodes already are added, or that other nodes on this slot are of old type not supporting plug and play functionality. 9(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 Example 3: NODEPNP 1:4 Reply: Failure to find nodes in rack 1, slot 3, probably more than one node answering. Try again! This probably means that two or more nodes answered at the same time, giving corrupt data back. Running this command again, optionally with a longer delay, might cause the nodes not to answer at the same time. Note 1! When performing a plug and play operation, communication with repeaters will be stopped during the plug and play routine. Note 2! When nodes are found, they can be added using the NODE ADD command. Note 3! If node is not configured as a node master, an error message will be produced: “Error: Node not a System Node Master, command not supported.” 5.2 STATUS The STATUS command gives an overview of the entire repeater RF-configuration and status of all alarm sources in the system. 1:1 1:2 1:3 1:4 1:5 1:6 SPLIT/DL CMB/UL|Rack Com. Board RXO/TXO ER/OK ER/ER OK/ER OK/OK OK/OK OK/OK Atten(dB): 21 21| 1 2 3 4 SZP/RBT OK/OK OK/OK OK/OK OK/OK OK/OK OK/OK PW3/ILD OK/OK OK/--|PW1 ER ER ER ER CRC/COM OK/OK OK/OK OK/OK OK/OK OK/OK OK/OK CRC/COM OK/OK OK/OK|PW2 OK ER OK OK 2:1 2:2 2:3 2:4 2:5 2:6 |PW3 OK OK OK OK RXO/TXO ER/OK ER/ER OK/ER OK/OK OK/OK OK/OK Atten(dB): 21 21|PW4 OK - - SZP/RBT OK/OK OK/OK OK/OK OK/OK OK/OK OK/OK PW3/ILD OK/OK OK/--|BAT OK - - CRC/COM OK/OK OK/OK OK/OK OK/OK OK/OK OK/OK CRC/COM OK/OK OK/OK|RBT OK OK OK OK 3:1 3:2 3:3 3:4 3:5 3:6 |CRC OK OK OK OK RXO/TXO ER/OK ER/ER OK/ER OK/OK OK/OK OK/OK Atten(dB): 21 21|COM OK OK OK OK SZP/RBT OK/OK OK/OK OK/OK OK/OK OK/OK OK/OK PW3/ILD OK/OK OK/--|--------------CRC/COM OK/OK OK/OK OK/OK OK/OK OK/OK OK/OK CRC/COM OK/OK OK/OK|External Alarms 4:1 4:2 4:3 4:4 4:5 4:6 |1 ER First 10ch RXO/TXO ER/OK ER/ER OK/ER OK/OK OK/OK OK/OK Atten(dB): 21 21|2 OK Descr. 2 SZP/RBT OK/OK OK/OK OK/OK OK/OK OK/OK OK/OK PW3/ILD OK/OK OK/--|3 OK Descr. 3 CRC/COM OK/OK OK/OK OK/OK OK/OK OK/OK OK/OK CRC/COM OK/OK OK/OK|4 OK Descr. 4 -------------------------------------------------------------------------------Ctrl Temp: -22.0(ER)| Relay:Closed(ER)| Node Statuses: 000001000---------------- 10(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 ALARM CONFIGURATIONS The following commands and attributes are implemented for the OMU target alarm configurations, as an add-on to the Common part. 6.1 AC2 – Compressed Alarm Severity and Alarm Class Configurations A compact message retrieving alarm severity and alarm class for a number of alarm sources. 6.1.1 Usage Attribute type: Read only This is a compact message to retrieve Severity and Class of the different alarm sources. BAT, COM, CRC, NCO, PW1, PW2, PW3, PW4, RBT, RXO, SZP, TEM , TXO and ILD Format: .. Example: GET AC2 Replies: WA EQ CR EQ WA EQ CR EN CR EQ CR EQ CR EQ CR EQ CR EQ CR EN CR EN WA EN CR EN CR EN which are the severities and classes for the alarm sources BAT..ILD. Note! The alarm severities and alarm classes can also be read and set with commands GET/SET ASE and GET/SET ACL 6.2 AL4 - Compressed Alarm Format A compact message retrieving alarm configurations for BAT, COM, CRC, NCO and PW1. 6.2.1 Usage Attribute type: Read only Same as attribute AL1, but replies with configuration for alarm sources BAT, COM, CRC, NCO and PW1. 6.3 AL5 - Compressed Alarm Format A compact message retrieving alarm configurations for PW2, PW3, PW4, RXO and RBT. 6.3.1 Usage Attribute type: Read only Same as attribute AL1, but replies with configuration for alarm sources PW2, PW3, PW4, RXO and RBT. 6.4 AL6 - Compressed Alarm Format A compact message retrieving alarm configurations for SZP, TEM, TXO and ILD. 6.4.1 Usage Attribute type: Read only Same as attribute AL1, but replies with configuration for alarm sources SZP, TEM, TXO and ILD. 11(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 6.5 Version: 1.0 ALL - Compact Message Status Parameters in Optical Master Unit A compact message of all RF and status parameters in the repeater. 6.5.1 Usage Attribute type: Read only This attribute replies with the same information as in the heartbeat sent to the Axell Element Manager, except the header information (Repeater ID, STATE, Message # , Time and Date ). Please refer to Heartbeat Reports format. 6.6 BAT – Status of battery charge Displays status of the battery charge. 6.6.1 Usage Attribute Type: Read-Only The optical master unit is equipped with a battery backup, which feeds controller and the modem with power during a power failure. This battery backup ensures that the optical master unit is able to inform the Axell Element Manager that the repeater network coverage is out. This attribute replies with the status of the battery charge. A too low battery charge probably means that the optical master unit is back from a power failure and that the battery is not fully charged yet, while a too high battery voltage might indicate that the battery pack needs replacement. Current battery level can be read out with attribute PLV, while battery level configurations are manipulated with attribute ALA BAT. Battery Level is measured in the Rack Communication Boards (RCB) of the master rack. Format: where is battery status. 0 if status is OK 1 if status is ERROR - (dash) if measured data is not available (communications error or improperly configured system). Example: GET BAT Reply: indicating that battery status is in error. 6.7 COM – Status of Communication with Active Devices Displays status of communication between controller and active devices. 6.7.1 Usage Attribute type: Read only Gives status of the communication between the controller and the active devices. A communications alarm might indicate a failing module an improperly configured module or a broken cable Format: .. .. .. .. .. .. .. where .. is status on communication with Rack Communications Board 1 to 4. .. is status on communication with Splitter Board 1 to 4. 12(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 .. is status on communication with Combiner Board 1 to 4. .. is status on communication with Fiber Optic Modules 1 to 6 in rack 1. .. is status on communication with Fiber Optic Modules 1 to 6 in rack 2. .. is status on communication with Fiber Optic Modules 1 to 6 in rack 3. .. is status on communication with Fiber Optic Modules 1 to 6 in rack 4. Value can be: 0 means status is OK 1 means status is ERROR, or data not currently available (configurations error). - (dash) means module is not installed. Example: GET COM Reply: 01-- 00-- 00-- 000000 0000-- ------ ------ meaning that two racks are installed with 6 modules in first rack and two in second. Communication between controller and Rack Communications Board 2 is failing, while communications with all other modules are OK. 6.8 CRC – Status of EEPROM CRC Displays status of the EEPROM CRC in active devices. 6.8.1 Usage Attribute type: Read only Each active device stores all settings and configurations in its own EEPROM memory so that an immediate startup can be performed after power outage, and so that radio coverage works as intended even if controller malfunctions. On regular intervals the controller requests a checksum calculation of the EEPROM in the radio devices. If a failure is detected, the CRC error is flagged in the EEPROM of the active device so that alarm status is known even after a power failure. This status is checked in EEPROM of the Rack Communication Boards (RCB), Splitter Boards (SPLIT), Combiner Boards (COMB) and the Fiber Optic Master Units (FOMASTER). CRC alarms normally indicates a failing EEPROM and that module should be replaced. This attribute replies with CRC status of the polled devices. Format: .. .. .. .. .. .. .. where .. is status on CRC check in Rack Communications Board 1 to 4. .. is status on CRC check in Splitter Board 1 to 4. .. is status on CRC check in Combiner Board 1 to 4. .. is status on CRC check in Fiber Optic Modules 1 to 6 in rack 1. .. is status on CRC check in Fiber Optic Modules 1 to 6 in rack 2. .. is status on CRC check in Fiber Optic Modules 1 to 6 in rack 3. .. is status on CRC check in Fiber Optic Modules 1 to 6 in rack 4. Value can be: 13(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 0 means status is OK 1 means status is ERROR. - (dash) means module is not available. Example: GET CRC Reply: 00-- 00-- 00-- 000000 0100-- ------ ------ meaning that two racks are installed with 6 modules in first rack and two in second. CRC error is detected in FiberOptic module 2 in rack 2, while CRC status in all other modules is OK. 6.9 PW1 - Status of Power Supply 1 Gives status of the power supply 1 as measured in the different racks. 6.9.1 Usage Attribute type: Read only This attribute replies with status of the Power Supply 1 (+28 V) in the different racks of the Optical Master Unit. Power Supplies are measured in the Rack Communication Boards (RCB) of the system. Format: where is status of the +28 V as measured in the RCB of the first rack (Master Rack). is status of the +28 V as measured in the RCB of the second rack (Slave Rack). is status of the +28 V as measured in the RCB of the third rack (Slave Rack). is status of the +28 V as measured in the RCB of the fourth rack (Slave Rack). where 0 means status is OK 1 means status is ERROR - (dash) means data is not available (not yet measured or communications error with RCB). Example: GET PW1 Reply: 001- meaning that power supply 1 is in error in third rack, and that fourth error is not installed, or there is a communications error with fourth rack. 6.10 PW2 - Status of Power Supply 2 Gives status of the power supply 2 as measured in the different racks. 6.10.1 Usage Attribute type: Read only This attribute replies with status of the Power Supply 2 (+15 V) in the different racks of the Optical Master Unit. Power Supplies are measured in the Rack Communication Boards (RCB) of the system. Format: where is status of the +15 V as measured in the RCB of the first rack (Master Rack). is status of the +15 V as measured in the RCB of the second rack (Slave Rack). is status of the +15 V as measured in the RCB of the third rack (Slave Rack). is status of the +15 V as measured in the RCB of the fourth rack (Slave Rack). where 0 means status is OK 14(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 1 means status is ERROR - (dash) means data is not available (not yet measured or communications error with RCB). Example: GET PW2 Reply: 010- meaning that power supply 2 is in error in second rack, and that fourth error is not installed, or there is a communications error with fourth rack. 6.11 PW3 - Status of Power Supply 3 Gives status of the power supply 3 as measured in the different racks. 6.11.1 Usage Attribute type: Read only This attribute replies with status of the Power Supply 3 (+6.45 V) in the different racks of the Optical Master Unit. Power Supplies are measured in the Rack Communication Boards (RCB) and the Splitter/Combiner Boards of the system. Format: where is status of the +6.45 V as measured in the RCB of the first rack (Master Rack). is status of the +6.45 V as measured in the RCB of the second rack (Slave Rack). is status of the +6.45 V as measured in the RCB of the third rack (Slave Rack). is status of the +6.45 V as measured in the RCB of the fourth rack (Slave Rack). is status of the +6.45 V as measured in the Splitter Board of the first rack (Master Rack). is status of the +6.45 V as measured in the Splitter Board of the second rack (Slave Rack). is status of the +6.45 V as measured in the Splitter Board of the third rack (Slave Rack). is status of the +6.45 V as measured in the Splitter Board of the fourth rack (Slave Rack). is status of the +6.45 V as measured in the Combiner Board of the first rack (Master Rack). is status of the +6.45 V as measured in the Combiner Board of the second rack (Slave Rack). is status of the +6.45 V as measured in the Combiner Board of the third rack (Slave Rack). is status of the +6.45 V as measured in the Combiner Board of the fourth rack (Slave Rack). where 0 means status is OK 1 means status is ERROR - (dash) means data is not available (not yet measured or communications error with RCB or Splitter). Example: GET PW3 Reply: 010-000- 15(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 meaning that there are three racks installed, power supply 3 in Rack Communications Board second rack is in error, and that all other measured power supplies are OK. 6.12 PW4 - Status of Power Supply 4 Gives status of the power supply 4 as measured in the first rack. 6.12.1 Usage Attribute type: Read only This attribute replies with status of the Power Supply 4 (+6.45 V) as measured in the first rack (master rack). Power Supply 4 feeds the controller and modem with power that is battery backed up, meaning that in case of a power failure it is still possible to report that repeater coverage has disappeared. Power Supplies are measured in the Rack Communication Boards (RCB) of the system. Format: where is status of the backup power supply +6.45 V as measured in the RCB of the first rack. Value can be: 0 means status is OK 1 means status is ERROR - (dash) means data is not available(not yet measured or communications error with RCB). Example: GET PW4 Reply: meaning that power supply 4 is measured as not being within allowed interval in first rack (master rack). 6.13 RBT – Status of Radio Board Temperatures Gives status of the radio board temperatures as measured throughout the optical master unit. 6.13.1 Usage Attribute type: Read only This attribute replies with status of the Radio Board Temperature alarm sources as measured throughout the repeater. Format: .. .. .. .. .. where .. is status of board temperatures in Rack Communications Board 1 to 4. .. is status of radio board temperatures in Fiber Optic Modules 1 to 6 in rack 1. .. is status of radio board temperatures in Fiber Optic Modules 1 to 6 in rack 2. .. is status of radio board temperatures in Fiber Optic Modules 1 to 6 in rack 3. .. is status of radio board temperatures in Fiber Optic Modules 1 to 6 in rack 4. 16(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 Value can be: 0 means status is OK 1 means status is ERROR. - (dash) means module is not available. Example: GET RBT Reply: 00-- 000010 0000-- ------ ------ meaning that two racks are installed with 6 modules in first rack and two in second. Temperature error is detected in FiberOptic module 5 in rack 1, while temperature status in all other modules is OK. 6.14 RSP – Optical Master Unit Status Parameters This attribute replies with status of all alarm sources in the Optical Master Unit. 6.14.1 Usage Attribute type: Read only This attribute replies with status of all alarm sources in the repeater and is used to get a quick overview of the entire repeater status. For certain parameters (as noted below) some parameters are hex coded. This means that a byte replied as “A” should be converted to 1010 for corresponding position. These parameters should be used in conjunction with COM attribute to determine if parameter is valid or not. Parameter NON should be used to determine number of nodes when interpreting NCO data. Format: where is status of Battery Charge for controller and modem backup. is status of communication with Rack Communication Boards. is status of communication with Splitter Boards. is status of communication with Combiner Boards. is status of communication with fiber optic modules in rack 1. is status of communication with fiber optic modules in rack 2. is status of communication with fiber optic modules in rack 3. is status of communication with fiber optic modules in rack 4. is status of EEPROM CRC in Rack Communication Boards and FiberOptic Modules. Hex Coded as: Byte 1: Byte 2: Byte 3: Byte 4: Byte 5: Byte 6: Byte 7: Byte 8: Byte 9: is status of communication with remote nodes. Hex Coded as: Byte 1: Byte 2: 17(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 ... Byte 6: is status of Power Supply 1 as measured in Rack Communication Boards is status of Power Supply 2 as measured in Rack Communication Boards is status of Power Supply 3 as measured in Rack Communication Boards and OMU Splitters. Hex Coded as: Byte 1: Byte 2: Byte 3: is status of Power Supply 4 as measured in Rack Oommuncations Board 1. is Radio Board Temperature as measured in Rack Communication Boards and Fiber Optic Modules. Hex Coded as: Byte 1: Byte 2: Byte 3: Byte 4: Byte 5: Byte 6: Byte 7: is status of Received Optical Level as measured in Fiber Optic Modules. Hex coded as: Byte 1: Byte 2: Byte 3: Byte 4: Byte 5: Byte 6: is synthesizer lock status for Pilot Tone Generator as measured in Fiber Optic Modules. Hex coded as: Byte 1: Byte 2: Byte 3: Byte 4: Byte 5: Byte 6: is temperature status as measured in controller. is status of Transmitted Optical Level as measured in Fiber Optic Modules. Hex coded as: Byte 1: Byte 2: Byte 3: Byte 4: Byte 5: Byte 6: is status of input level downlink as measured in Splitter Boards. is status of external alarms 1 – 4. Value can be: 0 means status is OK 1 means status is ERROR - (dash) means data is not available (not yet measured). 18(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 Example: GET RSP Reply: 0 000- 000- 000- 000000 000000 00000- ------ 000000000 000000 000- 000000 0 0000000 000000 000000 1 000000 000- 0000 which indicates that all alarm statuses are OK, except temperature, which is in error. 6.15 RXO – Status of Received Optical Level This attribute replies with the status of the Received Optical Level alarm sources. 6.15.1 Usage Attribute type: Read only The Fiber Optic Master constantly monitors received optical level. A too low optical input level might indicate that there is something wrong with the transmitter, a bad optical connection (poor soldering or cleaning) or a broken fiber. A drop in received optical level most likely means that received RF-signal level also has dropped and that repeater coverage area is affected / decreased. This attribute replies with the status of the Received Optical Level alarm sources for all opto masters. Format: .... 0 if status is OK. 1 if status is ERROR. - (dash) if measured data is not available (communications error or improperly configured system). Example: GET RXO Reply: 00001-0000--000--------- indicating that received optical level in module in rack 1, slot 5 is lower than expected level, and that reason for the dropped input signal level should be investigated. 6.16 SZP – Status of Pilot Tone Generator Synthesizer Replies with the status of the Pilot Tone Generator Synthesizer alarm sources. 6.16.1 Usage Attribute type: Read only When commissioning an Axell Wireless Repeater System it is essential that all fiber optic links are optimized and RF-limits adjusted accordingly. To accomplish this, a pilot tone is transmitted from Optical Master Units to the Fiber Optic Slaves and on request from slaves to masters. By transmitting with a known level and measuring received pilot tone level it is possible to calculate the path loss and hence compensate system gain accordingly. To generate the correct pilot tone frequency, a synthesizer is used. If there is a failure generating the correct pilot tone frequency, an Synthesizer Pilot Tone generator alarm is triggered. This attribute replies with the status of the Pilot Tone Generator Synthesizers. Format: .... where reply is 0 if status is OK/Synthesizer locked onto desired frequency. 1 if status is ERROR/Synthesizer not locked onto desired frequency. - (dash) if measured data is not available (communications error or improperly configured system). 19(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 Example: GET SZP Reply: 000000000010000--------- indicating that synthesizer in rack 2, slot 4 is unlocked, and that reason for failure should be investigated. 6.17 TEM – Status of Controller Temperature Displays status of temperature as measured in the repeater controller. 6.17.1 Usage Attribute type: Read only This attribute replies with status of the temperature as measured in the repeater controller. Format: where 0 means status is OK 1 means status is ERROR - (dash) means data is not available (not yet measured). Example: GET TEM Reply: indicating that temperature as measured in controller is outside allowed interval (as configured with attribute ALA TEM). Current temperature can be read out using attribute TEL. 6.18 TXO – Status of Transmitted Optical Level This attribute replies with the status of the transmitted optical level alarm source. 6.18.1 Usage Attribute type: Read only Transmitted optical power level is constantly monitored to ensure functionality of the system. In case the optical transmitter for some reason fails (hardware failure), an alarm is triggered. This attribute replies with the status of the transmitted optical level alarm source. Format: .... where reply is 0 if status is OK. 1 if status is ERROR. - (dash) if measured data is not available (communications error or improperly configured system). Example: GET TXO Reply: 00000000000010----00---- indicating that something is malfunctioning with the optical transmitter in rack3, slot 1. Reason for failure should be investigated. 20(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 OPTO INTERFACE CONFIGURATIONS This section describes attributes used to read out and configure settings related to the FiberOptic modules and corresponding pilot tone functionality. 7.1 OLA – Optical Loss Adjustment This attribute is used to read and adjust link between master and optical slave unit. 7.1.1 Usage Attribute type: Read and Action This attribute is used to perform an automatic adjustment of the fiber optic link to compensate for losses, and to read status of last performed adjustment. Adjustments are made to get a well balanced and optimized system, maintaining desired gain over the entire link from input of Optical Master Unit to output of repeater. When performing the adjustment from slave to master, a pilot tone with a well defined level is sent form the slave to the master. To start the measurements, the master must first enable pilot tone signal in the slave (Fiber Optic Slave in repeater), after which pilot tone adjustments can be performed. Once routine is finished, Pilot Tone in slave is disabled again Format on ACT: ACT OLA : [-v] [-l] performs automatic adjustment of the opto link from the repeater to the optical master unit in rack and . If supplying parameter -v (as verbose) progress information is printed out on the screen as the adjustments proceed. If supplying parameter -l (as local) enabling / disabling pilot tone on remote node is disabled. Example: ACT OLA 1:3 performs an optical link adjustment of link from repeater to opto module in rack one, slot 3. Reading OLA replies with status of last performed adjustments. Format on GET: GET OLA : reads last fiber optic adjustment for link from slave repeater to opto module in rack , slot . Reply: where is status of last measurement, 0 means adjustments were successfully completed, 1 means adjustments failed. is on the format HHMMSS DDMMYY, where HHMMSS is the time with 24 hours notation, and DDMMYY is the date for when last measurement started. is on the format HHMMSS DDMMYY, where HHMMSS is the time with 24 hours notation, and DDMMYY is the date for when last measurement finished. is the attenuation set before starting the adjustment routine. is the attenuation that was set when routine was completed. indicates the received pilot tone level in dBm * 10 when adjustment was completed (for optimal performance, pilot tone should be adjusted to -32.0 dBm). indicates number of iterations (Set Attenuation- Read Pilot Tone 21(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 Level) that was needed to complete adjustment. is a quoted string containing additional information about measurement or reason for failure. Example: GET OLA 1:6 Reply: 0 144503 220507 144511 220507 23 25 -314 3 “Pilot tone adjusted to -31.4 dBm, procedure completed.” indicating result for last adjustment. If no adjustment has been performed, a '-' (dash) is reported instead. Note! In order for opto adjustments to work, what node is installed as slave repeater must be known. This is configured using the attribute NCP ( Node Communications Path ). 7.2 OLC – Optical Loss Compensation Displays (and optionally configures) compensation for optical loss for all fiber optic masters in the system.. 7.2.1 Usage Attribute type: Read and Write During automatic optimization of the FiberOptic link, the node master reads the received pilot tone level and compensates for the optical loss. This is to ensure that the input RF level from the Optical Slave Unit is at the correct level to obtain the correct system gain. Format on getting parameter: .. .. where OLC1:1..OLC4:6 indicates attenuation in dB configured for fiber optic masters in .. to obtain optimal uplink performance of the system. If optical master is not configured, a '-' (dash) is reported in corresponding position. Example: GET OLC Reply: 10 10 9 10 8 - 10 11 10 - - - - - - - - - - - - - - - indicating optical loss attenuation for installed opto masters. Note! This parameter should normally be adjusted during commissioning, and not changed afterwards. Format on setting parameter: SET OLC : where indicates rack number from 1 to 4, and indicates slot from 1 to 6 within rack. is the desired attenuation in dB. Valid range is 0 to 25 dB. Example: SET OLC 2:1 18 adjusts the attenuation in FiberOptic Master unit in rack 2, slot 1 to 18 dB. 7.3 OLV – Optical Level Replies with optical signal level as received from the optical slave units. 7.3.1 Usage Attribute type: Read only Knowing the fixed optical transmission level of the optical slave unit and measuring the received optical level, it is possible to calculate optical loss between slave and master unit. This attribute displays the received optical level in dBm. Format: .. .. 22(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 where OLC1:1..OLC4:6 replies with received optical level in dBm with one decimal resolution for fiber optic masters in .. . If level is lower than lowest detectable, '<[LowDet]' is replied. If value is not available (such as not FiberOptic Master not installed or configured, or communications error with FiberOptic Master), a '-' (dash) is reported. Example: GET OLV Reply: -7.1 -7.5 -8.3 -6.2 -6.6 - -11.2 -10.1 - - - - - - - - - - - - - - - - meaning that received optical level is from -6.2 to -11.2 dBm. In this example, knowing that optical transmitted level is 3 dBm, optical loss is varying from 9.2 to to 14.2 dB. 7.4 OMP – Opto Master Parameters Displays different parameters on the optical master. 7.4.1 Usage Attribute type: Read only This attribute replies with parameters and constants of the FiberOptic Master. Values are used by the repeater to perform calculations and to present user with opto master performance data. Format: GET OMP : Reply: where is the lowest detectable received opto signal in dBm with one decimal resolution. is a frequency offset in dB set during production of the repeater, and is used to compensate for frequency variations in the opto module. is the lowest detectable pilot tone level in dBm with one decimal resolution. is the channel used for the pilot tone. Note! If data is not available (communications error with note, or wrong configuration), four dashes separated by space are replied. Example: GET OMP 3:6 Reply: -15.0 3 -50.0 500 indicating that for fiber optic module in rack 3, slot 6, lowest detectable optical level is -15.0 dBm, pilot tone offset is 3 dB, lowest detectable pilot tone is -50.0 dBm and ARFCN used for generated pilot tone is 500. 7.5 PTL – Pilot Tone Level This attribute replies with received pilot tone levels from optical slaves. 7.5.1 Usage Attribute type: Read only This attribute replies with received pilot tone level from optical slave unit. This value is used during automatic optical loss compensations to ensure that the repeater system is commissioned with optimal performance. Format: .. .. where PTL1:1..PTL4:6 replies with received pilot tone level in dBm with one decimal resolution for fiber optic masters in .. . If lower than lowest detectable pilot tone level, a <[Lowest Detectable Pilot Tone Level] is presented. 23(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 If value is not available (such as not FiberOptic Master not installed or configured, or communications error with FiberOptic Master), a '-' (dash) is reported. Example: GET PTL Reply: <-50.0 <-50.0 <-50.0 <-50.0 - - -27.1 - - - - - - - - - - - - - - - - - indicating that level of received pilot tone for the different modules are lower than lowest detectable, except for module in position rack 1, slot 1, which has a level of-27.1 dBm. This is the typical scenario when adjusting system in the uplink path, where only one module at a time is transmitting the pilot tone. 7.6 PTN – Pilot Tone Nominal Level This attribute replies with the nominal level for the received pilot tone level. 7.6.1 Usage Attribute type: Read only This attribute replies with the nominal pilot tone level that should be received from the slave node when a system is properly commissioned. This value serves as the value that received pilot tone should be adjusted to in order to have an optimized system. Format on getting parameter: GET PTN Reply: where is nominal level in dBm * 10. Example: GET PTN Reply: -250 meaning that nominal pilot tone level is -25.0 dBm. RF-RELATED CONFIGURATIONS 8.1 ATD – Attenuation Downlink Reads and configures attenuation in the downlink path. 8.1.1 Usage Attribute Type: Read and Write The input attenuation in the downlink path is used to adjust the input levels to the system before being fed to the opto converters. By adjusting the attenuation correctly, maximum range of the gain settings can be utilized in the fiber optic fed repeaters. It is possible to set up a threshold to monitor that input signal level to the system is within desired interval. If input signal level is below configured threshold, this means that output from the repeaters also has dropped and that desired coverage is not achieved, causing an alarm to be triggered. Note! In order to read out actual received input levels, refer to attribute ILV. To read status of input power level measurements, refer to attribute ILD and to set corresponding alarm thresholds use attribute ALA ILD. Format on getting parameters: where downlink attenuation for the different racks 1-4 are displayed. If rack is not installed, a '-' (dash) is reported in corresponding position. Example: GET ATD Reply: 24(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 6 6 9 - indicating that rack 1 and 2 have attenuation set to 6 dB, rack three to 9 dB and fourth rack is not configured. Format on setting parameters: SET ATD [ ] [ ] [ ] where is the rack selector (1..4) is downlink attenuation to set in rack K. Interval is 0 to 21 dB in 3 dB steps. Optionally attenuation in rack L to N can be set at the same time. Example: SET ATD 2 9 3 9 sets attenuation in rack 2 and 3 to 9 dB. 8.2 ATU – Attenuation Uplink Reads and configures the attenuation in the uplink path. 8.2.1 Usage Attribute Type: Read and Write The attenuation in the uplink path is used to configure the system according to downlink gain settings to get a well balanced system. The attenuation is set in the combiner board. Format on getting parameters: where uplink attenuation for the different racks 1-4 are displayed. If rack is not installed, a '-' (dash) is reported in corresponding position. Example: GET ATU Reply: 9 9 12 - indicating that rack 1 and 2 have attenuation set to 9 dB, rack three to 12 dB and fourth rack is not configured. Format on setting parameters: SET ATU [ ] [ ] [ ] where is the rack selector (1..4) is uplink attenuation to set in rack K. Interval is 0 to 21 dB in 3 dB steps. Optionally attenuation in rack L to N can be set at the same time. Example: SET ATU 2 9 3 9 sets attenuation in rack 2 and 3 to 9 dB. 8.3 ILD – Status of Input Level Downlink Displays status of the input power level in the downlink. 8.3.1 Usage Attribute Type: Read-Only The controller constantly monitors the input signal level to the rack in the downlink path. If input signal level is below configured threshold, this means that output from the repeaters has dropped too and that desired coverage is not achieved. This causes an alarm to be triggered. This attribute is used to read status of the Input Level alarms. 25(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 Format: where is status of the input signal level as measured in the Splitter Board of the first rack (Master Rack). is status of the input signal level as measured in the Splitter Board of the second rack (Slave Rack). is status of the input signal level as measured in the Splitter Board of the third rack (Slave Rack). is status of the input signal level as measured in the Splitter Board of the fourth rack (Slave Rack). where 0 means status is OK 1 means status is ERROR - (dash) means data is not available (not yet measured or communications error with Splitter Board). Example: GET ILD Reply: 010- meaning that input signal level is outside configured interval in the second rack, and that fourth error is not installed, or there is a communications error with fourth rack. Note 1! Input signal level is measured after attenuation, to ensure that desired level is distributed throughout the repeater system. Note 2! To configure downlink attenuation, refer to attribute ATD. To read out actual received input levels, refer to attribute ILV and to set input signal alarm thresholds use attribute ALA ILD. 8.4 ILV – Input Levels Downlink Displays RF input levels in the downlink. 8.4.1 Usage Attribute Type: Read-Only This attribute replies with the input signal level to the system in the downlink path. This can be used to adjust the downlink levels for optimal performance. Signal is measured after the downlink attenuator. This level is also used when configuring threshold for the Input Level Downlink (ILD) alarm. Format: where .. is the input signal level in dBm with one decimal tolerance for Splitter Board in rack 1 to 4. If input power is lower than lowest detectable signal, ' reads status from combiner installed in rack N (1..4). Reply: where is the lowest frequency in Hz that this combiner can be used for. is the highest frequency in Hz that this combiner can be used for. If data is not retrieved (such as a communications error with the combiner) or module is not installed, two dashes are reported. Example: GET RFC 1 Reply: 380000000 2250000000 meaning that frequency range for combiner is 380.0 MHz to 2250.0 MHz. 8.6 RFS – Radio Frequency Parameters for Splitter Displays Radio Frequency related parameters of the Splitter board. 8.6.1 Usage Attribute type: Read only This attribute displays Radio Frequency related parameters of the splitter board. Format on getting parameters: GET RFS reads status from Split installed in rack N (1..4). Reply: where is the lowest frequency in Hz that this splitter can be used for. is the highest frequency in Hz that this splitter can be used for. is the lowest signal level in dBm * 10 that the splitter can detect. If data is not retrieved (such as a communications error with the splitter) or module is not installed, three dashes are reported. Example: GET RFS 1 Reply: 380000000 2250000000 -50 meaning that frequency range for splitter is 380.0 MHz to 2250.0 MHz, and that lowest detectable input signal level is -5.0 dBm. TEMPERATURE AND POWER SUPPLY LEVELS This section describes attributes used to read out temperature and power supply levels and configurations. 9.1 PLV – Power Supply Levels Displays power supply levels as measured in the different racks. 27(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 9.1.1 Version: 1.0 Usage Attribute Type: Read-Only Depending on configuration, an optical master unit can consist of one to four racks, where rack 1 is the master rack and rack 2 to 4 are slave racks. This attribute displays a number of voltages as measured in the configured racks. Levels are displayed for all racks configured in the system, and if rack is not available, a '-' (dash) is reported in corresponding position. Format: .. .. .. .. .. where .. is the +28.0 V levels with one decimal resolution and a leading + sign as measured in rack 1 to rack 4. .. is the +15.0 V levels with one decimal resolution and a leading + sign as measured in rack 1 to rack 4. .. is the +6.45 V levels with two decimals resolution and a leading + sign as measured in Rack Communications Board in racks 1 to 4. .. is the +6.45 V levels with two decimals resolution and a leading + sign as measured in Splitter Board in racks 1 to 4. .. is the +6.45 V levels with two decimals resolution and a leading + sign as measured in Combiner Board in racks 1 to 4. is the +6.45 backup power level with two decimals resolution and a leading + sign as measured in rack 1. is the battery level with one decimal resolution and a leading + sign as measured in rack 1. Example (assuming system is equipped with master and one slave rack power supplies): GET PLV Reply: +28.1 +28.0 - - +15.0 +15.0 - - +6.41 +6.43 - - +6.42 +6.45 - - +6.41 +6.42 - - +6.46 +11.1 displaying the power supply distribution throughout the optical master unit. 9.2 TEL – Temperature Levels Displays temperatures as measured throughout the Optical Master Unit. 9.2.1 Usage Attribute type: Read only This attribute displays all temperatures as measured in the different boards of the optical master unit. Format: .. .. where temperature for each of the devices is presented with one decimal resolution and a leading + or minus sign. If data is not available, or hardware for position is not configured, a '-' (dash) is presented in corresponding position. Example: GET TEL Reply: +31.4 +31.1 +30.1 - - +30.9 +31.2 +30.0 +30.9 +31.1 - +31.5 +31.4 +32.0 - - - - - - - - - - - - - - indicating the different temperature levels throughout the Optical Master Unit. 28(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 10 DATA COMMUNICATION SETTINGS This section describes attributes used to configure and read out misc data communication settings. 10.1 NCP – Node Communications Path This attribute reads and configures node communications path. 10.1.1 Usage Attribute type: Read and write This attribute is used to read and configure what rack position the fiber optic repeater / slave node is connected. This configuration is used when performing optical loss adjustments (ACT OLA) from slaves to masters and for trouble shooting purposes. For this reason it is important to configure the Node Communications Path. Format on getting parameter: Rack1:Slot1 Rack2:Slot2 .. Rack24:Slot24 where RackN:SlotN indi cates rack (1..4) and slot (1..6) where node N is installed. If configuration for node is not made, 0:0 is replied. If node is not configured, a '-' (dash) is replied. Example: GET NCP Reply: 1:1 1:2 1:3 1:4 0:0 2:1 2:2 2:3 3:1 - - - - - - - - - - - - - - - meaning that system has 9 nodes, but node 5 does not have node communications path configured. Format on setting parameter: SET NCP : where determines node to be configured (1..24). is the rack (1..4) and is the slot (1..6) containing Fiber Optic master used to communicate with slave. Example: SET NCP 5 1:5 configures node 5 as being connected to fiber optic module in rack 1, slot 5. 10.2 OCP – Opto Communication Path Configurations This attribute is used to read and enable/disable communications over opto fiber. 10.2.1 Usage Attribute type: Read and Write For trouble shooting purposes and to disable data from a fiber optic device that pollutes communications data with other slaves it is possible to enable or disable data communications over the opto fiber connected to a certain FiberOptic Master Unit. Format on getting parameter: .. .. where OCP1:1..OCP4:6 indicates enable / disable communication over fiber connected to fiber optic masters in .. . 0 means communications path is disabled. 1 means communications path is enabled. If optical master is not configured, a '-' (dash) is reported in corresponding position. Example: GET OCP Reply: 1 1 1 1 0 1 1 1 1 1 1 – 1 1 1 1 1 - - - - - - - 29(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 indicating that all installed opto links have data communications enabled, exept for module in position rack 1:slot 5. Format on setting parameter: SET OCP : where indicates rack number from 1 to 4, and indicates slot from 1 to 6 within rack. configures if data communications should be enabled (1) or disabled (0). Example: SET OCP 2:1 0 disables communication over fiber connected to FiberOptic Master unit in rack 2, slot 1. Note 1! Communications path for all opto links are always enabled during startup of the Optical Master Unit. Note 2! Disabling communication over an opto fiber will cause communications alarm with any nodes/repeaters communicating over this link. 10.3 RCP - Rack Communications Path Configuration This attribute is used to read and enable/disable communications to opto modules. 10.3.1 Usage For trouble shooting purposes and testing it is possible to enable or disable data communications from all opto modules in a rack.. When disabling a communications path it means that communications alarm with all opto modules in that rack and all nodes/repeaters connected to corresponding fiber connections will be triggered. Format on getting parameter: where RCP:1..RCP:4 indicates enable / disable status for communications path from RCB:1 .. RCB:4 to fiber optic modules in corresponding rack. 0 means communications path is disabled. 1 means communications path is enabled. If optical master is not configured, a '-' (dash) is reported in corresponding position. Example: GET RCP Reply: 1 1 0 - indicating that rack 1 and 2 have communication to fiber optic devices enabled, while rack three communication is disabled and fourth rack is not configured. Format on setting parameter: SET RCP where indicates rack number from 1 to 4 configures if data communications should be enabled (1) or disabled (0). Example: SET RCP 2 0 disables communication with fiber modules in rack 2 Note! Communications path for all racks enabled during startup of the Optical Master Unit. 30(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 11 ALARM ATTRIBUTE THRESHOLDS This section defines alarm sources in the Optical Master Unit target. The following alarms are NOT described in this chapter, but are optionally generated by the repeater: * External Alarm Interface board alarms EX1-EX4. * User activity alarms VLI, LGO and CLR. * User administration alarms (UAD, UDE, UPM, UDM and UPW). * Firmware upgrade / fall back alarms (FWU and FWF). 11.1 BAT – Battery Level 11.1.1 Description The battery level alarm source ensures that the battery charge is within expected levels. A battery charge outside configured interval might mean that the battery is drained and needs replacement. 11.1.2 Threshold Usage By default, both upper and lower thresholds are used in the BAT alarm. 11.1.3 Time Time threshold defines how many seconds the alarm should be measured as in error before an alarm is triggered. 11.1.4 Upper Upper threshold is maximum voltage level * 10 of the battery charge before an alarm is triggered. For example, configuring the upper level as 126 means that if battery charge exceeds 12.6 V, an alarm is triggered. 11.1.5 Lower Lower threshold is minimum voltage level * 10 of the battery charge before an alarm is triggered. For example, configuring the lower level as 92 means that if battery charge drops below 9.2 V, an alarm is triggered. 11.2 COM – Communications with Active Devices 11.2.1 Description The repeater controller communicates with active devices using a serial bus. In case there is a failure in communications with an active device it might indicate that the active device or bus is broken, or that there is a configurations error. COM alarm is triggered on failure in communication with Rack Communication Boards (RCB), Splitter Boards (SPLIT), Combiner Boards (COMB) and FiberOptic Master Units (FOMASTER). 11.2.2 Threshold Usage This is a digital measurement, i.e, upper and lower thresholds are ignored. 11.2.3 Time Time threshold configures how many failed communication attempts in a row that is allowed before an alarm is triggered. 11.2.4 Upper Not used. 31(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 11.2.5 Lower Not used. 11.3 CRC – EEPROM CRC Check in Active Devices 11.3.1 Description On a regular interval, the controller polls the active devices for the Checksum of the EEPROM (where all radio parameters are stored). If CRC differs from expected CRC, an alarm is triggered. This status is checked in EEPROM of the Rack Communication Boards (RCB), Splitter Boards (SPLIT), Combiner Boards (COMB) and FiberOptic Modules (FOMASTER). If a failure is detected, the CRC error is flagged in the EEPROM of the active device so that alarm status is known even after a power failure. CRC alarms normally indicates a failing EEPROM and that module should be replaced. 11.3.2 Threshold Usage This is a digital measurement, i.e, upper and lower thresholds are ignored. 11.3.3 Time Time threshold configures after how many seconds in error the CRC alarm should be triggered. Normally this is set to 1 (one). 11.3.4 Upper Not used. 11.3.5 Lower Not used. 11.4 ILD – Input Signal Level Downlink 11.4.1 Description The Optical Master Unit can be configured to monitor the input signal level after the input attenuator. This is used to ensure that signals from the donor (BTS or antennas) always are above a defined level. If input signal level drops it means that output power for repeaters in the system will drop too, causing decreased coverage. 11.4.2 Threshold Usage By default, only lower threshold is configured, but it is possible to configure upper thresholds too. 11.4.3 Time Defines after how many consecutive seconds outside allowed interval that an alarm should be triggered. 11.4.4 Upper Defines above what downlink input signal level in dBm * 10 that an alarm should be triggered. 11.4.5 Lower Defines below what downlink input signal level in dBm * 10 that an alarm should be triggered. For example, configuring lower threshold as -40 means that if input signal level drops below -4.0 dBm, an alarm will be triggered. Note! If defining the threshold lower than lowest detectable level (as investigated with attribute RFS), alarm source will always be measured as OK. 32(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 11.5 NCO – Node Communications Status 11.5.1 Description If Optical Master Unit is configured as a node master monitoring a number of slave repeaters over the optical fiber, this alarm is used to indicate status of the actual communication. A communications alarm might indicate that fiber connection is unplugged or that repeater is down. 11.5.2 Threshold Usage This is a status measurement, either OK or ERROR. Hence, upper and lower thresholds are ignored. 11.5.3 Time Time threshold configures after how many consecutive communication errors with node that an alarm should be triggered. 11.5.4 Upper Not used. 11.5.5 Lower Not used. 11.6 PW1 – Power Supply 1 11.6.1 Description The Power Supply 1 is the +28 V distribution as measured in the in the Rack Communication Board in the different racks of the Optical Master Unit. If level is outside configured interval, an alarm is triggered. 11.6.2 Threshold Usage By default, both upper and lower thresholds are used in the PW1 alarm. 11.6.3 Time Time threshold defines how many seconds the alarm should be measured as in error before an alarm is triggered. 11.6.4 Upper Upper threshold is maximum voltage level * 10 of the power supply before an alarm is triggered. For example, configuring the upper level as 295 means that if voltage level exceeds 29.5 V, an alarm is triggered. 11.6.5 Lower Lower threshold is minimum voltage level * 10 of the power supply before an alarm is triggered. For example, configuring the lower level as 270 means that if voltage level drops below 27.0 V, an alarm is triggered. 11.7 PW2 – Power Supply 2 11.7.1 Description The Power Supply 1 is the +15 V distribution as measured in the in the Rack Communication Board in the different racks of the Optical Master Unit. If level is outside configured interval, an alarm is triggered. 33(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 11.7.2 Threshold Usage By default, both upper and lower thresholds are used in the PW2 alarm. 11.7.3 Time Time threshold defines how many seconds the alarm should be measured as in error before an alarm is triggered. 11.7.4 Upper Upper threshold is maximum voltage level * 10 of the power supply before an alarm is triggered. For example, configuring the upper level as 155 means that if voltage level exceeds 15.5 V, an alarm is triggered. 11.7.5 Lower Lower threshold is minimum voltage level * 10 of the power supply before an alarm is triggered. For example, configuring the lower level as 143 means that if voltage level drops below 14.3 V, an alarm is triggered. 11.8 PW3 – Power Supply 3 11.8.1 Description The Power Supply 1 is the +6.45 V distribution as measured in the Rack Communication Boards, Splitter Boards and Combiner Boards in the different racks of the Optical Master Unit. If level is outside configured interval, an alarm is triggered. 11.8.2 Threshold Usage By default, both upper and lower thresholds are used in the PW3 alarm. 11.8.3 Time Time threshold defines how many seconds the alarm should be measured as in error before an alarm is triggered. 11.8.4 Upper Upper threshold is maximum voltage level * 100 of the power supply before an alarm is triggered. For example, configuring the upper level as 660 means that if voltage level exceeds 6.60 V, an alarm is triggered. 11.8.5 Lower Lower threshold is minimum voltage level * 100 of the power supply before an alarm is triggered. For example, configuring the lower level as 610 means that if voltage level drops below 6.10 V, an alarm is triggered. 11.9 PW4 – Power Supply 4 11.9.1 Description The Rack Communications Board in rack 1 constantly monitors the backed up 6.45 V power supply level feeding the controller, modem and Rack Communications Board. If the level increases above or drops below configured thresholds, an alarm is triggered. PW4 alarm is measured in Rack Communications Board (RCB). Note! Since controller runs on this power supply, it is only possible to alarm when power supply changes slightly, not when it disappears completely. 11.9.2 Threshold Usage By default, both upper and lower thresholds are used in the PW4 alarm. 34(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 11.9.3 Time Time threshold defines how many seconds the alarm should be measured as in error before an alarm is triggered. 11.9.4 Upper Upper threshold is maximum voltage level * 100 of the power supply before an alarm is triggered. For example, configuring the upper level as 660 means that if voltage level exceeds 6.60 V, an alarm is triggered. 11.9.5 Lower Lower threshold is minimum voltage level * 100 of the power supply before an alarm is triggered. For example, configuring the lower level as 610 means that if voltage level drops below 6.10 V, an alarm is triggered. 11.10RBT – Radio Board Temperature 11.10.1Description Temperature is constantly monitored on the Rack Communications Board (RCB) and in the FiberOptic Masters (FOMASTER). An alarm will be triggered temperature board temperature is outside allowed interval. A radio board with a too high temperature might cause decreased radio performance and will lower MTBF on the entire Optical Master Unit. 11.10.2Threshold Usage By default, both upper and lower thresholds are used in the RBT alarm. 11.10.3Time Time threshold defines how many seconds the alarm should be measured as in error before an alarm is triggered. 11.10.4Upper Upper threshold is maximum temperature in Celsius * 10 allowed on the board before an alarm is triggered. For example, upper threshold set to 750 means that if board temperature increases above 75.0 Celsius, an alarm is triggered. 11.10.5Lower Lower threshold is minimum temperature in Celsius * 10 allowed on the board before an alarm is triggered. For example, lower threshold set to -100 means that if board temperature drops below -10.0 Celsius, an alarm is triggered. 11.11RXO - Recieved Optical Level 11.11.1Description The Fiber Optic Masters constantly monitors received optical level. A too low optical input level might indicate that there is something wrong with the slave transmitter, a bad optical connection (poor soldering or cleaning) or a broken fiber. 11.11.2Threshold Usage By default, only lower threshold is used. 11.11.3Time Time threshold defines how many seconds the alarm should be measured as in error before an alarm is triggered. 35(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 11.11.4Upper Not used. 11.11.5Lower Defines the lowest acceptable optical level in dBm * 10 before an alarm is triggered. For example, setting Lower alarm threshold to -20 means that if optical input level drops below -2.0 dBm, an alarm is triggered. 11.12SZP – Synthesizer Pilot Tone Generator 11.12.1Description When commissioning an Axell Wireless Repeater System it is essential that all fiber optic links are optimized and RF-limits adjusted. To accomplish this, a pilot tone is transmitted from Optical Master Unit to the Fiber Optic Slaves, and upon request by Fiber Optic Slaves to Optical Master Unit. By transmitting with a known level, it is possible to read out the path loss by monitoring the received pilot tone level. To generate the correct pilot tone frequency, a synthesizer is used. If there is a failure generating the correct pilot tone frequency, an Synthesizer Pilot Tone generator alarm is generated. 11.12.2Threshold Usage This is a digital measurement, i.e, upper and lower thresholds are ignored. 11.12.3Time Time threshold configures how many seconds the synthesizer should be unlocked before an alarm is triggered. 11.12.4Upper Not used. 11.12.5Lower Not used. 11.13TEM – Controller Temperature 11.13.1Description In order to know that repeater works in an allowed temperature range, the controller contains a temperature sensor that continuously is polled. If temperature goes outside configured thresholds, an alarm is triggered. 11.13.2Threshold Usage Both upper and lower temperature can be monitored. 11.13.3Time Time threshold configures how many seconds the synthesizer should be unlocked before an alarm is triggered. 11.13.4Upper Defines above what temperature in Celsius * 10 that an alarm is triggered. For example, by defining upper threshold as 650, an alarm is triggered if temperature exceeds 65.0 Celsius. 36(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 11.13.5Lower Defines below what temperature in Celsius * 10 that an alarm is triggered. For example, by defining lower threshold as -250, an alarm is triggered if temperature in controller drops below -25.0 C. 11.14TXO – Transmitted Optical Level 11.14.1Description Transmitted optical power level is constantly monitored to ensure functionality of the system. In case the optical transmitter for some reason fails (hardware failure), an alarm is triggered. 11.14.2Threshold Usage This is a digital measurement, i.e, upper and lower thresholds are ignored. 11.14.3Time Time threshold configures how many seconds the optical transmitter should be in error before an alarm is triggered. 11.14.4Upper Not used. 11.14.5Lower Not used. 37(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 12 HEARTBEAT FORMAT The heartbeat report is transmitted to the Axell Element Manager on configurable intervals (0-99 999 min). In case the heartbeat report is not received by the Axell Element Manager within expected interval, an alarm is triggered at the AEM. If optical master unit is configured as a node master, heartbeats are collected from all slaves for transmission to the Axell Element Manager. In the heartbeat report, all fields are separated by space. Field Format Repeater ID XX-YYZZZZ NNNNNNN NN STATE DDMMYY HHMMSS JJKKLLMM Attenuation in downlink for Splitter Boards 1-4, zero padded. JJKKLLMM Attenuation in uplink for Combiner Boards 1-4, zero padded. Status of Battery Charge NNNN Status of communication with Rack Communication Boards NNNN Status of communication with Splitter Boards NNNN Status of communication with Combiner Boards NNNNNN Status of communication with FiberOptic Modules in Rack 1 NNNNNN Status of communication with FiberOptic Modules in Rack 2 NNNNNN Status of communication with FiberOptic Modules in Rack 3 NNNNNN Status of communication with FiberOptic Modules in Rack 4 JKLMNXYZ Status of CRC in the different modules. These values are Hex Coded, and should be used in conjunction with COM status for actual device. For example, the Byte 1 status is sent as Hex ‘8’, which is extracted to 1000. Byte 1 Message no State Date Time ATD ATU BAT COM-RCB COM-SPLIT COM-COMB COM-FO Rack 1 COM-FO Rack 2 COM-FO Rack 3 COM-FO Rack 4 CRC Description Bit 3 Bit 2 Bit 1 # of chars 10 Bit 0 CRC for CRC for CRC for CRC for RCB in RCB in RCB in RCB Rack 1 Rack 2 Rack 3 Rack 4 Byte 2 38(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 Bit 3 Bit 2 Bit 1 Bit 0 CRC for CRC for CRC for CRC for Split in Split in Split in Split in Rack 1 Rack 2 Rack 3 Rack 4 Byte 3 Bit 3 Bit 2 Bit 1 Bit 0 CRC for CRC for CRC for CRC for Comb in Comb in Comb in Comb in Rack 1 Rack 2 Rack 3 Rack 4 Byte 4 Bit 3 Bit 2 Bit 1 Bit 0 CRC for CRC for CRC for CRC for Rack 1 Rack 1 Rack 1 Rack 1 Slot 1 Slot 2 Slot 3 Slot 4 Byte 5 Bit 3 Bit 2 Bit 1 Bit 0 CRC for CRC for CRC for CRC for Rack 1 Rack 1 Rack 2 Rack 2 Slot 5 Slot 6 Slot 1 Slot 2 Byte 6 Bit 3 Bit 2 Bit 1 Bit 0 CRC for CRC for CRC for CRC for Rack 2 Rack 2 Rack 2 Rack 2 Slot 3 Slot 4 Slot 5 Slot 6 Byte 7 Bit 3 Bit 2 Bit 1 Bit 0 CRC for CRC for CRC for CRC for Rack 3 Rack 3 Rack 3 Rack 3 Slot 1 Slot 2 Slot 3 Slot 4 Byte 8 Bit 3 Bit 2 Bit 1 Bit 0 CRC for CRC for CRC for CRC for Rack 3 Rack 3 Rack 4 Rack 4 Slot 5 Slot 6 Slot 1 Slot 2 Byte 9 Bit 3 Bit 2 Bit 1 Bit 0 CRC for CRC for CRC for CRC for Rack 4 Rack 4 Rack 4 Rack 4 Slot 3 Slot 4 Slot 5 Slot 6 39(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 NCO KLMNXY Version: 1.0 Status of communication with the node 6 slaves. These values are Hex Coded, and should be used in conjunction with NON attribute to know how many nodes are installed. For example, the Byte 1 status is sent as Hex ‘8’, which is extracted to 1000. Byte 1 Bit 3 Bit 2 Bit 1 Bit 0 NCO for node 1 NCO for node 2 NCO for node 3 NCO for node 4 Bit 3 Bit 2 Bit 1 Bit 0 NCO for node 5 NCO for node 6 NCO for node 7 NCO for node 8 Bit 3 Bit 2 Bit 1 Bit 0 NCO for node 9 NCO NCO NCO for for for node 10 node 11 node 12 Byte 2 Byte 3 Byte 4 Bit 3 Bit 2 Bit 1 Bit 0 NCO NCO NCO NCO for for for for node 13 node 14 node 15 node 16 Byte 5 Bit 3 Bit 2 Bit 1 Bit 0 NCO NCO NCO NCO for for for for node 17 node 18 node 19 node 20 Byte 6 Bit 3 Bit 2 Bit 1 Bit 0 NCO NCO NCO NCO for for for for node 21 node 22 node 23 node 24 PW1 NNNN PW2 NNNN PW3 NNN Status of 28 V Power Supply distribution Status of 15 V Power Supply distribution Status of 6.45 V Power Supply distribution as measured in RCB, Splitter and Combiner. These values are Hex Coded, and should 40(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 be used in conjunction with COM status for actual device. For example, the Byte 1 status is sent as Hex ‘8’, which is extracted to 1000. Byte 1 Bit 3 Bit 2 Bit 1 Bit 0 PW3 for PW3 for PW3 for PW3 for RCB in RCB in RCB in RCB Rack 1 Rack 2 Rack 3 Rack 4 Byte 2 Bit 3 Bit 2 Bit 1 Bit 0 PW3 for PW3 for PW3 for PW3 for Split in Split in Split in Split in Rack 1 Rack 2 Rack 3 Rack 4 Byte 3 Bit 3 Bit 2 Bit 1 Bit 0 PW3 for PW3 for PW3 for PW3 for Comb in Comb in Comb in Comb in Rack 1 Rack 2 Rack 3 Rack 4 PW4 RBT KLMNXYZ Status of 6.45 V Backup Power Supply 1 distribution Status of board temperatures in the different modules. These values are Hex Coded, and should be used in conjunction with COM status for actual device. For example, the Byte 1 status is sent as Hex ‘8’, which is extracted to 1000. Byte 1 Bit 3 Bit 2 Bit 1 Bit 0 RBT for RBT for RBT for RBT for RCB in RCB in RCB in RCB Rack 1 Rack 2 Rack 3 Rack 4 Byte 2 Bit 3 Bit 2 Bit 1 Bit 0 RBT for RBT for RBT for RBT for Rack 1 Rack 1 Rack 1 Rack 1 Slot 1 Slot 2 Slot 3 Slot 4 Byte 3 Bit 3 Bit 2 Bit 1 Bit 0 RBT for RBT for RBT for RBT for Rack 1 Rack 1 Rack 2 Rack 2 Slot 5 Slot 6 Slot 1 Slot 2 Byte 4 Bit 3 Bit 2 Bit 1 Bit 0 41(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 RBT for RBT for RBT for RBT for Rack 2 Rack 2 Rack 2 Rack 1 Slot 3 Slot 4 Slot 5 Slot 6 Byte 5 Bit 3 Bit 2 Bit 1 Bit 0 RBT for RBT for RBT for RBT for Rack 3 Rack 3 Rack 3 Rack 3 Slot 1 Slot 2 Slot 3 Slot 4 Byte 6 Bit 3 Bit 2 Bit 1 Bit 0 RBT for RBT for RBT for RBT for Rack 3 Rack 3 Rack 4 Rack 4 Slot 5 Slot 6 Slot 1 Slot 2 Byte 7 Bit 3 Bit 2 Bit 1 Bit 0 RBT for RBT for RBT for RBT for Rack 4 Rack 4 Rack 4 Rack 4 Slot 3 Slot 4 Slot 5 Slot 6 RXO KLMNXY Status of recieved optical level. These values are Hex Coded, and should be used in conjunction with COM status for actual device. For example, the Byte 1 status is sent as Hex ‘8’, which is extracted to 1000. Byte 1 Bit 3 Bit 2 Bit 1 Bit 0 RXO for Rack 1 Slot 1 RXO for Rack 1 Slot 2 RXO for Rack 1 Slot 3 RXO for Rack 1 Slot 4 Bit 3 Bit 2 Bit 1 Bit 0 RXO for Rack 1 Slot 5 RXO for Rack 1 Slot 6 RXO for Rack 2 Slot 1 RXO for Rack 2 Slot 2 Bit 3 Bit 2 Bit 1 Bit 0 RXO for Rack 2 Slot 3 RXO for Rack 2 Slot 4 RXO for Rack 2 Slot 5 RXO for Rack 1 Slot 6 Bit 3 Bit 2 Bit 1 Bit 0 RXO RXO RXO RXO Byte 2 Byte 3 Byte 4 42(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 for Rack 3 Slot 1 for Rack 3 Slot 2 for Rack 3 Slot 3 for Rack 3 Slot 4 Bit 3 Bit 2 Bit 1 Bit 0 RXO for Rack 3 Slot 5 RXO for Rack 3 Slot 6 RXO for Rack 4 Slot 1 RXO for Rack 4 Slot 2 Bit 3 Bit 2 Bit 1 Bit 0 RXO for Rack 4 Slot 3 RXO for Rack 4 Slot 4 RXO for Rack 4 Slot 5 RXO for Rack 4 Slot 6 Byte 5 Byte 6 SZP KLMNXY Status of Synthesizer in Pilot Tone Generator. These values are Hex Coded, and should be used in conjunction with COM status for actual device. For example, the Byte 1 status is sent as Hex ‘8’, which is extracted to 1000. Byte 1 Bit 3 Bit 2 Bit 1 Bit 0 SZP for Rack 1 Slot 1 SZP for Rack 1 Slot 2 SZP for Rack 1 Slot 3 SZP for Rack 1 Slot 4 Bit 3 Bit 2 Bit 1 Bit 0 SZP for Rack 1 Slot 5 SZP for Rack 1 Slot 6 SZP for Rack 2 Slot 1 SZP for Rack 2 Slot 2 Bit 3 Bit 2 Bit 1 Bit 0 SZP for Rack 2 Slot 3 SZP for Rack 2 Slot 4 SZP for Rack 2 Slot 5 SZP for Rack 1 Slot 6 Bit 3 Bit 2 Bit 1 Bit 0 SZP for Rack 3 Slot 1 SZP for Rack 3 Slot 2 SZP for Rack 3 Slot 3 SZP for Rack 3 Slot 4 Bit 3 Bit 2 Bit 1 Bit 0 SZP for SZP for SZP for SZP for Byte 2 Byte 3 Byte 4 Byte 5 43(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 Version: 1.0 Rack 3 Slot 5 Rack 3 Slot 6 Rack 4 Slot 1 Rack 4 Slot 2 Bit 3 Bit 2 Bit 1 Bit 0 SZP for Rack 4 Slot 3 SZP for Rack 4 Slot 4 SZP for Rack 4 Slot 5 SZP for Rack 4 Slot 6 Byte 6 TEM TXO KLMNXY Status of Controller Temperature Status of Optical Transmitter These values are Hex Coded, and should be used in conjunction with COM status for actual device. For example, the Byte 1 status is sent as Hex ‘8’, which is extracted to 1000. Byte 1 Bit 3 Bit 2 Bit 1 Bit 0 TXO for TXO for TXO for TXO for Rack 1 Rack 1 Rack 1 Rack 1 Slot 1 Slot 2 Slot 3 Slot 4 Byte 2 Bit 3 Bit 2 Bit 1 Bit 0 TXO for TXO for TXO for TXO for Rack 1 Rack 1 Rack 2 Rack 2 Slot 5 Slot 6 Slot 1 Slot 2 Byte 3 Bit 3 Bit 2 Bit 1 Bit 0 TXO for TXO for TXO for TXO for Rack 2 Rack 2 Rack 2 Rack 1 Slot 3 Slot 4 Slot 5 Slot 6 Byte 4 Bit 3 Bit 2 Bit 1 Bit 0 TXO for TXO for TXO for TXO for Rack 3 Rack 3 Rack 3 Rack 3 Slot 1 Slot 2 Slot 3 Slot 4 Byte 5 Bit 3 Bit 2 Bit 1 Bit 0 TXO for TXO for TXO for TXO for Rack 3 Rack 3 Rack 4 Rack 4 Slot 5 Slot 6 Slot 1 Slot 2 Byte 6 Bit 3 Bit 2 Bit 1 Bit 0 TXO for TXO for TXO for TXO for Rack 4 Rack 4 Rack 4 Rack 4 Slot 3 Slot 4 Slot 5 Slot 6 44(45) Document name: OMU Commands and Attributes 1.0.0 v1.0 ILD NNNN EX1/EX2/EX3/ EX4 NON RCH Version: 1.0 NNNN Status of Input Level Downlink as measured in Splitters 1-4 Status of external alarm inputs NN NNNNNN Number of nodes monitored. Repetition Cycle for Heartbeat reports 45(45)