root/branches/livecd/RWTHMindstormsNXT/doc/functions/help/GetAccelerator.html @ 462

Revision 462, 4.2 KB (checked in by behrens, 5 years ago)

add warning (NXTmotor), comments, docus
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>GetAccelerator</title>
13      <meta name="generator" content="MATLAB 7.7">
14      <meta name="date" content="2008-11-04">
15      <meta name="m-file" content="script_GetAccelerator">
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>GetAccelerator</h1>
22         <!--introduction-->
23         <p>Reads the current value of the HiTechnic acceleration sensor</p>
24         <!--/introduction-->
25         <h2>Contents</h2>
26         <div>
27            <ul>
28               <li><a href="#2">Syntax</a></li>
29               <li><a href="#5">Description</a></li>
30               <li><a href="#8">Example</a></li>
31               <li><a href="#10">See also</a></li>
32               <li><a href="#12">Signature</a></li>
33            </ul>
34         </div>
35         <h2>Syntax<a name="2"></a></h2>
36         <p><tt>acc_vector = GetAccelerator(port)</tt></p>
37         <p><tt>acc_vector = GetAccelerator(port, handle)</tt></p>
38         <h2>Description<a name="5"></a></h2>
39         <p><tt>acc_vector = GetAccelerator(port)</tt> returns the current 1x3 accelerator vector <tt>acc_vector</tt> of the HiTechnic acceleration sensor. The column vector contains the readings of the x, y, and z-axis, respectively. A reading
40            of 200 is equal to the acceleration of 1g. Maximum range is -2g to +2g. The given <tt>port</tt> number specifies the connection port. The value <tt>port</tt> can be addressed by the symbolic constants <tt>SENSOR_1</tt> , <tt>SENSOR_2</tt>, <tt>SENSOR_3</tt> and <tt>SENSOR_4</tt> analog to the labeling on the NXT Brick.
41         </p>
42         <p>The last optional argument can be a valid NXT handle. If none is specified, the default handle will be used (call <tt>COM_SetDefaultNXT</tt> to set one).
43         </p>
44         <h2>Example<a name="8"></a></h2><pre class="codeinput">   OpenAccelerator(SENSOR_4);
45   acc_Vector = GetAccelerator(SENSOR_4);
46   CloseSensor(SENSOR_4);
47</pre><h2>See also<a name="10"></a></h2>
48         <p><a href="OpenAccelerator.html">OpenAccelerator</a>, <a href="CloseSensor.html">CloseSensor</a>, <a href="COM_ReadI2C.html">COM_ReadI2C</a></p>
49         <h2>Signature<a name="12"></a></h2>
50         <div>
51            <ul>
52               <li><b>Author:</b> Linus Atorf (see AUTHORS)
53               </li>
54               <li><b>Date:</b> 2008/09/25
55               </li>
56               <li><b>Copyright:</b> 2007-2008, RWTH Aachen University
57               </li>
58            </ul>
59         </div>
60         <p class="footer"><br>
61            Published with wg_publish; V1.0<br></p>
62      </div>
63      <!--
64##### SOURCE BEGIN #####
65%% GetAccelerator
66% Reads the current value of the HiTechnic acceleration sensor
67%%
68%% Syntax
69% |acc_vector = GetAccelerator(port)|
70%%
71% |acc_vector = GetAccelerator(port, handle)|
72%%
73%% Description
74% |acc_vector = GetAccelerator(port)| returns the current 1x3 accelerator vector |acc_vector| of
75% the HiTechnic acceleration sensor. The column vector contains the
76% readings of the x, y, and z-axis, respectively. A reading of 200 is
77% equal to the acceleration of 1g. Maximum range is -2g to +2g.
78% The given |port| number specifies the connection port. The value |port| can be
79% addressed by the symbolic constants |SENSOR_1| , |SENSOR_2|, |SENSOR_3| and |SENSOR_4| analog to
80% the labeling on the NXT Brick.
81%%
82% The last optional argument can be a valid NXT handle. If none is
83% specified, the default handle will be used (call |COM_SetDefaultNXT| to
84% set one).
85%%
86%% Example
87   OpenAccelerator(SENSOR_4);
88   acc_Vector = GetAccelerator(SENSOR_4);
89   CloseSensor(SENSOR_4);
90%%
91%% See also
92% OpenAccelerator, CloseSensor, COM_ReadI2C
93%%
94%% Signature
95%%
96% * *Author:* Linus Atorf (see AUTHORS)
97% * *Date:* 2008/09/25
98% * *Copyright:* 2007-2008, RWTH Aachen University
99%
100
101##### SOURCE END #####
102-->
103   </body>
104</html>
Note: See TracBrowser for help on using the browser.