Getting Started

by Yang/wdaehn and OlliW, descriptions refer to firmware v0.67e

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:

Ordering Information

Things to order at minimum:

STorM32-BGC board
IMU module and matching cable
USB-to-TTL adapter

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.

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 Picoblade connector (often, but incorrectly, called JST 1.25 connector).

Finally, a USB-to-serial adapter with a matching cable is required for flashing the latest firmware. It can be any FTDI or CP2102 adapter, but NOT a PL2303-based adapter. Again, if you do not have one already, it is recommended to buy one together with the other parts.

Things to watch out when comparing prices

Bluetooth module included? Most STorM32 boards are 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:

Dos and Don'ts

Read and comprehend the Dos and Don'ts.

Flashing Firmware

The STorM32 board has a very active community, and new firmware versions with new enhancements are released on about a monthly basis. So, the first step will be to flash the newest 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.

In order to flash a new firmware the following steps are recommended.

Get your USB-to-serial adapter to work by installing all Windows drivers as requested by the vendor.
Unplug (!) the USB-to-serial adapter again.
Connect the USB-to-serial adapter to the STorM32 board at the pins labeled RC (!). The firmware is NOT programmed via the UART port, NOT via the USB, but via the RC pins. In other words, when the board is put into bootloader mode, the RC pins are re-assigned to the microcontroller's UART1 as needed for flashing the firmware; normally they are assigned to the PWM timers.
Connect the STorM32 board via USB to the computer. We are not using this connection yet, but we power the board via USB.
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_v067e.exe program. It does not matter what the currently installed firmware is, you use the GUI that comes with the firmware zip file. Get the zip file from here: Downloads.
In the GUI select the [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.
In step two, the middle of the screen, there is a [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.
Plugin the USB-to-serial adapter and click again on the drop down box of the serial connector for programming. Select the new one.
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.
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.
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 [Flash Firmware] button.
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.
If this is a first-time flash of a "virgin" board, then Windows will start with installing the USB driver directly after the flash has finished. This can take quite some time. DO NOT interrupt the install process.
After the reset, your board is fully operational and you may disconnect the USB-to-serial adapter.

Quick Trouble Shooting:

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.
In case of troubles with the USB driver, it can be found here: STM download page, or see the FAQ: Which drivers are needed for the USB?.

It is also recommended to read the How to flash firmware page for trouble shooting.

Related wiki articles:

Checking Connection to the GUI

Let's next check if the STorM32-BGC is indeed operational, and communicates with the GUI. Note that firmware and GUI version must match.

If connected, disconnect a USB cable and/or USB-to-serial adapter. Click on the COM port selector in the left bottom and memorize the list.
Then plug in the STorM32 board via the USB cable to power it. When clicking on the drop down for the COM port selector, it should now 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.
Go to e.g. the [Main] tab and click on [Connect] or [Read] to validate the connection with the board.

It's a good occasion now to also learn about the [Read], [Write] and [Write+Store] buttons and to read FAQ: How does Read, Write, and Store work?.

Quick Trouble Shooting:

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

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.

A typical beginners mistake is to route the IMU cables in close proximity to the motor cables. This may however lead to I2C errors, and subsequent artifacts such as a "freezing" of the gimbal. If in doubt, please check the web, it is full of discussions on this topic, and/or consult the I2C Error Compendium.

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.

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 camera IMU must go to the port I2C, near the USB plug! Your board may have been shipped with a IMU pre-connected to port I2C#2, which is incorrect.

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.

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

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.

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. 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.

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 has a short to the motor housing, the entire gimbal and maybe even the frame gets the motor voltage.

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 motor wires of a motor can be connected to the respective connector in any order, the order does not matter.

Summary

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

Basic Controller Configuration

Now it's time to set the most important parameters, namely the IMU orientations and motor parameter values, which are located on the [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 [Configure Gimbal Tool], which makes that very simple.

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 all times (unless you're specifically asked to do differently).

Change to the [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 [Configure Gimbal Tool].
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].
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 into 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].
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.
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.
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.
On the next screen you are informed that all motor direction values will be set to "auto". Click [Continue].
This completes the settings of Steps I, and you can proceed with adjusting the parameters of Steps II.
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.
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.
On the next screen you are informed that the motor direction values will be determined for all motors. Click [Continue].
In a further screen you are informed that the motor startup positions for the pitch and roll motors are determined. Click [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.
This completes the settings of Steps II. What is left is to store all values in non-volatile memory, and to restart the gimbal.
The results of the above steps can be seen in the [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.

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:

Quick Start Guide

First Startup

After the above steps were completed, the STorM32 controller was reset and hence will start up now, and go through its initialization steps.

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 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. Larger roll angles are not possible as when the pitch and yaw axes become aligned, and pitch and yaw movements cannot be distinguished anymore (gimbal lock). Without 2nd IMU, the yaw and roll ranges are as before, but the pitch range is limited to +-45°.

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 status line the GUI, or the Data Display.

In the past, the basic configuration was often problematic for users and after lots of debugging the root causes were identified: wrong motor directions, wrong IMU orientation and occasionally wrong motor pole count. Therefore the [Configure Gimbal Tool] was implemented and these problems should be gone now. Nevertheless some trouble shooting hints:

Quick Trouble Shooting:

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 -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, or the gimbal may even start to show weird shaking or make high frequency noises. This indicates that the PID values in the [Main] tab are not proper.

See the PID parameter Tuning Recipe for adjusting those.

Comment: For good camera stability you need to spend at least some 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.

Getting Started

Contents

Ordering Information

Dos and Don'ts

Flashing Firmware

Checking Connection to the GUI