MFEPlatform.hpp

/*
** Copyright (C) 2022 CERN
**
** This software is provided 'as-is', without any express or implied
** warranty.  In no event will the authors be held liable for any damages
** arising from the use of this software.
**
** Permission is granted to anyone to use this software for any purpose,
** including commercial applications, and to alter it and redistribute it
** freely, subject to the following restrictions:
**
** 1. The origin of this software must not be misrepresented; you must not
**    claim that you wrote the original software. If you use this software
**    in a product, an acknowledgment in the product documentation would be
**    appreciated but is not required.
** 2. Altered source versions must be plainly marked as such, and must not be
**    misrepresented as being the original software.
** 3. This notice may not be removed or altered from any source distribution.
**
** Created on: 2022-11-22T14:47:04
** Author: Sylvain Fargier <sylvain.fargier@cern.ch>
*/
 
#ifndef MFEPLATFORM_HPP__
#define MFEPLATFORM_HPP__
 
#include <memory>
 
#include "MFEAxisPositionMonitor.hpp"
#include "platform/specialized/MGrblPlatform/MGrblPlatform.hpp"
 
struct edge_reg;
namespace smc {
namespace internal {
class MFEPlatform : public MGrblPlatform
{
public:
    typedef std::shared_ptr<MFEPlatform> Shared;
 
    struct RegInfo;
    struct ResolverInfo;
    struct Context;
 
    static inline PlatformBase::Shared create(const ccut::yml::NodeRef &config)
    {
        return PlatformBase::Shared(new MFEPlatform(config));
    }
    virtual ~MFEPlatform();
 
    inline std::shared_ptr<MFEPlatform> shared_from_this()
    {
        return std::static_pointer_cast<MFEPlatform>(
            PlatformBase::shared_from_this());
    }
 
    inline std::shared_ptr<const MFEPlatform> shared_from_this() const
    {
        return std::static_pointer_cast<const MFEPlatform>(
            PlatformBase::shared_from_this());
    }
 
    DeviceTypeList getSupportedDevices() const override;
 
    DeviceList generateDevices(const DeviceTypeList &deviceType) override;
 
    grbl::Axis getResolverAxis(const std::string &uid) const;
 
    grbl::Axis getResolverMonitorAxis(const std::string &uid) const;
 
    void updateResolverSetting(const std::string &resolverId,
                               grbl::SettingId settingId,
                               const std::string &value);
 
    units::value_t getResolverPosition(const std::string &uid,
                                       const units::unit_t unit) const;
    units::value_t getResolverMode(const std::string &uid) const;
    AxisPositionMonitor::State getResolverMonitorState(const std::string &uid,
                                                       uint32_t &diff);
 
    static const std::string s_loggerCat;
    static const std::string s_resolverMonitorSuffix;
    static const std::string s_resolverSettingPrefix;
    static const std::string s_stepLostConfig;
    static const std::set<std::string> s_resolverConfigHidden;
    static const std::set<std::string> s_monitorConfigHidden;
 
    void processUpdate(MGrblPlatform::Context &ctx) override;
 
protected:
    explicit MFEPlatform(const ccut::yml::NodeRef &ref);
 
    MGrblAxis::Shared createAxis(
        const std::string &uid,
        const std::shared_ptr<GrblPlatform> &grbl) override;
 
    const ResolverInfo &_getResolverInfo(const std::string &uid) const;
 
    void generateGpios(Context &ctx, std::list<DeviceBase::Shared> &out);
 
    std::map<std::string, ResolverInfo> m_resolvers;
};
 
} // namespace internal
} // namespace smc
 
#include "MFEPlatformData.hpp"
 
#endif