NJRCMC
Issue Date: March 24, 2021
Rev. 10.00
                                                                   
TABLE OF CONTENTS
1. Monitor And Control Function
1.1 Monitor Functions (Query)
1.1.1 Request Status
1.1.2 Get Gain Control Attenuator
1.1.3 Get Band Select
1.2 Control Functions (Command)
1.2.1 Set Mute Control
1.2.2 Set Gain Control Attenuator
1.2.3 Set Band Select 
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 Set Mute Control
3.2.3 Set Gain Control Attenuator
3.2.4 Get Gain Control Attenuator
3.3 Response Data Format
3.3.1 Request Status
3.3.2 Set Mute Control
3.3.3 Set Gain Control Attenuator
3.3.4 Get Gain Control Attenuator
3.4 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 information
BUC Address Enables to build multi drop communications.
Notes : BUC Address has not been equipped yet. 
Output Power Obtains information of the output power monitor.
Temperature Obtains information of the thermal sensor 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.4  BUC Power Class)
Software Ver. Obtains the version information of the firmware.
                                                                   
1.1.2    Get Gain Control Attenuator
>>  This function obtains the current setting of the gain control attenuator.
>>  To set the attenuator, 
1.1.3    Get Band Select  (Not Aplicable)
>>  This function obtains information of current band setting. ( Universal / Standard )
>>  This Model is not applicable.
1.2    Control Functions  (Command)
1.2.1    Set Mute Control
>>  This function sets the Mute Control On/Off.
1.2.2    Set Gain Control Attenuator
>>  This function sets the gain of IF Attenuator inside BUC.
>>  The value of the gain can be in 0.5 dB steps between 0 dB and  15.5 dB.
>>  BUC will ignore values out of range.
1.2.3    Set Band Select  (Not Aplicable)
>>  This function specifies band setting. ( universal / Standard )
>>  This Model is not applicable.
                                                                   
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
Set the serial communication property of your PC as follows.
Baud rate 9600    .
Data bit 8          .
Parity none    .
Stop bit 1
Flow control none    .
>>   DC Power and Serial Cable connection   [  RS232 Model  ]
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.
>>   Execute the /T8318_EP001_9/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 ' BUC_EP001_10'  and
     You can see the following screen.
>>   Select COM Port Number  and
>>   Click the ' OPEN '
                                                                   
>>    If the GUI has established connection thru Serial to the BUC,
      You can see the following control screen.
                                                                   
2.4  Operating the GUI
>>   General
Send Command Box The GUI shows the transmitted command bytes  to BUC in Hexadecimal format.
Received Response 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 will query the BUC and display the current status.
BUC Address BUC Address is a fixed value for the moment.
Output Power Showing the transmitting RF power level in dBm 
Temperature Showing the internal sensor temperature in ℃ 
Temperature 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 the check sum error of BUC reception, the BUC reply "1" 
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.4  BUC Power Class)
Firmware Ver. Showing the BUC's firmware version.
                                                                   
>>   Set Mute Control
Click a check box(On/Off), when you change into a mute control state to ON or OFF.  (GUI sends mute control command To BUC.)
When you click the command button, GUI sends the same command to BUC again.
>>   Set Gain Control 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 15.5dB and 0.5dB steps.
>>   Get Gain Control Attenuator
The GUI will query the current Gain Control Attenuator value.
Click the command button, and GUI replies the value.
>>   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 of your control PC.
Since the log file is created in append mode, data is not overwritten even if it resumes logging. 
                                                                   
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 for RS232 as follows.
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 ・Fixed 0x01**
2 Command / Data byte 1 ・2nd byte : Command byte in Transition 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 character ・Algebraic sum of bytes 1 through 6.
0x01
/ 0x10
Command
/  Data1
Data2 Data3 Data4 Data5 check
**  BUC replies 0x10 which carried out 4 bit shifts of the address. 
                                                                   
3.2    Message Format
>>  This section includes frame description of each command.
3.2.1   Request Status
Command code : 0x01
No data bytes are used.
0x01 0x01 0xAA 0xAA 0xAA 0xAA check
3.2.2   Set Mute Control
Command code : 0x02
Bytes of Data1 : Mute = On: 0x00  /   Off: 0x01
0x01 0x02 0x00 0xAA 0xAA 0xAA check Case 0x00 :  Set the Mute to On
0x01 0x02 0x01 0xAA 0xAA 0xAA check Case 0x01 :  Set the Mute to Off
3.2.3   Set Gain Control Attenuator Specify ×10 ( ten times ) of the attenuation as data in decimal number.  ***
Command code : 0x05
Bytes of Data2 : 0x01 Fixed value  0x01
Bytes of Data3 : Data3 is the Tens(101) section.
Bytes of Data4 : Data4 is the Units(100) section.
Bytes of Data5 : Data5 is the Tenths(10-1) section.
ex.  5.5dB  → Data2: 0x00  Data3:0x05  Data4:0x05
0x01 0x05 0x01 Data3 Data4 Data5 check
*** >>  The Data range is from 0 (0dB) to 155 (15.5dB).
>>  If the data is out of range, the command is invalid.
                                                                   
3.2.4   Get Gain Control Attenuator
Command code : 0x06
Bytes of Data2 : 0x01 Fixed value  0x01
0x01 0x06 0x01 0xAA 0xAA 0xAA check
                                                                   
3.3    Response Data Format
>>  This section includes frame description of each response data.
3.3.1   Request Status
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 LSB :
bit0 Temperature Alarm
normal : 0     abnormal : 1
bit1 LO Status
locked : 0     un-locked : 1
bit2 Check Sum Error
no error : 0    error : 1
bit3 Output Power Mute
mute on : 0    mute off : 1
D4 MSB :
bit4-bit7 Power Class (See 3.4  BUC Power Class)
D5 LSB:
bit0-bit3 Fixed value  0x00
D5 MSB:
bit4-bit7 Software Version
0x10 D1 D2 D3 D4
MSB
D4
LSB
D5
MSB
0x0 check
3.3.2   Set Mute Control
D1 - D5 :  Same as 'Request Status' Response Data.
0x10 D1 D2 D3 D4
MSB
D4
LSB
D5
MSB
0x0 check
                                                                   
3.3.3   Set Gain Control Attenuator
D1        : 0x05 Command
D2 - D5 :  Same as  message format of '3.2.3 Set Gain Control Attenuator'.
0x10 0x05 0x01 D3 D4 D5 check
3.3.4   Get Gain Control Attenuator
Replied data is×10 ( ten times ) of the attenuation as data. 
D1        : 0x06 Command
D2        : 0x01 Fixed value  0x01
D3        : Tens(101) section.
D4        : Units(100) section.
D5        : Tenths(10-1) section.
ex.  5.5dB  → Data2: 0x00  Data3:0x05  Data4:0x05
0x10 0x06 0x01 D3 D4 D5 check
3.4    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 Brief Description Date
1.00 Initial Release                 2014/4/30
2.00 Change receive frame decoding.         2015/2/13
3.00 Adapted 'Band Select Command'.         2015/3/31
4.00 Adapted FSK interface mode.           2016/3/31
5.00 Revise receive frame decoding of Attenuator setting. 2016/4/26
6.00 Re-define Transmit-on/off frame decoding.     2016/7/1
7.00 Correct decording selecter in case of repeat mode.  2018/10/17
    *Selector recognize command from response frame.        
8.00 Remove Mute Control words 'Transmit On/Off'   2018/10/31
9.00 Remove Band Selection Function.         2019/2/26
10.00 Correct Request Status in case of repeat mode.    2021/3/24