Serial Communication: Difference between revisions

From STorM32-BGC Wiki
Jump to navigation Jump to search
 
(207 intermediate revisions by 2 users not shown)
Line 1: Line 1:
''The information on this page refers to firmware v0.78e and higher.''
<span style="font-size:88%">''The information on this page refers to firmware v2.69a and higher.''</span>


Communication with the STorM32 board is possible through the serial interfaces USB, UART, and Bluetooth. Three sets of commands are available:
Communication with the STorM32 board is possible through the serial interfaces USB, UART, and UART2 (Bluetooth and Wifi can be achieved by using corresponding dongles). Three sets of commands are available for serial communication:
* '''''Serial Communication - Simple Commands''''': This set has a very simple command structure, and is used for major tasks of the GUI.
* '''''Simple Commands''''': This set has a very simple command structure, and is used for major tasks of the GUI.
* '''''Serial Communication - RC Commands''''': This set is targeted at a remote control of the STorM32 gimbal. It shares many similarities with the simple serial commands.
* '''''RC Commands''''': This set is targeted at a remote control of the STorM32 gimbal.
* '''''Mavlink Commands''''': This set is "real" Mavlink, with extensions however to fully support the STorM32 features.
* '''''Mavlink Commands''''': This set is "real" MAVLink.


Any command of each set can be processed through any of the serial interfaces (USB, UART, and Bluetooth). However, when the Mavlink heartbeat is activated, then the UART only accepts Mavlink commands, and expels the simple serial and RC commands. Also, Bluetooth may not be used anymore.
The simple and the RC commands share many similarities, and could be considered the two sides of a coin (they both are in fact processed by the same code part in the firmware). They tend to be more efficient than the MAVLink commands. Any command of any set can be processed through any of the serial interfaces. However, when the MAVLink Gimbal or MAVLink Camera component is activated, then the serial port selected for MAVLink accepts only MAVLink commands, and on v1.3x boards also Bluetooth may not be used anymore.
 
The commands of each of the three command sets can be used interchangeably. The command set whih the command belongs to is determined by the first received character. This implies that in case of a communication error, the message parser may misinterpret characters which follow the error. The message parser is reset after a timeout.
 
For understanding all details of the communication, it is generally best to peek into the source code of the GUI (which is included in any firmware package). It's written in Perl, and Perl is sufficiently primitive to understand the code easily.


<div class="toclimit-2">__TOC__</div>
<div class="toclimit-2">__TOC__</div>


== Serial Communication - Simple Commands ==
== Serial Communication - Simple Commands ==
This protocol for the communication via the serial interfaces follows these rules:
This protocol for the communication via the serial interfaces follows these rules:


Line 17: Line 22:
* The board is responding to '''any''' incoming command, be it valid or not.
* The board is responding to '''any''' incoming command, be it valid or not.


Any data stream returned by the board ends with one of these characters:
Any data packet returned by the board ends with one of these characters:
* 'o': indicates that everything is ok, i.e. that the received command has been identified
* 'o': indicates that everything is ok, i.e. that the received command has been identified
* 'e': indicates that an error has occurred, i.e. that an invalid command has been received
* 'e': indicates that an error has occurred, i.e. that an invalid command has been received
Line 23: Line 28:
* 'c': indicates that a checksum error has occurred
* 'c': indicates that a checksum error has occurred


A checksum is invoked whenever data are transmitted, currently these are the 'p','g', and 'd' commands.
A checksum is invoked whenever data are transmitted, as e.g. for the 'p','g', and 'd' commands.
 
{{COMMENT|Only the most important simple commands are listed below. There are many more for interacting with the STorM32 controller; please inspect the GUI source code to identify them and their usage.}}


=== Command 't' ===
=== Command 't' ===
Line 29: Line 36:


=== Command 'v' ===
=== Command 'v' ===
This command returns information on the installed firmware version, the name of the board, and the type of the board. The data stream is appended by a crc, and closed with the character 'o'.
This command returns information on the installed firmware version, the name of the board, and the type of the board. The data packet is appended by a crc, and closed with the character 'o'.


=== Command 'g' ===
=== Command 'g' ===
This command returns a data stream containing all parameter values. The data stream is appended by a crc, and closed with the character 'o'.
This command returns a data packet containing all parameter values. The data packet is appended by a crc, and closed with the character 'o'.


=== Command 'p' ===
=== Command 'p' ===
This command sets all parameter values. The command character 'p' needs to be followed by a data stream containing all parameter values, plus a crc. It returns the character 'o'.
This command sets all parameter values. The command character 'p' needs to be followed by a data packet containing all parameter values, plus a crc. It returns the character 'o'.


=== Command 'd' ===
=== Command 'd' ===
Upon receipt of the command 'd' a data stream containing the current live data is transmitted. The live data is appended by a crc, and closed with the character 'o'. The respective C code snippet is as follows:
Upon receipt of the command 'd' a data packet containing the current live data is transmitted. The live data is appended by a crc, and closed with the character 'o'. The respective C code snippet is as follows:


   //send 32 data values
  uint8_t pos = 0;
  uart_prepare_transmit();
   // LIVEDATA_STATUS_V2:
   ((u16*)fbuf)[(*len)++]= STATE; //state
   ((u16*)buf)[pos++] = STATE; // state
   ((u16*)fbuf)[(*len)++]= status; //status
   ((u16*)buf)[pos++] = status; // status
   ((u16*)fbuf)[(*len)++]= status2; //status2
   ((u16*)buf)[pos++] = status2; // status2
   ((u16*)fbuf)[(*len)++]= i2c_geterrorcntofdevice(IMU_I2CDEVNR)+i2c_geterrorcntofdevice(IMU2_I2CDEVNR);
   ((u16*)buf)[pos++] = status3; // status3
   ((u16*)fbuf)[(*len)++]= adc_lipovoltage(); //lipo_voltage;
  ((u16*)buf)[pos++] = (s16)(Performance.MaxLoopdone*10); // performance
   ((u16*)fbuf)[(*len)++]= (u16)systicks; //timestamp
   ((u16*)buf)[pos++] = imu_ntbus_geterrocnt() + imu_onboard_geterrocnt(); // errors
   ((u16*)fbuf)[(*len)++]= (u16)(1.0E6*fdT); //cycle time
  ((u16*)buf)[pos++] = lipo_voltage(); // lipo_voltage
   ((u16*)fbuf)[(*len)++]= (s16)(fImu1.imu.gx);
  // LIVEDATA_TIMES:
   ((u16*)fbuf)[(*len)++]= (s16)(fImu1.imu.gy);
   ((u16*)buf)[pos++] = (u16)looptime.millis_32; // timestamp
   ((u16*)fbuf)[(*len)++]= (s16)(fImu1.imu.gz);
   ((u16*)buf)[pos++] = 0; // not used
   ((u16*)fbuf)[(*len)++]= (s16)(10000.0f*fImu1.imu.ax);
  // LIVEDATA_IMU1GYRO: not included
   ((u16*)fbuf)[(*len)++]= (s16)(10000.0f*fImu1.imu.ay);
  // LIVEDATA_IMU1ACC: not included
   ((u16*)fbuf)[(*len)++]= (s16)(10000.0f*fImu1.imu.az);
  // LIVEDATA_IMU1R:
  ((u16*)fbuf)[(*len)++]= (s16)(10000.0f*fImu1AHRS.R.x);
  ((u16*)buf)[pos++] = (s16)(10000*Imu1AHRS.R.x); // Imu1 R estimates, in 0.0001 g
  ((u16*)fbuf)[(*len)++]= (s16)(10000.0f*fImu1AHRS.R.y);
   ((u16*)buf)[pos++] = (s16)(10000*Imu1AHRS.R.y);
   ((u16*)fbuf)[(*len)++]= (s16)(10000.0f*fImu1AHRS.R.z);
   ((u16*)buf)[pos++] = (s16)(10000*Imu1AHRS.R.z);
  ((u16*)fbuf)[(*len)++]= (s16)(100.0f*fImu1Angle.Pitch);
  // LIVEDATA_IMU1ANGLES:
  ((u16*)fbuf)[(*len)++]= (s16)(100.0f*fImu1Angle.Roll);
   ((u16*)buf)[pos++] = (s16)(100*aImu1Angle.Pitch); // Imu1 angles, in 0.01°
   ((u16*)fbuf)[(*len)++]= (s16)(100.0f*fImu1Angle.Yaw);
   ((u16*)buf)[pos++] = (s16)(100*aImu1Angle.Roll);
   ((u16*)fbuf)[(*len)++]= (s16)(100.0f*cPID[PITCH].Cntrl);
   ((u16*)buf)[pos++] = (s16)(100*aImu1Angle.Yaw);
   ((u16*)fbuf)[(*len)++]= (s16)(100.0f*cPID[ROLL].Cntrl);
   // LIVEDATA_PIDCNTRL:
   ((u16*)fbuf)[(*len)++]= (s16)(100.0f*cPID[YAW].Cntrl);
  if (IS_ENCODERS_ENABLED || (IS_IMU2_PRESENT && IS_IMU2_FULL && IS_3AXISGIMBAL)) {
   ((u16*)fbuf)[(*len)++]= InputSrc.Pitch;
    ((u16*)buf)[pos++] = (s16)(100*cPID[PITCH].Cntrl); // PID output, in 0.01°
  ((u16*)fbuf)[(*len)++]= InputSrc.Roll;
    ((u16*)buf)[pos++] = (s16)(100*cPID[ROLL].Cntrl);
  ((u16*)fbuf)[(*len)++]= InputSrc.Yaw;
    ((u16*)buf)[pos++] = (s16)(100*cPID[YAW].Cntrl);
   ((u16*)fbuf)[(*len)++]= (s16)(100.0f*fImu2Angle.Pitch);
   } else {
  ((u16*)fbuf)[(*len)++]= (s16)(100.0f*fImu2Angle.Roll);
    ((u16*)buf)[pos++] = (s16)(100*cPID[PITCH].Cntrl - cPID[PITCH].SetPoint); // relative PID output, in 0.01°
  ((u16*)fbuf)[(*len)++]= (s16)(100.0f*fImu2Angle.Yaw);
    ((u16*)buf)[pos++] = (s16)(100*cPID[ROLL].Cntrl - cPID[ROLL].SetPoint);
   ((u16*)fbuf)[(*len)++]= (s16)(100.0f*fMag2Angle.Yaw);
    ((u16*)buf)[pos++] = (s16)(100*cPID[YAW].Cntrl - cPID[YAW].SetPoint);
   ((u16*)fbuf)[(*len)++]= (s16)(100.0f*fMag2Angle.Pitch);
  }
   ((u16*)fbuf)[(*len)++]= (s16)(10000.0f*fImu1AHRS._imu_acc_confidence);
  // LIVEDATA_INPUTS:
   ((u16*)fbuf)[(*len)++] = pack_functioninputvalues(&FunctionInputPulse);
   ((u16*)buf)[pos++] = InputSrc.Pitch; // Rc Input values
   (*len)*=2;
  ((u16*)buf)[pos++] = InputSrc.Roll;
   //add crc
  ((u16*)buf)[pos++] = InputSrc.Yaw;
   uint16_t crc= do_crc( fbuf, fbuf_len );
  // LIVEDATA_IMU2ANGLES: (these are the STorM32-Link angles when IS_STORM32LINK_INUSE)
   fbuf[fbuf_len++]= (u8)crc; //low byte
   ((u16*)buf)[pos++] = (s16)(100*aImu2Angle.Pitch); // Imu2 angles, in 0.01°
   fbuf[fbuf_len++]= (u8)(crc>>8); //high byte
   ((u16*)buf)[pos++] = (s16)(100*aImu2Angle.Roll);
   //end character
   ((u16*)buf)[pos++] = (s16)(100*aImu2Angle.Yaw);
   uart_transmit_ackchar( closewith ); //this sends a 'o'
   // LIVEDATA_ENCODERANGLES:
  if (IS_ENCODERS_ENABLED || IS_ENCODERS_PRESENT) {
    ((u16*)buf)[pos++] = (s16)(100*motorfoc_aEncoderAngle(PITCH)); // Encoder angles, in 0.01°
    ((u16*)buf)[pos++] = (s16)(100*motorfoc_aEncoderAngle(ROLL));
    ((u16*)buf)[pos++] = (s16)(100*motorfoc_aEncoderAngle(YAW));
   } else {
    ((u16*)buf)[pos++] = (s16)(100*cPID[PITCH].MotorCntrl); // Motor angles, in 0.01°
    ((u16*)buf)[pos++] = (s16)(100*cPID[ROLL].MotorCntrl);
    ((u16*)buf)[pos++] = (s16)(100*cPID[YAW].MotorCntrl);
  }
  // LIVEDATA_STORM32LINK:
   ((u16*)buf)[pos++] = (s16)(100*toR1earthYaw(aImu1Angle.Yaw)); // Imu1 yaw angle in earth frame, in 0.01°
   ((u16*)buf)[pos++] = (s16)(100*getR2earthYaw()); // yaw angle from flight controller, in 0.01°
  // LIVEDATA_IMUACCSTATS:
   ((u16*)buf)[pos++] = (s16)(10000*Imu1AHRS._acc_magnitude);
   ((u16*)buf)[pos++] = (s16)(10000*Imu1AHRS._acc_confidence);
  // LIVEDATA_STORM32LINK 2nd part:
   ((u16*)buf)[pos++] = debug;
  // LIVEDATA_ATTITUDE_RELATIVE: not included
  pos *= 2;
   // add crc
   uint16_t crc = do_crc(buf, pos);
   buf[pos++] = (u8)crc; // low byte
   buf[pos++] = (u8)(crc >> 8); // high byte
   // end character
   uart_transmit_ackchar(closewith); // this sends the data and a 'o'


=== Command 's' ===
=== Command 's' ===
Upon receipt of the command 's' a data stream containing the current status data is transmitted. The data stream is appended by a crc, and closed with the character 'o'. The command is essentially identical to the 'd' command, except that it transmits only the first five data values.
Upon receipt of the command 's' a data packet containing the current status data is transmitted. The data packet is appended by a crc, and closed with the character 'o'. The command is essentially identical to the 'd' command, except that it transmits only the first seven data values.


=== Checksum ===
=== Checksum ===
The checksum for protecting some data streams is the x25 16-bit crc used by [http://qgroundcontrol.org/mavlink/start Mavlink]. C code can be found [http://mbed.org/users/shimniok/code/AVC_2012/file/826c6171fc1b/MAVlink/include/checksum.h here].
The checksum for protecting some data packets is the x25 16-bit crc used by [https://mavlink.io/en/ MAVLink]. C code can be found [https://github.com/olliw42/fastmavlink/blob/master/c_library/lib/fastmavlink_crc.h here].


== Serial Communication - RC Commands ==
== Serial Communication - RC Commands ==
In addition to the simple serial commands described in the previous section, the o323bgc firmware also understands some messages, which are intended for remote control of the gimbal. These messages have a stricter data format and potentially provide a level of transmission reliability.
 
In addition to the simple serial commands described in the previous section, the STorM32 controller also understands some messages targeted at remote control of the gimbal. These messages have a stricter data format, and provide a higher level of transmission reliability. They also provide a much richer command set and allow access to STorM32's full potential.


The rules of the communication are exactly as before:
The rules of the communication are exactly as before:
Line 97: Line 130:
The general structure of a data frame is:
The general structure of a data frame is:
  * Startsign: 0xFA for incoming messages, and 0xFB for outgoing messages
  * Startsign: 0xFA for incoming messages, and 0xFB for outgoing messages
  * Length: length of the payload, i.e. number of bytes of the data packet excluding Start sign, Length byte, and crc word
  * Length: length of the payload, i.e. number of bytes of the data packet excluding<br> &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; Start sign, Length byte, Command byte, and crc word
  * Payload: as many or few data bytes as desired
* Command: the command byte
  * Checksum: x25 16-bit crc, as used by [http://qgroundcontrol.org/mavlink/start Mavlink]; C code can be found [http://mbed.org/users/shimniok/code/AVC_2012/file/826c6171fc1b/MAVlink/include/checksum.h here]
  * Payload: as many bytes as expected by the command
  * Checksum: x25 16-bit crc excluding start byte, as used by [https://mavlink.io/en/ MAVLink]; C code can be found [https://github.com/olliw42/fastmavlink/blob/master/c_library/lib/fastmavlink_crc.h here]
 
{{COMMENT|The response can be suppressed by using a 0xF9 start sign, instead of a 0xFA.}}


The following commands can be send to the STorM32 controller:
The following commands can be send to the STorM32 controller:
Line 107: Line 143:
If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the firmware version, the setup layout version and board capabilities in this format will be emitted:
If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the firmware version, the setup layout version and board capabilities in this format will be emitted:


  0xFB 0x06 0x00 data1-low data1-high data2-low data2-high data3-low data3-high crc-low-byte crc-high-byte
  0xFB 0x06 0x01 data1-low data1-high data2-low data2-high data3-low data3-high crc-low-byte crc-high-byte


Data1 is the firmware version, data2 the setup layout version, and data3 holds the board capabilities value.
Data1 is the firmware version, data2 the setup layout version, and data3 holds the board capabilities value.
Line 133: Line 169:
==== CMD_GETDATA (#5) ====
==== CMD_GETDATA (#5) ====
  0xFA 0x01 0x05 type-byte crc-low-byte crc-high-byte
  0xFA 0x01 0x05 type-byte crc-low-byte crc-high-byte
Type specifies the type of the requested data stream; currently only type 0 is supported. If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the data stream in this format will be emitted:
Type specifies the type of the requested data; currently only type 0 is supported. If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the data in this format will be emitted:


  0xFB 0x4A 0x05 type-byte 0x00 data-stream crc-low-byte crc-high-byte
  0xFB 0x4A 0x05 type-byte 0x00 data-stream crc-low-byte crc-high-byte


The data stream contains the same data as send by the 'd' command.
Data-stream holds the data, which is the same data as send by the 'd' command.


==== CMD_GETDATAFIELDS (#6) ====
==== CMD_GETDATAFIELDS (#6) ====
  0xFA 0x02 0x06 data-low-byte data-high-byte crc-low-byte crc-high-byte
  0xFA 0x02 0x06 bitmask-low-byte bitmask-high-byte crc-low-byte crc-high-byte
The data is of type uint16_t and represents the number of the data field which is requested.If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the parameter value in this format will be emitted:
The bitmask is of type uint16_t and represents a bitmask to specify which data should be send. If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the bitmask word and all the requested data in this format will be emitted:


  0xFB 0x04 0x06 data1-low-byte data1-high-byte data2-low-byte data2-high-byte crc-low-byte crc-high-byte
  0xFB LEN 0x06 bitmask-low-byte bitmask-high-byte data-stream crc-low-byte crc-high-byte


Data1 is the data field number and data2 holds the data field value.
Bitmask is the bitmask word, and data-stream holds the corresponding data. The following bits can be set:


  LIVEDATA_STATUS   0x0001
  0x0002 = LIVEDATA_TIMES
LIVEDATA_TIMES                   0x0002
  0x0004 = LIVEDATA_IMU1GYRO
  LIVEDATA_IMU1GYRO                 0x0004
  0x0008 = LIVEDATA_IMU1ACC
  LIVEDATA_IMU1ACC                 0x0008
  0x0010 = LIVEDATA_IMU1R
  LIVEDATA_IMU1R                   0x0010
  0x0020 = LIVEDATA_IMU1ANGLES
  LIVEDATA_IMU1ANGLES               0x0020
  0x0040 = LIVEDATA_PIDCNTRL
  LIVEDATA_PIDCNTRL                 0x0040
  0x0080 = LIVEDATA_INPUTS
  LIVEDATA_INPUTS                   0x0080
  0x0100 = LIVEDATA_IMU2ANGLES
  LIVEDATA_IMU2ANGLES               0x0100
  0x0400 = LIVEDATA_STORM32LINK
  LIVEDATA_MAGANGLES                0x0200
0x0800 = LIVEDATA_IMUACCSTATS
  LIVEDATA_STORM32LINK           0x0400
0x1000 = LIVEDATA_ATTITUDE_RELATIVE
LIVEDATA_IMUACCCONFIDENCE        0x0800
0x2000 = LIVEDATA_STATUS_V2
0x4000 = LIVEDATA_ENCODERANGLES
 
Note that the order of the flags does not coincide with the order of the respective data in the data-stream; the order in data-stream can be read off from the documentation for the 'd' command. The data send in the 'd' and CMD_GETDATA commands correspond to the bitmask
 
LIVEDATA_STATUS_V2 | LIVEDATA_TIMES | LIVEDATA_IMU1R | LIVEDATA_IMU1ANGLES | LIVEDATA_PIDCNTRL | \
  LIVEDATA_INPUTS | LIVEDATA_IMU2ANGLES | LIVEDATA_ENCODERANGLES | LIVEDATA_STORM32LINK | LIVEDATA_IMUACCSTATS
 
{{COMMENT|The flags have slightly changed in v2.61, so are slightly different in older firmware versions.}}


==== CMD_SETPITCH (#10) ====
==== CMD_SETPITCH (#10) ====
Line 174: Line 218:
==== CMD_SETPANMODE (#13) ====
==== CMD_SETPANMODE (#13) ====
  0xFA 0x01 0x0D data-byte crc-low-byte crc-high-byte
  0xFA 0x01 0x0D data-byte crc-low-byte crc-high-byte
The data is of type uint8_t and can assume these values: 0 = off, 1 = HOLDHOLDPAN, 2 = HOLDHOLDHOLD, 3 = PANPANPAN, 4 = PANHOLDHOLD, 5 = PANHOLDPAN. As response to this command a CMD_ACK message will be emitted.
The data is of type uint8_t and can assume these values: 0 = off, 1 = HOLDHOLDPAN, 2 = HOLDHOLDHOLD, 3 = PANPANPAN, 4 = PANHOLDHOLD, 5 = PANHOLDPAN, 6 = HOLDPANPAN. As response to this command a CMD_ACK message will be emitted.


==== CMD_SETSTANDBY(#14) ====
==== CMD_SETSTANDBY(#14) ====
Line 182: Line 226:
==== CMD_DOCAMERA(#15) ====
==== CMD_DOCAMERA(#15) ====
  0xFA 0x06 0x0F dummy-byte data-byte dummy-byte dummy-byte dummy-byte dummy-byte crc-low-byte crc-high-byte
  0xFA 0x06 0x0F dummy-byte data-byte dummy-byte dummy-byte dummy-byte dummy-byte crc-low-byte crc-high-byte
The data is of type uint8_t and can assume these values: 0 = off, 1 = IRSHUTTER, 2 = IRSHUTTERDELAYED, 3 = IRVIDEOON, 4 = IRVIDEOOFF. As response to this command a CMD_ACK message will be emitted.
The data is of type uint8_t and can assume these values: 0 = off, 1 = SHUTTER, 2 = SHUTTERDELAYED, 3 = VIDEOON, 4 = VIDEOOFF. As response to this command a CMD_ACK message will be emitted.


==== CMD_SETSCRIPTCONTROL (#16) ====
==== CMD_SETSCRIPTCONTROL (#16) ====
  0xFA 0x02 0x10 data1-byte data2-byte crc-low-byte crc-high-byte
  0xFA 0x02 0x10 data1-byte data2-byte crc-low-byte crc-high-byte
The data1 and data2 are of type uint8_t. Data1 is the number of the script and data2 can assume these values: 0 = off, 1 = CASE#DEFAULT, 2 = CASE#1, 3 = CASE#2, 4 = CASE#3. As response to this command a CMD_ACK message will be emitted.
The data1 and data2 are of type uint8_t. Data1 is the number of the script (0 = scritp1, 1 = script2, etc) and data2 can assume these values: 0 = off, 1 = CASE#DEFAULT, 2 = CASE#1, 3 = CASE#2, 4 = CASE#3, 5 = CASE#4. As response to this command a CMD_ACK message will be emitted.


==== CMD_SETANGLE (#17) ====
==== CMD_SETANGLES (#17) ====
  0xFA 0x0E 0x11 float1 float2 float3 flags-byte type-byte crc-low-byte crc-high-byte
  0xFA 0x0E 0x11 float1 float2 float3 flags-byte type-byte crc-low-byte crc-high-byte
The float1, float2, float3 fields represent 4 bytes each. They are of type float, and correspond to the pitch, roll, and yaw angles in degree. The flags byte allows to modify the behavior of the angle setting for each angle. It can be in the limited or unlimited mode. In limited mode the angle setting is subject to the RcMin and RcMax settings, and works only for "absolute". In unlimited mode any angle value can be set without restriction, bypassing the RcMin and RcMax settings, and works for both "relative" and "absolute". The first bit, 0x01, corresponds to pitch, 0x02 to roll, and 0x04 to yaw, and when set the respective axis is in limited mode. The type byte is not used currently and has to be set to zero. As response to this command a CMD_ACK message will be emitted.
The float1, float2, float3 fields represent 4 bytes each. They are of type float, and correspond to the pitch, roll, and yaw angles in degree. The flags and type bytes are not used and have to be set to zero. As response to this command a CMD_ACK message will be emitted. {{COMMENT|In previous firmware versions the flags byte allowed to set the behavior of the angle setting for each axis to unlimited or limited mode. The behavior now corresponds to flags 0, or unlimited mode for all axes.}} <!--The flags byte allows to modify the behavior of the angle setting for each axis. They can be in the unlimited or limited mode. In unlimited mode the respective axis can be set to any angle without restriction, bypassing the {{PARAMNAME|RcMin}} and {{PARAMNAME|RcMax}} settings, and working for both {{PARAMVALUE|relative}} and {{PARAMVALUE|absolute}}. In limited mode the angle setting is subject to the {{PARAMNAME|RcMin}} and {{PARAMNAME|RcMax}} settings, and works only for {{PARAMVALUE|absolute}}. The first bit of the flags byte, 0x01, corresponds to pitch, 0x02 to roll, and 0x04 to yaw, and when set the respective axis is in limited mode. The type byte is not used currently and has to be set to zero. As response to this command a CMD_ACK message will be emitted.-->


==== CMD_SETPITCHROLLYAW (#18) ====
==== CMD_SETPITCHROLLYAW (#18) ====
Line 207: Line 251:
  0xFA 0x00 0x15 crc-low-byte crc-high-byte
  0xFA 0x00 0x15 crc-low-byte crc-high-byte
This command sets all parameters to the values stored in the EEPROM. As response to this command a CMD_ACK message will be emitted.
This command sets all parameters to the values stored in the EEPROM. As response to this command a CMD_ACK message will be emitted.
==== CMD_SETINPUTS (#22) ====
0xFA 0x17 0x16 data-bytes crc-low-byte crc-high-byte
This overwrites the data received from virtual inputs, if {{PARAMNAME|Virtual Channel Configuration}} = {{PARAMVALUE|serial}} is configured. The data bytes are formatted similarly to sbus: 16 channels of 11 bit values combined into 22 bytes, plus a status byte. The range is 0...2047, and 1500 equals center. As response to this command a CMD_ACK message will be emitted.
==== CMD_SETHOMELOCATION (#23) ====
Deprecated.
==== CMD_SETTARGETLOCATION (#24) ====
Deprecated.
==== CMD_SETINPUTCHANNEL (#25) ====
0xFA 0x04 0x19 data1-low data1-high data2-low data2-high crc-low-byte crc-high-byte
This overwrites the data received from virtual inputs for the specified channel, if {{PARAMNAME|Virtual Channel Configuration}} = {{PARAMVALUE|serial}} is configured. The data1 and data2 are of type uint16_t each. Data1 is the channel number. Data2 is the channel value, the range is 700...2300, and 1500 equals center. As response to this command a CMD_ACK message will be emitted.
==== CMD_SETCAMERA (#26) ====
0xFA 0x04 0x1A data1-low data1-high data2-low data2-high crc-low-byte crc-high-byte
The data1 and data2 are of type uint16_t each, and can assume the values 700...2300, and 1500 equals center. If the value 0 is send, then the respective input is cleared. Any other values are ignored. Data1 and data2 represent the camera control and camera control2 input values, respectively. As response to this command a CMD_ACK message will be emitted.
==== CMD_SENDCAMERACOMMAND (#27) ====
0xFA 0x01-0x12 0x1B data1 ... data24 crc-low-byte crc-high-byte
The data1 to data18 are of type uint8_t. The message can have 1 to 24 of them, i.e., length byte can vary from 0x01 to 0x12. The data are send to the NT Camera uart port. As response to this command a CMD_ACK message will be emitted.
==== CMD_SETANGLES_UNRESTRICTED (#28) ====
0xFA 0x18 0x1C float1 float2 float3 float4 float5 float6 crc-low-byte crc-high-byte
The float1 - float6 fields represent 4 bytes each. They are of type float. Float1, float2, float3 correspond to the desired pitch, roll, and yaw angles in degrees. Float4, float5, float6 correspond to the desired pitch rate, roll rate, and yaw rate in degrees per second (only positive values are admitted). A value of zero means that no rate is applied. {{COMMENT|The rates are not the components of the angular velocity vector, but indeed the rates of the respective angles.}} As response to this command a CMD_ACK message will be emitted.
==== CMD_SETRETRACT(#29) ====
0xFA 0x01 0x1D data-byte crc-low-byte crc-high-byte
The data is of type uint8_t and can assume these values: 0 = off, 1 = on. As response to this command a CMD_ACK message will be emitted.


==== CMD_ACTIVEPANMODESETTING (#100) ====
==== CMD_ACTIVEPANMODESETTING (#100) ====
Line 224: Line 298:
  152 = SERIALRCCMD_ACK_ERR_PAYLOADLEN
  152 = SERIALRCCMD_ACK_ERR_PAYLOADLEN


== Mavlink Communication ==
==== CMD_CONNECT (#210) ====
In addition to the commands described in the previous sections, the o323bgc firmware also understands "real" Mavlink messages, as defined in the [http://qgroundcontrol.org/mavlink/start Mavlink] standard. Also some STorM32 specific Mavlink messages were added. The implemented Mavlink messages are described in the mavlink_storm32.xml file. For some messages the parameter values were however extended, such as to maintain compatibility but support all STorM32 features.
Deprecated.


The STorM32 controller's system ID and component ID can be freely adjusted in the GUI; the defaults are
==== CMD_GETDATADISPLAY (#213) ====
Deprecated.


* System ID: 'G' (= 71 = 0x47)
==== CMD_WIFICONNECTEDPING (#215) ====
* Component ID: 'C' (= 67 = 0x43)
Deprecated.


The following commands are supported:
==== CMD_STORM32LINK_V1 (#217) ====
Deprecated.


==== MAVLINK_MSG_ID_HEARTBEAT (#0) ====
==== CMD_STORM32LINK_V2 (#218) ====
Special command: Is used for transmitting from a flight controller to the STorM32 for the STorM32-Link.


See [https://pixhawk.ethz.ch/mavlink/#HEARTBEAT HEARTBEAT]. The emission of the heartbeat needs to be activated in the GUI via the {{PARAMNAME|Mav Configuration}} parameter. The heartbeat is emitted at 1 Hz, with the following values:
== Mavlink Communication ==
* type: MAV_TYPE_GIMBAL (= 26)
* autopilot: 'S' (= 83 = 0x53) (may become MAV_AUTOPILOT_STORM32)
* base_mode: either 0 or MAV_MODE_FLAG_SAFETY_ARMED (= 0x80)
* custom_mode: STATE value of the o323firmware
* system_status: either MAV_STATE_BOOT (= 1) or MAV_STATE_ACTIVE (= 4)


==== MAVLINK_MSG_ID_PARAM_REQUEST_READ (#20) ====
In addition to the commands described in the previous sections, the STorM32 controller also understands MAVLink messages, as defined in the [https://mavlink.io/en/ MAVLink] standard. The STorM32 controller's MAVLink support is in fact quite rich, and quite complex, and actually provides two MAVLink components. Therefore, the description is placed in a separate article [[MAVLink Communication]].


See [https://pixhawk.ethz.ch/mavlink/#PARAM_REQUEST_READ PARAM_REQUEST_READ].
The STorM32's MAVLink Gimbal component is enabled by opening the {{GUI|Interfaces Tool}} window, which is accessible via the {{GUI|Tools}} menu, and setting {{PARAMNAME|Mavlink Gimbal}} to {{PARAMVALUE|Gimbal1}}, which also sets the component ID. For further details see [[MAVLink Communication]].
<!--
== Comments on STorM32 specific Mavlink Messages ==


==== MAVLINK_MSG_ID_PARAM_REQUEST_LIST (#21) ====
==== COMMAND_LONG - MAV_CMD_GET_ATTITUDE ====  


See [https://pixhawk.ethz.ch/mavlink/#PARAM_REQUEST_LIST PARAM_REQUEST_LIST].
The command MAV_CMD_GET_ATTITUDE is deprecated, but still existing for compatibility reasons. The command triggered the emission of a [http://mavlink.org/messages/common#ATTITUDE ATTITUDE] message instead of a [http://mavlink.org/messages/common#COMMAND_ACK COMMAND_ACK] message. This allowed to ask for the gimbal attitude whenever it is required. The command should be replaced by using either the MAVLINK_MSG_ID_MESSAGE_INTERVAL message or a corresponding MAV_CMD_TARGET_SPECIFIC command.


==== MAVLINK_MSG_ID_PARAM_VALUE (#22) ====
==== COMMAND_LONG - MAV_CMD_TARGET_SPECIFIC ====  


See [https://pixhawk.ethz.ch/mavlink/#PARAM_VALUE PARAM_VALUE].
The command MAV_CMD_TARGET_SPECIFIC was added. This command can be viewed as a container to transmit data, those content isn't known to MAVLink. It thus becomes possible to establish a communication between two arbitrary devices, using a MAVLink channel. The command is intended for peer-to-peer communication, but of course is handled like any other COMMAND_LONG message by the MAVLink systems. The working principle is to treat the memory space of the seven param fields as a contiguous data buffer of 28 bytes, which hosts the target specific message. Obviously, only target specific messages of lengths less or equal 28 bytes can be handled.


==== MAVLINK_MSG_ID_PARAM_SET (#23) ====
In the o323bgc firmware, the command is used to embed both the simple serial and RC commands. That is, the param memory space hosts the serial or RC command, with the crc bytes stripped off however since the message is already crc protected by MAVLink.


See [https://pixhawk.ethz.ch/mavlink/#PARAM_SET PARAM_SET].
For instance, the command CMD_SETPITCH with value 1000 (= 0x03E8) can be transmitted in two ways from a MAVLink device (with IDs 0xYY and 0xZZ) to the STorM32 controller (with IDs 0x47 and 0x43):
* It can be transmitted as described in the above, with the 0xFA start sign. The byte stream which is sent to the STorM32 controller is then:


==== MAVLINK_MSG_ID_COMMAND_LONG (#76) ====
0xFA 0x02 0x0A 0xE8 0x03 CRCLOW CRCHIGH


See [https://pixhawk.ethz.ch/mavlink/#COMMAND_LONG COMMAND_LONG]. The value ranges of some parameters of the MAV_CMD_DO_DIGICAM_CONTROL and MAV_CMD_DO_MOUNT_CONTROL were extended, to embrace the STorM32's capabilities. These commands are supported (parameter fields not mentioned are ignored):
and the received ACK stream is:


  MAV_CMD_DO_SET_PARAMETER (#180)
  0xFB 0x01 0x96 0x00 0x52 0xE9
* param1 = parameter index
* param2 = parameter value


MAV_CMD_DO_SET_SERVO (#183)
* The message can be embedded into the MAV_CMD_TARGET_SPECIFIC command, i.e. the param field space becomes the target specific message, without its crc. The byte stream is then:
* param2 = pwm value (only 700...2300 accepted)


  MAV_CMD_DO_DIGICAM_CONTROL (#203)
  0xFE 0x21 0xXX 0xYY 0xZZ 0x4C 0xFA 0x02 0x0A 0xE8 0x03 23*0x00 0xD3 0x04 0x47 0x43 0x00 CRCLOW CRCHIGH
* param5 = shot (0 = off, 1 = IRSHUTTER, 2 = IRSHUTTERDELAYED, 3 = IRVIDEOON, 4 = IRVIDEOOFF)


MAV_CMD_DO_MOUNT_CONFIGURE (#204)
and the received ACK stream is:
* param1 = mount_mode (1 = MAV_MOUNT_MODE_NEUTRAL recenters camera)


  MAV_CMD_DO_MOUNT_CONTROL (#205)
  0xFE 0x21 0xXX 0x47 0x43 0x4C 0xFB 0x01 0x96 0x00 24*0x00 0xD3 0x04 0xYY 0xZZ 0x00 CRCLOW CRCHIGH
* param1 = pitch, angle in degree or pwm input
* param2 = roll, angle in degree or pwm input
* param3 = yaw, angle in degree or pwm input
* param6 = typeflags (uint16_t)
      0x0001: pitch, 0: unlimited, 1: limited, see [[#CMD_SETANGLE_.28.2317.29|CMD_SETANGLE]]
      0x0002: roll, 0: unlimited, 1: limited, see [[#CMD_SETANGLE_.28.2317.29|CMD_SETANGLE]]
      0x0004: yaw, 0: unlimited, 1: limited, see [[#CMD_SETANGLE_.28.2317.29|CMD_SETANGLE]]
      0x0100: input type, 0: angle input (see [[#CMD_SETANGLE_.28.2317.29|CMD_SETANGLE]]), 1: pwm input (see [[#CMD_SETPITCHROLLYAW (#18)|CMD_SETPITCHROLLYAW]])


==== MAVLINK_MSG_ID_COMMAND_ACK (#77) ====
This of course works for all serial and RC commands, and their responses. Thus, the full command set and functionality of the STorM32 controller is available through MAVLink channels. --><!--
 
See [https://pixhawk.ethz.ch/mavlink/#COMMAND_ACK COMMAND_ACK].
 
==== MAVLINK_MSG_ID_DIGICAM_CONTROL (#155) ====
 
ArduPilot specific message. See [http://mavlink.org/messages/ardupilotmega#DIGICAM_CONTROL DIGICAM_CONTROL]. The value range of the shot byte is extended, to embrace the STorM32's camera capabilities.
 
* target_system: System ID (uint8_t)
* target_component: Component ID (uint8_t)
* shot: 0 = off, 1 = IRSHUTTER, 2 = IRSHUTTERDELAYED, 3 = IRVIDEOON, 4 = IRVIDEOOFF (uint8_t)
 
All other fields of the message are ignored.
 
==== MAVLINK_MSG_ID_MOUNT_CONFIGURE (#156) ====
 
Ardupilot specific message. See [http://mavlink.org/messages/ardupilotmega#MOUNT_CONFIGURE MOUNT_CONFIGURE].
 
* target_system: System ID (uint8_t)
* target_component: Component ID (uint8_t)
* mount_mode: MAV_MOUNT_MODE_NEUTRAL recenters camera (uint8_t)
 
All other fields of the message are ignored.
 
==== MAVLINK_MSG_ID_MOUNT_CONTROL (#157) ====
 
ArduPilot specific message. See [http://mavlink.org/messages/ardupilotmega#MOUNT_CONTROL MOUNT_CONTROL]. The possible values of the save_position byte is extended to accept more flags, to embrace both the angle and pwm input capabilities of the STorM32.
 
* target_system: System ID (uint8_t)
* target_component: Component ID (uint8_t)
* input_a: pitch, angle in 0.01° or pwm input (int32_t)
* input_b: roll, angle in 0.01° or pwm input (int32_t)
* input_c: yaw, angle in 0.01° or pwm input (int32_t)
* save_position: (uint8_t)
    0x01: standard not-save/save position
    0x02: pitch, 0: unlimited, 1: limited, see [[#CMD_SETANGLE_.28.2317.29|CMD_SETANGLE]]
    0x04: roll, 0: unlimited, 1: limited, see [[#CMD_SETANGLE_.28.2317.29|CMD_SETANGLE]]
    0x08: yaw, 0: unlimited, 1: limited, see [[#CMD_SETANGLE_.28.2317.29|CMD_SETANGLE]]
    0x10: input type, 0: angle input (see [[#CMD_SETANGLE_.28.2317.29|CMD_SETANGLE]]), 1: pwm input (see [[#CMD_SETPITCHROLLYAW (#18)|CMD_SETPITCHROLLYAW]])
 
==== MAVLINK_MSG_ID_COMMAND_TARGET_SPECIFIC (#234) ====
Container for target specific messages. See [[#Comments_to_STorM32_specific_Mavlink_commands|Comments to STorM32 specific Mavlink commands]] below.
* target_system: System ID (uint8_t)
* target_component: Component ID (uint8_t)
* specific_payload: Target specific message as payload, the size can be variable, as needed
 
==== MAVLINK_MSG_ID_COMMAND_TARGET_SPECIFIC_ACK (#235) ====
Container for a target specific responses. May be emitted by the target as response to a COMMAND_TARGET_SPECIFIC message. See [[#Comments_to_STorM32_specific_Mavlink_commands|Comments to STorM32 specific Mavlink commands]] below.
* target_system: System ID (uint8_t)
* target_component: Component ID (uint8_t)
* specific_payload: Target specific response as payload, the size can be variable, as needed
 
==== MAVLINK_MSG_ID_PARAM_READ2 (#236) ====
Requests reading the parameter with index param_index. The target should respond with a PARAM_VALUE2 message. See [[#Comments_to_STorM32_specific_Mavlink_commands|Comments to STorM32 specific Mavlink commands]] below.
* target_system: System ID (uint8_t)
* target_component: Component ID (uint8_t)
* param_index: Parameter index (uint16_t)
 
==== MAVLINK_MSG_ID_PARAM_SET2 (#237) ====
Sets the parameter with index param_index to the value param_value. The target should respond with a PARAM_VALUE2 message to acknowledge. See [[#Comments_to_STorM32_specific_Mavlink_commands|Comments to STorM32 specific Mavlink commands]] below.
* target_system: System ID (uint8_t)
* target_component: Component ID (uint8_t)
* param_index: Parameter index (uint16_t)
* param_value: Parameter value (type depends on parameter)
* param_type: parameter type, see the MAV_PARAM_TYPE enum for supported data types (uint8_t)
 
==== MAVLINK_MSG_ID_PARAM_VALUE2 (#238) ====
Sends the value of the parameter with index param_index. See [[#Comments_to_STorM32_specific_Mavlink_commands|Comments to STorM32 specific Mavlink commands]] below.
* target_system: System ID (uint8_t)
* target_component: Component ID (uint8_t)
* param_index: Parameter index (uint16_t)
* param_value: Parameter value (type depends on parameter)
* param_type: Parameter type, see the MAV_PARAM_TYPE enum for supported data types (uint8_t)
* param_count: Total number of parameters (uint16_t)
 
== Comments to STorM32 specific Mavlink commands ==


==== PARAM_READ2, PARAM_SET2, PARAM_VALUE2 ====
==== PARAM_READ2, PARAM_SET2, PARAM_VALUE2 ====
Line 371: Line 358:
==== COMMAND_TARGET_SPECIFIC, COMMAND_TARGET_SPECIFIC_ACK ====
==== COMMAND_TARGET_SPECIFIC, COMMAND_TARGET_SPECIFIC_ACK ====


A major addition are the commands COMMAND_TARGET_SPECIFIC and COMMAND_TARGET_SPECIFIC_ACK. They are in some way similar to the COMMAND_LONG and COMMAND_ACK message pair, but do not impose format restrictions on the payload, and allow also to send information back to the sender. This optimizes not only bandwidth but also establishes a very flexible method to send information, in both directions if needed. These commands could also be viewed as containers for data, those content isn't known by Mavlink. It becomes thus possible to establish a communication channel between two arbitrary devices, using a Mavlink channel.
A major addition are the commands COMMAND_TARGET_SPECIFIC and COMMAND_TARGET_SPECIFIC_ACK. They are in some way similar to the pair of messages COMMAND_LONG and COMMAND_ACK, but do not impose format restrictions on the payload, and allow also to send information back to the sender. This optimizes not only bandwidth but also establishes a very flexible method to send information, in both directions if needed. These commands could also be viewed as containers for data, those content isn't known by Mavlink. It becomes thus possible to establish a communication channel between two arbitrary devices, using a Mavlink channel.


These commands are intended for peer-to-peer communication. That is the System and Component IDs of the ACK message are the Target System and Target Component IDs of the sending message, and vice versa.
These commands are intended for peer-to-peer communication. That is the System and Component IDs of the ACK message are the Target System and Target Component IDs of the sending message, and vice versa.


These two commands are however not fully conform with the Mavlink standard, which currently doesn't support variable payloads. Hence, most of the routines provided by Mavlink cannot be used, namely those which rely on the hardcoded length associated to a message. Also, any router, which handles the distribution of the Mavlink messages, should not rely on the hardcoded lengths (at least not for the two discussed commands). These points are inconvenient, but quite easy to realize in practice.  
These two commands are however not fully conform with the Mavlink standard, which currently doesn't support variable payloads. Hence, all routines provided by Mavlink which rely on the hardcoded length associated to a message cannot be used. Also, any router, which handles the distribution of the Mavlink messages, should not rely on the hardcoded lengths (at least not for the two discussed commands). These points are however quite easy to realize in practice.  


In the o323bgc firmware, these commands currently embed the [[Serial_Communication#Mavlink_RC_Communication|Mavlink RC commands]]. That is, for instance, the command CMD_SETANGLE with value 1000 (= 0x03E8) can be transmitted in two ways:
In the o323bgc firmware, these commands allow to embed both the simple serial and the RC commands. That is, for instance, the command CMD_SETANGLE with value 1000 (= 0x03E8) can be transmitted in two ways:
* It can be transmitted as described in the above, with the 0xFD start sign. The sent byte stream is then:  
* It can be transmitted as described in the above, with the 0xFA start sign. The sent byte stream is then:  


  0xFD 0x02 0x00 0x52 0x43 0x0A 0xE8 0x03 CRCLOW CRCHIGH
  0xFA 0x02 0x11 0xE8 0x03 CRCLOW CRCHIGH


and the received ACK stream
and the received ACK stream


  0xFD 0x01 0x00 0x47 0x43 0x96 0x00 0x52 0xE9
  0xFB 0x01 0x96 0x00 0x52 0xE9


* Its message id and payload is embedded into the COMMAND_TARGET_SPECIFIC command, i.e. the message id and payload becomes the specific payload. The byte stream is then:  
* The message can be embedded into the COMMAND_TARGET_SPECIFIC command, i.e. the message id and payload becomes the specific payload. The byte stream is then:  


  0xFE 0x05 0xXX 0x52 0x43 0xEA 0x47 0x43 0x0A 0xE8 0x03 CRCLOW CRCHIGH
  0xFE 0x05 0xXX 0xYY 0xZZ 0xEA 0x47 0x43 0xFA 0x11 0xE8 0x03 CRCLOW CRCHIGH


and the received ACK stream
and the received ACK stream


  0xFE 0x04 0xYY 0x47 0x43 0xEB 0x52 0x43 0x96 0x00 CRCLOW CRCHIGH
  0xFE 0x04 0xYY 0x47 0x43 0xEB 0xYY 0xZZ 0x96 0x00 CRCLOW CRCHIGH
 
This of course works for all serial commands, and their responses. Thus, the full command set and functionality is available through Mavlink channel. -->


This of course works for all [[Serial_Communication#Mavlink_RC_Communication|Mavlink RC commands]], and their responses.
== Code Examples ==


{{COMMENT|In a future version also the [[Serial_Communication#Serial_Communication_Protocol|simple serial commands]] will be embedded into the COMMAND_TARGET_SPECIFIC/COMMAND_TARGET_SPECIFIC_ACK pair, so that the full command set and functionality is available through Mavlink channel.}}
Please see [[Code_Examples#Serial_Communication|Code Examples: Serial Communication]].

Latest revision as of 20:21, 16 January 2024

The information on this page refers to firmware v2.69a and higher.

Communication with the STorM32 board is possible through the serial interfaces USB, UART, and UART2 (Bluetooth and Wifi can be achieved by using corresponding dongles). Three sets of commands are available for serial communication:

  • Simple Commands: This set has a very simple command structure, and is used for major tasks of the GUI.
  • RC Commands: This set is targeted at a remote control of the STorM32 gimbal.
  • Mavlink Commands: This set is "real" MAVLink.

The simple and the RC commands share many similarities, and could be considered the two sides of a coin (they both are in fact processed by the same code part in the firmware). They tend to be more efficient than the MAVLink commands. Any command of any set can be processed through any of the serial interfaces. However, when the MAVLink Gimbal or MAVLink Camera component is activated, then the serial port selected for MAVLink accepts only MAVLink commands, and on v1.3x boards also Bluetooth may not be used anymore.

The commands of each of the three command sets can be used interchangeably. The command set whih the command belongs to is determined by the first received character. This implies that in case of a communication error, the message parser may misinterpret characters which follow the error. The message parser is reset after a timeout.

For understanding all details of the communication, it is generally best to peek into the source code of the GUI (which is included in any firmware package). It's written in Perl, and Perl is sufficiently primitive to understand the code easily.

Serial Communication - Simple Commands

This protocol for the communication via the serial interfaces follows these rules:

  • The board responds to incoming commands by sending back a data stream of one or more characters, which is determined by the received command.
  • The board is never sending/transmitting anything by itself, that is, a transmission is always started only as a reaction to an incoming command.
  • The board is responding to any incoming command, be it valid or not.

Any data packet returned by the board ends with one of these characters:

  • 'o': indicates that everything is ok, i.e. that the received command has been identified
  • 'e': indicates that an error has occurred, i.e. that an invalid command has been received
  • 't': indicates that a timeout has occurred, i.e. that a command which consists of several characters was not completed within a certain time window
  • 'c': indicates that a checksum error has occurred

A checksum is invoked whenever data are transmitted, as e.g. for the 'p','g', and 'd' commands.

Comment: Only the most important simple commands are listed below. There are many more for interacting with the STorM32 controller; please inspect the GUI source code to identify them and their usage.

Command 't'

This command simply returns the character 'o'. Can be used by the host to check if the board is still connected.

Command 'v'

This command returns information on the installed firmware version, the name of the board, and the type of the board. The data packet is appended by a crc, and closed with the character 'o'.

Command 'g'

This command returns a data packet containing all parameter values. The data packet is appended by a crc, and closed with the character 'o'.

Command 'p'

This command sets all parameter values. The command character 'p' needs to be followed by a data packet containing all parameter values, plus a crc. It returns the character 'o'.

Command 'd'

Upon receipt of the command 'd' a data packet containing the current live data is transmitted. The live data is appended by a crc, and closed with the character 'o'. The respective C code snippet is as follows: 

 uint8_t pos = 0;
 // LIVEDATA_STATUS_V2:
 ((u16*)buf)[pos++] = STATE; // state
 ((u16*)buf)[pos++] = status; // status
 ((u16*)buf)[pos++] = status2; // status2
 ((u16*)buf)[pos++] = status3; // status3
 ((u16*)buf)[pos++] = (s16)(Performance.MaxLoopdone*10); // performance
 ((u16*)buf)[pos++] = imu_ntbus_geterrocnt() + imu_onboard_geterrocnt(); // errors
 ((u16*)buf)[pos++] = lipo_voltage(); // lipo_voltage
 // LIVEDATA_TIMES:
 ((u16*)buf)[pos++] = (u16)looptime.millis_32; // timestamp
 ((u16*)buf)[pos++] = 0; // not used
 // LIVEDATA_IMU1GYRO: not included
 // LIVEDATA_IMU1ACC: not included
 // LIVEDATA_IMU1R:
 ((u16*)buf)[pos++] = (s16)(10000*Imu1AHRS.R.x); // Imu1 R estimates, in 0.0001 g
 ((u16*)buf)[pos++] = (s16)(10000*Imu1AHRS.R.y);
 ((u16*)buf)[pos++] = (s16)(10000*Imu1AHRS.R.z);
 // LIVEDATA_IMU1ANGLES:
 ((u16*)buf)[pos++] = (s16)(100*aImu1Angle.Pitch); // Imu1 angles, in 0.01°
 ((u16*)buf)[pos++] = (s16)(100*aImu1Angle.Roll);
 ((u16*)buf)[pos++] = (s16)(100*aImu1Angle.Yaw);
 // LIVEDATA_PIDCNTRL:
 if (IS_ENCODERS_ENABLED || (IS_IMU2_PRESENT && IS_IMU2_FULL && IS_3AXISGIMBAL)) {
   ((u16*)buf)[pos++] = (s16)(100*cPID[PITCH].Cntrl); // PID output, in 0.01°
   ((u16*)buf)[pos++] = (s16)(100*cPID[ROLL].Cntrl);
   ((u16*)buf)[pos++] = (s16)(100*cPID[YAW].Cntrl);
 } else {
   ((u16*)buf)[pos++] = (s16)(100*cPID[PITCH].Cntrl - cPID[PITCH].SetPoint); // relative PID output, in 0.01°
   ((u16*)buf)[pos++] = (s16)(100*cPID[ROLL].Cntrl - cPID[ROLL].SetPoint);
   ((u16*)buf)[pos++] = (s16)(100*cPID[YAW].Cntrl - cPID[YAW].SetPoint);
 }
 // LIVEDATA_INPUTS:
 ((u16*)buf)[pos++] = InputSrc.Pitch; // Rc Input values
 ((u16*)buf)[pos++] = InputSrc.Roll;
 ((u16*)buf)[pos++] = InputSrc.Yaw;
 // LIVEDATA_IMU2ANGLES: (these are the STorM32-Link angles when IS_STORM32LINK_INUSE)
 ((u16*)buf)[pos++] = (s16)(100*aImu2Angle.Pitch); // Imu2 angles, in 0.01°
 ((u16*)buf)[pos++] = (s16)(100*aImu2Angle.Roll);
 ((u16*)buf)[pos++] = (s16)(100*aImu2Angle.Yaw);
 // LIVEDATA_ENCODERANGLES:
 if (IS_ENCODERS_ENABLED || IS_ENCODERS_PRESENT) {
   ((u16*)buf)[pos++] = (s16)(100*motorfoc_aEncoderAngle(PITCH)); // Encoder angles, in 0.01°
   ((u16*)buf)[pos++] = (s16)(100*motorfoc_aEncoderAngle(ROLL));
   ((u16*)buf)[pos++] = (s16)(100*motorfoc_aEncoderAngle(YAW));
 } else {
   ((u16*)buf)[pos++] = (s16)(100*cPID[PITCH].MotorCntrl); // Motor angles, in 0.01°
   ((u16*)buf)[pos++] = (s16)(100*cPID[ROLL].MotorCntrl);
   ((u16*)buf)[pos++] = (s16)(100*cPID[YAW].MotorCntrl);
 }
 // LIVEDATA_STORM32LINK:
 ((u16*)buf)[pos++] = (s16)(100*toR1earthYaw(aImu1Angle.Yaw)); // Imu1 yaw angle in earth frame, in 0.01°
 ((u16*)buf)[pos++] = (s16)(100*getR2earthYaw()); // yaw angle from flight controller, in 0.01°
 // LIVEDATA_IMUACCSTATS:
 ((u16*)buf)[pos++] = (s16)(10000*Imu1AHRS._acc_magnitude);
 ((u16*)buf)[pos++] = (s16)(10000*Imu1AHRS._acc_confidence);
 // LIVEDATA_STORM32LINK 2nd part:
 ((u16*)buf)[pos++] = debug;
 // LIVEDATA_ATTITUDE_RELATIVE: not included
 pos *= 2;
 // add crc
 uint16_t crc = do_crc(buf, pos);
 buf[pos++] = (u8)crc; // low byte
 buf[pos++] = (u8)(crc >> 8); // high byte
 // end character
 uart_transmit_ackchar(closewith); // this sends the data and a 'o'

Command 's'

Upon receipt of the command 's' a data packet containing the current status data is transmitted. The data packet is appended by a crc, and closed with the character 'o'. The command is essentially identical to the 'd' command, except that it transmits only the first seven data values.

Checksum

The checksum for protecting some data packets is the x25 16-bit crc used by MAVLink. C code can be found here.

Serial Communication - RC Commands

In addition to the simple serial commands described in the previous section, the STorM32 controller also understands some messages targeted at remote control of the gimbal. These messages have a stricter data format, and provide a higher level of transmission reliability. They also provide a much richer command set and allow access to STorM32's full potential.

The rules of the communication are exactly as before:

  • The STorM32 board emits a message only upon request, but never by itself.
  • Any received message is acknowledged by a message send back to the host.

The general structure of a data frame is: 

* Startsign: 0xFA for incoming messages, and 0xFB for outgoing messages
* Length: length of the payload, i.e. number of bytes of the data packet excluding
           Start sign, Length byte, Command byte, and crc word
* Command: the command byte
* Payload: as many bytes as expected by the command
* Checksum: x25 16-bit crc excluding start byte, as used by MAVLink; C code can be found here

Comment: The response can be suppressed by using a 0xF9 start sign, instead of a 0xFA.

The following commands can be send to the STorM32 controller:

CMD_GETVERSION (#1)

0xFA 0x00 0x01 crc-low-byte crc-high-byte

If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the firmware version, the setup layout version and board capabilities in this format will be emitted: 

0xFB 0x06 0x01 data1-low data1-high data2-low data2-high data3-low data3-high crc-low-byte crc-high-byte

Data1 is the firmware version, data2 the setup layout version, and data3 holds the board capabilities value.

CMD_GETVERSIONSTR (#2)

0xFA 0x00 0x02 crc-low-byte crc-high-byte

If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the version string, name string and board string in this format will be emitted: 

0xFB 0x30 0x02 data-stream crc-low-byte crc-high-byte

The data stream contains the 16 bytes version string, the 16 bytes name string and the 16 bytes board string.

CMD_GETPARAMETER (#3)

0xFA 0x02 0x03 data-low-byte data-high-byte crc-low-byte crc-high-byte

The data is of type uint16_t and represents the number of the parameter which is requested. If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the parameter value in this format will be emitted: 

0xFB 0x04 0x03 data1-low-byte data1-high-byte data2-low-byte data2-high-byte crc-low-byte crc-high-byte

Data1 is the parameter number and data2 holds the parameter value.

CMD_SETPARAMETER (#4)

0xFA 0x04 0x04 data1-low-byte data1-high-byte data2-low-byte data2-high-byte crc-low-byte crc-high-byte

Data1 is the parameter number and data2 holds the parameter value. As response to this command a CMD_ACK message will be emitted.

CMD_GETDATA (#5)

0xFA 0x01 0x05 type-byte crc-low-byte crc-high-byte

Type specifies the type of the requested data; currently only type 0 is supported. If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the data in this format will be emitted: 

0xFB 0x4A 0x05 type-byte 0x00 data-stream crc-low-byte crc-high-byte

Data-stream holds the data, which is the same data as send by the 'd' command.

CMD_GETDATAFIELDS (#6)

0xFA 0x02 0x06 bitmask-low-byte bitmask-high-byte crc-low-byte crc-high-byte

The bitmask is of type uint16_t and represents a bitmask to specify which data should be send. If an error occurred a CMD_ACK message will be emitted. Otherwise a message containing the bitmask word and all the requested data in this format will be emitted: 

0xFB LEN 0x06 bitmask-low-byte bitmask-high-byte data-stream crc-low-byte crc-high-byte

Bitmask is the bitmask word, and data-stream holds the corresponding data. The following bits can be set: 

0x0002 = LIVEDATA_TIMES
0x0004 = LIVEDATA_IMU1GYRO
0x0008 = LIVEDATA_IMU1ACC
0x0010 = LIVEDATA_IMU1R
0x0020 = LIVEDATA_IMU1ANGLES
0x0040 = LIVEDATA_PIDCNTRL
0x0080 = LIVEDATA_INPUTS
0x0100 = LIVEDATA_IMU2ANGLES
0x0400 = LIVEDATA_STORM32LINK
0x0800 = LIVEDATA_IMUACCSTATS
0x1000 = LIVEDATA_ATTITUDE_RELATIVE
0x2000 = LIVEDATA_STATUS_V2
0x4000 = LIVEDATA_ENCODERANGLES

Note that the order of the flags does not coincide with the order of the respective data in the data-stream; the order in data-stream can be read off from the documentation for the 'd' command. The data send in the 'd' and CMD_GETDATA commands correspond to the bitmask 

LIVEDATA_STATUS_V2 | LIVEDATA_TIMES | LIVEDATA_IMU1R | LIVEDATA_IMU1ANGLES | LIVEDATA_PIDCNTRL | \
LIVEDATA_INPUTS | LIVEDATA_IMU2ANGLES | LIVEDATA_ENCODERANGLES | LIVEDATA_STORM32LINK | LIVEDATA_IMUACCSTATS

Comment: The flags have slightly changed in v2.61, so are slightly different in older firmware versions.

CMD_SETPITCH (#10)

0xFA 0x02 0x0A data-low-byte data-high-byte crc-low-byte crc-high-byte

The data is of type uint16_t and can assume the values 700...2300. It represents the pitch input value. If the value 0 is send, then the pitch axis will be recentered. Any other values are ignored. As response to this command a CMD_ACK message will be emitted.

CMD_SETROLL (#11)

0xFA 0x02 0x0B data-low-byte data-high-byte crc-low-byte crc-high-byte

The data is of type uint16_t and can assume the values 700...2300. It represents the roll input value. If the value 0 is send, then the roll axis will be recentered. Any other values are ignored. As response to this command a CMD_ACK message will be emitted.

CMD_SETYAW (#12)

0xFA 0x02 0x0C data-low-byte data-high-byte crc-low-byte crc-high-byte

The data is of type uint16_t and can assume the values 700...2300. It represents the yaw input value. If the value 0 is send, then the yaw axis will be recentered. Any other values are ignored. As response to this command a CMD_ACK message will be emitted.

CMD_SETPANMODE (#13)

0xFA 0x01 0x0D data-byte crc-low-byte crc-high-byte

The data is of type uint8_t and can assume these values: 0 = off, 1 = HOLDHOLDPAN, 2 = HOLDHOLDHOLD, 3 = PANPANPAN, 4 = PANHOLDHOLD, 5 = PANHOLDPAN, 6 = HOLDPANPAN. As response to this command a CMD_ACK message will be emitted.

CMD_SETSTANDBY(#14)

0xFA 0x01 0x0E data-byte crc-low-byte crc-high-byte

The data is of type uint8_t and can assume these values: 0 = off, 1 = on. As response to this command a CMD_ACK message will be emitted.

CMD_DOCAMERA(#15)

0xFA 0x06 0x0F dummy-byte data-byte dummy-byte dummy-byte dummy-byte dummy-byte crc-low-byte crc-high-byte

The data is of type uint8_t and can assume these values: 0 = off, 1 = SHUTTER, 2 = SHUTTERDELAYED, 3 = VIDEOON, 4 = VIDEOOFF. As response to this command a CMD_ACK message will be emitted.

CMD_SETSCRIPTCONTROL (#16)

0xFA 0x02 0x10 data1-byte data2-byte crc-low-byte crc-high-byte

The data1 and data2 are of type uint8_t. Data1 is the number of the script (0 = scritp1, 1 = script2, etc) and data2 can assume these values: 0 = off, 1 = CASE#DEFAULT, 2 = CASE#1, 3 = CASE#2, 4 = CASE#3, 5 = CASE#4. As response to this command a CMD_ACK message will be emitted.

CMD_SETANGLES (#17)

0xFA 0x0E 0x11 float1 float2 float3 flags-byte type-byte crc-low-byte crc-high-byte

The float1, float2, float3 fields represent 4 bytes each. They are of type float, and correspond to the pitch, roll, and yaw angles in degree. The flags and type bytes are not used and have to be set to zero. As response to this command a CMD_ACK message will be emitted. Comment: In previous firmware versions the flags byte allowed to set the behavior of the angle setting for each axis to unlimited or limited mode. The behavior now corresponds to flags 0, or unlimited mode for all axes.

CMD_SETPITCHROLLYAW (#18)

0xFA 0x06 0x12 data1-low-byte data1-high-byte data2-low-byte data2-high-byte data3-low-byte data3-high-byte crc-low-byte crc-high-byte

The data1, data2 and data3 are each of type uint16_t and can assume the values 700...2300. They represent the pitch, roll, yaw input values. If a value 0 is send, then the respective axis will be recentered. Any other values are ignored. As response to this command a CMD_ACK message will be emitted.

CMD_SETPWMOUT (#19)

0xFA 0x02 0x13 data-low-byte data-high-byte crc-low-byte crc-high-byte

The data is of type uint16_t and can assume the values 700...2300. It represents the pwm pass through input value. As response to this command a CMD_ACK message will be emitted.

CMD_RESTOREPARAMETER (#20)

0xFA 0x02 0x14 data-low-byte data-high-byte crc-low-byte crc-high-byte

The data is of type uint16_t and holds the parameter number. This command sets the parameter to the value in the EEPROM. As response to this command a CMD_ACK message will be emitted.

CMD_RESTOREALLPARAMETER (#21)

0xFA 0x00 0x15 crc-low-byte crc-high-byte

This command sets all parameters to the values stored in the EEPROM. As response to this command a CMD_ACK message will be emitted.

CMD_SETINPUTS (#22)

0xFA 0x17 0x16 data-bytes crc-low-byte crc-high-byte

This overwrites the data received from virtual inputs, if Virtual Channel Configuration = “serial” is configured. The data bytes are formatted similarly to sbus: 16 channels of 11 bit values combined into 22 bytes, plus a status byte. The range is 0...2047, and 1500 equals center. As response to this command a CMD_ACK message will be emitted.

CMD_SETHOMELOCATION (#23)

Deprecated.

CMD_SETTARGETLOCATION (#24)

Deprecated.

CMD_SETINPUTCHANNEL (#25)

0xFA 0x04 0x19 data1-low data1-high data2-low data2-high crc-low-byte crc-high-byte

This overwrites the data received from virtual inputs for the specified channel, if Virtual Channel Configuration = “serial” is configured. The data1 and data2 are of type uint16_t each. Data1 is the channel number. Data2 is the channel value, the range is 700...2300, and 1500 equals center. As response to this command a CMD_ACK message will be emitted.

CMD_SETCAMERA (#26)

0xFA 0x04 0x1A data1-low data1-high data2-low data2-high crc-low-byte crc-high-byte

The data1 and data2 are of type uint16_t each, and can assume the values 700...2300, and 1500 equals center. If the value 0 is send, then the respective input is cleared. Any other values are ignored. Data1 and data2 represent the camera control and camera control2 input values, respectively. As response to this command a CMD_ACK message will be emitted.

CMD_SENDCAMERACOMMAND (#27)

0xFA 0x01-0x12 0x1B data1 ... data24 crc-low-byte crc-high-byte

The data1 to data18 are of type uint8_t. The message can have 1 to 24 of them, i.e., length byte can vary from 0x01 to 0x12. The data are send to the NT Camera uart port. As response to this command a CMD_ACK message will be emitted.

CMD_SETANGLES_UNRESTRICTED (#28)

0xFA 0x18 0x1C float1 float2 float3 float4 float5 float6 crc-low-byte crc-high-byte

The float1 - float6 fields represent 4 bytes each. They are of type float. Float1, float2, float3 correspond to the desired pitch, roll, and yaw angles in degrees. Float4, float5, float6 correspond to the desired pitch rate, roll rate, and yaw rate in degrees per second (only positive values are admitted). A value of zero means that no rate is applied. Comment: The rates are not the components of the angular velocity vector, but indeed the rates of the respective angles. As response to this command a CMD_ACK message will be emitted.

CMD_SETRETRACT(#29)

0xFA 0x01 0x1D data-byte crc-low-byte crc-high-byte

The data is of type uint8_t and can assume these values: 0 = off, 1 = on. As response to this command a CMD_ACK message will be emitted.

CMD_ACTIVEPANMODESETTING (#100)

0xFA 0x01 0x64 data-byte crc-low-byte crc-high-byte

The data is of type uint8_t and is a bit field related to the pan mode setting: default setting = 0x00, setting #1 = 0x01, setting #2 = 0x02, setting #3 = 0x03. As response to this command a CMD_ACK message will be emitted.

CMD_ACK (#150)

0xFB 0x01 0x96 data-byte crc-low-byte crc-high-byte

This command is send by the STorM32 controller to acknowledge execution of a received RC command message (if the message itself doesn't lead to a response, such as e.g. the get parameter command). The data is of type uint8_t and can assume these values: 

0 = SERIALRCCMD_ACK_OK
1 = SERIALRCCMD_ACK_ERR_FAIL
2 = SERIALRCCMD_ACK_ERR_ACCESS_DENIED
3 = SERIALRCCMD_ACK_ERR_NOT_SUPPORTED
150 = SERIALRCCMD_ACK_ERR_TIMEOUT
151 = SERIALRCCMD_ACK_ERR_CRC 
152 = SERIALRCCMD_ACK_ERR_PAYLOADLEN

CMD_CONNECT (#210)

Deprecated.

CMD_GETDATADISPLAY (#213)

Deprecated.

CMD_WIFICONNECTEDPING (#215)

Deprecated.

CMD_STORM32LINK_V1 (#217)

Deprecated.

CMD_STORM32LINK_V2 (#218)

Special command: Is used for transmitting from a flight controller to the STorM32 for the STorM32-Link.

Mavlink Communication

In addition to the commands described in the previous sections, the STorM32 controller also understands MAVLink messages, as defined in the MAVLink standard. The STorM32 controller's MAVLink support is in fact quite rich, and quite complex, and actually provides two MAVLink components. Therefore, the description is placed in a separate article MAVLink Communication.

The STorM32's MAVLink Gimbal component is enabled by opening the [GUI:Interfaces Tool] window, which is accessible via the [GUI:Tools] menu, and setting Mavlink Gimbal to “Gimbal1”, which also sets the component ID. For further details see MAVLink Communication.

Code Examples

Please see Code Examples: Serial Communication.

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