REVISIONS LTR DESCRIPTION DATE APPROVED - Initial Release 11/5/07 MDB A ECR 8770 4/9/08 MDB CONTRACT NO. DRAWN BY CHECKED BY APPROVED BY DATE P. Phillips 11/2/07 TITLE M. Bester 11/5/07 SIZE A 2120 Old Gatesburg Road State College, PA 16803 Frequency Reference System Model RMR-1004 User Communication Specification FSCM NO. 4NN85 DWG. NO. DCOM-21126 FILENAME: DCOM-21126_A.doc SHEET 1 OF 10
Table of Contents 1 Introduction... 3 2 Network Interface... 3 2.1 MIB Structure... 3 2.2 SNMP Message Details... 5 2.2.1 Reset Unit Command (.1) Write Only... 5 2.2.2 Product Type (.2) Read Only... 5 2.2.3 Active Faults Table (.3) Read Only... 5 2.2.4 Reset Latched Faults Command (.4) Write Only... 5 2.2.5 Unit Serial Number (.5) Read Only... 5 2.2.6 Reference Mode (.6) Read Only... 5 2.2.7 Detail Fault Flags (.7) Read Only... 5 2.2.8 Event Log (.8) Read Only... 6 2.2.9 Power Supply Voltages (.9) Read Only... 7 2.2.10 Operation Time (.10) Read Only... 8 2.2.11 Firmware Version (.11) Read Only... 8 2.2.12 Power-Up Warning (.12) Read/Write... 8 2.2.13 External Reference Frequency (.13) Read/Write... 8 2.2.14 Remote/Local Mode (.14) Read/Write... 8 2.2.15 Band Switch Position (.15) Read/Write... 8 2.2.16 Power Switch Position (.16) Read/Write... 9 2.2.17 LNB RF Attenuation (.17) Read/Write... 9 2.2.18 MAC Info (.18) Read Only... 9 2.2.19 LNB PS Voltage Set-Point (.19) Read/Write... 9 2.2.20 10 MHz Frequency Calibration (.20) Read/Write... 9 3 Web-Page Interface (HTTP)... 10 3.1 Home Page... 10 3.2 Network Setting Page... 10 3.3 Calibration Page... 10 List of Tables Table 2.1 RMR-1004 MIB Structure...3 Table 2-2 Event Codes...7 Page 2 of 10
Frequency Reference System Model RMR-1004 User Communication Specification 1 Introduction The RMR-1004 network interface supports Simple Network Management Protocol version 1 (SNMPv1), which is defined in RFC 1157 and is a full IETF standard. Its security is based on communities, which are nothing more than passwords plain-text strings that allow any SNMP-based application that knows the strings to gain access to a device s management information. There are typically three communities in SNMPv1: read-only, read-write, and trap (not supported by the RMR-1004). Read-only items would contain status information of the product such as power supply voltages or fault codes. The read-write items would contain controls such as attenuation settings and band-select settings. The customer must supply their own third-party PC software in order to communicate with the unit via the network interface. These software packages are called SNMP Managers and can be purchased or developed in-house. A management information block (MIB) file will be made available to the customer. This file is needed in order for the SNMP Manager software to understand what data is available from the product and where it is located. 2 Network Interface 2.1 MIB Structure The Ethernet interface uses the industry-standard SNMP protocol to control and monitor the RMR-1004. The SNMP Management Information Block (MIB) defines the address of each of the settings, controls, or commands. The MIB address for the RMR-1004 is prefixed with the following:.iso.org.dod.internet.private.enterprises.vertexrsi.vertexrsiproducts.rmr (1.3.6.1.4.1.1414.2.8) Each setting, control, or command is addressed using an address appended to this prefix. MIB addresses are represented in decimal. Table 2-1 lists the settings, controls, and commands that can be accessed through the Ethernet interface. Table 2-1. RMR-1004 MIB Structure MIB Address Access Mode Data Type Name Description.1 W INTEGER Unit Reset Command See Section 2.2.1.2 R INTEGER Product Type See Section 2.2.2.3 NA NULL Active Faults Table * See Section 2.2.3.3.0 R INTEGER Power-Up Warning.3.1 R INTEGER Logic Board Fault.3.2 R INTEGER Main Power Supply Fault.3.3 R INTEGER LNB Power Supply Fault.4 W INTEGER Fault Reset Command See Section 2.2.4.5 R STRING Unit Serial Number See Section 2.2.5.6 R INTEGER Reference Mode See Section 2.2.6.7 NA NULL Detailed Fault Table * See Section 2.2.7.7.0 R INTEGER NVRAM Fault.7.1 R INTEGER Power-Up Warning.7.2 R INTEGER Main Power Supply #1 V High Fault Page 3 of 10
MIB Address Access Mode Table 2-1. RMR-1004 MIB Structure Data Type Name Description.7.3 R INTEGER Main Power Supply #1 V Low Fault.7.4 R INTEGER Main Power Supply #2 V High Fault Not enabled in the RMR-1004.7.5 R INTEGER Main Power Supply #2 V Low Fault Not enabled in the RMR-1004.7.6 R INTEGER LNB Power Supply V High Fault.7.7 R INTEGER LNB Power Supply V Low Fault.7.8 R INTEGER LNB Fuse Fault.7.9 R INTEGER LNB Power Supply I High Fault.7.10 R INTEGER LNB Power Supply I Low Fault.7.11 R INTEGER RF Amp Power Supply V Low Fault.7.12 R INTEGER RF Amp Power Supply V High Fault.8 NA NULL Event Log Table See Section 2.2.8.8.0.0 R INTEGER Event Code #1.8.1.0 R INTEGER Event Code #2.8.2.0 R INTEGER Event Time Days.8.3.0 R INTEGER Event Time Hours.8.4.0 R INTEGER Event Time Minutes.8.5.0 R INTEGER Event Time Seconds.9 NA NULL Power Supply Table See Section 2.2.9.9.0 R INTEGER Main Power Supply #1 Voltage.9.1 R INTEGER Main Power Supply #2 Voltage.9.2 R INTEGER LNB Power Supply Voltage.9.3 R INTEGER LNB Power Supply Current.9.4 R INTEGER RF Amp Power Supply Voltage.10 NA NULL Run Time Table See Section 2.2.10.10.0 R INTEGER Days.10.1 R INTEGER Hours.10.2 R INTEGER Minutes.10.3 R INTEGER Seconds.11 R INTEGER Version See Section 2.2.11.12 RW INTEGER Power-up Warning Enable See Section 2.2.12.13 RW INTEGER External Reference Frequency See Section 2.2.13.14 RW INTEGER Control Mode See Section 2.2.14.15 RW INTEGER Band Switch Position See Section 2.2.15.16 RW INTEGER Power Switch Position See Section 2.2.16.17 RW INTEGER LNB RF Attenuation See Section 2.2.17.18 R STRING MAC Information See Section 2.2.18.19 RW INTEGER LNB PS Voltage Setpoint See Section 2.2.19.20 RW INTEGER 10MHz Frequency Calibration See Section 2.2.20 * Fault and status flag indicators: -1 = Unavailable or unknown, 0 = Inactive or Off, 1 = Active or On. Page 4 of 10
2.2 SNMP Message Details 2.2.1 Reset Unit Command (.1) Write Only Sending any non-zero value to the Reset Unit Command instance will cause the main processor to reset. During a reset, the RMR-1004 Ethernet connection will be disconnected. If the Ethernet mode was set to DHCP, the RMR-1004 may be assigned a new IP address upon reset. 2.2.2 Product Type (.2) Read Only This message contains the product code of the RMR-1004. The product code is decimal 80 and is assigned at the factory. The product type code can not be changed by the user. 2.2.3 Active Faults Table (.3) Read Only The Active Fault Flags contain top-level fault information. If a fault occurs, the corresponding fault flag will be active until the fault stops occurring and the user sends a Reset Latched Faults Command. The Detailed Fault Flags instance contains more detailed fault information that the user may query. Each flag may be in one of three states: Unavailable (-1) The fault status cannot be determined. Inactive (0) The corresponding fault hasn t occurred. Active (1) The corresponding fault has occurred. The following are the fault flag instances that may be read:.3.0 Power-Up Warning: If the power-up warning setting is enabled, this flag will be active whenever the unit is power-cycled..3.1 Logic Board Fault: A logic board fault has occurred..3.2 Main Power Supply Fault: A main power supply limit has been exceeded..3.3 LNB Power Supply Fault: An LNB power supply limit has been exceeded. 2.2.4 Reset Latched Faults Command (.4) Write Only Sending a non-zero value to the Reset Latched Faults Command instance will clear any latched faults contained in the Fault Summary Flags instance or the Detailed Fault Flags instance that are not presently occurring. Faults that are cleared will revert back to the inactive state. 2.2.5 Unit Serial Number (.5) Read Only The Unit Serial Number instance contains the RMR-1004 unit serial number. The serial number is 10 ASCII characters in length and is assigned at the factory. The serial number can not be changed by the user. 2.2.6 Reference Mode (.6) Read Only The Reference Mode instance contains the current status of the reference. The reference may be either Internal (0) or External (1) mode. If a usable external reference signal is detected, the reference mode will be External. If a usable external reference signal isn t detected, the internal 10 MHz reference will be enabled. If the Reference Mode cannot be determined, it will be reported as Unavailable (-1). 2.2.7 Detail Fault Flags (.7) Read Only The Detailed Fault Flags instance contains the most detailed fault information that is available from the RMR- 1004 unit. If a fault occurs, the corresponding fault flag will be active until the fault stops occurring and the user sends a Reset Latched Faults Command. Each flag may be in one of three states: Unavailable (-1) The fault status cannot be determined. Inactive (0) The corresponding fault hasn t occurred. Active (1) The corresponding fault has occurred. Page 5 of 10
The following are the fault flag instances that may be read:.7.0 NVRAM Fault: The NVRAM device located on the logic board has failed..7.1 Power-Up Warning: If the power-up warning setting is enabled, this flag will be active whenever the unit is power-cycled..7.2 Main PS #1 Voltage High Fault: The main power supply has exceeded its upper threshold limit..7.3 Main PS #1 Voltage Low Fault: The main power supply has gone below its lower threshold limit..7.4 Main PS #2 Voltage High Fault: Not enabled in the RMR-1004; always reported as Unavailable (-1)..7.5 Main PS #2 Voltage Low Fault: Not enabled in the RMR-1004; always reported as Unavailable (-1)..7.6 LNB PS Voltage High Fault: The LNB power supply voltage has exceeded its upper threshold limit..7.7 LNB PS Voltage Low Fault: The LNB power supply voltage has gone below its lower threshold limit..7.8 LNB PS Poly-Fuse Tripped: The inline LNB power supply poly-fuse has tripped..7.9 LNB PS Current High Fault: The LNB power supply current has exceeded its upper threshold limit..7.10 LNB PS Current Low Fault: The LNB power supply current has gone below its lower threshold limit..7.11 RF Amplifier PS Voltage Low Fault: The RF amplifier power supply voltage has gone below its lower threshold limit..7.12 RF Amplifier PS Voltage High Fault: The RF amplifier power supply voltage has exceeded its upper threshold limit. 2.2.8 Event Log (.8) Read Only The Event Log instance contains 32 event log entries. Each entry contains an event code. The event code consists of two values as defined in the Event Codes table, below. Each log entry also contains a sub-entry for the time-stamp of when the event occurred. For example, if the first event log entry contained a Main Power Supply Voltage High fault that occurred after the unit had been powered-on for 1 day, 4 hours, 3 minutes, and 34 seconds, the entry would appear as:.8.0.0 = 17 (Event Code #1).8.1.0 = 48 (Event Code #2).8.2.0 = 1 (Days).8.3.0 = 4 (Hours).8.4.0 = 3 (Minutes).8.5.0 = 34 (Seconds) Any blank entries in the Event Log will contain a value of 255. Table 2-2 lists the event codes that are returned in response to the event log message. They represent every fault condition detectable by the unit. Page 6 of 10
Table 2-2. Event Codes Event Code #1 #2 Description 16 48 16 49 17 48 17 49 18 48 18 49 19 48 19 49 19 50 20 48 20 49 20 50 20 51 20 52 NVRAM Fail The non-volatile memory has failed. Power Up This warning is generated each time the logic board is powered-up. This may be useful to indicate whether power to the unit has been interrupted while an operator is not present. This warning may be disabled. Main Supply #1 Voltage High The output of the main power supply has gone above a predefined upper limit threshold. Main Supply #1 Voltage Low The output of the main power supply has gone below a predefined upper limit threshold. Main Supply #2 Voltage High Not enabled in the RMR-1004. Main Supply #2 Voltage Low Not enabled in the RMR-1004. RF Amplifier Supply Voltage High The output of the RF amplifier power supply has gone above a predefined upper limit threshold. RF Amplifier Supply Voltage Low The output of the RF amplifier power supply has gone below a predefined upper limit threshold. RF Amplifier Poly-Fuse Tripped The in-line RF amplifier power supply poly-fuse has opened. LNB Supply Voltage High The output of the LNB power supply has gone above a predefined upper limit threshold. LNB Supply Voltage Low The output of the LNB power supply has gone below a predefined upper limit threshold. LNB Poly-Fuse Tripped The in-line LNB power supply poly-fuse has opened. LNB Supply Current Low The current output of the LNB power supply has gone above a predefined upper limit threshold. LNB Supply Current High The current output of the LNB power supply has gone below a predefined upper limit threshold. 2.2.9 Power Supply Voltages (.9) Read Only The Power Supply Voltages instance contains the measured voltage of the main power supply (+24 VDC), the LNB power supply voltage, the LNB power supply current draw, and the RF amplifier power supply voltage. Each power supply has pre-defined upper and lower measurement limits. If the measured voltage or current goes outside these limits, a corresponding fault will occur. The following are the power supply voltage or current instances that may be read:.9.0 Main Power Supply Voltage #1: Main power supply #1 voltage measurement in volts x 100..9.1 Main Power Supply Voltage #2: (Used for units that have two power supplies.) Main power supply #2 voltage measurement in volts x 100. The RMR-1004 has only one main power supply, so this value is reported as 0 volts..9.2 LNB Power Supply Voltage: LNB power supply voltage measurement in volts x 100..9.3 LNB Power Supply Current: LNB power supply current measurement in milliamps. Page 7 of 10
.9.4 RF Amp Power Supply Voltage: RF amplifier power supply voltage measurement in volts x 100. Note that the voltage measurements are reported as x 100 to obtain integer values of measurements to hundredths of a volt (n.nn); current is reported in milliamps and is not scaled. 2.2.10 Operation Time (.10) Read Only The Operation Time instance contains the total time the RMR-1004 has been powered-on. The power-on time is recorded in days, hours, minutes, seconds format. The following are the operation time instances that may be read:.10.0 Days: Number of whole days that the RMR has been powered on..10.1 Hours: Number of whole hours that the RMR has been powered on..10.2 Minutes: Number of whole minutes that the RMR has been powered on..10.3 Seconds: Number of whole seconds that the RMR has been powered on. 2.2.11 Firmware Version (.11) Read Only The Firmware Version instance contains the firmware version number. The firmware version is x100 scale. For example, a reading of 125 represents firmware version 1.25. 2.2.12 Power-Up Warning (.12) Read/Write The Power-Up Warning instance contains the power-up warning setting. If enabled, the RMR-1004 will set the power-up warning flag whenever the unit is power-cycled. This setting may be enabled or disabled. Sending a 0 to this instance will disable the power-up warning and sending a 1 will enable the power-up warning. 2.2.13 External Reference Frequency (.13) Read/Write The External Reference Frequency instance contains the external reference frequency setting. The external reference frequency may be set for 5 MHz or 10 MHz. To set the frequency setting to 5 MHz, a 5 must be written to this instance. To set the frequency to 10 MHz, a 10 must be written to this instance. 2.2.14 Remote/Local Mode (.14) Read/Write The Remote/Local Mode instance contains the RMR-1004 control mode setting. In Local mode, the RMR-1004 front-panel band select switch is operational. While in Local mode, the system status can be monitored via the Ethernet interface. Any commands issued via the Ethernet interface will be ignored, except for the command to switch to Remote mode. In Remote mode, the RMR-1004 front-panel band select switch is not operational and the Ethernet interface can be used to monitor system status and issue commands. To set the RMR to Local mode, a 0 must be set to this instance, or the Local mode must be selected from the front panel push button switch. To set the RMR-1004 to Remote mode, a 1 must be set to this instance, or the Remote mode must be selected from the front panel push button switch. 2.2.15 Band Switch Position (.15) Read/Write The Band Switch Position instance contains the RMR-1004 TLNB band selection output setting. The switch may be in 1 of 3 positions. Any integer value less than 1 or greater than 3 will be ignored by the unit. 1 Band A Position. 2 Band B Position. 3 Band C Position. Page 8 of 10
2.2.16 Power Switch Position (.16) Read/Write The Power Switch Position instance contains the RMR-1004 LNB power supply switch setting. The +Vdc power supply may be turned on or off to the TLNB device. The power switch position can be set to either of two values. A value other than 0 or 1 will be ignored by the unit. 0 Power switched Off to the LNB. 1 Power switched On to the LNB. 2.2.17 LNB RF Attenuation (.17) Read/Write The LNB RF Attenuation instance contains the RF attenuation setting for the LNB RF path. This attenuation setting may be set from 0.0 db to 20.0 db in 0.5 db increments. If a value that is set isn t in 0.5 db increments, the attenuation setting will be rounded to the nearest 0.5 db increment. Any values set that are above 20.0 db will be ignored. The sent and returned values are scaled by x10 (ex: 35 = 3.5 db). 2.2.18 MAC Info (.18) Read Only The MAC Info instance contains the 6-byte MAC that has been assign to the Ethernet interface. The first 3 bytes are company specific and shall always be reported back as 00-16-3B. The last 3 bytes are assigned at the factory during production testing. The MAC is reported as a string of ASCII characters which represent the byte values as hexadecimal (base 16) numbers. 2.2.19 LNB PS Voltage Set-Point (.19) Read/Write The LNB power supply voltage may be adjusted by the user. The voltage set-point may range from 13.0 V to 20.0 V. This set-point may be adjusted in 0.5 V increments. The sent and returned values are scaled by x10 (ex: 155 = 15.5 V). 2.2.20 10 MHz Frequency Calibration (.20) Read/Write The internal 10 MHz frequency reference may be adjusted by the user. The set-point may be set to any value from 0 to 1023. Changing this value will change the reference frequency. This setting should only be modified by certified personnel using NIST traceable test equipment. This capability allows calibration to be done without removing the top cover of the unit. To calibrate the unit, a highly accurate frequency counter should be connected to one of the RMR-1004 outputs. To update the output frequency, send the new value to this address. The frequency should change immediately. The new calibration value will be stored into non-volatile memory after each update is commanded. Page 9 of 10
3 Web-Page Interface (HTTP) The RMR-1004 contains a basic web-page interface. This interface has limited capabilities. These capabilities include the ability to modify the network settings of the unit and the ability to adjust the internal 10 MHz reference oscillator. To access the main web page, use a web browser such as Firefox or Internet Explorer. Enter the IP address of the unit into the address bar of the browser in order to go to the unit s home page. 3.1 Home Page The home page displays the unit s current IP address and its factory assigned MAC address. 3.2 Network Setting Page The network settings page contains three network parameters: IP Address, Subnet Mask, and Gateway Address. These parameters will display the unit s network settings. The user may modify these setting by typing in the appropriate information and then clicking on the Update button to command the unit to update its appropriate network setting. Any network setting changes will be immediately active. If the IP address setting is changed, the user must browse to the new IP address to re-establish communications. Any network setting changes should be recorded by the user for future reference. 3.3 Calibration Page The calibration page allows the user to modify the output frequency of the internal 10 MHz reference. The calibration is implemented with an internal digital potentiometer that may be set from 0 to 1023. Changing this value will change the reference frequency. This setting should only be modified by certified personnel using NIST traceable test equipment. To calibrate the unit, a highly accurate frequency counter should be connected to one of the RMR-1004 outputs. To update the output frequency, type in a new value into the calibration text box and press the Update button. The frequency should change immediately. The new calibration value will be stored into nonvolatile memory after each Update is commanded. Page 10 of 10