Technical Service Bulletin GENERAL DYNAMICS, State College, PA Phone: 814-238-2700 TSB # 60 Fax: 814-238-6243 Per ECR # 11428 Product(s) affected: Outdoor and Antenna Mount SSPAs Description of problem: 12245 Serial I/O Protocol has errors or misleading descriptions in messages 16.55 & 16.5A. Design change to resolve problem: Updated 12245 Serial I/O Protocol to Rev I. Instructions for modification: Use revised document, see attached. Units that must be modified: None.
REVISIONS LTR A B C D E F G H I DESCRIPTION Initial Release Release version 1.4. Release version 1.51 Release version 2.0x Per ECR 5409 Release ver. 2.5x per ECR 5520 ECR 6524 (Ant/DL switch, ver. 2.62) ECR 8161 ECR 10695 ECR 11428 CONTRACT NO. DRAWN BY 5/31/00 TITLE CHECKED BY Serial I/O Protocol for Outdoor and Antenna-Mount SSPAs APPROVED BY Peter B. Trippett Firmware Rev. 3.0x and earlier 6/1/00 SIZE A FILENAME: 12245_I.
(Intentionally blank page.
Table of Contents 1 Message Framing Format............................................................................................................................................ 5 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 2 Messages...................................................................................................................................................................... 8 2.1 2.2 2.3 2.4 2.5 3 STX/ETX................................................................................
3.8.4 3.9 Get Input Voltage (16 53).....................................................................................................................24 3.8.5 Get RF Output Status (16 54) ..............................................................................................................24 3.8.6 Get 1:1 Status (16 55)..........................................................................................................................25 3.8.7 Get Firmware Version Info (16 57).........
Serial I/O comes as a standard feature. By sending and receiving commands over an RS-232, RS-485 (2-wire), RS-485 (4-wire) or RS-422 port, you can control and monitor most of the SSPA’s functions. 1 Message Framing Format This framing protocol is used for communications between a host and a unit. This is a polling protocol, meaning that units answer ONLY when they receive a correctly formatted message from the host. The same framing protocol is used for all messages to and from a unit.
1.5 Message Data The actual content of the message starts with the least significant 6 bits of Byte 4, and can be of any length up to 250 bytes (including Byte 4). An optional End Body byte may be placed in the message footer (at the end of the Message Data), in which case the maximum length of the message data is 249 bytes. The optional End Body byte is used for compatibility with earlier protocols, in which the End Body byte was required if the message data contained more bytes than byte 4.
A message may also be rejected at a higher level, if something is wrong with the MESSAGE DATA itself (e.g. illegal instruction code), but in this case an ACK response will still be sent, if requested. See the protocol document for the equipment you are using to find out more about message data format. 1.7.2 Framing Synchronization A unit not currently receiving a message is watching the message stream for an STX (02) byte. Upon receiving that byte, the unit begins looking for the rest of the message.
If an ACK response is requested on every message, the host will know if a message was rejected (for any reason) because it will not receive the quick ACK response. 1.8.3 ACK Responses If requested, an ACK response will be generated as quickly as possible following receipt of the original message. With a full duplex interface, if the unit is already transmitting when it becomes time to send an ACK response, it will send the ACK as soon as it finishes transmitting the existing message.
If further data is included, if follows the instruction code and is referred to as the message body. Some instruction codes require a sub-instruction. If required, the sub-instruction is sent as the first byte of the message body. If there is a reply, the reply will contain the same sub-instruction. Data values, if required, are sent in the message body following the instruction code, or the sub-instruction (if it is present). 2.1 Message Types The message type is determined by the instruction code.
Where more than one data value is sent, they are usually separated by some delimiter such as a comma (“,” ASCII code 2C). The following are descriptions of the most commonly used types of data: 2.2.1 Analog Value An analog value represents a numeric measurement, control, or setting such as currents, voltages, gain, etc. Analog values are formatted as an ASCII string containing the numeric value. Analog data can be a floatingpoint value (e.g. “3.12”), or an integer value (e.g. “14”).
01 blb5 0 blb3blb2 1 blb0 lbx will be a label that identifies the function of each bit 0 represents bits that are not used, and that will always be set to 0. 1 represents bits that are not used, and that will always be set to 1. Brief descriptions of the meanings of each bit when it is SET (1) will follow. 2.2.4 String Value Text data, such as the firmware version and mask number, is represented simply as a string of ASCII characters.
EXAMPLE: An enumerated control currently has settings for “OFF” (30) and “ON” (31). In the future, a third choice may be added, called “STANDBY” (32). “OFF” and “ON” will retain their same values (30) and (31), and “STANDBY” will use a new code value (32). Make no assumptions about the presence of hardware or options in a particular model. There are messages that can be used to determine the number of power supplies, current stages, etc., and the presence or absence of various pieces of hardware.
This protocol was designed to be somewhat compatible with that of earlier SSPA products. Some messages that are not applicable to this type of amplifier were left in, because it is reasonable to assume that they might be routinely sent by already existing code, and some response would be expected. Such messages are marked in this table with gray vertical bars. These messages will return fixed values that should satisfy existing software, as indicated in the table.
Message Table Instr SubInstr Local Lockout (3.7) 0E Data Values Sent to Amplifier Returned by Amplifier Name/(Section) To set Local Lockout ON or OFF: BLOC_LOCKOUT_SETTING None To read the current Local Lockout setting: None BLOC_LOCKOUT_SETTING BLOC_LOCKOUT_SETTING = 30 for Local Lockout OFF, or = 31 for Local Lockout ON. The state of local lockout is tracked for protocol compatibility, although it will have no effect on an amplifier without local controls, e.g.
Message Table Instr SubInstr Data Values Sent to Amplifier Returned by Amplifier 16 57 Get Firmware Version Info (3.8.7) None “Firmware_Mask_Number” 20 “Firmware_Version” 16 58 Get Total Current (3.8.8) None NTOTAL_CURRENT 16 59 Get Specific Fault Info (3.8.
Message Table Instr SubInstr 16 60 Data Values Sent to Amplifier Returned by Amplifier Name/(Section) Get Module Measurements (3.8.14) [IMODULE] [IMODULE , ] “VG” ±NGATE_VOLTAGE [ , “VR” NREGULATED_VOLTAGE ] IMODULE must be equal to 31 or not be present, or a 3F (“?”) will be returned for NGATE_VOLTAGE (and NREGULATED_VOLTAGE if included in the response). IMODULE is only returned in the response if it was sent to the unit.
Message Table Instr SubInstr 17 58 Name/(Section) Power-Up State (3.9.7) Data Values Sent to Amplifier Returned by Amplifier To set state: BPOWER_UP_SETTING None To read currently set state: None BPOWER_UP_SETTING BPOWER_UP_SETTING = 30 for Muted, = 31 for Operating, = 32 for Previous state 17 59 Parallel Output Functions (3.9.
Message Table Instr SubInstr Data Values Sent to Amplifier Returned by Amplifier Name/(Section) BMUTE_CONTROL = 30 for MUTE (Output off), = 31 for OPERATE (Output on) 18 51 Redundancy Mode (3.10.2) To set redundancy mode: BREDUND_MODE None BREDUND_MODE = 30 for MANUAL, = 31 for AUTO, = 32 for SPARE. To read current setting: None BREDUND_MODE1 BREDUND_MODE2 BREDUND_MODE1 = 30 for MANUAL, = 31 for AUTO or SPARE. BREDUND_MODE2 = 30 for MANUAL, = 31 for AUTO, = 32 for SPARE.
Message Table Instr SubInstr Name/(Section) Data Values Sent to Amplifier Returned by Amplifier This command offers two different ways of defining which unit is to be switched online. The first, which is compatible with previous SSPA types, allows you to switch the addressed unit (“this” unit) on or off-line. The second allows you to switch UNIT 1 or 2 on-line.
3 Message Details 3.1 Reset Microprocessor (04) This command forces a power-up reset of the microprocessor in the addressed SSPA. If this command is sent with an ACK request, the unit will send its ACK response first, and then reset. Otherwise, there is no response to a RESET command. Normally, a spurious reset would be reported as a CPU fault. If the reset is due to this command being sent, however, a CPU fault will not be reported.
bxSUM_VOLTAGE The Power Supply Voltage fault in older amplifiers. This flag is set if the module’s input voltage is too high or too low. bxSUM_OUTPUT_POWER This flag signaled the output power fault (Pout fault) in older amplifiers. In the Outdoor and Antenna-Mount amplifiers, it is set if the output power is too low or too high, or if it is significantly below that of the other amplifier in a 1:1 system.
01 00 bAFLT_ANT_DL_FAIL bAFLT_RC_FAILURE bAFLT_FAN2_WARN bAFLT_FAN1_WARN bxFLT_EXT_INH One or more signals that inhibit the RF output have become shorted or disconnected. bxFLT_POUT_HI The output power of the amplifier has risen above the user-set fault limit. bxFLT_POUT_LO The output power of the amplifier has dropped below the user-set fault limit. bxSUM_MODULE Indicates a failure in the main RF module.
3.4 Clear Service Request (09) This command clears a service request, and causes the service request contacts on the serial I/O connector to stop indicating a fault condition. The service request contacts will remain in their non-fault state, unless a new fault occurs. This command differs from the Fault Reset command. This command does not attempt to clear any of the faulting conditions.
3.8.1 Get Output Power (16 50) The SSPA’s output power level will be returned as an analog value. The value will be signed if the power units are set for dBm or dBW, and unsigned if the power units are set for Watts. The units will be those selected by front panel controls, or by the serial I/O Power Units message (section 3.10.5). This command can also be used to determine which units are set. A question mark (3F) is returned if the output level A/D converter is not functioning.
bMUTED:SERIO bMUTED:LOCAL Muted by Serial I/O Muted by local MUTE button (or on power-up if power-up state is set to mute) The flags in the second byte indicate the four conditions that will turn the output OFF (such that it cannot be turned back on with an UN-MUTE command): bHICURR_SHTDN bGATE_V_SHTDN: bTH_SHTDN: bBUC_UNLK_INH bRF_INHIBIT High Current Shutdown Fault Gate Voltage Shutdown Fault Thermal (overtemperature) Shutdown Fault Amplifier has shut down because the (optional) BUC may be unlocked The
The following table lists the codes that are returned in response to the 16 59 message. They represent every fault condition that should be detected by the amplifier. The table also lists the corresponding bit flags returned by the Get Faults message (08). An optional one-byte parameter may be sent with this message, called BACTIVE_INFO. If this parameter is present, and equal to 31, the high bit of each of the following codes will be set if the fault condition is still active.
Fault Codes SIO Code (16 59) Screen Text 1 (RCP-200X) 42 SIO 08 flag 2 NEW_INFO SIO 08 flag 2 (old style) Local Warn bXFLT_LOCAL_WARN bXFLT_LOCAL_WARN Warning that you have set Local mode (which prevents remote control). 43 Maint Warn bXFLT_MAINT_WARN bXFLT_MAINT_WARN Warning that you have set Maintenance mode. 44 Manl Warn (N/A) (N/A) Reserved (not used at this time) 45 InpR1 bXFLT_INPR1 bXSUM_INPUT Parallel I/O input 1 fault (RCP-200x).
3.8.10 Get Configuration (16 5A) This message returns information about the SSPA hardware. The following information is returned: BOPT_PARALLEL_IO BOPT_1:1 30 BOPT_ANT_DL BOPT_1:1_SW BOPT_BUC 30 31 30 30 30 30 BOPT_REFLECTED_PWR 30 30 , 31 , BOPT_FAN_MONITOR The first 15 bytes are flags that indicate whether various options are present (31) or not (30).
There is also a Reflected Power Calibration offset setting (see 3.9.10), which the operator may use to adjust the readings to agree with other measurement equipment. Doing so involves connecting the output to a short, in order to produce a known and measurable reflected power signal. 3.8.12 Get Parallel Inputs (16 5C) This message returns information about the current state of the eight Parallel I/O Inputs that are optionally available when an RCP-2001 is connected.
3.8.15 Get Module Nominal Power (16 6A) The Get Module Nominal Power command returns the rated nominal power of the SSPA expressed in watts. For example, a 50-watt (nominal) SSPA will return the value “50” (35 30). 3.8.16 Get Gain Range (16 6B) The Get Gain Range command returns the adjustable range of the gain control, as a positive integer, in dB. Gain can be set anywhere from 0.0 dB down to –(Gain Range) in dB, in 0.1 dB increments. 3.8.
To set the power limits, you need only send the values you wish to change. If you wish to affect only the upper fault limit, send a comma (2C) followed by the new upper limit value. To disable the low fault limit send a less-than symbol (‘<’). To disable the high fault limit send a greater-than symbol (‘>’). 3.9.2 Unused 1 [Temperature Fault Limit] (17 52) NOTE: This message is NOT APPLICABLE to the amplifiers using this protocol.
3.9.7 Power-Up State (17 58) The Power Up State setting determines whether, when powered-up, a unit should be Muted, Operating, or in the state it was when it was last switched off. A single enumerated byte is sent or received in this message. 30: 31: 32: Power Up MUTED Power Up with RF ON Power Up with output set as it was when last powered down 3.9.8 Parallel Output Functions (17 59) The functions of the eight outputs on the Parallel I/O module can be read and controlled.
When queried or set, a signed analog value is passed in this message. This value is the offset (in dB) to get the Pout reading to agree with a power meter connected to the output. Note that this value is in dB, regardless of the Power Units setting. This offset can be set to any value between -6.0 to +6.0 dB, in 0.1 dB steps. 3.9.
If you turn on Remote Disables Local while the amplifier is in Remote Mode, you will immediately lose the ability to change anything from the RCP-2001 panel. Attempts to edit anything while this setting is ON and the amplifier is in Remote Mode will result in the message *** REMOTE *** being displayed for a few seconds on the RCP-2001 panel. You must return to the Control Mode setting in the Operate Menu, and set Local Mode, before you can do anything else from the RCP-2001. 3.9.
Units will respond with a message containing the same instruction code and sub-instruction, and a message body that contains the data in the same format which is used to set the values. The message body used to set a value contains the same sub-instruction, followed by the data for the new setting. The format of the data is described in the sections that follow. Unless an ACK is requested in the instruction byte, there will be no response to a message with this format.
Example, set PIO output R5 to the Normally Open position and R6 to the Normally Closed position (assuming neither has previously been assigned to any function with message 17 59), and leaving other outputs unchanged: SEND TO UNIT: 02 0F 01 18 53 30 30 30 30 31 32 30 30 EF 03 There is no response. Unused PIO Output R5 is set to “N.O.” position, and R6 is set to “N.C.” position. 3.10.5 Power Units (18 54) This message controls whether the Pout (output power) is displayed in dBm, dBW, or Watts.
3.11.2 AntDL Switch Command (19 54) This command message accepts only one one-byte parameter, which is: 30: 31: Switch the RF output to the antenna Switch the RF output to the dummy load The antenna/dummy-load switch can be in one of the following states (as displayed in the AntDL menu on an attached RCP-2001): “Disc”, “Antenna”, “Dummy Load”, “Switching”, “SwPwrFail”, or “?ADL”. The last is used if a problem in the hardware prevents the status of the switch from being determined. 3.
bCONTROL_MODE_LOCAL_OR_MAINTENANCE = Control Mode is set to Local or Maintenance. bCONTROL_MODE_REMOTE_OR_MAINTENANCE = Control Mode is set to Remote or Maintenance. bOTHER_UNIT_ONLINE = The other unit (in a 1:1 system) is on line, or there is a problem reading the switch position, or the switch is changing state. bOTHER_UNIT_STANDBY = The other unit (in a 1:1 system) is in standby, or there is a problem reading the switch position, or the switch is changing state.
After the fault condition has been rectified, bits can be cleared in the Latched Fault Mask by issuing a Fault Reset command (see section 3.5). A latched fault can only be cleared if the faulting condition no longer exists. Latched faults can also be cleared from the front panel, or using a parallel I/O Fault Reset input. When latched faults are reset: All Latched Fault Mask bits that do not have corresponding bits set in the Active Fault Mask are cleared.
