Changeset 144

Timestamp:

07/13/08 12:01:02 (5 years ago)

Author:

behrens

Message:

add function header template, modified CommandLayers.html

Location:

branches/atorf/RWTHMindstormsNXT

Files:

• DebugMode.m (modified) (1 diff)
• doc/functions/CommandLayers.html (modified) (6 diffs)
• isdebug.m (modified) (1 diff)

branches/atorf/RWTHMindstormsNXT/DebugMode.m

@@ -1 +1 @@
 function varargout = DebugMode(varargin)
+% 
+%  
+% Syntax
+%   || 
+%
+% Description
+%
+% Example
+%
+% See also: 
+%
+% Signature
+%   Author: Linus Atorf (see AUTHORS)
+%   Date: 2008/07/04
+%   Copyright: 2007-2008, RWTH Aachen University
+%
+;
+%
+% ***********************************************************************************************
+% *  This file is part of the RWTH - Mindstorms NXT Toolbox.                                    *
+% *                                                                                             *
+% *  The RWTH - Mindstorms NXT Toolbox is free software: you can redistribute it and/or modify  *
+% *  it under the terms of the GNU General Public License as published by the Free Software     *
+% *  Foundation, either version 3 of the License, or (at your option) any later version.        *
+% *                                                                                             *
+% *  The RWTH - Mindstorms NXT Toolbox is distributed in the hope that it will be useful,       *
+% *  but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS  *
+% *  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.             *
+% *                                                                                             *
+% *  You should have received a copy of the GNU General Public License along with the           *
+% *  RWTH - Mindstorms NXT Toolbox. If not, see <http://www.gnu.org/licenses/>.                 *
+% ***********************************************************************************************
+
     global DisableScreenOut
     

branches/atorf/RWTHMindstormsNXT/doc/functions/CommandLayers.html

@@ -31 +31 @@
     <td valign="top"><b>General</b></td>
     <td valign="top"><b>Bluetooth</b></td>
-  </tr> 
+  </tr>
 
   <tr bgcolor="#B5F1B4">
@@ -39 +39 @@
     <td valign="top">&nbsp;</td>
     <td valign="top">&nbsp;</td>
-    <td valign="top"><b>BT_MakeConfigFile</b></td>
-  </tr>  
+    <td valign="top"><b>COM_MakeBTConfigFile</b></td>
+  </tr>
 
   <tr bgcolor="#FFFF80">
@@ -47 +47 @@
     <td valign="top"><b>SendMotorSettings</b><br>SetMotor<br>SetPower<br>SetAngleLimit<br>SetRampMode<br>SpeedRegulation<br>SyncToMotor<br><br><b>StopMotor</b><br><br><b>GetMotorSettings</b><br>GetMotor<br><br><b>ResetMotorAngle</b><br><br>SetMemoryCount<br>GetMemoryCount</td>
     <td valign="top"><b>OpenLight<br>OpenSound<br>OpenSwitch<br>OpenUltrasonic<br><br>GetLight<br>GetSound<br>GetSwitch<br>GetUltrasonic<br><br>CloseSensor</b></td>
-    <td valign="top">readFromIniFile</td>
-    <td valign="top"><b>BT_OpenHandle</b><br><br><b>BT_CloseHandle</b><br>BT_CloseAllHandles<br><br></td>
-  </tr>  
+    <td valign="top">readFromIniFile<br><br>MAP_GetCommModule<br>MAP_GetInputModule<br>MAP_GetOutputModule<br>MAP_GetSoundModule<br>MAP_GetUIModule<br><br>MAP_SetOutputModule</td>
+    <td valign="top"><b>COM_OpenNXT</b><br>COM_OpenNXTEx<br><br><b>COM_CloseNXT</b><br></td>
+  </tr>
 
   <tr bgcolor="#F5BB80">
@@ -56 +56 @@
     <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_SendKeepAlive<br>NXT_GetBatteryLevel<br><br>NXT_StartProgram<br>NXT_StopProgram<br><br>NXT_SetBrickName<br></td>
-    <td valign="top">BT_CreatePacket<br>BT_SendPacket<br>BT_CollectPacket<br><br>BT_SetDefaultHandle<br>BT_GetDefaultHandle<br></td>
-  </tr>  
+    <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></td>
+    <td valign="top">COM_CreatePacket<br>COM_SendPacket<br>COM_CollectPacket<br><br>COM_SetDefaultNXT<br>COM_GetDefaultNXT<br></td>
+  </tr>
 
   <tr bgcolor="#FF80FF">
@@ -65 +65 @@
     <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<br>resetMotorRegulation</i></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></td>
-    <td valign="top">textOut<br><br>tictic (o)<br>toctoc (o)<br><br><i>dec2wordbytes<br>name2commandbytes<br>commandbyte2name<br>wordbytes2dec</i></td>
-    <td valign="top">checkStatusByte</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">checkStatusByte<br><br><i>createHandleStruct</i><br><i>checkHandleStruct</i><br><br><i>getLibusbErrorString</i><br><i>getVISAErrorString</i><br><i>getReplyLengthFromCmdByte</i></td>
   </tr>
 
@@ -72 +72 @@
     <td colspan="6" >legend: NXT_* = NXT Direct commands without any limitations (mapped to the LEGO direct command documentation)<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
-BT_* = Functions related to the Bluetooth connection<br>
+COM_* = Functions related to the NXT communication<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+MAP_* = Functions related to the NXT module maps<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 <b>bold</b> = Main funcions or main group functions<br>

branches/atorf/RWTHMindstormsNXT/isdebug.m

@@ -1 +1 @@
 function ret = isdebug
+% 
+%  
+% Syntax
+%   || 
+%
+% Description
+%
+% Example
+%
+% See also: 
+%
+% Signature
+%   Author: Linus Atorf (see AUTHORS)
+%   Date: 2008/07/04
+%   Copyright: 2007-2008, RWTH Aachen University
+%
+;
+%
+% ***********************************************************************************************
+% *  This file is part of the RWTH - Mindstorms NXT Toolbox.                                    *
+% *                                                                                             *
+% *  The RWTH - Mindstorms NXT Toolbox is free software: you can redistribute it and/or modify  *
+% *  it under the terms of the GNU General Public License as published by the Free Software     *
+% *  Foundation, either version 3 of the License, or (at your option) any later version.        *
+% *                                                                                             *
+% *  The RWTH - Mindstorms NXT Toolbox is distributed in the hope that it will be useful,       *
+% *  but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS  *
+% *  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.             *
+% *                                                                                             *
+% *  You should have received a copy of the GNU General Public License along with the           *
+% *  RWTH - Mindstorms NXT Toolbox. If not, see <http://www.gnu.org/licenses/>.                 *
+% ***********************************************************************************************
     
     %careful with empty var?