Spin 1 Documentation Ideas

Marcos' unmaintained, but still in-use, Puma for FreeEMS circuit board/hardware design!
User avatar
DeuceEFI
LQFP144 - On Top Of The Game
Posts: 578
Joined: Thu Feb 25, 2010 3:57 am
Location: Gosport, IN USA
Contact:

Re: Spin 1 Documentation Ideas

Post by DeuceEFI »

Fred, can you add to the spin1.html page (at the bottom under "Verifying correct operation of the firmware") what the proper Serial communications setting are? I know it is 115.2k baud, but what about data bits, stop bits, parity?

Thanks...
User avatar
Fred
Moderator
Posts: 15431
Joined: Tue Jan 15, 2008 2:31 pm
Location: Home sweet home!
Contact:

Re: Spin 1 Documentation Ideas

Post by Fred »

I kind of feel like it's out of scope of the document? In fact, a lot of that stuff should probably not be there, with a reference instead to a document on testing any new setup. For the time being, consult the comms spec documents which lay out the serial settings in explicit detail :-)

For the record, though, 8,1,odd. I guess I could add it in in an abbreviated format like that.

Fred.
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!
User avatar
Fred
Moderator
Posts: 15431
Joined: Tue Jan 15, 2008 2:31 pm
Location: Home sweet home!
Contact:

Re: Spin 1 Documentation Ideas

Post by Fred »

Preston has been doing some work on the spin1 how-to, and I've given it a home on the puma site here:

http://puma.freeems.org/how.to.guide/spin1/

Currently many of the sections are duplicates, but he'll fix that soon.

Fred.
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!
User avatar
Fred
Moderator
Posts: 15431
Joined: Tue Jan 15, 2008 2:31 pm
Location: Home sweet home!
Contact:

Re: Spin 1 Documentation Ideas

Post by Fred »

Presto, if you add me to your repo as a contributor, i can do tweaks while you sleep and you can just "git pull" in the morning before you start. You can also just pull from the diyefi user repo where i push to, but...

I just had Jammi update the output to be in a subdir with all needed parts, so now it's simple to scp it up any time you tell me it's ready to roll :-)
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!
User avatar
Preston
LQFP112 - Up with the play
Posts: 128
Joined: Fri Feb 26, 2010 5:26 am
Location: Aucks

Re: Spin 1 Documentation Ideas

Post by Preston »

Fred wrote:Presto, if you add me to your repo as a contributor, i can do tweaks while you sleep and you can just "git pull" in the morning before you start. You can also just pull from the diyefi user repo where i push to, but...

I just had Jammi update the output to be in a subdir with all needed parts, so now it's simple to scp it up any time you tell me it's ready to roll :-)
Will do mate, if you tell me how :)
Your help would be appreciated.I guess the sooner it is up to a decent state where others can try it with their build, then the sooner we get good feed back for spin2/Ravage.

Preston.
User avatar
Fred
Moderator
Posts: 15431
Joined: Tue Jan 15, 2008 2:31 pm
Location: Home sweet home!
Contact:

Re: Spin 1 Documentation Ideas

Post by Fred »

I'll try to get up early so we can work together in your evening to get that sorted out.
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!
User avatar
Fred
Moderator
Posts: 15431
Joined: Tue Jan 15, 2008 2:31 pm
Location: Home sweet home!
Contact:

Re: Spin 1 Documentation Ideas

Post by Fred »

Preston has been doing some more work on the spin1 how-to, it's uploaded now, check it out here:

http://puma.freeems.org/how.to.guide/spin1/

Expect this guide to be finalised in the next week or three :-)

It should make a nice xmas pressy for the Puma owners out there.

Fred.
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!
User avatar
Fred
Moderator
Posts: 15431
Joined: Tue Jan 15, 2008 2:31 pm
Location: Home sweet home!
Contact:

Re: Spin 1 Documentation Ideas

Post by Fred »

More changes overnight! Now split into separate pages, which is GREAT! Thanks Jammi for doing that and Preston for the content!

My feedback from IRC so that it doesn't get lost:

[09:21] <FreeAir> Lev8n: I'd split the pcb overview away from the bom stuff, and maybe even include it in the intro page to give that a bit of life
[09:22] <FreeAir> are "using the bom" and "bom config overview" really the same thing? right now i'd move config overview to the top and keep it on the same page, but maybe it's going to grow and move?
[09:22] <FreeAir> in general if there are two sections on a page, the shorter one will get lost if it's second
[09:23] <FreeAir> sourcing, surface mount, assembly tools should move to a new page too
[09:23] <FreeAir> i love the next, prev thing, perfectly appropriate for the content
[09:25] <FreeAir> general comment relevant before these changes, the images are auto scaled, i'd say make them smaller and make it more obvious that they should be clicked, or perhaps its obvious enough as is. Still, they take up too much space as is IMO.
[09:28] <FreeAir> Lev8n: I'd say that the polarised stuff should be marked obviously in bold caps whatever so it cant be missed, but all of the normal caps don't need to be marked. better to put something at the top saying "unless otherwise noted, resistors and capacitors can be installed in either direction, this excludes all tantalum caps, which will be clearly marked" or similar
[09:29] <FreeAir> will be a lot cleaner and easier to follow like that
[09:29] <FreeAir> ie, make noise when you need to and dont make as much noise when you dont
[09:36] <FreeAir> Lev8n: you're almost certainly onto this, but the spin 1 mods, this is a spin 1 guide, so rename to essential mods, also probably going to need to split the cutting traces and soldering jumpers to before/after relow, and thus on different pages,
[09:36] <FreeAir> and maybe assembly will end up on 3 pages as well. great work
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!
User avatar
Fred
Moderator
Posts: 15431
Joined: Tue Jan 15, 2008 2:31 pm
Location: Home sweet home!
Contact:

Re: Spin 1 Documentation Ideas

Post by Fred »

These instructions are days away from being complete! Preston has done a STACK of work on them. Pretty soon I'll be personally emailing all puma owners and apologising for the delay on this. Great work Preston, you're a star! :-)
DIYEFI.org - where Open Source means Open Source, and Free means Freedom
FreeEMS.org - the open source engine management system
FreeEMS dev diary and its comments thread and my turbo truck!
n00bs, do NOT PM or email tech questions! Use the forum!
The ever growing list of FreeEMS success stories!
User avatar
Dan
LQFP144 - On Top Of The Game
Posts: 1204
Joined: Tue Mar 02, 2010 2:33 pm
Location: Australia

Re: Spin 1 Documentation Ideas

Post by Dan »

I too would like to commend Preston on his documentation and BOM efforts for PUMA! A job well done mate! :-)
Post Reply