README.md

   1 ## OpenXsensor New Home
   2 _from may 2015_
   3
   4 ![OXS logo](https://github.com/openXsensor/openXsensor/wiki/images/OXS_Logo.png)
   5
   6
   7 ### Introduction
   8
   9 OpenXsensor is the evolution of [OpenXvario](https://code.google.com/p/openxvario/) and extends it to multi-sensing applications.
  10
  11 Discussion about this project: http://openrcforums.com/forum/viewforum.php?f=86
  12
  13 Based on an [Arduino](http://arduino.cc/) platform, it connects to different sensors and transmits the measurements via several telemetry capabilities.
  14
  15 It is compatible with :
  16   * The Multiplex receivers
  17   * The Frsky receivers : *D series* (HUB protocol) and *X series* (Smart Port protocol).
  18   * The Graupner receivers (Hott protocol)
  19   * The Jeti receivers (EX protocol only)
  20
  21 ### Functionalities provided at your choice :
  22
  23   * Altimeter / Variometer
  24     * Uses normally a MS5611 sensor (GY-63 or GY-86 module)
  25         * Alternatives: a BMP085, a BMP180 or a BMP280 sensor can be used as first sensor
  26         * A second barometric sensor can be added
  27         * Possibility to change vario sensitivity and/or to switch between 2 vertical speeds from TX while flying
  28   * Air Speed
  29     * Uses normally a 4525DO-DS5AI001DP sensor
  30         * Alternative: ADS1115 + MPXV7002DP
  31         * Can also be used by oXs to compensate vertical speed measurements (dTE)
  32   * GPS
  33     * Can be connected to a GPS (NEO6/NEO7/NEO8/M9/M10) and transmit collected data
  34   * Accelerometer/gyroscope
  35     * Can be connected to a MPU6050 sensor (e.g. GY-86 module)
  36     * Can calculate vertical speed based on acceleration + baro (faster reaction of vario)
  37         * Can calculate Roll and Pitch for attitude indicator (using a Lua script on OpenTx)
  38   * Up to 6 voltages measurements with Arduino
  39     * Battery voltage measurements
  40     * Lipo battery cell measurements
  41   * Up to 4 more accurate (and/or lower) voltages measurements with an extra ADC
  42     * Uses a ADS1115 module
  43     * Can be combined with Current and Airspeed sensor
  44   * RPM sensor
  45   * Current sensor
  46     * Max Amp depends on the sensor being used (e.g. ACS712, ACS754, ACS758)
  47         * Can calculate the consumed current
  48   * Flow sensor (provides actual flow, remaining tank capacity in ml and %)
  49   * Can use any sensor outputting voltage
  50     * Conversion from Volt to other units (e.g. to degree for temperature sensor)
  51         * Can be associate with termistor
  52   * Can calculate glider ratio to improve glider setup while flying
  53   * Can generate several sequences of signal (e.g. for light sequencer)
  54   * Can become a locator (to retreive lost model)
  55     * Uses a LORA module (SX1276/RFM95) to get a long range transmission
  56     * Uses a second Arduino pro mini (or Arduino nano) with a display and a LORA module
  57     * display the GPS position and strength of signal (as goniometer)
  58
  59 Note: Setup is done editing manually the files oXs_config_basic.h and in some cases oXs_config_advanced.h
  60           All details about the requirements and the way to configure oXs are given in the file oXs_config_description.h
  61           Some explanations are given in wiki (but are not 100% up to date). It is higtly recommended to read oXs_config_description.h.
  62 Note: The latest version of the project includes an oXs configurator. It allows:
  63    * to generate the config files using a graphical user interface.
  64    * to save/reload several sets of parameters.
  65    * to view the documentation (content of file oXs_description.h
  66 It requires that Python3.7 is installed - compatible with Python3.11 as well.
  67 Still, for Windows 10/Windows 11, there is precompiled package that does not require to install Python.
  68 The configurator supports most (but not all oXs setup parameters) so, in some cases, you still have to edit the config files manually.
  69