back_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 "block/base.h"
#include "bus/functions.h"
#include "chips/TMP127Q1.h"
 
 
namespace platform {
 
struct BackPanelIdentifier {
  uint8_t backpanel_id, backpanel_slot;
  bool is_valid;
  static BackPanelIdentifier fromRaw(uint16_t raw);
};
 
void convertToJson(const BackPanelIdentifier &id, JsonObject dst);
 
class BackPanelHAL {
protected:
  static const SPISettings F_ID_SPI_SETTINGS;
  const metadata::MetadataEditor f_meta;
  const functions::TMP127Q1 f_temperature;
  const functions::DataFunction f_id;
 
public:
  explicit BackPanelHAL(bus::addr_t block_address);
  uint16_t read_backplane_and_slot_id() const;
  metadata::eui_t get_entity_eui() const { return f_meta.read_eui(); }
};
 
class REDACBackPanel : public entities::Entity {
  BackPanelHAL* hardware;
public:
  static constexpr auto CLASS_ = entities::EntityClass::BACK_PANEL;
 
  static REDACBackPanel *from_entity_classifier(entities::EntityClassifier classifier,
                                                   __attribute__((__unused__)) bus::addr_t block_address);
 
  utils::status config_self_from_json(JsonObjectConst cfg) override { return utils::status::success(); }
 
  metadata::eui_t get_entity_eui() const override;
 
  Entity *get_child_entity(const std::string &child_id) override { return nullptr; }
 
  std::vector<Entity *> get_child_entities() override { return {}; };
 
  explicit REDACBackPanel(BackPanelHAL* hardware);
 
  uint16_t read_backplane_and_slot_id() const;
 
  // only further method to list here is read_temperature(), cf. #220
  // https://lab.analogparadigm.com/lucidac/firmware/hybrid-controller/-/merge_requests/75
};
 
} // namespace platform