Beruflich Dokumente
Kultur Dokumente
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 2 of 15
1 Project Overview
This document describes the communication protocol used to communicate with MitecVsat high power MTX block
up converters (BUCs) and their MRK redundant systems, including:
3 Scope
This document covers all aspects of the communication protocol which are required for the customer to develop a
controlling device (typically a PC application program or modem) to interface with the MitecVsat product.
The customer interface transport medium for this product may be configured for RS485 half duplex (2-wire) or
RS232. Please refer to the specific table in the user manual for pin allocations.
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 3 of 15
5 Communication Protocol Framing
The packets exchanged with the master controller will have the following format (regardless of direction):
MSB
LSB
Dest/Src
STX Cmd/Len Data CRC ETX
Address
MSB LSB
♦ STX is the start transmission byte (defined as 0x7E). This byte is used to determine the start of a packet.
♦ Dest/Src Address contains the destination address in the high nibble and the source address in the low
nibble. The destination address is the address of the device which is to process the packet. The source
address is the address of the device which sent the packet. Note that the device address of the customer
interface device is always = 0x0F.
♦ CMD/Len contains the packet command in the high nibble and the number of bytes in the data portion of
the packet in the lower nibble.
♦ Data1 - Datan contains the packet payload. The value of the data bytes is specific to the command and will
be covered in following sections.
♦ CRC is the cyclic redundancy check and is calculated by performing a byte-wise exclusive OR of the
Dest/Src address byte, Cmd/Len byte and all data bytes. A bit-wise inversion is then applied to the CRC
before being inserted into the packet. Refer to 5.4 CRC Calculation Example.
♦ ETX is the end transmission byte (defined as 0x7F). This byte is used to determine the end of a packet.
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 4 of 15
5.3 Default Address Values
The customer interface device (e.g. a PC) must always be assigned address 0xF.
Standalone BUC: a standalone BUC defaults to address 0xA. The main controller will always respond to address 0xF.
So communication with a standalone BUC can be established using address 0xA or address 0xF.
Redundant system: in a redundant system, upon connecting the redundancy cable, the address of the unit is
automatically set to 0xA for unit A and 0xB for unit B (for 1:2 config, unit C is set to address 0xC). Communication has
to be established using addresses 0xA, 0xB (or 0xC), respectively.
7E AF 02 06 06 52 7F
= 1010 1101
XOR
Data1 = 0x06 0000 0110
= 1010 1011
XOR
Data2 = 0x06 0000 0110
= 1010 1101
Perform bitwise
= 0101 0010 = 0x52 CRC
inversion of final result:
The main control module will only send a packet to the customer interface device in response to a packet received from
the customer.
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 5 of 15
6 Default Reply Packet Format
This section identifies the packet format of the ACK (Acknowledge) and NACK (Not acknowledge) replies which may be sent to the customer interface device
in response to a received command.
NOTE: The packets shown in the list below are based on the assumption that the master controller device address is set to 0xA for unit A and 0xB for unit B (in
1:2 config, unit C is set to address 0xC). Any unit will reply to address 0xF in standalone mode. To modify the commands for different addresses, the Dest/Src
byte and the CRC byte will have to change in all packets. In the following: X = main controller serial address and ZZ = CRC.
2) reply: 7E FA E0 E5 7F
ACK reply sent from unit A
NACK (Not Acknowledge) 7E FX F1 YY ZZ 7F Indicate that a problem was X = Device address of the packet source 1) reply: 7E FF F1 03 F2 7F
encountered with the received device. NACK reply sent from the main control module
packet. (address 0xF) for an invalid CRC
YY = Error code:
02 = Incorrect no of bytes for the command. 2) reply: 7E FA F1 18 EC 7F
03 = Incorrect CRC. NACK reply sent from unit A for an
18 = Unrecognized command. unrecognized command
30 = Set command attempted on a protected
element.
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 6 of 15
7 MTX Command List
Get Mute Status Update Mute Status: MM = 0x00 if unmuted, 0x01 if muted. 1) cmd: 7E AF 02 06 01 55 7F
reply: 7E FA 84 06 01 00 00 86 7F
7E XF 02 06 01 ZZ 7F 7E FX 84 06 01 00 MM ZZ 7F Unit A is enabled (unmuted).
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 7 of 15
Command Possible Replies Interpretation Examples
Get Gain Update Gain: GG GG = 10 * Gain in dB. 1) cmd: 7E AF 02 06 07 53 7F
reply: 7E FA 84 06 07 02 8A 08 7F
7E XF 02 06 07 ZZ 7F 7E FX 84 06 07 GG GG ZZ 7F Unit A gain = 0x028A = 0d650, 650/10 = 65.0 dB
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 8 of 15
7.2 MTX Control Commands
This section identifies the list of commands available to control the MTX units.
NOTES:
1. The packets shown in the list below are based on the assumption that the master controller device address is set to 0xA for unit A and 0xB for unit B (in
1:2 config, unit C is set to address 0xC). Any unit will reply to address 0xF in standalone mode. To modify the commands for different addresses, the
Dest/Src byte and the CRC byte will have to change in all packets. In the following: X = main controller serial address and ZZ = CRC.
2. In case of error, a NACK reply will be received. Refer to section 6 for possible error codes.
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 9 of 15
7.3 MTX Settings Commands
This section identifies the list of commands available to query the MTX settings information.
NOTES:
1. The packets shown in the list below are based on the assumption that the master controller device address is set to 0xA for unit A and 0xB for unit B (in
1:2 config, unit C is set to address 0xC). Any unit will reply to address 0xF in standalone mode. To modify the commands for different addresses, the
Dest/Src byte and the CRC byte will have to change in all packets. In the following: X = main controller serial address and ZZ = CRC.
2. In case of error, a NACK reply will be received. Refer to section 6 for possible error codes.
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 10 of 15
8 Network Access Command List
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 11 of 15
8.2 SET Network Configuration
This section identifies the list of commands available to change the network configuration.
NOTES:
1. The packets shown in the list below are based on the assumption that the master controller device address is set to 0xA for unit A and 0xB for unit B (in
1:2 config, unit C is set to address 0xC). Any unit will reply to address 0xF in standalone mode. To modify the commands for different addresses, the
Dest/Src byte and the CRC byte will have to change in all packets. In the following: X = main controller serial address and ZZ = CRC.
2. In case of error, a NACK reply will be received. Refer to section 6 for possible error codes.
Set Dynamic Host Note that this command will cause a reset of the controller in 2) cmd: 7E AF 14 06 31 00 00 73 7F
Configuration Protocol order to restart with the new configuration. reply: 7E FA E0 E5 7F (Ack)
Setting DHCP is disabled.
Restore Default Values ACK This command enables DHCP and restores the following 1) cmd: 7E AF 14 06 30 00 00 72 7F
Refer to section 6 parameters to their factory default values: reply: 7E FA E0 E5 7F (Ack)
7E XF 14 06 30 00 00 ZZ 7F
• Host Name • IP Address Controller will be reset in order to restart with the new
Restore Network • Gateway • Subnet Mask configuration.
Configuration Default Values • Primary DNS • Secondary DNS
Note that this command will cause a reset of the controller in
order to restart with the new configuration.
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 12 of 15
9 Redundant System Command List
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 13 of 15
Command Packet Format Interpretation Examples
YY = Switches alarm status, bitmap defined as follows:
Bit 0: RF switch 1 out of position
Bit 1: Not used
Bit 2: RF switch 1 unable to move
Bit 3: RF switch 2 out of position (in 1:2 config)
Bit 4: Not used
Bit 5: RF switch 2 unable to move (in 1:2 config)
Bits 6-7: Not used
All alarm and warning bits:
0 = no alarm or warning; 1 = alarm or warning.
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 14 of 15
10 Appendix I: Troubleshooting Guide
Reply packet is incomplete. 1) If software control of the transmit and receive buffer enable lines is required (RS485 half
duplex), then it is possible that the timing between the transition needs to be adjusted.
PS-216142-001-R07.doc Rev. 07
Designed: R. A. Page 15 of 15