Skip to content

Commit

Permalink
Various spelling and bug fixes; thanks Stephen!
Browse files Browse the repository at this point in the history
  • Loading branch information
bnewbold committed Aug 25, 2010
1 parent 404763c commit b611f8b
Show file tree
Hide file tree
Showing 14 changed files with 30 additions and 31 deletions.
4 changes: 2 additions & 2 deletions build/shared/reference/adc.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,11 @@ <h2><a name="noise">Noise and Bias</a></h2>
means that the voltage you are trying to sample must be between ground and
3.3v. In the case of a variable reading, it is best if the voltage varies
over the entire range of 0-3.3v; otherwise only a fraction of the sensitivity
is being leveraged. Resistor dividers and consant voltage diodes are basic
is being leveraged. Resistor dividers and constant voltage diodes are basic
tools which can help bring a given voltage signal into the appropriate range;
opamps and other powered components can also be used.

<h2><a name="functions">Funtion Reference</a></h2>
<h2><a name="functions">Function Reference</a></h2>

<dl>
<dt><code>pinMode(pin_num, INPUT_ANALOG)</code>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@
</head><body>
<!-- minimalist html; this is designed to be copy/pasted into a website -->
<!-- STARTDOC -->
<h1>Maple-Arduino Compatability Notes</h1>
<h1>Maple-Arduino Compatibility Notes</h1>

<ul>
<li><a href="#overview">Overview</a>
<li><a href="#software">Software Language/Library Changes</a>
<li><a href="#shields">Shield and Device Compatability</a>
<li><a href="#shields">Shield and Device Compatibility</a>
<li><a href="#libraries">Library Porting Status</a>
<li><a href="#headers">Header Numbering and Incompatabilities</a>
<li><a href="#headers">Header Numbering and Incompatibilities</a>
<li><a href="#porting">Sketch and Library Porting HOWTO</a>
</ul>

Expand All @@ -41,11 +41,11 @@ <h2><a name="overview">Overview</a></h2>
instructions means that programs aren't much larger (or are even smaller).


<h2><a name="headers">Header Numbering and Incompatabilities</a></h2>
<h2><a name="headers">Header Numbering and Incompatibilities</a></h2>

The numbering of headers is different; on the Maple each GPIO has a unique
number: D0, D1, D2, all the way up to D37 (actually there are a couple
more...). On the Arduino the analog pins are numbered seperately (A0-A5) from
more...). On the Arduino the analog pins are numbered separately (A0-A5) from
the digital pins (D0-D13).

<p>
Expand Down Expand Up @@ -105,11 +105,11 @@ <h2><a name="software">Software Language/Library Changes</a></h2>

</ul>

<h2><a name="shields">Shield and Device Compatability</a></h2>
<h2><a name="shields">Shield and Device Compatibility</a></h2>
<table>
<tr>
<th>Shield/Device
<th>Compatable?
<th>Compatible?
<th>Notes
<tr>
<td>Ethernet Shield
Expand Down
2 changes: 1 addition & 1 deletion build/shared/reference/errata.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ <h1>Maple Hardware Errata and Failure Modes</h1>
the Maple board. The failure modes aren't design errors, but are easy ways
to break or damage your board permanently. For a list of differences between
the Maple and Arduinos, see the page on <a
href="./compatability.html">compatability</a>.
href="./compatibility.html">compatibility</a>.

<ul>
<li><a href="#rev3">Maple Board rev3</a>
Expand Down
5 changes: 2 additions & 3 deletions build/shared/reference/gpio.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,6 @@ <h2><a name="pins">Pin Mapping Mega Table</a></h2>
<tr><th>D35 <td>PC6 <td>- <td>- <td>- <td>- <td>- <td>Yes
<tr><th>D36 <td>PC7 <td>- <td>- <td>- <td>- <td>- <td>Yes
<tr><th>D37 <td>PC8 <td>- <td>- <td>- <td>- <td>- <td>Yes
<tr><th>D38 <td>PC9 <td>- <td>- <td>- <td>- <td>- <td>Yes
</table>

<h2><a name="modes">GPIO Modes</a></h2>
Expand All @@ -89,7 +88,7 @@ <h2><a name="modes">GPIO Modes</a></h2>
<dd>In open drain mode, the pin indicates "low" by accepting current flow to
ground and "high" by providing increased impedence. An example use would be
to connect a pin to a bus line (which is pulled up to a positive voltage by a
seperate supply through a large resistor). When the pin is high, not much
separate supply through a large resistor). When the pin is high, not much
current flows through to ground and the line stays at positive voltage; when
the pin is low the bus "drains" to ground with a small amount of current
constantly flowing through the large resistor from the external supply. In
Expand Down Expand Up @@ -125,7 +124,7 @@ <h2><a name="modes">GPIO Modes</a></h2>
special case of digital output). See the <a href="./pwm.html">PWM</a> page.
</dl>

<h2><a name="functions">Funtion Reference</a></h2>
<h2><a name="functions">Function Reference</a></h2>
<dl>
<dt><code>pinMode(pin_number, MODE)</code>
<dd>Usually called from within <code>setup()</code> to configure the pin.
Expand Down
6 changes: 3 additions & 3 deletions build/shared/reference/i2c.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h2><a name="hardware">Hardware/Circuit Design</a></h2>
Port 2 (i2c2) has SDA on D30 and SCL on D29.

<p>
The Maple reliably communicates with up to a 400khz clock speed; this doesn't
The Maple reliably communicates with up to a 400kHz clock speed; this doesn't
translate into a 400kilobit data rate except in extreme cases because of
addressing and protocol overhead. We have tested clock speeds up to a megahertz
and have had mixed results; in theory it could be possible to achieve even
Expand All @@ -53,11 +53,11 @@ <h2><a name="hardware">Hardware/Circuit Design</a></h2>

<p>
Proper wiring and pullup resistor selection are essential when incorporating
i2c into a circuit, especially with datarates above 100khz. In the lab we
i2c into a circuit, especially with datarates above 100kHz. In the lab we
usually use ~5k ohm resistors with Vcc (3.3v) as the high voltage and try to
connect the pullup voltage as close to the SDA and SCL pins as possible. We
recommend looking at the reference website listed below, starting with a slow
clock rate (10khz), and if possible using an oscilloscope to debug any issues.
clock rate (10kHz), and if possible using an oscilloscope to debug any issues.

<h2><a name="functions">Function Reference</a></h2>

Expand Down
4 changes: 2 additions & 2 deletions build/shared/reference/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h1>Maple Reference Documentation</h1>
confusingly refered to as "analog output" even though it's really digital.

<li><b><a href="./spi.html">SPI</a></b>, the serial peripheral interface, for
high speed data transfer. Compatable with most SD cards.
high speed data transfer. Compatible with most SD cards.

<li><b><a href="./adc.html">ADC</a></b> (analog digital conversion), for
reading in analog voltage levels.
Expand Down Expand Up @@ -64,7 +64,7 @@ <h1>Maple Reference Documentation</h1>
<b><a href="./language.html">Language Documentation</a></b>

<p>
<b><a href="./compatability.html">Compatability</a></b>: A comparison of
<b><a href="./compatibility.html">Compatibility</a></b>: A comparison of
hardware and software differences between the Maple and Arduino boards, as well
as advice for porting sketches and libraries.

Expand Down
4 changes: 2 additions & 2 deletions build/shared/reference/pwm.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h2><a name="overview">Overview</a></h2>
more information!
<p>
Note that unlike the Arduino, the Maple does not have PWM functionality on
pin D10; all other pins are <a href="./compatability.html">compatible</a>.
pin D10; all other pins are <a href="./compatibility.html">compatible</a>.
<p>
The following table shows which <a href="./timers.html">timer</a> generates
which PWM outputs. See the <a href="./gpio.html#pins">pin mapping table</a> to
Expand Down Expand Up @@ -106,7 +106,7 @@ <h2><a name="functions">Function Reference</a></h2>
honor the maximum value (based on the configured period). As a convenience,
<code>analogWrite</code> is an alias of <code>pwmWrite</code> to ease porting
Arduino code, though period and duty will have to be recalibrated (see
<a href="./compatability.html">compatability.html</a>).
<a href="./compatibility.html">compatibility.html</a>).

<dt><code>Timer1.setPrescaleFactor(prescale)</code>
<dd>Find the appropriate timer for a given PWM header using the table above,
Expand Down
2 changes: 1 addition & 1 deletion build/shared/reference/quickstart.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ <h3>This is where our palms sweat...</h3>
flavors of Windows). We are working on a more robust software solution, but in
the meanwhile if you have trouble you could try repeating steps a few times,
power cycling the Maple, or restarting the IDE. Please let us know how
everything goes in the forums, the more datapoints the better!
everything goes in the forums, the more data points the better!
</div>

Now it's (finally!) time to plug in your Maple. Use a mini-b cable, making sure
Expand Down
2 changes: 1 addition & 1 deletion build/shared/reference/spi.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h1>Maple Reference Documentation: SPI</h1>
</code>
</ul>

<h2><a name="functions">Funtion Reference</a></h2>
<h2><a name="functions">Function Reference</a></h2>

<dl>
<dt><code>HardwareSPI Spi(number)</code><br>
Expand Down
4 changes: 2 additions & 2 deletions build/shared/reference/timers.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ <h1>Maple Reference Documentation: Timers</h1>
itself at a regular interval; the possibilities are endless!

<p>
The four timers each have four seperate compare channels. Each timer is a
The four timers each have four separate compare channels. Each timer is a
single 16-bit counter that can be configured with both a prescaler and an
overflow value. The prescaler acts as a divider of the 72MHz system clock;
without prescaling the counter would get up to 65536 (2 to the 16th power) and
Expand Down Expand Up @@ -93,7 +93,7 @@ <h2><a name="modes">General Timer Modes</a></h2>
<h2><a name="systick">SysTick Peripheral</a></h2>
The SysTick peripheral is and the associated <code>millis()</code> and
<code>delay()</code> functions are another simple way to perform periodic or
delayed events. This seperate timer does not conflict with any other
delayed events. This separate timer does not conflict with any other
peripherals, but the associated 1khz interrupt can jitter the general purpose
timer interrupts; this is clearly seen when running VGA code, where the timing
jitters are transformed into visual jags in the image. A future version of
Expand Down
2 changes: 1 addition & 1 deletion build/shared/reference/troubleshooting.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h2><a name="hardware">Hardware Problems</a></h2>

<dt><a name="hw3">My 5v peripheral doesn't work! (I2C, SPI, USART, etc)</a>
<dd>Yup, the Maple is a 3.3v board. You may need to use a level converter.
See the <a href="./compatability.html">compatability</a>, <a
See the <a href="./compatibility.html">compatibility</a>, <a
href="./gpio.html">GPIO</a>, or other feature specific documentation for more
information.

Expand Down
4 changes: 2 additions & 2 deletions build/shared/reference/unix-toolchain.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ <h1>libmaple Unix Toolchain Quickstart</h1>

<h3>1. Collect and Install Tools</h3>

First i'll give the commands to run, then explain:
First I'll give the commands to run, then explain:

<pre class="code">
sudo aptitude install build-essential git-core wget screen dfu-util \
Expand Down Expand Up @@ -271,7 +271,7 @@ <h3>8. Do it all with Code::Blocks</h3>
"Debug" configuration in the next window. Now you should have a project with no
files; add files by right clicking on the project in the left panel file
heirarchy and "Add files recursively". Import both the wirish and libmaple
directories recursively, then add main.cpp seperately.
directories recursively, then add main.cpp separately.

<br><br>
<div class="centerimg">
Expand Down
6 changes: 3 additions & 3 deletions build/shared/reference/usart.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ <h1>Maple Reference Documentation: USART</h1>

<h2><a name="hardware">Hardware/Circuit Design</a></h2>

The Maple has 3 seperate USART devices: Serial1, Serial2, and Serial3. In the
The Maple has 3 separate USART devices: Serial1, Serial2, and Serial3. In the
most simple use case the RX and TX pins are used to send data at a
predetermined baudrate with the the line voltage level relative to ground.
<table>
Expand Down Expand Up @@ -55,8 +55,8 @@ <h2><a name="functions">Function Reference</a></h2>
Accepts strings (character arrays). If a raw integer is passed the
corresponding ASCII character will be transmitted; to print out a number in
human readable form add a second parameter with the base system. Eg, to print
out the decimal number '1234' use print(1234,DEC); to print out the binary
numner '1001' use print(9,BIN).
out the decimal number '1234' use <code>print(1234,DEC)</code>; to print out
the binary numner '1001' use <code>print(9,BIN)</code>.

<dt><code>SerialN.available()</code><br>
<code>SerialN.read()</code>
Expand Down
2 changes: 1 addition & 1 deletion build/shared/reference/usb.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h3>Changes and Caveats</h3>
The Maple stm32 microprocessor includes a dedicated USB peripheral which can be
configured to act as a general USB slave device with transfer rates up to
12mbps (it unfortunately can not be configured as a host or on-the-go device).
By default the peripheral is configured for two uses: first to recieve
By default the peripheral is configured for two uses: first to receive
sketch/program uploads from the IDE, and second to emulate a regular serial
port for use as a terminal (text read/write).

Expand Down

0 comments on commit b611f8b

Please sign in to comment.