View source for Communication/FastData

=Introduction=
The FastData UDP server allows a UDP client to retrieve from the MC data about specific axes and variables.<br/>
The server is initialized upon MC startup and is immediately ready to respond to clients.<br/>
<br/>

==Server Functionality==
The server will receive client requests from any IP address, on port 60000.<br/>
The server will send axes data ONCE upon a SINGLE request received from the client, and will send<br/>
data only about axes that were specifically requested by the client.<br/>
Meaning the server is blocked on receive( ) and anticipates data from the client that indicates which axes data to send back.<br/><br/>
On version 1 of the FastData server, MC Integer and MC Double arrays are added to the requested axes data.<br/>
<br/>

==Client Request==
The client sends to the server a character array. Each cell in the array indicates an axis number.<br/>
A cell that is set to a value different from zero indicates that the client is interested in that specific axis’ data.<br/>

For Example, if cells 0, 5 and 13 are set to some value (not zero), it means that the client wants the data of axes numbers 1, 6 and 14.<br/>
<br/>

==Server Response==
Struct serverdata holds the FastData UDP version, arrays of MC Integer and MC Double (these arrays are set by the MC user) and requested data about the specified axes.<br/>
This struct allows backward compatibility in case that more data will be added to FastData in the future. It holds offsets from the head of the struct to beginnings of arrays of data and their lengths. This allows the client to read correctly the received data.<br/>
<br/>
Following is the definition of the struct as it appears in FastData Version 1:<br/>
<br/>
/* A structure to be sent back to the client after a request was received */<br/>
/* This structure holds the number of valid axis data structs and an array of the axis data structs */<br/><br/>
struct serverdata {<br/>
<br/>
:: INT32 version __attribute__ ((packed));       /* = FASTDATA_VERSION */<br/>
<br/>
:: INT32 axesdata_Offset __attribute__ ((packed));   /* Offset in bytes from beginning of data packet to axesdata array = &axesdata - &version */<br/>
:: INT32 numOfAxesStructs __attribute__ ((packed));  /* number of valid axes info structures in FastAxisData array */<br/>
:: INT32 sizeOfAxesStruct __attribute__ ((packed));  /* Size of 1 struct FastAxisData */<br/>
<br/>
:: INT32 int_array_Offset __attribute__ ((packed));  /* Offset in bytes from beginning of data packet to int_array = &int_array - &version */<br/>
:: INT32 int_array_length __attribute__ ((packed));  /* number of integers in array = USER_REGISTER_LENGTH */<br/>
<br/>
:: INT32 double_array_Offset __attribute__ ((packed));  /* Offset in bytes from beginning of data packet to double_array = &double_array - &version */<br/>
:: INT32 double_array_length __attribute__ ((packed));  /* number of doubles in array = USER_REGISTER_LENGTH */<br/>
<br/>
:: // Additional data set by a user task<br/>
:: INT32 int_array[USER_REGISTER_LENGTH] __attribute__ ((packed));			/* user data integer array */<br/>
:: double double_array[USER_REGISTER_LENGTH] __attribute__ ((packed));		/* user data double array */<br/>
<br/>
:: struct FastAxisData axesdata[64];<br/>
};<br/><br/>

The Server sends the struct serverdata with the field numOfAxes holding the number of axes that were requested by the client (could be less than the total number of axes in the system), and an array of struct FastAxisData that holds axis data per each axis, including the specific axis number, and bus_cycle_num which holds the Sercos Sample count.<br/>

The array axesdata[-???-] has the length of the number of axes data structs which are sent back from the server to the client. It is populated sequentially, meaning, if the client was interested in 3 axes, say, 1, 6 and 19, the array axesdata[-???-] will have the length of 3, and indices 0, 1 and 2 will hold structs of axes 1, 6 and 19 respectively. <br/>


<br/>

==Fast Axis Data Structure==
According to the array received from the client, the server collects the data and populates the following data structures:<br/>
<br/>
/* This structure holds a specific axis data */<br/>
struct FastAxisData {<br/>
<br/>
:: int pnStatus __attribute__ ((packed));<br/>
:: int axisnumber __attribute__ ((packed));<br/>
:: int drvStat __attribute__ ((packed));            // drive status word<br/>
:: int bus_cycle_num __attribute__ ((packed));   // system (sample number)<br/>
<br/>
:: double  pCmd __attribute__ ((packed));               // position command (user)<br/>
:: double  pFb __attribute__ ((packed));                  // position feedback (user)<br/>
:: double  pExt __attribute__ ((packed));                  // position external<br/>
:: double  cCmd __attribute__ ((packed));               // position command (drive units)<br/>
:: double  cFb __attribute__ ((packed));                  // position feedback (drive units)<br/>
:: double  vCmd __attribute__ ((packed));               // velocity command<br/>
:: double  vFb __attribute__ ((packed));                  // velocity feedback<br/>
:: double  aCmd __attribute__ ((packed));               // acceleration command<br/>
:: double  tAddCmd __attribute__ ((packed));         // torque (additional) command<br/>
:: double  tFb __attribute__ ((packed));                   // torque feedback<br/>
};<br/>
<br/>
pnStatus is mapped as follows:<br/>
Bit 0 - IsSettled: Set to 1 when the generator has completed AND abs(Target_pos - Actual_pos) <= PositionErrorSettle<br/>
Bit 1 - IsMoving: Set to 1 when the profiler is active.<br/>
Bit 2 - DriveEnabled: Set to 1 when the drive associated with the axis is enabled.<br/>
Bit 3 - DriveFault: Set to 1 when a fault exists on the drive associated with the axis. All unused bits return 0.<br/>
<br/>
[[Category:Control:Offline]]