Merge branch 'rusefi:master' into master
This commit is contained in:
mi-hol
GitHub
commit
bdd5e0be2d
|
|
@ -0,0 +1,41 @@
|
|||
#
|
||||
# ACCESS_TOKEN - Personal Access Token with "public_repo" permission
|
||||
# If there is a change to rusefi/rusefi_documentation, this action merges it to rusefi/rusefi/wiki
|
||||
#
|
||||
# the opposite merge is implemented as https://github.com/rusefi/rusefi/blob/master/.github/workflows/sync-wiki.yaml
|
||||
#
|
||||
|
||||
name: Sync Wiki2
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
sync:
|
||||
runs-on: ubuntu-latest
|
||||
if: ${{ github.actor != 'actions-user' }}
|
||||
|
||||
steps:
|
||||
- name: Check out docs repo
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
repository: rusefi/rusefi.wiki
|
||||
persist-credentials: false
|
||||
|
||||
- name: Merge from rusefi_documentation
|
||||
run: |
|
||||
git remote add technical-git https://github.com/rusefi/rusefi_documentation.git
|
||||
git fetch technical-git
|
||||
git config --local user.email "action@github.com"
|
||||
git config --local user.name "GitHub Action"
|
||||
git merge technical-git/master
|
||||
|
||||
- name: Push changes rusefi/rusefi wiki
|
||||
uses: ad-m/github-push-action@master
|
||||
with:
|
||||
repository: rusefi/rusefi.wiki
|
||||
github_token: ${{ secrets.ACCESS_TOKEN }}
|
||||
branch: master
|
||||
|
|
@ -5,7 +5,7 @@
|
|||
# the opposite merge is implemented as https://github.com/rusefi/rusefi/blob/master/.github/workflows/sync-wiki.yaml
|
||||
#
|
||||
|
||||
name: Sync Wiki & Generate static wiki
|
||||
name: Sync Wiki3
|
||||
|
||||
on:
|
||||
push:
|
||||
|
|
@ -18,12 +18,8 @@ jobs:
|
|||
if: ${{ github.actor != 'actions-user' }}
|
||||
|
||||
steps:
|
||||
- name: Check out docs repo
|
||||
- name: Check out repo
|
||||
uses: actions/checkout@v2
|
||||
with:
|
||||
fetch-depth: 0
|
||||
repository: rusefi/rusefi.wiki
|
||||
persist-credentials: false
|
||||
|
||||
- name: Install mkdocs Prerequisites
|
||||
run: |
|
||||
|
|
@ -31,21 +27,6 @@ jobs:
|
|||
sudo apt install sshpass
|
||||
pip install mkdocs mkdocs-ezlinks-plugin
|
||||
|
||||
- name: Merge from rusefi_documentation
|
||||
run: |
|
||||
git remote add technical-git https://github.com/rusefi/rusefi_documentation.git
|
||||
git fetch technical-git
|
||||
git config --local user.email "action@github.com"
|
||||
git config --local user.name "GitHub Action"
|
||||
git merge technical-git/master
|
||||
|
||||
- name: Push changes rusefi/rusefi wiki
|
||||
uses: ad-m/github-push-action@master
|
||||
with:
|
||||
repository: rusefi/rusefi.wiki
|
||||
github_token: ${{ secrets.ACCESS_TOKEN }}
|
||||
branch: master
|
||||
|
||||
- name: Generate static pages using mkdocs
|
||||
run: |
|
||||
shopt -s extglob
|
||||
90
B6-temp.md
90
B6-temp.md
|
|
@ -2,12 +2,18 @@
|
|||
|
||||
-- 640
|
||||
MOTOR_1 = 0x280
|
||||
-- 644
|
||||
MOTOR_BRE = 0x284
|
||||
-- 648
|
||||
MOTOR_2 = 0x288
|
||||
-- 896
|
||||
MOTOR_3 = 0x380
|
||||
-- 1152
|
||||
MOTOR_5 = 0x480
|
||||
-- 1160
|
||||
MOTOR_6 = 0x488
|
||||
-- 1386
|
||||
ACC_GRA = 0x56A
|
||||
-- 1408 the one with variable payload
|
||||
MOTOR_INFO = 0x580
|
||||
-- 1416
|
||||
|
|
@ -101,12 +107,15 @@ end
|
|||
totalEcuMessages = 0
|
||||
totalTcuMessages = 0
|
||||
|
||||
motor1Data = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
|
||||
motor1Data = { 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
|
||||
motorBreData={ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
|
||||
motor2Data = { 0x8A, 0x8D, 0x10, 0x04, 0x00, 0x4C, 0xDC, 0x87 }
|
||||
canMotorInfo = { 0x00, 0x00, 0x00, 0x14, 0x1C, 0x93, 0x48, 0x14 }
|
||||
canMotor3 = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }
|
||||
motor5Data = { 0x1C, 0x08, 0xF3, 0x55, 0x19, 0x00, 0x00, 0xAD }
|
||||
motor6Data = { 0x00, 0x00, 0x00, 0x7E, 0xFE, 0xFF, 0xFF, 0x00 }
|
||||
-- motor7Data = { 0x1A, 0x66, 0x7E, 0x00, 0x00, 0x00, 0x00, 0x00 }
|
||||
motor7Data = { 0x1A, 0x66, 0x7E, 0x00, 0x00, 0x00, 0x00, 0x00 }
|
||||
accGraData = { 0x00, 0x00, 0x08, 0x00, 0x1A, 0x00, 0x02, 0x01 }
|
||||
|
||||
function onMotor1(bus, id, dlc, data)
|
||||
rpm = getBitRange(data, 16, 16) * 0.25
|
||||
|
|
@ -137,8 +146,6 @@ function onMotor1(bus, id, dlc, data)
|
|||
|
||||
-- print ('MOTOR_1 torqueLoss ' ..torqueLoss ..' requestedTorque ' ..requestedTorque)
|
||||
|
||||
motor1Data[1] = data[1]
|
||||
|
||||
txCan(TCU_BUS, id, 0, motor1Data)
|
||||
end
|
||||
|
||||
|
|
@ -169,6 +176,9 @@ function onMotor6(bus, id, dlc, data)
|
|||
actualTorque = getBitRange(data, 16, 8) * 0.39
|
||||
feedbackGearbox = getBitRange(data, 40, 8) * 0.39
|
||||
|
||||
counter16 = (counter16 + 1) % 16
|
||||
|
||||
|
||||
-- engineTorque = fakeTorque * 0.9
|
||||
-- actualTorque = fakeTorque
|
||||
-- feedbackGearbox = 255
|
||||
|
|
@ -176,46 +186,74 @@ function onMotor6(bus, id, dlc, data)
|
|||
motor6Data[2] = math.floor(engineTorque / 0.39)
|
||||
motor6Data[3] = math.floor(actualTorque / 0.39)
|
||||
motor6Data[6] = math.floor(feedbackGearbox / 0.39)
|
||||
|
||||
motor6Data[8] = data[8]
|
||||
setBitRange(motor6Data, 60, 4, counter16)
|
||||
|
||||
xorChecksum(motor6Data, 1)
|
||||
txCan(TCU_BUS, id, 0, motor6Data)
|
||||
end
|
||||
|
||||
function silentDrop(bus, id, dlc, data)
|
||||
end
|
||||
|
||||
function printAndDrop(bus, id, dlc, data)
|
||||
print('Dropping ' ..arrayToString(data))
|
||||
end
|
||||
|
||||
function onAnythingFromECU(bus, id, dlc, data)
|
||||
totalEcuMessages = totalEcuMessages + 1
|
||||
function onMotorInfo(bus, id, dlc, data)
|
||||
-- print("Relaying to TCU " .. id)
|
||||
txCan(TCU_BUS, id, 0, data) -- relay non-TCU message to TCU
|
||||
end
|
||||
|
||||
function onAnythingFromTCU(bus, id, dlc, data)
|
||||
totalTcuMessages = totalTcuMessages + 1
|
||||
-- print("Relaying to ECU " .. id)
|
||||
txCan(ECU_BUS, id, 0, data) -- relay non-ECU message to ECU
|
||||
function onMotorBre(bus, id, dlc, data)
|
||||
motorBreCounter = (motorBreCounter + 1) % 16
|
||||
|
||||
setBitRange(motorBreData, 8, 4, motorBreCounter)
|
||||
xorChecksum(motorBreData, 1)
|
||||
|
||||
txCan(TCU_BUS, id, 0, motorBreData) -- relay non-TCU message to TCU
|
||||
end
|
||||
|
||||
function onMotor2(bus, id, dlc, data)
|
||||
minTorque = fakeTorque / 2
|
||||
motor2Data[7] = math.floor(minTorque / 0.39)
|
||||
|
||||
print ( "brake " .. getBitRange(data, 16, 2) .. " " .. rpm)
|
||||
|
||||
brakeBit = rpm < 2000 and 1 or 0
|
||||
setBitRange(motor2Data, 16, 1, brakeBit)
|
||||
|
||||
|
||||
txCan(TCU_BUS, id, 0, data) -- relay non-TCU message to TCU
|
||||
-- txCan(TCU_BUS, id, 0, motor2Data)
|
||||
end
|
||||
|
||||
function onMotor7(bus, id, dlc, data)
|
||||
-- print("Relaying to TCU " .. id)
|
||||
-- txCan(TCU_BUS, id, 0, data) -- relay non-TCU message to TCU
|
||||
txCan(TCU_BUS, id, 0, motor7Data)
|
||||
end
|
||||
|
||||
function onAccGra(bus, id, dlc, data)
|
||||
accGraCounter = (accGraCounter + 1) % 16
|
||||
setBitRange(accGraData, 60, 4, accGraCounter)
|
||||
xorChecksum(accGraData, 1)
|
||||
|
||||
-- print("Relaying to TCU " .. id)
|
||||
-- txCan(TCU_BUS, id, 0, data) -- relay non-TCU message to TCU
|
||||
txCan(TCU_BUS, id, 0, accGraData)
|
||||
end
|
||||
|
||||
canRxAdd(ECU_BUS, MOTOR_1, onMotor1)
|
||||
--canRxAdd(ECU_BUS, MOTOR_3, onMotor3)
|
||||
--canRxAdd(ECU_BUS, MOTOR_5, onMotor5)
|
||||
--canRxAdd(ECU_BUS, MOTOR_INFO, silentDrop)
|
||||
canRxAdd(ECU_BUS, MOTOR_BRE, onMotorBre)
|
||||
canRxAdd(ECU_BUS, MOTOR_2, onMotor2)
|
||||
canRxAdd(ECU_BUS, MOTOR_3, onMotor3)
|
||||
canRxAdd(ECU_BUS, MOTOR_5, onMotor5)
|
||||
canRxAdd(ECU_BUS, MOTOR_INFO, onMotorInfo)
|
||||
canRxAdd(ECU_BUS, MOTOR_6, onMotor6)
|
||||
--canRxAdd(ECU_BUS, MOTOR_7, silentDrop)
|
||||
canRxAdd(ECU_BUS, MOTOR_7, onMotor7)
|
||||
|
||||
-- last option: unconditional forward of all remaining messages
|
||||
canRxAddMask(ECU_BUS, 0, 0, onAnythingFromECU)
|
||||
canRxAddMask(TCU_BUS, 0, 0, onAnythingFromTCU)
|
||||
canRxAdd(ECU_BUS, ACC_GRA, onAccGra)
|
||||
|
||||
everySecondTimer = Timer.new()
|
||||
canMotorInfoCounter = 0
|
||||
|
||||
motorBreCounter = 0
|
||||
accGraCounter = 0
|
||||
counter16 = 0
|
||||
|
||||
mafSensor = Sensor.new("maf")
|
||||
mafCalibrationIndex = findCurveIndex("mafcurve")
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
Github Actions is currently in charge of:
|
||||
|
||||
* Firmware Builds: continues integration publishing at [https://rusefi.com/build_server/](https://rusefi.com/build_server/)
|
||||
* Firmware Builds: continuous integration publishing at [https://rusefi.com/build_server/](https://rusefi.com/build_server/)
|
||||
* Console Builds
|
||||
* Simulator Builds
|
||||
* Android App Builds
|
||||
|
|
@ -10,7 +10,7 @@ Github Actions is currently in charge of:
|
|||
* Generating Coverity code coverage pages
|
||||
* Generating Doxygen documentation
|
||||
* Generating iBOMs for hardware
|
||||
* Uploading .ini files into rusEFI Online database using RUSEFI_ONLINE_FTP_USER
|
||||
* Uploading .ini files into rusEFI Online database using RUSEFI_SSH_USER
|
||||
* Generating Hardware PCB visual diffs
|
||||
* Updating date stamps for builds
|
||||
* Synchronizing between rusefi/rusefi/wiki to rusefi_documentation repo
|
||||
|
|
|
|||
|
|
@ -1,36 +1,28 @@
|
|||
# Documentation Strategy
|
||||
|
||||
|
||||
# Side note
|
||||
|
||||
Open question what is in scope of rusEFI wiki and what is out of scope.
|
||||
Open question: What is in scope of rusEFI wiki and what is out of scope?
|
||||
|
||||
* A of Nov 2022 the best cost/benefit ratio is to work on TunerStudio layout and TunerStudio field tooltips and help articles which are embedded into "Help" of specific dialogs.
|
||||
* Andrey does not believe in text documentation on wiki
|
||||
* Content problem versus infrastructure/structure problem like https://github.com/rusefi/rusefi_documentation/issues/250 and https://github.com/rusefi/rusefi_documentation/issues/168
|
||||
* We are probably not trying to teach people how to tune HP Academy does that better
|
||||
|
||||
## Wiki status
|
||||
|
||||
# If we still hope to untangle the mess of four Wikis
|
||||
|
||||
As of April, 2020 the strategy is to move from MediaWiki https://rusefi.com/wiki/ to
|
||||
https://github.com/rusefi/rusefi/wiki/
|
||||
|
||||
A full list of (Legacy) mediawiki pages is available at https://rusefi.com/wiki/index.php?title=Special:AllPages
|
||||
|
||||
|
||||
Arguments for github:
|
||||
1) Access control
|
||||
2) Better change review process
|
||||
3) Better history and version control management
|
||||
|
||||
Arguments against github
|
||||
1) Weird workflow with two separate git repositories
|
||||
2) Weird inconsistency of markup language between two git repositories
|
||||
|
||||
Arguments for mediawiki:
|
||||
1) ?
|
||||
As of December, 2022 the strategy is to maintain two wikis, with [the same source](https://github.com/rusefi/rusefi_documentation) for both.
|
||||
[https://github.com/rusefi/rusefi/wiki/](https://github.com/rusefi/rusefi/wiki/) AKA Wiki2
|
||||
[https://wiki.rusefi.com](https://wiki.rusefi.com) AKA Wiki3
|
||||
|
||||
|
||||
Reasons for using a source repo:
|
||||
1. Access control
|
||||
2. Change review process
|
||||
3. History and version control management
|
||||
|
||||
Problems with Github Wiki:
|
||||
1. [Not crawlable by search engines](https://github.com/isaacs/github/issues/1683)
|
||||
|
||||
Problems with having two wikis:
|
||||
1. Inconsistency of markup language between the two wikis
|
||||
|
||||
See [HOWTO Contribute to Documentation](HOWTO-contribute-to-documentation)
|
||||
|
|
|
|||
|
|
@ -1,37 +0,0 @@
|
|||
In order to leverage github/wiki look&feel in combination with github pull request process we have to use two git repositories in our workflow:
|
||||
|
||||
1) Technical git repository https://github.com/rusefi/rusefi_documentation is used to submit content using fork&pull request process
|
||||
|
||||
2) The user-facing https://github.com/rusefi/rusefi.wiki.git repository is displayed to viewers at https://github.com/rusefi/rusefi/wiki and Jenkins automation merges all changes from technical git into https://github.com/rusefi/rusefi.wiki.git behind the scenes.
|
||||
|
||||
|
||||
For example, in order for user abelom to edit this page:
|
||||
|
||||
1) abelom would start editing at https://github.com/rusefi/rusefi_documentation/blob/master/Documentation_Workflow.md which would automatically create a branch in https://github.com/abelom/rusefi_documentation fork
|
||||
2) Once changed are made, abelom would create a Pull Request
|
||||
3) Once that PR is merged into primary rusEFI modified content would appear as https://github.com/rusefi/rusefi_documentation/blob/master/Documentation_Workflow.md
|
||||
4) Within the next 5 minutes automation would sync this page into wiki git and it would be available with nicer layout as https://github.com/rusefi/rusefi/wiki/Documentation_Workflow
|
||||
|
||||
Same but in different terms:
|
||||
|
||||
1) Fork https://github.com/rusefi/rusefi_documentation
|
||||
2) Make your changes
|
||||
3) PR your changes
|
||||
4) Once PR is merged by one of moderators, your changes will appear at https://github.com/rusefi/rusefi_documentation instantaneously
|
||||
5) Within the next 5 minutes magic happens and the changes appear at https://github.com/rusefi/rusefi/wiki
|
||||
|
||||
**Q:** Is there a place where we are holding all images for these documents?
|
||||
**A:** We have images in the same repository! Just add your images while editing pages. Please consider using some (any really) folder structure.
|
||||
|
||||
For example https://github.com/rusefi/rusefi_documentation/blob/master/FAQ/images/TunerStudio_new_project.png is visible on /wiki/ as https://raw.githubusercontent.com/wiki/rusefi/rusefi/FAQ/images/TunerStudio_new_project.png
|
||||
|
||||
Long story short, for images to work correctly both in the technical git and the user-facing wiki, we place all .md files into the same root folder.
|
||||
|
||||
(More details:
|
||||
Please note that all .md files like https://github.com/rusefi/rusefi_documentation/blob/master/FAQ/HOWTO_quick_start.md are displayed without folder name like https://github.com/rusefi/rusefi/wiki/HOWTO_quick_start - which also means
|
||||
that you need full image path like ``FAQ/images/rusEFI_console/rusEFI_console_start_screen.png`` for the image to be rendered properly. This is one of the github wiki features which are a bit counter-intuitive to me.
|
||||
|
||||
This also means that .md file names have to be unique for the whole.)
|
||||
|
||||
**Q:** What sort of fancy options do we have?
|
||||
**A:** We can do collapsible sections & hints sections! See [cranking](Cranking) for an example.
|
||||
|
|
@ -1,44 +0,0 @@
|
|||
In order to leverage the github pull request process for access control to the wiki, it is stored in a github repo:
|
||||
|
||||
[https://github.com/rusefi/rusefi_documentation](https://github.com/rusefi/rusefi_documentation)
|
||||
|
||||
When a change is made to the repo, a Github Action automatically builds the wiki and uploads it.
|
||||
|
||||
|
||||
For example, in order for user abelom to edit this page:
|
||||
|
||||
1. abelom would start editing at [https://github.com/rusefi/rusefi_documentation/blob/master/Documentation_Workflow.md](https://github.com/rusefi/rusefi_documentation/blob/master/Documentation_Workflow.md) which would automatically create a branch in [https://github.com/abelom/rusefi_documentation](https://github.com/abelom/rusefi_documentation) fork
|
||||
2. Once changed are made, abelom would create a Pull Request
|
||||
3. Once that PR is merged into primary rusEFI modified content would appear as [https://github.com/rusefi/rusefi_documentation/blob/master/Documentation_Workflow.md](https://github.com/rusefi/rusefi_documentation/blob/master/Documentation_Workflow.md)
|
||||
4. Within the next 5 minutes automation would build this page and upload it, and it would be available with nicer layout as [https://wiki.rusefi.com/Documentation_Workflow](https://wiki.rusefi.com/Documentation_Workflow)
|
||||
|
||||
Same but in different terms:
|
||||
|
||||
1. Fork [https://github.com/rusefi/rusefi_documentation](https://github.com/rusefi/rusefi_documentation)
|
||||
2. Make your changes
|
||||
3. PR your changes
|
||||
4. Once PR is merged by one of moderators, your changes will appear at [https://github.com/rusefi/rusefi_documentation](https://github.com/rusefi/rusefi_documentation) instantaneously
|
||||
5. Within the next 5 minutes magic happens and the changes appear at [https://wiki.rusefi.com](https://wiki.rusefi.com)
|
||||
|
||||
If you have been added to the documentation team, you will be able to make changes directly to the repo, and won't have to fork and PR.
|
||||
|
||||
**Q:** Is there a place where we are holding all images for these documents?
|
||||
**A:** We have images in the same repository! Just add your images while editing pages. Please consider using some (any really) folder structure.
|
||||
|
||||
For example [https://github.com/rusefi/rusefi_documentation/blob/master/FAQ/images/TunerStudio_new_project.png](https://github.com/rusefi/rusefi_documentation/blob/master/FAQ/images/TunerStudio_new_project.png) is visible on wiki.rusefi.com as [https://wiki.rusefi.com/FAQ/images/TunerStudio_new_project.png](https://wiki.rusefi.com/FAQ/images/TunerStudio_new_project.png)
|
||||
|
||||
### How URLs work
|
||||
|
||||
Links to page names use only the name of the page; relative path does not matter.
|
||||
Example:
|
||||
|
||||
`[The Documentation Workflow](Documentation-Workflow)`
|
||||
|
||||
Links to images are relative to the .md file they are in.
|
||||
Example:
|
||||
|
||||
``
|
||||
|
||||
**Q:** What sort of fancy options do we have?
|
||||
|
||||
**A:** We can do collapsible sections & hints sections! See [cranking](Cranking) for an example.
|
||||
|
|
@ -40,7 +40,7 @@ We have attempted to compile a list of coils [here.](Vault-Of-Ignition-Parts)
|
|||
|
||||
Ok, this question needs tackling in several parts, please pick the option you need below:
|
||||
|
||||
<details><summary><u>I want to buy new coils</u></summary>
|
||||
<details markdown="1"><summary><u>I want to buy new coils</u></summary>
|
||||
|
||||
If you are looking to buy new coils then we would recommend taking a look at the list of Ignition coils that have been tried with rusEFI.
|
||||
[List of ignition coils](Vault-Of-Ignition-Parts)
|
||||
|
|
@ -50,9 +50,9 @@ There are lots of tried and tested options that can be found by [**searching the
|
|||
</details>
|
||||
|
||||
|
||||
<details><summary><u>I have existing coils </u></summary>
|
||||
<details markdown="1"><summary><u>I have existing coils </u></summary>
|
||||
|
||||
<details><summary><u>My coils are newer smart coils</u></summary>
|
||||
<details markdown="1"><summary><u>My coils are newer smart coils</u></summary>
|
||||
|
||||
Great, then you can wire them directly to the ECU.
|
||||
However please take care to check that tht coils you have really do incorporate the ignition driver into the coil.
|
||||
|
|
@ -61,7 +61,7 @@ There is some information on known smart coils and how to work out if you have a
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary><u>My coils are older dumb coils</u></summary>
|
||||
<details markdown="1"><summary><u>My coils are older dumb coils</u></summary>
|
||||
|
||||
Great - same as the smart coils, please double check your coils are actually simple coils without built in ignition modules.
|
||||
You will need to source an external ignition module to go between the ECU and the coils.
|
||||
|
|
@ -101,4 +101,4 @@ Some Bosch dumb coils have 3 pins, one is used for ignition misfire monitoring.
|
|||
Wasted spark coils can share one common pin and then have a single pin for each coil pair. Resulting in a dumb coil with 3-5 pins.
|
||||
Some wasted spark coils have 2 pins for each coil pair inside the pack.
|
||||
|
||||
This means it is vitally necessary to check the requirements of your actual coils by reviewing the wiring diagrams or [**searching the forum.**](https://rusefi.com/forum/search.php)
|
||||
This means it is vitally necessary to check the requirements of your actual coils by reviewing the wiring diagrams or [**searching the forum.**](https://rusefi.com/forum/search.php)
|
||||
|
|
|
|||
|
|
@ -0,0 +1,41 @@
|
|||
# Testing Documentation Changes
|
||||
|
||||
## Wiki2
|
||||
|
||||
###Setup:
|
||||
|
||||
You must have a fork of the main rusefi repo as well as a fork of the rusefi_documentation repo.
|
||||
Clone your fork of the rusefi_documentation repo:
|
||||
`git clone git@github.com:<your username>/rusefi_documentation.git`
|
||||
From your clone, add your wiki as a remote and push to it.
|
||||
```
|
||||
git remote add wiki git@github.com:<your username>/rusefi.wiki.git
|
||||
git fetch wiki
|
||||
git push wiki
|
||||
```
|
||||
This will get your wiki2 up and running. Now you can make changes, and run
|
||||
```
|
||||
git commit -am "your commit message"
|
||||
git push wiki
|
||||
```
|
||||
to test them on wiki2.
|
||||
You might have to use `git push --force wiki`.
|
||||
Also, note that the changes must be in the master branch of your fork for this to work.
|
||||
|
||||
If you want the changes to be synced automatically, you will have to change the usernames in your forks' action files.
|
||||
Specifically, these action workflows:
|
||||
[rusefi_documentation/.github/workflows/sync-wiki.yaml](https://github.com/rusefi/rusefi_documentation/blob/master/.github/workflows/sync-wiki.yaml)
|
||||
[rusefi/.github/workflows/sync-wiki.yaml](https://github.com/rusefi/rusefi/blob/master/.github/workflows/sync-wiki.yaml)
|
||||
You need to set up an access token in your repository secrets for Actions.
|
||||
|
||||
## Wiki3
|
||||
|
||||
The easiest way to test Wiki3 is locally. You could also set up a webserver and your repository secrets to let the workflow upload it for you, but here I'll just explain how to test locally.
|
||||
|
||||
The full instructions for installing MkDocs can be found [here](https://www.mkdocs.org/user-guide/installation/), but the short version is to run `pip install mkdocs`.
|
||||
You will also need the EzLinks plugin, which you can install with `pip install mkdocs-ezlinks-plugin`.
|
||||
|
||||
Once MkDocs is installed, you can now generate the site.
|
||||
I do this with a one-liner, run from the root directory of the repo:
|
||||
`cd mkdocs; rm -r docs site; mkdir docs; cp -r ../!(mkdocs) docs; cp style.css docs; mkdocs build; cd ..`
|
||||
MkDocs expects the Markdown documentation files to be in a "docs" subdirectory, so we create it and move everything to it, and then we can go ahead and build the site.
|
||||
|
|
@ -1,63 +1,111 @@
|
|||
|
||||
#### How to contribute to https://github.com/rusefi/rusefi_documentation
|
||||
# How to contribute to documentation
|
||||
|
||||
Step 0: Edits are possible directly via [https://wiki.rusefi.com](https://wiki.rusefi.com/) 'Edit in GitHub' button. A Fork and PR will be created.
|
||||
In order to leverage the Github pull request process for access control to the wiki, it is stored in a [Github repo](https://github.com/rusefi/rusefi_documentation).
|
||||
|
||||
## Editing
|
||||
|
||||
### Editing from a Wiki3 page
|
||||
|
||||
1. From the wiki page you wish to edit on [https://wiki.rusefi.com](https://wiki.rusefi.com), click on the "Edit on GitHub" link in the upper right hand corner.
|
||||
|
||||
2. Sign up or sign in to [Github](https://github.com) if you aren't already
|
||||
|
||||
3. If you have been given write access the the rusefi_documentation priority, you can commit changes directly. If not, clicking on "Propose Changes" will fork the repository and give you the option to create a pull request.
|
||||
|
||||
|
||||
|
||||
Step 1: Alternatively, sign up or sign in to https://github.com
|
||||
4. Click "Create Pull Request" and wait for your change to be reviewed.
|
||||
|
||||
Step 2: Open https://github.com/rusefi/rusefi_documentation and click 'Fork' - this would produce your own fork/copy of rusefi_documentation which you can now edit right in your browser!
|
||||
|
||||
### Alternative: Editing from a fork of the repo
|
||||
|
||||
Step 3: Edit your code and Commit changes using the button below the editor.
|
||||
1. Sign up or sign in to [Github](https://github.com) if you aren't already
|
||||
|
||||
Step 4: Once you are ready to contribute your changes, hit 'New pull request' button on the main page of your fork.
|
||||
2. Open [the documentation repo](https://github.com/rusefi/rusefi_documentation) and click 'Fork' - this would produce your own fork/copy of rusefi_documentation which you can now edit right in your browser!
|
||||
|
||||
|
||||
This would produce a [Pull request like this](https://github.com/rusefi/rusefi_documentation/pull/3) in the official rusefi repository and your changes would probably soon become public!
|
||||
https://github.com/rusefi/rusefi/blob/master/firmware/tunerstudio/rusefi.input
|
||||
3. Edit your code and Commit changes using the button below the editor.
|
||||
|
||||
4. Once you are ready to contribute your changes, click the 'New pull request' button on the main page of your fork.
|
||||
|
||||
#### How to contribute to rusEFI TunerStudio project
|
||||
### After creating a Pull Request
|
||||
|
||||
Within the next 5 minutes after the pull request has been merged, a Github Action automatically builds the wiki and uploads it to both wikis.
|
||||
|
||||
Same as above, fork https://github.com/rusefi/rusefi and edit your local copy of
|
||||
https://github.com/rusefi/rusefi/blob/master/firmware/tunerstudio/rusefi.input file
|
||||
## How to contribute to rusEFI TunerStudio project
|
||||
|
||||
https://github.com/rusefi/rusefi/commit/9d9ae5a05499027b32ed76df3e7ee2e2e8240c31 is an example of how more help could be added
|
||||
1. Sign up or sign in to [Github](https://github.com) if you aren't already
|
||||
|
||||
2. Go to [https://github.com/rusefi/rusefi](https://github.com/rusefi/rusefi) and click "Fork" near the upper right corner
|
||||
|
||||
3. Edit your fork of [the TunerStudio input](https://github.com/rusefi/rusefi/blob/master/firmware/tunerstudio/rusefi.input) file
|
||||
|
||||
4. Click "Contribute", then "Open Pull Request", and finally "Create Pull Request"
|
||||
|
||||
5. Wait for your changes to be reviewed and merged.
|
||||
|
||||
[This commit](https://github.com/rusefi/rusefi/commit/9d9ae5a05499027b32ed76df3e7ee2e2e8240c31) is an example of how more help could be added
|
||||
right into TunerStudio project file. Lines with green background are the lines being added.
|
||||
|
||||
Unfortunately while you would be modifying your mainController.ini file while trying your changes, you need to edit rusefi.input file which
|
||||
is a template from which rusefi.ini is generated programmatically on rusefi side.
|
||||
|
||||
# Wiki location migration
|
||||
|
||||
As of Dec 2022, https://github.com/rusefi/rusefi/wiki called "wiki2-human" is the primary documentation URL. wiki.rusefi.com migration is on-going we are fighting some issues.
|
||||
|
||||
|
||||
# Technical implementation details
|
||||
## Technical implementation details
|
||||
|
||||
Github Wiki is weird.
|
||||
|
||||
One the one hand, we have https://github.com/rusefi/rusefi_documentation called "wiki2-technical" - that's a git repository with nice pull
|
||||
request process, but less nice web page rendering which start each folder by showing list of files, that's not what end users want to see.
|
||||
One the one hand, we have [https://github.com/rusefi/rusefi_documentation](https://github.com/rusefi/rusefi_documentation), which we will call "wiki-source".
|
||||
That's a git repository with nice pull request process, but less nice web page rendering which starts each page by showing a list of files - that's not what end users want to see.
|
||||
|
||||
On the other hand, we have [the Github Wiki](https://github.com/rusefi/rusefi/wiki), which we will call "wiki2" which is displayed much nicer - and that is actually implemented by ANOTHER git repository https://github.com/rusefi/rusefi.wiki.git behind the scenes.
|
||||
That repository does not have a nice Pull Request process :(
|
||||
|
||||
On the other hand, we have https://github.com/rusefi/rusefi/wiki which is displayed much nicer - and
|
||||
that https://github.com/rusefi/rusefi/wiki is actually implemented by ANOTHER git repository
|
||||
https://github.com/rusefi/rusefi.wiki.git behind the scene. That https://github.com/rusefi/rusefi.wiki.git repository does not have a nice Pull Request process :(
|
||||
Solution? A combination. [wiki2](https://github.com/rusefi/rusefi/wiki) and [wiki-source](https://github.com/rusefi/rusefi_documentation) repositories are actually set to mirror each other.
|
||||
This way we have the nice Pull Request process on [wiki-source](https://github.com/rusefi/rusefi_documentation) and once changes are merged, the wiki-source repo is then automatically merged into the wiki2 repo, which makes actual content nicely visible on [wiki2](https://github.com/rusefi/rusefi/wiki)
|
||||
Synchronization between wiki2 and wiki-source is automated via [Github Action](https://github.com/rusefi/rusefi/blob/master/.github/workflows/sync-wiki.yaml), file content is expected to be the same between these two repositories.
|
||||
|
||||
Solution? A combination. [wiki2-human](https://github.com/rusefi/rusefi/wiki) and [wiki2-technical](https://github.com/rusefi/rusefi_documentation) repositories are actually set to mirror each other.
|
||||
This way we have the nice Pull Request process on https://github.com/rusefi/rusefi_documentation and once changes are
|
||||
merged into https://github.com/rusefi/rusefi_documentation, complete https://github.com/rusefi/rusefi_documentation is automatically merged
|
||||
into https://github.com/rusefi/rusefi.wiki.git which makes actual content nicely visible at https://github.com/rusefi/rusefi/wiki
|
||||
Synchronization between wiki2-human and wiki2-technical is automated via [Github Action](https://github.com/rusefi/rusefi/blob/master/.github/workflows/sync-wiki.yaml), file content is expected to be the same between these two repositories.
|
||||
## How Page Titles Work on Wiki3
|
||||
|
||||
# Technical FAQ
|
||||
If the first line with content is a top-level header, e.g. `# rusEFI Documentation`, that will be used as the page title.
|
||||
If not, the file name will be used as the page title, only without the hyphens.
|
||||
|
||||
Q: Is it ok that https://github.com/rusefi/rusefi.wiki.git cannot be opened from browser?
|
||||
## How URLs work
|
||||
|
||||
A: There is no reason to open https://github.com/rusefi/rusefi.wiki.git from browser. Also while you technically
|
||||
Links to page names use only the name of the page.
|
||||
Example:
|
||||
|
||||
`[How to contribute to documentation](HOWTO-contribute-to-documentation)`
|
||||
Result:
|
||||
[How to contribute to documentation](HOWTO-contribute-to-documentation)
|
||||
|
||||
Links to images are relative to the root of the wiki on Wiki2, and relative to the .md file location on Wiki3.
|
||||
The only way for this to work consistently between Wiki2 and Wiki3 is to have a flat directory structure.
|
||||
Example:
|
||||
|
||||
``
|
||||
Result:
|
||||
|
||||
|
||||
## Technical FAQ
|
||||
|
||||
**Q:** Is there a place where we are holding all images for these documents?
|
||||
**A:** We have images in the same repository! Just add your images while editing pages. Please consider using some (any really) folder structure.
|
||||
For example [https://github.com/rusefi/rusefi_documentation/blob/master/FAQ/images/TunerStudio_new_project.png](https://github.com/rusefi/rusefi_documentation/blob/master/FAQ/images/TunerStudio_new_project.png) is visible on wiki.rusefi.com as [https://wiki.rusefi.com/FAQ/images/TunerStudio_new_project.png](https://wiki.rusefi.com/FAQ/images/TunerStudio_new_project.png)
|
||||
|
||||
**Q:** What sort of fancy options do we have?
|
||||
**A:** We can do collapsible sections & hints sections! See [cranking](Cranking) for an example. Unfortunately, it's quite picky about how you format the markdown.
|
||||
```
|
||||
<details markdown="1"><summary>More...</summary>
|
||||
|
||||
^ Must have empty line after </summary>
|
||||
# Content
|
||||
</details>
|
||||
|
||||
^ Must have empty line after </details>
|
||||
```
|
||||
|
||||
**Q**: Is it ok that https://github.com/rusefi/rusefi.wiki.git cannot be opened from browser?
|
||||
**A**: There is no reason to open https://github.com/rusefi/rusefi.wiki.git from browser. Also while you technically
|
||||
CAN "git clone https://github.com/rusefi/rusefi_documentation.wiki.git" and it would work -
|
||||
you should NOT. Anyone looking to make changes should be making changes to non-wiki git via normal fork & pull request process.
|
||||
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,12 +1,12 @@
|
|||
## Master list of fuel pages
|
||||
|
||||
<details><summary><u>rusEFI Project</u></summary>
|
||||
<details markdown="1"><summary><u>rusEFI Project</u></summary>
|
||||
|
||||
* [rusEFI Project Fuel](rusEFI-project-Fuel)
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary><u>Fuel Algorithms</u></summary>
|
||||
<details markdown="1"><summary><u>Fuel Algorithms</u></summary>
|
||||
|
||||
* [Fuel Overview](Fuel-Overview)
|
||||
* [Cranking](Cranking)
|
||||
|
|
@ -16,7 +16,7 @@
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary><u>Acceleration</u></summary>
|
||||
<details markdown="1"><summary><u>Acceleration</u></summary>
|
||||
|
||||
* [Overview](Acceleration-Compensation)
|
||||
* [X-Tau Wall Wetting](X-tau-Wall-Wetting)
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary><u>AFR measurement</u></summary>
|
||||
<details markdown="1"><summary><u>AFR measurement</u></summary>
|
||||
|
||||
* [Wide Band Sensors](Wide-Band-Sensors.md)
|
||||
* [Do I need a wideband](do-i-need-wideband-oxygen-sensor)
|
||||
|
|
@ -32,7 +32,7 @@
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary><u>Fuel Hardware</u></summary>
|
||||
<details markdown="1"><summary><u>Fuel Hardware</u></summary>
|
||||
|
||||
* [Converting from Carb](how-to-convert-from-carburetor-to-EFI)
|
||||
* [GDI Status](GDI-status)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,5 @@
|
|||
#Master list of HOW TO pages
|
||||
|
||||
<details><summary><u>HOW TO</u></summary>
|
||||
|
||||
* [Ask questions](HOWTO-ask-questions.md)
|
||||
* [Contribute to documentation](HOWTO-contribute-to-documentation.md)
|
||||
* [Create a tunerstudio project](HOWTO-create-tunerstudio-project.md)
|
||||
|
|
@ -15,5 +13,3 @@
|
|||
* [Remote tune](HOWTO-Remote-Tuning.md)
|
||||
* [Search the wiki](HOWTO-Search-on-rusEFI-wiki.md)
|
||||
* [Set rusEFI Online authentication token](HOWTO-set-rusEFI-Online-authentication-token.md)
|
||||
|
||||
</details>
|
||||
|
|
|
|||
|
|
@ -2,22 +2,22 @@
|
|||
|
||||
### [Ignition FAQ](FAQ-Ignition)
|
||||
|
||||
<details><summary><u>rusEFI Project</u></summary>
|
||||
<details markdown="1"><summary><u>rusEFI Project</u></summary>
|
||||
|
||||
* [rusEFI Project Ignition](rusEFI-project-Ignition)
|
||||
|
||||
</details>
|
||||
|
||||
<details><summary><u>Ignition Wiring</u></summary>
|
||||
<details markdown="1"><summary><u>Ignition Wiring</u></summary>
|
||||
|
||||
* [Basic Ignition Wiring](FAQ-Basic-Wiring-and-Connections)
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Coils and ignition modules</u></summary>
|
||||
<details markdown="1"><summary><u>Coils and ignition modules</u></summary>
|
||||
|
||||
* [List of tested coils](Vault-Of-Ignition-Parts)
|
||||
* [List of tested Ignition modules and IGBTs](Vault-Of-Ignition-Parts)
|
||||
|
||||
</details>
|
||||
</details>
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
## Master list of Sensor and Actuators pages
|
||||
|
||||
<details><summary><u>Throttle and ETB</u></summary>
|
||||
<details markdown="1"><summary><u>Throttle and ETB</u></summary>
|
||||
|
||||
* [How To - ETB](Electronic-Throttle-Body-Configuration-Guide)
|
||||
* List of tested ETBs - Coming Soon
|
||||
|
|
@ -10,7 +10,7 @@
|
|||
</details>
|
||||
|
||||
|
||||
<details><summary><u>MAP Sensors</u></summary>
|
||||
<details markdown="1"><summary><u>MAP Sensors</u></summary>
|
||||
|
||||
* [Fuel Overview](Fuel-Overview)
|
||||
* [GM Map sensor](GM-map-sensor)
|
||||
|
|
@ -19,14 +19,14 @@
|
|||
</details>
|
||||
|
||||
|
||||
<details><summary><u>MAF Sensors</u></summary>
|
||||
<details markdown="1"><summary><u>MAF Sensors</u></summary>
|
||||
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>AFR measurement (Wideband)</u></summary>
|
||||
<details markdown="1"><summary><u>AFR measurement (Wideband)</u></summary>
|
||||
|
||||
* [Wide Band Sensors](Wide-Band-Sensors)
|
||||
* [Do I need a wideband](do-i-need-wideband-oxygen-sensor)
|
||||
|
|
@ -36,21 +36,21 @@
|
|||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Intake Air Temperature Sensors</u></summary>
|
||||
<details markdown="1"><summary><u>Intake Air Temperature Sensors</u></summary>
|
||||
|
||||
* List of tested Intake Air Temperature Sensors - Coming Soon
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Coolant Temperature Sensors</u></summary>
|
||||
<details markdown="1"><summary><u>Coolant Temperature Sensors</u></summary>
|
||||
|
||||
* List of tested Coolant Temperature Sensors - Coming Soon
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Crank Sensors</u></summary>
|
||||
<details markdown="1"><summary><u>Crank Sensors</u></summary>
|
||||
|
||||
* [List of tested trigger patterns](All-Supported-Triggers)
|
||||
* List of tested Crank Sensors - Coming Soon
|
||||
|
|
@ -60,28 +60,28 @@
|
|||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Knock Sensors</u></summary>
|
||||
<details markdown="1"><summary><u>Knock Sensors</u></summary>
|
||||
|
||||
* [Overview](knock-sensing)
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Camshaft Sensors</u></summary>
|
||||
<details markdown="1"><summary><u>Camshaft Sensors</u></summary>
|
||||
|
||||
- Coming Soon
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Ignition Coils</u></summary>
|
||||
<details markdown="1"><summary><u>Ignition Coils</u></summary>
|
||||
|
||||
- Coming Soon
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Fuel Injectors</u></summary>
|
||||
<details markdown="1"><summary><u>Fuel Injectors</u></summary>
|
||||
|
||||
* [GDI Status](GDI-status)
|
||||
* List of tested fuel injectors - Coming Soon
|
||||
|
|
@ -89,15 +89,15 @@
|
|||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Variable Valve Timing</u></summary>
|
||||
<details markdown="1"><summary><u>Variable Valve Timing</u></summary>
|
||||
|
||||
* [VVT Overview](VVT)
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Vehicle Specific Oddities</u></summary>
|
||||
<details markdown="1"><summary><u>Vehicle Specific Oddities</u></summary>
|
||||
|
||||
* [Mazda PRC Valve](Mazda-PRC-Valve)
|
||||
|
||||
</details>
|
||||
</details>
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
## Master list of software pages
|
||||
|
||||
<details><summary><u>rusEFI Project</u></summary>
|
||||
<details markdown="1"><summary><u>rusEFI Project</u></summary>
|
||||
|
||||
* [rusEFI Project Overview](rusEFI-project)
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>General Firmware info</u></summary>
|
||||
<details markdown="1"><summary><u>General Firmware info</u></summary>
|
||||
|
||||
* [Preferred Code Style](Code-Style)
|
||||
* [Debug Mode](Debug-Mode.md)
|
||||
|
|
@ -23,7 +23,7 @@
|
|||
|
||||
</details>
|
||||
|
||||
<details><summary><u>Firmware Features</u></summary>
|
||||
<details markdown="1"><summary><u>Firmware Features</u></summary>
|
||||
|
||||
* See also -> [rusEFI Project Overview](rusEFI-project)
|
||||
* [FSIO](FSIO.md)
|
||||
|
|
|
|||
|
|
@ -2,411 +2,411 @@
|
|||
|
||||
## This document contains all of the commonly used abbreviations and terminology used by rusEFI
|
||||
|
||||
<details><summary><u>AAP</u></summary>
|
||||
<details markdown="1"><summary><u>AAP</u></summary>
|
||||
|
||||
Absolute Atmosphere Pressure
|
||||
</details>
|
||||
|
||||
<details><summary><u>AFR</u></summary>
|
||||
<details markdown="1"><summary><u>AFR</u></summary>
|
||||
|
||||
Air Fuel Ratio - See also Lambda, Stoichiometric
|
||||
AFR is the ratio of air to fuel, often expressed as "14.7:1"
|
||||
</details>
|
||||
|
||||
<details><summary><u>AIT</u></summary>
|
||||
<details markdown="1"><summary><u>AIT</u></summary>
|
||||
|
||||
Air Intake Temperature
|
||||
</details>
|
||||
|
||||
<details><summary><u>Baro</u></summary>
|
||||
<details markdown="1"><summary><u>Baro</u></summary>
|
||||
|
||||
Shorthand for Barometric pressure
|
||||
</details>
|
||||
|
||||
<details><summary><u>BTDC</u></summary>
|
||||
<details markdown="1"><summary><u>BTDC</u></summary>
|
||||
|
||||
Before TDC, Before Top Dead Center - See also ATDC
|
||||
</details>
|
||||
|
||||
<details><summary><u>BMEP</u></summary>
|
||||
<details markdown="1"><summary><u>BMEP</u></summary>
|
||||
|
||||
Brake mean effective pressure
|
||||
</details>
|
||||
|
||||
<details><summary><u>CAS</u></summary>
|
||||
<details markdown="1"><summary><u>CAS</u></summary>
|
||||
|
||||
Crank Angle Sensor Also See [CPS - Wikipedia]](http://en.wikipedia.org/wiki/Crankshaft_position_sensor)
|
||||
</details>
|
||||
|
||||
<details><summary><u>CLT</u></summary>
|
||||
<details markdown="1"><summary><u>CLT</u></summary>
|
||||
|
||||
Coolant Temperature
|
||||
</details>
|
||||
|
||||
<details><summary><u>CoV</u></summary>
|
||||
<details markdown="1"><summary><u>CoV</u></summary>
|
||||
|
||||
Coefficient of variability
|
||||
</details>
|
||||
|
||||
<details><summary><u>CPS</u></summary>
|
||||
<details markdown="1"><summary><u>CPS</u></summary>
|
||||
|
||||
Crankshaft Position Sensor
|
||||
</details>
|
||||
|
||||
<details><summary><u>CR</u></summary>
|
||||
<details markdown="1"><summary><u>CR</u></summary>
|
||||
|
||||
compression ratio
|
||||
</details>
|
||||
|
||||
<details><summary><u>DI</u></summary>
|
||||
<details markdown="1"><summary><u>DI</u></summary>
|
||||
|
||||
Direct injection
|
||||
</details>
|
||||
|
||||
<details><summary><u>DISA</u></summary>
|
||||
<details markdown="1"><summary><u>DISA</u></summary>
|
||||
|
||||
BMW variable inlet manifold resonance system
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>EDIS</u></summary>
|
||||
<details markdown="1"><summary><u>EDIS</u></summary>
|
||||
|
||||
Electronic Distributorless Ignition System - An older Ford ignition system that combined a set of ignition IGBTs and some electronics to assist the ECU. Obsolete on modern ECUs.
|
||||
</details>
|
||||
|
||||
<details><summary><u>EGO</u></summary>
|
||||
<details markdown="1"><summary><u>EGO</u></summary>
|
||||
|
||||
Exhaust Gases Oxygen - see also lambda sensor, WBO2,
|
||||
Often used when referring to air fuel sensors like the lambda sensor.
|
||||
Sometimes also used as HEGO or Heated Exhaust Gas Oxygen.
|
||||
</details>
|
||||
|
||||
<details><summary><u>EGR</u></summary>
|
||||
<details markdown="1"><summary><u>EGR</u></summary>
|
||||
|
||||
Exhaust gas recirculation
|
||||
</details>
|
||||
|
||||
<details><summary><u>EGT</u></summary>
|
||||
<details markdown="1"><summary><u>EGT</u></summary>
|
||||
|
||||
Exhaust gas temperature
|
||||
</details>
|
||||
|
||||
<details><summary><u>EOI</u></summary>
|
||||
<details markdown="1"><summary><u>EOI</u></summary>
|
||||
|
||||
End Of Injection - See also SOI
|
||||
</details>
|
||||
|
||||
<details><summary><u>ETB</u></summary>
|
||||
<details markdown="1"><summary><u>ETB</u></summary>
|
||||
|
||||
Electronic throttle body
|
||||
</details>
|
||||
|
||||
<details><summary><u>EVC</u></summary>
|
||||
<details markdown="1"><summary><u>EVC</u></summary>
|
||||
|
||||
Exhaust valve closing
|
||||
</details>
|
||||
|
||||
<details><summary><u>EVO</u></summary>
|
||||
<details markdown="1"><summary><u>EVO</u></summary>
|
||||
|
||||
Exhaust valve opening
|
||||
</details>
|
||||
|
||||
<details><summary><u>GDI</u></summary>
|
||||
<details markdown="1"><summary><u>GDI</u></summary>
|
||||
|
||||
Gasoline Direct Injection
|
||||
</details>
|
||||
|
||||
<details><summary><u>Hall</u></summary>
|
||||
<details markdown="1"><summary><u>Hall</u></summary>
|
||||
|
||||
A type of sensor that requires a power and earth wire in addition to its signal wire, the output is normally a 5v square wave.
|
||||
</details>
|
||||
|
||||
<details><summary><u>High Side</u></summary>
|
||||
<details markdown="1"><summary><u>High Side</u></summary>
|
||||
|
||||
A driver that is open circuit when off and powered to 5v or 12v when on.
|
||||
</details>
|
||||
|
||||
<details><summary><u>High/Low</u></summary>
|
||||
<details markdown="1"><summary><u>High/Low</u></summary>
|
||||
|
||||
a pushpull or HighLow is an output that is powered "high" (12v or 5v) and switched to low (earth).
|
||||
</details>
|
||||
|
||||
<details><summary><u>High and Low Z</u></summary>
|
||||
<details markdown="1"><summary><u>High and Low Z</u></summary>
|
||||
|
||||
High and low resistance, used in terms of fuel injectors, normally around 14 ohms for high impedance and ~4 ohms for low.
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>IAT</u></summary>
|
||||
<details markdown="1"><summary><u>IAT</u></summary>
|
||||
|
||||
Intake Air Temperature
|
||||
</details>
|
||||
|
||||
<details><summary><u>IFR</u></summary>
|
||||
<details markdown="1"><summary><u>IFR</u></summary>
|
||||
|
||||
Injector Flow Rate
|
||||
</details>
|
||||
|
||||
<details><summary><u>IGBT</u></summary>
|
||||
<details markdown="1"><summary><u>IGBT</u></summary>
|
||||
|
||||
[IGBT - Wikipedia]](http://en.wikipedia.org/wiki/Insulated-gate_bipolar_transistor)
|
||||
A common type of transistor used for switching high power devices like ignition coils with a low power/voltage output.
|
||||
</details>
|
||||
|
||||
<details><summary><u>IMEP</u></summary>
|
||||
<details markdown="1"><summary><u>IMEP</u></summary>
|
||||
|
||||
Indicated mean effective pressure
|
||||
</details>
|
||||
|
||||
<details><summary><u>Injector Impedance</u></summary>
|
||||
<details markdown="1"><summary><u>Injector Impedance</u></summary>
|
||||
|
||||
The resistance of the fuel injectors, see high and low Z
|
||||
</details>
|
||||
|
||||
<details><summary><u>IPW</u></summary>
|
||||
<details markdown="1"><summary><u>IPW</u></summary>
|
||||
|
||||
Injector Pulse Width
|
||||
</details>
|
||||
|
||||
<details><summary><u>IVC</u></summary>
|
||||
<details markdown="1"><summary><u>IVC</u></summary>
|
||||
|
||||
Intake valve closing
|
||||
</details>
|
||||
|
||||
<details><summary><u>IVO</u></summary>
|
||||
<details markdown="1"><summary><u>IVO</u></summary>
|
||||
|
||||
Intake valve opening
|
||||
</details>
|
||||
|
||||
<details><summary><u>Low side</u></summary>
|
||||
<details markdown="1"><summary><u>Low side</u></summary>
|
||||
|
||||
A driver that is open circuit when off and grounded to earth when switched on.
|
||||
</details>
|
||||
|
||||
<details><summary><u>LQFP</u></summary>
|
||||
<details markdown="1"><summary><u>LQFP</u></summary>
|
||||
|
||||
Low profile quad flat package
|
||||
</details>
|
||||
|
||||
<details><summary><u>MAF</u></summary>
|
||||
<details markdown="1"><summary><u>MAF</u></summary>
|
||||
|
||||
Mass Air Flow, often used in the context of air flow or load sensors.
|
||||
</details>
|
||||
|
||||
<details><summary><u>MAP</u></summary>
|
||||
<details markdown="1"><summary><u>MAP</u></summary>
|
||||
|
||||
Manifold Absolute Pressure or perhaps Manifold Air Pressure, often used in the context of load sensors.
|
||||
</details>
|
||||
|
||||
<details><summary><u>MBT</u></summary>
|
||||
<details markdown="1"><summary><u>MBT</u></summary>
|
||||
|
||||
Mean best timing, used in context of spark timing, it is the spark timing that results in the best torque
|
||||
</details>
|
||||
|
||||
<details><summary><u>MFB</u></summary>
|
||||
<details markdown="1"><summary><u>MFB</u></summary>
|
||||
|
||||
Mass fraction burned, often stated with a number after i.e. MFB10/MFB50/MFB90 and refers to the fraction of the fuel burned by mass.
|
||||
</details>
|
||||
|
||||
<details><summary><u>MRE</u></summary>
|
||||
<details markdown="1"><summary><u>MRE</u></summary>
|
||||
|
||||
Micro rusEFI
|
||||
</details>
|
||||
|
||||
<details><summary><u>NGC</u></summary>
|
||||
<details markdown="1"><summary><u>NGC</u></summary>
|
||||
|
||||
Chrysler Next Generation Controller
|
||||
</details>
|
||||
|
||||
<details><summary><u>NTC</u></summary>
|
||||
<details markdown="1"><summary><u>NTC</u></summary>
|
||||
|
||||
Negative temperature coefficient, used in context of temperature sensors and refers to the resistance increasing as temperature decreases.
|
||||
</details>
|
||||
|
||||
<details><summary><u>PIP</u></summary>
|
||||
<details markdown="1"><summary><u>PIP</u></summary>
|
||||
|
||||
Profile ignition pickup See [Profile Ignition Pickup - Wikipedia]](http://en.wikipedia.org/wiki/Profile_ignition_pickup)
|
||||
</details>
|
||||
|
||||
<details><summary><u>PFI</u></summary>
|
||||
<details markdown="1"><summary><u>PFI</u></summary>
|
||||
|
||||
Port fuel injection
|
||||
</details>
|
||||
|
||||
<details><summary><u>PID</u></summary>
|
||||
<details markdown="1"><summary><u>PID</u></summary>
|
||||
|
||||
A proportional–integral–derivative controller
|
||||
</details>
|
||||
|
||||
<details><summary><u>PNP</u></summary>
|
||||
<details markdown="1"><summary><u>PNP</u></summary>
|
||||
|
||||
Plug and play
|
||||
</details>
|
||||
|
||||
<details><summary><u>PPS</u></summary>
|
||||
<details markdown="1"><summary><u>PPS</u></summary>
|
||||
|
||||
Pedal Position Sensor
|
||||
</details>
|
||||
|
||||
|
||||
<details><summary><u>Primary Coil</u></summary>
|
||||
<details markdown="1"><summary><u>Primary Coil</u></summary>
|
||||
|
||||
The primary winding of an ignition coil
|
||||
</details>
|
||||
|
||||
<details><summary><u>RE</u></summary>
|
||||
<details markdown="1"><summary><u>RE</u></summary>
|
||||
|
||||
rusEFI
|
||||
</details>
|
||||
|
||||
<details><summary><u>REO</u></summary>
|
||||
<details markdown="1"><summary><u>REO</u></summary>
|
||||
|
||||
rusEFI Online
|
||||
</details>
|
||||
|
||||
<details><summary><u>RUSEFI</u></summary>
|
||||
<details markdown="1"><summary><u>RUSEFI</u></summary>
|
||||
|
||||
Really Uber Simple EFI? Robust Ultra Simple EFI? Retarded Unproven Shitty EFI?
|
||||
</details>
|
||||
|
||||
<details><summary><u>Secondary Coil</u></summary>
|
||||
<details markdown="1"><summary><u>Secondary Coil</u></summary>
|
||||
|
||||
The secondary winding of an ignition coil.
|
||||
</details>
|
||||
|
||||
<details><summary><u>Sequential</u></summary>
|
||||
<details markdown="1"><summary><u>Sequential</u></summary>
|
||||
|
||||
Often this refers to Sequential injection, which means the injectors fire individually for each cylinder and often at a specific crank angle.
|
||||
This can be handy for engines direct injection or to try to spray the injector into the cyl while the intake valve is open. If an engine can inject onto an open inlet valve it will reduce the amount of fuel wetting the port walls and help reduce low load emissions.
|
||||
Sequential is required for direct injection engines like common rail diesel.
|
||||
</details>
|
||||
|
||||
<details><summary><u>SD</u></summary>
|
||||
<details markdown="1"><summary><u>SD</u></summary>
|
||||
|
||||
Speed Density this is a method of predicting how much fuel should be delivered to an engine. This is a MAP based system which uses pressure to make a prediction of how much O2 is entering the cyl.
|
||||
</details>
|
||||
|
||||
<details><summary><u>SI</u></summary>
|
||||
<details markdown="1"><summary><u>SI</u></summary>
|
||||
|
||||
Spark injection
|
||||
</details>
|
||||
|
||||
<details><summary><u>Smart Coil</u></summary>
|
||||
<details markdown="1"><summary><u>Smart Coil</u></summary>
|
||||
|
||||
A type of ignition coil that has its ignition drivers (IGBT) built into the coil, this means they only receive a 5v signal to activate.
|
||||
</details>
|
||||
|
||||
<details><summary><u>SMD</u></summary>
|
||||
<details markdown="1"><summary><u>SMD</u></summary>
|
||||
|
||||
Surface mount device, interchangeable with SMT
|
||||
</details>
|
||||
|
||||
<details><summary><u>SMT</u></summary>
|
||||
<details markdown="1"><summary><u>SMT</u></summary>
|
||||
|
||||
Surface mount technology, interchangeable with SMD
|
||||
</details>
|
||||
|
||||
<details><summary><u>SOI</u></summary>
|
||||
<details markdown="1"><summary><u>SOI</u></summary>
|
||||
|
||||
Start Of Injection - See also EOI
|
||||
</details>
|
||||
|
||||
<details><summary><u>Staged injection</u></summary>
|
||||
<details markdown="1"><summary><u>Staged injection</u></summary>
|
||||
|
||||
The use of 2 injectors for one cyl. This commonly means at low RPM and lower loads, one injector is turned on which allows for finer control over idle fuel delivery, while at higher RPM and higher Loads both injector inject fuel which allows for larger amounts of fuel to be delivered.
|
||||
</details>
|
||||
|
||||
<details><summary><u>Stoichiometric</u></summary>
|
||||
<details markdown="1"><summary><u>Stoichiometric</u></summary>
|
||||
|
||||
The ideal quantity of fuel to burn with a quantity of air for complete combustion. For gasoline this is 14.7:1, ethanol is 9:1 and methanol 6.47:1
|
||||
</details>
|
||||
|
||||
<details><summary><u>SOIC</u></summary>
|
||||
<details markdown="1"><summary><u>SOIC</u></summary>
|
||||
|
||||
small outline integrated circuit
|
||||
</details>
|
||||
|
||||
<details><summary><u>TDC</u></summary>
|
||||
<details markdown="1"><summary><u>TDC</u></summary>
|
||||
|
||||
Top Dead Center
|
||||
</details>
|
||||
|
||||
<details><summary><u>TPS</u></summary>
|
||||
<details markdown="1"><summary><u>TPS</u></summary>
|
||||
|
||||
Throttle Position Sensor
|
||||
</details>
|
||||
|
||||
<details><summary><u>TE</u></summary>
|
||||
<details markdown="1"><summary><u>TE</u></summary>
|
||||
|
||||
TE connectors, they produce the ampseal connectors on the proteus and a lot of OEM ECUs.
|
||||
</details>
|
||||
|
||||
<details><summary><u>TFI</u></summary>
|
||||
<details markdown="1"><summary><u>TFI</u></summary>
|
||||
|
||||
Thick Film Ignition - Ford distributor - Likely unsupported at this time.
|
||||
</details>
|
||||
|
||||
<details><summary><u>TFSI</u></summary>
|
||||
<details markdown="1"><summary><u>TFSI</u></summary>
|
||||
|
||||
Turbo Fuel Stratified Injection - A VW direct injection lean burn strategy
|
||||
</details>
|
||||
|
||||
<details><summary><u>TLE</u></summary>
|
||||
<details markdown="1"><summary><u>TLE</u></summary>
|
||||
|
||||
Short for TLE8888 the Infineon chip on the MRE
|
||||
</details>
|
||||
|
||||
<details><summary><u>TVIS</u></summary>
|
||||
<details markdown="1"><summary><u>TVIS</u></summary>
|
||||
|
||||
Toyota variable intake system, a variable inlet length system that switches on/off a set of longer intake manifold runners.
|
||||
</details>
|
||||
|
||||
<details><summary><u>Valvetronic</u></summary>
|
||||
<details markdown="1"><summary><u>Valvetronic</u></summary>
|
||||
|
||||
BMW variable valve lift system
|
||||
</details>
|
||||
|
||||
<details><summary><u>VANOS</u></summary>
|
||||
<details markdown="1"><summary><u>VANOS</u></summary>
|
||||
|
||||
BMW variable valve timing system
|
||||
</details>
|
||||
|
||||
<details><summary><u>VCC</u></summary>
|
||||
<details markdown="1"><summary><u>VCC</u></summary>
|
||||
|
||||
Common Collector Voltage; the positive supply voltage for an integrated circuit
|
||||
</details>
|
||||
|
||||
<details><summary><u>VDD</u></summary>
|
||||
<details markdown="1"><summary><u>VDD</u></summary>
|
||||
|
||||
the DC Power supply connected to Drain Terminal of any FET circuit.
|
||||
</details>
|
||||
|
||||
<details><summary><u>VE</u></summary>
|
||||
<details markdown="1"><summary><u>VE</u></summary>
|
||||
|
||||
Volumetric Efficiency, often expressed as a decimal value i.e. 0.8 (for 80%)
|
||||
</details>
|
||||
|
||||
<details><summary><u>VISA</u></summary>
|
||||
<details markdown="1"><summary><u>VISA</u></summary>
|
||||
|
||||
BMW variable inlet manifold length system
|
||||
</details>
|
||||
|
||||
<details><summary><u>VOL</u></summary>
|
||||
<details markdown="1"><summary><u>VOL</u></summary>
|
||||
|
||||
Short for engine volume
|
||||
</details>
|
||||
|
||||
<details><summary><u>VSS</u></summary>
|
||||
<details markdown="1"><summary><u>VSS</u></summary>
|
||||
|
||||
Vehicle speed sensor
|
||||
</details>
|
||||
|
||||
<details><summary><u>VVT</u></summary>
|
||||
<details markdown="1"><summary><u>VVT</u></summary>
|
||||
|
||||
Variable valve timing
|
||||
</details>
|
||||
|
||||
<details><summary><u>WOT</u></summary>
|
||||
<details markdown="1"><summary><u>WOT</u></summary>
|
||||
|
||||
Wide Open Throttle
|
||||
</details>
|
||||
|
|
|
|||
|
|
@ -76,7 +76,7 @@
|
|||
# Contributors
|
||||
|
||||
- [Documentation Strategy](Documentation-Strategy)
|
||||
- [Documentation Workflow](Documentation-Workflow)
|
||||
- [HOWTO Contribute to Documentation](HOWTO-contribute-to-documentation)
|
||||
- [Firmware Code Doxygen](https://rusefi.com/docs/html)
|
||||
- [Firmware Code Automated Test Coverage](https://rusefi.com/docs/unit_tests_coverage)
|
||||
- [HOWTO Contribute To Firmware](HOWTO-contribute-to-firmware)
|
||||
|
|
|
|||
|
|
@ -74,7 +74,7 @@ nav:
|
|||
- 'Creating a PnP PCB': HOWTO-Make-a-PnP-board
|
||||
- 'Contributors':
|
||||
- 'Documentation Strategy': Documentation-Strategy
|
||||
- 'Documentation Workflow': Documentation-Workflow
|
||||
- 'HOWTO Contribute to Documentation': HOWTO-contribute-to-documentation
|
||||
- 'Firmware Code Doxygen': "https://rusefi.com/docs/html"
|
||||
- 'Firmware Code Automated Test Coverage': "https://rusefi.com/docs/unit_tests_coverage"
|
||||
- 'HOWTO Contribute To Firmware': HOWTO-contribute-to-firmware
|
||||
|
|
|
|||
Loading…
Reference in New Issue