Show
Ignore:
Timestamp:
09/25/08 18:56:32 (5 years ago)
Author:
behrens
Message:

add modification

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/mfiles/Contents.m

    r173 r308  
    1 % RWTH - Mindstorms NXT Toolbox  
    2 % Version 2.00beta 17-Jul-2008 
     1% RWTH - Mindstorms NXT Toolbox 
     2% Version 2.00 25-Sep-2008 
    33% Files 
    4 %   checkStatusByte           - Interpretes the status byte of a return package and creates an error message 
    5 %   CloseSensor               - Closes a specified sensor port (e.g. turns off the active light mode of the NXT light sensor) 
    6 %   COM_CloseNXT              - Closes and deletes a specific NXT handle, or clears all existing handles 
    7 %   COM_CollectPacket         - Reads data from a USB or serial/Bluetooth port and retrieves exactly one packet 
    8 %   COM_CreatePacket          - Generates a valid Bluetooth packet ready for transmission (i.e. calculates length) 
    9 %   COM_GetDefaultNXT         - Returns the global default NXT handle if it was previously set 
    10 %   COM_MakeBTConfigFile      - Creates a Bluetooth configuration file which is needed to open a Bluetooth connection. 
    11 %   COM_OpenNXT               - Opens a USB or Bluetooth connection to an NXT device and returns a handle for future use 
    12 %   COM_OpenNXTEx             - Opens a Bluetooth or USB connection to an NXT device and returns a handle for future use 
    13 %   COM_SendPacket            - Sends a communication protocol packet (byte-array) via a USB or Bluetooth channel (serial port) 
    14 %   COM_SetDefaultNXT         - Sets a global default NXT handle that will be used by other functions if no handle is specified. 
    15 %   DebugMode                 - Gets or sets the debug state (i.e. if textOut will print messages to the command window) 
    16 %   GetLight                  - Reads the current value of the NXT light sensor 
    17 %   GetMemoryCount            - Gets the internal NXT memory counter (manual mapping replica) 
    18 %   GetMotor                  - Reads the current motor set by SetMotor(). Raises an error if no motor was set 
    19 %   GetMotorSettings          - Returns the current motor data / settings (e.g. position, speed, etc.) from the specified motor 
    20 %   GetSound                  - Reads the current value of the NXT sound sensor 
    21 %   GetSwitch                 - Reads the current value of the NXT switch / touch sensor 
    22 %   GetUltrasonic             - Reads the current value of the NXT ultrasonic sensor 
    23 %   MAP_GetCommModule         - Reads the IO map of the communication module 
    24 %   MAP_GetInputModule        - Reads the IO map of the input module 
    25 %   MAP_GetOutputModule       - Reads the IO map of the output module 
    26 %   MAP_GetSoundModule        - Reads the IO map of the sound module 
    27 %   MAP_GetUIModule           - Reads the IO map of the user interface module 
    28 %   MAP_SetOutputModule       - Writes the IO map to the output module 
    29 %   MOTOR_A                   - Symbolic constant MOTOR_A (returns 0) 
    30 %   MOTOR_B                   - Symbolic constant MOTOR_B (returns 1) 
    31 %   MOTOR_C                   - Symbolic constant MOTOR_C (returns 2) 
    32 %   MotorRotateAbs            - Rotates a motor to an absolute angle 
    33 %   NXT_GetBatteryLevel       - Returns the current battery level in milli volts 
    34 %   NXT_GetFirmwareVersion    - Returns the protocol and firmware version of the NXT 
    35 %   NXT_GetInputValues        - Processes a complete sensor reading, i.e. requests input values and collects the answer. 
    36 %   NXT_GetOutputState        - Requests and retrieves an output motor state reading 
    37 %   NXT_LSGetStatus           - Gets the number of available bytes from low speed (digital) sensor (e.g. ultrasonic) 
    38 %   NXT_LSRead                - Reads data from a low speed (digital) sensor 
    39 %   NXT_LSWrite               - Writes the given data to a low speed (digital) sensor 
    40 %   NXT_PlaySoundFile         - Plays the given sound file on the NXT Brick 
    41 %   NXT_PlayTone              - Plays a tone with the given frequency and duration  
    42 %   NXT_ReadIOMap             - Reads the IO map of the given module ID 
    43 %   NXT_ResetInputScaledValue - Resets the sensors ScaledVal back to 0, depends on currently configured mode (see NXT_SetInputMode) 
    44 %   NXT_ResetMotorPosition    - Resets NXT internal counter for specified motor, relative or absolute counter 
    45 %   NXT_SendKeepAlive         - Sends a KeepAlive packet. Optional: requests sleep time limit. 
    46 %   NXT_SetBrickName          - Sets a new name for the NXT Brick (connected to the specified handle) 
    47 %   NXT_SetInputMode          - Sets mode, configures and initializes sensor ready to be read out 
    48 %   NXT_SetOutputState        - Sends previously specified settings to current active motor. 
    49 %   NXT_StartProgram          - Starts the given program on the NXT Brick 
    50 %   NXT_StopProgram           - Stops a specific program on the NXT Brick 
    51 %   NXT_StopSoundPlayback     - Stops the current sound playback 
    52 %   NXT_WriteIOMap            - Writes the IO map to the given module ID 
    53 %   OpenLight                 - Sets the parameter mode of the NXT light sensor 
    54 %   OpenSound                 - Sets the parameter mode of the NXT sound sensor 
    55 %   OpenSwitch                - Sets the parameter mode of the NXT switch / touch sensor 
    56 %   OpenUltrasonic            - Initializes and sets the mode of the NXT ultrasonic sensor 
    57 %   readFromIniFile           - Reads parameters from a configuration file (usually *.ini) 
    58 %   ResetMotorAngle           - Resets the relative angle counter for the given motor 
    59 %   SendMotorSettings         - Sends previously specified settings to current active motor. 
    60 %   SENSOR_1                  - Symbolic constant SENSOR_1 (returns 0) 
    61 %   SENSOR_2                  - Symbolic constant SENSOR_2 (returns 1) 
    62 %   SENSOR_3                  - Symbolic constant SENSOR_3 (returns 2) 
    63 %   SENSOR_4                  - Symbolic constant SENSOR_4 (returns 3) 
    64 %   SetAngleLimit             - Sets the angle limit (in degrees) of the current motor port 
    65 %   SetMemoryCount            - Sets the internal NXT memory counter (manual mapping replica) 
    66 %   SetMotor                  - Sets the current motor to use for motor setting commands 
    67 %   SetPower                  - Sets the power of the current active motor 
    68 %   SetRampMode               - Sets the runstate of the current active motor 
    69 %   SetTurnRatio              - Sets the turn ratio of the current active motor 
    70 %   SpeedRegulation           - Enables / disables the speed regulation mode of the current active motor 
    71 %   StopMotor                 - Stops / brakes specified motor. (Synchronisation will be lost after this) 
    72 %   SwitchLamp                - Switches the LEGO lamp on or off (has to be connected to a motor port) 
    73 %   SyncToMotor               - Enables synchronization regulation for current active and specified motor 
    74 %   textOut                   - Wrapper for fprintf() which can optionally write screen output to a logfile 
    75 %   tictic                    - Similar to MATLAB's tic(), but extended to save "more states" 
    76 %   toctoc                    - Similar to MATLAB's toc(), but extended to save "more states" 
    77 %   USGetSnapshotResults      - Retrieves up to eight echos (distances) stored inside the US sensor 
    78 %   USMakeSnapshot            - Causes the ultrasonic sensor to send one snapshot ("ping") and record the echos 
    79 %   WaitForMotor              - Pauses execution until specific motor is not running anymore.  
     4%   CalibrateCompass           - Enables calibration mode of the HiTechnic compass sensor 
     5%   checkStatusByte            - Interpretes the status byte of a return package and creates an error message 
     6%   CloseSensor                - Closes a specified sensor port (e.g. turns off the active light mode of the NXT light sensor) 
     7%   COM_CloseNXT               - Closes and deletes a specific NXT handle, or clears all existing handles 
     8%   COM_CollectPacket          - Reads data from a USB or serial/Bluetooth port and retrieves exactly one packet 
     9%   COM_CreatePacket           - Generates a valid Bluetooth packet ready for transmission (i.e. calculates length) 
     10%   COM_GetDefaultNXT          - Returns the global default NXT handle if it was previously set 
     11%   COM_MakeBTConfigFile       - Creates a Bluetooth configuration file which is needed to open a Bluetooth connection. 
     12%   COM_OpenNXT                - Opens a USB or Bluetooth connection to an NXT device and returns a handle for future use 
     13%   COM_OpenNXTEx              - Opens a Bluetooth or USB connection to an NXT device and returns a handle for future use 
     14%   COM_ReadI2C                - Requests and reads sensor data via I2C from a correctly configured digital sensor. 
     15%   COM_SendPacket             - Sends a communication protocol packet (byte-array) via a USB or Bluetooth channel (serial port) 
     16%   COM_SetDefaultNXT          - Sets a global default NXT handle that will be used by other functions if no handle is specified. 
     17%   DebugMode                  - Gets or sets the debug state (i.e. if textOut will print messages to the command window) 
     18%   GetAccelerator             - Reads the current value of the HiTechnic acceleration sensor 
     19%   GetCompass                 - Reads the current value of the HiTechnic compass sensor 
     20%   GetInfrared                - Reads the current value of the Hitechnic infrared sensor (infrared seeker) 
     21%   GetLight                   - Reads the current value of the NXT light sensor 
     22%   GetMemoryCount             - Gets the internal NXT memory counter (manual mapping replica) 
     23%   GetMotor                   - Reads the current motor set by SetMotor(). Raises an error if no motor was set 
     24%   GetMotorSettings           - Returns the current motor data / settings (e.g. position, speed, etc.) from the specified motor 
     25%   GetSound                   - Reads the current value of the NXT sound sensor 
     26%   GetSwitch                  - Reads the current value of the NXT switch / touch sensor 
     27%   GetUltrasonic              - Reads the current value of the NXT ultrasonic sensor 
     28%   MAP_GetCommModule          - Reads the IO map of the communication module 
     29%   MAP_GetInputModule         - Reads the IO map of the input module 
     30%   MAP_GetOutputModule        - Reads the IO map of the output module 
     31%   MAP_GetSoundModule         - Reads the IO map of the sound module 
     32%   MAP_GetUIModule            - Reads the IO map of the user interface module 
     33%   MAP_SetOutputModule        - Writes the IO map to the output module 
     34%   MOTOR_A                    - Symbolic constant MOTOR_A (returns 0) 
     35%   MOTOR_B                    - Symbolic constant MOTOR_B (returns 1) 
     36%   MOTOR_C                    - Symbolic constant MOTOR_C (returns 2) 
     37%   MotorRotateAbs             - Rotates a motor to an absolute angle 
     38%   NXT_GetBatteryLevel        - Returns the current battery level in milli volts 
     39%   NXT_GetFirmwareVersion     - Returns the protocol and firmware version of the NXT 
     40%   NXT_GetInputValues         - Processes a complete sensor reading, i.e. requests input values and collects the answer. 
     41%   NXT_GetOutputState         - Requests and retrieves an output motor state reading 
     42%   NXT_LSGetStatus            - Gets the number of available bytes from low speed (digital) sensor (e.g. ultrasonic) 
     43%   NXT_LSRead                 - Reads data from a low speed (digital) sensor 
     44%   NXT_LSWrite                - Writes the given data to a low speed (digital) sensor 
     45%   NXT_MessageWrite           - Sends a message to NXT 
     46%   NXT_PlaySoundFile          - Plays the given sound file on the NXT Brick 
     47%   NXT_PlayTone               - Plays a tone with the given frequency and duration  
     48%   NXT_ReadIOMap              - Reads the IO map of the given module ID 
     49%   NXT_ResetInputScaledValue  - Resets the sensors ScaledVal back to 0, depends on currently configured mode (see NXT_SetInputMode) 
     50%   NXT_ResetMotorPosition     - Resets NXT internal counter for specified motor, relative or absolute counter 
     51%   NXT_SendKeepAlive          - Sends a KeepAlive packet. Optional: requests sleep time limit. 
     52%   NXT_SetBrickName           - Sets a new name for the NXT Brick (connected to the specified handle) 
     53%   NXT_SetInputMode           - Sets mode, configures and initializes sensor ready to be read out 
     54%   NXT_SetOutputState         - Sends previously specified settings to current active motor. 
     55%   NXT_StartProgram           - Starts the given program on the NXT Brick 
     56%   NXT_StopProgram            - Stops a specific program on the NXT Brick 
     57%   NXT_StopSoundPlayback      - Stops the current sound playback 
     58%   NXT_WriteIOMap             - Writes the IO map to the given module ID 
     59%   OpenAccelerator            - Initializes and sets the mode of the HiTechnic acceleration sensor 
     60%   OpenCompass                - Initializes and sets the mode of the HiTechnic magnetic compass sensor 
     61%   OpenInfrared               - Initializes and sets the mode of the HiTechnic infrared seeker sensor 
     62%   OpenLight                  - Sets the parameter mode of the NXT light sensor 
     63%   OpenSound                  - Sets the parameter mode of the NXT sound sensor 
     64%   OpenSwitch                 - Sets the parameter mode of the NXT switch / touch sensor 
     65%   OpenUltrasonic             - Initializes and sets the mode of the NXT ultrasonic sensor 
     66%   OptimizeToolboxPerformance - Copies binary versions of typecastc to toolbox for better performance  
     67%   readFromIniFile            - Reads parameters from a configuration file (usually *.ini) 
     68%   ResetMotorAngle            - Resets the relative angle counter for the given motor 
     69%   SendMotorSettings          - Sends previously specified settings to current active motor. 
     70%   SENSOR_1                   - Symbolic constant SENSOR_1 (returns 0) 
     71%   SENSOR_2                   - Symbolic constant SENSOR_2 (returns 1) 
     72%   SENSOR_3                   - Symbolic constant SENSOR_3 (returns 2) 
     73%   SENSOR_4                   - Symbolic constant SENSOR_4 (returns 3) 
     74%   SetAngleLimit              - Sets the angle limit (in degrees) of the current motor port 
     75%   SetMemoryCount             - Sets the internal NXT memory counter (manual mapping replica) 
     76%   SetMotor                   - Sets the current motor to use for motor setting commands 
     77%   SetPower                   - Sets the power of the current active motor 
     78%   SetRampMode                - Sets the runstate of the current active motor 
     79%   SetTurnRatio               - Sets the turn ratio of the current active motor 
     80%   SpeedRegulation            - Enables / disables the speed regulation mode of the current active motor 
     81%   StopMotor                  - Stops / brakes specified motor. (Synchronisation will be lost after this) 
     82%   SwitchLamp                 - Switches the LEGO lamp on or off (has to be connected to a motor port) 
     83%   SyncToMotor                - Enables synchronization regulation for current active and specified motor 
     84%   textOut                    - Wrapper for fprintf() which can optionally write screen output to a logfile 
     85%   tictic                     - Similar to MATLAB's tic(), but extended to save "more states" 
     86%   toctoc                     - Similar to MATLAB's toc(), but extended to save "more states" 
     87%   USGetSnapshotResults       - Retrieves up to eight echos (distances) stored inside the US sensor 
     88%   USMakeSnapshot             - Causes the ultrasonic sensor to send one snapshot ("ping") and record the echos 
     89%   WaitForMotor               - Pauses execution until specific motor is not running anymore.