mike/stir
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 26 Wiki Activity

updated readme

Browse Source
This commit is contained in:
Michael Wesemann 2019-03-11 09:16:11 +01:00
parent 5ad12e208f
commit 868f3eb34d
1 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -36,20 +36,20 @@ All functions are controlled by the KY-040 encoder:
|Value|Description| |Value|Description|
|:----|:----------| |:----|:----------|
|SPEEDINC|increment of speed values when turning the encoder| |`SPEEDINC`|increment of speed values when turning the encoder|
|FANMIN|fan minimum speed (should be a value at which the fan runs safely) (rpm)| |`FANMIN`|fan minimum speed (should be a value at which the fan runs safely) (rpm)|
|FANMAX|maximum speed of the fan (it is important that this is the real maximum value of the fan) (rpm)| |`FANMAX`|maximum speed of the fan (it is important that this is the real maximum value of the fan) (rpm)|
|CATCHSTOP|stop interval for stir fish catch function (ms)| |`CATCHSTOP`|stop interval for stir fish catch function (ms)|
|PWM0, PWN1|PWM output pins| |`PWM0`, `PWN1`|PWM output pins|
|I0, I1|interrupts for rpm measurement (2 and 3 for Leonardo and ProMicro / 0 and 1 for Uno)| |`I0`, `I1`|interrupts for rpm measurement (2 and 3 for Leonardo and ProMicro / 0 and 1 for Uno)|
|CLK, DT, SW|pins for KY-040 encoder| |`CLK`, `DT`, `SW`|pins for KY-040 encoder|
|RINTERVAL|regulation interval (ms)| |`RINTERVAL`|regulation interval (ms)|
|RDELAY|extra regulation delay when value changes (ms)| |`RDELAY`|extra regulation delay when value changes (ms)|
|RTOL|regulation tolerance (rpm)| |`RTOL`|regulation tolerance (rpm)|
|SINTERVAL|speed measurement interval (ms)| |`SINTERVAL`|speed measurement interval (ms)|
|SAVERAGE|speed measurement average| |`SAVERAGE`|speed measurement average|
|SAVETAG|parameter save identifier| |`SAVETAG`|parameter save identifier|
|SAVEDELAY|delay in seconds before parameter will be saved to EEPROM| |`SAVEDELAY`|delay in seconds before parameter will be saved to EEPROM|
## API commands ## API commands
@ -63,13 +63,13 @@ Command are colon separated an can be send via USB/Serial
|`off:<0/1>`|switch stirren off| |`off:<0/1>`|switch stirren off|
|`bon:<0/1>`|switch boost mode on| |`bon:<0/1>`|switch boost mode on|
|`boff:<0/1>`|switch boost mode off| |`boff:<0/1>`|switch boost mode off|
|`speed:<0/1>:<speed>`|set stirrer speed| |`speed:<0/1>:<rpm>`|set stirrer speed|
|`bspeed:<0/1>:<speed>`|set stirrer boost speed| |`bspeed:<0/1>:<rpm>`|set stirrer boost speed|
|`btime:<0/1>:<time>`|set boost time| |`btime:<0/1>:<min>`|set boost time|
|`con:<0/1>`|switch catch mode on| |`con:<0/1>`|switch catch mode on|
|`coff:<0/1>`|switch catch mode off| |`coff:<0/1>`|switch catch mode off|
|`ctime:<0/1>:<time>`|set catch mode interval| |`ctime:<0/1>:<min>`|set catch mode interval|
|`rtime:<0/1>:<time>`|set speed rise time| |`rtime:<0/1>:<min>`|set speed rise time|
All commands return a colon separated string with all current parameters: All commands return a colon separated string with all current parameters: