Update README

This commit is contained in:
Josh Stewart 2024-04-19 16:06:26 +10:00
parent 8244388fd8
commit a94f5020b4
2 changed files with 22 additions and 20 deletions

View File

@ -15,9 +15,11 @@ Ardustim is an engine simulator built on the Arduino platform. It produces simul
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
It is designed to run on an Arduino Nano, but will also work with Arduino Uno boards.
## Wiring
- **Arduino Uno**
- **Arduino Nano or Uno**
- pin `8` will provide the `crank` or primary wheel signal
- pin `9` will provide the `cam` or secondary wheel signal
- **Arduino Mega**
@ -34,7 +36,7 @@ The source code can be built in either PlatformIO or the Arduino IDE and does no
Simply open the `ardustim` sub-folder in PlatformIO or the Arduino IDE and it should compile up.
Intended hardware platform is the Arduino Nano or Diecimila.
Intended hardware platform is the Arduino Nano or Uno.
## Installing GUI from Source

View File

@ -93,15 +93,15 @@ function draw_crank_gear(toothPattern, depth, radius, width, line, halfspeed) {
end = newEnd - diff;
/*
* Values to use within a wheel definition.
* 0 means no tooth on any wheel definition
* 1 means crank tooth
* 2 means cam1 tooth
* 4 means cam2 tooth
*
* combinations of numbers mean all of the related teeth are present,
* eg 3 means crank and cam1, 5 means crank and cam2, 6 means cam1 and cam2, 7 means crank, cam1 and cam2
*/
* Values to use within a wheel definition.
* 0 means no tooth on any wheel definition
* 1 means crank tooth
* 2 means cam1 tooth
* 4 means cam2 tooth
*
* combinations of numbers mean all of the related teeth are present,
* eg 3 means crank and cam1, 5 means crank and cam2, 6 means cam1 and cam2, 7 means crank, cam1 and cam2
*/
if (toothPattern[i] == 1 || toothPattern[i] == 3 || toothPattern[i] == 5 || toothPattern[i] == 7)
{
c.arc(x, y, radius, start, end, false);
@ -150,15 +150,15 @@ function draw_cam_gear(toothPattern, depth, radius, width, line) {
end = newEnd - diff;
/*
* Values to use within a wheel definition.
* 0 means no tooth on any wheel definition
* 1 means crank tooth
* 2 means cam1 tooth
* 4 means cam2 tooth
*
* combinations of numbers mean all of the related teeth are present,
* eg 3 means crank and cam1, 5 means crank and cam2, 6 means cam1 and cam2, 7 means crank, cam1 and cam2
*/
* Values to use within a wheel definition.
* 0 means no tooth on any wheel definition
* 1 means crank tooth
* 2 means cam1 tooth
* 4 means cam2 tooth
*
* combinations of numbers mean all of the related teeth are present,
* eg 3 means crank and cam1, 5 means crank and cam2, 6 means cam1 and cam2, 7 means crank, cam1 and cam2
*/
if (toothPattern[i] == 2 || toothPattern[i] == 3 || toothPattern[i] == 6 || toothPattern[i] == 7)
{
c.arc(x, y, radius, start, end, false);