[jallib] r1499 committed - added tutorial_sd_card.xml (not published in book yet), fixed blink a ...

2 views
Skip to first unread message

jal...@googlecode.com

unread,
Nov 24, 2009, 12:11:47 AM11/24/09
to jal...@googlegroups.com
Revision: 1499
Author: mattsc...@hotmail.com
Date: Mon Nov 23 21:10:58 2009
Log: added tutorial_sd_card.xml (not published in book yet), fixed blink a
led schematic
http://code.google.com/p/jallib/source/detail?r=1499

Added:
/trunk/doc/dita/tutorials/images/sd_card_pinout.jpg
/trunk/doc/dita/tutorials/images/sd_card_schematic.jpg
/trunk/doc/dita/tutorials/images/sd_card_sd_card.jpg
/trunk/doc/dita/tutorials/tutorial_installation.xml
/trunk/doc/dita/tutorials/tutorial_sd_card.xml
Modified:
/trunk/doc/dita/tutorials/images/blink_a_led_circuit.jpg

=======================================
--- /dev/null
+++ /trunk/doc/dita/tutorials/images/sd_card_pinout.jpg Mon Nov 23 21:10:58
2009
Binary file, no diff available.
=======================================
--- /dev/null
+++ /trunk/doc/dita/tutorials/images/sd_card_schematic.jpg Mon Nov 23
21:10:58 2009
Binary file, no diff available.
=======================================
--- /dev/null
+++ /trunk/doc/dita/tutorials/images/sd_card_sd_card.jpg Mon Nov 23
21:10:58 2009
Binary file, no diff available.
=======================================
--- /dev/null
+++ /trunk/doc/dita/tutorials/tutorial_installation.xml Mon Nov 23 21:10:58
2009
@@ -0,0 +1,38 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="template_id">
+ <title>Installation</title>
+ <prolog>
+ <author>Matthew Schinkel</author>
+ <publisher>Jallib Group</publisher>
+ </prolog>
+ <body>
+ <p id="firstcontent">JALv2 &amp; Jallib installation guide</p>
+ <section>
+ <title>Windows Install:</title>
+ <ol>
+ <li>Download jalpack (installer executable) from <xref
format="html"
href="http://jaledit.googlecode.com/files/JALPack_2.4_0.4_0.6.1.0.exe">http://jaledit.googlecode.com/files/JALPack_2.4_0.4_0.6.1.0.exe</xref></li>
+ <li>Run the setup file</li>
+ <li>Run JalEdit.exe from the jaledit directory</li>
+ <li>(optional) Click Tools Menu -&gt; Environment Options -&gt;
Programmer, Then Set the Programmer Executable Path</li>
+ </ol>
+ <p/>
+ <p>You should get something like this:</p>
+ <p><image href="images/installation_jalv2_dir.jpg"/></p>
+ <p/>
+ </section>
+ <section>
+ <title>Linux Install</title>
+ <ol>
+ <li>Go to <xref
href="http://code.google.com/p/jallib/downloads/list"
format="html">http://code.google.com/p/jallib/downloads/list</xref>, get
the link location of the jallib-pack (.tar.gz file)</li>
+ <li>Login via ssh to your linux install</li>
+ <li>Go to the directory you wish to install JALv2</li>
+ <li>Download the package with: #wget [link location of the
jallib-pack]</li>
+ <li>unzip the package with: #tar -xvf [filename.tar.gz]</li>
+ </ol>
+ <p/>
+ <p>(Jaledit runs under WINE on Linux)
+</p>
+ </section>
+ </body>
+</topic>
=======================================
--- /dev/null
+++ /trunk/doc/dita/tutorials/tutorial_sd_card.xml Mon Nov 23 21:10:58 2009
@@ -0,0 +1,28 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE topic
PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd" []>
+<topic id="template_id">
+ <title>SD Memory Cards</title>
+ <prolog>
+ <author>Matthew Schinkel</author>
+ <publisher>Jallib Group</publisher>
+ </prolog>
+ <body>
+ <p id="firstcontent">In this tuturial we will learn how to use an SD
Card for data storage</p>
+ <section>
+ <title>Some SD Card info:</title>
+ <p>SD Cards are quite popular these days for things like digital
camera&apos;s, video camera&apos;s, mp3 players and mobile phones. The main
advantages are: small size, large data storage capability, speed, cost and
flash data storage that does not require power to hold data. The current
version of the sd card library works with &quot;standard capacity&quot; sd
cards up 4gb in size.</p>
+ <image href="images/sd_card_sd_card.jpg" width="250"/>
+ <image href="images/sd_card_pinout.jpg" width="300"/>
+ </section>
+ <section>
+ <title>Let&apos;s put one in our circuit!</title>
+ <p>With the use of the sd card lib (sd_card.jal) and a sample file
16f877_sd_card.jal, we can easily put one in our own circuit for mass data
storage! </p>
+ <p>SD Card have 2 data transfer types &quot;sd bus&quot; and
&quot;spi bus&quot;. Most PIC&apos;s have an SPI port. The &quot;sd
bus&quot; is faster but uses more pins. As you can see from the circuit we
are using SPI.</p>
+ <p>These SD Cards are 3.3v devices, therefore a 5v to 3v conversion
is needed between the PIC and the sd card. We will use resistors to do the
conversion, however there are many other methods. See <xref
href="http://www.microchip.com/3v/"
format="html">http://www.microchip.com/3v/</xref> for more information.
Another setup may be needed if you are putting more devices on the same SPI
bus.</p>
+ <p>Let&apos;s build the circuit:</p>
+ <image href="images/sd_card_schematic.jpg" width="500"
otherprops="clickable"/>
+ <title>Power It Up</title>
+ <p>Now that our circuit is built, lets test it and make sure it
works before we continue with more details. Compile and program your pic
with 16f877_sd_card.jal from your jallib samples directory and. plug your
circuit into your PC for serial port communication and apply 5v power.
After pressing the reset button, you should get a result similar to
this:</p>
+ </section>
+ </body>
+</topic>
=======================================
--- /trunk/doc/dita/tutorials/images/blink_a_led_circuit.jpg Sat Oct 31
13:05:20 2009
+++ /trunk/doc/dita/tutorials/images/blink_a_led_circuit.jpg Mon Nov 23
21:10:58 2009
Binary file, no diff available.

Sebastien Lelong

unread,
Nov 24, 2009, 2:10:24 AM11/24/09
to jal...@googlegroups.com
Nice, another one !

Few comments:

Looks like tutorial_installation.xml is the same as installation.xml. Should the latter be removed ? (I prefer with tutorial_ prefix)

About SD-Card: sd_card.jal and 16f877_sd_card.jal should be within a xred element, pointing to jallib file in SVN repos. Maybe an external link for SPI would be nice (wikipedia ?)


Cheers,
Seb

2009/11/24 <jal...@googlecode.com>

--

You received this message because you are subscribed to the Google Groups "jallib" group.
To post to this group, send email to jal...@googlegroups.com.
To unsubscribe from this group, send email to jallib+un...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/jallib?hl=en.





--
Sébastien Lelong
http://www.sirloon.net
http://sirbot.org

mattschinkel

unread,
Nov 24, 2009, 3:06:13 AM11/24/09
to jallib
Yes, It still needs a lot of work.

>(I prefer with tutorial_ prefix)
one of them can be removed but installation is not a tutorial so it
should not have that prefix (just like your license page). right?

Another suggestion for the book... Can we have a word definition page?
just a simple list or table would be fine. It would contain (for
example) a list like this:

JAL - Just Another Language
LED - Light Emitting Diode
Library - blah blah blah
jallist - the jal support group at http://www....

Matt.

On Nov 24, 2:10 am, Sebastien Lelong <sebastien.lel...@gmail.com>
wrote:
> Nice, another one !
>
> Few comments:
>
> Looks like tutorial_installation.xml is the same as installation.xml. Should
> the latter be removed ? (I prefer with tutorial_ prefix)
>
> About SD-Card: sd_card.jal and 16f877_sd_card.jal should be within a xred
> element, pointing to jallib file in SVN repos. Maybe an external link for
> SPI would be nice (wikipedia ?)
>
> Cheers,
> Seb
>
> 2009/11/24 <jal...@googlecode.com>
>
>
>
>
>
> > Revision: 1499
> > Author: mattschin...@hotmail.com
> > jallib+un...@googlegroups.com<jallib%2Bunsu...@googlegroups.com>
> > .
> > For more options, visit this group at
> >http://groups.google.com/group/jallib?hl=en.
>
> --
> Sébastien Lelonghttp://www.sirloon.nethttp://sirbot.org- Hide quoted text -
>
> - Show quoted text -

Sebastien Lelong

unread,
Nov 24, 2009, 3:59:08 PM11/24/09
to jal...@googlegroups.com

>(I prefer with tutorial_ prefix)
one of them can be removed but installation is not a tutorial so it
should not have that prefix (just like your license page). right?

OK, but I think I'll need to handle a kind of context within the website. "installation.xml" will give URL "content/installation". When I write Jaluino installation, named installation.xml, conflict will occur. I think I need to kind of prefix URL: "content/jallib/installation", "content/jaluino/installation". But I need to make sure there's no problem when mixing both context (in a single book for instance).
 

Another suggestion for the book... Can we have a word definition page?
just a simple list or table would be fine. It would contain (for
example) a list like this:

JAL - Just Another Language
LED - Light Emitting Diode
Library - blah blah blah
jallist - the jal support group at http://www....

Sure, a "glossary" page. Very precious !


Cheers,
Seb
 
> > +    <p id="firstcontent">JALv2 & Jallib installation guide</p>

> > +    <section>
> > +      <title>Windows Install:</title>
> > +      <ol>
> > +        <li>Download jalpack (installer executable) from <xref
> > format="html"
> > href="http://jaledit.googlecode.com/files/JALPack_2.4_0.4_0.6.1.0.exe">
> >http://jaledit.googlecode.com/files/JALPack_2.4_0.4_0.6.1.0.exe
> > </xref></li>
> > +        <li>Run the setup file</li>
> > +        <li>Run JalEdit.exe from the jaledit directory</li>
> > +        <li>(optional) Click Tools Menu -> Environment Options ->
> > camera's, video camera's, mp3 players and mobile phones. The main

> > advantages are: small size, large data storage capability, speed, cost and
> > flash data storage that does not require power to hold data. The current
> > version of the sd card library works with "standard capacity" sd

> > cards up  4gb in size.</p>
> > +      <image href="images/sd_card_sd_card.jpg" width="250"/>
> > +      <image href="images/sd_card_pinout.jpg" width="300"/>
> > +    </section>
> > +    <section>
> > +      <title>Let's put one in our circuit!</title>

> > +      <p>With the use of the sd card lib (sd_card.jal) and a sample file
> > 16f877_sd_card.jal, we can easily put one in our own circuit for mass data
> > storage! </p>
> > +      <p>SD Card have 2 data transfer types "sd bus" and
> > "spi bus". Most PIC's have an SPI port.  The "sd
> > bus" is faster but uses more pins. As you can see from the circuit we

> > are using SPI.</p>
> > +      <p>These SD Cards are 3.3v devices, therefore a 5v to 3v conversion
> > is needed between the PIC and the sd card. We will use resistors to do the
> > conversion, however there are many other methods. See <xref
> > href="http://www.microchip.com/3v/"
> > format="html">http://www.microchip.com/3v/</xref> for more information.
> > Another setup may be needed if you are putting more devices on the same SPI
> > bus.</p>
> > +      <p>Let's build the circuit:</p>
To unsubscribe from this group, send email to jallib+un...@googlegroups.com.

For more options, visit this group at http://groups.google.com/group/jallib?hl=en.





--

mattschinkel

unread,
Nov 24, 2009, 11:36:40 PM11/24/09
to jallib
Jaluino will also have tutorials i'm sure, will they also start with
tutorial_? this may conflict. How would you like to handle it?

I suppose all xml files should start with tutorial_ for the tutorial
book, jaluino will have to start with jaluino_

Matt.

On Nov 24, 3:59 pm, Sebastien Lelong <sebastien.lel...@gmail.com>
wrote:
> > >(I prefer with tutorial_ prefix)
> > one of them can be removed but installation is not a tutorial so it
> > should not have that prefix (just like your license page). right?
>
> OK, but I think I'll need to handle a kind of context within the website.
> "installation.xml" will give URL "content/installation". When I write
> Jaluino installation, named installation.xml, conflict will occur. I think I
> need to kind of prefix URL: "content/jallib/installation",
> "content/jaluino/installation". But I need to make sure there's no problem
> when mixing both context (in a single book for instance).
>
>
>
> > Another suggestion for the book... Can we have a word definition page?
> > just a simple list or table would be fine. It would contain (for
> > example) a list like this:
>
> > JAL - Just Another Language
> > LED - Light Emitting Diode
> > Library - blah blah blah
> > jallist - the jal support group athttp://www....
> > <jallib%2Bunsu...@googlegroups.com<jallib%252Bunsubscribe@googlegroups.­com>
>
> > > > .
> > > > For more options, visit this group at
> > > >http://groups.google.com/group/jallib?hl=en.
>
> > > --
> > > Sébastien Lelonghttp://www.sirloon.nethttp://sirbot.org-Hide quoted text

Sebastien Lelong

unread,
Nov 25, 2009, 1:32:27 AM11/25/09
to jal...@googlegroups.com

Jaluino will also have tutorials i'm sure, will they also start with
tutorial_? this may conflict. How would you like to handle it?

Like I said, using a prefix, so URLs looks like "content/jallib/tutorial_..." and "content/jaluino/tutorial_..."
 
Cheers,
Seb

To unsubscribe from this group, send email to jallib+un...@googlegroups.com.

For more options, visit this group at http://groups.google.com/group/jallib?hl=en.





--
Reply all
Reply to author
Forward
0 new messages