front_panel.h

Go to the documentation of this file.

// Copyright (c) 2024 anabrid GmbH
// Contact: https://www.anabrid.com/licensing/
//
// SPDX-License-Identifier: MIT OR GPL-2.0-or-later
 
#pragma once
 
#include "bus/bus.h"
#include "entity/entity.h"
 
#include "chips/AD9834.h"
#include "chips/DAC60508.h"
#include "chips/SR74HCT595.h"
 
namespace platform {
 
class LUCIDACFrontPanel : public entities::Entity {
public:
  // Entity hardware identifier information.
  static constexpr auto CLASS_ = entities::EntityClass::FRONT_PANEL;
 
  static LUCIDACFrontPanel *from_entity_classifier(entities::EntityClassifier classifier,
                                                   __attribute__((__unused__)) bus::addr_t block_address);
 
  std::array<uint8_t, 8> get_entity_eui() const override;
 
  utils::status config_self_from_json(JsonObjectConst cfg) override;
 
  Entity *get_child_entity(const std::string &child_id) override { return nullptr; }
 
  std::vector<Entity *> get_child_entities() override { return {}; };
 
protected:
  utils::status _config_leds_from_json(const JsonVariantConst &cfg);
  utils::status _config_signal_generator_from_json(const JsonVariantConst &cfg);
  void config_self_to_json(JsonObject &cfg) override;
 
public:
  static constexpr uint8_t FUNCTION_GENERATOR_IDX = 2;
  static constexpr uint8_t DAC_IDX = 3;
  static constexpr uint8_t LED_REGISTER_IDX = 4;
  static constexpr uint8_t LED_REGISTER_STORE_IDX = 5;
  static constexpr uint8_t LED_REGISTER_RESET_IDX = 6;
 
  static constexpr uint8_t DAC_AMPLITUDE_CH = 0;
  static constexpr uint8_t DAC_SQUARE_HIGH_CH = 1;
  static constexpr uint8_t DAC_SQUARE_LOW_CH = 2;
  static constexpr uint8_t DAC_OFFSET_CH = 3;
  static constexpr uint8_t DAC_OUT0_CH = 4;
  static constexpr uint8_t DAC_OUT1_CH = 5;
 
  LUCIDACFrontPanel();
 
  bool init();
 
  void reset(entities::ResetAction action);
 
  // Error codes:
  // 0 LED register failed in pedantic mode
  // -1 Signal generator amplitude chanel
  // -2 Signal generator square low chanel
  // -3 Signal generator square high chanel
  // -4 Signal generator offset chanel
  // -5 Signal generator dac0 chanel
  // -6 Signal generator dac1 chanel
  utils::status write_to_hardware() override;
 
  class LEDs {
  public:
    LEDs();
 
    bool set(const uint8_t led, bool on);
    void set_all(const uint8_t states);
    void reset();
 
    uint8_t get_all() const;
 
    utils::status write_to_hardware() const;
 
  private:
    const functions::SR74HCT595 led_register;
    const functions::TriggerFunction led_register_store;
    const functions::TriggerFunction led_register_reset;
 
    uint8_t led_states = 0;
  } leds;
  class LEDs {…};
 
  class SignalGenerator {
  public:
    SignalGenerator();
    bool init();
 
    bool is_installed() const { return installed; }
 
    void set_frequency(float frequency);
    void set_phase(float phase);
    void set_wave_form(functions::AD9834::WaveForm wave_form);
    bool set_amplitude(float amplitude);
    bool set_square_voltage_levels(float low, float high);
    bool set_square_voltage_low(float low);
    bool set_square_voltage_high(float high);
    bool set_offset(float offset);
 
    float get_real_frequency() const;
    float get_real_phase() const;
 
    float get_frequency() const;
    float get_phase() const;
    functions::AD9834::WaveForm get_wave_form() const;
    float get_amplitude() const;
    float get_square_voltage_low() const;
    float get_square_voltage_high() const;
    float get_offset() const;
    bool get_sleep() const;
 
    float get_dac_out0() const;
    float get_dac_out1() const;
 
    void sleep();
    void awake();
 
    bool set_dac_out0(float value);
    bool set_dac_out1(float value);
 
    utils::status write_to_hardware();
 
  private:
    const functions::DAC60508 digital_analog_converter;
    functions::AD9834 function_generator;
 
    static constexpr float _map_dac_levelshift(float x) {
      return (x + 2.0f) * (0.0f - 2.5f) / (2.0f + 2.0f) + 2.5f;
    }
 
    float _frequency;
    float _phase;
    functions::AD9834::WaveForm _wave_form;
    float _amplitude;
    float _square_low_voltage;
    float _square_high_voltage;
    float _offset;
    float _dac_out0;
    float _dac_out1;
 
    bool _sleep = true;
 
    bool installed = false;
 
    friend LUCIDACFrontPanel;
 
  } signal_generator;
  class SignalGenerator {…};
};
class LUCIDACFrontPanel : public entities::Entity {…};
} // namespace platform