ClariusBLE Class Reference

#include <src/PlusDataCollection/Clarius/ClariusBLE.h>

Public Member Functions
bool	AwaitWifiInfoReady ()
	ClariusBLE ()
PlusStatus	CloseConnection ()
PlusStatus	ConfigureWifiAP ()
PlusStatus	ConfigureWifiLAN (std::string ssid, std::string password)
PlusStatus	Connect ()
PlusStatus	Disconnect ()
PlusStatus	FindBySerial (std::string serialNum)
std::string	GetLastError ()
std::pair< PlusStatus, ClariusWifiInfo >	GetWifiInfo ()
bool	IsProbeConnected ()
bool	IsProbePowered ()
PlusStatus	ReadWifiInfo ()
PlusStatus	RequestProbeOff ()
PlusStatus	RequestProbeOn ()
std::vector< std::string >	RetrieveFoundProbeIds ()
	~ClariusBLE ()

Detailed Description

Definition at line 72 of file ClariusBLE.h.

Constructor & Destructor Documentation

ClariusBLE()

ClariusBLE::ClariusBLE

(

)

Definition at line 697 of file ClariusBLE.cxx.

~ClariusBLE()

ClariusBLE::~ClariusBLE

(

)

Definition at line 703 of file ClariusBLE.cxx.

Member Function Documentation

AwaitWifiInfoReady()

bool ClariusBLE::AwaitWifiInfoReady

(

)

Synchronously wait for probe wifi information to be available. Useful for blocking execution while the probe is booting.

WARNING: This function can block for ~10 seconds, and should therefore be called on a thread.

Returns

true if info available, false if timeout

Definition at line 948 of file ClariusBLE.cxx.

CloseConnection()

PlusStatus ClariusBLE::CloseConnection

(

)

Close the BLE connection.

Definition at line 821 of file ClariusBLE.cxx.

ConfigureWifiAP()

PlusStatus ClariusBLE::ConfigureWifiAP

(

)

Configure the probe wifi to access-point mode, where the user will directly connect to the probe's wifi network (DIRECT-**SN** SSID).

Definition at line 1006 of file ClariusBLE.cxx.

ConfigureWifiLAN()

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

Configure the probe wifi to LAN mode, where the probe will connect to a local wifi network

Parameters

ssid
password

Definition at line 1044 of file ClariusBLE.cxx.

Connect()

PlusStatus ClariusBLE::Connect

(

)

Connect to probe found by FindBySerial

Definition at line 751 of file ClariusBLE.cxx.

Disconnect()

PlusStatus ClariusBLE::Disconnect

(

)

Disconnect from the currently connected probe BLE

Definition at line 850 of file ClariusBLE.cxx.

FindBySerial()

PlusStatus ClariusBLE::FindBySerial

(

std::string

serialNum

)

Search for probe BLE connection by serial number

Returns

PLUS_SUCCESS if probe BLE was found

Definition at line 710 of file ClariusBLE.cxx.

GetLastError()

std::string ClariusBLE::GetLastError

(

)

Get the last error message

Definition at line 1106 of file ClariusBLE.cxx.

GetWifiInfo()

std::pair< PlusStatus, ClariusWifiInfo > ClariusBLE::GetWifiInfo

(

)

Get the wifi information to connect to the probe over, this is only useful when the probe is configured in ACCESS_POINT mode

Returns

std::pair as C++ 11 compatible equivalent of std::optional first: status of function call second: if successful, probe wifi info

Definition at line 1094 of file ClariusBLE.cxx.

IsProbeConnected()

bool ClariusBLE::IsProbeConnected

(

)

Is there a currently connected probe?

Definition at line 745 of file ClariusBLE.cxx.

IsProbePowered()

bool ClariusBLE::IsProbePowered

(

)

Check if currently connected probe is powered

Definition at line 866 of file ClariusBLE.cxx.

ReadWifiInfo()

PlusStatus ClariusBLE::ReadWifiInfo

(

)

Read the current wifi state from the BLE characteristic.

Definition at line 989 of file ClariusBLE.cxx.

RequestProbeOff()

PlusStatus ClariusBLE::RequestProbeOff

(

)

Initiate the power off process for the currently connected probe

Definition at line 906 of file ClariusBLE.cxx.

RequestProbeOn()

PlusStatus ClariusBLE::RequestProbeOn

(

)

Initiate the power on process for the currently connected probe

Definition at line 872 of file ClariusBLE.cxx.

RetrieveFoundProbeIds()

std::vector< std::string > ClariusBLE::RetrieveFoundProbeIds

(

)

If FindBySerial returns false, this method can be used to retrieve a list of serial numbers for available Clarius probes

Returns

list of nearby probe serial numbers

Definition at line 739 of file ClariusBLE.cxx.

---

The documentation for this class was generated from the following files:

• src/PlusDataCollection/Clarius/ClariusBLE.h
• src/PlusDataCollection/Clarius/ClariusBLE.cxx