param: clarify that implementors may choose to make all param set per…

…sistent
dronecan · May 18, 2023 · 984553a · 984553a
1 parent c082019
commit 984553a
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/uavcan/protocol/param/10.ExecuteOpcode.uavcan b/uavcan/protocol/param/10.ExecuteOpcode.uavcan
@@ -10,6 +10,11 @@
 # with their default values. The node may require a restart in order for some changes to take effect.
 #
 # Other opcodes may be added in the future (for example, an opcode for switching between multiple configurations).
+
+# note that implementors may choose to make parameter set operations
+# be immediately persistent, or can choose to make them temporary,
+# requiring a ExecuteOpcode with OPCODE_SAVE to put into persistent
+# storage
 #
 uint8 OPCODE_SAVE  = 0  # Save all parameters to non-volatile storage.
 uint8 OPCODE_ERASE = 1  # Clear the non-volatile storage; some changes may take effect only after reboot.

diff --git a/uavcan/protocol/param/11.GetSet.uavcan b/uavcan/protocol/param/11.GetSet.uavcan
@@ -4,6 +4,9 @@
 # discouraged to use it for anything else, because persistent ordering is not guaranteed.
 #
 
+# implementors may choose to make parameter set operations be immediately persistent, or can choose
+# to make them temporary, requiring a ExecuteOpcode with OPCODE_SAVE to put into persistent storage
+
 #
 # Index of the parameter starting from 0; ignored if name is nonempty.
 # Use index only to retrieve the list of parameters.