Getting Started: Difference between revisions

From STorM32-BGC Wiki
Jump to navigation Jump to search
 
(444 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<span style="font-size:88%">''by Yang/wdaehn, descriptions refer to firmware v0.56</span>''
<span style="font-size:88%">''by Yang/wdaehn and OlliW, descriptions refer to firmwares v2.xx''</span>


You have a gimbal, the STorM32-BGC board, the IMU module and all cables. So what is next? This page is intended to guide you through the essential steps, and provides references to more specific pages in case you need to know more. Basically the steps are:
You have a gimbal, the STorM32 controller board, the IMU module(s) and all cables. So what is next? This page is intended to guide you through the essential steps, provide you with the most relevant information, and give references to the more specific pages in case you want or need to know more.


<div class="toclimit-2">__TOC__</div>
<div class="toclimit-2">__TOC__</div>
== Opening Remarks ==
If you are new to gimbals, then the [https://www.rcgroups.com/forums/showthread.php?2818200-Gimbals-101 Gimbal 101] by rcgroups user mike_kelly is a much recommended reading. It provides a wealth of information in a very readable way.
The following tutorial is for users of a conventional STorM32 NT setup (= non-encoder setup).
If you are using a T-STorM32 setup (= encoder setup), then not all info given here does apply. Please read the article [[Getting Started with T-STorM32]], and in case of conflicting info go with the info given there.


== Ordering Information ==
== Ordering Information ==
Things to order at minimum:
Things to order at minimum:
* STorM32-BGC board
* STorM32 controller board (v1.3x, v3.3 or v4.1, and compatible boards; older boards are not supported)
* IMU module and matching cable  
* NT IMU module and matching cable  
* USB-to-TTL adapter
* USB-to-TTL adapter (not required for some v3.x and the v4.x boards, but always handy to have anyway)


The STorM32-BGC board can be obtained from various shops. There are several hardware revisions around, but, frankly, they do not differ much. There is, e.g., nothing wrong with buying a v1.1 board, just keep in mind that some pins are placed differently here. A v1.3 board is used exemplary below.
Users of v3.x STorM32 boards (all variants) in addition need to order:
* three NT Motor modules or NT Motor-Encoder modules


Together with the board, buy also an IMU module and a matching cable from the same vendor. There are tons of different IMU modules available, and different connectors are in use. The plug on the STorM32 board is a so-called [http://www.molex.com/molex/products/family?key=picoblade&channel=products&chanName=family&pageTitle=Introduction Picoblade] connector (commonly but incorrectly often called JST 1.25 connector).
The STorM32 controller board can be obtained from various sources. There are several hardware revisions around. The 50x50 mm-sized v1.3 and v1.32 boards or one of the various v3.3 boards (available in 40x25 mm and 25x25 mm sizes) or the 40x28 mm-sized v4.1 board are the best options. The wide-spread v1.31 board is a good starting point too, but when used in a NT setup issues with its too weak 3.3 V power were reported (see [[Boards#GLB_STorM32_v1.31|Boards: GLB STorM32 v1.31]]). For other boards you may want to check the [[Boards]] page or the internet. A v1.3 board is used exemplarily below.


Finally, a USB-to-serial adapter with a matching cable is required for flashing the latest firmware. It can be any FTDI, CP2102, ... adapter, but NOT a PL2303-based adapter. Again, if you do not have one already, I recommend buying one together with the other parts. Personally I prefer those where the drivers come from the Windows Update Site automatically.
{{COMMENT|Vendors sell all sorts of boards and call them v1.3, v1.31, or v1.32, but they may not be identical to the "legit" versions but show hardware variations. This can result in different behavior than described in this wiki, and thus user irritations, but that's how it is.}} 


Things to watch out when comparing prices
In addition to the STorM32 controller board you also need a NT IMU module and a matching cable. The plug on the v1.3x STorM32 boards is a [http://www.molex.com/molex/products/family?key=picoblade&channel=products&chanName=family&pageTitle=Introduction&parentKey=wire_to_board_connectors Picoblade] connector (often incorrectly called JST 1.25). The standard plug on the v3.x and v4.x boards is a [http://www.jst-mfg.com/product/detail_e.php?series=231 JST SH] connector (often called JST 1.0); however, which plug is used on STorM32 derivatives depends a lot on the manufacturer.
* Bluetooth module included? The STorM32 board is designed for a HC06 Bluetooth module to be soldered on it. Then you can run the GUI on your laptop via Bluetooth. The range of these modules is modest, so do not expect that it allows to remotely monitor the gimbal values in flight. If in future a smartphone app should become available, this might be really cool for changing configurations, on the other hand, how often will you be doing that?
* Connectors soldered to it? Preinstalled connectors allow to simply plug in the motors and go. On the other hand, the RC and motor connectors are quite large, hence you may wish to place them differently or to solder motor cables directly to the board. Consider your preferences before buying.  
* IMU module and cable included? Is the IMU cable soft enough and of appropriate length?


Related wiki articles:
Finally, users of a v1.3x STorM32 board also require a USB-TTL adapter with a matching cable for upgrading the STorM32 board to the latest firmware. It can be any USB-TTL adapter with FTDI or CP2102 or CH340 chip, but NOT a PL2303-based adapter (for details please see [[STorM32_FAQ#Which USB-TTL adapter should I use.3F|FAQ: Which USB-TTL adapter should I use?]]). If you do not happen to have one already, then buy one together with the other parts. Users of the Micro STorM32 board or STorM32 RaspberyPi Hat also need a USB-TTL adapter. Users of v3.x or v4.x STorM32 boards do not need a USB-TTL adapter (these boards do have the adapter integrated on board).
* [[Where to buy STorM32 boards]].
 
* [[Boards]].
Users of v3.x STorM32 boards (all variants) need three NT Motor modules in addition (the v3.x boards do not have motor drivers on board).
 
'''Related wiki articles:'''
* [[Where to buy STorM32 boards]]
* [[Where to get NT Modules]]
* [[STorM32_FAQ#What_are_the_differences_between_the_boards.3F|FAQ: What are the differences between the boards?]]
* [[STorM32_FAQ#What_are_the_differences_between_the_boards.3F|FAQ: What are the differences between the boards?]]
* [[STorM32_FAQ#Will_my_motors_work_with_my_STorM32_board.3F|FAQ: Will my motors work with my STorM32 board?]]
* [[STorM32_FAQ#Which USB-TTL adapter should I use.3F|FAQ: Which USB-TTL adapter should I use?]]
== Dos and Don'ts ==
  {{WARNING|Read and comprehend the [[Dos and Don'ts]].}}
== Supported Gimbals ==
The STorM32 controller currently supports the following setups:
* '''''3-axis with camera IMU''''': Uses only one IMU (aka camera IMU), which is connected to the NT bus and mounted to the camera.
* '''''3-axis with camera & on-board IMU''''': In addition to the camera IMU, the STorM32 on-board IMU is used as 2nd IMU. The STorM32 board must be mounted on the gimbal ''above'' the yaw motor.
* '''''3-axis with camera & separate 2nd NT IMU''''': In addition to the camera IMU, a further NT IMU module connected to the NT bus is used as 2nd IMU. The STorM32 board can be mounted anywhere, but the 2nd IMU must be mounted on the gimbal ''above'' the yaw motor.
* '''''2-axis and 1-axis''''': For some 2-axis gimbal configurations a 2nd IMU is supported (either on-board or separate 2nd NT IMU); for some not or only partially. For 1-axis gimbals a 2nd IMU is not supported. All 2- and 1-axis configurations can work with only a camera IMU. Unused motors must be disabled.
In this article a 3-axis gimbal is assumed throughout.
In the following, a 2nd IMU is not needed. However, if you plan to use one, then you may want to have it installed and connected, so that the {{GUI|Configure Gimbal Tool}} can auto-determine its orientation, but it should be disabled for the following.
The gimbal should be in '''''pitch-roll-yaw''''' configuration. {{WARNING|''Other configurations such as pitch-yaw-roll or roll-pitch-yaw are not officially supported''}} by the STorM32 controller (for further details you may read [https://www.rcgroups.com/forums/showpost.php?p=39183865&postcount=10801]).
The gimbal can be in the "down-hanging" or the "up-standing" position, it works perfectly fine either way.
{{COMMENT|The support of 2- and 1-axis gimbals is somewhat varying. That is, they all can be operated, but due to the large manifold of operating situations testing is challenging and the firmware might not be totally bug free, and also features may be missing depending on the specific configuration. Please report any bugs or missing feature to the rcgroups discussion thread. Also note that the {{GUI|Configure Gimbal Tool}} does not support all possible gimbal configurations, but just a subset.}}
== Calibration ==
The accelerometers within the IMU modules need to be calibrated for optimal performance, e.g. to achieve a good horizon behavior. The calibration is most easily done with the gimbal not yet fully assembled. However, the gimbal will work also with uncalibrated sensors, i.e. calibration is not mandatory for the setup steps to work. You thus can freely decide if you prefer to do the calibration now or later - as long as you do a calibration at some point in time!
'''Related wiki articles:'''
* [[Calibration]]


== Flashing Firmware ==
== Flashing Firmware ==


Because the STorM32 board has a very active community, new firmware versions with new enhancements are released on about a monthly basis these days, so the first step will be to flash the newest firmware.
As first step it is recommended to flash the latest firmware.


Your board may come or may not come with a firmware loaded; this depends on the vendor. In the first case you could skip the following steps and just install the GUI, but it is recommended to carry them out nevertheless, in order to get the latest firmware and GUI. In the latter case you must go through the steps; without firmware the board obviously would not function. The following description applies to both cases, only the USB driver gets installed by Win 7 in different steps; see the red warnings. It is crucial to NOT interrupt the USB driver install process. It can take several minutes, so please be patient.
Your STorM32 board may or may not come with a firmware loaded; this depends on the vendor (nowadays they usually come with firmware loaded). If a firmware is already loaded then you could skip the flashing steps and just install the GUI, but it is recommended to carry them out nevertheless, in order to benefit from the latest firmware and GUI. If no firmware is loaded then you must go through the flashing steps; without firmware the board obviously won't work.  


In order to flash a new firmware the following steps are recommended.
During the flashing procedure the USB driver for the STorM32 board may be installed by Win 7/8/10/11; see the red warnings in the descriptions. {{WARNING|''It is crucial to '''not''' interrupt the USB driver install process''}}. It can take several minutes, so please be patient; let Windows do its job, for however long it takes.


# Get your USB-to-serial adapter to work by installing all Windows drivers as requested by the vendor. [[File:Usb-to-uart-driver.png|none|300px]]
The flashing procedure is quite different for the v1.3x and v3.x/v4.x STorM32 boards:
# Unplug (!) the USB-to-serial adapter again.
* v1.3x STorM32 boards: Follow the description in [[How_to_flash_v1.x_STorM32_boards#Flashing_Firmware_using_a_USB-TTL_Adapter|How to flash v1.x STorM32 boards: Flashing Firmware using a USB-TTL Adapter]]
# Connect the USB-to-serial adapter to the STorM32 board to the pins labeled RC (!). The firmware is not programmed via the UART port, not via USB, but via the RC pins. In other words, when the board is brought into the bootloader mode, the RC pins are re-assigned to the microcontroller's UART1; normally they are assigned to the PWM timer, and the UART pins are the mcu's UART0. All of this is a security measure to avoid people programming the board via e.g. Bluetooth and end up with an nonoperational board. [[File:Stom32-bgc-flashing-w-usbttladapter-connections-02.jpg|none|480px]]
* v3.x and v4.x STorM32 boards: Please refer to the article [[How to flash firmware]].
# Connect the STorM32 board via USB to the computer. We are not using this connection yet, but we power the board via USB.<br>{{WARNING|If the board has already a firmware installed and this is the first-time connection to your PC, then Windows will install the USB driver for the STorM32 board. This can take quite some time. DO NOT interrupt the install process.}}
<!--
# Download the newest firmware, unzip it and run the GUI, in this example the o323BGCTool_v056.exe program. It does not matter what the current firmware installed is, you use the GUI that comes with the firmware zip file. Get the zip file from here: [[Downloads]].
For v1.3x boards, the flashing process is also nicely described in this video by rcgroups user alcurtis93:
# In the GUI select the {{GUI|Flash Firmware}} tab on the very right hand side and select the hardware revision of your board. This does change the firmware file to be used in the field below. [[File:Firmware_selector.png|none|300px]]
::{{#ev:youtube|HwaHjRw1Qqg|480}}-->
# In step two, the middle of the screen, there is a {{GUI|Com Port}} selector for flashing. NOT the com port selector at the bottom! Click on the drop down box to see all currently available COM ports. Since we do not have connected the USB-to-serial adapter to the computer yet, the new one appearing when plugging in the adapter will be the one to use. Hence remember that list of ports to identify the new one in the next step. [[File:Firmware_comport1.png|none|300px]]
# Plugin the USB-to-serial adapter and click again on the drop down box of the serial connector for programming. Select the new one. [[File:Firmware_comport2.png|none|300px]]
# The board has two buttons, the boot and reset button. When the board is started, the very first thing the firmware does is checking if the boot button is currently pressed. If it is, the bootloader mode is entered, else the normal operation starts. The best way of entering the bootloader mode is hence to press the boot button and while it is pressed to press and release the reset button to initiate a hard reset. [[File:Firmware-bootloadermode.jpg|none|300px]]
# Check if the board is in bootloader mode or in operational mode. If the boards appears to be dead, then it is brought into bootloader mode successfully, if the LEDs are blinking, it is in normal operation and obviously the boot button was not pressed while the reset button was released. [[File:Firmware-bootloadermode-leds.jpg|none|300px]]
# Now the board is listening on the RC pins for serial data, the USB adapter is connected, and the correct COM port of the serial adapter is selected, so you can click on the {{GUI|Flash Firmware}} button. [[File:Firmware_start_flash.png|none|300px]]
# A DOS box will open and either return an error that the UART connection is not responding or a sequence of downloading and verifying the firmware is shown. [[File:Flash.png|none|300px]] {{WARNING|If this is a first-time flash of a "virgin" board, then Windows will install the USB driver. This can take quite some time. DO NOT interrupt the install process.}}
# After the reset, your board is operational and can be reached via the USB cable. Hence disconnect both, the USB cable and the USB-to-serial adapter and click on the COM port selector at the very bottom. Again, remember the list. [[File:Board read 0.png|none|300px]]
# Then plug in the STorM32 board via the USB cable to power it. Either the matching driver was installed already or it will be installed now. Either way, once windows has installed the driver when clicking on the drop down for the COM port selector, it should now show an additional one.[[File:Board read 1.png|none|300px]]
# Jump back to the {{GUI|Main}} tab and click on {{GUI|Read}} to validate the connection with the board. [[File:Board_read_2.png|none|300px]]


In case you have troubles with the STorM32's USB driver, it can be found here: [http://www.st.com/web/en/catalog/tools/PF257938|STM download page].
'''Related wiki articles:'''
* [[STorM32_FAQ#Which_drivers_are_needed_for_the_USB.3F|FAQ: Which drivers are needed for the USB]]


In case the above did not work, typical traps when flashing are
== Checking Connection to the GUI ==
* The board has no power - connect the board to the computer via USB to power it.
* The pins labeled UART are used for flashing - which is wrong, the RC pins should be used.
* Wrong serial port is selected in the tool.


It is also recommended to read the [[How to flash firmware]] page for trouble shooting.
Next, let's check if the STorM32 controller is indeed operational, and communicates with the GUI. Note that the firmware and GUI versions must match. If they do not match, the GUI will tell you the versions it expects, but may refuse to work.


Related wiki articles:
This is a good occasion to also learn about the usage of the {{GUIFIELD|Read}}, {{GUIFIELD|Write}} and {{GUIFIELD|Write+Store}} buttons: Please read the [[STorM32_FAQ#How_does_Read.2C_Write.2C_and_Store_work.3F|FAQ: How does Read, Write, and Store work?]].
* [[How to flash firmware]].
 
To check the connection, follow these steps:
 
# If a USB cable is connected to the STorM32 board, disconnect it. Click on the {{GUIFIELD|Port}} selector in the left bottom and memorize the list. [[File:Storm32-wiki-gettingstarted-checkconnection-1.jpg|none|360px]]
# Now plug in the STorM32 board via the USB cable to power it. When clicking on the drop down for the {{GUIFIELD|Port}} selector, it should show an additional one.<br> {{WARNING|If the board has a firmware installed and this is the first-time connection via USB to your PC, then Windows will install the USB driver for the STorM32 board. This can take quite some time. Do '''''NOT''''' interrupt the install process.}} [[File:Storm32-wiki-gettingstarted-checkconnection-2.jpg|none|360px]]
# Go to the {{GUI|Main}} tab and click on {{GUIFIELD|Connect}} or {{GUIFIELD|Read}} to validate the connection with the board. [[File:Storm32-wiki-gettingstarted-checkconnection-3.jpg|none|360px]]
 
'''Quick Trouble Shooting:'''
* Wrong COM port selected.
* Firmware and GUI version numbers do not match.
 
'''Related wiki articles:'''
* [[STorM32_FAQ#Which_drivers_are_needed_for_the_USB.3F|FAQ: Which drivers are needed for the USB?]]
* [[STorM32_FAQ#How_does_Read.2C_Write.2C_and_Store_work.3F|FAQ: How does Read, Write, and Store work?]]
* [[STorM32_FAQ#How_to_enter_precise_parameter_values.3F|FAQ: How to enter precise parameter values?]]


== Hardware Setup ==
== Hardware Setup ==
Line 67: Line 113:
=== The Camera IMU ===
=== The Camera IMU ===


The camera IMU needs to be mounted such that it does measure all camera movements. Its actual position does not matter, behind the camera, on the pitch arm, below the camera,... anything will work. The only thing to watch out for is that its axes are aligned with the camera axes. Each axis has to be either horizontal or vertical. Just imagine that the sensor would read that the horizon is level but because of a misalignment the camera does hang slightly to one side and hence the horizon in the video is not level.  
The camera IMU needs to be mounted such that it measures all camera movements. Its actual position does not matter, behind the camera, on the pitch arm, below the camera,... anything will work. The only thing to watch out for is that its axes are aligned with the camera axes. Each axis has to be either horizontal or vertical. Just imagine that the sensor would measure that the horizon is level but because of a misalignment the camera does hang slightly to one side and hence the horizon in the video is not level.
 
Thanks to the NT concept, there are essentially no limits on how to wire the cables (in contrast to the older I2C-based approach, which often was prone to I2C errors).


=== Mounting the STorM32 Board ===
=== Mounting the STorM32 Board ===


One of the outstanding features of the STorM32 board is its 2nd IMU support. In fact the board has such an IMU on-board already. To make use of it, the board needs to be mounted such that it measures the movements of the copter frame. The direction does not matter as long as it measures the frame's movements. In case this is not possible, either the 2nd IMU support has to be disabled, or another external IMU can be mounted to the frame and connected to the frame I2C connector, labeled I2C#2. As for the camera IMU, also the axes of the 2nd IMU have to be vertical or horizontal, respectively.
One of the outstanding features of the STorM32 board is its 2nd IMU support. In fact, most STorM32 boards do have a 2nd IMU on-board already. To make use of it, the STorM32 board needs to be mounted such that it measures the movements of the copter frame ("above" the yaw axis). The board's location does not matter, as long as it measures the frame's movements. In case this is not possible, another external IMU can be mounted to the frame and connected to the STorM32 board. As for the camera IMU, also the axes of the 2nd IMU have to be vertical or horizontal, respectively.
 
{{COMMENT|T-STorM32 does not make use of a 2nd IMU, and the STorM32 board can thus be placed in any location or orientation which is convenient.}}


Related wiki articles:
'''Related wiki articles:'''
* [[Using a 2nd IMU]].
* [[Using a 2nd IMU]]


=== Electric Connection and Insulation ===
=== Electric Connection and Insulation ===


The IMUs go to their corresponding I2C plugs: The camera IMU goes to the picoblade connector labeled I2C next to the USB connector. On the backside of the board is the I2C#2 connector for the optional frame IMU.
The IMUs go to their corresponding plugs: The camera IMU, which must be a NT IMU module, goes to the NT bus. If a 2nd IMU shall be used, then you have 2 options: (i) A further NT IMU module connected to the NT bus in parallel to the camera IMU; (ii) if an extrenal 2nd IMU is not found the on-board IMU is selected, if available.
 
Make sure that the IMUs are mounted rigidly, so that they measure the actual position.


[[File:Stom32-bgc-v130-ports-and-connections-01.jpg|none|480px]]
{{COMMENT|Check that the NT IMU modules are configured properly, i.e., that the ID solder bridge is closed for the 2nd IMU.}}


One thing we found out the hard way is to never mount the board or the IMUs with metal screws and/or metal distance sleeves. Always use plastic ones. Not only does this help to avoid electrical problems but also the I2C bus can be sensitive to the nearby metal parts, leading to massive error rates on the I2C bus. Without a continuous readings of the IMU positions the entire purpose of the gimbal is forfeit.
{{COMMENT|If starting from a "classic" (non-NT) STorM32 gimbal kit with an I2C IMU module, it can be necessary to rewire one end of the stock I2C cable to match the [[What_is_STorM32_NT_about%3F|pinout of the NT bus]]. Releasing the pins on a picoblade connector is best done using a needle, a craft knife, or similar tool that can lift the release catch holding the crimped picoblade connector.}}


Make also sure that the IMUs are mounted rigidly, so that they measure the actual position.
::[[File:Storm32-nt-v130-ports-and-connections-01.jpg|600px]]


Related wiki articles:
'''Related wiki articles:'''
* [[Dos and Don'ts]].
* [[Dos and Don'ts]]
* [[Pins and Connectors]].
* [[Pins and Connectors]]
* [[I2C Error Compendium]].
* [[Pins and Connectors of NT Modules]]


=== Gimbal Mechanics ===
=== Gimbal Mechanics ===


Before using a gimbal, it is absolutely necessary to balance it and to ensure minimum resistance to rotations (friction in bearings, stiff cables, etc). Any improper balance or resistance to rotation will make setting up the gimbal more difficult or even impossible. The goal shall be to rotate the camera in the gimbal and it should stay in that position by itself. In other words, the center of gravity should be in the center of all gimbal motor axes. Just imagine the camera's center of gravity is way below the pitch axis (looking with the camera up and down). It would act like a pendulum. So just because your copter does accelerate forward, the gimbal pitch motor has to hold against the mass inertia. You will need very strong motors and lots of energy which is a waste. On the other hand, if the gimbal is balanced properly, the motor only has to compensate the copter rotations, wind resistance and inertia when rotating the camera to point to somewhere else.
Before using a gimbal, it is absolutely mandatory to balance it and to ensure minimum resistance to rotations (friction in bearings, stiff cables, etc). {{WARNING|''The importance of these points cannot be overstressed''}}. Any improper balance or resistance to rotation will compromise the performance of the gimbal, and make setting up the gimbal more difficult or even impossible. The goal shall be to rotate the camera in the gimbal and it should stay in that position by itself. In other words, the center of gravity should be in the center of all gimbal motor axes. Just imagine the camera's center of gravity is way below the pitch axis (looking with the camera up and down). It would act like a pendulum. So just because your copter does accelerate forward, the gimbal pitch motor has to hold against the mass inertia. You will need very strong motors and lots of energy which is a waste. On the other hand, if the gimbal is balanced properly, the motor only has to compensate the copter rotations, wind resistance and inertia when rotating the camera to point to somewhere else.


Related wiki articles:
'''Related wiki articles:'''
* [[Tuning_Recipe#Balancing_the_Gimbal|Balancing the Gimbal]].
* [[Tuning_Recipe#Balancing_the_Gimbal|Balancing the Gimbal]]


=== Powering the Gimbal ===
=== Powering the Gimbal ===


For the motors the 5 V supply of the USB bus is too low for sure. So, the motors will work only if a battery with sufficient voltage is connected. That is the reason why e.g. flashing the firmware is done using USB power only, as we do not want the motors to get power in that case. The battery connector can handle any voltage from 6 V to 18 V. Connecting the PC via the USB cable while the board is powered via a battery is no problem at all. The order does not matter, first USB then battery, or vice versa, both will work.
For the motors the 5 V supply of the USB bus is too low. So, the motors will work only if a battery with sufficient voltage is connected. This is btw the reason why the firmware should be flashed using USB power only, as we do not want the motors to get power in this case. Connecting the PC via the USB cable while the board is powered via a battery is no problem at all. The order does not matter, first USB then battery, or vice versa, both will work. The battery connector can handle any voltage from 6 V to 18 V.
 
The 3.3 V power supply on the v1.3x STorM32 boards is typically relatively weak and may not be able to power all accessories, such as the NT modules, Bluetooth module, and Spektrum satellite. A 5 V BEC should then be used for powering the NT modules (see also the scheme in [[What is STorM32 NT about%3F]]). Power limitations seem to be reported more often for v1.31 boards than for v1.3 boards.
 
This does not apply to v3.x and v4.x STorM32 boards; they do have a 5 V BEC capable of 0.6 A (or more) on board.


=== Motor Connectors ===
=== Motor Connectors ===


The board has three connectors for the motors labeled Mot0, Mot1 and Mot2. Before connecting any motor, it is a good idea to measure the resistance of the motor windings and the motor frame. The three motor cables should have an electrical resistance of 12 Ohm or more and be completely isolated from the motor housing. If the resistance is too low, the amount of amps flowing through the motor might be too high for the board driver. If one of the motor cables is connected to the motor housing, the entire gimbal and maybe even the frame gets the motor voltage.
Before connecting any motor, it is a good idea to measure the resistance of the motor windings and housing. The three motor cables should have an electrical resistance of about 10 Ohm and be completely isolated from the motor housing. If the resistance is too low, the amount of amps flowing through the motor might be too high for the motor drivers. The current capability of course depends on the type of STorM32 board or NT Motor module which is used; the 10 Ohms are a good figure-of-merit. If one of the motor cables has a short to the motor housing, the entire gimbal and maybe even the frame gets the motor voltage and the electronics may be destroyed.


The usage of the three connectors is
The v1.3x and v4.1 STorM32 boards have three connectors with three pins each for the motors labeled Mot0, Mot1 and Mot2. The usage of the three connectors is
* Mot0: Pitch motor to point the camera up/down
* Mot0: Pitch motor to point the camera up/down
* Mot1: Roll motor to stabilize the horizon
* Mot1: Roll motor to stabilize the horizon
* Mot2: Yaw motor to turn the camera left/right
* Mot2: Yaw motor to turn the camera left/right
The motors have to be connected in this order to the motor ports. The three wires of a motor in contrast can be connected to its port in any order, here the order does not matter.
Alternatively, one of course can use NT Motor modules. Any combination is possible, one motor module for pitch and Mot1, Mot2 for roll and yaw, or two motor modules for pitch and roll, and Mot2 for yaw, or whatever fits your needs best.
Users of a v3.x STorM32 board, or of T-STorM32, need to use NT Motor modules in any case.
{{COMMENT|Ensure that the NT Motor modules are properly configured, i.e., that the ID solder pads are closed/opened as needed.}}


=== Summary ===
=== Summary ===


Now the motors are connected, the IMU(s) are connected, the battery power cable is ready, and its polarity double-checked.
Now all motors and the IMU(s) are connected, the battery power cable is ready, and its polarity double-checked. You are ready for the next steps.
 
::[[File:Storm32-wiki-a-1-02.jpg|480px]]
 
== Basic Controller Configuration ==
 
{{COMMENT|T-STorM32 users please refer to the article [[Getting Started with T-STorM32]]}}.
 
{{COMMENT|The {{GUI|Configure Gimbal Tool}} can be used also for 2- and 1-axis gimbals; in the following a 3-axis gimbal is assumed.}}
 
Now it's time to set the most important parameters, namely the IMU orientations and motor parameter values, which are located in the {{GUI|Gimbal Configuration}} tab. Without that, the controller can't do even the most basic operations. Setting these parameters correctly by hand is difficult, however, the GUI provides the {{GUI|Configure Gimbal Tool}}, which makes this very simple.
 
Again: The parameters in the {{GUI|Gimbal Configuration}} tab must all be configured correctly; otherwise the gimbal will just not work correctly.


{{WARNING|The picture is confusing as regards the pitch and roll motor connections, it should be pitch-roll-yaw.}}
You should be prepared to know the number of poles of your motors, as well as be ready to connect a battery on demand (if you haven't already plugged in a battery).
[[File:0connections.JPG|none|480px]]


== First Configuration ==
{{WARNING|In the following the gimbal '''MUST''' be at rest and '''NOT''' be moved at any time (unless you're specifically asked to do differently).}} Specifically, don't hold the gimbal in your hands. {{WARNING|Also, a camera must be installed in the gimbal.}} Without camera gimbals don't work properly.


{{COMMENT|Since v0.57e a new {{GUI|Configure Gimbal Tool}} is implemented, which further simplifies setup enormously (see [[Quick Start Guide]]). The first steps are however essentially identical to those described here.}}  
# Change to the {{GUI|Gimbal Configuration}} tab. There you find the parameter fields for the IMU orientations, motor poles, motor directions and motor startup positions. To set them, run the {{GUI|Configure Gimbal Tool}} by hitting the so named button. [[File:Storm32-wiki-c-1-01.jpg|none|360px]]
# In the welcome screen you can select what to configure. The individual steps are grouped into '''Steps I''' and '''Steps II''', and some finishing steps. You want to do all, and hence just click on {{GUIFIELD|Continue}}. [[File:Storm32-wiki-c-2-01.jpg|none|360px]]
# You are now asked to position the gimbal and camera. The gimbal should be in its standard default position. Adjust the camera manually such that it is level and points to the forward direction of your copter. You might not be able to do that perfectly because of the motor magnets, but you should get that better than to within 15°. Once the camera is in forward position click on {{GUIFIELD|Continue}}. [[File:Storm32-wiki-c-3-01.jpg|none|360px]] [[File:Gimbal config tool forward.jpg| none | 500px]]
# Now you are asked to pitch the entire frame inclusive camera downwards by 45°, as if you would want to film the ground in front of the copter. So you lift the frame such that both, frame and camera, point downwards. Importantly, the camera should not move and keep its position relative to the frame. If it does move then you should consider balancing the camera better. Also, avoid roll movements. Anyway, the goal in this step is to measure the effect of a downturn by 45° degree on the IMU's signals. <!--The IMUs do measure the acceleration values, and as we are static its the earth gravity. For example, the reading in normal position might be x/y/z = 0 g/1 g/0 g. When pitching downwards, the values may change to 0.7 g/0.7 g/0 g, and from that we know the IMU's orientations.--> [[File:Storm32-wiki-c-4-01.jpg|none|360px]] [[File:Gimbal config tool 45.jpg| none | 500px]]
# Once the IMU orientations were determined, their values are shown and you can (should) put the gimbal back to normal position. When you can continue with the next step. [[File:Storm32-wiki-c-5-01.jpg|none|360px]]
# The next important step is to set the motor pole counts for each motor. This is information you should get from the motor vendor. Data like N12P14 means 14 poles. [[File:Storm32-wiki-c-6-01.jpg|none|360px]]
<!--
# We are now informed that all motor direction values will be set to {{PARAMVALUE|auto}}. [[File:Storm32-wiki-c-7-01.jpg|none|360px]]-->
# On the next screen you are informed that all motor direction values will be set to {{PARAMVALUE|auto}}. Click {{GUIFIELD|Continue}}.
# This completes the settings of '''Steps I''', and you can proceed with adjusting the parameters of '''Steps II'''. [[File:Storm32-wiki-c-8-01.jpg|none|360px]]
# For the next steps to work, the gimbal has to be started up with enabled motors, and a battery must be connected. The GUI will check for that, and will ask you to connect a battery if required. Do as advised. [[File:Storm32-wiki-c-9-01.jpg|none|360px]]
# The gimbal will now go through it's initialization steps, which you can follow in the screen. Please wait until it reaches the NORMAL state. You should see the green LED go solid, as well as hear a beep. You are reminded to keep the gimbal in normal position and at rest during all this.<br>{{WARNING|If this step doesn't complete or an error occurs see the [[#Basic_Controller_Configuration_Quick_Trouble_Shooting|Quick Trouble Shooting]] section below, and please take any recommendations from there seriously.}}  [[File:Storm32-wiki-c-10-01.jpg|none|360px]]
<!--
# We are now informed that the motor direction values will be set for all motors. [[File:Storm32-wiki-c-11-01.jpg|none|300px]]
-->
# On the next screen you are informed that the motor direction values will be determined for all motors. Click {{GUIFIELD|Continue}}.
<!--# We are now informed that the motor startup positions for the pitch and roll motors are set. [[File:Storm32-wiki-c-12-01.jpg|none|300px]]
-->
# In a further screen you are informed that the motor startup positions for the pitch and roll motors are determined. Click {{GUIFIELD|Continue}}.
# Now you are asked for another important step, namely to align the camera such as to point forward. Use the buttons to turn the camera until you're satisfied. The goal of this step is to align the camera with the 2nd IMU. A precise alignment is required for the 2nd IMU function to work correctly. You don't have to overdo however, a visual accuracy of the alignment is sufficient. [[File:Storm32-wiki-c-13-01.jpg|none|360px]]
# This completes the settings of '''Steps II'''. What is left is to store all values in non-volatile memory, and to restart the gimbal. [[File:Storm32-wiki-c-14-01.jpg|none|360px]]
# The results of the above steps can be seen in the {{GUI|Gimbal Configuration}} tab, which got updated with the new IMU orientations and motor parameters. Also the motors are enabled, and the system is functional now. [[File:Storm32-wiki-c-16-01.jpg|none|360px]]


Let's first check if the STorM32-BGC is operational.
# Disconnect the USB cable and click on the com port selector at the very bottom. Remember the list. [[File:Board read 0.png|none|300px]]
# Plug in the STorM32 board via the USB cable to power it. Either the matching driver was installed already or it will be installed now. Either way once windows has installed the driver when clicking on the drop down for the com port selector, it should now show an additional one.[[File:Board read 1.png|none|300px]]
# Jump back to the {{GUI|Main tab}} and click on {{GUI|Read}} to validate the connection with the board. [[File:Board_read_2.png|none|300px]]


Now it's time to set the most important parameters, namely the IMU orientations and motor parameter values. Without that the controller can't perform the basic operations even. With the {{GUI|Configure Gimbal Tool}} this is very simple.
<span id="Basic_Controller_Configuration_Quick_Trouble_Shooting">'''Quick Trouble Shooting:'''</span><br>
It may happen that the tool gets stuck in step 10. This generally indicates a serious problem with the setup, and not the controller. Examples are:
* Motors are not connected to the correct ports.
* Motors are not working properly because of e.g. a broken wire or bad connection.
* The IMU(s) do not work properly because they are connected to the wrong ports, or step 4 wasn't done correctly.
* I2C errors occur because of inappropriate routing of motor and I2C cables (consult also the [[I2C Error Compendium]]).
* PID parameters are totally wrong for the gimbal.
* Read also the [[#First_Startup_Quick_Trouble_Shooting|Quick Trouble Shooting]] section in the next chapter!


# Change to the {{GUI|Gimbal Configuration}} tab. There you can enter the values for the motor poles, the motor directions and the IMU orientation manually, or run the {{GUI|Configure Gimbal Tool}}. [[File:Gimbal config tool 1.png|none|300px]]
'''Related wiki article:'''
# In the welcome screen you can select what to configure, we want to do all and hence click on {{GUI|Continue}}. [[File:Gimbal config tool 2.png|none|300px]]
* [[Quick Start Guide]]
# Next we are asked to position the gimbal to look forward. So you manually adjust the camera so that it points into the forward direction of your copter. You might not be able to do that perfectly because of the motor magnets, 15° is more than enough. Once the camera is in forward position click on {{GUI|Continue}}. [[File:Gimbal config tool 3.png|none|300px]] [[File:Gimbal config tool forward.jpg| none | 500px]]
# Now you are asked to pitch the frame, the entire copter, by 45° downward, as if the goal would film the ground in front of the copter. So you lift the frame accordingly and both, frame and camera should point downwards. To be more precise, the camera should not move relative to the frame. If it does you should consider balancing the camera better. Anyway, the entire goal in this task is to get a clear reading of which axis of each IMU are all impacted by this 45° degree movement. The IMU does measure the acceleration values, as we are static its only acceleration is the earth gravity. For example the reading in the forward position might be x/y/z=0g/1g/0g. When pitching downward, the value could change to 0.7g/0.7g/0g and therefore we know that the pitch axis is along the z axis, its reading did not change (much). This plus the +/- sign allows to derive the IMU orientation by simply measuring it. [[File:Gimbal config tool 4a.png|none|300px]] [[File:Gimbal config tool 45.jpg| none | 500px]]
# Once the IMU orientation was read, the values are shown and we can continue with the next step. [[File:Gimbal config tool 4.png|none|300px]]
# This is just informational that the motor direction values are all being set to Auto. [[File:Gimbal config tool 5.png|none|300px]]
# Last step is the motor pole counts for each motor. This is again information you should get from the motor vendor, data like N12P14, meaning 14 poles. [[File:Gimbal config tool 6.png|none|300px]]
# With this the basic parameters are set but not stored permanently in the board. So you click on {{GUI|Okay}} to close the wizard. [[File:Gimbal config tool 7.png|none|300px]]
# The setup screen got updated now with the provided IMU, IMU2 and motor pole counts for each motor. All motors are disabled and the direction set to Auto. [[File:Gimbal config tool 8.png|none|300px]]
# In order to make these settings permanently stored, tick the checkbox next the {{GUI|Write}} button and the button will change its label to {{GUI|Write+Store}}. Press that button and the values get saved in the board's EEprom. [[File:Gimbal config tool 9.png|none|300px]]
# Attention: These values are used at startup only. Hence you have to reset the board! [[File:Gimbal config tool 10.png|none|300px]]


== First Startup ==
== First Startup ==


{{COMMENT|Since v0.57e a new {{GUI|Configure Gimbal Tool}} is implemented, which further simplifies setup enormously (see [[Quick Start Guide]]). The steps described here are now integrated into the new {{GUI|Configure Gimbal Tool}}.}}
After the above steps were completed, the STorM32 controller was reset and hence will start up now (the following applies to any startup however).
 
At startup, the controller goes through its initialization steps, which typically takes about 20 - 25 seconds (after configuration and tuning has been finished, the startup time can be cut down massively with proper parameter settings). Note that the gimbal must not be moved until the initialization is finished and the controller has reached normal operation. This is indicated by the green LED going solid, and - if enabled - by a beep.
 
'''Initialization Steps:'''


With above steps completed, plug in the battery in order to get power to the motors. Remember, the motor outputs had been disabled in the above step. Now position the camera to look forward by hand and then enable the motors. In the {{GUI|Setup}} tab check that the {{GUI|Pitch Usage}}, {{GUI|Roll Usage}} and {{GUI|Yaw Usage}} parameter fields are all set to {{GUIPARAM|disabled}}. Change them to {{GUIPARAM|normal}} individually. Or better, click on {{GUI|Enable all Motors}}, and write and store the changed setting. Without writing the values all you did is changing the values on your computer. Without the store the changes are not saved permanently in the controller's EEprom. The controller will now go through its initialization steps.
strtMOTOR - SETTLE - CALIBRATE - LEVEL - AUTODIR - RELEVEL - NORMAL
* {{PARAMNAME|strtMOTOR}}: The motors are turned on, and moved into the position specified by the startup motor position parameters.
* {{PARAMNAME|SETTLE}}: In order to calibrate, the gimbal has to be stable, it should not be moved. For a copter that is quite simple as the copter is on the ground. A handheld device needs to be put at a table to remain in position for a few seconds.
* {{PARAMNAME|CALIBRATE}}: Calibrates the sensors. Takes a second or so.
* {{PARAMNAME|LEVEL}}: This is the point where the motors are moved such as to level the camera in the pitch and roll axis. The yaw motor is under power, so you can feel some resistance, but it is not moved.
* {{PARAMNAME|AUTODIR}}: Here the motors are moved slightly around and from the sensor changes the controller determines the motor directions.  
* {{PARAMNAME|RELEVEL}}: Since autodir moved the camera, it is quickly brought back in a horizontal position.
* {{PARAMNAME|NORMAL}}: This is the final stage; the PID controller is activated and the gimbal is operational. Whatever you do, the camera should remain now stable.  


'''Initialization Steps:''' strtMOTOR - SETTLE - CALIBRATE - LEVEL - AUTODIR - RELEVEL - NORMAL
'''Led Signals''':
* strtMOTOR: The motors are turned on, and moved into the position specified by the startup motor position parameters.
* SETTLE: In order to calibrate, the gimbal has to be stable, it should not be moved. For a copter that is quite simple as the copter is on the ground. A handheld device needs to be put at a table to remain in position for a few seconds.
* CALIBRATE: Calibrates the sensors. Takes a second or so.
* LEVEL: This is the point where the motors will moved such to level the camera in pitch and roll axis. The yaw motor is under power, so you can feel some resistance, but it is not moved.
* AUTODIR: Here the motors are moved slightly around and from the sensor changes the controller determines the motor directions.
* RELEVEL: Since autodir moved the camera, it is quickly brought back in a horizontal position.
* NORMAL: This is the final stage; the PID controller is activated and the gimbal is operational. Simply move the camera out of position by hand, move the frame,... whatever you do the camera should remain stable. With a 2nd IMU enabled you can pitch the camera indefinitely, you can yaw the camera indefinitely or roll the camera by maximal +-80° or so. More roll is not possible as then the pitch and yaw axes become aligned, and pitch and yaw movements cannot be distinguished anymore.


'''Led Signals''': The progress of the initialization is also indicated by the green LED on the board: During initialization it flashes with varying frequency; when initialization has finished and NORMAL state been reached, it goes solid. By the way, if beepes are activated, the motors will emit a sound at the end of initialization, which can be very convenient. The current state can also be seen in the GUI.
The progress of the initialization is also indicated by the green LED on the board: During initialization it flashes with varying frequency. When initialization has finished and NORMAL state been reached, it goes solid. If beeps are activated, then the motors will emit a sound at the end of initialization, which can be very convenient. The current state of the controller can also be seen in the status line the GUI, or the Data Display. The red LED blinks with a frequency of 1 Hz, except in certain fault conditions or special states, in which case it blinks very fast.


In the past, the first startup was often problematic for users and after lots of debugging the same root causes were identified: Motor directions, IMU orientation and occasionally the motor pole count. Therefore the {{GUI|Configure Gimbal Tool}} was implemented and all these problems should be gone now. Nevertheless some trouble shooting hints:
'''Operational Range''':


'''Quick Trouble Shooting:'''
With a 2nd IMU enabled you can pitch and yaw the camera indefinitely. Without 2nd IMU, the pitch range is limited to +-45°. In either case the roll angle is limited to maximal +-80° or so. Larger roll angles are not possible due to [http://en.wikipedia.org/wiki/Gimbal_lock gimbal lock] (either mechanically or electronically).  
* The gimbal controller levels the camera, but only very, very slowly: The gimbal is moved before the initialization has finished. Wait until the NORMAL state has been reach (green LED = solid) before moving the gimbal.
 
* The gimbal moves constantly around, never finding the level position: The pitch and roll motors are not connected to Mot0 (Pitch) and Mot1 (Roll) but reverse. Hence the control logic does measure that pitch has to be changed by -5°, applies the proper movement sequence to the motor but all that happens is that suddenly the roll value is off by -. Make sure the motors are connected correctly.
{{COMMENT|T-STorM32 gimbals have a much larger operational range, and do not need a 2nd IMU.}}
* Camera turns upside down or things like that: The IMU orientation is wrong.
* Gimbal starts shaking, makes high frequency noises and things like that: This would be normal as we have not yet tuned the PID values for the motor control loop. In case that happens, set for all motors the P, I and D values to very low numbers but not zero (P=0.10; I=5.0; D=0.0050) and write them to the board. This will cause the gimbal to be slow when correcting movements but at least you can prove all is functional.


We can save some time during the startup if we would speedup the leveling and the motor directions. For this we have three options in the {{GUI|Tools}} menu.
'''Yaw Axis Alignment''':
[[File:Gimbal config motor directions.png|none|300px]]


# {{GUI|Get Current Motor Directions}}: Since the gimbal is now in a normal operation, the AUTODIR phase was completed, it knows the directions. By selecting this menu the motor directions in the {{GUI|Gimbal Configuration}} tab are changed from {{GUIPARAM|auto}} to their actual direction {{GUIPARAM|normal}} or {{GUIPARAM|reverse}}.
With a 2nd IMU enabled, it is very important that the camera is aligned properly with respect to the gimbal support '''''before''''' the gimbal is powered up. You typically do this by hand. It is sufficient to have the camera aligned to within typically +-25° (for a 14 pole yaw motor). When the controller is powered up, it first moves the motors, and the camera should now precisely point forward (to within a degree or so).
# {{GUI|Get Current Pitch and Roll Motor Positions}}: Initially the gimbal does not know the current motor position. So it powers the motor's windings to assume a default position. Now that the gimbal is level, we know the motor positions default. Hence we can take the current position as {{GUIPARAM|Pitch Startup Motor Pos}} and {{GUIPARAM|Roll Startup Motor Pos}}
# {{GUI|Adjust Yaw Startup Motor Pos Parameter Tool}}: Yaw is a different story. The current yaw value cannot be zero'ed in as there is no sensor telling what "forward" means. Hence the motor start position is the only way but using what value? With the yaw tool you can manually move the gimbal in yaw to bring it into the forward position and then safe that as the {{GUIPARAM|Yaw Startup Motor Pos}}.


Don't forget to {{GUI|Write+Store}} these values permanently by ticking the checkbox next to the {{GUI|Write}} button to change its label and click that button.
{{COMMENT|Does not apply to T-STorM32 gimbals, these do nicely align the camera themselves from any starting position.}}


Related wiki articles:
<span id="First_Startup_Quick_Trouble_Shooting">'''Quick Trouble Shooting:'''</span>
* [[STorM32_FAQ#How_does_Read.2C_Write.2C_and_Store_work.3F|FAQ: How does Read, Write, and Store work?]]
* The gimbal controller levels the camera, but only very, very slowly: The gimbal had been moved before the initialization has finished. Wait until the NORMAL state has been reach (green LED = solid) before moving the gimbal.
* The gimbal moves constantly around, never finding the level position: The pitch and roll motors are not connected to Mot0 (Pitch) and Mot1 (Roll) but reverse. Hence the control logic does measure that pitch has to be changed by -5°, applies the proper movement sequence to the motor but all that happens is that suddenly the roll value is off by -5°. Make sure the motors are connected correctly.
* Camera turns upside down or things like that: The IMU orientation is wrong.
* Gimbal starts shaking, makes high frequency noises and things like that: This would be normal as we have not yet tuned the PID values for the motor control loop. In case that happens, set for all motors the P, I and D values to very low numbers but not zero (P=0.10; I=5.0; D=0.0050) and write them to the board. This will cause the gimbal to be slow when correcting movements but at least you can prove all is functional.
* The motors receive power only briefly after startup but are when shut off and the red and green led start blinking fast, and the controller remains in LEVEL state: The controller could not level the camera within a certain time and hence shut off the motors for safety. This can happen for various reasons, such as that there is a mechanical constraint to the camera, one or more motors do not operate properly because of e.g. a broken motor wire or bad connections, or that the gimbal has not been assembled fully.


== Next Step - PID Tuning ==
== Next Step - PID Tuning ==


At this point the gimbal may already stabilize the camera. However, usually, the camera is not yet stabilized perfectly, or the gimbal may even start to show weird shaking or make high frequency noises. This indicates that the PID values in the {{GUI|Main}} tab are not proper.
At this point the gimbal may already stabilize the camera. However, usually, the camera is not yet stabilized perfectly, since the PID parameters in the {{GUI|PID}} tab are not yet optimal. The gimbal may even start to show weird shaking or make high frequency noises, which indicates that the PID values are totally off. So, in any case the next step should be to tune the gimbal.


See the PID parameter [[Tuning Recipe|Tuning Recipe]] for adjusting those.
See the PID parameter [[Tuning Recipe|Tuning Recipe]] for adjusting those.
You are also '''''strongly''''' encouraged to check out the [[Video Tutorials|Video Tutorials]]; there is a collection of some quite good videos available.
{{COMMENT|{{WARNING|'''For good camera stability you need to spend at least a minimum time with PID tuning.'''}} The default PID values are chosen such that they work with most gimbals in the sense that the gimbal doesn't freak out. They therefore are necessarily "bad" in terms of good PID control or camera stabilization, respectively.}}

Latest revision as of 18:39, 18 June 2024

by Yang/wdaehn and OlliW, descriptions refer to firmwares v2.xx

You have a gimbal, the STorM32 controller board, the IMU module(s) and all cables. So what is next? This page is intended to guide you through the essential steps, provide you with the most relevant information, and give references to the more specific pages in case you want or need to know more.

Opening Remarks

If you are new to gimbals, then the Gimbal 101 by rcgroups user mike_kelly is a much recommended reading. It provides a wealth of information in a very readable way.

The following tutorial is for users of a conventional STorM32 NT setup (= non-encoder setup).

If you are using a T-STorM32 setup (= encoder setup), then not all info given here does apply. Please read the article Getting Started with T-STorM32, and in case of conflicting info go with the info given there.

Ordering Information

Things to order at minimum:

  • STorM32 controller board (v1.3x, v3.3 or v4.1, and compatible boards; older boards are not supported)
  • NT IMU module and matching cable
  • USB-to-TTL adapter (not required for some v3.x and the v4.x boards, but always handy to have anyway)

Users of v3.x STorM32 boards (all variants) in addition need to order:

  • three NT Motor modules or NT Motor-Encoder modules

The STorM32 controller board can be obtained from various sources. There are several hardware revisions around. The 50x50 mm-sized v1.3 and v1.32 boards or one of the various v3.3 boards (available in 40x25 mm and 25x25 mm sizes) or the 40x28 mm-sized v4.1 board are the best options. The wide-spread v1.31 board is a good starting point too, but when used in a NT setup issues with its too weak 3.3 V power were reported (see Boards: GLB STorM32 v1.31). For other boards you may want to check the Boards page or the internet. A v1.3 board is used exemplarily below.

Comment: Vendors sell all sorts of boards and call them v1.3, v1.31, or v1.32, but they may not be identical to the "legit" versions but show hardware variations. This can result in different behavior than described in this wiki, and thus user irritations, but that's how it is.

In addition to the STorM32 controller board you also need a NT IMU module and a matching cable. The plug on the v1.3x STorM32 boards is a Picoblade connector (often incorrectly called JST 1.25). The standard plug on the v3.x and v4.x boards is a JST SH connector (often called JST 1.0); however, which plug is used on STorM32 derivatives depends a lot on the manufacturer.

Finally, users of a v1.3x STorM32 board also require a USB-TTL adapter with a matching cable for upgrading the STorM32 board to the latest firmware. It can be any USB-TTL adapter with FTDI or CP2102 or CH340 chip, but NOT a PL2303-based adapter (for details please see FAQ: Which USB-TTL adapter should I use?). If you do not happen to have one already, then buy one together with the other parts. Users of the Micro STorM32 board or STorM32 RaspberyPi Hat also need a USB-TTL adapter. Users of v3.x or v4.x STorM32 boards do not need a USB-TTL adapter (these boards do have the adapter integrated on board).

Users of v3.x STorM32 boards (all variants) need three NT Motor modules in addition (the v3.x boards do not have motor drivers on board).

Related wiki articles:

Dos and Don'ts

 Read and comprehend the Dos and Don'ts.

Supported Gimbals

The STorM32 controller currently supports the following setups:

  • 3-axis with camera IMU: Uses only one IMU (aka camera IMU), which is connected to the NT bus and mounted to the camera.
  • 3-axis with camera & on-board IMU: In addition to the camera IMU, the STorM32 on-board IMU is used as 2nd IMU. The STorM32 board must be mounted on the gimbal above the yaw motor.
  • 3-axis with camera & separate 2nd NT IMU: In addition to the camera IMU, a further NT IMU module connected to the NT bus is used as 2nd IMU. The STorM32 board can be mounted anywhere, but the 2nd IMU must be mounted on the gimbal above the yaw motor.
  • 2-axis and 1-axis: For some 2-axis gimbal configurations a 2nd IMU is supported (either on-board or separate 2nd NT IMU); for some not or only partially. For 1-axis gimbals a 2nd IMU is not supported. All 2- and 1-axis configurations can work with only a camera IMU. Unused motors must be disabled.

In this article a 3-axis gimbal is assumed throughout.

In the following, a 2nd IMU is not needed. However, if you plan to use one, then you may want to have it installed and connected, so that the [GUI:Configure Gimbal Tool] can auto-determine its orientation, but it should be disabled for the following.

The gimbal should be in pitch-roll-yaw configuration. Other configurations such as pitch-yaw-roll or roll-pitch-yaw are not officially supported by the STorM32 controller (for further details you may read [1]).

The gimbal can be in the "down-hanging" or the "up-standing" position, it works perfectly fine either way.

Comment: The support of 2- and 1-axis gimbals is somewhat varying. That is, they all can be operated, but due to the large manifold of operating situations testing is challenging and the firmware might not be totally bug free, and also features may be missing depending on the specific configuration. Please report any bugs or missing feature to the rcgroups discussion thread. Also note that the [GUI:Configure Gimbal Tool] does not support all possible gimbal configurations, but just a subset.

Calibration

The accelerometers within the IMU modules need to be calibrated for optimal performance, e.g. to achieve a good horizon behavior. The calibration is most easily done with the gimbal not yet fully assembled. However, the gimbal will work also with uncalibrated sensors, i.e. calibration is not mandatory for the setup steps to work. You thus can freely decide if you prefer to do the calibration now or later - as long as you do a calibration at some point in time!

Related wiki articles:

Flashing Firmware

As first step it is recommended to flash the latest firmware.

Your STorM32 board may or may not come with a firmware loaded; this depends on the vendor (nowadays they usually come with firmware loaded). If a firmware is already loaded then you could skip the flashing steps and just install the GUI, but it is recommended to carry them out nevertheless, in order to benefit from the latest firmware and GUI. If no firmware is loaded then you must go through the flashing steps; without firmware the board obviously won't work.

During the flashing procedure the USB driver for the STorM32 board may be installed by Win 7/8/10/11; see the red warnings in the descriptions. It is crucial to not interrupt the USB driver install process. It can take several minutes, so please be patient; let Windows do its job, for however long it takes.

The flashing procedure is quite different for the v1.3x and v3.x/v4.x STorM32 boards:

Related wiki articles:

Checking Connection to the GUI

Next, let's check if the STorM32 controller is indeed operational, and communicates with the GUI. Note that the firmware and GUI versions must match. If they do not match, the GUI will tell you the versions it expects, but may refuse to work.

This is a good occasion to also learn about the usage of the [Read], [Write] and [Write+Store] buttons: Please read the FAQ: How does Read, Write, and Store work?.

To check the connection, follow these steps:

  1. If a USB cable is connected to the STorM32 board, disconnect it. Click on the [Port] selector in the left bottom and memorize the list.
    Storm32-wiki-gettingstarted-checkconnection-1.jpg
  2. Now plug in the STorM32 board via the USB cable to power it. When clicking on the drop down for the [Port] selector, it should show an additional one.
    If the board has a firmware installed and this is the first-time connection via USB to your PC, then Windows will install the USB driver for the STorM32 board. This can take quite some time. Do NOT interrupt the install process.
    Storm32-wiki-gettingstarted-checkconnection-2.jpg
  3. Go to the [GUI:Main] tab and click on [Connect] or [Read] to validate the connection with the board.
    Storm32-wiki-gettingstarted-checkconnection-3.jpg

Quick Trouble Shooting:

  • Wrong COM port selected.
  • Firmware and GUI version numbers do not match.

Related wiki articles:

Hardware Setup

The Camera IMU

The camera IMU needs to be mounted such that it measures all camera movements. Its actual position does not matter, behind the camera, on the pitch arm, below the camera,... anything will work. The only thing to watch out for is that its axes are aligned with the camera axes. Each axis has to be either horizontal or vertical. Just imagine that the sensor would measure that the horizon is level but because of a misalignment the camera does hang slightly to one side and hence the horizon in the video is not level.

Thanks to the NT concept, there are essentially no limits on how to wire the cables (in contrast to the older I2C-based approach, which often was prone to I2C errors).

Mounting the STorM32 Board

One of the outstanding features of the STorM32 board is its 2nd IMU support. In fact, most STorM32 boards do have a 2nd IMU on-board already. To make use of it, the STorM32 board needs to be mounted such that it measures the movements of the copter frame ("above" the yaw axis). The board's location does not matter, as long as it measures the frame's movements. In case this is not possible, another external IMU can be mounted to the frame and connected to the STorM32 board. As for the camera IMU, also the axes of the 2nd IMU have to be vertical or horizontal, respectively.

Comment: T-STorM32 does not make use of a 2nd IMU, and the STorM32 board can thus be placed in any location or orientation which is convenient.

Related wiki articles:

Electric Connection and Insulation

The IMUs go to their corresponding plugs: The camera IMU, which must be a NT IMU module, goes to the NT bus. If a 2nd IMU shall be used, then you have 2 options: (i) A further NT IMU module connected to the NT bus in parallel to the camera IMU; (ii) if an extrenal 2nd IMU is not found the on-board IMU is selected, if available.

Make sure that the IMUs are mounted rigidly, so that they measure the actual position.

Comment: Check that the NT IMU modules are configured properly, i.e., that the ID solder bridge is closed for the 2nd IMU.

Comment: If starting from a "classic" (non-NT) STorM32 gimbal kit with an I2C IMU module, it can be necessary to rewire one end of the stock I2C cable to match the pinout of the NT bus. Releasing the pins on a picoblade connector is best done using a needle, a craft knife, or similar tool that can lift the release catch holding the crimped picoblade connector.

Storm32-nt-v130-ports-and-connections-01.jpg

Related wiki articles:

Gimbal Mechanics

Before using a gimbal, it is absolutely mandatory to balance it and to ensure minimum resistance to rotations (friction in bearings, stiff cables, etc). The importance of these points cannot be overstressed. Any improper balance or resistance to rotation will compromise the performance of the gimbal, and make setting up the gimbal more difficult or even impossible. The goal shall be to rotate the camera in the gimbal and it should stay in that position by itself. In other words, the center of gravity should be in the center of all gimbal motor axes. Just imagine the camera's center of gravity is way below the pitch axis (looking with the camera up and down). It would act like a pendulum. So just because your copter does accelerate forward, the gimbal pitch motor has to hold against the mass inertia. You will need very strong motors and lots of energy which is a waste. On the other hand, if the gimbal is balanced properly, the motor only has to compensate the copter rotations, wind resistance and inertia when rotating the camera to point to somewhere else.

Related wiki articles:

Powering the Gimbal

For the motors the 5 V supply of the USB bus is too low. So, the motors will work only if a battery with sufficient voltage is connected. This is btw the reason why the firmware should be flashed using USB power only, as we do not want the motors to get power in this case. Connecting the PC via the USB cable while the board is powered via a battery is no problem at all. The order does not matter, first USB then battery, or vice versa, both will work. The battery connector can handle any voltage from 6 V to 18 V.

The 3.3 V power supply on the v1.3x STorM32 boards is typically relatively weak and may not be able to power all accessories, such as the NT modules, Bluetooth module, and Spektrum satellite. A 5 V BEC should then be used for powering the NT modules (see also the scheme in What is STorM32 NT about?). Power limitations seem to be reported more often for v1.31 boards than for v1.3 boards.

This does not apply to v3.x and v4.x STorM32 boards; they do have a 5 V BEC capable of 0.6 A (or more) on board.

Motor Connectors

Before connecting any motor, it is a good idea to measure the resistance of the motor windings and housing. The three motor cables should have an electrical resistance of about 10 Ohm and be completely isolated from the motor housing. If the resistance is too low, the amount of amps flowing through the motor might be too high for the motor drivers. The current capability of course depends on the type of STorM32 board or NT Motor module which is used; the 10 Ohms are a good figure-of-merit. If one of the motor cables has a short to the motor housing, the entire gimbal and maybe even the frame gets the motor voltage and the electronics may be destroyed.

The v1.3x and v4.1 STorM32 boards have three connectors with three pins each for the motors labeled Mot0, Mot1 and Mot2. The usage of the three connectors is

  • Mot0: Pitch motor to point the camera up/down
  • Mot1: Roll motor to stabilize the horizon
  • Mot2: Yaw motor to turn the camera left/right

The motors have to be connected in this order to the motor ports. The three wires of a motor in contrast can be connected to its port in any order, here the order does not matter.

Alternatively, one of course can use NT Motor modules. Any combination is possible, one motor module for pitch and Mot1, Mot2 for roll and yaw, or two motor modules for pitch and roll, and Mot2 for yaw, or whatever fits your needs best.

Users of a v3.x STorM32 board, or of T-STorM32, need to use NT Motor modules in any case.

Comment: Ensure that the NT Motor modules are properly configured, i.e., that the ID solder pads are closed/opened as needed.

Summary

Now all motors and the IMU(s) are connected, the battery power cable is ready, and its polarity double-checked. You are ready for the next steps.

Storm32-wiki-a-1-02.jpg

Basic Controller Configuration

Comment: T-STorM32 users please refer to the article Getting Started with T-STorM32.

Comment: The [GUI:Configure Gimbal Tool] can be used also for 2- and 1-axis gimbals; in the following a 3-axis gimbal is assumed.

Now it's time to set the most important parameters, namely the IMU orientations and motor parameter values, which are located in the [GUI:Gimbal Configuration] tab. Without that, the controller can't do even the most basic operations. Setting these parameters correctly by hand is difficult, however, the GUI provides the [GUI:Configure Gimbal Tool], which makes this very simple.

Again: The parameters in the [GUI:Gimbal Configuration] tab must all be configured correctly; otherwise the gimbal will just not work correctly.

You should be prepared to know the number of poles of your motors, as well as be ready to connect a battery on demand (if you haven't already plugged in a battery).

In the following the gimbal MUST be at rest and NOT be moved at any time (unless you're specifically asked to do differently). Specifically, don't hold the gimbal in your hands. Also, a camera must be installed in the gimbal. Without camera gimbals don't work properly.

  1. Change to the [GUI:Gimbal Configuration] tab. There you find the parameter fields for the IMU orientations, motor poles, motor directions and motor startup positions. To set them, run the [GUI:Configure Gimbal Tool] by hitting the so named button.
    Storm32-wiki-c-1-01.jpg
  2. In the welcome screen you can select what to configure. The individual steps are grouped into Steps I and Steps II, and some finishing steps. You want to do all, and hence just click on [Continue].
    Storm32-wiki-c-2-01.jpg
  3. You are now asked to position the gimbal and camera. The gimbal should be in its standard default position. Adjust the camera manually such that it is level and points to the forward direction of your copter. You might not be able to do that perfectly because of the motor magnets, but you should get that better than to within 15°. Once the camera is in forward position click on [Continue].
    Storm32-wiki-c-3-01.jpg
    Gimbal config tool forward.jpg
  4. Now you are asked to pitch the entire frame inclusive camera downwards by 45°, as if you would want to film the ground in front of the copter. So you lift the frame such that both, frame and camera, point downwards. Importantly, the camera should not move and keep its position relative to the frame. If it does move then you should consider balancing the camera better. Also, avoid roll movements. Anyway, the goal in this step is to measure the effect of a downturn by 45° degree on the IMU's signals.
    Storm32-wiki-c-4-01.jpg
    Gimbal config tool 45.jpg
  5. Once the IMU orientations were determined, their values are shown and you can (should) put the gimbal back to normal position. When you can continue with the next step.
    Storm32-wiki-c-5-01.jpg
  6. The next important step is to set the motor pole counts for each motor. This is information you should get from the motor vendor. Data like N12P14 means 14 poles.
    Storm32-wiki-c-6-01.jpg
  7. On the next screen you are informed that all motor direction values will be set to “auto”. Click [Continue].
  8. This completes the settings of Steps I, and you can proceed with adjusting the parameters of Steps II.
    Storm32-wiki-c-8-01.jpg
  9. For the next steps to work, the gimbal has to be started up with enabled motors, and a battery must be connected. The GUI will check for that, and will ask you to connect a battery if required. Do as advised.
    Storm32-wiki-c-9-01.jpg
  10. The gimbal will now go through it's initialization steps, which you can follow in the screen. Please wait until it reaches the NORMAL state. You should see the green LED go solid, as well as hear a beep. You are reminded to keep the gimbal in normal position and at rest during all this.
    If this step doesn't complete or an error occurs see the Quick Trouble Shooting section below, and please take any recommendations from there seriously.
    Storm32-wiki-c-10-01.jpg
  11. On the next screen you are informed that the motor direction values will be determined for all motors. Click [Continue].
  12. In a further screen you are informed that the motor startup positions for the pitch and roll motors are determined. Click [Continue].
  13. Now you are asked for another important step, namely to align the camera such as to point forward. Use the buttons to turn the camera until you're satisfied. The goal of this step is to align the camera with the 2nd IMU. A precise alignment is required for the 2nd IMU function to work correctly. You don't have to overdo however, a visual accuracy of the alignment is sufficient.
    Storm32-wiki-c-13-01.jpg
  14. This completes the settings of Steps II. What is left is to store all values in non-volatile memory, and to restart the gimbal.
    Storm32-wiki-c-14-01.jpg
  15. The results of the above steps can be seen in the [GUI:Gimbal Configuration] tab, which got updated with the new IMU orientations and motor parameters. Also the motors are enabled, and the system is functional now.
    Storm32-wiki-c-16-01.jpg


Quick Trouble Shooting:
It may happen that the tool gets stuck in step 10. This generally indicates a serious problem with the setup, and not the controller. Examples are:

  • Motors are not connected to the correct ports.
  • Motors are not working properly because of e.g. a broken wire or bad connection.
  • The IMU(s) do not work properly because they are connected to the wrong ports, or step 4 wasn't done correctly.
  • I2C errors occur because of inappropriate routing of motor and I2C cables (consult also the I2C Error Compendium).
  • PID parameters are totally wrong for the gimbal.
  • Read also the Quick Trouble Shooting section in the next chapter!

Related wiki article:

First Startup

After the above steps were completed, the STorM32 controller was reset and hence will start up now (the following applies to any startup however).

At startup, the controller goes through its initialization steps, which typically takes about 20 - 25 seconds (after configuration and tuning has been finished, the startup time can be cut down massively with proper parameter settings). Note that the gimbal must not be moved until the initialization is finished and the controller has reached normal operation. This is indicated by the green LED going solid, and - if enabled - by a beep.

Initialization Steps:

strtMOTOR - SETTLE - CALIBRATE - LEVEL - AUTODIR - RELEVEL - NORMAL

  • strtMOTOR: The motors are turned on, and moved into the position specified by the startup motor position parameters.
  • SETTLE: In order to calibrate, the gimbal has to be stable, it should not be moved. For a copter that is quite simple as the copter is on the ground. A handheld device needs to be put at a table to remain in position for a few seconds.
  • CALIBRATE: Calibrates the sensors. Takes a second or so.
  • LEVEL: This is the point where the motors are moved such as to level the camera in the pitch and roll axis. The yaw motor is under power, so you can feel some resistance, but it is not moved.
  • AUTODIR: Here the motors are moved slightly around and from the sensor changes the controller determines the motor directions.
  • RELEVEL: Since autodir moved the camera, it is quickly brought back in a horizontal position.
  • NORMAL: This is the final stage; the PID controller is activated and the gimbal is operational. Whatever you do, the camera should remain now stable.

Led Signals:

The progress of the initialization is also indicated by the green LED on the board: During initialization it flashes with varying frequency. When initialization has finished and NORMAL state been reached, it goes solid. If beeps are activated, then the motors will emit a sound at the end of initialization, which can be very convenient. The current state of the controller can also be seen in the status line the GUI, or the Data Display. The red LED blinks with a frequency of 1 Hz, except in certain fault conditions or special states, in which case it blinks very fast.

Operational Range:

With a 2nd IMU enabled you can pitch and yaw the camera indefinitely. Without 2nd IMU, the pitch range is limited to +-45°. In either case the roll angle is limited to maximal +-80° or so. Larger roll angles are not possible due to gimbal lock (either mechanically or electronically).

Comment: T-STorM32 gimbals have a much larger operational range, and do not need a 2nd IMU.

Yaw Axis Alignment:

With a 2nd IMU enabled, it is very important that the camera is aligned properly with respect to the gimbal support before the gimbal is powered up. You typically do this by hand. It is sufficient to have the camera aligned to within typically +-25° (for a 14 pole yaw motor). When the controller is powered up, it first moves the motors, and the camera should now precisely point forward (to within a degree or so).

Comment: Does not apply to T-STorM32 gimbals, these do nicely align the camera themselves from any starting position.

Quick Trouble Shooting:

  • The gimbal controller levels the camera, but only very, very slowly: The gimbal had been moved before the initialization has finished. Wait until the NORMAL state has been reach (green LED = solid) before moving the gimbal.
  • The gimbal moves constantly around, never finding the level position: The pitch and roll motors are not connected to Mot0 (Pitch) and Mot1 (Roll) but reverse. Hence the control logic does measure that pitch has to be changed by -5°, applies the proper movement sequence to the motor but all that happens is that suddenly the roll value is off by -5°. Make sure the motors are connected correctly.
  • Camera turns upside down or things like that: The IMU orientation is wrong.
  • Gimbal starts shaking, makes high frequency noises and things like that: This would be normal as we have not yet tuned the PID values for the motor control loop. In case that happens, set for all motors the P, I and D values to very low numbers but not zero (P=0.10; I=5.0; D=0.0050) and write them to the board. This will cause the gimbal to be slow when correcting movements but at least you can prove all is functional.
  • The motors receive power only briefly after startup but are when shut off and the red and green led start blinking fast, and the controller remains in LEVEL state: The controller could not level the camera within a certain time and hence shut off the motors for safety. This can happen for various reasons, such as that there is a mechanical constraint to the camera, one or more motors do not operate properly because of e.g. a broken motor wire or bad connections, or that the gimbal has not been assembled fully.

Next Step - PID Tuning

At this point the gimbal may already stabilize the camera. However, usually, the camera is not yet stabilized perfectly, since the PID parameters in the [GUI:PID] tab are not yet optimal. The gimbal may even start to show weird shaking or make high frequency noises, which indicates that the PID values are totally off. So, in any case the next step should be to tune the gimbal.

See the PID parameter Tuning Recipe for adjusting those.

You are also strongly encouraged to check out the Video Tutorials; there is a collection of some quite good videos available.

Comment: For good camera stability you need to spend at least a minimum time with PID tuning. The default PID values are chosen such that they work with most gimbals in the sense that the gimbal doesn't freak out. They therefore are necessarily "bad" in terms of good PID control or camera stabilization, respectively.