rusefi/README.md

# rusEFI
A GPL open-source DIY ECU

current binaries are always available at http://rusefi.com/build_server/

[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6YSSN35GWYS3A)


[![Tindie](http://rusefi.com/wiki/images/1/1c/Tindie-smalls.png)](https://www.tindie.com/stores/russian/)

## Cloning the repository

Important note - we now use submodules:

`git submodule update --init`

# What do we have here?
 * [Firmware](/firmware) Source code for open source engine control unit for stm32 chips
 * [Hardware](/hardware) KiCAD files for all our PCBs
 * [rusEfi console](/java_console) rusEfi own naive tuning software
 * [Simulator](/simulator) win32 or posix version of firmware allows to explore without any hardware 
 * [Unit Tests](/unit_tests) Unit tests of firmware pieces
 * [Misc tools](/java_tools) Misc development utilities
 * [misc/Jenkins](/misc/jenkins) Jenkins Continues Integration scripts
 * [Work in progress status](work_in_progress.md)

# External Links

 * Wiki: http://rusefi.com
 * Forum http://rusefi.com/forum
 * Documentation is now moving to https://github.com/rusefi/rusefi_documentation
 * Doxygen documentation is available at http://rusefi.com/docs/html
 * General source code Q&A is at http://rusefi.com/forum/viewtopic.php?f=5&t=10
 * Facebook https://www.facebook.com/rusEfiECU
 * YouTube: https://www.youtube.com/user/rusefi
 * Patreon https://www.patreon.com/rusefi

# Building the Code
See https://rusefi.com/forum/viewtopic.php?f=5&t=9


# Release Notes

| Release date  | Revision  | Details |
| ------------  | --------- | ------- |
| 07/28/2018    | r19612    | improvement #809: software jump to DFU |
| 04/25/2019    | r17317    | bugfix #775: electrical noise reboot during settings change causes with full tune loss |
| 04/07/2019    | r17098    | improvement #714: TLE8888 Enable Outputs SPI integration |
| 02/27/2019    | r16886    | bugfix #698: concurrency defect with single timer executor initialization |
| 02/23/2019    | r16857    | improvement #688: better support for 144 and 176 pin packages |
| 02/05/2019    | r16713    | improvement #631: ChibiOS 18 |
| 01/11/2019    | r16346    | bugfix #663: SPI fixes for CJ125 for stm32 errata STM32f405/7/15/17 |
| 12/09/2018    | r16057    | electronic throttle body control is now BETA version |
| 08/19/2018    | r15811    | bugfix #604: no interpolation outside of the table |
| 01/29/2018    | r15514    | improvement #215: CJ125 wideband contoller |
| 01/23/2018    | r15442    | improvement #463: ChibiOS 17 / 4 |
| 01/07/2018    | r14952    | usability & minor bugfix #532 idle defaults are broken |
| 12/17/2017    | r14892    | bugfix #513: console: erase on older chips does not work |
| 11/26/2017    | r14789    | bugfix #500: set_rpn_expression command is broken |
| 11/23/2017    | r14779    | bugfix #497: engine does not start with SD card |
| 11/19/2017    | r14766    | improvement #496: console flasher to support older boards |
| 11/19/2017    | r14760    | improvement #495: incomppatible change - larger settings area |
| 11/06/2017    | r14733    | improvement #487: single-point injection mode |
| 10/26/2017    | r14700    | improvement #385: narrow band to wide band conversion table |
| 08/31/2017    |           | improvement #442: ADC_VCC should be configurable |
| 07/24/2017    | r14513    | bugfix #307: TS bench test blinks three times |
| 07/13/2017    | r14476    | bugfix #461: SAXParserException on console start-up due to damaged settings.xml file |
| 07/09/2017    | r14473    | improvement: IAC solenoid frequencty changeable on the fly |
| 06/19/2017    | r14393    | bugfix: pinMode, milMode |
| 05/27/2017    | r14221    | improvement: ochGetCommand to support offset and count |
| 05/05/2017    | r13974    | bugfix #404: 36/1 FATAL error: angle range trgSync |
| 05/03/2017    | r13967    | improvement: ChibiOS 3.2 |
| 04/06/2017    | r13759    | major improvement #72: ChibiOS 3.1 |
| 03/26/2017    | r13330    | super annoying bug #336 fixed |
| 03/20/2017    | r13233    | improvements #375 & #376: hard FPU mode & migrating to fresh version of arm gcc |
| 03/19/2017    | r13223    | bugfix #374: persistent configuration starts to touch firmware - settings would need to be reloaded |
| 03/09/2017    | r13146    | bugfix #370: duty cycle vs error code 6050 |
| 03/06/2017    | r13123    | bugfix #363: 2/1 skipped wheel is a corner-case |
| 03/05/2017    | r13108    | bugfix #363: trigger front only processing |
| 02/22/2017    | r12980    | bugfix: false error message in case of single coil or simultaneous injection | 
| 02/22/2017    | r12973    | unused property 'custom Use Rise Edge' removed |
| 02/22/2017    | r12972    | protocol signature changed to 'v0.02' (this would happen from time to time to ensure version match between console and TS project | 
| 02/20/2017    | r12939    | https://github.com/rusefi/rusefi is now the official primary repository |
| 02/18/2017    | r11565    | improvement: level1 default brown out https://sourceforge.net/p/rusefi/tickets/354/ |
| 02/18/2017    | r11554    | bugfix: rusEfi console program/erase buttons fixed with ST-LINK 2.1 |
| 12/09/2016    | r10991    | bugfixes, bugfixes, bugfixes & releave 1.0
| 02/15/2016	| r9600     | automatic warm-up fuel correction, performance improvements
| 08/31/2015	| r8725     | acceleration fuel correction, console improvements
| 07/06/2015	| r8554     | more CAN, better console, bugfixes, performance
| 04/26/2015	| r7938	    | vehicle speed sensor, stepper idle valve, lots of improvements
| 11/13/2014	| r5327	    | ChibiOS/RT 2.6.6, better cold start logic, bugfixes, bugfixes, bugfixes...
| 06/12/2014	| r3477	    | Precise event scheduling, protocol selection 
| 03/26/2014	| r2413	    | C++, refactoring & improvements
| 02/23/2013	| r1777	    | trigger is now configurable via TunerStudio
| 01/30/2014	| r1309	    | true trigger angles, VBatt signal
| 01/12/2014	| r1007	    | refactoring, refactoring & refactoring
| 12/19/2013	| r605	    | ignition control & a little bit of CAN bus
| 11/08/2013	| r100	    | Tuner Studio fuel map tuning, fuel pump control
| 10/14/2013	| r39	    | USB serial bug, missing IAR files, self-containted Makefile
| 10/13/2013	| r33	    | IAR project file
| 10/04/2013	| r26	    | Patched ChibiOS/RT 2.6.1 sources are now included
| 09/23/2013	| r20	    | Tuner Studio integration, configuraton persistence
| 08/30/2013	| r14	    | initial documentation & refactoring. tunerstudio integration
| 08/03/2013	| r13	    | wideband O2 input, better idling algorithm, serial-over-USB
| 07/05/2013	| r10	    | Second CKP, sequential injection.
| 06/19/2013	| r9	    | Initial version - batch injection & ignition with advance table lookup.

## Cloning the repository

Important note - we now use submodules:

`git submodule update --init`
Improve README (#481) Some typo fixes, improve markdown formatting. 2017-10-25 06:48:41 -07:00			`# rusEFI`
			`A GPL open-source DIY ECU`

find_cygwin . -type f -print0 \| xargs -0 dos2unix done? 2017-03-24 15:57:10 -07:00			`current binaries are always available at http://rusefi.com/build_server/`

donate button to GH homepage 2017-05-05 13:40:12 -07:00			`[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=6YSSN35GWYS3A)`
same pre-merge: random docs 2017-03-30 16:55:26 -07:00
adding store link 2017-05-05 13:42:13 -07:00
			`[![Tindie](http://rusefi.com/wiki/images/1/1c/Tindie-smalls.png)](https://www.tindie.com/stores/russian/)`

docs 2018-12-14 15:37:05 -08:00			`## Cloning the repository`

			`Important note - we now use submodules:`

			`git submodule update --init`

docs 2018-12-14 15:46:44 -08:00			`# What do we have here?`
			`* [Firmware](/firmware) Source code for open source engine control unit for stm32 chips`
			`* [Hardware](/hardware) KiCAD files for all our PCBs`
docs 2018-12-14 16:08:32 -08:00			`* [rusEfi console](/java_console) rusEfi own naive tuning software`
			`* [Simulator](/simulator) win32 or posix version of firmware allows to explore without any hardware`
			`* [Unit Tests](/unit_tests) Unit tests of firmware pieces`
			`* [Misc tools](/java_tools) Misc development utilities`
better folder stucture & docs 2018-12-15 19:23:05 -08:00			`* [misc/Jenkins](/misc/jenkins) Jenkins Continues Integration scripts`
docs 2018-12-15 20:29:15 -08:00			`* [Work in progress status](work_in_progress.md)`
docs 2018-12-14 15:37:05 -08:00
			`# External Links`

			`* Wiki: http://rusefi.com`
			`* Forum http://rusefi.com/forum`
links 2019-04-26 19:07:45 -07:00			`* Documentation is now moving to https://github.com/rusefi/rusefi_documentation`
docs 2018-12-14 15:37:05 -08:00			`* Doxygen documentation is available at http://rusefi.com/docs/html`
			`* General source code Q&A is at http://rusefi.com/forum/viewtopic.php?f=5&t=10`
			`* Facebook https://www.facebook.com/rusEfiECU`
			`* YouTube: https://www.youtube.com/user/rusefi`
better folder structure 2018-12-15 21:19:15 -08:00			`* Patreon https://www.patreon.com/rusefi`
docs 2018-12-14 15:37:05 -08:00
			`# Building the Code`
			`See https://rusefi.com/forum/viewtopic.php?f=5&t=9`


			`# Release Notes`
find_cygwin . -type f -print0 \| xargs -0 dos2unix done? 2017-03-24 15:57:10 -07:00
			`\| Release date \| Revision \| Details \|`
			`\| ------------ \| --------- \| ------- \|`
software jump to DFU #809 2019-07-28 09:33:47 -07:00			`\| 07/28/2018 \| r19612 \| improvement #809: software jump to DFU \|`
electrical noise during tuning ETB causes full tune reset fix #775 2019-04-25 19:28:46 -07:00			`\| 04/25/2019 \| r17317 \| bugfix #775: electrical noise reboot during settings change causes with full tune loss \|`
release notes 2019-04-07 09:27:59 -07:00			`\| 04/07/2019 \| r17098 \| improvement #714: TLE8888 Enable Outputs SPI integration \|`
fix #698 2019-02-27 14:12:52 -08:00			`\| 02/27/2019 \| r16886 \| bugfix #698: concurrency defect with single timer executor initialization \|`
fix #688 2019-02-23 05:52:12 -08:00			`\| 02/23/2019 \| r16857 \| improvement #688: better support for 144 and 176 pin packages \|`
Migrate to Chibios 18 stable fix #631 2019-02-04 17:41:56 -08:00			`\| 02/05/2019 \| r16713 \| improvement #631: ChibiOS 18 \|`
#663 goes into release notes 2019-01-11 05:49:46 -08:00			`\| 01/11/2019 \| r16346 \| bugfix #663: SPI fixes for CJ125 for stm32 errata STM32f405/7/15/17 \|`
ETB is now BETA 2018-12-09 12:14:04 -08:00			`\| 12/09/2018 \| r16057 \| electronic throttle body control is now BETA version \|`
r15811 2018-08-19 08:57:38 -07:00			`\| 08/19/2018 \| r15811 \| bugfix #604: no interpolation outside of the table \|`
CAN debug field #26 2018-01-29 16:41:39 -08:00			`\| 01/29/2018 \| r15514 \| improvement #215: CJ125 wideband contoller \|`
close #463 2018-01-23 18:59:10 -08:00			`\| 01/23/2018 \| r15442 \| improvement #463: ChibiOS 17 / 4 \|`
fix #532 2018-01-07 09:11:49 -08:00			`\| 01/07/2018 \| r14952 \| usability & minor bugfix #532 idle defaults are broken \|`
fix #513 2017-12-17 11:33:51 -08:00			`\| 12/17/2017 \| r14892 \| bugfix #513: console: erase on older chips does not work \|`
fix #500 2017-11-26 16:35:08 -08:00			`\| 11/26/2017 \| r14789 \| bugfix #500: set_rpn_expression command is broken \|`
fix #497 2017-11-23 14:43:42 -08:00			`\| 11/23/2017 \| r14779 \| bugfix #497: engine does not start with SD card \|`
#496 2017-11-19 16:01:53 -08:00			`\| 11/19/2017 \| r14766 \| improvement #496: console flasher to support older boards \|`
			`\| 11/19/2017 \| r14760 \| improvement #495: incomppatible change - larger settings area \|`
#487 2017-11-06 20:00:57 -08:00			`\| 11/06/2017 \| r14733 \| improvement #487: single-point injection mode \|`
fix #385 2017-11-08 10:34:53 -08:00			`\| 10/26/2017 \| r14700 \| improvement #385: narrow band to wide band conversion table \|`
history 2017-11-20 07:19:21 -08:00			`\| 08/31/2017 \| \| improvement #442: ADC_VCC should be configurable \|`
poke 2017-07-24 20:21:34 -07:00			`\| 07/24/2017 \| r14513 \| bugfix #307: TS bench test blinks three times \|`
			`\| 07/13/2017 \| r14476 \| bugfix #461: SAXParserException on console start-up due to damaged settings.xml file \|`
improvement: IAC solenoid frequencty changeable on the fly 2017-07-10 19:24:03 -07:00			`\| 07/09/2017 \| r14473 \| improvement: IAC solenoid frequencty changeable on the fly \|`
changelog 2017-06-18 22:58:29 -07:00			`\| 06/19/2017 \| r14393 \| bugfix: pinMode, milMode \|`
#429 2017-05-27 06:02:48 -07:00			`\| 05/27/2017 \| r14221 \| improvement: ochGetCommand to support offset and count \|`
readme 2017-05-05 13:00:40 -07:00			`\| 05/05/2017 \| r13974 \| bugfix #404: 36/1 FATAL error: angle range trgSync \|`
better state validation 2017-05-03 15:08:04 -07:00			`\| 05/03/2017 \| r13967 \| improvement: ChibiOS 3.2 \|`
release notes 2017-04-06 18:02:50 -07:00			`\| 04/06/2017 \| r13759 \| major improvement #72: ChibiOS 3.1 \|`
#336 2017-03-26 20:28:45 -07:00			`\| 03/26/2017 \| r13330 \| super annoying bug #336 fixed \|`
find_cygwin . -type f -print0 \| xargs -0 dos2unix done? 2017-03-24 15:57:10 -07:00			`\| 03/20/2017 \| r13233 \| improvements #375 & #376: hard FPU mode & migrating to fresh version of arm gcc \|`
			`\| 03/19/2017 \| r13223 \| bugfix #374: persistent configuration starts to touch firmware - settings would need to be reloaded \|`
			`\| 03/09/2017 \| r13146 \| bugfix #370: duty cycle vs error code 6050 \|`
			`\| 03/06/2017 \| r13123 \| bugfix #363: 2/1 skipped wheel is a corner-case \|`
			`\| 03/05/2017 \| r13108 \| bugfix #363: trigger front only processing \|`
			`\| 02/22/2017 \| r12980 \| bugfix: false error message in case of single coil or simultaneous injection \|`
			`\| 02/22/2017 \| r12973 \| unused property 'custom Use Rise Edge' removed \|`
			`\| 02/22/2017 \| r12972 \| protocol signature changed to 'v0.02' (this would happen from time to time to ensure version match between console and TS project \|`
			`\| 02/20/2017 \| r12939 \| https://github.com/rusefi/rusefi is now the official primary repository \|`
			`\| 02/18/2017 \| r11565 \| improvement: level1 default brown out https://sourceforge.net/p/rusefi/tickets/354/ \|`
			`\| 02/18/2017 \| r11554 \| bugfix: rusEfi console program/erase buttons fixed with ST-LINK 2.1 \|`
			`\| 12/09/2016 \| r10991 \| bugfixes, bugfixes, bugfixes & releave 1.0`
			`\| 02/15/2016 \| r9600 \| automatic warm-up fuel correction, performance improvements`
			`\| 08/31/2015 \| r8725 \| acceleration fuel correction, console improvements`
			`\| 07/06/2015 \| r8554 \| more CAN, better console, bugfixes, performance`
			`\| 04/26/2015 \| r7938 \| vehicle speed sensor, stepper idle valve, lots of improvements`
			`\| 11/13/2014 \| r5327 \| ChibiOS/RT 2.6.6, better cold start logic, bugfixes, bugfixes, bugfixes...`
			`\| 06/12/2014 \| r3477 \| Precise event scheduling, protocol selection`
			`\| 03/26/2014 \| r2413 \| C++, refactoring & improvements`
			`\| 02/23/2013 \| r1777 \| trigger is now configurable via TunerStudio`
			`\| 01/30/2014 \| r1309 \| true trigger angles, VBatt signal`
			`\| 01/12/2014 \| r1007 \| refactoring, refactoring & refactoring`
			`\| 12/19/2013 \| r605 \| ignition control & a little bit of CAN bus`
			`\| 11/08/2013 \| r100 \| Tuner Studio fuel map tuning, fuel pump control`
			`\| 10/14/2013 \| r39 \| USB serial bug, missing IAR files, self-containted Makefile`
			`\| 10/13/2013 \| r33 \| IAR project file`
			`\| 10/04/2013 \| r26 \| Patched ChibiOS/RT 2.6.1 sources are now included`
			`\| 09/23/2013 \| r20 \| Tuner Studio integration, configuraton persistence`
			`\| 08/30/2013 \| r14 \| initial documentation & refactoring. tunerstudio integration`
			`\| 08/03/2013 \| r13 \| wideband O2 input, better idling algorithm, serial-over-USB`
			`\| 07/05/2013 \| r10 \| Second CKP, sequential injection.`
			`\| 06/19/2013 \| r9 \| Initial version - batch injection & ignition with advance table lookup.`
same pre-merge: random docs 2017-03-30 16:55:26 -07:00
Improve README (#481) Some typo fixes, improve markdown formatting. 2017-10-25 06:48:41 -07:00			`## Cloning the repository`
same pre-merge: random docs 2017-03-30 16:55:26 -07:00
docs 2019-01-18 18:53:21 -08:00			`Important note - we now use submodules:`
same pre-merge: random docs 2017-03-30 16:55:26 -07:00
Improve README (#481) Some typo fixes, improve markdown formatting. 2017-10-25 06:48:41 -07:00			`git submodule update --init`