diff --git a/Debug-Serial.md b/Debug-Serial.md index f70ba3f..1694862 100644 --- a/Debug-Serial.md +++ b/Debug-Serial.md @@ -31,39 +31,51 @@ DEBUG_SERIAL_ASCII output is: ## Debug Protocol: If enabled with parameter DEBUG_SERIAL_PROTOCOL in config.h, debug protocol lets you send Ascii commands to set or get data. +Values are being translated to external<>internal format automatically. |Command|Usage|Description| |---|---|---| |HELP|HELP
HELP PPPP|Prints all commands/parameters/variables available for the protocol
If parameter/variable PPPP is provided, it will print individual help text| -|GET|GET
GET PPPP|Prints current value, initial value, minimum and maximum for all parameter/variable
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| -|INIT|INIT PPPP|Sets Parameter PPPP to its initial value| -|SAVE|SAVE|Saves all Parameters that can be saved to EEPROM| -|WATCH|WATCH PPPP|Enables/disables output for parameter/variable| +|GET|GET
GET PPPP|Prints current value, initial value, minimum and maximum for all parameters/variables
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| +|INIT|INIT PPPP|Sets parameter PPPP to its initial value| +|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|
-All commands can be used for parameters. -Variables cannot be Set|Initialized|Saved. +All commands can be used for parameters.
+Variables cannot be Set,Initialized or Saved.
-|Type|Name|Description|Can be saved to EEPROM| -|----|----|----|----| -|Parameter|CTRL_MOD|Ctrl mode 1:Voltage 2:Speed 3:Torque|No| -|Parameter|CTRL_TYP|Ctrl type 0:Commutation 1:Sinusoidal 2:FOC|No| -|Parameter|I_MOT_MAX|Max phase current A|Yes| -|Parameter|N_MOT_MAX|Max motor RPM|Yes| -|Parameter|FI_WEAK_ENA|Enable field weak 0:OFF 1:ON|No| -|Parameter|FI_WEAK_HI|Field weak high RPM|No| -|Parameter|FI_WEAK_LO|Field weak low RPM|No| -|Parameter|FI_WEAK_MAX|Field weak max current A(FOC only)|No| -|Parameter|PHA_ADV_MAX|Max Phase Adv angle Deg(SIN only)|No| -|Variable|IN1_RAW|Input2 raw value|No| -|Parameter|IN1_RAW|Input2 type 0:Disabled, 1:Normal Pot, 2:Middle Resting Pot, 3:Auto-detect|Yes| - - - - - - +|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_TYP|Ctrl type 0:Commutation 1:Sinusoidal 2:FOC|Yes|No| +|Parameter|I_MOT_MAX|Max phase current A|Yes|Yes| +|Parameter|N_MOT_MAX|Max motor RPM|Yes|Yes| +|Parameter|FI_WEAK_ENA|Enable field weak 0:OFF 1:ON|Yes|No| +|Parameter|FI_WEAK_HI|Field weak high RPM|Yes|No| +|Parameter|FI_WEAK_LO|Field weak low RPM|Yes|No| +|Parameter|FI_WEAK_MAX|Field weak max current A(FOC only)|Yes|No| +|Parameter|PHA_ADV_MAX|Max Phase Adv angle Deg(SIN only)|Yes|No| +|Variable|IN1_RAW|Input1 raw value|No|No| +|Parameter|IN1_TYP|Input1 type 0:Disabled, 1:Normal Pot, 2:Middle Resting Pot, 3:Auto-detect|Yes|Yes| +|Parameter|IN1_MIN|Input1 minimum value|Yes|Yes| +|Parameter|IN1_MID|Input1 middle value|Yes|Yes| +|Parameter|IN1_MAX|Input1 maximum value|Yes|Yes| +|Variable|IN1_CMD|Input1 command value|No|No| +|Variable|IN2_RAW|Input2 raw value|No|No| +|Parameter|IN2_TYP|Input2 type 0:Disabled, 1:Normal Pot, 2:Middle Resting Pot, 3:Auto-detect|Yes|Yes| +|Parameter|IN2_MIN|Input2 minimum value|Yes|Yes| +|Parameter|IN2_MID|Input2 middle value|Yes|Yes| +|Parameter|IN2_MAX|Input2 maximum value|Yes|Yes| +|Variable|IN2_CMD|Input2 command value|No|No| +|Variable|I_DC_LINK|DC Link current A *100|No|No| +|Variable|SPD_AVG|Motor Measured Avg RPM|No|No| +|Variable|SPDL|Left Motor Measured RPM|No|No| +|Variable|SPDR|Right Motor Measured RPM|No|No| +|Variable|RATE|Rate *10|No|No| +|Variable|SPD_COEF|Speed Coefficient *10|No|No| +|Variable|STR_COEF|Steer Coefficient *10|No|No|