Difference between revisions of "Developer Guide"

From PaparazziUAV
Jump to: navigation, search
m (A great resource for in-depth information.)
(Coding Standards)
 
(33 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== A great resource for in-depth information. ==
+
==Introduction==
 
By the time you land on this page, you probably want to enhance the Paparazzi project, that is really good for your karma and really appreciated. You are welcomed to enhance and extend this documentation.
 
  
*[[Contributing|Contributing]]<br><small>how to contribute</small>
+
By the time you land on this page, you probably want to enhance the Paparazzi project, that is really good for your karma and really appreciated by the Paparazzi community. We welcome contributions and improvements to the documentation.
*[[Builds|Continuous Integration builds]]<br><small>Info on the CI server</small>
+
[[Image:FixIt.jpg|right|FixIt]]
*[[DevGuide/Communications|Communications]]<br><small>how telemetry and datalink is done</small>
 
*[[DevGuide/CommunicationsNew|Communications (Proposed New system)]]<br><small>how telemetry and datalink is done</small>
 
*[[DevGuide/Server_GCS_com|Server-GCS communications]]<br><small>how the Server and the Ground Control Station interact with each other</small>
 
*[[DevGuide/Values|Values]]<br><small>a short walk through the system</small>
 
*[[DevGuide/USBDownload|USB Download]]<br><small>how the Paparazzi USB bootloader works</small>
 
*[[BootloaderUploadHowTo|Upload Bootloader]]<br><small>How to upload the Bootloader to a LPC2148 processor based AP board like the TWOG</small>
 
*[[BootloaderUploadHowToSTM32|Upload the luftboot bootloader]]<br><small>How to upload the Bootloader to a STM32 processor based AP board like the LISA</small>
 
*[[DevGuide/JTAG-Debug|JTAG-Debug]]<br><small>using JTAG to directly debug on the board</small>
 
*[[DevGuide/DesignOverview|Design Overview]]<br><small>Attempt at a longer walk through the airborne code architecture</small>
 
*[[FirmwareArchitecture|Firmware Architecture]]<br><small>Attempt at brief overview of the firmware architecture with modules and subsystems</small>
 
*[[DevGuide/USB-Serial|USB-Serial]]<br><small>using the USB instead of the UART for telemetry</small>
 
*[[Installation/FromScratch| Toolchain]]<br><small>Install Paparazzi ARM toolchain and IVY from scratch</small>
 
*[[DevGuide/CodeEditors|Code Editing]]<br><small>How to setup an IDE for OCAML and C and C++</small>
 
*[[DevGuide/LearningToProgram|Learning to Program]]<br><small>Improve your Paparazzi code in OCAML,C,C++ and Python</small>
 
*[[DevGuide/Mathlib|Paparazzi Math Library]]<br><small>The custom paparazzi math library (C) and how to use it in external programs</small>
 
*[[DevGuide/Settings|Settings]]<br><small>Settings is the generic mechanism that allows to set and get the value of any variable of the embedded code.</small>
 
  
 +
See also [[Doxygen]] for documentation close to the code.
  
*[[ControlTheory]]<br><small>The harsh reality about the Control Theory</small>
+
==[[Contributing|Contributing]]==
*[[Reference/bootloader]]<br><small>All questions about bootloader but where afraid to ask</small>
+
You would like to contribute, but are not sure how, then [[Contributing|this is the page to visit]]
*[[Demystified/Altitude and Height|Altitude and Height]]<br><small>Altitude and Height demystified</small>
+
 
*[[Abi]]
+
==[[DevGuide/CodeEditors|Code Editing]]==
*[[DevGuide/StateInterface]]<br><small>A stateinterface is a stateinterface is a stateinterface, poems aside read more here</small>
+
How to setup your IDE for use with the source code
 +
 
 +
==[[DevGuide/LearningToProgram|Learning to Program]]==
 +
Improve your Paparazzi code in OCAML,C,C++ and Python
 +
 
 +
==[[DevGuide/AircraftBuildProcess|Aircraft build process and code generation]]==
 +
Description of the (rather complicated) build system and code generation regarding the airborne firmwares
 +
 
 +
==[[DevGuide/DesignOverview|Design Overview]]==
 +
Attempt at a longer walk through the airborne code architecture
 +
 
 +
==[[FirmwareArchitecture|Firmware Architecture]]==
 +
Attempt at brief overview of the firmware architecture with modules and subsystems
 +
 
 +
==[[DevGuide/Communications|Communications]]==
 +
How telemetry and datalink is done
 +
 
 +
==[[DevGuide/CommunicationsNew|Communications (Proposed New system)]]==
 +
How the telemetry and datalink works
 +
 
 +
==[[DevGuide/Server_GCS_com|Server-GCS communications]]==
 +
How the Server and the Ground Control Station interact with each other
 +
 
 +
==[[DevGuide/Values|Values]]==
 +
A short walk through the system and how values are handled
 +
 
 +
==[[DevGuide/Settings|Settings]]==
 +
Settings is the generic mechanism that allows to set and get the value of any variable of the embedded code.
 +
 
 +
==[[DevGuide/Mathlib|Paparazzi Math Library]]==
 +
The custom Paparazzi math library written in C and how to use it in external programs
 +
 
 +
==[[Reference/bootloader]]==
 +
All of the questions and answers about the bootloader, but were afraid to ask
 +
 
 +
===[[Lpc21iap|LPC USB firmware]]===
 +
All of the answers to the Paparazzi USB bootloader of question you never dared to ask
 +
 
 +
====[[Lpc21BootloaderUpload|Upload Bootloader for LPC21xx]]====
 +
How to [[[[Lpc21BootloaderUpload|upload the Bootloader]] to a LPC2148 processor based Autopilot board like the TWOG
 +
 
 +
===[[Luftboot|Upload the luftboot bootloader]]===
 +
How to upload the Bootloader to a STM32 processor based Autopilot board like the [[Elle0]] or [[Lisa/M]]
 +
 
 +
===[[DFU|Upload with DFU (with native or custom dfu bootloader)]]===
 +
Using the native (embedded in ROM) or custom (e.g. [[Luftboot]] or [[KroozSD#Bootloader|KroozSD]]==) bootloader to upload Paparazzi code
 +
 
 +
===[[STLink|Upload with STLink via SWD (without Bootloader)]]===
 +
General ST-LinkV2 page.
 +
 
 +
==[[DevGuide/GDB_OpenOCD_Debug|GDB OpenOCD Debug]]==
 +
Using GDB or OpenOCD to directly flash and debug Hardware
 +
 
 +
==[[DevGuide/USB-Serial|USB-Serial]]==
 +
Using a USB connection instead of UART for use with telemetry
 +
 
 +
==[[ControlTheory]]==
 +
All [[ControlTheory|information you are looking for about the harsh reality of Control Theory]] needed to let your aircraft fly
 +
 
 +
==[[Demystified/Altitude and Height|Altitude and Height]]==
 +
Altitude and Height demystified
 +
 
 +
==[[Abi|AirBorne Interface ABI]]==
 +
Presentation of the airborne communication system
 +
 
 +
==[[DevGuide/StateInterface]]==
 +
A stateinterface is a stateinterface is a stateinterface, [[DevGuide/StateInterface|poems aside read more about what the stateinterface entails here]]
 +
 
 +
==[[RT_Paparazzi]]==
 +
[[RT_Paparazzi|Real Time Paparazzi]] how-to and guidelines
 +
 
 +
==[[Builds|Continuous Integration builds]]==
 +
Info on the [[Builds|Continuous Integration builds]] (CI) server
 +
 
 +
==Coding Standards==
 +
JPL (Jet Propulsion Laboratory) released their own coding standards (can be downloaded for free here: [http://lars-lab.jpl.nasa.gov/JPL_Coding_Standard_C.pdf JPL C Coding Standards and Guidelines]). They include MISRA-C rules and directives, but add their own rules on top of that. They also specify different levels of compliance (LOC) because not always it is necessary to comply with all of the rules. Anyway, they are making things that go to space, so we can definitely learn something about good coding practices from them.
 +
 
 +
==[[DevGuide/Releasing]]==
 +
Info for maintainers on how to create a new release.
  
 
[[Category:Developer_Documentation]]
 
[[Category:Developer_Documentation]]

Latest revision as of 07:42, 28 November 2017

Introduction

By the time you land on this page, you probably want to enhance the Paparazzi project, that is really good for your karma and really appreciated by the Paparazzi community. We welcome contributions and improvements to the documentation.

FixIt

See also Doxygen for documentation close to the code.

Contributing

You would like to contribute, but are not sure how, then this is the page to visit

Code Editing

How to setup your IDE for use with the source code

Learning to Program

Improve your Paparazzi code in OCAML,C,C++ and Python

Aircraft build process and code generation

Description of the (rather complicated) build system and code generation regarding the airborne firmwares

Design Overview

Attempt at a longer walk through the airborne code architecture

Firmware Architecture

Attempt at brief overview of the firmware architecture with modules and subsystems

Communications

How telemetry and datalink is done

Communications (Proposed New system)

How the telemetry and datalink works

Server-GCS communications

How the Server and the Ground Control Station interact with each other

Values

A short walk through the system and how values are handled

Settings

Settings is the generic mechanism that allows to set and get the value of any variable of the embedded code.

Paparazzi Math Library

The custom Paparazzi math library written in C and how to use it in external programs

Reference/bootloader

All of the questions and answers about the bootloader, but were afraid to ask

LPC USB firmware

All of the answers to the Paparazzi USB bootloader of question you never dared to ask

Upload Bootloader for LPC21xx

How to [[upload the Bootloader to a LPC2148 processor based Autopilot board like the TWOG

Upload the luftboot bootloader

How to upload the Bootloader to a STM32 processor based Autopilot board like the Elle0 or Lisa/M

Upload with DFU (with native or custom dfu bootloader)

Using the native (embedded in ROM) or custom (e.g. Luftboot or KroozSD==) bootloader to upload Paparazzi code

Upload with STLink via SWD (without Bootloader)

General ST-LinkV2 page.

GDB OpenOCD Debug

Using GDB or OpenOCD to directly flash and debug Hardware

USB-Serial

Using a USB connection instead of UART for use with telemetry

ControlTheory

All information you are looking for about the harsh reality of Control Theory needed to let your aircraft fly

Altitude and Height

Altitude and Height demystified

AirBorne Interface ABI

Presentation of the airborne communication system

DevGuide/StateInterface

A stateinterface is a stateinterface is a stateinterface, poems aside read more about what the stateinterface entails here

RT_Paparazzi

Real Time Paparazzi how-to and guidelines

Continuous Integration builds

Info on the Continuous Integration builds (CI) server

Coding Standards

JPL (Jet Propulsion Laboratory) released their own coding standards (can be downloaded for free here: JPL C Coding Standards and Guidelines). They include MISRA-C rules and directives, but add their own rules on top of that. They also specify different levels of compliance (LOC) because not always it is necessary to comply with all of the rules. Anyway, they are making things that go to space, so we can definitely learn something about good coding practices from them.

DevGuide/Releasing

Info for maintainers on how to create a new release.