Documentation/Version Number Changes
This commit is contained in:
@@ -1,7 +1,6 @@
|
||||
function socket = clearUDPBuffer(socket,varargin)
|
||||
% clearUDPBuffer Script that clears an UDP Socket Buffer by closing and
|
||||
% reopening the socket
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% Socket: UDP Socket to be cleared
|
||||
@@ -14,12 +13,6 @@ function socket = clearUDPBuffer(socket,varargin)
|
||||
% 2. Socket = openUDP(49005);
|
||||
% 3. Socket = clearUDPBuffer(Socket);
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] Added Versioning
|
||||
% 09/12/13: [CT] Add optional arguments
|
||||
% 09/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function [socket] = closeUDP(socket)
|
||||
% closeUDP Script that closes a UDP Socket
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% Socket: UDP Socket to be closed
|
||||
@@ -13,11 +12,6 @@ function [socket] = closeUDP(socket)
|
||||
% 2. Socket = openUDP(49005);
|
||||
% 3. Status = closeUDP(Socket);
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Added Versioning
|
||||
% 09/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function [socket] = openUDP(port, varargin)
|
||||
%openUDP Script that opens an UDP Socket
|
||||
% Version 0.25
|
||||
%
|
||||
%Inputs
|
||||
% port: UDP Port for socket
|
||||
@@ -14,12 +13,6 @@ function [socket] = openUDP(port, varargin)
|
||||
% or
|
||||
% 2. Socket = openUDP(49005); %Open socket at port 49005 with timeout=0.2 sec
|
||||
%
|
||||
%Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] Added Versioning
|
||||
% 09/12/13: [CT] Added optional timeout input argument
|
||||
% 09/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function status = pauseSim( pause, varargin )
|
||||
%pauseSim pause Simulation
|
||||
% Version 0.25
|
||||
%
|
||||
%Inputs
|
||||
% Pause: binary value 0=run, 1=pause
|
||||
@@ -14,10 +13,6 @@ function status = pauseSim( pause, varargin )
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. status = pauseSim(1);
|
||||
%
|
||||
%Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/19/14: [CT] V0.2: First Created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function [ sensor ] = readDATA( socket )
|
||||
% readDATA Reads UDP Socket and interprets data
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% location: Either an opened UDP Socket or integer port number
|
||||
@@ -29,13 +28,7 @@ function [ sensor ] = readDATA( socket )
|
||||
% 2. data = readDATA(49005);
|
||||
%
|
||||
% NOTE: sending in a port number instead of an opened socket clears the UDP buffer. This only works if the data is being sent at a fast rate. Sending in a UDP Socket reads the first packet in the buffer.
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Updated to work with new Plugin
|
||||
% 09/10/13: [CT] Updated to receive UDP socket or port number
|
||||
% 06/10/13: [CT] Code created
|
||||
%
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function [ data ] = readUDP( input )
|
||||
%readUDP Read Array from UDP Socket
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% input: Either an opened UDP Socket or integer port number
|
||||
@@ -23,12 +22,6 @@ function [ data ] = readUDP( input )
|
||||
%UDP buffer. This only works if the data is being sent at a fast rate.
|
||||
%Sending in a UDP Socket reads the first packet in the buffer.
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Added Versioning
|
||||
% 09/08/13: [CT] Added option for either UDP Socket or port number input
|
||||
% 06/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function result = requestDREF( DREFArray, varargin )
|
||||
%requestDREF request the value of a specific DataRef from X-Plane over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
%Inputs
|
||||
% DREFArray: Cell Array of DataRefs to be requested
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function [ status ] = selectDATA( index, varargin )
|
||||
% selectDATA Choose specific X-Plane parameters to be send over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% index: An array of the values that to be sent. Corresponds to the numbers on the XPlane Output screen
|
||||
@@ -14,11 +13,6 @@ function [ status ] = selectDATA( index, varargin )
|
||||
% 1. import XPlaneConnect.*;
|
||||
% 2. values = [1, 2, 3, 27, 40];
|
||||
% 3. status = selectDATA( values, '127.0.0.1', 49005 ); % send to localhose port 49005
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Added Versioning
|
||||
% 06/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function [ status ] = sendCTRL( ctrl, acft, IP, port )
|
||||
% sendCTRL Send X-Plane Aircraft Control Commands over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% ctrl: control array where the elements are as follows:
|
||||
@@ -24,10 +23,6 @@ function [ status ] = sendCTRL( ctrl, acft, IP, port )
|
||||
%
|
||||
% Note: send the value -998 to not overwrite that parameter. That is, if -998 is sent, the parameter will stay at the current X-Plane value
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 09/26/14: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function [ status ] = sendDATA(data, varargin)
|
||||
% sendDATA Send X-Plane formatted DATA over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% data: X-Plane formatted data. Is a matlab structure with the following fields:
|
||||
@@ -20,11 +19,6 @@ function [ status ] = sendDATA(data, varargin)
|
||||
%
|
||||
% Note: send the value -998 to not overwrite that parameter. That is, if -998 is sent, the parameter will stay at the current X-Plane value
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Updated to work with new Plugin
|
||||
% 06/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function status = sendDREF( dataRef, Value, varargin )
|
||||
% sendDREF Send a command to change any DataRef in X-Plane over UDP. This requires the X-Plane Connect Plugin to be running
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% dataRef: The X-Plane Dataref that will be chaged
|
||||
@@ -16,10 +15,6 @@ function status = sendDREF( dataRef, Value, varargin )
|
||||
% 2. dataRef = 'sim/aircraft/parts/acf_gear_deploy'; // Landing Gear
|
||||
% 3. Value = 0;
|
||||
% 4. status = sendDREF(dataRef, Value);
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: First Version
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function [ status ] = sendPOSI( posi, varargin )
|
||||
% sendPOSI Send X-Plane Aircraft Position over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% posi: Position array where the elements are as follows:
|
||||
@@ -25,10 +24,6 @@ function [ status ] = sendPOSI( posi, varargin )
|
||||
%
|
||||
% Note: send the value -998 to not overwrite that parameter. That is, if -998 is sent, the parameter will stay at the current X-Plane value
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 09/25/14: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function [ status ] = sendSTRU( STRU, varargin )
|
||||
%sendSTRU Send a MATLAB structure over UDP
|
||||
% Version 0.25
|
||||
%
|
||||
%Inputs
|
||||
% stru: A MATLAB structure
|
||||
@@ -16,11 +15,6 @@ function [ status ] = sendSTRU( STRU, varargin )
|
||||
% 3. #Send the data structure to port 49005 on the computer at IP address 172.0.100.54
|
||||
% 4. status = sendUDP( data, '172.0.100.54', 49005 );
|
||||
%
|
||||
%Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/18/14: [CT] V0.2: Added Versioning
|
||||
% 08/01/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,6 +1,5 @@
|
||||
function [ status ] = sendUDP( data, IP, port )
|
||||
%sendUDP Send an one dimensional array of type uint8 data over an UDP connection using a java DatagramSocket
|
||||
% Version 0.25
|
||||
%
|
||||
%Inputs
|
||||
% Data: 1-D array of type uint8 data to be sent
|
||||
@@ -16,12 +15,6 @@ function [ status ] = sendUDP( data, IP, port )
|
||||
% 3. #Send the data array to port 49005 on the computer at IP address 172.0.100.54.
|
||||
% 4. status = sendUDP( data, '172.0.100.54', 49005 );
|
||||
%
|
||||
%Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 09/25/14: [CT] V0.24: Added persistant socket
|
||||
% 04/21/14: [CT] V0.2:Added Versioning, support for DREF/SIMU/GETD/CONN
|
||||
% 06/10/13: [CT] Code created
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
% christopher.a.teubert@nasa.gov
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
function status = setConn( recvPort, IP, port )
|
||||
% setConn Send a command to set up the port where you will receive data on
|
||||
% this computer.
|
||||
% Version 0.25
|
||||
%
|
||||
% Inputs
|
||||
% Receiving Port: Port that data will be sent to in the future for this connection
|
||||
@@ -14,10 +13,6 @@ function status = setConn( recvPort, IP, port )
|
||||
% Use
|
||||
% 1. import XPlaneConnect.*
|
||||
% 2. status = setConn(49011);
|
||||
%
|
||||
% Change Log
|
||||
% 10/02/14: [CT] V0.25: Updated to work with updated xpcPlugin
|
||||
% 04/21/14: [CT] V0.2: First Version
|
||||
%
|
||||
% Contributors
|
||||
% [CT] Christopher Teubert (SGT, Inc.)
|
||||
|
||||
Reference in New Issue
Block a user