Difference between revisions of "TCP Server"

From DDUtilV3
Jump to: navigation, search
(→‎Commands)
Line 1: Line 1:
 
==General==
 
==General==
−
Allows third party Ethernet clients to remotely control '''DDUtil_V3''' functionality.
+
Allows third party '''Ethernet''' clients to remotely control '''DDUtil_V3''' functionality.
  
 
==Setup==
 
==Setup==
  
 
===Connection===
 
===Connection===
−
Connections are restricted the Local Area Network (LAN) that DDUtil is connected to.
+
Connections are restricted to the '''Local Area Network''' (LAN) that '''DDUtil''' is connected to.
−
* Use the IP address of the host PC '''DDUtil''' is open on; i.e. 192.168.1.xxx.
+
* Use the IP address of the host PC '''DDUtil''' is open on; i.e. '''192.168.1.xxx'''.
−
* Use port 5678
+
* Use port '''5678'''
  
 
===Commands===
 
===Commands===
−
+
The following commands are available for remote '''DDUtil''' control. <BR>
−
  '''GETSLICE'''  -  Gets frequency of slice n (n = 0-7)    
+
'''Notes:'''<br>
 +
* Commands must be input '''EXACTLY''' as shown below.
 +
* '''All''' commands must be terminated with a '''CRLF''' (\r\n).
 +
* '''ACK''' returns only guarantee the commands were sent, not that they actually worked.
 +
* '''Rotor''' feedback is provided anytime the rotor moves whether initiated from this app, manually or some other manner.
 +
<br>'''
 +
  '''GETSLICE'''  -  '''Gets frequency of a radio slice n (n = 0-7)'''   '''
 
     '''Form:'''    GETSLICE P1 \r\n
 
     '''Form:'''    GETSLICE P1 \r\n
 
     '''Parm:'''    P1 = Slice number 0-7
 
     '''Parm:'''    P1 = Slice number 0-7
Line 17: Line 23:
 
     '''Rtrn:'''    Slice2:00014123456
 
     '''Rtrn:'''    Slice2:00014123456
 
 
−
  '''SETSLICE'''  -  Sets frequency of slice n (n = 0-7)    
+
  '''SETSLICE'''  -  '''Sets frequency of a radio slice n (n = 0-7)'''    
 
     '''Form:'''    SETSLICE P1 \r\n
 
     '''Form:'''    SETSLICE P1 \r\n
 
     '''Parm:'''    P1 = Slice number 0-7
 
     '''Parm:'''    P1 = Slice number 0-7
Line 23: Line 29:
 
     '''Rtrn:'''    ACK
 
     '''Rtrn:'''    ACK
 
 
−
  '''GETROTOR'''  -  Gets Rotor position    
+
  '''GETROTOR'''  -  '''Gets Rotor position'''    
 
     '''Form:'''    GETROTOR \r\n
 
     '''Form:'''    GETROTOR \r\n
 
     '''Uses:'''    GETROTOR\r\n
 
     '''Uses:'''    GETROTOR\r\n
 
     '''Rtrn:'''    Head:045
 
     '''Rtrn:'''    Head:045
 
 
−
  '''SETROTOR'''  -  Sets Rotor position    
+
  '''SETROTOR'''  -  '''Sets Rotor position'''    
 
     '''Form:'''    SETROTOR \r\n
 
     '''Form:'''    SETROTOR \r\n
 
     '''Uses:'''    SETROTOR045\r\n
 
     '''Uses:'''    SETROTOR045\r\n
 
     '''Rtrn:'''    Head:045 (when finished turning)
 
     '''Rtrn:'''    Head:045 (when finished turning)
 
 
−
  '''TOGGLEPTT''' -  Toggle Auto Drive Oper/Stby (PTT)
+
  '''TOGGLEPTT''' -  '''Toggle Auto Drive Oper/Stby (PTT)'''
 
     '''Form:'''    TOGGLEPTT \r\n
 
     '''Form:'''    TOGGLEPTT \r\n
 
     '''Uses:'''    TOGGLEPTT\r\n
 
     '''Uses:'''    TOGGLEPTT\r\n
 
     '''Rtrn:'''    PTT:{Oper|Stby}
 
     '''Rtrn:'''    PTT:{Oper|Stby}
  
−
     '''A95PWR''' -  A9500 Amp Power On
+
     '''A95PWR''' -  '''A9500 Amp Power On'''
 
     '''Form:'''    A95PWR \r\n
 
     '''Form:'''    A95PWR \r\n
 
     '''Uses:'''    A95PWR\r\n
 
     '''Uses:'''    A95PWR\r\n
 
     '''Rtrn:'''    ACK
 
     '''Rtrn:'''    ACK
 
 
−
     '''A95AUX''' -  A9500 Aux Power On / PowerOff
+
     '''A95AUX''' -  '''A9500 Aux Power On / Power Off'''
 
     '''Form:'''    A95AUX \r\n
 
     '''Form:'''    A95AUX \r\n
 
     '''Uses:'''    A95AUX\r\n
 
     '''Uses:'''    A95AUX\r\n
 
     '''Rtrn:'''    ACK
 
     '''Rtrn:'''    ACK
 
 
−
   '''A95AUTO''' -  A9500 Auto Mode On/Off (toggle)
+
   '''A95AUTO''' -  '''A9500 Auto Mode On/Off (toggle)'''
 
     '''Form:'''    A95AUTO \r\n
 
     '''Form:'''    A95AUTO \r\n
 
     '''Uses:'''    A95AUTO\r\n
 
     '''Uses:'''    A95AUTO\r\n
 
     '''Rtrn:'''    ACK
 
     '''Rtrn:'''    ACK
 
 
−
     '''A95ANT''' -  A9500 Antenna Select (steps 1-4)
+
     '''A95ANT''' -  '''A9500 Antenna Select (steps 1-4)'''
 
     '''Form:'''    A95ANT \r\n
 
     '''Form:'''    A95ANT \r\n
 
     '''Uses:'''    A95ANT\r\n
 
     '''Uses:'''    A95ANT\r\n
 
     '''Rtrn:'''    ACK
 
     '''Rtrn:'''    ACK
 
 
−
   '''A95MODE''' -  A9500 Oper/Stby (toggle)
+
   '''A95MODE''' -  '''A9500 Oper/Stby (toggle)'''
 
     '''Form:'''    A95MODE \r\n
 
     '''Form:'''    A95MODE \r\n
 
     '''Uses:'''    A95MODE\r\n
 
     '''Uses:'''    A95MODE\r\n
 
     '''Rtrn:'''    ACK
 
     '''Rtrn:'''    ACK
 +
 +
    '''KPAPWR''' -  '''KPA500 Amp Power On/Off'''
 +
    '''Form:'''    KPAPWR \r\n
 +
    '''Uses:'''    KPAPWR\r\n
 +
    '''Rtrn:'''    KPA:{On|Off}
 +
 +
  '''KPAMODE''' -  '''KPA500 Oper/Stby (toggle)'''
 +
    '''Form:'''    KPAMODE \r\n
 +
    '''Uses:'''    KPAMODE\r\n
 +
    '''Rtrn:'''    KPA:{Oper|Stby}

Revision as of 15:12, 7 September 2013

General

Allows third party Ethernet clients to remotely control DDUtil_V3 functionality.

Setup

Connection

Connections are restricted to the Local Area Network (LAN) that DDUtil is connected to.

  • Use the IP address of the host PC DDUtil is open on; i.e. 192.168.1.xxx.
  • Use port 5678

Commands

The following commands are available for remote DDUtil control.
Notes:

  • Commands must be input EXACTLY as shown below.
  • All commands must be terminated with a CRLF (\r\n).
  • ACK returns only guarantee the commands were sent, not that they actually worked.
  • Rotor feedback is provided anytime the rotor moves whether initiated from this app, manually or some other manner. 


GETSLICE  -  Gets frequency of a radio slice n (n = 0-7)						  
   Form:     GETSLICE P1 \r\n			
   Parm:     P1 = Slice number 0-7
   Uses:     GETSLICE2\r\n	
   Rtrn:     Slice2:00014123456

SETSLICE  -  Sets frequency of a radio slice n (n = 0-7)						  
   Form:     SETSLICE P1 \r\n			
   Parm:     P1 = Slice number 0-7
   Uses:     SETSLICE2\r\n	
   Rtrn:     ACK

GETROTOR  -  Gets Rotor position						  
   Form:     GETROTOR \r\n			
   Uses:     GETROTOR\r\n	
   Rtrn:     Head:045

SETROTOR  -  Sets Rotor position						  
   Form:     SETROTOR \r\n			
   Uses:     SETROTOR045\r\n	
   Rtrn:     Head:045 (when finished turning)

TOGGLEPTT -  Toggle Auto Drive Oper/Stby (PTT)						
    Form:    TOGGLEPTT \r\n			
    Uses:    TOGGLEPTT\r\n	
    Rtrn:    PTT:{Oper|Stby}

   A95PWR -  A9500 Amp Power On						
    Form:    A95PWR \r\n			
    Uses:    A95PWR\r\n	
    Rtrn:    ACK

   A95AUX -  A9500 Aux Power On / Power Off						
    Form:    A95AUX \r\n			
    Uses:    A95AUX\r\n	
    Rtrn:    ACK

  A95AUTO -  A9500 Auto Mode On/Off (toggle)						
    Form:    A95AUTO \r\n			
    Uses:    A95AUTO\r\n	
    Rtrn:    ACK

   A95ANT -  A9500 Antenna Select (steps 1-4)						
    Form:    A95ANT \r\n			
    Uses:    A95ANT\r\n	
    Rtrn:    ACK

  A95MODE -  A9500 Oper/Stby (toggle)						
    Form:    A95MODE \r\n			
    Uses:    A95MODE\r\n	
    Rtrn:    ACK

   KPAPWR -  KPA500 Amp Power On/Off						
    Form:    KPAPWR \r\n			
    Uses:    KPAPWR\r\n	
    Rtrn:    KPA:{On|Off}

  KPAMODE -  KPA500 Oper/Stby (toggle)						
    Form:    KPAMODE \r\n			
    Uses:    KPAMODE\r\n	
    Rtrn:    KPA:{Oper|Stby}
Retrieved from "http://k5fr.com/DDUtilV3wiki/index.php?title=TCP_Server&oldid=436"