EFeru/hoverboard-firmware-hack-FOC
1
0
Fork 1
mirror of https://github.com/EFeru/hoverboard-firmware-hack-FOC.git synced 2025-08-05 02:24:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated Debug Serial (markdown)

Candas1
2021-01-30 00:15:35 +01:00
parent 4dac3cd3a3
commit 9c8025aca8
1 changed files with 6 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Debug-Serial.md

@@ -30,23 +30,23 @@ DEBUG_SERIAL_ASCII output is:
## Debug Protocol: ## Debug Protocol:
If enabled with parameter DEBUG_SERIAL_PROTOCOL in config.h, debug protocol lets you send Ascii commands to set or get data. If enabled with parameter DEBUG_SERIAL_PROTOCOL in config.h, debug protocol lets you send Ascii commands.<br>
All commands can be used for parameters.<br>
Variables cannot be Set,Initialized or Saved.<br>
Values are being translated to external<>internal format automatically. Values are being translated to external<>internal format automatically.
### Commands
|Command|Usage|Description| |Command|Usage|Description|
|---|---|---| |---|---|---|
|HELP|HELP<BR>HELP PPPP|Prints all commands/parameters/variables available for the protocol<br>If parameter/variable PPPP is provided, it will print individual help text| |HELP|HELP<BR>HELP PPPP|Prints all commands/parameters/variables available for the protocol<br>If parameter/variable PPPP is provided, it will print individual help text|
|GET|GET<br>GET PPPP|Prints current value, initial value, minimum and maximum for all parameters/variables<br>If parameter/variable PPPP is provided, it will print current value, initial value, minimum and maximum for parameter/variable| |GET|GET<br>GET PPPP|Prints current value, initial value, minimum and maximum for all parameters/variables<br>If parameter/variable PPPP is provided, it will print current value, initial value, minimum and maximum for parameter/variable|
|SET|SET PPPP VVVV|Sets parameter PPPP with Value VVVV if it's in the correct range| |SET|SET PPPP VVVV|Sets parameter PPPP with Value VVVV if it's in the correct range|
|INIT|INIT PPPP|Sets parameter PPPP to its initial value| |INIT|INIT PPPP|Initializes parameter PPPP to EEPROM value if available, config.h value otherwise|
|SAVE|SAVE|Saves all parameters that can be saved to EEPROM| |SAVE|SAVE|Saves all parameters that can be saved to EEPROM|
|WATCH|WATCH PPPP|Enables/disables output for parameter/variable. It will display 15 values at most| |WATCH|WATCH PPPP|Enables/disables output for parameter/variable. It will display 15 values at most|
<br>
All commands can be used for parameters.<br>
Variables cannot be Set,Initialized or Saved.
<br>
### Parameters/Variables
|Type|Name|Description|Can be Set|Can be saved to EEPROM| |Type|Name|Description|Can be Set|Can be saved to EEPROM|
|----|----|----|----|----| |----|----|----|----|----|
|Parameter|CTRL_MOD|Ctrl mode 1:Voltage 2:Speed 3:Torque|Yes|No| |Parameter|CTRL_MOD|Ctrl mode 1:Voltage 2:Speed 3:Torque|Yes|No|