Documentation Improvment Ideas

General English language SECU-3 discussions here. Обсуждение общих вопросов SECU-3 на английском.

Moderator: STC

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

Documentation Improvment Ideas

Post by Fred »

Hello All!

If you're reading through the english secu3 docs on http://secu-3.org/ and you notice anything that isn't quite right, place your suggestions in this thread and STC can consider them as improvements in his own time.

Mine for today:

schemas > schematics

I don't understand what this sentence is trying to tell me "You can use results represented on this site in all your needs, therefore it is necessary to refer to original author(s)."

"double coils" later you say 2,4,6,8 cylinders so I assume that you mean double post coils, if so, you need to add "post" in there otherwise it sounds like 2 coils, not each coil having two posts/HT connections.

Replace this screen shot with one of the English version (or people will assume it doesn't exist!) http://subversion.assembla.com/svn/secu ... am_mon.gif

what is a "commutator"?

It's more normal to say "timing" which is short for "ignition timing" than "advance angle" in the general sense. EG "The ignition timing was set to an advance angle of 25btdc" does that make sense?

"Starter blocking when engine speed reaches specified value " interesting feature! (nothing wrong with the language, sorry for OT...)

"RS-232 interface for reprogramming, control and tuning with galvanic isolation. " what the hell is "galvanic isolation" ?

For the table of features, instead of the + you could/should use unicode ticks : either ✓ or ✔

"Description of communication protocol (Application)" - This should say firmware, not application. You DO use the term firmware in places, but not all places, I also find your repository name "secu3app" confusing/misleading, but maybe its just me?

"Useful advices and FAQ." - advice (it's a continuous quantity)

"Some packets may only be transferred, while some only received." sent and received or transmitted and received, probably the former is best.

"Ventilator" what is that?

"An open source, free, engine control unit for carburetor engines" Although this is clear when you read it a few times, you should probably make it this instead:

"An open source, free, ignition control unit" or "An open source, free, ignition controller"

OK, I've got things to do, so that's all for today from me, but anyone else, feel free to dive in and help too, I know JHarvey likes docs! :-)

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
STC
LQFP144 - On Top Of The Game
Posts: 2420
Joined: Fri Oct 22, 2010 10:47 pm
Location: Ukraine, Kiev
Contact:

Re: Documentation Improvment Ideas

Post by STC »

Thank you.
"Commutator" - means device which commutates current through coil.
"galvanic isolation" - means optical uncoupling (using photocouplers)
"Ventilator" - cooler installed on radiator (engine cooling)
Author of the SECU-3 project. SECU-3 Engine control unit / Ignition control system
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook
User avatar
Fred
Moderator
Posts: 15431
Joined: Tue Jan 15, 2008 2:31 pm
Location: Home sweet home!
Contact:

Re: Documentation Improvment Ideas

Post by Fred »

STC wrote:Thank you.
"Commutator" - means device which commutates current through coil. Ignitor?
"galvanic isolation" - means optical uncoupling (using photocouplers) I forget the context, but something like "using opto isolators" ?
"Ventilator" - cooler installed on radiator (engine cooling) Cooling fan?
Perhaps this would be easier with pictures? Bed time! :-)
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
STC
LQFP144 - On Top Of The Game
Posts: 2420
Joined: Fri Oct 22, 2010 10:47 pm
Location: Ukraine, Kiev
Contact:

Re: Documentation Improvment Ideas

Post by STC »

Pictures are good, but I am lazy to draw :-)
Maybe "Ignitor". Why "Commutator" is not good ?
I think "galvanic isolation" is also good. http://en.wikipedia.org/wiki/Galvanic_isolation
"Ventilator" - Cooling fan, exactly
Author of the SECU-3 project. SECU-3 Engine control unit / Ignition control system
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook
User avatar
STC
LQFP144 - On Top Of The Game
Posts: 2420
Joined: Fri Oct 22, 2010 10:47 pm
Location: Ukraine, Kiev
Contact:

Re: Documentation Improvment Ideas

Post by STC »

Also I don't know how to display Unicode characters(✓ ✔) in my web-page.

even if I use:
<meta http-equiv="Content-Type" content="text/html; charset=windows-1251">
or
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
etc
Author of the SECU-3 project. SECU-3 Engine control unit / Ignition control system
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook
User avatar
Fred
Moderator
Posts: 15431
Joined: Tue Jan 15, 2008 2:31 pm
Location: Home sweet home!
Contact:

Re: Documentation Improvment Ideas

Post by Fred »

Commutator is no good because no one will know what you're talking about ;-)

re galv iso, i will re read and make a new suggestion, it might be a valid term, and clearly is, but there has to be a simpler more obvious way to say it, i'll look later.

cooling fan! use that... :-)

Re the ticks, check out the source of the wikipedia page where i got them from. http://en.wikipedia.org/wiki/Tick_(check_mark)

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!
thebigmacd
LQFP112 - Up with the play
Posts: 205
Joined: Thu Apr 10, 2008 5:51 pm

Re: Documentation Improvment Ideas

Post by thebigmacd »

STC wrote:Pictures are good, but I am lazy to draw :-)
Maybe "Ignitor". Why "Commutator" is not good ?
I think "galvanic isolation" is also good. http://en.wikipedia.org/wiki/Galvanic_isolation
"Ventilator" - Cooling fan, exactly
A "commutator" is a component in a DC electric motor. It is a two-piece slip ring that switches polarity of the armature based on angular position. "Ignitor" is definitely the word you should use.
Basic-commutator-for-a-dc-motor.jpg
Galvanic isolation is correct, but in the context the word "optoisolation" is more common.
Keith MacDonald
Control Engineering (Systems) Technologist
User avatar
Fred
Moderator
Posts: 15431
Joined: Tue Jan 15, 2008 2:31 pm
Location: Home sweet home!
Contact:

Re: Documentation Improvment Ideas

Post by Fred »

Thanks Keith!
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
STC
LQFP144 - On Top Of The Game
Posts: 2420
Joined: Fri Oct 22, 2010 10:47 pm
Location: Ukraine, Kiev
Contact:

Re: Documentation Improvment Ideas

Post by STC »

Thank you.
"ignitor" is already used in the firmware. I will continue to use it in other places.
Agree with "optoisolation" - I will use it
Author of the SECU-3 project. SECU-3 Engine control unit / Ignition control system
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook
User avatar
STC
LQFP144 - On Top Of The Game
Posts: 2420
Joined: Fri Oct 22, 2010 10:47 pm
Location: Ukraine, Kiev
Contact:

Re: Documentation Improvment Ideas

Post by STC »

New wiring diagrams are available here http://secu-3.org/index.php?locale=ru_R ... nd_sensors
Author of the SECU-3 project. SECU-3 Engine control unit / Ignition control system
SECU-3.org (Русский)
SECU-3.org (English)
SECU-3 Club ВКонтакте
SECU-3 EMS Project Facebook
Post Reply