Profiler.h

Go to the documentation of this file.

/*******************************************************************************
 *BSD 3-Clause License
 *
 *Copyright (c) 2016-2025, Mech-Mind Robotics Technologies Co., Ltd.
 *All rights reserved.
 *
 *Redistribution and use in source and binary forms, with or without
 *modification, are permitted provided that the following conditions are met:
 *
 *1. Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 *2. Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 *3. Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 *THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 *FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 *DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 *CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 *OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/
 
#pragma once
#include <memory>
#include <functional>
#include "api_global.h"
#include "ProfilerInfo.h"
#include "ProfileData.h"
#include "UserSetManager.h"
#include "UserSet.h"
 
namespace mmind {
 
namespace eye {
 
class ProfilerImpl;
enum class OutputLineGPIO {
    Line21 = 0,
    Line22,
    Line23,
    Line24,
    Line25,
    Line26,
    Line27,
    Line28,
};
 
enum class OutputLevel { Low, High };
enum class AcquisitionStatus {
    AcquisitionTriggerWait, 
    AcquisitionActive,      
    FrameTriggerWait,       
    FrameActive, 
};
 
struct ProfilerTemperature
{
    float controllerCpuTemperature{}; 
    float sensorCpuTemperature{};     
};
 
struct ProfilerStatus
{
    ProfilerTemperature temperature;
};
 
class MMIND_API_EXPORT Profiler
{
public:
    using AcquisitionCallback = std::function<void(const ProfileBatch& batch, void* pUser)>;
    Profiler();
 
    ~Profiler();
 
    Profiler(const Profiler& other) noexcept;
 
    Profiler& operator=(const Profiler& other) noexcept;
 
    static std::vector<ProfilerInfo> discoverProfilers(unsigned int timeoutMs = 5000);
 
    ErrorStatus connect(const ProfilerInfo& info, unsigned int timeoutMs = 5000);
 
    ErrorStatus saveVirtualDeviceFile(const ProfileBatch& data, const std::string& fileName);
 
    ErrorStatus connect(const std::string& ipAddress, unsigned int timeoutMs = 5000);
 
    ErrorStatus disconnect();
 
    ErrorStatus setHeartbeatInterval(unsigned int intervalMs);
 
    ErrorStatus getProfilerInfo(ProfilerInfo& info) const;
 
    ErrorStatus getProfilerStatus(ProfilerStatus& status) const;
 
    UserSetManager& userSetManager();
 
    UserSet& currentUserSet();
 
    ErrorStatus retrieveBatchData(ProfileBatch& batch, int timeoutMs = 4000) const;
 
    ErrorStatus triggerSoftware();
 
    ErrorStatus registerAcquisitionCallback(const Profiler::AcquisitionCallback& func, void* pUser);
 
    ErrorStatus startAcquisition();
 
    ErrorStatus stopAcquisition();
 
    ErrorStatus setOutputForGPIO(OutputLineGPIO outputLine, OutputLevel value, int holdTimeMs = -1);
 
    ErrorStatus getAcquisitionStatus(AcquisitionStatus& status);
 
private:
    friend class ProfilerEvent;
    friend class InternalInterfaces;
    std::shared_ptr<ProfilerImpl> _d;
};
 
} // namespace eye
 
} // namespace mmind