MechEyeLNXApi.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 <vector>
#include "api_global.h"
#include "MechEyeFrame.hpp"
#include "MechEyeDataType.h"
#include "MechEyeSettings.h"
 
namespace mmind {
 
namespace api {
 
class MechEyeDeviceImpl;
 
namespace lnxapi {
 
std::string MMIND_API_EXPORT getApiInformation();
 
class MMIND_API_EXPORT MechEyeDevice
{
public:
    MechEyeDevice();
 
    ~MechEyeDevice();
 
    static std::vector<api::MechEyeDeviceInfo> enumerateMechEyeDeviceList();
 
    ErrorStatus connect(const MechEyeDeviceInfo& info, const int timeout = 10000);
 
    ErrorStatus connect(const std::string& ipAddress, const int port = 5577,
                        const int timeout = 10000);
 
    void disconnect();
 
    ErrorStatus getDeviceInfo(api::MechEyeDeviceInfo& info) const;
 
    ErrorStatus saveAllSettingsToUserSets() const;
 
    ErrorStatus setCurrentUserSet(const std::string& userSetName) const;
 
    ErrorStatus getCurrentUserSet(std::string& userSetName) const;
 
    ErrorStatus getAllUserSets(std::vector<std::string>& userSetNames) const;
 
    ErrorStatus deleteUserSet(const std::string& userSetName) const;
 
    ErrorStatus addUserSet(const std::string& userSetName) const;
 
    ErrorStatus captureLnx2DImage(ColorMap& colorMap) const;
 
    ErrorStatus getLnxBatchRollData(float* depth, unsigned char* intensity, unsigned int* encoder,
                                    long long* frameId, int& lineCount) const;
 
    ErrorStatus getLnxBatchRollData(LineBatch& LineBatch) const;
 
    ErrorStatus stopLnxCaptureImage();
 
    ErrorStatus startLnxCaptureImage();
 
    ErrorStatus setLnxCaptureMode(CaptureMode value) const;
 
    ErrorStatus getLnxCaptureMode(CaptureMode& value) const;
 
    ErrorStatus setLnxRawTimeout(int time) const;
 
    ErrorStatus getLnxRawTimeout(int& time) const;
 
    ErrorStatus setLnxDepthTimeout(int time) const;
 
    ErrorStatus getLnxDepthTimeout(int& time) const;
 
    ErrorStatus getLnxXDataWidth(int& xDataWidth) const;
 
    ErrorStatus getLnxXScale(float& xScale) const;
 
    ErrorStatus setLnxLaserPowerLevel(int powerLevel) const;
 
    ErrorStatus getLnxLaserPowerLevel(int& powerLevel) const;
 
    ErrorStatus setScanExposureMode(ExposureMode mode) const;
 
    ErrorStatus getScanExposureMode(ExposureMode& mode) const;
 
    ErrorStatus setLnxExposure(int time) const;
 
    ErrorStatus getLnxExposure(int& time) const;
 
    ErrorStatus setScan3DHDRExposureSequence(int time1, int time2, int time3) const;
 
    ErrorStatus getScan3DHDRExposureSequence(int& time1, int& time2, int& time3) const;
 
    ErrorStatus setLnxHDRDualSlope(int value) const;
 
    ErrorStatus getLnxHDRDualSlope(int& value) const;
 
    ErrorStatus setLnxHDRTripleSlope(int value) const;
 
    ErrorStatus getLnxHDRTripleSlope(int& value) const;
 
    ErrorStatus setScan3DAnalogGain(ImageAnalogGain gainVal) const;
 
    ErrorStatus getScan3DAnalogGain(ImageAnalogGain& gainVal) const;
 
    ErrorStatus setScan3DAnalogGainFor8030(ImageAnalogGainFor8030 gainVal) const;
 
    ErrorStatus getScan3DAnalogGainFor8030(ImageAnalogGainFor8030& gainVal) const;
 
    ErrorStatus setScan3DDigitalGain(int gainVal) const;
 
    ErrorStatus getScan3DDigitalGain(int& gainVal) const;
 
    ErrorStatus setLnxROIMode(ROIMode mode) const;
 
    ErrorStatus getLnxROIMode(ROIMode& mode) const;
 
    ErrorStatus setLnxTriggerDelay(int delay) const;
 
    ErrorStatus getLnxTriggerDelay(int& delay) const;
 
    ErrorStatus setLnxDepthTriggerSource(TriggerSource triggerSource) const;
 
    ErrorStatus getLnxDepthTriggerSource(TriggerSource& triggerSource) const;
 
    ErrorStatus setLnxLineRate(double rate) const;
 
    ErrorStatus getLnxLineRate(double& rate) const;
 
    ErrorStatus setLnxProfileNum(int profileNum) const;
 
    ErrorStatus getLnxProfileNum(int& profileNum) const;
 
    ErrorStatus setLnxEncoderTriggerMode(EncoderTriggerMode mode) const;
 
    ErrorStatus getLnxEncoderTriggerMode(EncoderTriggerMode& mode) const;
 
    ErrorStatus setLnxEncoderDivide(int interval) const;
 
    ErrorStatus getLnxEncoderDivide(int& interval) const;
 
    ErrorStatus setLnxEncoderMultiplier(EncoderMultiplier multiple) const;
 
    ErrorStatus getLnxEncoderMultiplier(EncoderMultiplier& multiple) const;
 
    ErrorStatus setLnxFilterType(FilterType type) const;
 
    ErrorStatus getLnxFilterType(FilterType& type) const;
 
    ErrorStatus setLnxMeanFilterWindow(MeanFilterWindow window) const;
 
    ErrorStatus getLnxMeanFilterWindow(MeanFilterWindow& window) const;
 
    ErrorStatus setLnxMedianFilterWindow(MedianFilterWindow window) const;
 
    ErrorStatus getLnxMedianFilterWindow(MedianFilterWindow& window) const;
 
    ErrorStatus setLnxMaxFillingPointCount(int value) const;
 
    ErrorStatus getLnxMaxFillingPointCount(int& value) const;
 
    ErrorStatus setLnxProfileStrategy(ProfileStrategy value) const;
 
    ErrorStatus getLnxProfileStrategy(ProfileStrategy& value) const;
 
    ErrorStatus setLnxGrayFilterThresh(int value) const;
 
    ErrorStatus getLnxGrayFilterThresh(int& value) const;
 
    ErrorStatus setLnxMinStripeWidth(int value);
 
    ErrorStatus getLnxMinStripeWidth(int& value) const;
 
    ErrorStatus setLnxMaxStripeWidth(int value);
 
    ErrorStatus getLnxMaxStripeWidth(int& value) const;
 
    ErrorStatus setLnxMinStripeIntensity(int value);
 
    ErrorStatus getLnxMinStripeIntensity(int& value) const;
 
    ErrorStatus setLnxMaxStripeIntensity(int value);
 
    ErrorStatus getLnxMaxStripeIntensity(int& value) const;
 
    ErrorStatus getLnxEncoderValue(unsigned int& value) const;
 
private:
    MechEyeDeviceImpl* _d;
};
} // namespace lnxapi
} // namespace api
} // namespace mmind