Skip to content

Commit 333a4f6

Browse files
authored
Merge pull request #4 from NicholasNelsonwood/nnelsonwood_units
Added units to mointoring
2 parents 24d3adb + 3cfdeb7 commit 333a4f6

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/simplefoc_library/code/monitoring.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,13 +68,13 @@ motor.monitor()
6868
```
6969

7070
Monitoring function can output 7 different motor specific variables:
71-
- `target` - current target value, specific to the motion control used (either current, voltage, velocity or position)
72-
- `voltage.q` - set voltage in q direction
73-
- `voltage.d` - set voltage in d direction
74-
- `current.q` - measured current in q direction ( if current sense available )
75-
- `current.d` - measured current in d direction ( if current sense available )
76-
- `shaft_velocity` - motor velocity
77-
- `shaft_angle` - motor position
71+
- `target` - current target value, specific to the motion control used (either current [A], voltage [V], velocity [rad/s], or position [rad])
72+
- `voltage.q` - [V] - set voltage in q direction
73+
- `voltage.d` - [V] - set voltage in d direction
74+
- `current.q` - [mA] - measured current in q direction ( if current sense available )
75+
- `current.d` - [mA] - measured current in d direction ( if current sense available )
76+
- `shaft_velocity` - [rad/s] - motor velocity
77+
- `shaft_angle` - [rad] - motor position
7878

7979
To set the preferred values to be monitored you can just change the `motor.monitoring_variables` parameter in the `setup()` function.:
8080
```cpp
@@ -158,7 +158,7 @@ voltage,target,velocity
158158
<blockquote class="warning"><p class="heading"> Execution time impairment</p>
159159
The intention of this method is to be called in main loop function along the <code class="highlighter-rouge">loopFOC()</code> and <code class="highlighter-rouge">move()</code> function. Therefore, <code class="highlighter-rouge">motor.monitor()</code> is going to impact the execution performance and reduce the sampling frequency of the FOC algorithm so therefore take it in consideration when running the code. </blockquote>
160160

161-
## Custom serial terminal monitoring
161+
## Custom serial terminal monitoring
162162

163163
If you wish to implement you own monitoring functions or just output the motor variables to the `Serial` terminal here are the public variables of the `BLDCMotor` and `StepperMotor` class that you can access at any time.
164164
```cpp

0 commit comments

Comments
 (0)