Searching \ for '[PIC]: Docs for the Embed Inc PIC dev envir.' in subject line. ()
Make payments with PayPal - it's fast, free and secure! Help us get a faster server
FAQ page: techref.massmind.org/techref/microchip/devices.htm?key=pic
Search entire site for: 'Docs for the Embed Inc PIC dev envir.'.

Exact match. Not showing close matches.
PICList Thread
'[PIC]: Docs for the Embed Inc PIC dev envir.'
2003\05\13@110430 by erholm (QAC)

flavicon
face
Hi all.
I'v just started playing around with the PIC development
environment from Embed Inc. One thing that striked me
pretty soon, was the lack of documentation.

Now, I'v taken what I could found on the Embed Inc
PIC web pages and compiled a "Guide".

It was primarily for my own use, but after consulting
with Olin, we have decided to publish it on my web site.
Olin will later link to it from his PIC pages.

Anyway, anyone interested can download a copy (a 141 kb
ZIP file with a 160 kb PDF document) from my web at :
http://w1.121.telia.com/~u12103129/. Look under "PIC page".

Note that the current version was a quick-n-dirty first
version put together last evening. It's not been proof
read, there are still some formatting to be fixed and
some other things to be added (such as an index).

Any comments are highly appreciated !

Regards
Jan-Erik Soderholm

--
http://www.piclist.com hint: The list server can filter out subtopics
(like ads or off topics) for you. See http://www.piclist.com/#topics

2003\05\13@161843 by John Nall

flavicon
face
At 05:02 PM 5/13/2003 +0200, Jan-Erik wrote:

>Any comments are highly appreciated !

I just downloaded install_picdev.exe and installed it (Windows XP).  The
installation does not produce the same number of directories in C:\embedinc
as the documentation shows.  In particular, the subdirectories
c:\embedinc\examples, c:\embedinc\fonts, c:\embedinc\lib and
c:\embedinc\progs are not there.

Also, the file QQQ_UART.ASPIC, shown under the "standard modules and files"
is not in the subdirectory c:\embedinc\source\pic, although all the other
listed files are.  (No big deal -- I just got it separately from Olin's
site, but you wanted comments. :-)

John

--
http://www.piclist.com hint: The list server can filter out subtopics
(like ads or off topics) for you. See http://www.piclist.com/#topics

2003\05\13@164659 by John Nall

flavicon
face
And a second comment for the documentation as it evolves:

After I got the Embed Inc. development environment installed, I decided to
also download the install_pic.hal.exe file and install it, so as to try out
the environment.  GOOD IDEA!  I strongly recommend that such an immediate
test be made a part of the documentation. :-)

I had screwed up, and the MPLABDir environmental variable was not set.  My
fault, and I set it.  But it may be that everyone doesn't know how to set
these things (hey, maybe they do -- what do I know?).  So a little blurb in
the instructions on it might be nice.

John

--
http://www.piclist.com hint: The list server can filter out subtopics
(like ads or off topics) for you. See http://www.piclist.com/#topics

2003\05\13@184540 by Olin Lathrop

face picon face
> I just downloaded install_picdev.exe and installed it (Windows XP).  The
> installation does not produce the same number of directories in
> C:\embedinc as the documentation shows.  In particular, the
> subdirectories c:\embedinc\examples, c:\embedinc\fonts, c:\embedinc\lib
> and c:\embedinc\progs are not there.

Right, just like the documentation says in the first paragraph of
"Structure of installed software" at http://www.embedinc.com/swdload.htm:
"Only some of these directories may exist in any one software release.
For example, if a software release contains no source code, then it will
not contain a SOURCE directory."

> Also, the file QQQ_UART.ASPIC, shown under the "standard modules and
> files" is not in the subdirectory c:\embedinc\source\pic, although all
> the other listed files are.  (No big deal -- I just got it separately
> from Olin's site, but you wanted comments. :-)

Oops.  I just checked the release script, and QQQ_UART.ASPIC was
deliberately deleted.  I did this a long time ago because all the QQQ_
modules are automatically copied by the release script, but the UART
module wasn't ready for general release at the time.  I guess I forgot to
go back and update the script once this module was officially released.
Sorry.  The script has been fixed and QQQ_UART.ASPIC will be included next
time.


*****************************************************************
Embed Inc, embedded system specialists in Littleton Massachusetts
(978) 742-9014, http://www.embedinc.com

--
http://www.piclist.com hint: The list server can filter out subtopics
(like ads or off topics) for you. See http://www.piclist.com/#topics

2003\05\14@042109 by Alan B. Pearce

face picon face
I also downloaded it and had a browse. It looks good, apart from the little
bits that John noted. Much better than the Word document that I made for
myself from the STD.INS.ASPIC file so I could find my way around the macros
while writing code.

The only comment I would make is why so much white space beside the text?
With only half the page width used it may make it OK to have as an overlay
on a computer screen, but this sort of documentation I prefer to print off
and have in a folder on the desk, and the way it is formatted nearly doubles
the number of pages.

You may want to have some shortcuts available in the navigation pane, to get
to the macro descriptions. This would make it really useful having around as
an overlay while programming. Did not read the macro descriptions carefully
to see if these were already there, but do put in some details of "gotchas",
(like the FIFO macros using the FSR) or processor dependencies.

All up a very good effort to bring all the info into one place. I do like
it.

--
http://www.piclist.com hint: The PICList is archived three different
ways.  See http://www.piclist.com/#archives for details.

2003\05\14@052739 by

flavicon
face
Hi.
I'm using a typsetting application called DECdocument.
This is an application that originated from Digital
Equipment Corp (DEC, VAX and VMS if that rings a bell).

When compiling a document, one selects a "style", in
this case I selected "SOFTWARE.REFERENCE".

DECdocument is a "text markup" tool, actualy it is
based on SDML (Structured Document Markup Language)
which is, in a way, very much like HTML, but with
added "tags" for such things as "chapters" and other
document related things.

I can agree on that the left margin for running text
is a bit wide, but that was the format selected when the
selected style was defined.

I'm not going to digg into the inner works of DECdoc to
change this. Print double sided and save a couple of
sheets ! :-)

I'm not realy sure what you mean by "shortcuts" and
"navigation pane". Is that the "link" that you can put
into PDF files ? Problem is, my tool (DECdoc) outputs
raw Postscript, and DECdoc don't have any tags to include
this kind of information. It *could* be added later
using "Acrobat Exchange" (the full version), but then
I'm stuck with manual editing of the document which
I'd like to avoid.

As for adding "gothas", "hints" and other stuf. I'd like
to keep the main chapters of the document as close as
possible to Olins texts to make it easier to update. Note
that the SDML file for the STD_INS macro part is generated
automaticly directly from the ASPIC file by a script with
no manual editing. I would like to keep it that way. (The
script need a bit of tweeking, the formatting of the
macro descriptions is lost now...)

I'd like to look at the current document content as
a "reference", and then add "gothas" and "hints"
to section separated from Olins original texts in a
chapter of it's own. That way it will be easier to
maintain.

Now, with that said, I'll take a look at the others
document "styles" in DECdoc. There is one called
"SOFTWARE.POCKET_REFERENCE" that looks to be more
compact. Maybe it could be used for a condensed
"ref-card" ? I'll check...

Also note that the currect document was produced
during 3-4 evening hours, I *do* plan to both
add more and fix some formatting issues.

Well, did that answer your questions ?

And, finaly, this is unpayed hobby stuff :-)

Jan-Erik.



Alan B. Pearce wrote :

{Quote hidden}

--
http://www.piclist.com hint: The PICList is archived three different
ways.  See http://www.piclist.com/#archives for details.

2003\05\14@074839 by Alan B. Pearce

face picon face
>I'm not realy sure what you mean by "shortcuts" and
>"navigation pane". Is that the "link" that you can put
>into PDF files ? Problem is, my tool (DECdoc) outputs
>raw Postscript, and DECdoc don't have any tags to include
>this kind of information. It *could* be added later
>using "Acrobat Exchange" (the full version), but then
>I'm stuck with manual editing of the document which
>I'd like to avoid.

The navigation pane is what some documents open on the left hand side of the
main document window, with all the chapter headings. A bit like what word
processors will give you as an index, and then by clicking on the heading in
the navigation pane it will take you straight to the appropriate page. Prime
examples of this are the Microchip data sheets. The navigation window also
has a tag labelled "thumbnail" which puts up thumbnails of all the pages. As
to how to generate this, I have no experience, but if anyone else can please
chip in.

>As for adding "gothas", "hints" and other stuf. I'd like
>to keep the main chapters of the document as close as
>possible to Olins texts to make it easier to update. Note
>that the SDML file for the STD_INS macro part is generated
>automaticly directly from the ASPIC file by a script with
>no manual editing. I would like to keep it that way. (The
>script need a bit of tweeking, the formatting of the
>macro descriptions is lost now...)

Fair enough.

>I'd like to look at the current document content as
>a "reference", and then add "gothas" and "hints"
>to section separated from Olins original texts in a
>chapter of it's own. That way it will be easier to
>maintain.

Again fair enough

>Now, with that said, I'll take a look at the others
>document "styles" in DECdoc. There is one called
>"SOFTWARE.POCKET_REFERENCE" that looks to be more
>compact. Maybe it could be used for a condensed
>"ref-card" ? I'll check...
>
>Also note that the currect document was produced
>during 3-4 evening hours, I *do* plan to both
>add more and fix some formatting issues.

I think we have all been there <big grin>.

>Well, did that answer your questions ?

Well certainly expanded some of the stuff you have in the introduction to
the document. Gave me more of an appreciation of why it is the way it is.

>And, finaly, this is unpayed hobby stuff :-)

Just like Olin's supplying the environment in the first place. Nice to be
able to put something back to help him. You have done a good job.

--
http://www.piclist.com hint: The PICList is archived three different
ways.  See http://www.piclist.com/#archives for details.

2003\05\14@093558 by

flavicon
face
Well, if this in any way differs from what you can read on
the Embed Inc web site, then it's an error on my behalf.

It was not my intention to correct any errors at the
Embed Inc site, just to to make then easier to find :-)
I wouldn't like my doc to take a separate route
from Olins pages, since I can't take any responsability
for the factual content.

I will make a note in the PDF doc that, when any errors
are found, cross check with Olins original, and if
the same error exists there, ask Olin to correct it first
(or explain or whatever). It could be that the doc is
correct and the downloded routine is not. I don't know...

Anyway, I'll collect all notices for a couple of days and
take a look at them then.

We'll probably see in due time if this is a workable
route...

Do note that the line you qouted below still stands !!

Jan-Erik.

John Nall wrote:


{Quote hidden}

--
http://www.piclist.com hint: The PICList is archived three different
ways.  See http://www.piclist.com/#archives for details.

2003\05\14@103801 by

flavicon
face
Reread the doc. Under chap 2.2 it says :

"Only some of these directories may exist in any one
software release."

Jan-Erik.

John Nall wrote:
> I just downloaded install_picdev.exe and installed it (Windows XP).  The
> installation does not produce the same number of directories in C:\embedinc
> as the documentation shows.

--
http://www.piclist.com hint: The PICList is archived three different
ways.  See http://www.piclist.com/#archives for details.

2003\05\14@104349 by

flavicon
face
I did exactly the same thing on first install.
Also had to define MPLABDIR, of course :-)
It built cleanly (as soon as I checked my own doc,
and run the correct built script). :-) :-)

Still, perfect comments !!

Jan-Erik.


John Nall wrote:

{Quote hidden}

--
http://www.piclist.com hint: The PICList is archived three different
ways.  See http://www.piclist.com/#archives for details.

2003\05\14@104600 by

flavicon
face
Anyone else seeing mail posted yesterday
popping up today ?
Just got the post below...
Jan-Erik.

-----Original Message-----
From: Jan-erik Söderholm (QAC) Sent: den 13 maj 2003 23:06

--
http://www.piclist.com hint: The PICList is archived three different
ways.  See http://www.piclist.com/#archives for details.


'[PIC]: Docs for the Embed Inc PIC dev envir.'
2003\08\11@113550 by
picon face
Now there is a new version my PDF docs for
the "Embedinc PIC development environmnt"
available from http://www.st-anna-data.se under the "PIC page"
link. It's the "11-aug-2003" version. I have added a
"tips-n-tricks" section that right now has info about
initial setup of a new project, UltraEdit and using MAKE.

Enjoy !!

All comments are highly welcome !

Jan-Erik.

--
http://www.piclist.com hint: The list server can filter out subtopics
(like ads or off topics) for you. See http://www.piclist.com/#topics

2003\08\11@164454 by Olin Lathrop

face picon face
> Now there is a new version my PDF docs for
> the "Embedinc PIC development environmnt"
> available from http://www.st-anna-data.se under the "PIC page"
> link. It's the "11-aug-2003" version. I have added a
> "tips-n-tricks" section that right now has info about
> initial setup of a new project, UltraEdit and using MAKE.
>
> Enjoy !!
>
> All comments are highly welcome !

I'm typing these comments in one window while looking thru your
documentation in another.  These comments are just blurted out as they
occur to me.

1  -  The extra step of providing a ZIP file containing the PDF file seems
unnecessary.  PDF files compress reasonably well.  The ZIP file was 196Kb,
and the PDF 220Kb.  Not worth the extra hassle in my opinion.

2  -  The document certainly looks a lot nicer than my web pages.

3  -  The first page of the document shows a date of 7 June although I
downloaded the 11 August ZIP file.

4  -  The name of the file with all the macros in it is STD.INS.ASPIC, not
STD_INS.ASPIC.  On page 5-1 there is a typo calling it ATD_INS.ASPIC.

5  -  I like the Tips and Tricks section.  I've been meaning to write
something like that, but there was always something else that needed doing
first.  Now I don't have to.

6  -  In the section on creating a new project, you don't mention the
.mlist file, although this is implicitly required by the build script you
show.


*****************************************************************
Embed Inc, embedded system specialists in Littleton Massachusetts
(978) 742-9014, http://www.embedinc.com

--
http://www.piclist.com hint: The list server can filter out subtopics
(like ads or off topics) for you. See http://www.piclist.com/#topics

2003\08\11@182022 by

picon face
(Short summary : there is a new file on my web...)



Olin Lathrop wrote:

> 1  -  The extra step of providing a ZIP file containing the PDF file seems
> unnecessary.

OK, saves me also a few keystrokes (or mouse clicks...) if I
skip the ZIPing. The current file is in "native" PDF format.

> 2  -  The document certainly looks a lot nicer than my web pages.

Thanks !

> 3  -  The first page of the document shows a date of 7 June although I
> downloaded the 11 August ZIP file.

Merde! forgot that, fixed now...

> 4  -  The name of the file with all the macros in it is STD.INS.ASPIC, not
> STD_INS.ASPIC.  On page 5-1 there is a typo calling it ATD_INS.ASPIC.

Fixed.

> 5  -  I like the Tips and Tricks section.  I've been meaning to write
> something like that, but there was always something else that needed doing
> first.  Now I don't have to.

Well, you are of course welcome to contribute ! :-)

> 6  -  In the section on creating a new project, you don't mention the
> .mlist file, although this is implicitly required by the build script you
> show.

Probably missed that since I now build with MAKE. Added now...



There is an updated version on my site now.

A few things I plan to add :

- A search index at the back. I just have to markup "interesting" words
 in the document source and the tool makes the rest.

- A section on creating a new module like the ones builtin. I made
 a module called "D01_TMR.ASPIC" with routines like "TMR0_INIT"
 called from the STRT module) and "TMR0_OVERFLOW_HANDLER" (called
 from the INTR modudle), much like the structure of the builtin UART
 module.

- A descsription of one possible structure of an application. Like
 having the ISR's only set flags, that the main loop (in xxx_MAIN.ASPIC)
 then checks and jumps to the different routines (the way I'm
 structuring my current project).

Anyway, creating the document has forced me to learn the environment,
and that helps a lot in my current project :-)

Jan-Erik.

--
http://www.piclist.com hint: The list server can filter out subtopics
(like ads or off topics) for you. See http://www.piclist.com/#topics


'[PIC]: Docs for the Embed Inc PIC dev envir.'
2003\09\22@170617 by
picon face
New version available at http://www.st-anna-data.se
under the "PIC page" link.

Nothing major, added a 12F629 chapter to the
"tips'n tricks" section.

Build the PDF file using Acrobat Destiller V5 instead of
GhostScript. Cut the size of the PDF file in half...

Enjoy !
Jan-Erik.

--
http://www.piclist.com#nomail Going offline? Don't AutoReply us!
email spam_OUTlistservTakeThisOuTspammitvma.mit.edu with SET PICList DIGEST in the body

2003\09\22@183906 by Olin Lathrop

face picon face
Jan-Erik Soderholm XA (TN/PAC) wrote:
> Nothing major, added a 12F629 chapter to the
> "tips'n tricks" section.

I noticed how you were trying to work around my kludge of artifically
breaking the RAM on that chip into bank 0 and unbanked RAM, when all of it
is really unbanked.

What you did is no worse of a kludge than what I did, but this really should
be fixed properly.  I think the right answer is to specifically detect cases
where all RAM is unbanked, define it that way in the linker file, and have
DEFRAM always emit UDATA_SHR.  I'm knee deep in other projects, but it's on
my list of things to get around to.  Of course if a project using such a PIC
comes up, it will happen a lot faster.


*****************************************************************
Embed Inc, embedded system specialists in Littleton Massachusetts
(978) 742-9014, http://www.embedinc.com

--
http://www.piclist.com#nomail Going offline? Don't AutoReply us!
email .....listservKILLspamspam@spam@mitvma.mit.edu with SET PICList DIGEST in the body

2003\09\23@025627 by

picon face
Olin Lathrop wrote:
> I noticed how you were trying to work around my kludge of artifically
> breaking the RAM on that chip into bank 0 and unbanked RAM, when all of it
> is really unbanked.

Yes, and I wrote that I'm positive that you'll come up with
a better solution when you have the time. I just wanted to show
how I, for the moment, set it up for the 12F629.

> I'm knee deep in other projects, but it's on
> my list of things to get around to.  Of course if a project using
> such a PIC comes up, it will happen a lot faster.

Well, *I* have such an project, but that doesn't count, right ? ;-) ;-)

Jan-Erik.

--
http://www.piclist.com hint: To leave the PICList
piclist-unsubscribe-requestspamKILLspammitvma.mit.edu

More... (looser matching)
- Last day of these posts
- In 2003 , 2004 only
- Today
- New search...