root/branches/livecd/RWTHMindstormsNXT/doc/functions/help/MAP_GetCommModule.html @ 465

Revision 465, 7.8 KB (checked in by behrens, 5 years ago)

NXTmotor: remove "silent toggling" and move adaptive default settings in constructor
SendToNXT: add warning of ignoring Speedregulation in the case of MultipleMotorPorts?, disabled brakeAtTachoLimit=0 warning, add missing %
Line 
1
2<!DOCTYPE html
3  PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4<html>
5   <head>
6      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
7   
8      <!--
9This HTML is auto-generated from an M-file.
10To make changes, update the M-file and republish this document.
11      -->
12      <title>MAP_GetCommModule</title>
13      <meta name="generator" content="MATLAB 7.7">
14      <meta name="date" content="2008-11-05">
15      <meta name="m-file" content="script_MAP_GetCommModule">
16<link type="text/css" rel="stylesheet" href="../../style.css">
17  </head>
18   <body>
19<p class="header">RWTH - Mindstorms NXT Toolbox</p>
20      <div class="content">
21         <h1>MAP_GetCommModule</h1>
22         <!--introduction-->
23         <p>Reads the IO map of the communication module</p>
24         <!--/introduction-->
25         <h2>Contents</h2>
26         <div>
27            <ul>
28               <li><a href="#2">Syntax</a></li>
29               <li><a href="#4">Description</a></li>
30               <li><a href="#35">Examples</a></li>
31               <li><a href="#37">See also</a></li>
32               <li><a href="#39">Signature</a></li>
33            </ul>
34         </div>
35         <h2>Syntax<a name="2"></a></h2>
36         <p><tt>map = MAP_GetCommModule()</tt></p>
37         <h2>Description<a name="4"></a></h2>
38         <p><tt>map = MAP_GetCommModule()</tt> returns the IO map of the communication module. The return value <tt>map</tt> is a struct variable. It contains all communication module information.
39         </p>
40         <p><b>Output:</b></p>
41         <p><tt>map.PFunc</tt>              % ?
42         </p>
43         <p><tt>map.PFuncTwo</tt>           % ?
44         </p>
45         <p><tt>map.BTPort</tt>             % 1x4 cell array contains Bluetooth device information of each NXT Bluetooth port (i = 0..3)
46         </p>
47         <p><tt>map.BTPort{i}.BtDeviceTableName</tt>            % name of the Bluetooth device
48         </p>
49         <p><tt>map.BTPort{i}.BtDeviceTableClassOfDevice</tt>   % class of the Bluetooth device
50         </p>
51         <p><tt>map.BTPort{i}.BtDeviceTableBdAddr</tt>          % MAC address of the Bluetooth device
52         </p>
53         <p><tt>map.BTPort{i}.BtDeviceTableDeviceStatus</tt>    % status of the Bluetooth device
54         </p>
55         <p><tt>map.BTPort{i}.BtConnectTableName</tt>           % name of the connected Bluetooth device
56         </p>
57         <p><tt>map.BTPort{i}.BtConnectTableClassOfDevice</tt>  % class of the connected Bluetooth device
58         </p>
59         <p><tt>map.BTPort{i}.BtConnectTablePinCode</tt>        % pin code of the connected Bluetooth device
60         </p>
61         <p><tt>map.BTPort{i}.BtConnetTableBdAddr</tt>          % MAC address of the connected Bluetooth device
62         </p>
63         <p><tt>map.BTPort{i}.BtConnectTableHandleNr</tt>       % handle nr of the connected Bluetooth device
64         </p>
65         <p><tt>map.BTPort{i}.BtConnectTableStreamStatus</tt>   % stream status of the connected Bluetooth device
66         </p>
67         <p><tt>map.BTPort{i}.BtConnectTableLinkQuality</tt>    % link quality of the connected Bluetooth device
68         </p>
69         <p><tt>map.BrickDataName</tt>               % name of the NXT brick
70         </p>
71         <p><tt>map.BrickDataBluecoreVersion</tt>    % Bluecore version number
72         </p>
73         <p><tt>map.BrickDataBdAddr</tt>             % MAC address of the NXT brick
74         </p>
75         <p><tt>map.BrickDataBtStateStatus</tt>      % Bluetooth state status
76         </p>
77         <p><tt>map.BrickDataBtHwStatus</tt>         % NXT hardware status
78         </p>
79         <p><tt>map.BrickDataTimeOutValue</tt>       % time out value
80         </p>
81         <p><tt>map.BtDeviceCnt</tt>                 % number of devices defined within the Bluetooth device table
82         </p>
83         <p><tt>map.BtDeviceNameCnt</tt>             % number of devices defined within the Bluetooth device table (usually equal to BtDeviceCnt)
84         </p>
85         <p><tt>map.HsFlags</tt>                     % High Speed flags
86         </p>
87         <p><tt>map.HsSpeed</tt>                     % High Speed speed
88         </p>
89         <p><tt>map.HsState</tt>                     % High Speed state
90         </p>
91         <p><tt>map.HsSpeed</tt>                     % High Speed speed
92         </p>
93         <p><tt>map.UsbState</tt>                    % USB state
94         </p>
95         <h2>Examples<a name="35"></a></h2><pre class="codeinput">   map = MAP_GetCommModule();
96</pre><h2>See also<a name="37"></a></h2>
97         <p><a href="NXT_ReadIOMap.html">NXT_ReadIOMap</a></p>
98         <h2>Signature<a name="39"></a></h2>
99         <div>
100            <ul>
101               <li><b>Author:</b> Alexander Behrens (see AUTHORS)
102               </li>
103               <li><b>Date:</b> 2008/05/23
104               </li>
105               <li><b>Copyright:</b> 2007-2008, RWTH Aachen University
106               </li>
107            </ul>
108         </div>
109         <p class="footer"><br>
110            Published with wg_publish; V1.0<br></p>
111      </div>
112      <!--
113##### SOURCE BEGIN #####
114%% MAP_GetCommModule
115% Reads the IO map of the communication module
116%%
117%% Syntax
118% |map = MAP_GetCommModule()|
119%%
120%% Description
121% |map = MAP_GetCommModule()| returns the IO map of the communication module. The return
122% value |map| is a struct variable. It contains all communication module information.
123%%
124%%
125% *Output:*
126%%
127% |map.PFunc|              % ?
128%%
129% |map.PFuncTwo|           % ?
130%%
131% |map.BTPort|             % 1x4 cell array contains Bluetooth device information of each
132% NXT Bluetooth port (i = 0..3)
133%%
134% |map.BTPort{i}.BtDeviceTableName|            % name of the Bluetooth device
135%%
136% |map.BTPort{i}.BtDeviceTableClassOfDevice|   % class of the Bluetooth device
137%%
138% |map.BTPort{i}.BtDeviceTableBdAddr|          % MAC address of the Bluetooth device
139%%
140% |map.BTPort{i}.BtDeviceTableDeviceStatus|    % status of the Bluetooth device
141%%
142% |map.BTPort{i}.BtConnectTableName|           % name of the connected Bluetooth device
143%%
144% |map.BTPort{i}.BtConnectTableClassOfDevice|  % class of the connected Bluetooth device
145%%
146% |map.BTPort{i}.BtConnectTablePinCode|        % pin code of the connected Bluetooth device
147%%
148% |map.BTPort{i}.BtConnetTableBdAddr|          % MAC address of the connected Bluetooth device
149%%
150% |map.BTPort{i}.BtConnectTableHandleNr|       % handle nr of the connected Bluetooth device
151%%
152% |map.BTPort{i}.BtConnectTableStreamStatus|   % stream status of the connected Bluetooth device
153%%
154% |map.BTPort{i}.BtConnectTableLinkQuality|    % link quality of the connected Bluetooth device
155%%
156% |map.BrickDataName|               % name of the NXT brick
157%%
158% |map.BrickDataBluecoreVersion|    % Bluecore version number
159%%
160% |map.BrickDataBdAddr|             % MAC address of the NXT brick
161%%
162% |map.BrickDataBtStateStatus|      % Bluetooth state status
163%%
164% |map.BrickDataBtHwStatus|         % NXT hardware status
165%%
166% |map.BrickDataTimeOutValue|       % time out value
167%%
168% |map.BtDeviceCnt|                 % number of devices defined within the Bluetooth device table
169%%
170% |map.BtDeviceNameCnt|             % number of devices defined within the Bluetooth device table
171% (usually equal to BtDeviceCnt)
172%%
173% |map.HsFlags|                     % High Speed flags
174%%
175% |map.HsSpeed|                     % High Speed speed
176%%
177% |map.HsState|                     % High Speed state
178%%
179% |map.HsSpeed|                     % High Speed speed
180%%
181% |map.UsbState|                    % USB state
182%%
183%% Examples
184   map = MAP_GetCommModule();
185%%
186%% See also
187% NXT_ReadIOMap
188%%
189%% Signature
190%%
191% * *Author:* Alexander Behrens (see AUTHORS)
192% * *Date:* 2008/05/23
193% * *Copyright:* 2007-2008, RWTH Aachen University
194%
195
196##### SOURCE END #####
197-->
198   </body>
199</html>
Note: See TracBrowser for help on using the browser.