Autopilot configuration reference: Difference between revisions

Jump to navigation Jump to search
m
→‎Available elements: Syntaxhighlight
m (→‎Available elements: Syntaxhighlight)
Line 123: Line 123:
All elements may contain the attributes "include" and "alias".  
All elements may contain the attributes "include" and "alias".  
The "include" property takes a file name as a parameter. This can be used to read the document tree of an external XML file into the node containing the "include" attribute. The included file must have a PropertyList node as the root node. All nodes under this PropertyList node will be added to the node containing the "include" attribute.
The "include" property takes a file name as a parameter. This can be used to read the document tree of an external XML file into the node containing the "include" attribute. The included file must have a PropertyList node as the root node. All nodes under this PropertyList node will be added to the node containing the "include" attribute.
The "alias" attribute refers to an element defined elsewhere in this XMl document. Alias references are in a path-style syntax, either as a relative or absolute path. Absolute paths start with a slash, like <foo alias="/params/bar/baz"/>. Use the colon to move through the document tree, similar to file system paths like <foo alias="../../bar/baz"/>.
The "alias" attribute refers to an element defined elsewhere in this XMl document. Alias references are in a path-style syntax, either as a relative or absolute path. Absolute paths start with a slash, like <syntaxhighlight lang="xml" inline><foo alias="/params/bar/baz"/></syntaxhighlight>. Use the colon to move through the document tree, similar to file system paths like <syntaxhighlight lang="xml" inline><foo alias="../../bar/baz"/></syntaxhighlight>.


Any top-level element can appear in an autopilot XML file, but only the following elements will be recognised and used:
Any top-level element can appear in an autopilot XML file, but only the following elements will be recognised and used:
* <pid-controller>
* <syntaxhighlight lang="xml" inline><pid-controller></syntaxhighlight>
* <pi-simple-controller>
* <syntaxhighlight lang="xml" inline><pi-simple-controller></syntaxhighlight>
* <filter>
* <syntaxhighlight lang="xml" inline><filter></syntaxhighlight>
* <predict-simple>
* <syntaxhighlight lang="xml" inline><predict-simple></syntaxhighlight>
* <logic>
* <syntaxhighlight lang="xml" inline><logic></syntaxhighlight>
* <flipflop>
* <syntaxhighlight lang="xml" inline><flipflop></syntaxhighlight>
* <state-machine>
* <syntaxhighlight lang="xml" inline><state-machine></syntaxhighlight>


== Common elements used by all elements ==
== Common elements used by all elements ==

Navigation menu