Microchip Technology SA5 Series, Руководство пользователя

Страница: 38 / 63

MAC-SA5X User’s Guide
DS50002938A-page 38

2019 Microchip Technology Inc.
4.5.2 Command Usage
This section contains command usage and details regarding each supported C3 com-
mand, listed in alphabetical order.
{ackalm, alarm }
Description Acknowledges an alarm, or multiple alarms. The acknowledged alarm remains
active but it will no longer contribute to the output of the ALARM pin as an out-
standing alarm. The value of the
Alarms
parameter will not be affected; it
always shows the active alarms, acknowledged or outstanding.
Arguments Requires one argument:
alarm – The decimal number of alarm bit(s) to acknowledge. Multiple alarm bits
may be OR’d together, to be acknowledged simultaneously.
Returns
[=1]
Since V1.0
{add, parameter,amount }
Description Adds to the current value of a parameter.
Arguments Requires two arguments:
parameter – The numeric id or name string of the parameter to modify. Param-
eter must not be read-only.
amount – The amount to add to the value (may be negative). Allowable range
depends on parameter used.
Returns The parameter’s updated value.
Error
[!100]
(Invalid parameter) if the parameter does not exist.
Error
[!102]
(Read-only parameter) if the parameter is read-only.
Since V1.0
{app?}
Description Returns a short string identifying the firmware application type.
Arguments None.
Returns
[=clock]
in normal operation, or
[=bsl]
in the bootstrap loader.
Since V1.0
{browse, what,parameter }
Description Returns information about one or more parameters.
Arguments Accepts two arguments (first is required):
what – (Required) The type of parameter information being queried.
Acceptable values for what are:
• “id” – Browses numeric parameter ids.
• “name” – Browses parameter name strings.
• “value” – Browses current parameter values.
• “attrs” – Browses parameter attributes.
parameter – (Optional) The numeric id or name string of the specific parameter
being queried.
Returns A single item (if parameter is specified), or a list of items beginning with a
comma and delimited by commas (if parameter is omitted). Returned lists are
always the same length and in the same order. (e.g. Element N of
{browse,id}
matches element N of
{browse,name}
.
Error
[!101]
(Invalid argument) if what value for the specified parameter does
not exist.
Examples
{browse,id}
– Returns all parameter IDs.
{browse,id,Alarms}
– Returns the numeric id of the Alarms parameter.