service.hpp

Go to the documentation of this file.

// Copyright (C) 2025 Vincent Hamp
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.
 
#pragma once
 
#include <mutex>
#include <optional>
#include <z21/z21.hpp>
#include "accessories.hpp"
#include "intf/http/endpoints.hpp"
#include "locos.hpp"
#include "turnouts.hpp"
 
namespace mw::dcc {

class Service : public z21::server::intf::Dcc {
public:
  Service();
 
  //
  void z21(std::shared_ptr<z21::server::intf::System> z21_system_service,
           std::shared_ptr<z21::server::intf::Dcc> z21_dcc_service);
 
  //
  intf::http::Response getRequest(intf::http::Request const& req);
  intf::http::Response postRequest(intf::http::Request const& req);
 
  //
  intf::http::Response locosGetRequest(intf::http::Request const& req);
  intf::http::Response locosDeleteRequest(intf::http::Request const& req);
  intf::http::Response locosPutRequest(intf::http::Request const& req);
 
  //
  intf::http::Response turnoutsGetRequest(intf::http::Request const& req);
  intf::http::Response turnoutsDeleteRequest(intf::http::Request const& req);
  intf::http::Response turnoutsPutRequest(intf::http::Request const& req);
 
private:
  // Driving interface
  void locoEStop(uint16_t loco_addr) final;
  void locoPurge(uint16_t loco_addr) final;
  z21::LocoInfo locoInfo(uint16_t loco_addr) final;
  [[nodiscard]] z21::LocoEntry locoEntry(uint16_t loco_addr) final;
  void locoEntry(uint16_t loco_addr, z21::LocoEntry loco_entry) final;
  void locoDrive(uint16_t loco_addr,
                 z21::LocoInfo::SpeedSteps speed_steps,
                 uint8_t rvvvvvvv) final;
  void locoFunction(uint16_t loco_addr, uint32_t mask, uint32_t state) final;
  z21::LocoInfo::Mode locoMode(uint16_t loco_addr) final;
  void locoMode(uint16_t, z21::LocoInfo::Mode mode) final;
  void broadcastLocoInfo(uint16_t loco_addr) final;
  void broadcastLocoEntry(uint16_t loco_addr) final;
 
  // Switching interface
  [[nodiscard]] z21::TurnoutInfo turnoutInfo(uint16_t accy_addr) final;
  [[nodiscard]] z21::AccessoryInfo accessoryInfo(uint16_t accy_addr) final;
  void turnout(uint16_t accy_addr, bool p, bool a, bool q) final;
  void accessory(uint16_t accy_addr, uint8_t dddddddd) final;
  [[nodiscard]] z21::TurnoutInfo::Mode turnoutMode(uint16_t accy_addr) final;
  void turnoutMode(uint16_t accy_addr, z21::TurnoutInfo::Mode mode) final;
  void broadcastTurnoutInfo(uint16_t accy_addr) final;
  void broadcastExtAccessoryInfo(uint16_t accy_addr) final;
 
  // Programming interface
  [[nodiscard]] bool cvRead(uint16_t cv_addr) final;
  [[nodiscard]] bool cvWrite(uint16_t cv_addr, uint8_t byte) final;
  void cvPomRead(uint16_t loco_addr, uint16_t cv_addr) final;
  void cvPomWrite(uint16_t loco_addr, uint16_t cv_addr, uint8_t byte) final;
  void cvPomAccessoryRead(uint16_t accy_addr, uint16_t cv_addr, bool) final;
  void cvPomAccessoryWrite(uint16_t accy_addr,
                           uint16_t cv_addr,
                           uint8_t byte,
                           bool) final;
  void cvNackShortCircuit() final;
  void cvNack() final;
  void cvAck(uint16_t cv_addr, uint8_t byte) final;
 
  // RailCom interface
  [[nodiscard]] z21::RailComData railComData(uint16_t loco_addr) final;
  void broadcastRailComData(uint16_t loco_addr) final;
 
  // This gets called by FreeRTOS
  [[noreturn]] void taskFunction(void*);
 
  //
  void operationsLoop();
  void operationsLocos();
  void operationsTurnouts();
  void operationsBiDi();
  void serviceLoop();
  std::optional<uint8_t> serviceRead(uint16_t cv_addr);
  std::optional<uint8_t> serviceWrite(uint16_t cv_addr, uint8_t byte);
  std::optional<bool> serviceReceiveBit();
  std::optional<uint8_t> serviceReceiveByte();
 
  //
  void resume();
  void suspend();
 
  //
  Loco& getOrInsertLoco(uint16_t loco_addr);
  Turnout& getOrInsertTurnout(uint16_t accy_addr);
 
  //
  void sendLocos(std::span<Locos::iterator, 2uz> its) const;
  Packet makeDrivePacket(Address::value_type addr, Loco const& loco) const;
  Address basicOrExtendedLocoAddress(Address::value_type addr) const;
  bool maybeInvertR(bool p) const;
 
  //
  void sendToFront(Packet const& packet, size_t n = 1uz) const;
  void sendToBack(Packet const& packet, size_t n = 1uz) const;
 
  Locos _locos;
  Turnouts _turnouts;
 
  std::mutex _internal_mutex;
  std::shared_ptr<z21::server::intf::System> _z21_system_service;
  std::shared_ptr<z21::server::intf::Dcc> _z21_dcc_service;
 
  // NVS cache
  struct {
    uint8_t programming_type{};
    uint8_t program_packet_count{};
    bool bit_verify_to_1{};
    uint8_t loco_flags{};
    uint8_t accy_flags{};
    uint8_t accy_switch_time{};
    uint8_t accy_packet_count{};
  } _nvs{};

  struct CvRequest {
    TickType_t timeout_tick{};     
    uint16_t addr{};               
    uint16_t cv_addr{};            
    std::optional<uint8_t> byte{}; 
  };
  ztl::inplace_deque<CvRequest, Z21_SERVER_MAX_LOCO_ADDRESSES_PER_CLIENT>
    _cv_request_deque{};
  ztl::inplace_deque<CvRequest, Z21_SERVER_MAX_LOCO_ADDRESSES_PER_CLIENT>
    _cv_pom_request_deque{};
};
 
} // namespace mw::dcc