From 1fbe1e19f03440b815d00138cf935f6c4f99e543 Mon Sep 17 00:00:00 2001 From: Marcel Holtmann Date: Wed, 10 Jun 2020 10:59:39 +0200 Subject: [PATCH] doc: Add commands for reading and changing runtime parameters --- doc/mgmt-api.txt | 64 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) diff --git a/doc/mgmt-api.txt b/doc/mgmt-api.txt index 3b97b54bd..883c082d9 100644 --- a/doc/mgmt-api.txt +++ b/doc/mgmt-api.txt @@ -3313,6 +3313,70 @@ Set Default System Configuration Command Invalid Index +Read Default Runtime Configuration Command +========================================== + + Command Code: 0x004d + Controller Index: + Command Parameters: + Return Parameters: Parameter1 { + Parameter_Type (2 Octet) + Value_Length (1 Octet) + Value (0-255 Octets) + } + Parameter2 { } + ... + + This command is used to read a list of default runtime parameters. + + Currently no Parameter_Type values are defined and an empty list + will be returned. + + This command can be used at any time and will return a list of + supported default parameters as well as their current value. + + This command generates a Command Complete event on success or + a Command Status event on failure. + + Possible errors: Invalid Parameters + Invalid Index + + +Set Default Runtime Configuration Command +========================================= + + Command Code: 0x004e + Controller Index: + Command Parameters: Parameter1 { + Parameter_Type (2 Octet) + Value_Length (1 Octet) + Value (0-255 Octets) + } + Parameter2 { } + ... + Return Parameters: + + This command is used to set a list of default runtime parameters. + + See Read Default Runtime Configuration command for list of supported + Parameter_Type values. + + This command can be used at any time and will change the runtime + default. Changes however will not apply to existing connections or + currently active operations. + + When providing unsupported values or invalid values, no parameter + value will be changed and all values discarded. + + This command generates a Command Complete event on success or + a Command Status event on failure. + + Possible errors: Rejected + Not Supported + Invalid Parameters + Invalid Index + + Command Complete Event ====================== -- 2.47.3