Differences

This shows you the differences between two versions of the page.

--- the_quimdc_command_line_interface [2018/05/22 10:33] – external edit 127.0.0.1
+++ the_quimdc_command_line_interface [2019/07/16 14:21] – ddecoeyer
@@ Line 23: / Line 23: @@
 Display the list of all available commands except debug commands with their syntax.
 <code>
 >help
-- ref_speed [<motor>] [<value>]
+- motor_reset_position <int>
-- ref_position [<motor>] [<value>]
+- srst
-- ref_current [<motor>] [<value>]
+- rword <int>
+- loop_mesurement [<motor>] [<int value>]
+- ref_pwm [<motor>] [<int value>]
+- ref_speed [<motor>] [<int value>]
+- ref_position [<motor>] [<int value>]
+- ref_current [<motor>] [<int value>]
 - encoder_motor [<motor>]
 - current_motor [<motor>]
 - speed_motor [<motor>]
-- motor_watchdog_value [<value>]
+- pwm_motor [<motor>]
-- speed_pid_p [<motor>] [<value>]
+- motor_watchdog_value [<int value>]
-- speed_pid_i [<motor>] [<value>]
+- speed_pid_p [<motor>] [<int value>]
-- speed_pid_d [<motor>] [<value>]
+- speed_pid_i [<motor>] [<int value>]
-- speed_pid_do [<motor>] [<value>]
+- speed_pid_d [<motor>] [<int value>]
-- speed_pid_fixed_point_divider [<motor>] [<value>]
+- speed_pid_do [<motor>] [<int value>]
-- speed_pid_uIAntiWU_Limit [<motor>] [<value>]
+- speed_pid_fixed_point_divider [<motor>] [<int value>]
-- current_pid_p [<motor>] [<value>]
+- speed_pid_uIAntiWU_Limit [<motor>] [<int value>]
-- current_pid_i [<motor>] [<value>]
+- current_pid_p [<motor>] [<int value>]
-- current_pid_d [<motor>] [<value>]
+- current_pid_i [<motor>] [<int value>]
-- current_pid_do [<motor>] [<value>]
+- current_pid_d [<motor>] [<int value>]
-- current_pid_fixed_point_divider [<motor>] [<value>]
+- current_pid_do [<motor>] [<int value>]
-- current_pid_uIAntiWU_Limit [<motor>] [<value>]
+- current_pid_fixed_point_divider [<motor>] [<int value>]
-- position_pid_p [<motor>] [<value>]
+- current_pid_uIAntiWU_Limit [<motor>] [<int value>]
-- position_pid_i [<motor>] [<value>]
+- position_pid_p [<motor>] [<int value>]
-- position_pid_d [<motor>] [<value>]
+- position_pid_i [<motor>] [<int value>]
-- position_pid_do [<motor>] [<value>]
+- position_pid_d [<motor>] [<int value>]
-- position_pid_fixed_point_divider [<motor>] [<value>]
+- position_pid_do [<motor>] [<int value>]
-- position_pid_uIAntiWU_Limit [<motor>] [<value>]
+- position_pid_fixed_point_divider [<motor>] [<int value>]
-- loop_function [<motor>] [<value>]
+- position_pid_uIAntiWU_Limit [<motor>] [<int value>]
-- ticks_per_turn_motor [<motor>] [<value>]
+- pwmDutyMax [<motor>] [<int value>]
-- resistance_motor [<motor>] [<value>]
+- bemf_compensation [<motor>] [<int value>]
-- kv_motor [<motor>] [<value>]
+- loop_function [<motor>] [<int value>]
-- nominal_power_voltage [<motor>] [<value>]
+- ticks_per_turn_motor [<motor>] [<int value>]
-- save_parameter_to_flash
+- resistance_motor [<motor>] [<float value>]
-- polarity [<motor>] [<value>]
+- kv_motor [<motor>] [<float value>]
-- position_speed_period [<motor>] [<value>]
+- nominal_power_voltage [<motor>] [<float value>]
+- polarity [<motor>] [<int value>]
+- position_speed_period [<motor>] [<int value>]
 - print_board_states
 - enterOperationalMode
 - leaveOperationalMode
+- startAutoPublish [<motor>] [<int value>]
+- stopAutoPublish [<motor>]
+- save_parameters_to_flash
+- load_parameters_from_flash
+- erase_flash
 - help
 </code>
@@ Line 65: / Line 77: @@
 ----
 ==== Board States ====
@@ Line 100: / Line 111: @@
 ==== Save parameters ====
-You can save the parameters using save_parameter_to_flash.
+You can save the parameters using save_parameters_to_flash.
 <code>
->save_parameter_to_flash
+>save_parameters_to_flash
 >D:001-000000 Parameters saved
@@ Line 124: / Line 135: @@
 ----
+==== Data Publication ====
+Some information like average speed, PWM duty cycle, voltage, and current can be published periodically to the serial bus. To enable this auto-publishing mode for a specific motor, use :
+<code>
+>startAutoPublish [<motor>] [<int frequency>]
+</code>
+To disable auto-publishing mode, use :
+<code>
+>stopAutoPublish [<motor>]
+</code>
+----
 ==== Motor Parameters ====
 === Getter and Setter ===