radio/src/telemetry/telemetry_sensors.h

   1 /*
   2  * Copyright (C) OpenTX
   3  *
   4  * Based on code named
   5  *   th9x - http://code.google.com/p/th9x
   6  *   er9x - http://code.google.com/p/er9x
   7  *   gruvin9x - http://code.google.com/p/gruvin9x
   8  *
   9  * License GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  */
  20
  21 #ifndef _TELEMETRY_SENSORS_H_
  22 #define _TELEMETRY_SENSORS_H_
  23
  24 #include "telemetry.h"
  25
  26 constexpr int8_t TELEMETRY_SENSOR_TIMEOUT_UNAVAILABLE = -2;
  27 constexpr int8_t TELEMETRY_SENSOR_TIMEOUT_OLD = -1;
  28 constexpr int8_t TELEMETRY_SENSOR_TIMEOUT_START = 125; // * 160ms = 20s
  29
  30 class TelemetryItem
  31 {
  32   public:
  33     union {
  34       int32_t  value;           // value, stored as uint32_t but interpreted accordingly to type
  35       uint32_t distFromEarthAxis;
  36     };
  37
  38     union {
  39       int32_t valueMin;         // min store
  40       int32_t pilotLongitude;
  41     };
  42
  43     union {
  44       int32_t valueMax;         // max store
  45       int32_t pilotLatitude;
  46     };
  47
  48     int8_t timeout; // for detection of sensor loss
  49
  50     union {
  51       struct {
  52         int32_t  offsetAuto;
  53         int32_t  filterValues[TELEMETRY_AVERAGE_COUNT];
  54       } std;
  55       struct {
  56         uint16_t prescale;
  57       } consumption;
  58       struct {
  59         uint8_t   count;
  60         CellValue values[6];
  61       } cells;
  62       struct {
  63         uint16_t year;          // full year (4 digits)
  64         uint8_t  month;
  65         uint8_t  day;
  66         uint8_t  hour;
  67         uint8_t  min;
  68         uint8_t  sec;
  69       } datetime;
  70       struct {
  71         int32_t latitude;
  72         int32_t longitude;
  73         // pilot longitude is stored in min
  74         // pilot latitude is stored in max
  75         // distFromEarthAxis is stored in value
  76       } gps;
  77       char text[16];
  78     };
  79
  80     TelemetryItem()
  81     {
  82       clear();
  83     }
  84
  85     void clear()
  86     {
  87       memset(reinterpret_cast<void*>(this), 0, sizeof(TelemetryItem));
  88       timeout = TELEMETRY_SENSOR_TIMEOUT_UNAVAILABLE;
  89     }
  90
  91     void eval(const TelemetrySensor & sensor);
  92     void per10ms(const TelemetrySensor & sensor);
  93
  94     void setValue(const TelemetrySensor & sensor, int32_t newVal, uint32_t unit, uint32_t prec=0);
  95
  96     inline bool isAvailable()
  97     {
  98       return (timeout != TELEMETRY_SENSOR_TIMEOUT_UNAVAILABLE);
  99     }
 100
 101     inline bool isOld()
 102     {
 103       return (timeout == TELEMETRY_SENSOR_TIMEOUT_OLD);
 104     }
 105
 106     inline bool hasReceiveTime()
 107     {
 108       return timeout >= 0;
 109     }
 110
 111     inline int8_t getDelaySinceLastValue()
 112     {
 113       return hasReceiveTime() ? TELEMETRY_SENSOR_TIMEOUT_START - timeout : TELEMETRY_SENSOR_TIMEOUT_OLD;
 114     }
 115
 116     inline bool isFresh()
 117     {
 118       return TELEMETRY_SENSOR_TIMEOUT_START - timeout <= 1; // 2 * 160ms
 119     }
 120
 121     inline void setFresh()
 122     {
 123       timeout = TELEMETRY_SENSOR_TIMEOUT_START;
 124     }
 125
 126     inline void setOld()
 127     {
 128       timeout = TELEMETRY_SENSOR_TIMEOUT_OLD;
 129     }
 130 };
 131
 132 extern TelemetryItem telemetryItems[MAX_TELEMETRY_SENSORS];
 133 extern uint8_t allowNewSensors;
 134 bool isFaiForbidden(source_t idx);
 135
 136 #endif // _TELEMETRY_SENSORS_H_