Skip to content

Commit 3aaaeaf

Browse files
author
Chas Leichner
committed
Correct spelling, broken links, and missing parameters in documentation
1 parent 31a3131 commit 3aaaeaf

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

CONTRIBUTING

+3-3
Original file line numberDiff line numberDiff line change
@@ -85,16 +85,16 @@ When making updates it is easy to break things for different configurations. In
8585

8686
=== Other guidelines ===
8787

88-
* Use single precition floating point operations, as the FPU in the STM32F4 is 32 bits only. Double precision operations can take up to 50 times (!) longer.
89-
- float instead if double
88+
* Use single precision floating point operations, as the FPU in the STM32F4 is 32 bits only. Double precision operations can take up to 50 times (!) longer.
89+
- float instead of double
9090
- Use the math library functions ending with f (sinf, cosf, powf, fabsf etc.)
9191

9292
* Make sure that the code compiles without warnings.
9393

9494
* Avoid dynamic memory allocation if possible, so that the RAM usage is known at compile time.
9595

9696
* If the code crashed randomly, use the ChibiOS state checker:
97-
http://www.chibios.org/dokuwiki/doku.php?id=chibios:articles:state_checker
97+
https://www.chibios.org/dokuwiki/doku.php?id=chibios:documentation:books:rt:kernel_debug#system_state_checks
9898

9999

100100
=== Be patient, and don't take criticism personally ===

mcpwm_foc.c

+9-1
Original file line numberDiff line numberDiff line change
@@ -1399,6 +1399,10 @@ void mcpwm_foc_get_current_offsets(
13991399
* @param current
14001400
* The locking open loop current for the motor.
14011401
*
1402+
* @param print
1403+
* Controls logging during the detection procedure. Set to true to enable
1404+
* logging.
1405+
*
14021406
* @param offset
14031407
* The detected offset.
14041408
*
@@ -1407,6 +1411,10 @@ void mcpwm_foc_get_current_offsets(
14071411
*
14081412
* @param direction
14091413
* The detected direction.
1414+
*
1415+
* @param inverted
1416+
* Is set to true if the encoder reports an increase in angle in the opposite
1417+
* direction of the motor.
14101418
*/
14111419
void mcpwm_foc_encoder_detect(float current, bool print, float *offset, float *ratio, bool *inverted) {
14121420
mc_interface_lock();
@@ -1629,7 +1637,7 @@ void mcpwm_foc_encoder_detect(float current, bool print, float *offset, float *r
16291637
}
16301638

16311639
/**
1632-
* Lock the motor with a current and sample the voiltage and current to
1640+
* Lock the motor with a current and sample the voltage and current to
16331641
* calculate the motor resistance.
16341642
*
16351643
* @param current

0 commit comments

Comments
 (0)