Replace deprecated HowTo with documentation

MindstormsEV3Toolbox.pdf

+docs/_build/latex/MindstormsEV3Toolbox.pdf
\ No newline at end of file

docs/_build/latex/MindstormsEV3Toolbox.aux

@@ -102,13 +102,13 @@
 \newlabel{source:source.Sensor}{{3}{11}{Sensor}{section*.64}{}}
 \@writefile{toc}{\contentsline {paragraph}{Notes}{11}{paragraph*.65}}
 \newlabel{source:source.Sensor.mode}{{3}{11}{Notes}{section*.66}{}}
-\newlabel{source:source.Sensor.debug}{{3}{11}{Notes}{section*.67}{}}
-\newlabel{source:source.Sensor.value}{{3}{12}{Notes}{section*.68}{}}
-\newlabel{source:source.Sensor.type}{{3}{12}{Notes}{section*.69}{}}
-\newlabel{source:source.Sensor.reset}{{3}{12}{Notes}{section*.70}{}}
-\@writefile{toc}{\contentsline {paragraph}{Notes}{12}{paragraph*.71}}
-\newlabel{source:source.Sensor.setProperties}{{3}{12}{Notes}{section*.72}{}}
-\@writefile{toc}{\contentsline {paragraph}{Example}{13}{paragraph*.73}}
+\newlabel{source:source.Sensor.debug}{{3}{13}{Notes}{section*.67}{}}
+\newlabel{source:source.Sensor.value}{{3}{13}{Notes}{section*.68}{}}
+\newlabel{source:source.Sensor.type}{{3}{13}{Notes}{section*.69}{}}
+\newlabel{source:source.Sensor.reset}{{3}{13}{Notes}{section*.70}{}}
+\@writefile{toc}{\contentsline {paragraph}{Notes}{13}{paragraph*.71}}
+\newlabel{source:source.Sensor.setProperties}{{3}{13}{Notes}{section*.72}{}}
+\@writefile{toc}{\contentsline {paragraph}{Example}{14}{paragraph*.73}}
 \@writefile{toc}{\contentsline {chapter}{\numberline {4}Indices and tables}{15}{chapter.4}}
 \@writefile{lof}{\addvspace {10\p@ }}
 \@writefile{lot}{\addvspace {10\p@ }}

docs/_build/latex/MindstormsEV3Toolbox.idx

@@ -44,8 +44,8 @@
 \indexentry{waitFor() (source.Motor method)|hyperpage}{10}
 \indexentry{Sensor (class in source)|hyperpage}{11}
 \indexentry{mode (source.Sensor attribute)|hyperpage}{11}
-\indexentry{debug (source.Sensor attribute)|hyperpage}{11}
-\indexentry{value (source.Sensor attribute)|hyperpage}{12}
-\indexentry{type (source.Sensor attribute)|hyperpage}{12}
-\indexentry{reset() (source.Sensor method)|hyperpage}{12}
-\indexentry{setProperties() (source.Sensor method)|hyperpage}{12}
+\indexentry{debug (source.Sensor attribute)|hyperpage}{13}
+\indexentry{value (source.Sensor attribute)|hyperpage}{13}
+\indexentry{type (source.Sensor attribute)|hyperpage}{13}
+\indexentry{reset() (source.Sensor method)|hyperpage}{13}
+\indexentry{setProperties() (source.Sensor method)|hyperpage}{13}

docs/_build/latex/MindstormsEV3Toolbox.ind

@@ -16,7 +16,7 @@
   \bigletter D
   \item debug (source.EV3 attribute), \hyperpage{3}
   \item debug (source.Motor attribute), \hyperpage{8}
-  \item debug (source.Sensor attribute), \hyperpage{11}
+  \item debug (source.Sensor attribute), \hyperpage{13}
   \item disconnect() (source.EV3 method), \hyperpage{4}
 
   \indexspace
@@ -50,7 +50,7 @@
 
   \indexspace
   \bigletter R
-  \item reset() (source.Sensor method), \hyperpage{12}
+  \item reset() (source.Sensor method), \hyperpage{13}
   \item resetTachoCount() (source.Motor method), \hyperpage{8}
 
   \indexspace
@@ -63,7 +63,7 @@
   \item setBrake() (source.Motor method), \hyperpage{8}
   \item setProperties() (source.EV3 method), \hyperpage{5}
   \item setProperties() (source.Motor method), \hyperpage{8}
-  \item setProperties() (source.Sensor method), \hyperpage{12}
+  \item setProperties() (source.Sensor method), \hyperpage{13}
   \item smoothStart (source.Motor attribute), \hyperpage{7}
   \item smoothStop (source.Motor attribute), \hyperpage{7}
   \item source (module), \hyperpage{1}
@@ -80,11 +80,11 @@
   \item tachoCount (source.Motor attribute), \hyperpage{8}
   \item tonePlayed() (source.EV3 method), \hyperpage{5}
   \item type (source.Motor attribute), \hyperpage{8}
-  \item type (source.Sensor attribute), \hyperpage{12}
+  \item type (source.Sensor attribute), \hyperpage{13}
 
   \indexspace
   \bigletter V
-  \item value (source.Sensor attribute), \hyperpage{12}
+  \item value (source.Sensor attribute), \hyperpage{13}
 
   \indexspace
   \bigletter W

docs/_build/latex/MindstormsEV3Toolbox.log

-This is pdfTeX, Version 3.1415926-2.5-1.40.14 (TeX Live 2013/Debian) (format=pdflatex 2016.11.23)  8 DEC 2016 16:50
+This is pdfTeX, Version 3.1415926-2.5-1.40.14 (TeX Live 2013/Debian) (format=pdflatex 2016.11.23)  13 DEC 2016 18:45
 entering extended mode
  restricted \write18 enabled.
  %&-line parsing enabled.
@@ -1039,11 +1039,11 @@ Chapter 2.
 Chapter 3.
 [11
 
-] [12] [13] [14
-
-]
+] [12] [13] [14]
 Chapter 4.
-[15] [16
+[15
+
+] [16
 
 ] [17
 
@@ -1054,25 +1054,25 @@ Chapter 4.
 ] [19
 
 ])
-Package atveryend Info: Empty hook `BeforeClearDocument' on input line 1088.
-Package atveryend Info: Empty hook `AfterLastShipout' on input line 1088.
+Package atveryend Info: Empty hook `BeforeClearDocument' on input line 1256.
+Package atveryend Info: Empty hook `AfterLastShipout' on input line 1256.
 
 (./MindstormsEV3Toolbox.aux)
-Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 1088.
-Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 1088.
+Package atveryend Info: Executing hook `AtVeryEndDocument' on input line 1256.
+Package atveryend Info: Executing hook `AtEndAfterFileList' on input line 1256.
 
 Package rerunfilecheck Info: File `MindstormsEV3Toolbox.out' has not changed.
 (rerunfilecheck)             Checksum: E100CA1E8BEC3FF034AB7A951CE1136C;554.
-Package atveryend Info: Empty hook `AtVeryVeryEnd' on input line 1088.
+Package atveryend Info: Empty hook `AtVeryVeryEnd' on input line 1256.
  ) 
 Here is how much of TeX's memory you used:
  13363 strings out of 493304
  182319 string characters out of 6139870
- 269857 words of memory out of 5000000
+ 269862 words of memory out of 5000000
  16432 multiletter control sequences out of 15000+600000
  49812 words of font info for 63 fonts, out of 8000000 for 9000
  958 hyphenation exceptions out of 8191
- 36i,12n,45p,266b,714s stack positions out of 5000i,500n,10000p,200000b,80000s
+ 36i,12n,45p,266b,712s stack positions out of 5000i,500n,10000p,200000b,80000s
 {/usr/share/texlive/texmf-dist/fonts/enc/dvips/base/8r.enc}</usr/share/texliv
 e/texmf-dist/fonts/type1/urw/courier/ucrb8a.pfb></usr/share/texlive/texmf-dist/
 fonts/type1/urw/courier/ucrr8a.pfb></usr/share/texlive/texmf-dist/fonts/type1/u
@@ -1082,7 +1082,7 @@ uhvb8a.pfb></usr/share/texlive/texmf-dist/fonts/type1/urw/helvetic/uhvbo8a.pfb>
 texlive/texmf-dist/fonts/type1/urw/times/utmb8a.pfb></usr/share/texlive/texmf-d
 ist/fonts/type1/urw/times/utmr8a.pfb></usr/share/texlive/texmf-dist/fonts/type1
 /urw/times/utmri8a.pfb>
-Output written on MindstormsEV3Toolbox.pdf (23 pages, 135625 bytes).
+Output written on MindstormsEV3Toolbox.pdf (23 pages, 136359 bytes).
 PDF statistics:
  326 PDF objects out of 1000 (max. 8388607)
  284 compressed objects within 3 object streams

docs/_build/latex/MindstormsEV3Toolbox.tex

@@ -32,9 +32,9 @@
 
 
 \title{Mindstorms EV3 Toolbox Documentation}
-\date{Dec 08, 2016}
-\release{v0.3-rc.8}
-\author{Tim Stadtmann}
+\date{Dec 13, 2016}
+\release{v0.4-rc.10}
+\author{LfB - RWTH Aachen}
 \newcommand{\sphinxlogo}{}
 \renewcommand{\releasename}{Release}
 \makeindex
@@ -382,7 +382,7 @@ Plays tone on brick.
 
 b = EV3(); 
 b.connect(`bt', `serPort', `/dev/rfcomm0'); 
-b.playTone(50, 5000, 1000);  \% Plays tone with 50\% volume and 5000Hz for 1
+b.playTone(40, 5000, 1000);  \% Plays tone with 40\% volume and 5000Hz for 1
 second. 
 
 \end{fulllineitems}
@@ -485,6 +485,10 @@ instances for each motor port, and you can work with them via the EV3-object.
 \item {} 
 The Motor-class represents motor ports, not individual motors!
 
+\item {} 
+If you start a motor with power=0, the internal state will still be set to
+`isRunning'
+
 \end{itemize}
 \index{power (source.Motor attribute)}
 
@@ -553,7 +557,7 @@ milliseconds. \emph{{[}WRITABLE{]}}
 
 \begin{fulllineitems}
 \phantomsection\label{source:source.Motor.brakeMode}\pysigline{\sphinxbfcode{brakeMode}}
-\emph{`Brake'\textbar{}'Coast'} -- Mode for braking. If `Coast', the motor will (at
+\emph{`Brake'\textbar{}'Coast'} -- Action done when stopping. If `Coast', the motor will (at
 tacholimit, if \textasciitilde{}=0) coast to a stop. If `Brake', the motor will stop immediately
 (at tacholimit, if \textasciitilde{}=0) and hold the brake. \emph{{[}WRITABLE{]}}
 
@@ -619,8 +623,13 @@ brakemode is `Coast', this function is called automatically.
 \item {} 
 A better name would probably be resetPosition...
 
+\item {} 
+Gets called automatically when starting the motor and the internal tacho
+
 \end{itemize}
 
+count is \textgreater{} 0
+
 See also MOTOR.RESETTACHOCOUNT
 
 \end{fulllineitems}
@@ -710,7 +719,7 @@ to run the with a tacholimit, it will stop sooner or later than expected,
 or may not even start at all.
 
 \item {} 
-After calling one of the functions to control the motor with some kind of
+(OLD)After calling one of the functions to control the motor with some kind of
 limit (which is done if limit\textasciitilde{}=0), the physical brick's power/speed value for
 starting without a limit (i.e. if limit==0) is reset to zero. So if you want
 to control the motor without a limit after doing so with a limit, you would
@@ -885,7 +894,7 @@ sensor type): \emph{{[}WRITABLE{]}}
 \item {} \begin{description}
 \item[{Touch-Sensor:}] \leavevmode\begin{itemize}
 \item {} 
-DeviceMode.Touch.Pushed {[}Default{]}
+DeviceMode.Touch.Pushed \emph{{[}Default{]}}
 
 \item {} 
 DeviceMode.Touch.Bumps
@@ -897,7 +906,7 @@ DeviceMode.Touch.Bumps
 \item {} \begin{description}
 \item[{Ultrasonic-Sensor:}] \leavevmode\begin{itemize}
 \item {} 
-DeviceMode.UltraSonic.DistCM {[}Default{]}
+DeviceMode.UltraSonic.DistCM \emph{{[}Default{]}}
 
 \item {} 
 DeviceMode.UltraSonic.DistIn
@@ -912,7 +921,7 @@ DeviceMode.UltraSonic.Listen
 \item {} \begin{description}
 \item[{Color-Sensor:}] \leavevmode\begin{itemize}
 \item {} 
-DeviceMode.Color.Reflect {[}Default{]}
+DeviceMode.Color.Reflect \emph{{[}Default{]}}
 
 \item {} 
 DeviceMode.Color.Ambient
@@ -927,7 +936,7 @@ DeviceMode.Color.Col
 \item {} \begin{description}
 \item[{Gyro-Sensor:}] \leavevmode\begin{itemize}
 \item {} 
-DeviceMode.Gyro.Angular {[}Default{]}
+DeviceMode.Gyro.Angular \emph{{[}Default{]}}
 
 \item {} 
 DeviceMode.Gyro.Rate
@@ -936,6 +945,156 @@ DeviceMode.Gyro.Rate
 
 \end{description}
 
+\item {} \begin{description}
+\item[{Infrared-Sensor:}] \leavevmode\begin{itemize}
+\item {} 
+DeviceMode.InfraRed.Prox \emph{{[}Default{]}}
+
+\item {} 
+DeviceMode.InfraRed.Seek
+
+\item {} 
+DeviceMode.InfraRed.Remote
+
+\end{itemize}
+
+\end{description}
+
+\item {} \begin{description}
+\item[{NXTColor-Sensor:}] \leavevmode\begin{itemize}
+\item {} 
+DeviceMode.NXTColor.Reflect \emph{{[}Default{]}}
+
+\item {} 
+DeviceMode.NXTColor.Ambient
+
+\item {} 
+DeviceMode.NXTColor.Color
+
+\item {} 
+DeviceMode.NXTColor.Green
+
+\item {} 
+DeviceMode.NXTColor.Blue
+
+\item {} 
+DeviceMode.NXTColor.Raw
+
+\end{itemize}
+
+\end{description}
+
+\item {} \begin{description}
+\item[{NXTLight-Sensor:}] \leavevmode\begin{itemize}
+\item {} 
+DeviceMode.NXTLight.Reflect \emph{{[}Default{]}}
+
+\item {} 
+DeviceMode.NXTLight.Ambient
+
+\end{itemize}
+
+\end{description}
+
+\item {} \begin{description}
+\item[{NXTSound-Sensor:}] \leavevmode\begin{itemize}
+\item {} 
+DeviceMode.NXTSound.DB \emph{{[}Default{]}}
+
+\item {} 
+DeviceMode.NXTSound.DBA
+
+\end{itemize}
+
+\end{description}
+
+\item {} \begin{description}
+\item[{NXTTemperature-Sensor}] \leavevmode\begin{itemize}
+\item {} 
+DeviceMode.NXTTemperature.C \emph{{[}Default{]}}
+
+\item {} 
+DeviceMode.NXTTemperature.F
+
+\end{itemize}
+
+\end{description}
+
+\item {} \begin{description}
+\item[{NXTTouch-Sensor:}] \leavevmode\begin{itemize}
+\item {} 
+DeviceMode.NXTTouch.Pushed \emph{{[}Default{]}}
+
+\item {} 
+DeviceMode.NXTTouch.Bumps
+
+\end{itemize}
+
+\end{description}
+
+\item {} \begin{description}
+\item[{NXTUltraSonic-Sensor:}] \leavevmode\begin{itemize}
+\item {} 
+DeviceMode.NXTUltraSonic.CM \emph{{[}Default{]}}
+
+\item {} 
+DeviceMode.NXTUltraSonic.IN
+
+\end{itemize}
+
+\end{description}
+
+\item {} \begin{description}
+\item[{HTAccelerometer-Sensor:}] \leavevmode\begin{itemize}
+\item {} 
+DeviceMode.HTAccelerometer.Acceleration \emph{{[}Default{]}}
+
+\item {} 
+DeviceMode.HTAccelerometer.AccelerationAllAxes
+
+\end{itemize}
+
+\end{description}
+
+\item {} \begin{description}
+\item[{HTCompass-Sensor:}] \leavevmode\begin{itemize}
+\item {} 
+DeviceMode.HTCompass.Degrees \emph{{[}Default{]}}
+
+\end{itemize}
+
+\end{description}
+
+\item {} \begin{description}
+\item[{HTColor-Sensor:}] \leavevmode\begin{itemize}
+\item {} 
+DeviceMode.HTColor.Col \emph{{[}Default{]}}
+
+\item {} 
+DeviceMode.HTColor.Red
+
+\item {} 
+DeviceMode.HTColor.Green
+
+\item {} 
+DeviceMode.HTColor.Blue
+
+\item {} 
+DeviceMode.HTColor.White
+
+\item {} 
+DeviceMode.HTColor.Raw
+
+\item {} 
+DeviceMode.HTColor.Nr,
+
+\item {} 
+DeviceMode.HTColor.All
+
+\end{itemize}
+
+\end{description}
+
 \end{itemize}
 
 \end{fulllineitems}
@@ -1004,6 +1163,15 @@ DeviceType.Gyro
 \item {} 
 DeviceType.InfraRed
 
+\item {} 
+DeviceType.HTColor
+
+\item {} 
+DeviceType.HTCompass
+
+\item {} 
+DeviceType.HTAccelerometer
+
 \item {} 
 DeviceType.Unknown
 

docs/_build/latex/MindstormsEV3Toolbox.toc

@@ -20,8 +20,8 @@
 \contentsline {paragraph}{Notes}{10}{paragraph*.63}
 \contentsline {chapter}{\numberline {3}Sensor}{11}{chapter.3}
 \contentsline {paragraph}{Notes}{11}{paragraph*.65}
-\contentsline {paragraph}{Notes}{12}{paragraph*.71}
-\contentsline {paragraph}{Example}{13}{paragraph*.73}
+\contentsline {paragraph}{Notes}{13}{paragraph*.71}
+\contentsline {paragraph}{Example}{14}{paragraph*.73}
 \contentsline {chapter}{\numberline {4}Indices and tables}{15}{chapter.4}
 \contentsline {chapter}{MATLAB Module Index}{17}{section*.74}
 \contentsline {chapter}{Index}{19}{section*.75}