ethcamerasettings.h

/**************************************************************************
 *
 * File: ethcamerasettings.h
 *
 *
 * Description: Contains the wrapper class definition for the ETH camera API.
 * The ETH Camera API allows you to send and receive commands to a Ethernet Camera that supports
 * the ISO17215 standard. This simplifies handling and communication with ETH cameras.
 *
 * Copyright (C) 2018 CrossControl AB
 * All rights reserved.
 * Contact: CrossControl AB (info@crosscontrol.com)
 *
**************************************************************************/

#ifndef ETHCAMERASETTINGS_H
#define ETHCAMERASETTINGS_H

/*************************************************************************
 * Include Files
 *************************************************************************/
#include <string>
#include <vector>
#include "camtypes.h"

/*************************************************************************
 * Manifest constants, macros
 *************************************************************************/
#ifndef MAX_WAIT_TIME_MS
#define MAX_WAIT_TIME_MS 1500
#endif

class CameraSettings;

namespace CrossControl {

/*************************************************************************
 * Class definition
 *************************************************************************/
class ETHCameraSettings
{
public:

    ETHCameraSettings();

    ETHCameraSettings(std::string ipAddress, int portNum, int clientID = 1);

    ETHCameraSettings(ETHCameraSettings &other) = delete;

    ~ETHCameraSettings();

    ETHCamStatus open();

    ETHCamStatus open(std::string ipAddress, int portNum);

    ETHCamStatus openServiceDiscovery(std::vector<std::string> multicastGroups, int portNumber);

    ETHCamStatus openServiceDiscovery(int portNumber);

    ETHCamStatus close();

    ETHCamStatus closeServiceDiscoverySocket();

    ETHCamStatus getDatasheet(Datasheet &datasheet, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus getCamStatus(CamStatus &camStatus, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus setCamExclusive(const int expireTimeSeconds = 5, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus eraseCamExclusive(const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus setRegionOfInterest(const RegionOfInterest regionOfInterest, const uint32_t roiIndex, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus getRegionOfInterest(RegionOfInterest &regionOfInterest, const uint32_t roiIndex, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus getRegionsOfInterest(std::vector<uint32_t> &roiIndices, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus eraseRegionOfInterest(const uint32_t roiIndex, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus subscribeROIVideo(const uint32_t roiIndex = 0, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus subscribeROIVideo(VideoContent &videoContent, const uint32_t roiIndex = 0, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus unsubscribeROIVideo(const uint32_t roiIndex, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus setBrightnessControl(const SignedControl sControl, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus getBrightnessControl(SignedControl &sControl, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus setSaturationControl(const UnsignedControl uControl, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus getSaturationControl(UnsignedControl &uControl, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus setGammaControl(const UnsignedControl uControl, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus getGammaControl(UnsignedControl &uControl, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus setHeaterControl(const UnsignedControl uControl, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus getHeaterControl(UnsignedControl &uControl, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus setCamRegister(const ImagerRegister imagerRegister, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus setCamRegister(const uint16_t regAddress, const uint16_t regValue, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus setCamRegisters(const std::vector<ImagerRegister> &imagerRegisters, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus getCamRegister(const uint16_t regAddress, uint16_t &regValue, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus getCamRegisters(const std::vector<uint16_t> &addressList, std::vector<ImagerRegister> &imagerRegisters, const int maxWaitTimeMs = MAX_WAIT_TIME_MS);

    ETHCamStatus sendMessageNoResponse(const unsigned char *data, const size_t messageLength) const;

    ETHCamStatus sendMessageWithResponse(const unsigned char * data, const size_t messageLength, unsigned char * responseData, size_t &responseLength, const int maxWaitTimeMs = MAX_WAIT_TIME_MS) const;

    ETHCamStatus serviceDiscoveryGetIPv4(IPv4Option &option);

    uint16_t getSessionID() const;

    void setSessionID(uint16_t arg);

    uint16_t getClientID() const;

    void setClientID(uint16_t arg);

    static std::string stringifyETHCamStatus(const ETHCamStatus camStatus);

private:
    CameraSettings* m_cameraSettings;
};
}

#endif // ETHCAMERASETTINGS_H