diff --git a/README.md b/README.md index 65eda5a..9ebcaab 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,53 @@ All functions are controlled by the KY-040 encoder: |SAVETAG|parameter save identifier| |SAVEDELAY|delay in seconds before parameter will be saved to EEPROM| +## API commands + +Command are colon separated an can be send via USB/Serial + +|Command|Description| +|:------|:----------| +|info|returns a colon separated string with all parameters (see below)| +|version|returns the software version| +|on:<0/1>|switch stirren on| +|off:<0/1>|switch stirren off| +|bon:<0/1>|switch boost mode on| +|boff:<0/1>|switch boost mode off| +|speed:<0/1>:|set stirrer speed| +|bspeed:<0/1>:|set stirrer boost speed| +|btime:<0/1>: