Skip to content

Commit

Permalink
Documention
Browse files Browse the repository at this point in the history
Tidy up documentation and examples to be ready for V1.0
  • Loading branch information
c0pperdragon committed May 11, 2015
1 parent 5eac9cc commit abe7588
Show file tree
Hide file tree
Showing 6 changed files with 115 additions and 53 deletions.
7 changes: 4 additions & 3 deletions Documentation/Resources/Appendix.txt
Expand Up @@ -25,10 +25,11 @@ Type Mode Name get reading with delivers
29 5 RGB-RAW ReadRaw (3 values) value1=red intensity, value2=green intensity, value3=blue intensity

33 0 IR-PROX ReadPercent distance in cm (not very accurate)
33 1 IR-SEEK ReadRaw (2 values) direction and distance to IR beacon
33 2 IR-REMOTE ReadRaw (4 values) value1=signal from channel 1 (*), value2=signal from channel 2...
a remote control sender can be switched to use one of 4 channels
(slider on top position is channel 1) and the remote receiver can detect
all channel signals at the same time
a remote control sender can be switched to use one of 4 channels
(slider on top position is channel 1) and the remote receiver can detect
all channel signals at the same time

(*) numbers for the remote control buttons (A=left top, B=left bottom, C=right top, D=right bottom, E=beacon activated):
A = 1 A&B = 10 B&C = 7
Expand Down
25 changes: 24 additions & 1 deletion Documentation/Resources/Manual.txt
Expand Up @@ -165,7 +165,7 @@ Similar requirements are there for function parameters, which also have a define
To make things easier, an automatic conversion from number to text is done if a parameter needs a text (but not the other way round).
</P>

<H3 class="subchapter>Arrays</H3>
<H3 class="subchapter">Arrays</H3>
<P>
In Small Basic arrays work like a dictionary and can use any text as an index.
EV3-Basic can not do that. Only numbers are allowed as index and only non-negative numbers without decimal places work as expected
Expand Down Expand Up @@ -212,6 +212,29 @@ but there are possible "Serial Ports" available, the PC will prompt you to selec
these ports. When this is indeed the port for the EV3, the connection will work.
</P>

<H1 class="chapter">Motor object since v1.0</H1>
<P>
For version 1.0, I made a re-design of the Motor object, so programs written for v0.9 or
earlier need some adjustments to work with v1.0.
One of the main changes is, that there are no "Motor.Speed" or "Motor.Power" commands anymore. You
have to specify the speed or power directly at the "Motor.Start" command. Also the other motor control commands
have been restructured into a functional matrix:
</P>
<TABLE>
<TR><TD></TD><TD>Move x degrees while waiting</TD><TD>Start to run indefinitely</TD><TD>Start to move x degrees</TD></TR>
<TR><TD>Regulate speed</TD><TD>Motor.Move</TD><TD>Motor.Start</TD><TD>Motor.Schedule</TD></TR>
<TR><TD>Choose power</TD><TD>Motor.MovePower</TD><TD>Motor.StartPower</TD><TD>Motor.SchedulePower</TD></TR>
<TR><TD>Synchronize</TD><TD>Motor.MoveSync</TD><TD>Motor.StartSync</TD><TD>Motor.ScheduleSync</TD></TR>
</TABLE>
<P>
For most purposes the variants with speed regulation of a single motor will be the right choice. So these commands have
shorter names (no "Power" or "Sync" suffix) when compared to their expert-feature counterparts.
</P>
<P>
When you have to change power or speed of an already running motor, just re-issue a start command with the appropriate
speed or power value. The motor will then seemlessly switch over to the new mode of operation.
</P>

<H1 class="chapter">Library Documentation</H1>
<P>
The runtime-library for the EV3 is organized in individual parts, called 'object's. Each object provides functionality for a different part of the system.
Expand Down
16 changes: 16 additions & 0 deletions Documentation/Resources/Styles.txt
Expand Up @@ -16,6 +16,22 @@
font-family: Verdana;
float: right;
}
TABLE {
font-family: Verdana;
border-spacing: 0px;
border:1px solid black;
}
TD {
padding: 4px;
}
TR:nth-child(1)
{
background: #d0d0d0;
}
TD:nth-child(1)
{
background: #d0d0d0;
}

H2.object {
font-family: Verdana;
Expand Down

0 comments on commit abe7588

Please sign in to comment.