Modules - Revision history

Flixr: add autoload

2016-06-17T21:23:14Z

add autoload

← Older revision		Revision as of 15:23, 17 June 2016
Line 131:		Line 131:
	** comma separated list of conflicting modules		** comma separated list of conflicting modules
	** the elements can be a xml file (in conf/modules) or a module name (as set in the module xml 'name' node)		** the elements can be a xml file (in conf/modules) or a module name (as set in the module xml 'name' node)

			* autoload (0 or 1 'autoload' node)
			** name : the name of the module which should also be automatically loaded

	* header (0 or 1 'header' node)		* header (0 or 1 'header' node)

IHaveADrone: spelling

2016-06-06T18:32:15Z

spelling

← Older revision		Revision as of 12:32, 6 June 2016
Line 99:		Line 99:
	* module		* module
	** name : this parameter is the name of the module (mandatory)		** name : this parameter is the name of the module (mandatory)
	** dir : the name of the directory in '''sw/airborne/modules''' where the source code is located (in the above ~~exemple~~: sw/airborne/modules/demo_module), if not specified, the name of the module is used as default directory name		** dir : the name of the directory in '''sw/airborne/modules''' where the source code is located (in the above example: sw/airborne/modules/demo_module), if not specified, the name of the module is used as default directory name

	* doc		* doc

Flixr: /* Telemetry */

2016-05-25T08:24:02Z

Telemetry

← Older revision		Revision as of 02:24, 25 May 2016
Line 187:		Line 187:
	<message name="SOME_MODULE_MSG" period="2" module="module_name"/>		<message name="SOME_MODULE_MSG" period="2" module="module_name"/>
	</source>		</source>

			This functionality was removed again in v5.9 ([https://github.com/paparazzi/paparazzi/pull/1678 #1678]), since it is not needed anymore with the <tt>register_periodic_telemetry</tt> functionality we have since v5.0.

	[[Category:Developer_Documentation]] [[Category:Modules]]		[[Category:Developer_Documentation]] [[Category:Modules]]

Ghattenb: /* In the airframe file */

2016-02-16T17:50:09Z

In the airframe file

@@ Line 29: / Line 29: @@
 </source>
 }}
-* The main_freq parameter (in Hz) is optional. If present, it allows to specify the frequency of the main loop. Default is '''60 Hz'''. If not needed to be specified, then the first line is just: <modules>
+* The main_freq parameter (in Hz) is optional. If present, it allows to specify the frequency of the main loop. Default is the ''main periodic frequency'' of the autopilot. If not needed to be specified, then the first line is just: <modules>
 * The children "define" generate compilation defines for all the targets of a module and can be used with or without value. It allows to keep the module description more generic add to place the airframe dependent parameters in the airframe xml file.
 * The child "configure" generates a makefile variable.
 === In the module file ===

IHaveADrone: spelling

2016-02-04T15:07:12Z

spelling

← Older revision		Revision as of 09:07, 4 February 2016
Line 12:		Line 12:
	=== Make your own ===		=== Make your own ===

	It is very possible to make your own module and to share it with the world. To make it ~~eaven~~ easier there is a helper tool called "create_module" in the main Paparazzi directory. Try it, you'll be ~~surprized~~ how easy it is to start your own module with the help of this tool.		It is very possible to make your own module and to share it with the world. To make it even easier there is a helper tool called "create_module" in the main Paparazzi directory. Try it, you'll be surprised how easy it is to start your own module with the help of this tool.

	=== In the airframe file ===		=== In the airframe file ===

Ghattenb: /* In the module file */

2016-02-02T21:49:41Z

In the module file

← Older revision		Revision as of 15:49, 2 February 2016
Line 48:		Line 48:
	<define name="DEMO_MODULE_LED" value="LED_X" description="LED Selection"/>		<define name="DEMO_MODULE_LED" value="LED_X" description="LED Selection"/>
	</doc>		</doc>
			<settings>
			<dl_settings name="bla">
			<dl_setting min="0" max="5" step="1" var="bla_bla" shortname="bb"/>
			</dl_settings>
			<settings>
	<depends>foo.xml,bar\|baz</depends>		<depends>foo.xml,bar\|baz</depends>
	<conficts>boo</conflicts>		<conficts>boo</conflicts>
Line 77:		Line 82:
	** configure: describe the possible configuration options for this module with default values and a short description (usually called from the [[Airframe_Configuration\|airframe firmware section]])		** configure: describe the possible configuration options for this module with default values and a short description (usually called from the [[Airframe_Configuration\|airframe firmware section]])
	** section: describe the parameters that can be added as a section in the [[Airframe_Configuration\|airframe configuration file]]		** section: describe the parameters that can be added as a section in the [[Airframe_Configuration\|airframe configuration file]]

			* settings_file (0 or more)
			** file name of a settings xml file

			* settings (0 or more): use the same format than systems [[Settings]]
			** target: a list of targets allowed or forbidden for which embedded settings should be used
			** dl_settings node with a tab name
			*** dl_setting: setting description, see [[Settings]] page for details

	* depends (0 or 1 'depends' node)		* depends (0 or 1 'depends' node)

Flixr: /* In the module file */ doc is mandatory

2015-12-10T13:35:40Z

In the module file: doc is mandatory

← Older revision		Revision as of 07:35, 10 December 2015
Line 72:		Line 72:
	** dir : the name of the directory in '''sw/airborne/modules''' where the source code is located (in the above exemple: sw/airborne/modules/demo_module), if not specified, the name of the module is used as default directory name		** dir : the name of the directory in '''sw/airborne/modules''' where the source code is located (in the above exemple: sw/airborne/modules/demo_module), if not specified, the name of the module is used as default directory name

	* doc ~~(0 or 1 'doc' node)~~		* doc
	** description: a description of the module. The content of the first line until the dot is treated as the brief description used as the name in the [http://paparazzi.github.com/docs/latest/onboard_modules.html generated docs].		** description: a description of the module. The content of the first line until the dot is treated as the brief description used as the name in the [http://paparazzi.github.com/docs/latest/onboard_modules.html generated docs] (mandatory).
	** define: describe the possible define flags for this module with default values and a short description (usually called from the [[Airframe_Configuration\|airframe firmware section]])		** define: describe the possible define flags for this module with default values and a short description (usually called from the [[Airframe_Configuration\|airframe firmware section]])
	** configure: describe the possible configuration options for this module with default values and a short description (usually called from the [[Airframe_Configuration\|airframe firmware section]])		** configure: describe the possible configuration options for this module with default values and a short description (usually called from the [[Airframe_Configuration\|airframe firmware section]])

Flixr: add info about new depends and conflicts (replacing depend)

2014-12-16T12:32:49Z

add info about new depends and conflicts (replacing depend)

← Older revision		Revision as of 06:32, 16 December 2014
Line 48:		Line 48:
	<define name="DEMO_MODULE_LED" value="LED_X" description="LED Selection"/>		<define name="DEMO_MODULE_LED" value="LED_X" description="LED Selection"/>
	</doc>		</doc>
	<~~depend require="bla~~.xml~~" conflict="~~boo"/>		<depends>foo.xml,bar\|baz</depends>
			<conficts>boo</conflicts>
	<header>		<header>
	<file name="demo_module.h"/>		<file name="demo_module.h"/>
Line 77:		Line 78:
	** section: describe the parameters that can be added as a section in the [[Airframe_Configuration\|airframe configuration file]]		** section: describe the parameters that can be added as a section in the [[Airframe_Configuration\|airframe configuration file]]

			* depends (0 or 1 'depends' node)
			** comma separated list of required modules
			** allows to specify OR dependencies with pipe (\|) similar to Debian depends, ex: <code>foo,bar\|baz</code> would make it depend on foo AND (bar OR baz)
			** the elements can be a xml file (in conf/modules) or a module name (as set in the module xml 'name' node)
			<div class="toccolours mw-collapsible mw-collapsed" style="width:800px">
			Prior to '''v5.3.0_testing''' we had one <tt>depend</tt> node instead of <tt>depends</tt> and <tt>conflicts</tt>:
			<div class="mw-collapsible-content">'depend' node used prior to '''v5.3_devel-438-g8be5c42'''):
	* depend (0 or 1 'depend' node)		* depend (0 or 1 'depend' node)
	** require : the list of required modules		** require : the list of required modules
Line 82:		Line 90:
	** the elements of a list are separated with a pipe (\|), ex: "bla\|boo"		** the elements of a list are separated with a pipe (\|), ex: "bla\|boo"
	** the elements can be a xml file (in conf/modules) or a module name (in sw/airborne/modules)		** the elements can be a xml file (in conf/modules) or a module name (in sw/airborne/modules)
			</div></div>
			* conflicts (0 or 1 'conflicts' node)
			** comma separated list of conflicting modules
			** the elements can be a xml file (in conf/modules) or a module name (as set in the module xml 'name' node)

	* header (0 or 1 'header' node)		* header (0 or 1 'header' node)

IHaveADrone: typo

2014-11-06T19:07:38Z

typo

← Older revision		Revision as of 13:07, 6 November 2014
Line 12:		Line 12:
	=== Make your own ===		=== Make your own ===

	It is very possible to make your own module and to share it with the world. To make it eaven easier there is a helper tool called "create_module" in the main Paparazzi directory. Try it, you'll be surprized how easy it is to start your own module with the ~~hep~~ of this tool.		It is very possible to make your own module and to share it with the world. To make it eaven easier there is a helper tool called "create_module" in the main Paparazzi directory. Try it, you'll be surprized how easy it is to start your own module with the help of this tool.

	=== In the airframe file ===		=== In the airframe file ===

Openuas at 21:43, 5 November 2014

2014-11-05T21:43:11Z

← Older revision		Revision as of 15:43, 5 November 2014
Line 9:		Line 9:

	The auto-generated list and short doc for all modules in the master branch can be found at the [http://docs.paparazziuav.org/latest/onboard_modules.html onboard modules page of the doxygen docs].		The auto-generated list and short doc for all modules in the master branch can be found at the [http://docs.paparazziuav.org/latest/onboard_modules.html onboard modules page of the doxygen docs].

			=== Make your own ===

			It is very possible to make your own module and to share it with the world. To make it eaven easier there is a helper tool called "create_module" in the main Paparazzi directory. Try it, you'll be surprized how easy it is to start your own module with the hep of this tool.

	=== In the airframe file ===		=== In the airframe file ===