# Package com.mouseviator.fsuipc.helpers

This package (and sub-packages) contains helper classes to get data requests for use with `FSUIPC` class to gather various sim data. The helpers are designed to return/expect "friendly" values. For example, airspeed, available via FSUIPC offset 0x02BC - is stored as integer value * 128. When reading this value normally using the `IntRequest` we would have to divide it by 128 after reading the value. But the `AircraftHelper.getIAS()` will do this for us and returned value will be the airspeed in knots as float value.

- Class Summary
  Class | Description
  --- | ---
  LuaHelper | This class implements a helper to manipulate Lua scripts using FSUIPC.
  LuaHelper.LuaControlRequest | This class implements Lua control request.
  LuaHelper.LuaParamRequest | This class implements lua parameter request.
  LuaHelper.LuaResult | A class representing a result for lua control helper functions in the class `LuaHelper`.
  LVarHelper | This class implements a helper to manipulate LVars using FSUIPC.
  LVarHelper.ByteLVarReadRequest | This class implements LVar read (read-only) request.
  LVarHelper.ByteLVarWriteRequest | This class implements LVar write (write-only) request.
  LVarHelper.DoubleLVarReadRequest | This class implements LVar read (read-only) request.
  LVarHelper.DoubleLVarWriteRequest | This class implements LVar write (write-only) request.
  LVarHelper.FloatLVarReadRequest | This class implements LVar read (read-only) request.
  LVarHelper.FloatLVarWriteRequest | This class implements LVar write (write-only) request.
  LVarHelper.IntegerLVarReadRequest | This class implements LVar read (read-only) request.
  LVarHelper.IntegerLVarWriteRequest | This class implements LVar write (write-only) request.
  LVarHelper.LVarControlRequest | This class implements Lvar control offset.
  LVarHelper.LVarParamRequest | This class implements Lvar parameter request.
  LVarHelper.LVarResult | A class representing a result fo many Lvar helper functions in the class `LVarHelper`.
  LVarHelper.ShortLVarReadRequest | This class implements LVar read (read-only) request.
  LVarHelper.ShortLVarWriteRequest | This class implements LVar write (write-only) request.
  MacroHelper | This class implements a helper to execute FSUIPC macros using FSUIPC.
  MacroHelper.MacroExecuteRequest | This class implements macro execute request.
  MacroHelper.MacroParamRequest | This class implements macro parameter request.
  MacroHelper.MacroResult | A class representing a result fo macro execute helper functions in the class `MacroHelper`.
  SimHelper | This class provides methods that return data requests to gather various info about flight simulator.

- Enum Summary
  Enum | Description
  --- | ---
  LuaHelper.LuaControlRequestCommand | An enumeration representing a command for `LuaHelper.LuaControlRequest`.
  LVarHelper.LVarControlRequestCommand | An enumeration representing a command for `LVarHelper.LVarControlRequest`.
  LVarHelper.LVarValueFormat | An enumeration specifying a value format for LVar read and write functions.