#include <alpaca_client.h>

Inheritance diagram for AlpacaClient:

Public Member Functions
	AlpacaClient (DeviceManager *deviceManager)

	~AlpacaClient ()

bool	connectServer () override
	Connect to INDI server.

bool	disconnectServer (int exist_code=0) override
	Disconnect from INDI server. Any devices previously created will be deleted and memory cleared.

Public Member Functions inherited from INDI::BaseClient
	BaseClient ()

virtual	~BaseClient ()

bool	connectServer () override
	Connect to INDI server.

bool	disconnectServer (int exit_code=0) override
	Disconnect from INDI server. Any devices previously created will be deleted and memory cleared.

void	enableDirectBlobAccess (const char dev=nullptr, const char prop=nullptr)
	activate zero-copy delivering of the blob content. When enabled, all blob copy will be avoided when possible (depending on the connection). This changes how the IBLOB.data field :

Public Member Functions inherited from INDI::AbstractBaseClient
	AbstractBaseClient ()=delete

virtual	~AbstractBaseClient ()

void	setServer (const char *hostname, unsigned int port)
	Set the server host name and port.

const char *	getHost () const
	Get the server host name.

int	getPort () const
	Get the port number.

bool	isServerConnected () const
	Get status of the connection.

void	setConnectionTimeout (uint32_t seconds, uint32_t microseconds)
	setConnectionTimeout Set connection timeout. By default it is 3 seconds.

void	setVerbose (bool enable)
	setVerbose Set verbose mode

bool	isVerbose () const
	isVerbose Is client in verbose mode?

void	watchDevice (const char *deviceName)
	Add a device to the watch list.

void	watchDevice (const char *deviceName, const std::function< void(BaseDevice)> &callback)

void	watchProperty (const char deviceName, const char propertyName)
	watchProperties Add a property to the watch list. When communicating with INDI server.

void	connectDevice (const char *deviceName)
	Disconnect INDI driver.

void	disconnectDevice (const char *deviceName)
	Disconnect INDI driver.

INDI::BaseDevice	getDevice (const char *deviceName)

std::vector< INDI::BaseDevice >	getDevices () const

bool	getDevices (std::vector< INDI::BaseDevice > &deviceList, uint16_t driverInterface)
	getDevices Returns list of devices that belong to a particular DRIVER_INTERFACE class.

void	setBLOBMode (BLOBHandling blobH, const char dev, const char prop=nullptr)
	Set Binary Large Object policy mode.

BLOBHandling	getBLOBMode (const char dev, const char prop=nullptr)
	getBLOBMode Get Binary Large Object policy mode IF set previously by setBLOBMode

void	sendNewProperty (INDI::Property pp)
	Send new Property command to server.

void	sendNewText (INDI::Property pp)
	Send new Text command to server.

void	sendNewText (const char deviceName, const char propertyName, const char elementName, const char text)
	Send new Text command to server.

void	sendNewNumber (INDI::Property pp)
	Send new Number command to server.

void	sendNewNumber (const char deviceName, const char propertyName, const char *elementName, double value)
	Send new Number command to server.

void	sendNewSwitch (INDI::Property pp)
	Send new Switch command to server.

void	sendNewSwitch (const char deviceName, const char propertyName, const char *elementName)
	Send new Switch command to server.

void	startBlob (const char devName, const char propName, const char *timestamp)
	Send opening tag for BLOB command to server.

void	sendOneBlob (IBLOB *bp)
	Send ONE blob content to server. The BLOB data in raw binary format and will be converted to base64 and sent to server.

void	sendOneBlob (INDI::WidgetViewBlob *blob)

void	sendOneBlob (const char blobName, unsigned int blobSize, const char blobFormat, void *blobBuffer)
	Send ONE blob content to server. The BLOB data in raw binary format and will be converted to base64 and sent to server.

void	finishBlob ()
	Send closing tag for BLOB command to server.

void	sendPingRequest (const char *uid)
	Send one ping request, the server will answer back with the same uuid.

void	sendPingReply (const char *uid)
	Send a ping reply for the given uuid.

Public Member Functions inherited from INDI::BaseMediator
virtual	~BaseMediator ()=default

virtual void	newMessage (INDI::BaseDevice baseDevice, int messageID)
	Emmited when a new message arrives from INDI server.

virtual void	newDevice (INDI::BaseDevice *dp)
	Emmited when a new device is created from INDI server.

virtual void	removeDevice (INDI::BaseDevice *dp)
	Emmited when a device is deleted from INDI server.

virtual void	newProperty (INDI::Property *property)
	Emmited when a new property is created for an INDI driver.

virtual void	removeProperty (INDI::Property *property)
	Emmited when a property is deleted for an INDI driver.

virtual void	newSwitch (ISwitchVectorProperty *svp)
	Emmited when a new switch value arrives from INDI server.

virtual void	newNumber (INumberVectorProperty *nvp)
	Emmited when a new number value arrives from INDI server.

virtual void	newText (ITextVectorProperty *tvp)
	Emmited when a new text value arrives from INDI server.

virtual void	newLight (ILightVectorProperty *lvp)
	Emmited when a new light value arrives from INDI server.

virtual void	newBLOB (IBLOB *bp)
	Emmited when a new property value arrives from INDI server.

virtual void	newMessage (INDI::BaseDevice *dp, int messageID)
	Emmited when a new message arrives from INDI server.

Protected Member Functions
void	newDevice (INDI::BaseDevice dp) override
	Emmited when a new device is created from INDI server.

void	removeDevice (INDI::BaseDevice dp) override
	Emmited when a device is deleted from INDI server.

void	newProperty (INDI::Property property) override
	Emmited when a new property is created for an INDI driver.

void	removeProperty (INDI::Property property) override
	Emmited when a property is deleted for an INDI driver.

void	updateProperty (INDI::Property property) override
	Emmited when a new property value arrives from INDI server.

void	serverConnected () override
	Emmited when the server is connected.

void	serverDisconnected (int exitCode) override
	Emmited when the server gets disconnected.

Protected Member Functions inherited from INDI::AbstractBaseClient
virtual void	newPingReply (std::string uid)
	pingReply are sent by the server on response to pingReply (see above).

virtual void	newUniversalMessage (std::string message)
	newUniversalMessage Universal messages are sent from INDI server without a specific device. It is addressed to the client overall.

	AbstractBaseClient (std::unique_ptr< AbstractBaseClientPrivate > &&dd)

Additional Inherited Members
Protected Attributes inherited from INDI::AbstractBaseClient
std::unique_ptr< AbstractBaseClientPrivate >	d_ptr_indi

Detailed Description

Definition at line 33 of file alpaca_client.h.

Constructor & Destructor Documentation

◆ AlpacaClient()

AlpacaClient::AlpacaClient ( DeviceManager * deviceManager )

Definition at line 29 of file alpaca_client.cpp.

◆ ~AlpacaClient()

AlpacaClient::~AlpacaClient ( )

Definition at line 35 of file alpaca_client.cpp.

Member Function Documentation

◆ connectServer()

bool AlpacaClient::connectServer ( )

overridevirtual

Connect to INDI server.

Returns: True if the connection is successful, false otherwise.

Note: This function blocks until connection is either successfull or unsuccessful.

Implements INDI::AbstractBaseClient.

Definition at line 40 of file alpaca_client.cpp.

◆ disconnectServer()

bool AlpacaClient::disconnectServer ( int exit_code = 0 )

overridevirtual

Disconnect from INDI server. Any devices previously created will be deleted and memory cleared.

Returns: True if disconnection is successful, false otherwise.

Implements INDI::AbstractBaseClient.

Definition at line 46 of file alpaca_client.cpp.

◆ newDevice()

void AlpacaClient::newDevice ( INDI::BaseDevice baseDevice )

overrideprotectedvirtual

Emmited when a new device is created from INDI server.

Parameters

baseDevice BaseDevice instance.

Reimplemented from INDI::BaseMediator.

Definition at line 52 of file alpaca_client.cpp.

◆ newProperty()

void AlpacaClient::newProperty ( INDI::Property property )

overrideprotectedvirtual

Emmited when a new property is created for an INDI driver.

Parameters

property Property container.

Reimplemented from INDI::BaseMediator.

Definition at line 71 of file alpaca_client.cpp.

◆ removeDevice()

void AlpacaClient::removeDevice ( INDI::BaseDevice baseDevice )

overrideprotectedvirtual

Emmited when a device is deleted from INDI server.

Parameters

baseDevice BaseDevice instance.

Reimplemented from INDI::BaseMediator.

Definition at line 65 of file alpaca_client.cpp.

◆ removeProperty()

void AlpacaClient::removeProperty ( INDI::Property property )

overrideprotectedvirtual

Emmited when a property is deleted for an INDI driver.

Parameters

property Property container.

Reimplemented from INDI::BaseMediator.

Definition at line 78 of file alpaca_client.cpp.

◆ serverConnected()

void AlpacaClient::serverConnected ( )

overrideprotectedvirtual

Emmited when the server is connected.

Reimplemented from INDI::BaseMediator.

Definition at line 91 of file alpaca_client.cpp.

◆ serverDisconnected()

void AlpacaClient::serverDisconnected ( int exit_code )

overrideprotectedvirtual

Emmited when the server gets disconnected.

Parameters

exit_code 0 if client was requested to disconnect from server. -1 if connection to server is terminated due to remote server disconnection.

Reimplemented from INDI::BaseMediator.

Definition at line 96 of file alpaca_client.cpp.

◆ updateProperty()

void AlpacaClient::updateProperty ( INDI::Property property )

overrideprotectedvirtual

Emmited when a new property value arrives from INDI server.

Parameters

property Property container.

Reimplemented from INDI::BaseMediator.

Definition at line 84 of file alpaca_client.cpp.

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AlpacaClient()

◆ ~AlpacaClient()

Member Function Documentation

◆ connectServer()

◆ disconnectServer()

◆ newDevice()

◆ newProperty()

◆ removeDevice()

◆ removeProperty()

◆ serverConnected()

◆ serverDisconnected()

◆ updateProperty()