ClariusBLE.h

Go to the documentation of this file.

/*=Plus=header=begin======================================================
    Program: Plus
    Copyright (c) Verdure Imaging Inc, Stockton, California. All rights reserved.
    See License.txt for details.
    We would like to acknowledge Verdure Imaging Inc for generously open-sourcing
    this support for the Clarius OEM interface to the PLUS & Slicer communities.
=========================================================Plus=header=end*/

#ifndef _CLARIUSBLE_H
#define _CLARIUSBLE_H

// local includes
#include "PlusConfigure.h"

// STL includes
#include <memory>
#include <string>
#include <utility>
#include <vector>

class ClariusBLEPrivate;

//-----------------------------------------------------------------------------
enum class ClariusAvailability
{
  AVAILABLE,    // available for control over BLE
  LISTEN,       // available for casting
  NOT_AVAILABLE
};

//-----------------------------------------------------------------------------
enum class ClariusWifiMode
{
  ACCESS_POINT, // probe is configured to be connected to directly 
                // via the DIRECT-**SN** network
  LAN           // probe is configured to connect to a local area network
};

//-----------------------------------------------------------------------------
struct ClariusWifiInfo
{
  bool Ready;
  ClariusAvailability Available;
  ClariusWifiMode WifiMode;
  std::string SSID;
  std::string Password;
  std::string IPv4;
  std::string MacAddress;
  int ControlPort;
  int CastPort;
  int Channel;

  ClariusWifiInfo()
    : Ready(false)
    , Available(ClariusAvailability::NOT_AVAILABLE)
    , WifiMode(ClariusWifiMode::ACCESS_POINT)
    , SSID("")
    , Password("")
    , IPv4("")
    , MacAddress("")
    , ControlPort(-1)
    , CastPort(-1)
    , Channel(-1)
  {
  }

  ClariusWifiInfo(const ClariusWifiInfo&) = default;
  ClariusWifiInfo& operator=(const ClariusWifiInfo&) = default;
};

//-----------------------------------------------------------------------------
class ClariusBLE
{
public:

  ClariusBLE();

  ~ClariusBLE();

  PlusStatus ClariusBLE::FindBySerial(std::string serialNum);

  std::vector<std::string> RetrieveFoundProbeIds();

  bool IsProbeConnected();

  PlusStatus Connect();

  PlusStatus Disconnect();

  PlusStatus CloseConnection();

  bool IsProbePowered();

  PlusStatus RequestProbeOn();

  PlusStatus RequestProbeOff();

  bool AwaitWifiInfoReady();

  PlusStatus ClariusBLE::ReadWifiInfo();

  PlusStatus ConfigureWifiAP();

  PlusStatus ConfigureWifiLAN(std::string ssid, std::string password);

  std::pair<PlusStatus, ClariusWifiInfo> GetWifiInfo();

  std::string GetLastError();

private:

  std::unique_ptr<ClariusBLEPrivate> _impl;

};

#endif // _CLARIUSBLE_H