Analog Way MIDRA PLATFORM TPP Current Programmer's Guide - Manual (Page 11)

11
PROGRAMMER'S GUIDE FOR v01.02.11
2.6 Command indexes and Command values
As explained in chapter §Midra_control_principle , Midra™ commands allow reading or writing values in
multidimensional registers. For these, indexes values must be supplied. If a register is not
multidimensional, its reading or writing commands does not need indexes values.
Indexes values : Depending on the command, you can have to specify from 0 to 5 indexes values. They
indicate on which the command relates. For example, the “OSCREEN_MAX_LAYERS” command, which
gives the number of live layers, requires an index value to indicate one of the device’s screen.
No wildcard exists, all required indexes values shall be supplied. Some indexes values have names
starting with “DIM_”, meaning dimension. For example, the “OSCREEN_MAX_LAYERS” command giving
the number of live layers in a screen, always requires a “DIM_SCREEN” index value indicating the screen.
Indexes values are detailed in the “ Midra_TPP_commands_for_v01-02-11.xls ” document.
Command value : This is the register value. In a write command, It indicates the new value that you
want to be applied. In a read answer, it indicates the current state of the command (current register
value). A write command is distinguished from a read command due to the presence of the numerical
command value just before the command letters.
A value written in a register remains until modified by a new write command or by the device itself.
This allows options to be written only once.
All registers have a default value, noted in the detailed tables.
You must be careful on value range, which depends on multiple factors, like device type, device
configuration or current situation. Value range have names starting with “ENUM_”, else, if no
enumeration name exist, value must be comprise between given “min value” and “max value”.
Commands values are detailed in the “ Midra_TPP_commands_for_v01-02-11.xls ” document.