User Tools

Site Tools


the_quimdc_command_line_interface

Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
the_quimdc_command_line_interface [2018/05/22 10:33] – external edit 127.0.0.1the_quimdc_command_line_interface [2022/06/24 11:50] (current) – [Data Publication] cbernier
Line 23: Line 23:
 Display the list of all available commands except debug commands with their syntax. Display the list of all available commands except debug commands with their syntax.
 <code> <code>
->help  +> help 
-- ref_speed [<motor>] [<value>] +    - motor_reset_position <int> 
-- ref_position [<motor>] [<value>] +    - help 
-- ref_current [<motor>] [<value>] +    - srst 
-- encoder_motor [<motor>+    - rword <int> 
-- current_motor [<motor>+    - set_echo <int> 
-- speed_motor [<motor>+    - loop_mesurement [<motor>] [<int>
-- motor_watchdog_value [<value>] +    - ref_pwm [<motor>] [<int>] [<int>
-- speed_pid_p [<motor>] [<value>] +    - ref_speed [<motor>] [<int>] [<int>] 
-- speed_pid_i [<motor>] [<value>] +    - ref_position [<motor>] [<int>] [<int>                                                       
-- speed_pid_d [<motor>] [<value>] +    - ref_current [<motor>] [<int>] [<int>]                                                         
-- speed_pid_do [<motor>] [<value>] +    - encoder_motor [<motor>                                                                      
-- speed_pid_fixed_point_divider [<motor>] [<value>] +    - current_motor [<motor>                                                                      
-- speed_pid_uIAntiWU_Limit [<motor>] [<value>] +    - speed_motor [<motor>                                                                        
-- current_pid_p [<motor>] [<value>] +    - pwm_motor [<motor>                                                                          
-- current_pid_i [<motor>] [<value>] +    - motor_watchdog_value [<int>]                                                                  
-- current_pid_d [<motor>] [<value>] +    - speed_pid_p [<motor>] [<int>]                                                                 
-- current_pid_do [<motor>] [<value>] +    - speed_pid_i [<motor>] [<int>]                                                                 
-- current_pid_fixed_point_divider [<motor>] [<value>] +    - speed_pid_d [<motor>] [<int>]                                                                 
-- current_pid_uIAntiWU_Limit [<motor>] [<value>] +    - speed_pid_do [<motor>] [<int>]                                                                
-- position_pid_p [<motor>] [<value>] +    - speed_pid_fixed_point_divider [<motor>] [<uint>]                                              
-- position_pid_i [<motor>] [<value>] +    - speed_pid_uIAntiWU_Limit [<motor>] [<uint>]                                                   
-- position_pid_d [<motor>] [<value>] +    - current_pid_p [<motor>] [<int>]                                                               
-- position_pid_do [<motor>] [<value>] +    - current_pid_i [<motor>] [<int>]                                                               
-- position_pid_fixed_point_divider [<motor>] [<value>] +    - current_pid_d [<motor>] [<int>]                                                               
-- position_pid_uIAntiWU_Limit [<motor>] [<value>] +    - current_pid_do [<motor>] [<int>]                                                              
-- loop_function [<motor>] [<value>] +    - current_pid_fixed_point_divider [<motor>] [<uint>]                                            
-- ticks_per_turn_motor [<motor>] [<value>] +    - current_pid_uIAntiWU_Limit [<motor>] [<uint>]                                                 
-- resistance_motor [<motor>] [<value>] +    - position_pid_p [<motor>] [<int>]                                                              
-- kv_motor [<motor>] [<value>] +    - position_pid_i [<motor>] [<int>]                                                              
-- nominal_power_voltage [<motor>] [<value>] +    - position_pid_d [<motor>] [<int>]                                                              
-- save_parameter_to_flash +    - position_pid_do [<motor>] [<int>]                                                             
-- polarity [<motor>] [<value>] +    - position_pid_fixed_point_divider [<motor>] [<uint>]                                           
-- position_speed_period [<motor>] [<value>] +    - position_pid_uIAntiWU_Limit [<motor>] [<uint>]                                                
-- print_board_states +    - pwm_duty_max [<motor>] [<uint>                                                              
-enterOperationalMode +    - bemf_compensation [<motor>] [<uint>                                                         
-leaveOperationalMode +    - minimal_speed [<motor>] [<uint>                                                             
-help+    - offset_current_start [<motor>] [<uint>                                                      
 +    - loop_function [<motor>] [<int>]                                                               
 +    - ticks_per_turn_motor [<motor>] [<int>]                                                        
 +    - resistance_motor [<motor>] [<float>]                                                          
 +    - kv_motor [<motor>] [<float>]                                                                  
 +    - nominal_power_voltage [<motor>] [<float>]                                                     
 +    - polarity [<motor>] [<int>]                                                                    
 +    - position_speed_period [<motor>] [<int>]                                                       
 +    - print_board_states                                                                            
 +    enter_operational_mode                                                                        
 +    leave_operational_mode                                                                        
 +    publish_freq [<motor>] [<int>                                                               
 +    - emergency_stop [<motor>] [<int>                                                             
 +    - homing [<motor>] [<int>                                                                     
 +    - print_gpio_list                                                                               
 +    - print_gpio [<motor>] [<str>                                                                 
 +    - freeWheelGpio [<motor>] [<str>                                                              
 +    - homingGpio [<motor>] [<str>                                                                 
 +    - negLimitSwitchGpio [<motor>] [<str>                                                         
 +    - posLimitSwitchGpio [<motor>] [<str>                                                         
 +    - is_homing_done [<motor>                                                                     
 +    - invertNegLimitSwitchGpio [<motor>] [<uint>                                                  
 +    - invertPosLimitSwitchGpio [<motor>] [<uint>                                                  
 +    - invertHomingGpio [<motor>] [<uint>                                                          
 +    - max_position_error [<motor>] [<uint>                                                        
 +    - pwm_offset [<motor>] [<uint>                                                                
 +    - acceleration_period [<motor>] [<uint>                                                       
 +    - deceleration_limit [<motor>] [<uint>                                                        
 +    - acceleration_limit [<motor>] [<uint>                                                        
 +    - max_current [<motor>] [<uint>                                                               
 +    - max_speed [<motor>] [<uint>                                                                 
 +    - save_parameters_to_flash                                                                      
 +    - load_parameters_from_flash                                                                    
 +    - erase_flash                                                                                   
 +    - spi_xfer_dbg <int> <int> <int>                                                                
 +    - spi_xfer8_dbg <int> <int>                                                                     
 +    - spi_xfer16_dbg <int> <int>                                                                    
 +    - board_brake [<motor>] [<int>                                                                
 +    - board_getAllExtEncPin <int>                                                                   
 +    - board_printSupplyVoltage                                                                      
 +    - board_sleep <int>                                                                             
 +    - board_reset <int>                                                                             
 +    - board_printDriverFault                                                                        
 +    - board_resetDriver                                                                             
 +    - board_setRightMotorPwm <int>                                                                  
 +    - board_motorControl <int>                                                                      
 +    - board_activateDrivers <int>                                                                   
 +    - board_getCurrent <int>                                                                        
 +    - board_seeCurrent                                                                              
 +    - board_getMotorEnc <int>                                                                       
 +    - config_DriverParam                                                                            
 +    - com_spi <int> <int> <int>
 </code> </code>
  
  
 ---- ----
- 
 ==== Board States ==== ==== Board States ====
  
Line 100: Line 150:
 ==== Save parameters ==== ==== Save parameters ====
  
-You can save the parameters using save_parameter_to_flash.+You can save the parameters using save_parameters_to_flash.
 <code> <code>
->save_parameter_to_flash +>save_parameters_to_flash 
  
 >D:001-000000 Parameters saved >D:001-000000 Parameters saved
Line 115: Line 165:
 To enter operational mode use : To enter operational mode use :
 <code> <code>
->enterOperationalMode +>enter_Operational_Mode 
 </code> </code>
  
 To leave operational mode use : To leave operational mode use :
 <code> <code>
->leaveOperationalMode +>leave_Operational_Mode 
 </code> </code>
  
 ---- ----
 +
 +==== Data Publication ====
 +Some information like average speed, PWM duty cycle, voltage, and current can be published periodically to the serial port. To enable this auto-publishing mode for a specific motor, use :
 +<code>
 +>publish_freq [<motor>] [<int>]
 +</code>
 +
 +To disable auto-publishing mode, use :
 +<code>
 +>publish_freq [<motor>] 0
 +</code>
 +
 +----
 +
 ==== Motor Parameters ==== ==== Motor Parameters ====
 === Getter and Setter === === Getter and Setter ===
the_quimdc_command_line_interface.1526978020.txt.gz · Last modified: 2018/05/22 10:33 by 127.0.0.1