Quick Start Guide: Difference between revisions

From STorM32-BGC Wiki
Jump to navigation Jump to search
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
On this page, I (OlliW) will briefly describe the initial steps which are required to set up the STorM32-BGC to function correctly.
<span style="font-size:88%">''by OlliW, descriptions refer to firmware v0.57e and later</span>''
 
On this page, I will briefly describe the initial steps which are required to set up the STorM32-BGC to function correctly. Since firmware v0.57e this has become extremely simple.  


'''Ultra-Quick Start Guide:'''
'''Ultra-Quick Start Guide:'''
* Use the "Calibrate Acc" tab to calibrate the imus.
* Use the {{GUI|Calibrate Acc}} tab to calibrate the imus.
* Use the "Configure Gimbal Tool" to set the Imu-1 Orientation, Imu-2 Orientation, and the Motor Poles correctly, and to set the Motor Directions to "auto".
* Use the {{GUI|Configure Gimbal Tool}} to set the {{PARAMNAME|Imu Orientation}}, {{PARAMNAME|Imu2 Orientation}}, {{PARAMNAME|Motor Poles}}, {{PARAMNAME|Motor Direction}}, and {{PARAMNAME|Startup Motor Pos}} parameters correctly, as well as to enable the motors and store the settings permanently.  
* Use the "Get Current Motor Directions" option to set the Motor Directions.
* Use the "Get Current Pitch and Roll Motor Positions" option to set the Startup Motor Pos parameters for pitch and roll.
* Use the "Adjust Yaw Startup Motor Pos Parameter Tool" to align the yaw axis to point forward at startup.


Below a somewhat less quick "Quick Start Guide" follows. It tells you what you need to know and what to do.
Below a somewhat less quick "Quick Start Guide" follows. It tells you what you need to know and what to do.
Line 13: Line 12:
The STorM32 controller can currently be used for the following setups:
The STorM32 controller can currently be used for the following setups:
* '''3-Axis with single Camera IMU:''' Only one IMU, connected to the I2C port and mounted to the camera, is used.
* '''3-Axis with single Camera IMU:''' Only one IMU, connected to the I2C port and mounted to the camera, is used.
* '''3-Axis with Camera & on-board IMU:''' In addition to the camera IMU the Storm32 on-board IMU is used as a 2nd IMU. The Storm32 board must be mounted on the gimbal ~Above~ the yaw motor.  
* '''3-Axis with Camera & on-board IMU:''' In addition to the camera IMU the STorM32 on-board IMU is used as a 2nd IMU. The STorM32 board must be mounted on the gimbal ''above'' the yaw motor.  
* '''3-Axis with Camera & separate 2nd IMU:''' In addition to the camera IMU a further IMU connected to the I2C#2 port is used as 2nd IMU. The board can be mounted anywhere, but the 2nd IMU must be mounted on the gimbal ~Above~ the yaw motor.  
* '''3-Axis with Camera & separate 2nd IMU:''' In addition to the camera IMU a further IMU connected to the I2C#2 port is used as 2nd IMU. The board can be mounted anywhere, but the 2nd IMU must be mounted on the gimbal ''above'' the yaw motor.  
* '''2-Axis:''' This is not "officially" supported but users figured out that the controller can be set up to work fine with a 2-axis gimbal. Only one Camera IMU is attached to the I2C port. The 2nd IMU is not supported in this configuration.  
* '''2-Axis:''' This is not officially supported but users figured out that the controller can be set up to work fine with a 2-axis gimbal (check the [http://www.rcgroups.com/forums/showthread.php?t=2055844 rcgroups thread]). Only a camera IMU is attached to the I2C port. A 2nd IMU is not supported in this configuration.  
Both the 3-axis and 2-axis gimbals with single IMU are obviously easier to set up since one doesn't need to be concerned about the effects of the 2nd IMU and what's required to get it working correctly. The following focuses on the dual-IMU setups.  
Both the 3-axis and 2-axis gimbals with single IMU are obviously easier to set up since one doesn't need to be concerned about the 2nd IMU and what's required to get it working correctly. The following focuses on the 3-axis dual-IMU setups.


== Preparation ==
== Preparation ==
Things to know before starting:  
Things to know before starting:  
* Comprehend the [[Getting Started#Dos and Dont's|Dos and Dont's]].
* Comprehend the [[Dos and Don'ts]].
* Understand the importance of a proper gimbal mechanics, read [[Getting Started#The Gimbal|The Gimbal]] and especially [[Tuning_Recipe#Balancing the Gimbal|Balancing the Gimbal]]!
* Understand the importance of a proper gimbal mechanics, read [[Getting Started#The Gimbal|The Gimbal]] and especially [[Tuning_Recipe#Balancing the Gimbal|Balancing the Gimbal]].
* Get familiar with the board, inspect the [[Pins and Connectors]].
* Get familiar with the board, inspect the [[Pins and Connectors]].
* Use the latest firmware and GUI. To download the latest firmware package see [[Downloads]]. To flash the firmware to the board see [[How to flash firmware]]. Read the updates and installation instructions in the respective posts at the [http://www.rcgroups.com/forums/showthread.php?t=2055844 rcgroups thread], also check these posts for known bugs.
* Use the latest firmware and GUI. To download the latest firmware package see [[Downloads]]. To flash the firmware to the board see [[How to flash firmware]]. Read the updates and installation instructions in the respective posts at the [http://www.rcgroups.com/forums/showthread.php?t=2055844 rcgroups thread], also check these posts for known bugs.
* Check that your setup matches one of the supported setups mentioned previously.
* Check that your setup matches one of the supported setups mentioned previously.
* Understand the "Read", "Write", and "Write+Store" mechanism in the GUI.
* Understand the {{GUI|Read}}, {{GUI|Write}}, and {{GUI|Write+Store}} mechanism in the GUI.


Finally, good advice:- Please take any recommendations from these links seriously!
Finally, good advice: Please take any recommendations from these links seriously!


== Calibration ==
== Calibration ==
The accelerometers of the IMU modules need to be calibrated for optimal performance (the gyros too, but that's  beyond reach). Several calibration techniques are known, and two of them are implemented in the STorM32 project, called 1-point and 6-point calibration.  
The accelerometers within the IMU modules need to be calibrated for optimal performance. See [[Calibration]].


Unfortunately, it is not finally clear what method is the best. This is because not much useful info is in the web and I don't have the resources for an extensive research project on this, but this is what would be needed. Hence, the situation is currently a bit experimental and might appear fuzzy to many users, but - to also have a good message - the knowledge and experience increases and calibration procedures might improve with time.
== Basic Controller Configuration ==
The algorithms used in the STorM32 controller need to know some aspects of your gimbal in order to work correctly. If any of this information is incorrect, the controller will misbehave. Unfortunately, an incorrect setup will not always immediately reveal itself, but will lead to misbehavior at a later stage, e.g. when a new function is activated, and therefore you might not associate it with the earlier faulty setup. So, please accept the following statement:


The reasons for a calibration are different for the camera and the 2nd IMU.
Just because a setting seems to work correctly doesn't mean that it is correct!


'''Camera IMU:''' The calibration mainly affects the "horizont drift", i.e. the accuracy with which the horizont is hold in quick yaw turns and other high-g maneuvers. It also determines the accuracy of how well the camera is level, but this could in principle be tuned out easily by other means (e.g. offset parameters). The main concern is the performance in high-g maneuvers.
One implication is that adjusting the fundamental parameters by trial-and-error is the best approach in producing all sorts of non-obvious problems. Fortunately, a straight-forward setup procedure is available and if followed, guarantees correct settings. So, the above could be rephrased as "Don't try to be smart, just shut up and follow the recipe". That's in fact the best advice possible here.  


'''Second IMU:''' The measurement accuracy of the 2nd IMU is by itself not very important, it is however very important that the 2nd IMU data is consistent with the camera IMU, and it is the more important the higher the number of motor poles is.
The parameters we are talking about are those mainly contained under the {{GUI|Gimbal Configuration}} tab in the GUI:


Some insights have been made so far.
* Imu Orientation (= camera IMU)
 
* Imu2 Orientation (= 2nd IMU)
'''Imu Orientation:''' As a general trend, the z axis is much more wrong than the x and y axes.
* Motor Poles
 
* Motor Directions
'''Calibration Accuracy:'''
* Startup Motor Positions
A 6-point calibration is meaningful only if it is done very accurately. A poorly undertaken 6-point calibration can easily result in a poorer performance than a supposedly "lesser" 1-point calibration. The quality factor can give an indication.
 
From that these rule of thumbs follow:
 
'''Rules of thumb:'''
* The calibration only needs to be as good as you need it to be. If you are happy with how your gimbal works, you don't have to spend time on a (better) calibration.
* IMU orientations with the z-axis up or down seem preferable, as it lessens the need of a calibration. But don't get fooled here, equally good results can be obtained for any orientation. Some of the best videos out there were in fact recorded with the IMU's z axis horizontal. It just means that with the z axis up or down it's more likely to get away with a lesser calibration for a desired level of performance.
* The calibration of the camera IMU is more important than for the 2nd IMU, i.e. for the 2nd IMU a "lesser" calibration might be fully sufficient.
* The calibration of the 2nd IMU is the more important the higher the motor pole count is.
 
Even though, for the reasons mentioned before, a clear cut calibration recipe cannot be offered currently, some recommendations seems at place:


'''Current Recommendations:'''
Some of these parameters should be adjusted "before" the motors are activated, some can only be adjusted with the motors enabled. Hence, the individual steps are grouped into {{GUI|Steps I}} and {{GUI|Steps II}} in the {{GUI|Configure Gimbal Tool}}. In between a battery needs to be connected to power the motors and the gimbal is restarted. Finally, in the {{GUI|Finish}} steps, the motors are enabled and the determined values stored permanently to the STorM32 board.
* A 1-point calibration is fairly simple, and is hence recommended for both the camera and 2nd IMU.
* If possible choose IMU orientations with the z-axis up or down, but that's no must as explained before.
* Don't do a 6-point calibration if you don't plan to do it really accurately (check out the rcgroups thread).
* If motors with 12 or 14 poles are used, a 1-point calibration of the 2nd IMU is most likely sufficient. High-pole motors require in contrast a careful 2nd IMU calibration.


'''Video Calibration Tutorial:''' Rcgroups user mackar did a great video on the 6-point calibration. Go to [[6-Point Calibration]].
All this can be most easily done by using the {{GUI|Configure Gimbal Tool}} option, which is started by clicking on the respective button under the {{GUI|Gimbal Configuration}} tab in the GUI. Just follow the instructions step by step.  


Finally, this important advice:
=== Steps I ===
The camera and 2nd IMU orientations and number of motor poles are adjusted, and the motor direction parameters set to {{PARAMVALUE|auto}} in order to find correct rotation directions later on.


Safe your calibration data to a file!
Just follow the instructions in the {{GUI|Configure Gimbal Tool}} step by step:


Ideally safe it from within the Calibration dialog, as this stores the most detailed information. Consider also to post your calibration files in the rcgroups thread, so that I and others can enhance our knowledge and hopefully develop better calibration schemes.
* It will guide you through a simple procedure which determines the Imu and Imu2 orientations.
 
* It will then ask you to enter the number of poles of your motors. The number of poles for your motors should be available in the motor data sheets. For example, a 12N14P motor has 14 poles. The number of poles corresponds to the number of magnets, which you can be seen on the inner side of the motor bell. So, if in doubt you can quite easily determine the number of poles by simply counting the number of magnets.  
== Basic Controller Configuration ==
* Finally, it will set the motor direction parameters to {{PARAMVALUE|auto}}.
The algorithms used in the STorM32 controller need to know some aspects of your gimbal in order to work correctly. If any of this information is incorrect, the controller will misbehave. Unfortunately, an incorrect setup will not always  immediately reveal itself, but will lead to misbehavior at a later stage, e.g. when a new function is activated, and therefore you might not associate it with the earlier faulty setup. So, please accept the following statement:
 
Just because a setting seems to work correctly doesn't mean that it is correct!
 
One implication is that adjusting the fundamental parameters by trial-and-error is the best approach in producing all sorts of non-obvious problems. Fortunately, a straight-forward setup procedure is available and if followed, guarantees correct settings. So, the above could be rephrased also as "Don't try to be smart, just follow the recipe". That's in fact the best advice possible here.
 
The parameters we are talking about are those contained under in the "Gimbal Configuration" tab in the GUI:
* Imu-1 Orientation
* Imu-2 Orientation
* Motor Poles
* Motor Directions
* Motor Start-up Positions
Some of them should be adjusted before the motors are activated, some can only be adjusted with the motors enabled.


=== Before the motors are enabled for the first time ===
=== Steps II ===
The Imu-1 and Imu-2 orientations and number of motor poles should be adjusted before the motors are activated, and the motor direction settings, initially set to "auto" in order to find correct rotation directiony.
With the camera and 2nd IMU orientations, and motor poles set correctly, and the motor directions set to {{PARAMVALUE|auto}} in the previous steps, the motor directions and startup motor positions can be determined in the next steps.  


This is most easily done by using the "Configure Gimbal Tool" (accessible under the "Gimbal Configuration" tab in the GUI), which is started by clicking on the respective button. Just follow the instructions step by step:
For that, all motors will be enabled and the gimbal restarted. For this to work the controller needs to be connected to a battery; don't worry, the {{GUI|Configure Gimbal Tool}} will check and tell you when to connect a battery. The controller should go through the initialization steps and level the camera (green led blinks), and then reach the "Normal" state (a beep occurs, and the green led goes continuously on). You can follow this also by the status messages in the {{GUI|Configure Gimbal Tool}}. Once the "Normal" state is reached, the motor directions and startup motor positions can be determined.


* It will guide you through a simple procedure which determines the Imu1 and Imu2 Orientation parameters.  
Just follow the instructions in the {{GUI|Configure Gimbal Tool}} step by step:
* It then will ask you to enter the number of poles of your motors. The number of poles for your motor should be available in the motor data sheets. For instance, a 12N14P motor has 14 poles. The number of poles corresponds to the number of magnets, which you can see on the inner side of the motor bell. So, if in doubt you can easily determine the number of poles by simply counting the magnets.
* It will copy the automatically determined motor directions into the Motor Direction fields.  
* Finally, as mentioned above, the Motor Direction parameters are set to "auto".
* It will then copy the current pitch and roll motor positions into the Pitch and Roll Startup Motor Pos parameter fields.
* Finally it will ask you to align the yaw axis such that the camera points to the forward position using the various buttons. Don't worry that the alignment is undone, when going to the next step, this is normal as the adjustment becomes effective after the next re-start of the STorM32 controller.  


=== After motors have been enabled for the first time ===
{{COMMENT|In rare cases it may happen that these steps fail, since the gimbal starts to freak out when the "Normal" state is reached. This happens when the (default) PID parameters are grossly wrong for your gimbal. In that case skip the {{GUI|Steps II}} steps and proceed to the {{GUI|Finish}} steps, do a coarse PID tuning, and when repeat.}}
With the Imu-1 and Imu-2 orientations, and motor poles set correctly, and the motor directions set to "auto", one can enable the motors (all motors!) and start the gimbal. The controller should go through the initialization steps and level the camera (green led blinks), and then reach the "Normal" state (green led continuously On). Note: You can see what is happening by initiating and starting the "Data Display". Once the "Normal" state is reached the Motor Direction and the Startup Motor Pos parameters can be set using the "Tools" menu:


* Go to the "Tools" menu and execute the "Get Current Motor Directions" option. This will copy the auto determined motor directions into the Motor Direction fields.
=== Finish ===
* Go to the "Tools" menu and execute the "Get Current Pitch and Roll Motor Positions" option. This will copy the current pitch and roll motor positions into the Pitch and Roll Startup Motor Pos parameter fields.
With all relevant parameters determined, the motors can be permanently enabled and the parameter values permanently stored in the STorM32 board.
* Go to the "Tools" menu and execute the "Adjust Yaw Startup Motor Pos Parameter Tool". This opens a dialog box which allows you to align the yaw axis such that the camera points to the forward position. Don't worry that the alignment being undone when closing the dialog box, this is normal.


The adjustments made in these steps become effective only at the next startup of the gimbal.
In the {{GUI|Configure Gimbal Tool}} just hit the {{GUI|Ok}} button to finish the configuration.


== The Next Steps ==
== The Next Steps ==
The next steps are to tune the PID parameters. It is not part of this Quick Guide, since the PID values are not fundamental for the controller to work correctly; they are (very) important for the performance. Once tuned, one can start to enjoy all the great and partly unique possibilities of the STorM32 controller. :)
The next steps are to tune the PID parameters. It is not part of this Quick Guide, since the PID values are not fundamental for the controller to work correctly; they are (very) important for the performance. Once tuned, one can start to enjoy all the great and partly unique possibilities of the STorM32 controller. :)

Latest revision as of 23:11, 17 September 2015

by OlliW, descriptions refer to firmware v0.57e and later

On this page, I will briefly describe the initial steps which are required to set up the STorM32-BGC to function correctly. Since firmware v0.57e this has become extremely simple.

Ultra-Quick Start Guide:

  • Use the [GUI:Calibrate Acc] tab to calibrate the imus.
  • Use the [GUI:Configure Gimbal Tool] to set the Imu Orientation, Imu2 Orientation, Motor Poles, Motor Direction, and Startup Motor Pos parameters correctly, as well as to enable the motors and store the settings permanently.

Below a somewhat less quick "Quick Start Guide" follows. It tells you what you need to know and what to do.

Supported Gimbals

The STorM32 controller can currently be used for the following setups:

  • 3-Axis with single Camera IMU: Only one IMU, connected to the I2C port and mounted to the camera, is used.
  • 3-Axis with Camera & on-board IMU: In addition to the camera IMU the STorM32 on-board IMU is used as a 2nd IMU. The STorM32 board must be mounted on the gimbal above the yaw motor.
  • 3-Axis with Camera & separate 2nd IMU: In addition to the camera IMU a further IMU connected to the I2C#2 port is used as 2nd IMU. The board can be mounted anywhere, but the 2nd IMU must be mounted on the gimbal above the yaw motor.
  • 2-Axis: This is not officially supported but users figured out that the controller can be set up to work fine with a 2-axis gimbal (check the rcgroups thread). Only a camera IMU is attached to the I2C port. A 2nd IMU is not supported in this configuration.

Both the 3-axis and 2-axis gimbals with single IMU are obviously easier to set up since one doesn't need to be concerned about the 2nd IMU and what's required to get it working correctly. The following focuses on the 3-axis dual-IMU setups.

Preparation

Things to know before starting:

  • Comprehend the Dos and Don'ts.
  • Understand the importance of a proper gimbal mechanics, read The Gimbal and especially Balancing the Gimbal.
  • Get familiar with the board, inspect the Pins and Connectors.
  • Use the latest firmware and GUI. To download the latest firmware package see Downloads. To flash the firmware to the board see How to flash firmware. Read the updates and installation instructions in the respective posts at the rcgroups thread, also check these posts for known bugs.
  • Check that your setup matches one of the supported setups mentioned previously.
  • Understand the [GUI:Read], [GUI:Write], and [GUI:Write+Store] mechanism in the GUI.

Finally, good advice: Please take any recommendations from these links seriously!

Calibration

The accelerometers within the IMU modules need to be calibrated for optimal performance. See Calibration.

Basic Controller Configuration

The algorithms used in the STorM32 controller need to know some aspects of your gimbal in order to work correctly. If any of this information is incorrect, the controller will misbehave. Unfortunately, an incorrect setup will not always immediately reveal itself, but will lead to misbehavior at a later stage, e.g. when a new function is activated, and therefore you might not associate it with the earlier faulty setup. So, please accept the following statement: 

Just because a setting seems to work correctly doesn't mean that it is correct!

One implication is that adjusting the fundamental parameters by trial-and-error is the best approach in producing all sorts of non-obvious problems. Fortunately, a straight-forward setup procedure is available and if followed, guarantees correct settings. So, the above could be rephrased as "Don't try to be smart, just shut up and follow the recipe". That's in fact the best advice possible here.

The parameters we are talking about are those mainly contained under the [GUI:Gimbal Configuration] tab in the GUI:

  • Imu Orientation (= camera IMU)
  • Imu2 Orientation (= 2nd IMU)
  • Motor Poles
  • Motor Directions
  • Startup Motor Positions

Some of these parameters should be adjusted "before" the motors are activated, some can only be adjusted with the motors enabled. Hence, the individual steps are grouped into [GUI:Steps I] and [GUI:Steps II] in the [GUI:Configure Gimbal Tool]. In between a battery needs to be connected to power the motors and the gimbal is restarted. Finally, in the [GUI:Finish] steps, the motors are enabled and the determined values stored permanently to the STorM32 board.

All this can be most easily done by using the [GUI:Configure Gimbal Tool] option, which is started by clicking on the respective button under the [GUI:Gimbal Configuration] tab in the GUI. Just follow the instructions step by step.

Steps I

The camera and 2nd IMU orientations and number of motor poles are adjusted, and the motor direction parameters set to “auto” in order to find correct rotation directions later on.

Just follow the instructions in the [GUI:Configure Gimbal Tool] step by step:

  • It will guide you through a simple procedure which determines the Imu and Imu2 orientations.
  • It will then ask you to enter the number of poles of your motors. The number of poles for your motors should be available in the motor data sheets. For example, a 12N14P motor has 14 poles. The number of poles corresponds to the number of magnets, which you can be seen on the inner side of the motor bell. So, if in doubt you can quite easily determine the number of poles by simply counting the number of magnets.
  • Finally, it will set the motor direction parameters to “auto”.

Steps II

With the camera and 2nd IMU orientations, and motor poles set correctly, and the motor directions set to “auto” in the previous steps, the motor directions and startup motor positions can be determined in the next steps.

For that, all motors will be enabled and the gimbal restarted. For this to work the controller needs to be connected to a battery; don't worry, the [GUI:Configure Gimbal Tool] will check and tell you when to connect a battery. The controller should go through the initialization steps and level the camera (green led blinks), and then reach the "Normal" state (a beep occurs, and the green led goes continuously on). You can follow this also by the status messages in the [GUI:Configure Gimbal Tool]. Once the "Normal" state is reached, the motor directions and startup motor positions can be determined.

Just follow the instructions in the [GUI:Configure Gimbal Tool] step by step:

  • It will copy the automatically determined motor directions into the Motor Direction fields.
  • It will then copy the current pitch and roll motor positions into the Pitch and Roll Startup Motor Pos parameter fields.
  • Finally it will ask you to align the yaw axis such that the camera points to the forward position using the various buttons. Don't worry that the alignment is undone, when going to the next step, this is normal as the adjustment becomes effective after the next re-start of the STorM32 controller.

Comment: In rare cases it may happen that these steps fail, since the gimbal starts to freak out when the "Normal" state is reached. This happens when the (default) PID parameters are grossly wrong for your gimbal. In that case skip the [GUI:Steps II] steps and proceed to the [GUI:Finish] steps, do a coarse PID tuning, and when repeat.

Finish

With all relevant parameters determined, the motors can be permanently enabled and the parameter values permanently stored in the STorM32 board.

In the [GUI:Configure Gimbal Tool] just hit the [GUI:Ok] button to finish the configuration.

The Next Steps

The next steps are to tune the PID parameters. It is not part of this Quick Guide, since the PID values are not fundamental for the controller to work correctly; they are (very) important for the performance. Once tuned, one can start to enjoy all the great and partly unique possibilities of the STorM32 controller. :)

Retrieved from "http:///storm32bgc-wiki/index.php?title=Quick_Start_Guide&oldid=2727"