VisionaryAutoIPScan.h

Go to the documentation of this file.

//
// Copyright (c) 2023 SICK AG, Waldkirch
//
// SPDX-License-Identifier: Unlicense
 
#pragma once
 
#include <cstdint>
#include <string>
#include <vector>
 
namespace visionary {
 
class VisionaryAutoIPScan
{
public:
  static constexpr std::uint16_t DEFAULT_PORT{30718u};
  static const std::string       DEFAULT_BROADCAST_ADDR;
  static const std::string       DEFAULT_IP_MASK;
  static const std::string       DEFAULT_GATEWAY;
  static constexpr bool          DEFAULT_DHCP{false};
  static constexpr std::uint16_t DEFAULT_TIMEOUT{5000};
 
  enum ProtocolType
  {
    INVALID_PROTOCOL = -1,
    COLA_A           = 2111,
    COLA_B           = 2112,
    COLA_2           = 2122
  };
 
  struct MacAddress
  {
    std::uint8_t macAddress[6];
  };
 
  struct DeviceInfo
  {
    std::string   deviceName;
    MacAddress    macAddress;
    std::string   ipAddress;
    std::string   subNet;
    std::uint16_t port;
    ProtocolType  protocolType;
  };
 
  VisionaryAutoIPScan(const std::string& serverIP, std::uint8_t prefixLength);
  std::vector<DeviceInfo> doScan(unsigned int timeOut, std::uint16_t port = DEFAULT_PORT);
 
  bool assign(const MacAddress&  destinationMac,
              ProtocolType       colaVer,
              const std::string& ipAddr,
              std::uint8_t       prefixLength,
              const std::string& ipGateway = DEFAULT_GATEWAY,
              bool               dhcp      = DEFAULT_DHCP,
              unsigned int       timout    = DEFAULT_TIMEOUT);
 
  static MacAddress  convertMacToStruct(const std::string& basicString);
  static std::string convertMacToString(const MacAddress& macAddress);
 
private:
  using ByteBuffer = std::vector<std::uint8_t>;
  std::string m_serverIP;
  std::string m_serverNetMask;
 
  DeviceInfo                       parseAutoIPXml(std::stringstream& rStringStream);
  DeviceInfo                       parseAutoIPBinary(const ByteBuffer& receivedBuffer);
  static std::vector<std::uint8_t> convertIpToBinary(const std::string& address);
  static std::string               networkPrefixToMask(std::uint8_t prefixLength);
};
 
} // namespace visionary