Parameters Api Introduction - Safran WR-Z16 User Manual

4.1 Parameters API Introduction
4.1

Parameters API Introduction

Although the interaction using CLI & GUI differs, both approaches rely on the
same mechanism handled by the "Generic Parameters Access (GPA)" core lib-
rary.
In other words, most of the services running in the WRZ-OS can be configured &
monitorized through common operations using the attributes of parameters. The
definition of all attributes that a parameter must handle is given below:
28
OID: a unique identifier that should be used that refers to a specific para-
meter. This OID is composed by three sub- indexes <M>.<D>.<P> cor-
responding to
<M>: ID of the module.
<D>: ID of the directory/path containing the parameter.
<P>: ID of the parameter inside a specific module directory.
Module: The name of the corresponding module.
Directory: The directory attached to the parameter.
Name: The name of the parameter (Names in the GUI and CLI can slightly
differ but their OID are always the same).
Type: The type of value stored by the parameters.
String: Datatype to represent text.
Enum/Bool: Fixed list of String-Integer associations.
Integer: Integer number with different binary representations (u8, i8,
u16, i16, u32, i32, u64, i64).
Decimal: Floating point number (f32 or f64).
Array: Vector of binary types handled like a separated string.
Unit: Corresponding unit of the parameter including scale (i.e., s, ms, us, ns,
ps).
Description: Description of the parameter.
Access: How the user can interact with a parameter.
Read: can read the value.
Write: can directly apply (online) the value.
Load: can save the value (it will be applied at next restart).
Disabled: Currently disabled, writing will not apply anything and the
value read value might be invalid.
CHAPTER •
4 WR-Z16 User Manual Rev. v5.0