Using STorM32 with ArduPilot: Difference between revisions

From STorM32-BGC Wiki
Jump to navigation Jump to search
Tag: Manual revert
 
(470 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The STorM32 gimbal controller can communicate with an [http://ardupilot.org/ardupilot/index.html ArduPilot] flight controller via a serial data line. The serial communication allows for a much richer data transmission and accordingly richer set of features than possible with the traditional PWM connections. It also leads to a clean wiring.
''The information on this page refers to firmware v2.64e, and higher.''


Two aspects of the communication should be distinguished:
The STorM32 gimbal controller can communicate with an [http://ardupilot.org/ardupilot/index.html ArduPilot] flight controller via a serial UART data link. The serial communication allows for a much richer data transmission and accordingly richer set of features than possible with the traditional connections such as PWM, PPM, SBUS, CRSF, and alike.
* '''''Control of the gimbal:''''' The serial communication allows us to control the orientation of the gimbal, with higher precision than possible with the standard inputs, and gives access to all other features of the STorM32 controller, such as triggering a camera, executing on-board scripts, and so on. It also allows the STorM32 to feed back information to the flight controller and the ground station, such as the actual camera orientation, which can be displayed by a ground station or OSD. Advanced modes, involving the flight controller, ground station or additional electronics, such as follow me, object tracking, and so on, also fall into that category.
* '''''Improved stabilization:''''' In addition, the serial communication can be used to transfer dedicated data from the flight controller to the STorM32, which helps it to achieve better stabilization and video performance. For instance, yaw drift can be corrected, horizon shifts in high-speed turns removed, or smoother pans achieved. This (and only this) part of the serial communication is called the [http://www.rcgroups.com/forums/showthread.php?t=2395475 STorM32-Link].
This article is mostly concerned with the first aspect, also because the STorM32-Link is not yet fully developed.


If you just need the range of functionality possible with the standard tilt & pan control, then you don't need anything of the below. Also, in fact, many of the things could as well be accomplished by workarounds. Decide yourself which approach fits your needs best. :)
If you only need the range of functionality possible with the conventional tilt & pan control, then you may not need anything of the following. Some of the basic features can also be accomplished in traditional ways. Decide yourself which approach fits your needs best. :)
 
If you want to make best use of your STorM32 gimbal and want 2020-ish capabilities, then you may want to chose [https://github.com/olliw42/BetaPilot BetaPilot] (BetaCopter/BetaPlane). This fork of ArduPilot is specifically designed for the STorM32 gimbal controller, and provides the best range of functions. For details see [[Using STorM32 with BetaPilot]].
 
<div class="toclimit-3">__TOC__</div>


== STorM32 - ArduPilot Support ==
== STorM32 - ArduPilot Support ==


Three modes of operation are currently available:
'''''ArduPilot''''' offers three mount types, which can in principle be used with the STorM32 controller:


=== STorM32 Mavlink ===
* '''''SToRM32 MAVLink''''': MNTx_TYPE = 4
* '''''SToRM32 Serial''''': MNTx_TYPE = 5
* '''''Greemsy''''': MNTx_TYPE = 6


* SERIAL_PROTOCOL = 1
For further details on the first two mounts, and instructions on how to use them, please visit [http://ardupilot.org/copter/docs/common-storm32-gimbal.html#common-storm32-gimbal| ArduPilot Docs > Copter > Optional Hardware > Camera&Gimbals > SToRM32 Gimbal Controller].
* MOUNT_TYPE = 4
* STorM32 heartbeat must be activated, {{PARAMNAME|Mavlink Configuration}} = {{PARAMVALUE|emit heartbeat}} or higher
* available in ArduPilot and BetaCopter


For further details please visit [http://ardupilot.org/copter/docs/common-storm32-gimbal.html#common-storm32-gimbal| ArduPilot Docs > Copter > Optional Hardware > Camera&Gimbals > SToRM32 Gimbal Controller]. A good sum-up by lvale is found here [http://www.rcgroups.com/forums/showpost.php?p=35263645&postcount=154], and a workaround to access the other STorM32r functions here [http://www.rcgroups.com/forums/showpost.php?p=34415407&postcount=115].
The ''SToRM32 Serial'' mount (MNTx_TYPE = 5) does not work with v2.xx firmwares, and should not be considered except for legacy I2C setups running v0.9x firmware.


{{COMMENT|When the STorM32's {{PARAMNAME|Mavlink System ID}} is configured to be different from that of the autopilot, e.g. to the default value {{PARAMVALUE|71}}, when the mount works, but the gimbal point does not. Reversely, when the STorM32 is configured as component by setting its {{PARAMNAME|Mavlink System ID}} equal to that of the autopilot, usually {{PARAMVALUE|1}}, when the mount does not work, but the gimbal point does. Camera trigger works partially. {{WARNING|Since v2.11e this comment does not apply anymore [[http://www.rcgroups.com/forums/showpost.php?p=35441133&postcount=8676]]}}.}}
The ''Greemsy'' mount (MNTx_TYPE = 6) is MAVLink based, and thus can in principle be used with STorM32. This mount in fact exploits the 'new' gimbal messages of the [https://mavlink.io/en/services/gimbal_v2.html gimbal protocol v2], and would offer some real benefits. However, it unfortuntaley violates and breaks the MAVLink standard in various respects, and interoperability with STorM32 is thus mixed.


=== STorM32 serial ===
The ''SToRM32 MAVLink'' mount (MNTx_TYPE = 4) currently appears to work best with STorM32 in the sense that it produces the least issues, but it is quite limited in its functionality.


* SERIAL_PROTOCOL = 8
For both the ''SToRM32 MAVLink'' (MNTx_TYPE = 4) and ''Greemsy'' (MNTx_TYPE = 6) mounts, it is not fully clear what works and what does not work at the time of writing, but the ''SToRM32 MAVLink'' mount (MNTx_TYPE = 4) should work fine with respect to controlling a STorM32 gimbal.
* MOUNT_TYPE = 5 (the arducopter docu is wrong here)
* STorM32 heartbeat must be deactivated, {{PARAMNAME|Mavlink Configuration}} = {{PARAMVALUE|no heartbeat}}
* available in ArduPilot and BetaCopter


For further details please visit [http://ardupilot.org/copter/docs/common-storm32-gimbal.html#common-storm32-gimbal| ArduPilot Docs > Copter > Optional Hardware > Camera&Gimbals > SToRM32 Gimbal Controller].
'''''Disclaimer''': ArduPilot's gimbal support is a constant source of issues, in terms of incompatibilities with the official MAVLink standard and/or flaws, and the details can quite vary with the ArduPilot firmware version. Also the ArduPilot documentation can be out-of-date. Please note that STorM32 can't do anything about this, it's ArduPilot, and please also note that the STorM32 firmware author is neither responsible for the implementation of ArduPilot's mount types nor for ArduPilot's documentation.''


=== STorM32 native ===
== Virtual Channel Configuration ==


* SERIAL_PROTOCOL = 83
ArduPilot does not emit the RC_CHANNELS MAVLink message by default, which could be desired for taking advantage of the STorM32's virtual channel feature.
* MOUNT_TYPE is irrelevant
* STorM32 heartbeat must be deactivated, {{PARAMNAME|Mavlink Configuration}} = {{PARAMVALUE|no heartbeat}}
* available only in BetaCopter


The remainder of this wiki page is devoted exclusively to describing the STorM32 native mode.
It can be activated in the flight controller by setting the SRx_RC_CHAN parameter to a non-zero value, where 'x' refers to the stream associated to the serial port which is used for the MAVLink communication with the STorM32 controller.
 
=== Feature Matrix ===


For more details on the feature see [[Using_STorM32_with_BetaPilot#Virtual_Channel_Configuration|Virtual Channel Configuration]].
<!--
== Feature Matrix ==
(for ArduPilot 4.2)(the status for ArduPilot 4.3 is presently unclear)(all to the best of the authors knowledge)
{| class="wikitable" style="text-align: center;"
{| class="wikitable" style="text-align: center;"
!Feature
!Feature
!STorM32 Mavlink
!Traditional<br>PWM, PPM, SBUS, ...
!STorM32 serial
!SToRM32 MAVLink<br>(MNT_TYPE = 4)
!STorM32 native
!SToRM32 Serial<br>(MNT_TYPE = 5)
!BetaPilot<br> STorM32 MAVLink2<br>(MNT_TYPE = 83)
|-
| style="text-align:left;" | Gimbal Angle Control || style="background-color: lightgreen;"| x || style="background-color: #d2f8d2;"| x <sup>(?)</sup> || style="background-color: lightgreen;"| x || style="background-color: lightgreen;"| x
|-
| style="text-align:left;" | MOUNT_STATUS message || - || style="background-color: #d2f8d2;"| x <sup>(1)</sup> || style="background-color: #d2f8d2;"| x <sup>(2)</sup> || style="background-color: lightgreen;"| x
|-
| style="text-align:left;" | ATTITUDE message || - || - || - || style="background-color: lightgreen;"| x
|-
| style="text-align:left;" | Camera Trigger || style="background-color: lightgreen;"| x || style="background-color: lightgreen;"| x || - || style="background-color: lightgreen;"| x
|-
| style="text-align:left;" | Gimbal Point in MP || - || style="background-color: lightgreen;"| x || style="background-color: #d2f8d2;"| x <sup>(2)</sup> || style="background-color: lightgreen;"| x
|-
| style="text-align:left;" | Solo Smart Shots || style="background-color: #d2f8d2;"| x <sup>(3)|| - || - || style="background-color: #d2f8d2;"| x <sup>(3)</sup>
|-
| style="text-align:left;" | Camera Manager in QGC || - || style="background-color: lightgreen;"| x || - || style="background-color: lightgreen;"| x
|-
| style="text-align:left;" | MAVLink Parameters || - || style="background-color: lightgreen;"| x || - || style="background-color: lightgreen;"| x
|-
|-
| style="text-align:left;" | Gimbal Angle Control || style="background-color: lightgreen;"| x || style="background-color: lightgreen;"| x || style="background-color: lightgreen;"| x
| style="text-align:left;" | Video Control in Missions || - || style="background-color: lightgreen;"| x || - || style="background-color: lightgreen;"| x
|-
|-
| style="text-align:left;" | Camera Trigger || style="background-color: lightgreen;"| x (?) || - || style="background-color: lightgreen;"| x
| style="text-align:left;" | 360° Gimbal with Free Look || style="background-color: lightgreen;"| x || - || - || style="background-color: lightgreen;"| x
|-
|-
| style="text-align:left;" | MAV_MOUNT_STATUS message || - || style="background-color: lightgreen;"| x || style="background-color: lightgreen;"| x
| style="text-align:left;" | STorM32 Functions || style="background-color: lightgreen;"| x || - || - || style="background-color: lightgreen;"| x
|-
|-
| style="text-align:left;" | Video on/off || - || - || style="background-color: lightgreen;"| x
| style="text-align:left;" | STorM32 Scripts || style="background-color: lightgreen;"| x || - || - || style="background-color: lightgreen;"| x
|-
|-
| style="text-align:left;" | Extended Gimbal Angle Control || - || - || style="background-color: lightgreen;"| x
| style="text-align:left;" | STorM32-Link: Horizon Drift Comp. || - || - || - || style="background-color: lightgreen;"| x <sup></sup>
|-
|-
| style="text-align:left;" | 360° Gimbal with Free Look || - || - || style="background-color: lightgreen;"| x
| style="text-align:left;" | STorM32-Link: Yaw Drift Comp. || - || - || - || style="background-color: lightgreen;"| x <sup></sup>
|-
|-
| style="text-align:left;" | STorM32 Functions || - || - || style="background-color: lightgreen;"| x
| style="text-align:left;" | MAVLink Passthrough Configuration || - || style="background-color: lightgreen;"| x || - || style="background-color: lightgreen;"| x
|-
|-
| style="text-align:left;" | STorM32 Scripts || - || - || style="background-color: lightgreen;"| x
| style="text-align:left;" | MAVLink Camera Microservice || - || style="background-color: lightgreen;"| x || - || style="background-color: lightgreen;"| x
|-
|-
| style="text-align:left;" | Transmitter Passthrough || - || - || style="background-color: lightgreen;"| x  
| style="text-align:left;" | MAVLink Advanced Features || - || - || - || style="background-color: lightgreen;"| x
|-
|-
| style="text-align:left;" | STorM32-Link || - || - || style="background-color: lightgreen;"| x
| style="text-align:left;" | MAVLink Statustext messages || - || - || - || style="background-color: lightgreen;"| x
|-
| style="text-align:left;" | STorM32 Gimbal Protocol || - || - || - || style="background-color: lightgreen;"| x
|-
| style="text-align:left;" | Prearm Checks || - || - || - || style="background-color: lightgreen;"| x
|}
|}


== BetaCopter ==
(?) Many but not all features work in the latest ArduPilot releases. Please check with the ArduPilot community.
 
I made some modification to ArduCopter (currently AC3.4-rc5), yielding BetaCopter. However, unless the STorM32-specific features are activated by a "secret key" 83, BetaCopter will - to the best of my knowledge - behave exactly like the original code. This means that - to the best of my knowledge - there is no additional risk in using BetaCopter instead of ArduCopter.
 
For the following you need betacopter 3.4rc2 v017 and o323bgc v2.11e. You can download them here:
* o323bgc v2.11e: http://www.rcgroups.com/forums/showpost.php?p=35440964&postcount=8675
* betacopter 3.4rc5 v020: http://www.rcgroups.com/forums/showpost.php?p=35731598&postcount=8919
 
On the STorM32, the {{PARAMNAME|Mavlink Configuration}} parameter '''''must''''' be set to {{PARAMVALUE|no heartbeat}}.
 
The following settings or parameter fields are available. The features involve settings on both the BetaCopter and STorM32 side.
 
=== ArduCopter: SERIALx_PROTOCOL = 83 ===
 
As serial protocol you may choose 83, which activates BetaCopter's native STorM32 protocol. SERIALx_BAUD should be set to 115, but is in fact ignored; the baudrate will always be configured to 115200 bps. You should then notice this:
 
* All ArduCopter camera features are working. That is, whenever a certain path of actions (Mavlink, receiver, mission,...) lets ArduCopter think it wants to take a picture, the STorM32 will know and act.
* All ArduCopter mount features are working. Well, that's mostly exactly what you get also with the other modes of operation, e.g. when using the Mavlink connection with ArduPilot. One enhancement of the 83 mode is however that also the Mavlink MAV_MOUNT_STATUS message is emitted, so that in e.g. MissionPlaner the camera orientation can be read off. Furthermore, see the next parameters.
* In the Message box of MissonPlanner "STorM32 ..." messages will appear.
 
Setting SERIALx_PROTOCOL = 83 is '''''mandatory''''' for any of the STorM32-specific features to work, including all those that follow.
 
{{COMMENT|Setting MNT_TYPE is not required, and its value is in fact ignored. This makes it easy to configure for the STorM32 native connection.}}
 
=== ArduCopter: STORM Parameters ===
 
BetaCopter introduces some new parameters, which are collected under the STORM header.
 
* '''STORM_ARMCHECKS''': Enables pre-arm and arm checks, 0:disabled or 1:enabled. <br> When enabled, this checks if the gimbal has been initialized, i.e. is in NORMAL state. Otherwise arming the copter is denied. In future this option will in addition allow us to extend the STorM32's initialization procedure to until the copter is ready to go, which the STorM32 gimbal controller will use to improve its calibration, and thus stabilization performance.
 
* '''STORM_HAS_PAN''': Allows to set the has_pan_control flag of the native STorM32 mount to 0:false or 1:true. <br> It is not totally clear to me what this flag does (for the other mounts it is set to false). From the code I speculate that when false the copter will yaw along with a yaw command to the gimbal, while when true the copter isn't affected by a yawing mount. If so, the latter would enable a free 360° panning independent on the copter as expected for 360° gimbals (see e.g. digaus' tracking work). Anyway, whatever this flag does, it will be interesting to figure it out.
 
* '''STORM_RC_TRGT''': Allows to modify the behavior of the native STorM32 mount in the RC Targeting mode. <br> A value of 0 sets it to the standard ArduPilot behavior, as you know it. In this setting, the camera motion is determined by the various MNT parameters. When set to 1, in contrast, the standard STorM32 behavior is obtained. Here, the camera motion is determined by the STorM32's {{PARAMNAME|Rc Input}} parameter fields. That is, the camera responds to transmitter inputs in exactly the same way as you know it for the STorM32. I guess, after having gotten used to it, most will prefer this operation mode. It is also somewhat more robust against rc failsafes.
 
* '''STORM_RCIN_DZ''': Sets deadbands for the native STorM32 mount, when STORM_RC_TRGT is enabled.
 
* '''STORM_DIS_MASK''': Bitmask to disable specific features by setting a corresponding bit. <br> It sometimes can be useful to disable a particular function. Bits 1: disable mount, 2: disable camera trigger, 4: disable transmitter passthrough.
 
* '''STORM_FS_HOVER''': Enables BetaCopter's better radio failsafe, 0:disabled or 1:enabled. <br> For some receivers ArduPilot doesn't provide a satisfying failsafe handling, which easily leads to potentially harmful flying conditions. That's specifically so when using a Spektrum satellite. This is known for long but still not addressed; when you're using a Spektrum satellite it is recommended to enable that feature.
 
=== STorM32: Virtual Channel Configuration = serial ===
 
In the STorM32 GUI the {{PARAMNAME|Virtual Channel Configuration}} parameter can be set to {{PARAMVALUE|serial}}, with this effect:
 
All STorM32 [[Inputs and Functions|functions]] can be invoked by selecting a {{PARAMVALUE|Virtual-1}} - {{PARAMVALUE|Virtual-16}} input channel, as if the STorM32 would be directly connected to the receiver. This allows doing many useful things, such as activating a script or triggering video on/off from the transmitter. It however also allows doing nonsense, and it is the users responsibility to avoid that. For instance, if the ArduPilot mount is activated and is in Rc Targeting mode, and e.g. {{PARAMNAME|Rc Pitch Control}} is set to a virtual input channel, then the gimbal may move in funny ways since it may receive the transmitter stick information from both the ArduPilot mount and the receiver. In contrast, if the ArduPilot mount is in GPS or ROI Targeting mode, then one gets "free look", which is useful and quite cool actually. As said, all that is exactly as if the receiver would be directly connected to the STorM32 on its RC ports.
 
=== STorM32-Link ===
 
With SERIALx_PROTOCOL = 83 you also have activated the STorM32-Link (if you want to know in detail what the STorM32-Link is about, please see [http://www.rcgroups.com/forums/showthread.php?t=2395475]). In the STorM32 GUI, specifically the {{GUI|Dashboard}} and/or {{GUI|Data Display}}, you should thus note that the STorM32-Link field goes ON.
 
The main parts of the STorM32-Link functionality are actually not yet implemented in the STorM32 firmware, this will take some more time. However, as evidenced by the STorM32-Link field going ON, the data exchange is established, and thus a crucial milestone been met.
 
== Testing the Serial Connection ==
 
The serial connection can be tested in several ways. The following tests do not require that the copter is completely built, and do not require that the copter is armed.
 
* '''''Message box in MissonPlanner''''': In the message box several messages related to the STorM32 should appear. In particular, a message like "STorM32 v2.11e nt v1.30 F103RC" informing about the STorM32 firmware version should be visible. Also, a message "STorM32 in NORMAL mode" should occur when the gimbal has finished initialization and entered NORMAL mode.
 
* '''''STorM32-Link field in the STorM32 GUI''''': The {{GUI|Dashboard}} and {{GUI|Data Display}} each have a field which is related to the STorM32-Link. They should display OK or a similar positive message.


* '''''Trigger Camera NOW''''': In MissionPlanner the camera can be triggered by a right-mouse-click dropdown menu in the Flight Data map. On the STorM32 side the camera trigger can be easily tested by connecting a visible-light LED (red, green, blue, not IR) to the #IR port.
(1) The message reports the last set point, not the actual gimbal/camera orientation.


* '''''Gimbal RC Targeting''''': With the ArduPilot mount in RC Targeting mode (which should be the default setting), the camera can be turned with the transmitter sticks.
(2) Works only for deprecated v0.9x firmwares.


== Gimbal Point ==
(3) Only up to ArduCopter 3.6. ArduCopter 4.0 has introduced two bugs which the STorM32 controller cannot work around.
-->


MissionPlanner supports what it calls a gimbal point. It is a blue point icon on the map, which indicates the estimated position at which the gimbal is looking at (see also e.g. https://github.com/ArduPilot/MissionPlanner/issues/1323). In order to activate it, the following ArduPilot parameters must be set:
== Testing the Connection ==


* MNT_STAB_ROLL = 0
The serial MAVLink connection can be tested in several ways. Suggestions can be found in [[Using_STorM32_with_BetaPilot#Testing_the_Connection | Using STorM32 with BetaPilot: Testing the Connection]]. They may not all work with native ArduPilot, but many will.
* MNT_STAB_TILT = 1

Latest revision as of 10:00, 28 January 2024

The information on this page refers to firmware v2.64e, and higher.

The STorM32 gimbal controller can communicate with an ArduPilot flight controller via a serial UART data link. The serial communication allows for a much richer data transmission and accordingly richer set of features than possible with the traditional connections such as PWM, PPM, SBUS, CRSF, and alike.

If you only need the range of functionality possible with the conventional tilt & pan control, then you may not need anything of the following. Some of the basic features can also be accomplished in traditional ways. Decide yourself which approach fits your needs best. :)

If you want to make best use of your STorM32 gimbal and want 2020-ish capabilities, then you may want to chose BetaPilot (BetaCopter/BetaPlane). This fork of ArduPilot is specifically designed for the STorM32 gimbal controller, and provides the best range of functions. For details see Using STorM32 with BetaPilot.

STorM32 - ArduPilot Support

ArduPilot offers three mount types, which can in principle be used with the STorM32 controller:

  • SToRM32 MAVLink: MNTx_TYPE = 4
  • SToRM32 Serial: MNTx_TYPE = 5
  • Greemsy: MNTx_TYPE = 6

For further details on the first two mounts, and instructions on how to use them, please visit ArduPilot Docs > Copter > Optional Hardware > Camera&Gimbals > SToRM32 Gimbal Controller.

The SToRM32 Serial mount (MNTx_TYPE = 5) does not work with v2.xx firmwares, and should not be considered except for legacy I2C setups running v0.9x firmware.

The Greemsy mount (MNTx_TYPE = 6) is MAVLink based, and thus can in principle be used with STorM32. This mount in fact exploits the 'new' gimbal messages of the gimbal protocol v2, and would offer some real benefits. However, it unfortuntaley violates and breaks the MAVLink standard in various respects, and interoperability with STorM32 is thus mixed.

The SToRM32 MAVLink mount (MNTx_TYPE = 4) currently appears to work best with STorM32 in the sense that it produces the least issues, but it is quite limited in its functionality.

For both the SToRM32 MAVLink (MNTx_TYPE = 4) and Greemsy (MNTx_TYPE = 6) mounts, it is not fully clear what works and what does not work at the time of writing, but the SToRM32 MAVLink mount (MNTx_TYPE = 4) should work fine with respect to controlling a STorM32 gimbal.

Disclaimer: ArduPilot's gimbal support is a constant source of issues, in terms of incompatibilities with the official MAVLink standard and/or flaws, and the details can quite vary with the ArduPilot firmware version. Also the ArduPilot documentation can be out-of-date. Please note that STorM32 can't do anything about this, it's ArduPilot, and please also note that the STorM32 firmware author is neither responsible for the implementation of ArduPilot's mount types nor for ArduPilot's documentation.

Virtual Channel Configuration

ArduPilot does not emit the RC_CHANNELS MAVLink message by default, which could be desired for taking advantage of the STorM32's virtual channel feature.

It can be activated in the flight controller by setting the SRx_RC_CHAN parameter to a non-zero value, where 'x' refers to the stream associated to the serial port which is used for the MAVLink communication with the STorM32 controller.

For more details on the feature see Virtual Channel Configuration.

Testing the Connection

The serial MAVLink connection can be tested in several ways. Suggestions can be found in Using STorM32 with BetaPilot: Testing the Connection. They may not all work with native ArduPilot, but many will.

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