Changes between Version 6 and Version 7 of Documentation

Timestamp:

12/07/09 14:56:02 (3 years ago)

Author:

atorf

Comment:

Updated command layer structure to 4.0x

Documentation

@@ -100 +100 @@
 {{{
 #!html
-<br><br>
+<br>
 <table  border="2" cellpadding="10" align="center">
 
@@ -116 +116 @@
     <td align="center" width="40"><b>4</b></td>
     <td><b>High Level Regulation / Utilities</b></td>
-    <td valign="top"><b>MotorRotateAbs</b> (o)<br><br><b>WaitForMotor</b> (o)</td>
+    <td valign="top"><b>NXTMotor</b><br>.ReadFromNXT<br>.SendToNXT<br>.Stop<br>.WaitFor<br>.ResetPosition<br><br><b>NXC_MotorControl<br></td>
     <td valign="top">&nbsp;</td>
-    <td valign="top"><b>OptimizeToolboxPerformance</b></td>
+    <td valign="top"><b>OptimizeToolboxPerformance</b><br><br><b>GUI_WatchMotorState</b><br><b>GUI_WatchSensor</b></td>
     <td valign="top"><b>COM_MakeBTConfigFile</b></td>
   </tr>
@@ -124 +124 @@
   <!-- Layer 3 -->
   <tr bgcolor="#BBBBFF">
-    <th align="center" rowspan="2"><b>3</b></th>
-    <th align="left" rowspan="2"><b>High Level Functions</b></th>
-    <td align="left" valign="top"><b>NXTmotor</b><br>ReadFromNXT<br>SendToNXT<br>Stop<br>WaitFor<br>ResetPosition<br><br><b>NXC_MotorControl<br>NXC_ResetErrorCorrection</b></td>
-    <th align="left" valign="top" rowspan="2"><b>OpenLight<br>OpenSound<br>OpenSwitch<br>OpenUltrasonic<br>OpenAccelerator<br>OpenInfrared<br>OpenCompass<br>OpenGyro<br>OpenRFID<br>OpenColor<br><br>GetLight<br>GetSound<br>GetSwitch<br>GetAccelerator<br>GetInfrared<br>GetUltrasonic</b><br>USMakeSnapshot<br>USGetSnapshotResults<br><b>GetCompass</b><br>CalibrateCompass<br>GetColor<br>CalibrateColor<br>GetRFID<br>GetGyro<br><br><b>CloseSensor</b></th>
-    <th align="left" valign="top" rowspan="2">readFromIniFile<br><br>MAP_GetCommModule<br>MAP_GetInputModule<br>MAP_GetOutputModule<br>MAP_GetSoundModule<br>MAP_GetUIModule<br><br>MAP_SetOutputModule</th>
-    <th align="left" valign="top" rowspan="2"><b>COM_OpenNXT</b><br>COM_OpenNXTEx<br><br><b>COM_CloseNXT</b><br><br><b>COM_ReadI2C</b><br></th>
+    <th align="center" rowspan="1"><b>3</b></th>
+    <th align="left" rowspan="1"><b>High Level Functions</b></th>
+    <td align="left" valign="top"><b>DirectMotorCommand</b><br><br><b>StopMotor</b><br><br><b>SwitchLamp</b><br><br>NXC_ResetErrorCorrection</td>
+    <td align="left" valign="top" rowspan="1"><b>OpenLight<br>GetLight<br><br>OpenSound<br>GetSound<br><br>OpenSwitch<br>GetSwitch<br><br>OpenUltrasonic<br>GetUltrasonic<br>USMakeSnapshot<br>USGetSnapshotResults<br><br>OpenAccelerator<br>GetAccelerator<br><br>OpenColor<br>CalibrateColor<br>GetColor<br><br>OpenCompass<br>CalibrateCompass<br>GetCompass<br><br>OpenGyro<br>CalibrateGyro<br>GetGyro<br><br>OpenInfrared<br>GetInfrared<br><br>OpenRFID<br>GetRFID<br><br>CloseSensor</b></td>
+    <td align="left" valign="top" rowspan="1"><b>readFromIniFile</b><br><br>MAP_GetCommModule<br>MAP_GetInputModule<br>MAP_GetOutputModule<br>MAP_GetSoundModule<br>MAP_GetUIModule<br><br>MAP_SetOutputModule<br><br>NXC_GetSensorMotorData</td>
+    <td align="left" valign="top" rowspan="1"><b>COM_OpenNXT</b><br><b>COM_OpenNXTEx</b><br><br><b>COM_CloseNXT</b><br><br>COM_ReadI2C<br></td>
   </tr>
-  <tr bgcolor="#BBBBFF">
-    <td align="left" valign="top"><b>SendMotorSettings</b> (o)<br>SetMotor (o)<br>SetPower (o)<br>SetAngleLimit (o)<br>SetRampMode (o)<br>SpeedRegulation (o)<br>SyncToMotor (o)<br><br><b>StopMotor</b><br><br><b>GetMotorSettings</b> (o)<br>GetMotor (o)<br><br><b>ResetMotorAngle</b> (o)<br><br><b>SwitchLamp</b><br><br>SetMemoryCount (o)<br>GetMemoryCount (o)</td>
-  </tr>
+
   
 
@@ -142 +140 @@
     <td valign="top"><b>NXT_SetOutputState<br><br>NXT_GetOutputState<br><br>NXT_ResetMotorPosition</b></td>
     <td valign="top"><b>NXT_SetInputMode<br><br>NXT_GetInputValues</b><br><br>NXT_ResetInputScaledValue<br><br>NXT_LSRead<br>NXT_LSWrite<br>NXT_LSGetStatus</td>
-    <td valign="top"><b>NXT_PlayTone</b><br>NXT_PlaySoundFile<br>NXT_StopSoundPlayback<br><br>NXT_StartProgram<br>NXT_StopProgram<br><br>NXT_SendKeepAlive<br>NXT_GetBatteryLevel<br>NXT_GetFirmwareVersion<br>NXT_SetBrickName<br><br>NXT_ReadIOMap<br>NXT_WriteIOMap<br><br>NXT_MessageWrite<br></td>
-    <td valign="top">COM_CreatePacket<br>COM_SendPacket<br>COM_CollectPacket<br><br>COM_SetDefaultNXT<br>COM_GetDefaultNXT<br></td>
+    <td valign="top"><b>NXT_PlayTone</b><br>NXT_PlaySoundFile<br>NXT_StopSoundPlayback<br><br>NXT_StartProgram<br>NXT_GetCurrentProgramName<br>NXT_StopProgram<br><br>NXT_SendKeepAlive<br>NXT_GetBatteryLevel<br>NXT_GetFirmwareVersion<br>NXT_SetBrickName<br><br>NXT_ReadIOMap<br>NXT_WriteIOMap<br><br>NXT_MessageWrite<br>NXT_MessageRead</td>
+    <td valign="top">COM_CreatePacket<br>COM_SendPacket<br>COM_CollectPacket<br><br><b>COM_SetDefaultNXT</b><br>COM_GetDefaultNXT<br></td>
   </tr>
 
   <!-- Layer 1 -->
-  <tr bgcolor="#7777DD">
+  <tr bgcolor="#7777FF">
     <td align="center"><b>1</b></td>
     <td><b>Low Level Functions:<br>Helper, Conversion and<br> Lookup Functions</b></td>
-    <td valign="top">MOTOR_A<br>MOTOR_B<br>MOTOR_C<br><br><i>byte2outputmode<br>byte2regmode<br>byte2runstate<br>outputmode2byte<br>regmode2byte<br>runstate2byte</i><br><br><i>initializeGlobalMotorStateVar</i> (o)<br><i>resetMotorRegulation</i> (o)</td>
-    <td valign="top">SENSOR_1<br>SENSOR_2<br>SENSOR_3<br>SENSOR_4<br><br><i>byte2sensortype<br>byte2sensormode<br>sensortype2byte<br>sensormode2byte</i><br><br><i>waitUntilI2CReady</i></td>
-    <td valign="top">DebugMode<br><i>isdebug</i><br><br>textOut<br><br>tictic (o)<br>toctoc (o)<br><br><i>dec2wordbytes<br>name2commandbytes<br>commandbyte2name<br>wordbytes2dec</i></td>
+    <td valign="top"><b>MOTOR_A<br>MOTOR_B<br>MOTOR_C</b><br><br><i>SetMotor</i> (o)<br><i>SetPower</i> (o)<br><i>SetAngleLimit</i> (o)<br><i>SetRampMode</i> (o)<br><i>SpeedRegulation</i> (o)<br><i>SyncToMotor</i> (o)<br><i>GetMotor</i> (o)<br><i>SetMemoryCount</i> (o)<br><i>GetMemoryCount</i> (o)<br>
+    <br><i>byte2outputmode<br>byte2regmode<br>byte2runstate<br>outputmode2byte<br>regmode2byte<br>runstate2byte</i><br><br><i>initializeGlobalMotorStateVar</i> (o)</td>
+    <td valign="top"><b>SENSOR_1<br>SENSOR_2<br>SENSOR_3<br>SENSOR_4</b><br><br><i>byte2sensortype<br>byte2sensormode<br>sensortype2byte<br>sensormode2byte</i><br><br><i>waitUntilI2CReady</i></td>
+    <td valign="top"><b>DebugMode</b><br><i>isdebug</i><br><br>textOut<br><br><i>dec2wordbytes<br>name2commandbytes<br>commandbyte2name<br>wordbytes2dec</i></td>
     <td valign="top">checkStatusByte<br><br><i>createHandleStruct</i><br><i>checkHandleStruct</i><br><br><i>getLibusbErrorString</i><br><i>getVISAErrorString</i><br><i>getReplyLengthFromCmdByte</i><br><br><i>fantom_proto</i><br><i>libusb_proto</i></td>
   </tr>
@@ -164 +163 @@
 MAP_* = Functions related to the NXT module maps<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+NXC_* = Functions communicating with the embedded NXC program MotorControl<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <b>bold</b> = Main funcions or main group functions<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <i>italic</i> = private functions<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-(o) = obsolete functions (will be removed in a future release)
+(o) = obsolete / deprecated functions (might be removed in a future release)
     </td>
   </tr>
 </table>
-<br><br>
+<br>
 }}}