diff --git a/docs-mini/README.protocol b/docs-mini/README.protocol index ef9c39a2e..080c42bda 100644 --- a/docs-mini/README.protocol +++ b/docs-mini/README.protocol @@ -131,6 +131,23 @@ each of which describes the properties of on variable to write/read. an optional offset which can be used for unit conversion. (for example, degrees Celcius to degrees Fahrenheit). +For input chunks there exist some more options: + + optional boolean parameter to enable handling of incoming values + as relative changes (default: false) + (Can be eg. used to realise up/down buttons by just sending 1 or + -1 respectively) + + an optional minimum limit for the value to be clamped to. This + limit is always specified as absolute value, also with relative + changes enabled. (default: 0) + an optional upper limit for the input value to be clamped to. If + equals no limit is applied. (default: 0) + instead of clamping to minimum and maximum limits, wrap values + around. (default: false) + (Usefull for eg. heading selector to start again with 1 for + values higher than 360) + Chunks can also consist of a single constant , like in: Data Section @@ -184,7 +201,30 @@ P=3.59 +Control the heading bug by sending relative changes separated by newlines: + + + + + + + newline + + + heading bug + int + /autopilot/settings/heading-bug-deg + true + 1 + 360 + true + + + + + + -- writing data in XML syntax -------------------------------------------------