carrier.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 <Arduino.h>
#include <ArduinoJson.h>
#include <array>
#include <string>
 
#include "block/ctrlblock.h"
#include "chips/TMP127Q1.h"
#include "cluster.h"
#include "daq/base.h"
#include "entity/entity.h"
#include "utils/error.h"
 
using namespace platform;
 
namespace carrier {
 
class Carrier_HAL {
public:
  virtual bool write_adc_bus_mux(const std::array<int8_t, 8> &channels) = 0;
  virtual void reset_adc_bus_mux() = 0;
};
 
class Carrier : public entities::Entity {
public:
  static constexpr int8_t ADC_CHANNEL_DISABLED = -1;
  static constexpr auto CLASS_ = entities::EntityClass::CARRIER;
 
  // Hint: Carrier lacks EEPROM, so we cannot do this:
  // enum class TYPES : uint8_t { UNKNOWN = 0, LUCIDAC = 1, mREDAC = 2 };
  // static Carrier *from_entity_classifier(entities::EntityClassifier classifier, bus::addr_t block_address);
  // bool is_entity_type(TYPES type_) { return entities::Entity::is_entity_type(static_cast<uint8_t>(type_)); }
 
protected:
  Carrier_HAL *hardware;
 
  std::array<int8_t, 8> adc_channels{ADC_CHANNEL_DISABLED, ADC_CHANNEL_DISABLED, ADC_CHANNEL_DISABLED,
                                     ADC_CHANNEL_DISABLED, ADC_CHANNEL_DISABLED, ADC_CHANNEL_DISABLED,
                                     ADC_CHANNEL_DISABLED, ADC_CHANNEL_DISABLED};
 
public:
  std::vector<Cluster> clusters;
  blocks::CTRLBlock *ctrl_block = nullptr;
 
  explicit Carrier(std::vector<Cluster> clusters, Carrier_HAL *hardware);
 
  metadata::eui_t get_entity_eui() const final;
 
  virtual bool init();
 
  virtual bool calibrate_offset();
  virtual bool calibrate_routes_in_cluster(Cluster &cluster);
  virtual bool calibrate_routes();
  virtual bool calibrate_mblock(Cluster &cluster, blocks::MBlock &mblock);
  virtual bool calibrate_m_blocks();
 
  virtual void reset(entities::ResetAction action);
 
  std::vector<Entity *> get_child_entities() override;
 
  Entity *get_child_entity(const std::string &child_id) override;
 
  utils::status config_self_from_json(JsonObjectConst cfg) override;
  void config_self_to_json(JsonObject& cfg) override;
 
  [[nodiscard]] utils::status write_to_hardware() override;
 
  [[nodiscard]] const std::array<int8_t, 8> &get_adc_channels() const;
  [[nodiscard]] bool set_adc_channels(const std::array<int8_t, 8> &channels);
  [[nodiscard]] bool set_adc_channel(uint8_t adc_channel, int8_t src_idx);
  void reset_adc_channels();
 
  utils::status user_set_extended_config(JsonObjectConst msg_in, JsonObject &msg_out);
  utils::status user_get_overload_status(JsonObjectConst msg_in, JsonObject &msg_out);
 
public:
  // Module addresses
  static constexpr uint8_t CARRIER_MADDR = 5;
};
 
} // namespace carrier