wiki:GaugesAPI

Gauges API

Terms

  • Item : item can be a SVG group or a SVG item that have a particular name. This name is based on its type (Pointer), the index (you can have several pointer in your gauges, it starts at 1) and its item name. For example: pointer1_main is the main item of the pointer number 1
  • Fields are described in Python syntax and located in the description part of the SVG item (see object properties to show it)

Base for all Gauges

  • Each SVG file represents 1 gauges
  • One gauge is composed by different items, it can have 2 pointer, and 1 list
  • Each items has a particular behaviour (light, counter, pointer) with common fields and specific fields
  • Only named items (and their childrens) can be displayed
  • background element is MANDATORY. It represents the background of the gauge.
    • to put something under the background, use the under_background=True field on items --> very specific use!!!

Base for all items

  • Night? management
  • value_factor : is multiplicator factor applied on data before displaying. Ex: to show number of hundred feet of altitude from the lockon altitude field, put value_factor=0.01. Note that the value_factor is applied on the final value after the unit conversion if there is one.
  • visible_condition : the item can be show/hide on a external condition has is ILS, gear out.... put visible_condition="Lockon.LuaServer.Req_luaCnxState"
  • quantity : Represent the quantity of the system unit (see here )
  • unit : Represent the unit (see here )

Items