as3935.h

Go to the documentation of this file.

#pragma once

#include "esphome/core/component.h"
#include "esphome/core/defines.h"
#include "esphome/core/hal.h"
#ifdef USE_SENSOR
#include "esphome/components/sensor/sensor.h"
#endif
#ifdef USE_BINARY_SENSOR
#include "esphome/components/binary_sensor/binary_sensor.h"
#endif

namespace esphome {
namespace as3935 {

static const uint8_t DIRECT_COMMAND = 0x96;
static const uint8_t ANTFREQ = 3;

enum AS3935RegisterNames {
  AFE_GAIN = 0x00,
  THRESHOLD,
  LIGHTNING_REG,
  INT_MASK_ANT,
  ENERGY_LIGHT_LSB,
  ENERGY_LIGHT_MSB,
  ENERGY_LIGHT_MMSB,
  DISTANCE,
  FREQ_DISP_IRQ,
  CALIB_TRCO = 0x3A,
  CALIB_SRCO = 0x3B,
  DEFAULT_RESET = 0x3C,
  CALIB_RCO = 0x3D
};

enum AS3935RegisterMasks {
  WIPE_ALL = 0x0,
  GAIN_MASK = 0x3E,
  SPIKE_MASK = 0xF,
  IO_MASK = 0xC1,
  DISTANCE_MASK = 0xC0,
  INT_MASK = 0xF0,
  THRESH_MASK = 0x0F,
  R_SPIKE_MASK = 0xF0,
  ENERGY_MASK = 0xF0,
  CAP_MASK = 0xF0,
  LIGHT_MASK = 0xCF,
  DISTURB_MASK = 0xDF,
  NOISE_FLOOR_MASK = 0x70,
  OSC_MASK = 0xE0,
  CALIB_MASK = 0x7F,
  CALIB_MASK_NOK = 0xBF,
  DIV_MASK = 0x3F
};

enum AS3935Values {
  AS3935_ADDR = 0x03,
  INDOOR = 0x12,
  OUTDOOR = 0xE,
  LIGHTNING_INT = 0x08,
  DISTURBER_INT = 0x04,
  NOISE_INT = 0x01
};

class AS3935Component : public Component {
#ifdef USE_SENSOR
  SUB_SENSOR(distance)
  SUB_SENSOR(energy)
#endif

#ifdef USE_BINARY_SENSOR
  SUB_BINARY_SENSOR(thunder_alert)
#endif

 public:
  void setup() override;
  void dump_config() override;
  float get_setup_priority() const override;
  void loop() override;

  void set_irq_pin(GPIOPin *irq_pin) { irq_pin_ = irq_pin; }

  void set_indoor(bool indoor) { indoor_ = indoor; }
  void write_indoor(bool indoor);
  void set_noise_level(uint8_t noise_level) { noise_level_ = noise_level; }
  void write_noise_level(uint8_t noise_level);
  void set_watchdog_threshold(uint8_t watchdog_threshold) { watchdog_threshold_ = watchdog_threshold; }
  void write_watchdog_threshold(uint8_t watchdog_threshold);
  void set_spike_rejection(uint8_t spike_rejection) { spike_rejection_ = spike_rejection; }
  void write_spike_rejection(uint8_t write_spike_rejection);
  void set_lightning_threshold(uint8_t lightning_threshold) { lightning_threshold_ = lightning_threshold; }
  void write_lightning_threshold(uint8_t lightning_threshold);
  void set_mask_disturber(bool mask_disturber) { mask_disturber_ = mask_disturber; }
  void write_mask_disturber(bool enabled);
  void set_div_ratio(uint8_t div_ratio) { div_ratio_ = div_ratio; }
  void write_div_ratio(uint8_t div_ratio);
  void set_capacitance(uint8_t capacitance) { capacitance_ = capacitance; }
  void write_capacitance(uint8_t capacitance);
  uint8_t read_div_ratio();
  uint8_t read_capacitance();
  bool calibrate_oscillator();
  void display_oscillator(bool state, uint8_t osc);
  void tune_antenna();
  void set_tune_antenna(bool tune_antenna) { tune_antenna_ = tune_antenna; }
  void set_calibration(bool calibration) { calibration_ = calibration; }

 protected:
  uint8_t read_interrupt_register_();
  void clear_statistics_();
  uint8_t get_distance_to_storm_();
  uint32_t get_lightning_energy_();

  virtual uint8_t read_register(uint8_t reg) = 0;
  uint8_t read_register_(uint8_t reg, uint8_t mask);

  virtual void write_register(uint8_t reg, uint8_t mask, uint8_t bits, uint8_t start_position) = 0;

  GPIOPin *irq_pin_;

  bool indoor_;
  uint8_t noise_level_;
  uint8_t watchdog_threshold_;
  uint8_t spike_rejection_;
  uint8_t lightning_threshold_;
  bool mask_disturber_;
  uint8_t div_ratio_;
  uint8_t capacitance_;
  bool tune_antenna_;
  bool calibration_;
};

}  // namespace as3935
}  // namespace esphome