diff --git a/README.md b/README.md index 04a1933..9e59876 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,9 @@ ## Ardustim -Ardustim is an engine simulator built on the Arduino platform. It produces simulated crank and cam signals that can be used for testing aftermarket ECUs as well as being a useful tool for the development of firmware for these +Ardustim is an engine simulator built on the Arduino platform. It produces simulated crank and cam signals that can be used for testing aftermarket ECUs as well as being a useful tool for the development of firmware for these. It supports a large number of simulated rtigger patterns as well as multiple options for output speed (Eg Using an external pot, a fixed value or a sweep range) + +
Ardu-Stim Demo
This version is a fork of the original by David Andruczyk [https://gitlab.com/libreems-suite/ardu-stim](https://gitlab.com/libreems-suite/ardu-stim) and is intended to provide a more modern, cross platform GUI as well as continued expansion of the trigger pattern library. It was primarily developed for use by the Speeduino community, but can be utilised for testing virtually any aftermarket ECU system @@ -22,17 +24,34 @@ It is designed to run on an Arduino Nano, but will also work with Arduino Uno bo - **Arduino Nano or Uno** - pin `8` will provide the `crank` or primary wheel signal - pin `9` will provide the `cam` or secondary wheel signal + - Pin `10` will provide a `2nd cam` or tertiary wheel signal. This is for simulating some dual cam patterns - **Arduino Mega** - pin `53` will provide the `crank` or primary wheel signal - pin `52` will provide the `cam` or secondary wheel signal + - Pin `51` will provide a `2nd cam` or tertiary wheel signal. This is for simulating some dual cam patterns + +Example for `Arduino Nano` connected to `Speeduino v0.4 Series` board: + +![ArduStim wiring](docs/nano-v04-wiring.png) + +### RPM Potentiometer + +An optional potentiometer can be added to control the RPM value (With the relevant RPM mode selected). This should be connect to pin A0 if in use. + +## Installing and Using + +Ardu-Stim is distributed as a ready-to-run binary for Windows, Mac (Intel and Arm) and linux (AppImage) so no installation is required. Simply down the latest release (https://github.com/speeduino/Ardu-Stim/releases/latest) and + +### First time Connection +The first time you connect Ardu-Stim to an Arduino Nano board, you need to upload the included firmware to it. Plug the Nano into your PC and then select the port from the list. Press the upload firmware button and wait for this to complete -Example for `Arduino Uno` connected to `Speeduino v0.4 Series` board with `Arduino Mega`: +![Upload Firmware](docs/upload-firmware.png) -![ArduStim wiring](docs/uno-v04-wiring.png) +**Note:** This only needs to be performed with a new Arduino Nano or if upgrading from an earlier version -## Build +## Firmware Build -The source code can be built in either PlatformIO or the Arduino IDE and does not have any dependencies on 3rd party libraries that were used in the original version of Ardustim (Eg SerialUI) +The firmwaresource code can be built in either PlatformIO or the Arduino IDE and does not have any dependencies on 3rd party libraries that were used in the original version of Ardustim (Eg SerialUI) Simply open the `ardustim` sub-folder in PlatformIO or the Arduino IDE and it should compile up. diff --git a/docs/demo.gif b/docs/demo.gif new file mode 100644 index 0000000..19ba87e Binary files /dev/null and b/docs/demo.gif differ diff --git a/docs/nano-v0.4-wiring.png b/docs/nano-v0.4-wiring.png new file mode 100644 index 0000000..5c8cc2a Binary files /dev/null and b/docs/nano-v0.4-wiring.png differ diff --git a/docs/upload-firmware.png b/docs/upload-firmware.png new file mode 100644 index 0000000..c391776 Binary files /dev/null and b/docs/upload-firmware.png differ