NJRCMC
Issue Date: Feb 26, 2019
Rev. 3.03
                                                                         
TABLE OF CONTENTS
1. Monitor And Control Function
1.1 Monitor Functions (Query)
1.1.1 Request Status
1.1.2 Request Alarm Status
1.1.3 Get Attenuator
1.1.4 Get Fan Status
1.1.5 Get PS Status
1.1.6 Get Temperature status ( Not Applicable)
1.1.7 Get Power Monitor status ( Not Applicable)
1.1.8 Get Band Select ( Not Applicable)
1.1.9 Get Reference Status ( Not Applicable)
1.2 Control Functions (Command)
1.2.1 Set Set Transmit On/Off State
1.2.2 Set Attenuator
1.2.3 Reset Fan Counter
1.2.4 Set Band Select ( Not Applicable)
1.2.5 Set Reference Status ( Not Applicable)
1.2.6 Set Carrier Frequency ( Not Applicable)
1.3 Maintenance Functions
1.3.1 Set BUC Address
1.3.2 Get BUC Address
2. Graphical User Interface (GUI) Software
2.1 Hardware Setup
2.2 Installing the GUI
2.3 Starting the GUI
2.4 Operating the GUI
3. Programming Information
3.1 Communication Protocol
3.1.1 COM port setting
3.1.2 Procedure
3.1.3 Frame format
3.2 Message Format
3.2.1 Request Status
3.2.2 Request Alarm Status
3.2.3 Set Set Transmit On/Off State
3.2.4 Get Attenuator
3.2.5 Set Attenuator
3.2.6 Get Fan Status
3.2.7 Get PS Status
3.2.8 Reset Fan Counter
3.2.9 Set BUC Address
3.2.10 Get BUC Address
3.3 BUC Power Class
4. Update History
                                                                         
1. MONITOR AND CONTROL
This section describes:
>>  Detail description of BUC's Monitor and Control function.
1.1    Monitor Functions  (Query)
1.1.1    Request Status
>>  This function obtains the status information of BUC.
>>  It reads each status information and reports the results.
>>  Status informations
Output Power Obtains information of the output power monitor.
Temperature Obtains information of the thermalsensor in BUC.
Temperature Alarm Obtains information of temperature alarm monitoring if BUC maintains below restrictive temperature.
LO Status Obtains information of PLL-Lock of the Local Oscillator.
Check Sum Obtains the result of check sum calculation received at BUC.
Mute Control Obtains the state of the Mute(On/Off).
Power Class Obtains the Output Power Class. (See 3.3  BUC Power Class)
Software Ver. Obtains the version information of the firmware.
1.1.2    Request Alarm Status
>>  This function obtains the all alarm information.
High Temperature Fault Exceeding a temperature limit.
Lock Alarm PLL Unlock
PS (Power Supply) Alarm PS Voltage is out of range
VSWR Alarm         ※Not Applicable
Fan Alarm Fan module is sending alarm signal.
Over Fan Life Alarm Exceeding a operation time limit.
Over Pow Protection Alarm Exceeding a output power limit.
Redundancy Alarm Notifying any alarm except fan alarm for redundancy systems.
1.1.3    Get Attenuator
>>  This function obtains the current setting of the gain control attenuator.
>>  To set the attenuator, refer to 1.2.2
1.1.4    Get Fan Status
>>  This function obtains information of fan status as follows.
Fan Alarm Obtains if it's normal or abnormal.
Life Alarm Obtains if the fan exceeded operation life time or not.
Fan Status Obtains if the fan is operating or not.
Fan Life Obtains the accumulated operation time in minutes unit.
1.1.5    Get PS Status
>>  This function obtains information of Power supply status as follows.
PS Alarm Obtains if its input voltage is in or out of allowed range.
PS Voltage Obtains its input voltage.
1.1.6    Get Temperature status
>>  This function obtains information of each Temperature Sensor information.
>>  This Model is not applicable.
1.1.7    Get Power Monitor status
>>  This function obtains information of each Power Monitor information.
>>  This Model is not applicable.
1.1.8    Get Band Select
>>  This function obtains information of current band setting. ( Universal / Standard )
>>  This Model is not applicable.
1.1.9    Get Reference Status
>>  This function obtains information of current PLL-reference setting. ( Internal / External )
>>  This Model is not applicable.
1.2    Control Functions  (Command)
1.2.1    Set Transmit On/Off State
>>  This function specifies the Transmit Control On/Off.
1.2.2    Set Attenuator
>>  This function specifies the gain of IF Attenuator inside BUC.
>>  The value of the attenuation can be in 0.5 dB steps between 0 dB and  31.5 dB.
>>  BUC will ignore values out of range.
1.2.3    Reset Fan Counter
>> This function can reset fan life to initial state (0 minute).
1.2.4    Set Band Select
>>  This function specifies band setting. ( universal / Standard )
>>  This Model is not applicable.
1.2.5    Set Reference Status
>>  This function specifies PLL-reference setting. ( Internal / External )
>>  This Model is not applicable.
1.2.6    Set Carrier Frequency
>> This function specifies current carrier frequency setting.
>>  This Model is not applicable.
1.3    Maintenance Functions
1.3.1    Set BUC Address
>>  This function specifies BUC(Slave) address for multi-drop usage.
>>  Usually the BUC address is specified with default value (0x01).
1.3.2    Get BUC Address
>>  This function obtains BUC(Slave) address.
>>  The BUC and host should be PPP(point to point) connection when executed this command.
                                                                         
2. GRAPHICAL USER INTERFACE SOFTWARE
This section describes:
>>  System requirements of Graphical User Interface(GUI).
>>  Installation and starting up the GUI.
2.1  Hardware Setup
>>   COM port setting
GUI sets the serial communication property of your PC as follows.
Model RS232
Baud rate 9600    .
Data bit 8          .
Parity none    .
Stop bit 1
Flow control none    .
>>   DC Power and Serial Cable connection   [  RS232 Mode ]
The DC and M&C interface is a 12-pin MS connector as next page.
Connect COM port and MS connector with a RS-232 cable.
Supply DC power to the BUC thru the MS connector using J and K lines.
Figure.1       .
2.2  Installing the GUI
>>   Copy all files from the CD to a directory on the control computer.
>>   Excute the /NJT8371_EP003_3/Installer/Setup.exe  file.  You should see the following screen.
>>   Click install.
>>   The program uses Microsoft.net Framework. This software will be installed if the
      setup does not detect it.
2.3  Starting the GUI
>>   Go the Start Menu
>>   Select the All Programs Menu
>>   Select ' NJT8371_EP003_3'  and
     You should see the following screen.
>>   Select COM Port Number, Interface type  and
>>   Click the ' OPEN '
>>    If the GUI has established connection thru Serial to the BUC,
      You should see the following control screen.
                                                                         
2.4  Operating the GUI
>>   General
Target Address Box The GUI sends a command to BUC of specified address by this Box.
In case of RS232 model  it should be set to 0x01. (default value)
Using different address can make multi drop communications like RS422 type.
Send Command Box The GUI shows the transmitted command bytes to BUC in hexadecimal format.
Received Respnse Box The GUI shows the received data bytes from BUC in hexadecimal format.
In the case of the check sum error of PC reception, GUI adds a 'False' 
to the received data. 
>>   Request Status
The GUI sends a query  by this command and it displays the current fundamental status.
Output Power Showing the transmitting RF power level in dBm.
Temperature Showing the internal sensor temperature in ℃.
Temp. Alarm In the case of exceeding a temperature limit the BUC reply "1".
LO Status In the case of unlocked state the BUC reply "1".
Check Sum When an check-sum error has occurred in BUC reception,
it notifies you only when it receives a Request Status command next.
Mute Control The mute control state (ON or OFF) is displayed. 
In the case of 'ON' the BUC reply "0".
Power Class Showing the BUC's power class. (See 3.3  BUC Power Class)
Firmware Ver. Showing the BUC's firmware version.
**   Request Status Option
Check a check box ( Repeat ) in executing the command repeatedly. 
Then, GUI shows a text box for the setup of a time interval. 
Input the suitable numerical value for the text box in the unit of 'second'. 
Then, click the command button and start logging.
GUI creates a log file ( Status.csv ) to the desktop folder of your control PC.
Since the log file is created in append mode, data is not overwritten even if it resumes logging. 
>>  Request Alarm Status
The GUI sends a query  by this command and it displays the current alarm status by 'Normal' or 'Fail'.
High Temperature Fault Showing the Temperature alarm status.
Lock Alarm Showing the PLL lock status.
PS (Power Supply) Alarm Showing the Voltage alarm status.
VSWR Alarm        ※Not Applicable
Fan Alarm Showing the Fan alarm status.
Over Fan Life Alarm Showing the Life alarm status.
Over Pow Protection Alarm Showing the Over power limit status.
Redundancy Alarm Showing the Redundancy alarm status.
>>   Set Transmit On/Off State
Click a command button when you change into a mute control state to ON or OFF.  (GUI sends mute control command To BUC.)
After Transmit-On command, if there is not an error BUC sets Transmit-On.
>>   Get Attenuator
The GUI will query the current Gain Control Attenuator value.
Click the command button, and GUI replys the value.
>>   Set Attenuator
Fill the suitable numerical value for a text box in the unit of 'dB'. 
Then, click the command button.
The Data range is from 0dB to 31.5dB with 0.5dB steps.
>>   Set Carrier Frequency
This Model is not applicable.
>>   Get Fan Status
The GUI sends a query  by this command and it displays the current fan-alarm status by 'Normal' or 'Fail'.
Fan Alarm Showing the status of fan module.
Life Alarm Showing if the accumulated operation time exceeds life time or not.
Fan Status Showing the fan module is operating or not.
Fan Life Showing the specified fan life time.
>>   Reset Fan Counter
Click this button if you need to reset accumulated operation time (Fan Life) of fan module.
>>   Get PS Status
The GUI sends a query  by this command and it displays the current PS status by 'Normal' or 'Fail', and voltage data in volt unit.
>>   Get Temperature status
This Model is not applicable.
>>   Get Power Monitor status
This Model is not applicable.
>>   Get Band Select
This Model is not applicable.
>>   Set Band Select
This Model is not applicable.
>>   Get Reference Status
This Model is not applicable.
>>   Set Reference Status
This Model is not applicable.
>>   Set BUC address
Click this button if you need to change BUC address to specified number by list box.
>>   Get BUC address
Click this button if you need to know the BUC address.
If the multiple BUCs are connected you could not receive the response by this command.
                                                                         
3. PROGRAMMING INFORMATION
This section describes:
>>    Detailed description about communication specification.
3.1    Communication Protocol
3.1.1   COM port setting
Specify the serial port property as follows.
Model RS232
Baud rate 9600    .
Data bit 8          .
Parity none    .
Stop bit 1
Flow control none    .
3.1.2    Procedure
A communicative start is always a control computer and a BUC always waits for the command. 
If the command from the controller is received, the BUC will start requested processing. 
The BUC will reply to the controller, after processing is completed. 
3.1.3    Frame format
Transmission and reception are the same frame structure.
Byte# Contents of the byte description          
1 Address of BUC ・Default is 0x01**
2 Command / Data byte 1 ・2nd byte : Command byte in Transmittion frame.
The first Data byte in Reception frame.
3 Data byte 2
・Command byte is assigned to each function.
4 Data byte 3 ・Data bytes 1−5 are defined by each function. 
・If it is not used, be fixed 0xAA.
5 Data byte 4
6 Data byte 5
7 Check sum byte ・Algebraic sum of bytes 1 through 6.
0x01 Command Data2 Data3 Data4 Data5 check
/ 0x10 /  Data1
**  BUC replies 0x10 which carried out 4 bit shifts of the address to controller.
3.2    Message Format
>>  This section includes frame description of each command.
3.2.1   Request Status
Transmit format
0x01 0x01 0xAA 0xAA 0xAA 0xAA check
Command code : 0x01
No data bytes are used.
Response format
0x10 D1 D2 D3 D4 D4 D5 0x0 check
MSB LSB MSB
D1 D2: Output Power
Replied data is ×100 ( hundred times ) of the output power in dBm.
ex.   0x0F 0xA0 (0x0FA0) → +40dBm
D3 : Temperature
In the negative temperature, BUC replies data in two's complement.
D4 MSB :
bit7-bit4 Power Class (See 3.3  BUC Power Class)
D4 LSB :
bit3 Mute Control mute on : 0    mute off : 1
bit2 Check Sum Error no error : 0    error : 1
bit1 LO Status locked : 0     un-locked : 1
bit0 Temperature Alarm normal : 0     abnormal : 1
D5 MSB:
bit7-bit4 Software Version
D5 LSB:
bit3-bit0 Fixed value 0
3.2.2   Request Alarm Status
Transmit format
0x01 0x0C 0xAA 0xAA 0xAA 0xAA check
Command code : 0x0C
No data bytes are used.
Response format
0x10 D1 D2 0xAA 0xAA 0xAA check
D1:
bit7 Redandancy Alarm normal : 0     abnormal : 1
bit6 Over Pow Protection Alarm normal : 0     over limit : 1
bit5 Over Fan Life Alarm normal : 0     over limit : 1
bit3 Fan Alarm normal : 0     abnormal : 1
bit3 VSWR Alarm         not applicable
bit2 PS (Power Supply) Alarm normal : 0     over limit : 1
bit1 Lock Alarm locked : 0     unlock : 1
bit0 High Temperature Fault normal : 0     over limit : 1
D2:
bit7 Temp Monitor4 Alarm not applicable
bit6 Temp Monitor3 Alarm not applicable
bit5 Temp Monitor2 Alarm not applicable
bit3 Temp Monitor1 Alarm normal : 0     over limit : 1
bit3  PS Monitor4 Alarm not applicable
bit2  PS Monitor3 Alarm not applicable
bit1  PS Monitor2 Alarm not applicable
bit0  PS Monitor1 Alarm normal : 0     over limit : 1
3.2.3   Set Transmit On/Off State
Transmit format
0x01 0x02 D2 0xAA 0xAA 0xAA check Case 0x00 :  Set the Transmit state to Off
(0x00)
0x01 0x02 D2 0xAA 0xAA 0xAA check Case 0x01 :  Set the Transmit state to On
(0x01)
Command code : 0x02
D2                  : Off: 0x00  /   On: 0x01
Response format
0x10 0x00 0xAA 0xAA 0xAA 0xAA check Case 0x00 :  Set the Transmit state to Off
or 0x01 Case 0x01 :  Set the Transmit state to On
D1                  : Transmit state after changed
3.2.4   Get  Attenuator
Transmit format
0x01 0x06 D2 0xAA 0xAA 0xAA check
(0x01)
Command code : 0x06
D2                  : 0x01 Fixed value  0x01
Response format
0x10 D1 D2 D3 D4 0xAA check
(0x01)
Replied data is×10 ( ten times ) of the attenuation as data. 
D1                  : Fixed value 0x01
D2                  : Tens(101) section.
D3                  : Units(100) section.
D4                  : Tenths(10-1) section.
ex.  5.5dB  → Data2: 0x00  Data3:0x05  Data4:0x05
3.2.5   Set Attenuator
Specify ×10 ( ten times ) of the attenuation as data in decimal number.  ***
Transmit format
0x01 0x05 D2 D3 D4 D5 check
(0x01)
Command code : 0x05
D2                  : Fixed value 0x01
D3                  : Data3 is the Tens(101) section.
D4                  : Data4 is the Units(100) section.
D5                  : Data5 is the Tenths(10-1) section.
ex.  5.5dB  → Data2: 0x00  Data3:0x05  Data4:0x05
*** >>  The Data range is from 0 (0dB) to 315 (31.5dB).
>>  If the data is out of range, the command is invalid.
Response format
0x10 D1 D2 D3 D4 0xAA check
(0x01)
D1                   : Fixed value 0x01
D2-4               : Attenuator value after changed
3.2.6   Get Fan Status
Transmit format
0x01 0x08 0xAA 0xAA 0xAA 0xAA check
Command code : 0x08
No data bytes are used.
Response format
0x10 D1 D2 D3 D4 0xAA check
D1                   :
bit7-bit5 not use Fixed value : 0
bit4 fan operation status stop : 0     operating : 1
bit3-bit2 not use Fixed value : 0
bit1 Fan Life normal : 0     over limit : 1
bit0 Fan Alarm normal : 0     abnormal : 1
D2 D3 D4     : Accumulated operation time 0x000000 - 0xFFFFFF
24bit Integer in minutes
3.2.7   Get PS Status
Transmit format
0x01 0x09 D2 0xAA 0xAA 0xAA check
(0x01)
Command code : 0x09
D2                   : Fixed value 0x01
Response format
0x10 D1 D2 D3 D4 0xAA check
(0x01)
D1                   : Fixed value 0x01
D2                   : Power Supply Alarm 0x00:Normal    0x01:Under Lower Limit    0x02:Above Upper Limit
D3 D4             : Monitor Voltage
Replied data is ×100 ( hundred times ) of the voltage in Volts.
ex.   0x0F 0xA0 (0x0FA0) → +40V
3.2.8   Reset Fan Counter
Transmit format
0x01 0x07 0xAA 0xAA 0xAA 0xAA check
Command code : 0x07
No data bytes are used.
Response format
0x10 0xAA 0xAA 0xAA 0xAA 0xAA check
No data bytes are used.
3.2.9   Set BUC Address
Transmit format
0x01 0x03 D2 0xAA 0xAA 0xAA check
Command code : 0x03
D2                   : 0x01 - 0x0F
Response format
0x10 D1 0xAA 0xAA 0xAA 0xAA check
D1                   : New BUC address after changed
3.2.10   Get BUC Address
Transmit format
0xAA 0xFF 0xAA 0xAA 0xAA 0xAA check
No need to specify address byte
Command code : 0xFF
No data bytes are used.
Response format
0xAA D1 0xAA 0xAA 0xAA 0xAA check
D1                   : BUC address 0x01 - 0x0F
                                                                         
3.3    BUC Power Class
Resp. 0x01 0x02 0x03 0x04 0x05 0x06
Class 2W 4W 5W 8W 10W 16W
Resp. 0x07 0x08 0x09 0x0A 0x0B    
Class 20W 25W 40W 60W 80W    
not applicable
                                                                         
NJRCMC
5. UPDATE HISTORY
Revision Description Date
3.0.1 Initial Release :  Customized for NJT8371   2016/4/14
3.0.2 Correction of frame format  :  Transmit , etc.,   2016/6/10
3.0.3 Revise Hardware setup : Remove FSK mode 2019/2/26