Difference between revisions of "Release Upgrades"

From PaparazziUAV
Jump to navigation Jump to search
(Created page with "The latest stable release is: '''v5.0.0_stable''' This page is help guide any software configuration changes in airframe files or configuration files, as well as provides hints …")
 
(start adding upgrade information for v5.6)
 
(13 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The latest stable release is: '''v5.0.0_stable'''
__TOC__
'''Release information and tarballs can be found at https://github.com/paparazzi/paparazzi/releases or accessed directly via [[git]].'''
 
<span style="color:red">'''Please also have a look at the [https://github.com/paparazzi/paparazzi/blob/master/CHANGELOG.md CHANGELOG]'''</span>
 
When this page was last update the latest stable release was: '''v5.4.2_stable'''


This page is help guide any software configuration changes in airframe files or configuration files, as well as provides hints around any behaviour or workflow changes.
This page is help guide any software configuration changes in airframe files or configuration files, as well as provides hints around any behaviour or workflow changes.
Line 7: Line 12:
DISCLAIMER: This page is by no means guaranteed to be complete. If you find another required change that was missed, please add it!
DISCLAIMER: This page is by no means guaranteed to be complete. If you find another required change that was missed, please add it!


== Upgrading from v4.2.0_stable to v5.0.0_stable ==
== Upgrading to v5.6.x ==
'''v5.6 has not been released yet, this refers to the current release candidates v5.5.x_testing'''
 
=== AHRS ===
 
The <tt>ahrs infrared</tt> subsystem has been converted to a module. See also [http://docs.paparazziuav.org/latest/module__infrared_adc.html ahrs infrared module docs].
{{Box Code|conf/airframes/myplane.xml|
<source lang="xml">
  <firmware name="fixedwing">
    ...
-  <subsystem name="ahrs" type="infrared"/>
  </firmware>
  <modules>
+  <load name="ahrs_infrared.xml"/>
  </modules>
</source>
}}
 
=== digital_cam modules ===
 
specify time in senconds:
* replace <tt>DC_AUTOSHOOT_QUARTERSEC_PERIOD</tt> with <tt>DC_AUTOSHOOT_PERIOD</tt> in seconds
* <tt>DC_SHUTTER_DELAY</tt> and <tt>DC_POWER_OFF_DELAY</tt> are now in seconds
See also [http://docs.paparazziuav.org/latest/onboard_modules.html#modules_category_digital_cam digital cam module docs]
 
== Upgrading from v5.0.x_stable to v5.2.x_stable ==
 
Extra navigation routines have been converted to modules ([https://github.com/paparazzi/paparazzi/pull/512 #512]).<br/>
This means you have to explicitly add the module if you want to use one of these navigation routines, see [http://docs.paparazziuav.org/latest/onboard_modules.html#modules_category_nav list of nav modules].<br/>
The naming of the functions has also been harmonized across all nav modules to <tt>nav_foo_setup</tt> and <tt>nav_foo_run</tt>.
 
=== INS ===
* INS_BARO_SENS has been removed.
* INS_SONAR_VARIANCE_THRESHOLD has been removed.
* ALT_KALMAN_ENABLED removed.
 
=== Flightplans ===
 
* <tt>'''GetAltRef()'''</tt> replaces <tt>'''ground_alt'''</tt>
 
=== Fixedwing airframes ===
 
Further altitude/climb estimator clean-up.
 
Remove the ALT_KALMAN_ENABLED define, it's always enabled if you use the ins alt_float subsystem.
{{Box Code|conf/airframes/myplane.xml|
<source lang="xml">
    <section name="MISC">
      ...
-    <define name="ALT_KALMAN_ENABLED" value="TRUE"/> <!-- can also be set to FALSE (default if not present) -->
    </section>
 
    <firmware name="fixedwing">
      ...
      <subsystem name="ins" type="alt_float"/>
    </firmware>
</source>
}}
 
== Upgrading from v4.2.x_stable to v5.0.x_stable ==


Changelog for this release on GitHub: [https://github.com/paparazzi/paparazzi/blob/v5.0/CHANGELOG.md changelog]
Changelog for this release on GitHub: [https://github.com/paparazzi/paparazzi/blob/v5.0/CHANGELOG.md changelog]
Line 25: Line 89:
The adoption of the '''state interface''' means a number of functions and variables previously used in the flightplans are no longer valid, and must be replaced by their equivalent:
The adoption of the '''state interface''' means a number of functions and variables previously used in the flightplans are no longer valid, and must be replaced by their equivalent:


* <tt>'''GpsPosAlt()'''</tt> replaces <tt>'''estimator_z'''</tt>
* <tt>'''GetPosAlt()'''</tt> replaces <tt>'''estimator_z'''</tt>
* <tt>'''GetPosX()'''</tt> replaces <tt>'''estimator_x'''</tt>
* <tt>'''GetPosY()'''</tt> replaces <tt>'''estimator_y'''</tt>
* <tt>'''autopilot_flight_time'''</tt> replaces <tt>'''estimator_flight_time'''</tt>
* <tt>'''autopilot_flight_time'''</tt> replaces <tt>'''estimator_flight_time'''</tt>


Line 62: Line 128:
     <firmware name="fixedwing">
     <firmware name="fixedwing">
       ...
       ...
+    <subsystem name="ins" type="alt_float" />
+    <subsystem name="ins" type="alt_float"/>
     </firmware>
     </firmware>
</source>
</source>
Line 72: Line 138:
     <firmware name="fixedwing">
     <firmware name="fixedwing">
       ...
       ...
+    <subsystem name="ins" type="gps_passthrough" />
+    <subsystem name="ins" type="gps_passthrough"/>
     </firmware>
     </firmware>
</source>
</source>
Line 89: Line 155:
}}
}}


- <section name="MIXING" prefix="MOTOR_MIXING_"> instead of <section name="SUPERVISION" prefix="SUPERVISION_">
* servos need a driver <servos driver="Asctec">
- servos need a driver <servos driver="Asctec">
    <command_laws>
-  <command_laws>
    <call fun="motor_mixing_run(autopilot_motors_on,FALSE,values)"/>
    <call fun="motor_mixing_run(autopilot_motors_on,FALSE,values)"/>
    <set servo="FRONT"  value="motor_mixing.commands[SERVO_FRONT]"/>
    <set servo="FRONT"  value="motor_mixing.commands[SERVO_FRONT]"/>
    <set servo="BACK"  value="motor_mixing.commands[SERVO_BACK]"/>
    <set servo="BACK"  value="motor_mixing.commands[SERVO_BACK]"/>
    <set servo="RIGHT"  value="motor_mixing.commands[SERVO_RIGHT]"/>
    <set servo="RIGHT"  value="motor_mixing.commands[SERVO_RIGHT]"/>
    <set servo="LEFT"  value="motor_mixing.commands[SERVO_LEFT]"/>
    <set servo="LEFT"  value="motor_mixing.commands[SERVO_LEFT]"/>
    </command_laws>
  </command_laws>


- <define name="TRIM_A" value="0"/>
    - <define name="TRIM_A" value="0"/>
- <define name="TRIM_E" value="0"/>
    - <define name="TRIM_E" value="0"/>
- <define name="TRIM_R" value="0"/>
    - <define name="TRIM_R" value="0"/>
+ <define name="TRIM_ROLL" value="0"/>
    + <define name="TRIM_ROLL" value="0"/>
+ <define name="TRIM_PITCH" value="0"/>
    + <define name="TRIM_PITCH" value="0"/>
+ <define name="TRIM_YAW" value="0"/>
    + <define name="TRIM_YAW" value="0"/>


     - <define name="MIN_MOTOR" value="3"/>    replaced by min value in servo
     - <define name="MIN_MOTOR" value="3"/>    replaced by min value in servo
     - <define name="MAX_MOTOR" value="200"/>  replaced by neutral value in servo
     - <define name="MAX_MOTOR" value="200"/>  replaced by neutral value in servo


    + an INS subsystem is now compulsory
* an INS subsystem is now compulsory
 


=== Advanced Code and Makefile ===
=== Advanced Code and Makefile ===
Line 128: Line 192:
* Default actuator driver
* Default actuator driver
* ADC_CHANNEL_X -> X
* ADC_CHANNEL_X -> X
[[Category:Software]] [[Category:User_Documentation]]

Latest revision as of 14:18, 15 July 2015

Release information and tarballs can be found at https://github.com/paparazzi/paparazzi/releases or accessed directly via git.

Please also have a look at the CHANGELOG

When this page was last update the latest stable release was: v5.4.2_stable

This page is help guide any software configuration changes in airframe files or configuration files, as well as provides hints around any behaviour or workflow changes.

In any codeblocks, a leading - indicates one should remove the line, while a leading + indicates one should add the line. In other cases, only names have changed.

DISCLAIMER: This page is by no means guaranteed to be complete. If you find another required change that was missed, please add it!

Upgrading to v5.6.x

v5.6 has not been released yet, this refers to the current release candidates v5.5.x_testing

AHRS

The ahrs infrared subsystem has been converted to a module. See also ahrs infrared module docs.

File: conf/airframes/myplane.xml 
  <firmware name="fixedwing">
    ...
-   <subsystem name="ahrs" type="infrared"/>
  </firmware>
  <modules>
+   <load name="ahrs_infrared.xml"/>
  </modules>

digital_cam modules

specify time in senconds:

  • replace DC_AUTOSHOOT_QUARTERSEC_PERIOD with DC_AUTOSHOOT_PERIOD in seconds
  • DC_SHUTTER_DELAY and DC_POWER_OFF_DELAY are now in seconds

See also digital cam module docs

Upgrading from v5.0.x_stable to v5.2.x_stable

Extra navigation routines have been converted to modules (#512).
This means you have to explicitly add the module if you want to use one of these navigation routines, see list of nav modules.
The naming of the functions has also been harmonized across all nav modules to nav_foo_setup and nav_foo_run.

INS

  • INS_BARO_SENS has been removed.
  • INS_SONAR_VARIANCE_THRESHOLD has been removed.
  • ALT_KALMAN_ENABLED removed.

Flightplans

  • GetAltRef() replaces ground_alt

Fixedwing airframes

Further altitude/climb estimator clean-up.

Remove the ALT_KALMAN_ENABLED define, it's always enabled if you use the ins alt_float subsystem.

File: conf/airframes/myplane.xml 
    <section name="MISC">
       ...
-     <define name="ALT_KALMAN_ENABLED" value="TRUE"/> <!-- can also be set to FALSE (default if not present) -->
    </section>

    <firmware name="fixedwing">
       ...
      <subsystem name="ins" type="alt_float"/>
    </firmware>

Upgrading from v4.2.x_stable to v5.0.x_stable

Changelog for this release on GitHub: changelog

Control Panel

A new simulator launcher has been added to better select between the different types of simulator (OCAML fixed-wing, JSBSim fixed-wing, NPS, etc). The launcher path must be changed to support this:

File: conf/controlpanel.xml 
-   <program name="Simulator" command="sw/simulator/launchsitl">
+   <program name="Simulator" command="sw/simulator/pprzsim-launch">

Flightplans

The adoption of the state interface means a number of functions and variables previously used in the flightplans are no longer valid, and must be replaced by their equivalent:

  • GetPosAlt() replaces estimator_z
  • GetPosX() replaces estimator_x
  • GetPosY() replaces estimator_y
  • autopilot_flight_time replaces estimator_flight_time

Advanced flightplans will likely require additional changes.

Airframes

A number of changes to clarify names and clean up subsystems and modules means airframe files must be updated:

All Airframes

  • CONTROL_FREQUENCY replaces CONTROL_RATE

Fixedwing Airframes

The altitude/climb estimator has been cleaned up.

Change the way the altitude kalman filter is enabled:

File: conf/airframes/myplane.xml 
    <section name="MISC">
       ...
+    <define name="ALT_KALMAN_ENABLED" value="TRUE"/> <!-- can also be set to FALSE (default if not present) -->
    </section>

    <firmware name="fixedwing">
       ...
-    <define name="ALT_KALMAN"/>
    </firmware>

Add the altitude INS subsystem if there is an ALT_KALMAN_ENABLED define or if you use a barometer:

File: conf/airframes/myplane.xml 
    <firmware name="fixedwing">
       ...
+    <subsystem name="ins" type="alt_float"/>
    </firmware>

Alternatively, use the gps_passthrough subsystem to use direct GPS data (remove all ALT_KALMAN_ENABLED):

File: conf/airframes/myplane.xml 
    <firmware name="fixedwing">
       ...
+    <subsystem name="ins" type="gps_passthrough"/>
    </firmware>

Rotorcraft Airframes

The motor mixing has been updated and renamed:

File: conf/airframes/myplane.xml 
-   <section name="SUPERVISION" prefix="SUPERVISION_">
+   <section name="MIXING" prefix="MOTOR_MIXING_">
       ...
    </section>
  • servos need a driver <servos driver="Asctec">
   <command_laws>
   <call fun="motor_mixing_run(autopilot_motors_on,FALSE,values)"/>
   <set servo="FRONT"  value="motor_mixing.commands[SERVO_FRONT]"/>
   <set servo="BACK"   value="motor_mixing.commands[SERVO_BACK]"/>
   <set servo="RIGHT"  value="motor_mixing.commands[SERVO_RIGHT]"/>
   <set servo="LEFT"   value="motor_mixing.commands[SERVO_LEFT]"/>
   </command_laws>

   - <define name="TRIM_A" value="0"/>
   - <define name="TRIM_E" value="0"/>
   - <define name="TRIM_R" value="0"/>
   + <define name="TRIM_ROLL" value="0"/>
   + <define name="TRIM_PITCH" value="0"/>
   + <define name="TRIM_YAW" value="0"/>

   - <define name="MIN_MOTOR" value="3"/>    replaced by min value in servo
   - <define name="MAX_MOTOR" value="200"/>  replaced by neutral value in servo
  • an INS subsystem is now compulsory

Advanced Code and Makefile

Board Makefiles

In any conf/boards/board_name.makefile:

  • add $(TARGET).LDSCRIPT
  • ?= can replace ifndef statements or = statements to allow overrides
  • add a default actuator configuration (can be overridden by a configure option in the firmware section)
    • ACTUATORS ?= actuators_pwm

Board Header Files

In all sw/airborne/boards/'board_name.h:

  • add EXT_CLK
  • change to libopencm3
  • Default actuator driver
  • ADC_CHANNEL_X -> X
Retrieved from "http://wiki.paparazziuav.org/w/index.php?title=Release_Upgrades&oldid=20160"