shblock.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 "base.h"
#include "bus/functions.h"
#include "ublock.h"
 
namespace blocks {
 
enum class SHState { TRACK, TRACK_AT_IC, INJECT, GAIN_ZERO_TO_SEVEN, GAIN_EIGHT_TO_FIFTEEN };
 
class SHBlockHAL : public FunctionBlockHAL {
public:
  explicit SHBlockHAL(bus::addr_t block_address);
 
  metadata::eui_t get_entity_eui() const override { return f_meta.read_eui(); }
 
  void compensate_hardware_offsets(uint32_t track_time, uint32_t inject_time);
  void set_state(SHState state) const;
 
private:
  // Default state after reset is inject with a potentially random inject current
  const metadata::MetadataEditor f_meta;
  const functions::TriggerFunction set_track;
  const functions::TriggerFunction set_track_at_ic;
  const functions::TriggerFunction set_gain;
  const functions::TriggerFunction set_gain_channels_zero_to_seven;
  const functions::TriggerFunction set_gain_channels_eight_to_fifteen;
  const functions::TriggerFunction set_inject;
};
 
class SHBlock : public blocks::FunctionBlock {
public:
  // Entity hardware identifier information.
  static constexpr auto CLASS_ = entities::EntityClass::SH_BLOCK;
  static constexpr uint8_t BLOCK_IDX = bus::SH_BLOCK_IDX;
 
  SHBlock();
  explicit SHBlock(SHBlockHAL *hardware);
 
  metadata::eui_t get_entity_eui() const override;
 
  void set_state(SHState state_);
  SHState get_state() const;
 
  void reset(entities::ResetAction action) override;
 
  [[nodiscard]] utils::status write_to_hardware() override;
 
  // Automatically does an track and inject sequence. This directly writes to hardware. Delays for track time
  // and inject time can be set optionally in microseconds. Block will be left in inject mode afterwards
  void compensate_hardware_offsets(uint32_t track_time = 10000, uint32_t inject_time = 5000);
 
  static SHBlock *from_entity_classifier(entities::EntityClassifier classifier, bus::addr_t block_address);
 
protected:
  SHState state = SHState::INJECT;
 
  utils::status config_self_from_json(JsonObjectConst cfg) override;
 
  SHBlockHAL *hardware;
};
 
} // namespace blocks