Commit Graph

59 Commits

Author SHA1 Message Date
Peter Barker cb2e3424ee Tools: add kilobytes as known unit 2018-05-08 09:36:01 +10:00
Randy Mackay 8186ce0d32 Tools: add deg/s/s to valid parameter units 2018-04-05 12:14:59 +09:00
Peter Barker dca866c98d Tools: make parameter generation failure clearer 2018-03-26 12:39:23 +11:00
Peter Barker 338af9e142 Tools: correct misleading comment on per-vehicle parameter descriptions 2018-03-21 21:05:42 +11:00
Peter Barker 5ac5a68d17 Tools: param_parse.py: replace @PREFIX in values with library prefix 2018-03-14 15:44:00 +11:00
Peter Barker 0b4dcdde35 Tools: param_parse.py: allow whitespace between vehicles
Also add sanity check that the vehicles you're limitting to we know
about
2017-12-16 11:08:35 +11:00
Peter Barker d1128e7be4 Tools: param_parse.py: replace comments with debug statements 2017-12-16 11:08:35 +11:00
Peter Barker eeb15d7fd5 Tools: param_parse.py: make comment consistent 2017-12-16 11:08:35 +11:00
Peter Barker 825832be93 Tools: param_parse.py: add a map for vehicle name to a true-name to be used in code
Where true-name is something like "Rover" and the normal name remains
the directory name (e.g. "APMrover2")
2017-12-16 11:08:35 +11:00
Peter Barker e0125a68e7 Tools: param_parse.py: use single regex for params everywhere 2017-12-16 11:08:35 +11:00
Peter Barker a45ab6b84c Tools: param_parse.py: correct example comment 2017-12-16 11:08:35 +11:00
Peter Barker ea2c156c7f Tools: param_parse.py: understand tagging of parameters for specific vehicles 2017-12-16 11:08:35 +11:00
Randy Mackay 19af2f7d1d Tools: add decibel as valid param Unit 2017-12-12 07:59:41 +09:00
Francisco Ferreira eda5d9265f
Tools: add new no-emit option to param_parse.py so that only validation is done 2017-07-18 14:15:39 +01:00
Michael du Breuil 31924e46d3 Tools: Parameters: Permit kHz as a unit 2017-07-16 08:26:52 +10:00
Jacob Walser b752594fe5 param_metadata: Markdown parameter formatter 2017-06-20 14:53:17 +10:00
Dr.-Ing. Amilcar Do Carmo Lucas 023e3b6e30 Tools: Add comments explaining why a couple of units are not SI 2017-05-17 18:07:25 +10:00
Dr.-Ing. Amilcar Do Carmo Lucas 02e7c49394 Tools: remove non-ASCII characters in comments, Travis chokes on them 2017-05-17 18:07:25 +10:00
Dr.-Ing. Amilcar Do Carmo Lucas d7c7deacdf Tools: Follow SI units conventions
http://physics.nist.gov/cuu/Units/units.html
http://physics.nist.gov/cuu/Units/outside.html
and
http://physics.nist.gov/cuu/Units/checklist.html
http://www.bipm.org/en/publications/si-brochure/
http://www1.bipm.org/en/CGPM/db/3/2/   g_n unit for G-force
one further constrain is that only printable (7bit) ASCII characters are allowed

Add a validation so that Travis can validate the units
Use full text unit information when generating .wiki, .rst and .html documentation
Use both unit symbol and unit full text when generating .xml
2017-05-17 18:07:25 +10:00
Andrew Tridgell 496ed18530 autotest: sort libraries by name 2017-02-07 10:37:24 +11:00
Andrew Tridgell de59f27e14 autotest: fixed parameter generation for recursive libraries 2017-02-06 15:12:32 +11:00
Pierre Kancir bec09b9a57 autotest: python3 support 2016-11-09 11:48:22 -03:00
Pierre Kancir 63a6b28065 param_metadata: change Ardupilot site to old Ardupilot site 2016-09-01 13:05:11 +10:00
Pierre Kancir 9e1ffcae5d Tools: update python coding style
Tools: update PrintVersion.py coding style

autotest: update python coding style

pysim: update python coding style

jsb_sim: update Python coding style

param_metadata: update Python coding style
2016-09-01 13:05:11 +10:00
Peter Barker 27fadb2572 Tools: rstemit: render parameter information in h tables
Render ranges as "min - max"
2016-04-13 21:16:41 +10:00
Peter Barker 14b51080a9 Tools: remove erroneous space in rst output 2016-03-22 18:31:05 +11:00
Peter Barker 9f9e3843e0 Tools: formatting changes for rst parameter file 2016-03-21 20:56:49 +11:00
Peter Barker a8e9fc19b0 Tools: allow param parser to emit ReStructured Text 2016-03-17 16:10:11 +11:00
Don Gagne cae7ea0d13 Add @Volatile, @ReadOnly support 2016-03-17 10:58:05 +11:00
Don Gagne 07c0c6d519 autotest: Validate Range meta data for correctness 2015-12-27 16:10:43 +11:00
Andrew Tridgell 43d6060ba7 autotest: removed "Library Parameters" heading in autodocs 2015-06-16 10:01:03 +10:00
Randy Mackay fbec1e63ad autotest: fix typo in Bitmask keyword for autodocs 2015-06-05 09:19:26 +09:00
Randy Mackay 7c851b781b autotest: allow Bitmask keyword in autodocs 2015-06-04 21:31:41 +09:00
Andrew Tridgell b6ed86465b autotest: prioritise .cpp projects over .pde projects 2015-05-30 15:21:25 +09:00
Andrew Tridgell 337cd3d4a7 autotest: allow RebootRequired keyword in autodocs 2015-05-29 16:35:33 +10:00
Andrew Tridgell dfc7878b14 autotest: fixed cpp files for parameter parsing 2015-05-21 11:42:32 +10:00
Andrew Tridgell cd2898b149 autotest: removed old table of contents link in generated paramater docs 2015-02-19 15:58:30 +11:00
Aaron Curtis 068febda1f Tools: Fix broken duplicate check for adding new libraries to the data structure 2014-06-28 13:17:45 +10:00
Andrew Tridgell 4f33e4e114 autotest: fixed handling for wiki and xml generation 2013-09-12 10:01:30 +10:00
Andrew Tridgell bfd61fec15 param_metadata: support .pde files for parameter autodocs 2013-09-12 09:51:59 +10:00
Andrew Tridgell ceaa0c789c autotest: improved preamble in auto param docs 2013-05-30 12:36:05 +10:00
Andrew Tridgell 7eb40d151c autotest: added TOC link
thanks to Gary for the suggestion!
2013-05-30 12:19:24 +10:00
Andrew Tridgell afd2f4bc78 autotest: added advanced param warning and header to auto-docs 2013-05-28 10:11:56 +10:00
Andrew Tridgell e6891ebdab autotest: fixed escaping of html in wiki descriptions 2013-05-27 23:17:47 +10:00
Andrew Tridgell d510f8f722 autotest: added generation of Parameters.html for wordpress
this generates APM docs for wordpress
2013-05-27 08:25:24 +10:00
Andrew Tridgell 5818dce3d2 param_metadata: fixed parameter parsing for multi-parameter objects
also adds more error checking
2013-05-21 17:02:13 +10:00
Kevin Hester d3dad7afee autotest: add @User autodocs to the apm.pdef.xml as user=foo 2013-04-16 11:19:15 +10:00
Kevin Hester a86ede4270 autotest: APM xml docs should be named xml.pdef.xml
(not arduplane.pdef.xml)

pch: rebased pull request #188
2013-04-07 11:12:11 -07:00
Kevin Hester 9885cc7ed1 Docs: Add XML emit to param_parse.py. See below for more details...
I've refactored the param_parse tool to use various 'emitters'.  An emitter
can take parameter info and output it in a particular format.  Currently the
only supported emitters are the wiki and XML formats.

The goal of these changes is to create a standard machine readable description
of parameters - mainly for use by ground control stations, but it will also
enable spiffy scripting environments where code can refer symbolically to
vehicle parameters (reflectionish).

Open issue: Is there any sort of Ardupilot build id which can be included in
the generated XML?  That would ensure that we select the correct paramdefs
for the load on the target (possibly by asking the target for a SHA or
somesuch).  If that issue is resolved, then the filename for the XML
file should probably be something like:
arduplane-ca5742ac.pdef.xml.

It is worth noting that I've proposed a suffix of ".pdef.xml" for these file
types.  This facilitates automated file handling on Android devices.  On
Android you can register 'handlers' for particular file extensions and if
the user tries to open that extension in email or a web browser your app
will be given a chance to do something about it.  The 'outer' xml extension
will allow naive editors to know that at least this is an xml file.

I will include a sample of the XML format with the pull-request for this CL.
2013-03-10 17:47:42 +11:00
Andrew Tridgell 58a0cfc0b3 params: fixed ordering of vehicle parsing
this keeps it consistent in the wiki
2012-11-20 20:37:02 +11:00