24288605255

Committed 11 Apr 2026 06:17PM UTC coverage: 25.599% (-2.4%) from 27.99%

Build # 24288605255

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #222 from traintastic/cbus

Added CBUS/VLCB hardware support

Coverage Stats

169 of 3369 new or added lines in 99 files covered. (5.02%)

5 existing lines in 4 files now uncovered.

8300 of 32423 relevant lines covered (25.6%)

178.31 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/server/src/hardware/interface/cbusinterface.cpp

/**
 * This file is part of Traintastic,
 * see <https://github.com/traintastic/traintastic>.
 *
 * Copyright (C) 2026 Reinder Feenstra
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#include "cbusinterface.hpp"
#include "cbus/cbusnodelist.hpp"
#include "cbus/cbussessionlist.hpp"
#include "cbus/cbussettings.hpp"
#include "../decoder/decoderchangeflags.hpp"
#include "../decoder/list/decoderlist.hpp"
#include "../decoder/list/decoderlisttablemodel.hpp"
#include "../input/input.hpp"
#include "../input/list/inputlist.hpp"
#include "../output/addressoutput.hpp"
#include "../output/list/outputlist.hpp"
#include "../protocol/cbus/cbusconst.hpp"
#include "../protocol/cbus/cbuskernel.hpp"
#include "../protocol/cbus/iohandler/cbuscanusbiohandler.hpp"
#include "../protocol/cbus/iohandler/cbuscanetheriohandler.hpp"
#include "../protocol/cbus/iohandler/cbussimulationiohandler.hpp"
#ifdef __linux__
  #include "../protocol/cbus/iohandler/cbussocketcaniohandler.hpp"
#endif
#include "../protocol/cbus/simulator/cbussimulator.hpp"
#include "../protocol/cbus/simulator/module/cbuscancab.hpp"
#include "../protocol/cbus/simulator/module/cbuscancmd.hpp"
#include "../../core/attributes.hpp"
#include "../../core/controllerlist.hpp"
#include "../../core/eventloop.hpp"
#include "../../core/method.tpp"
#include "../../core/objectproperty.tpp"
#include "../../log/log.hpp"
#include "../../log/logmessageexception.hpp"
#include "../../utils/displayname.hpp"
#include "../../utils/inrange.hpp"
#include "../../world/world.hpp"

namespace {

constexpr auto decoderListColumns = DecoderListColumn::Id | DecoderListColumn::Name | DecoderListColumn::Address;
constexpr auto inputListColumns = InputListColumn::Channel | InputListColumn::Node | InputListColumn::Address;
constexpr auto outputListColumns = OutputListColumn::Channel | OutputListColumn::Node | OutputListColumn::Address;

constexpr auto nodeNumberRange = std::make_pair(std::numeric_limits<uint16_t>::min(), std::numeric_limits<uint16_t>::max());
constexpr auto eventNumberRange = std::make_pair(std::numeric_limits<uint16_t>::min(), std::numeric_limits<uint16_t>::max());

template<typename T>
void deduplicate(std::vector<T>& v)
{
  std::sort(v.begin(), v.end());
  v.erase(std::unique(v.begin(), v.end()), v.end());
}

}

CREATE_IMPL(CBUSInterface)

CBUSInterface::CBUSInterface(World& world, std::string_view _id)
  : Interface(world, _id)
  , DecoderController(*this, decoderListColumns)
  , InputController(static_cast<IdObject&>(*this))
  , OutputController(static_cast<IdObject&>(*this))
  , type{this, "type", CBUSInterfaceType::CANUSB, PropertyFlags::ReadWrite | PropertyFlags::Store,
      [this](CBUSInterfaceType /*value*/)
      {
        updateVisible();
      }}
  , device{this, "device", "", PropertyFlags::ReadWrite | PropertyFlags::Store}
  , hostname{this, "hostname", "", PropertyFlags::ReadWrite | PropertyFlags::Store}
  , port{this, "port", 0, PropertyFlags::ReadWrite | PropertyFlags::Store}
  , interface{this, "interface", "", PropertyFlags::ReadWrite | PropertyFlags::Store}
  , canId{this, "can_id", 0x7D, PropertyFlags::ReadWrite | PropertyFlags::Store}
  , cbus{this, "cbus", nullptr, PropertyFlags::ReadOnly | PropertyFlags::Store | PropertyFlags::SubObject}
  , cbusNodeList{this, "cbus_node_list", nullptr, PropertyFlags::ReadOnly | PropertyFlags::NoStore | PropertyFlags::SubObject}
  , cbusSessionList{this, "cbus_session_list", nullptr, PropertyFlags::ReadOnly | PropertyFlags::NoStore | PropertyFlags::SubObject}
{
  name = "CBUS/VLCB";
  cbus.setValueInternal(std::make_shared<CBUSSettings>(*this, cbus.name()));
  cbusNodeList.setValueInternal(std::make_shared<CBUSNodeList>(*this, cbusNodeList.name()));
  cbusSessionList.setValueInternal(std::make_shared<CBUSSessionList>(*this, cbusSessionList.name()));

  Attributes::addDisplayName(type, DisplayName::Interface::type);
  Attributes::addEnabled(type, !online);
  Attributes::addValues(type, CBUSInterfaceTypeValues);
  m_interfaceItems.insertBefore(type, notes);

  Attributes::addEnabled(device, !online);
  Attributes::addVisible(device, false);
  m_interfaceItems.insertBefore(device, notes);

  Attributes::addDisplayName(hostname, DisplayName::IP::hostname);
  Attributes::addEnabled(hostname, !online);
  Attributes::addVisible(hostname, false);
  m_interfaceItems.insertBefore(hostname, notes);

  Attributes::addDisplayName(port, DisplayName::IP::port);
  Attributes::addEnabled(port, !online);
  Attributes::addVisible(port, false);
  m_interfaceItems.insertBefore(port, notes);

  Attributes::addDisplayName(interface, DisplayName::Hardware::interface);
  Attributes::addEnabled(interface, !online);
  Attributes::addVisible(interface, false);
  m_interfaceItems.insertBefore(interface, notes);

  Attributes::addEnabled(canId, !online);
  Attributes::addMinMax(canId, CBUS::canIdMin, CBUS::canIdMax);
  Attributes::addVisible(canId, false);
  m_interfaceItems.insertBefore(canId, notes);

  m_interfaceItems.insertBefore(cbus, notes);

  m_interfaceItems.insertBefore(cbusNodeList, notes);

  m_interfaceItems.insertBefore(cbusSessionList, notes);

  m_interfaceItems.insertBefore(decoders, notes);

  m_interfaceItems.insertBefore(inputs, notes);

  m_interfaceItems.insertBefore(outputs, notes);

  m_cbusPropertyChanged = cbus->propertyChanged.connect(
    [this](BaseProperty& /*property*/)
    {
      if(m_kernel)
      {
        m_kernel->setConfig(cbus->config());
      }
    });

  updateVisible();
}

CBUSInterface::~CBUSInterface() = default;

bool CBUSInterface::send(std::vector<uint8_t> message)
{
  if(m_kernel)
  {
    return m_kernel->send(std::move(message));
  }
  return false;
}

bool CBUSInterface::sendDCC(std::vector<uint8_t> dccPacket, uint8_t repeat)
{
  if(m_kernel)
  {
    return m_kernel->sendDCC(std::move(dccPacket), repeat);
  }
  return false;
}

size_t CBUSInterface::registerOnReceive(CBUS::OpCode opCode, std::function<void(uint8_t, const CBUS::Message&)> callback)
{
  if(m_kernel)
  {
    return m_kernel->registerOnReceive(opCode, std::move(callback));
  }
  return 0;
}

void CBUSInterface::unregisterOnReceive(size_t handle)
{
  if(m_kernel)
  {
    m_kernel->unregisterOnReceive(handle);
  }
}

std::span<const DecoderProtocol> CBUSInterface::decoderProtocols() const
{
  static constexpr std::array<DecoderProtocol, 2> protocols{DecoderProtocol::DCCShort, DecoderProtocol::DCCLong};
  return std::span<const DecoderProtocol>{protocols.data(), protocols.size()};
}

void CBUSInterface::decoderChanged(const Decoder& decoder, DecoderChangeFlags changes, uint32_t functionNumber)
{
  if(m_kernel)
  {
    const bool longAddress = (decoder.protocol == DecoderProtocol::DCCLong);

    if(has(changes, DecoderChangeFlags::FunctionValue) && functionNumber <= CBUS::engineFunctionMax)
    {
      m_kernel->setEngineFunction(
        decoder.address,
        longAddress,
        static_cast<uint8_t>(functionNumber),
        decoder.getFunctionValue(functionNumber));
    }
    else
    {
      m_kernel->setEngineSpeedDirection(
        decoder.address,
        longAddress,
        Decoder::throttleToSpeedStep<uint8_t>(decoder.throttle, decoder.speedSteps),
        decoder.speedSteps,
        decoder.emergencyStop,
        decoder.direction == Direction::Forward);
    }
  }
}

std::span<const InputChannel> CBUSInterface::inputChannels() const
{
  static const std::array<InputChannel, 2> channels{
    InputChannel::ShortEvent,
    InputChannel::LongEvent,
  };
  return channels;
}

bool CBUSInterface::isInputLocation(InputChannel channel, const InputLocation& location) const
{
  if(hasNodeAddressLocation(channel))
  {
    return
      inRange<uint32_t>(std::get<InputNodeAddress>(location).node, nodeNumberRange) &&
      inRange<uint32_t>(std::get<InputNodeAddress>(location).address, inputAddressMinMax(channel));
  }
  return InputController::isInputLocation(channel, location);
}

std::pair<uint32_t, uint32_t> CBUSInterface::inputAddressMinMax(InputChannel /*channel*/) const
{
  return eventNumberRange;
}

void CBUSInterface::inputSimulateChange(InputChannel channel, const InputLocation& location, SimulateInputAction action)
{
  if(m_simulator)
  {
    boost::asio::post(m_kernel->ioContext(),
      [this, channel, location, action]
      {
        switch(channel)
        {
          case InputChannel::ShortEvent:
            m_simulator->shortEvent(std::get<InputAddress>(location).address, action);
            break;

          case InputChannel::LongEvent:
            m_simulator->longEvent(std::get<InputNodeAddress>(location).node, std::get<InputNodeAddress>(location).address, action);
            break;

          default: [[unlikely]]
            assert(false);
            break;
        }
      });
  }
}

std::span<const OutputChannel> CBUSInterface::outputChannels() const
{
  static const std::array<OutputChannel, 4> channels{
    OutputChannel::ShortEvent,
    OutputChannel::LongEvent,
    OutputChannel::AccessoryDCC,
    OutputChannel::DCCext,
  };
  return channels;
}

std::pair<uint32_t, uint32_t> CBUSInterface::outputNodeMinMax(OutputChannel /*channel*/) const
{
  return eventNumberRange;
}

std::pair<uint32_t, uint32_t> CBUSInterface::outputAddressMinMax(OutputChannel channel) const
{
  switch(channel)
  {
    case OutputChannel::LongEvent:
    case OutputChannel::ShortEvent:
      return {std::numeric_limits<uint16_t>::min(), std::numeric_limits<uint16_t>::max()};

    default:
      return OutputController::outputAddressMinMax(channel);
  }
}

bool CBUSInterface::setOutputValue(OutputChannel channel, const OutputLocation& location, OutputValue value)
{
  if(m_kernel)
  {
    switch(channel)
    {
      case OutputChannel::ShortEvent:
        assert(std::holds_alternative<TriState>(value));
        if(auto v = std::get<TriState>(value); v != TriState::Undefined)
        {
          assert(std::holds_alternative<OutputAddress>(location));
          const auto address = static_cast<uint16_t>(std::get<OutputAddress>(location).address);
          m_kernel->setAccessoryShort(address, v == TriState::True);
          return true;
        }
        break;

      case OutputChannel::LongEvent:
        assert(std::holds_alternative<TriState>(value));
        if(auto v = std::get<TriState>(value); v != TriState::Undefined)
        {
          assert(std::holds_alternative<OutputNodeAddress>(location));
          const auto node = static_cast<uint16_t>(std::get<OutputNodeAddress>(location).node);
          const auto address = static_cast<uint16_t>(std::get<OutputNodeAddress>(location).address);
          m_kernel->setAccessory(node, address, v == TriState::True);
          return true;
        }
        break;

      case OutputChannel::AccessoryDCC:
        assert(std::holds_alternative<OutputPairValue>(value));
        if(const auto v = std::get<OutputPairValue>(value); v == OutputPairValue::First || v == OutputPairValue::Second)
        {
          assert(std::holds_alternative<OutputAddress>(location));
          const auto address = static_cast<uint16_t>(std::get<OutputAddress>(location).address);
          m_kernel->setDccAccessory(address, v == OutputPairValue::Second);
          return true;
        }
        break;

      case OutputChannel::DCCext:
        assert(std::holds_alternative<int16_t>(value));
        if(const auto v = std::get<int16_t>(value); inRange<int16_t>(v, std::numeric_limits<uint8_t>::min(), std::numeric_limits<uint8_t>::max()))
        {
          assert(std::holds_alternative<OutputAddress>(location));
          const auto address = static_cast<uint16_t>(std::get<OutputAddress>(location).address);
          m_kernel->setDccAdvancedAccessoryValue(address, static_cast<uint8_t>(v));
          return true;
        }
        break;

      default: [[unlikely]]
        assert(false);
        break;
    }
  }
  return false;
}

void CBUSInterface::addToWorld()
{
  Interface::addToWorld();
  DecoderController::addToWorld();
  InputController::addToWorld(inputListColumns);
  OutputController::addToWorld(outputListColumns);
  m_world.cbusInterfaces->add(Object::shared_ptr<CBUSInterface>());
}

void CBUSInterface::loaded()
{
  Interface::loaded();

  updateVisible();
}

void CBUSInterface::destroying()
{
  m_world.cbusInterfaces->add(Object::shared_ptr<CBUSInterface>());
  m_cbusPropertyChanged.disconnect();
  OutputController::destroying();
  InputController::destroying();
  DecoderController::destroying();
  Interface::destroying();
}

void CBUSInterface::worldEvent(WorldState state, WorldEvent event)
{
  Interface::worldEvent(state, event);

  switch(event)
  {
    case WorldEvent::PowerOff:
      if(m_kernel)
      {
        m_kernel->trackOff();
      }
      break;

    case WorldEvent::PowerOn:
      if(m_kernel)
      {
        m_kernel->trackOn();
      }
      break;

    case WorldEvent::Stop:
      if(m_kernel)
      {
        m_kernel->requestEmergencyStop();
      }
      break;

    case WorldEvent::Run:
      if(m_kernel)
      {
        // TODO: send all known speed values
      }
      break;

    default:
      break;
  }
}

bool CBUSInterface::setOnline(bool& value, bool simulation)
{
  if(!m_kernel && value)
  {
    try
    {
      if(simulation)
      {
        m_simulator = std::make_unique<CBUS::Simulator>();
        m_simulator->addModule(std::make_unique<CBUS::Module::CANCMD>(*m_simulator));
        m_simulator->addModule(std::make_unique<CBUS::Module::CANCAB>(*m_simulator));
        m_kernel = CBUS::Kernel::create<CBUS::SimulationIOHandler>(id.value(), cbus->config(), CBUS::CanId::CANUSB, std::ref(*m_simulator));
      }
      else
      {
        switch(type)
        {
          case CBUSInterfaceType::CANUSB:
            m_kernel = CBUS::Kernel::create<CBUS::CANUSBIOHandler>(id.value(), cbus->config(), CBUS::CanId::CANUSB, device.value());
            break;

          case CBUSInterfaceType::CANEther:
            m_kernel = CBUS::Kernel::create<CBUS::CANEtherIOHandler>(id.value(), cbus->config(), CBUS::CanId::CANEther, hostname.value(), port.value());
            break;

          case CBUSInterfaceType::SocketCAN:
#ifdef __linux__
            m_kernel = CBUS::Kernel::create<CBUS::SocketCANIOHandler>(id.value(), cbus->config(), canId.value(), interface.value());
            break;
#else
            setState(InterfaceState::Error);
            Log::log(*this, LogMessage::C2005_SOCKETCAN_IS_ONLY_AVAILABLE_ON_LINUX);
            return false;
#endif
        }
      }

      setState(InterfaceState::Initializing);

      m_kernel->setOnStarted(
        [this]()
        {
          setState(InterfaceState::Online);
        });
      m_kernel->setOnError(
        [this]()
        {
          setState(InterfaceState::Error);
          online = false; // communication no longer possible
        });
      m_kernel->onPresenceOfNode =
        [this](uint8_t canId_, uint16_t nodeNumber, uint8_t manufacturerId, uint8_t moduleId, bool flimMode, bool supportsServiceDiscovery)
        {
          cbusNodeList->add(CBUSNodeList::Node{
            .nodeNumber = nodeNumber,
            .canId = canId_,
            .manufacturerId = manufacturerId,
            .moduleId = moduleId,
            .flim = flimMode,
            .vlcb = supportsServiceDiscovery,
            .parameters = {},
          });
        };
      m_kernel->onNodeParameterResponse =
        [this](uint8_t canId_, uint16_t nodeNumber, CBUS::NodeParameter parameter, uint8_t parameterValue)
        {
          auto& nodes = cbusNodeList->m_nodes;
          if(auto it = std::find_if(nodes.begin(), nodes.end(),
              [canId_, nodeNumber](const auto& item)
              {
                return item.canId == canId_ && item.nodeNumber == nodeNumber;
              }); it != nodes.end())
          {
            switch(parameter)
            {
              using enum CBUS::NodeParameter;

              case VersionMajor:
                it->parameters.versionMajor = parameterValue;
                break;

              case VersionMinor:
                it->parameters.versionMinor = parameterValue;
                break;

              case BetaReleaseCode:
                it->parameters.betaReleaseCode = parameterValue;
                break;

              default:
                return;
            }
            cbusNodeList->rowChanged(static_cast<uint32_t>(std::distance(nodes.begin(), it)));
          }
        };
      m_kernel->onTrackOff =
        [this]()
        {
          if(contains(m_world.state, WorldState::PowerOn))
          {
            m_world.powerOff();
          }
        };
      m_kernel->onTrackOn =
        [this]()
        {
          if(!contains(m_world.state, WorldState::PowerOn))
          {
            m_world.powerOn();
          }
        };
      m_kernel->onEmergencyStop =
        [this]()
        {
          if(contains(m_world.state, WorldState::Run))
          {
            m_world.stop();
          }
        };
      m_kernel->onEngineSessionAcquire =
        [this](uint8_t session, uint16_t address, bool isLongAddress)
        {
          if(auto it = cbusSessionList->findEngine(address, isLongAddress); it != cbusSessionList->end())
          {
            it->session = session;
            cbusSessionList->rowChanged(static_cast<uint32_t>(std::distance(cbusSessionList->begin(), it)));
          }
          else
          {
            cbusSessionList->add({session, address, isLongAddress});
          }
        };
      m_kernel->onEngineSpeedDirectionChanged =
        [this](uint8_t session, uint8_t speed, bool forward)
        {
          if(auto it = cbusSessionList->findSession(session); it != cbusSessionList->end())
          {
            it->speed = speed;
            it->direction = forward ? Direction::Forward : Direction::Reverse;
            cbusSessionList->rowChanged(static_cast<uint32_t>(std::distance(cbusSessionList->begin(), it)));
          }
        };
      m_kernel->onEngineFunctionChanged =
        [this](uint8_t session, uint8_t number, bool on)
        {
          if(auto it = cbusSessionList->findSession(session); it != cbusSessionList->end())
          {
            assert(number < it->functions.size());
            it->functions[number] = toTriState(on);
            cbusSessionList->rowChanged(static_cast<uint32_t>(std::distance(cbusSessionList->begin(), it)));
          }
        };
      m_kernel->onEngineSessionReleased =
        [this](uint8_t session)
        {
          if(auto it = cbusSessionList->findSession(session); it != cbusSessionList->end())
          {
            it->session = std::nullopt;
            cbusSessionList->rowChanged(static_cast<uint32_t>(std::distance(cbusSessionList->begin(), it)));
          }
        };
      m_kernel->onEngineSessionCancelled =
        [this](uint16_t address, bool isLongAddress)
        {
          if(auto it = cbusSessionList->findEngine(address, isLongAddress); it != cbusSessionList->end())
          {
            it->session = std::nullopt;
            cbusSessionList->rowChanged(static_cast<uint32_t>(std::distance(cbusSessionList->begin(), it)));
          }
        };
      m_kernel->onShortEvent =
        [this](uint16_t eventNumber, bool on)
        {
          updateInputValue(InputChannel::ShortEvent, InputAddress(eventNumber), toTriState(on));
          updateOutputValue(OutputChannel::ShortEvent, OutputAddress(eventNumber), toTriState(on));
        };
      m_kernel->onLongEvent =
        [this](uint16_t nodeNumber, uint16_t eventNumber, bool on)
        {
          updateInputValue(InputChannel::LongEvent, InputNodeAddress(nodeNumber, eventNumber), toTriState(on));
          updateOutputValue(OutputChannel::LongEvent, OutputNodeAddress(nodeNumber, eventNumber), toTriState(on));
        };

      {
        std::vector<uint16_t> shortEvents;
        std::vector<std::pair<uint16_t, uint16_t>> longEvents;

        for(const auto& [key, input] : m_inputs)
        {
          if(input->channel == InputChannel::ShortEvent)
          {
            shortEvents.emplace_back(input->address);
          }
          else if(input->channel == InputChannel::LongEvent)
          {
            longEvents.emplace_back(input->node, input->address);
          }
        }

        for(const auto& [key, output] : m_outputs)
        {
          if(output->channel == OutputChannel::ShortEvent)
          {
            shortEvents.emplace_back(static_cast<const AddressOutput&>(*output).address);
          }
          else if(output->channel == OutputChannel::LongEvent)
          {
            longEvents.emplace_back(static_cast<const AddressOutput&>(*output).node, static_cast<const AddressOutput&>(*output).address);
          }
        }

        deduplicate(shortEvents);
        deduplicate(longEvents);

        m_kernel->setRequestEventsDuringInitialize(std::move(shortEvents), std::move(longEvents));
      }

      m_kernel->start();

      Attributes::setEnabled({type, device, hostname, port, interface, canId}, false);
    }
    catch(const LogMessageException& e)
    {
      setState(InterfaceState::Offline);
      Log::log(*this, e.message(), e.args());
      return false;
    }
  }
  else if(m_kernel && !value)
  {
    Attributes::setEnabled({type, device, hostname, port, interface, canId}, true);

    m_kernel->stop();
    EventLoop::deleteLater(m_kernel.release());
    EventLoop::deleteLater(m_simulator.release());

    cbusNodeList->clear();

    if(status->state != InterfaceState::Error)
    {
      setState(InterfaceState::Offline);
    }
  }
  return true;
}

void CBUSInterface::updateVisible()
{
  Attributes::setVisible(device, (type == CBUSInterfaceType::CANUSB));
  Attributes::setVisible({hostname, port}, (type == CBUSInterfaceType::CANEther));
  Attributes::setVisible({interface, canId}, (type == CBUSInterfaceType::SocketCAN));
}

traintastic / traintastic / 24288605255

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous