#include <flip_flat.h>

Inheritance diagram for FlipFlat:

Collaboration diagram for FlipFlat:

Public Member Functions
	FlipFlat ()

virtual	~FlipFlat ()=default

virtual bool	initProperties ()
	Initilize properties initial state and value. More...

virtual void	ISGetProperties (const char *dev)
	define the driver's properties to the client. More...

virtual bool	updateProperties ()
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. More...

virtual bool	ISNewText (const char dev, const char name, char texts[], char names[], int n)
	Process the client newSwitch command. More...

virtual bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process the client newSwitch command. More...

virtual bool	ISNewNumber (const char dev, const char name, double values[], char *names[], int n)
	Process the client newNumber command. More...

virtual bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. More...

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

virtual	~DefaultDevice ()

void	addAuxControls ()
	Add Debug, Simulation, and Configuration options to the driver. More...

void	addDebugControl ()
	Add Debug control to the driver. More...

void	addSimulationControl ()
	Add Simulation control to the driver. More...

void	addConfigurationControl ()
	Add Configuration control to the driver. More...

void	addPollPeriodControl ()
	Add Polling period control to the driver. More...

void	resetProperties ()
	Set all properties to IDLE state. More...

void	defineNumber (INumberVectorProperty *nvp)
	Define number vector to client & register it. More...

void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. More...

void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. More...

void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. More...

void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. More...

virtual bool	deleteProperty (const char *propertyName)
	Delete a property and unregister it. More...

virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client. More...

int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds. More...

void	RemoveTimer (int id)
	Remove timer added with SetTimer. More...

virtual const char *	getDriverExec ()

virtual const char *	getDriverName ()

void	setVersion (uint16_t vMajor, uint16_t vMinor)
	Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...

uint16_t	getMajorVersion ()

uint16_t	getMinorVersion ()

virtual bool	ISNewBLOB (const char dev, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n)
	Process the client newBLOB command. More...

virtual uint16_t	getDriverInterface ()

void	setDriverInterface (uint16_t value)
	setInterface Set driver interface. More...

	DefaultDevice ()

virtual	~DefaultDevice ()

void	addAuxControls ()
	Add Debug, Simulation, and Configuration options to the driver. More...

void	addDebugControl ()
	Add Debug control to the driver. More...

void	addSimulationControl ()
	Add Simulation control to the driver. More...

void	addConfigurationControl ()
	Add Configuration control to the driver. More...

void	addPollPeriodControl ()
	Add Polling period control to the driver. More...

void	resetProperties ()
	Set all properties to IDLE state. More...

void	defineNumber (INumberVectorProperty *nvp)
	Define number vector to client & register it. More...

void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. More...

void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. More...

void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. More...

void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. More...

virtual bool	deleteProperty (const char *propertyName)
	Delete a property and unregister it. More...

virtual void	setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
	Set connection switch status in the client. More...

int	SetTimer (uint32_t ms)
	Set a timer to call the function TimerHit after ms milliseconds. More...

void	RemoveTimer (int id)
	Remove timer added with SetTimer. More...

virtual const char *	getDriverExec ()

virtual const char *	getDriverName ()

void	setVersion (uint16_t vMajor, uint16_t vMinor)
	Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...

uint16_t	getMajorVersion ()

uint16_t	getMinorVersion ()

virtual bool	ISNewBLOB (const char dev, const char name, int sizes[], int blobsizes[], char blobs[], char formats[], char *names[], int n)
	Process the client newBLOB command. More...

virtual uint16_t	getDriverInterface ()

void	setDriverInterface (uint16_t value)
	setInterface Set driver interface. More...

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

virtual	~BaseDevice ()

INumberVectorProperty *	getNumber (const char *name)

ITextVectorProperty *	getText (const char *name)

ISwitchVectorProperty *	getSwitch (const char *name)

ILightVectorProperty *	getLight (const char *name)

IBLOBVectorProperty *	getBLOB (const char *name)

IPState	getPropertyState (const char *name)

IPerm	getPropertyPermission (const char *name)

void	registerProperty (void *p, INDI_PROPERTY_TYPE type)

int	removeProperty (const char name, char errmsg)
	Remove a property. More...

void *	getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
	Return a property and its type given its name. More...

INDI::Property *	getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
	Return a property and its type given its name. More...

std::vector< INDI::Property * > *	getProperties ()
	Return a list of all properties in the device. More...

bool	buildSkeleton (const char *filename)
	Build driver properties from a skeleton file. More...

bool	isConnected ()

void	setDeviceName (const char *dev)
	Set the device name. More...

const char *	getDeviceName ()

void	addMessage (const std::string &msg)
	Add message to the driver's message queue. More...

void	checkMessage (XMLEle *root)

void	doMessage (XMLEle *msg)

std::string	messageQueue (int index) const

std::string	lastMessage ()

void	setMediator (INDI::BaseMediator *med)
	Set the driver's mediator to receive notification of news devices and updated property values. More...

INDI::BaseMediator *	getMediator ()

const char *	getDriverName ()

const char *	getDriverExec ()

const char *	getDriverVersion ()

	BaseDevice ()

virtual	~BaseDevice ()

INumberVectorProperty *	getNumber (const char *name)

ITextVectorProperty *	getText (const char *name)

ISwitchVectorProperty *	getSwitch (const char *name)

ILightVectorProperty *	getLight (const char *name)

IBLOBVectorProperty *	getBLOB (const char *name)

IPState	getPropertyState (const char *name)

IPerm	getPropertyPermission (const char *name)

void	registerProperty (void *p, INDI_PROPERTY_TYPE type)

int	removeProperty (const char name, char errmsg)
	Remove a property. More...

void *	getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
	Return a property and its type given its name. More...

INDI::Property *	getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
	Return a property and its type given its name. More...

std::vector< INDI::Property * > *	getProperties ()
	Return a list of all properties in the device. More...

bool	buildSkeleton (const char *filename)
	Build driver properties from a skeleton file. More...

bool	isConnected ()

void	setDeviceName (const char *dev)
	Set the device name. More...

const char *	getDeviceName ()

void	addMessage (const std::string &msg)
	Add message to the driver's message queue. More...

void	checkMessage (XMLEle *root)

void	doMessage (XMLEle *msg)

std::string	messageQueue (int index) const

std::string	lastMessage ()

void	setMediator (INDI::BaseMediator *med)
	Set the driver's mediator to receive notification of news devices and updated property values. More...

INDI::BaseMediator *	getMediator ()

const char *	getDriverName ()

const char *	getDriverExec ()

const char *	getDriverVersion ()

Protected Member Functions
const char *	getDefaultName ()

virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Save specific properties in the provide config file handler. More...

void	TimerHit ()
	Callback function to be called once SetTimer duration elapses. More...

virtual IPState	ParkCap ()
	Park dust cap (close cover). More...

virtual IPState	UnParkCap ()
	unPark dust cap (open cover). More...

virtual bool	SetLightBoxBrightness (uint16_t value)
	setBrightness Set light level. More...

virtual bool	EnableLightBox (bool enable)
	EnableLightBox Turn on/off on a light box. More...

Protected Member Functions inherited from INDI::DefaultDevice
void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. More...

virtual bool	loadConfig (bool silent=false, const char *property=nullptr)
	Load the last saved configuration file. More...

virtual bool	saveConfig (bool silent=false, const char *property=nullptr)
	Save the current properties in a configuration file. More...

virtual bool	saveAllConfigItems (FILE *fp)
	saveAllConfigItems Save all the drivers' properties in the configuration file More...

virtual bool	loadDefaultConfig ()
	Load the default configuration file. More...

void	setDebug (bool enable)
	Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...

void	setSimulation (bool enable)
	Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...

virtual void	debugTriggered (bool enable)
	Inform driver that the debug option was triggered. More...

virtual void	simulationTriggered (bool enable)
	Inform driver that the simulation option was triggered. More...

bool	isDebug ()

bool	isSimulation ()

virtual bool	Connect ()
	Connect to the device. More...

virtual bool	Disconnect ()
	Disconnect from device. More...

void	registerConnection (Connection::Interface *newConnection)
	registerConnection Add new connection plugin to the existing connection pool. More...

bool	unRegisterConnection (Connection::Interface *existingConnection)
	unRegisterConnection Remove connection from existing pool More...

Connection::Interface *	getActiveConnection ()

void	setDefaultPollingPeriod (uint32_t period)

uint32_t	getPollingPeriod ()

void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. More...

virtual bool	loadConfig (bool silent=false, const char *property=nullptr)
	Load the last saved configuration file. More...

virtual bool	saveConfig (bool silent=false, const char *property=nullptr)
	Save the current properties in a configuration file. More...

virtual bool	saveAllConfigItems (FILE *fp)
	saveAllConfigItems Save all the drivers' properties in the configuration file More...

virtual bool	loadDefaultConfig ()
	Load the default configuration file. More...

void	setDebug (bool enable)
	Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...

void	setSimulation (bool enable)
	Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...

virtual void	debugTriggered (bool enable)
	Inform driver that the debug option was triggered. More...

virtual void	simulationTriggered (bool enable)
	Inform driver that the simulation option was triggered. More...

bool	isDebug ()

bool	isSimulation ()

virtual bool	Connect ()
	Connect to the device. More...

virtual bool	Disconnect ()
	Disconnect from device. More...

void	registerConnection (Connection::Interface *newConnection)
	registerConnection Add new connection plugin to the existing connection pool. More...

bool	unRegisterConnection (Connection::Interface *existingConnection)
	unRegisterConnection Remove connection from existing pool More...

Connection::Interface *	getActiveConnection ()

void	setDefaultPollingPeriod (uint32_t period)

uint32_t	getPollingPeriod ()

Protected Member Functions inherited from INDI::BaseDevice
int	buildProp (XMLEle root, char errmsg)
	Build a property given the supplied XML element (defXXX) More...

int	setValue (XMLEle root, char errmsg)
	handle SetXXX commands from client More...

int	setBLOB (IBLOBVectorProperty pp, XMLEle root, char *errmsg)
	Parse and store BLOB in the respective vector. More...

int	buildProp (XMLEle root, char errmsg)
	Build a property given the supplied XML element (defXXX) More...

int	setValue (XMLEle root, char errmsg)
	handle SetXXX commands from client More...

int	setBLOB (IBLOBVectorProperty pp, XMLEle root, char *errmsg)
	Parse and store BLOB in the respective vector. More...

Protected Member Functions inherited from INDI::LightBoxInterface
	LightBoxInterface (DefaultDevice *device, bool isDimmable)

virtual	~LightBoxInterface ()

void	initLightBoxProperties (const char deviceName, const char groupNam)
	Initilize light box properties. More...

void	isGetLightBoxProperties (const char *deviceName)
	isGetLightBoxProperties Get light box properties More...

bool	processLightBoxSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process light box switch properties. More...

bool	processLightBoxNumber (const char dev, const char name, double values[], char *names[], int n)
	Process light box number properties. More...

bool	processLightBoxText (const char dev, const char name, char texts[], char names[], int n)
	Process light box text properties. More...

bool	updateLightBoxProperties ()

bool	saveLightBoxConfigItems (FILE *fp)

bool	snoopLightBox (XMLEle *root)

	LightBoxInterface (DefaultDevice *device, bool isDimmable)

virtual	~LightBoxInterface ()

void	initLightBoxProperties (const char deviceName, const char groupNam)
	Initilize light box properties. More...

void	isGetLightBoxProperties (const char *deviceName)
	isGetLightBoxProperties Get light box properties More...

bool	processLightBoxSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process light box switch properties. More...

bool	processLightBoxNumber (const char dev, const char name, double values[], char *names[], int n)
	Process light box number properties. More...

bool	processLightBoxText (const char dev, const char name, char texts[], char names[], int n)
	Process light box text properties. More...

bool	updateLightBoxProperties ()

bool	saveLightBoxConfigItems (FILE *fp)

bool	snoopLightBox (XMLEle *root)

Protected Member Functions inherited from INDI::DustCapInterface
	DustCapInterface ()=default

virtual	~DustCapInterface ()=default

void	initDustCapProperties (const char deviceName, const char groupName)
	Initilize dust cap properties. More...

bool	processDustCapSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process dust cap switch properties. More...

	DustCapInterface ()=default

virtual	~DustCapInterface ()=default

void	initDustCapProperties (const char deviceName, const char groupName)
	Initilize dust cap properties. More...

bool	processDustCapSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process dust cap switch properties. More...

Private Member Functions
bool	getStartupData ()

bool	ping ()

bool	getStatus ()

bool	getFirmwareVersion ()

bool	getBrightness ()

bool	Handshake ()

Private Attributes
ITextVectorProperty	StatusTP

IText	StatusT [3] {}

ITextVectorProperty	FirmwareTP

IText	FirmwareT [1] {}

int	PortFD { -1 }

int	productID { 0 }

bool	isFlipFlat { false }

uint8_t	simulationWorkCounter { 0 }

uint8_t	prevCoverStatus { 0xFF }

uint8_t	prevLightStatus { 0xFF }

uint8_t	prevMotorStatus { 0xFF }

uint8_t	prevBrightness { 0xFF }

Connection::Serial *	serialConnection { nullptr }

Additional Inherited Members
Public Types inherited from INDI::BaseDevice
enum	INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4, INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }

enum	DRIVER_INTERFACE { GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15), GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15) }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...

enum	INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4, INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4 }

enum	DRIVER_INTERFACE { GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15), GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2), FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6), WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10), DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15) }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...

Public Types inherited from INDI::LightBoxInterface
enum	{ FLAT_LIGHT_ON, FLAT_LIGHT_OFF }

enum	{ FLAT_LIGHT_ON, FLAT_LIGHT_OFF }

Public Types inherited from INDI::DustCapInterface
enum	{ CAP_PARK, CAP_UNPARK }

enum	{ CAP_PARK, CAP_UNPARK }

Protected Attributes inherited from INDI::DefaultDevice
uint32_t	POLLMS = 1000
	Period in milliseconds to call TimerHit(). Default 1000 ms. More...

Protected Attributes inherited from INDI::LightBoxInterface
ISwitchVectorProperty	LightSP

ISwitch	LightS [2]

INumberVectorProperty	LightIntensityNP

INumber	LightIntensityN [1]

ITextVectorProperty	ActiveDeviceTP

IText	ActiveDeviceT [1] {}

INumberVectorProperty	FilterIntensityNP

INumber *	FilterIntensityN

Protected Attributes inherited from INDI::DustCapInterface
ISwitchVectorProperty	ParkCapSP

ISwitch	ParkCapS [2]

Constructor & Destructor Documentation

◆ FlipFlat()

FlipFlat::FlipFlat ( )

◆ ~FlipFlat()

virtual FlipFlat::~FlipFlat ( )

virtualdefault

Member Function Documentation

◆ EnableLightBox()

bool FlipFlat::EnableLightBox ( bool enable )

protectedvirtual

EnableLightBox Turn on/off on a light box.

Must be impelemented in the child class.

Parameters

enable If true, turn on the light, otherwise turn off the light.

Returns: True if successful, false otherwise.

Reimplemented from INDI::LightBoxInterface.

◆ getBrightness()

bool FlipFlat::getBrightness ( )

private

◆ getDefaultName()

const char * FlipFlat::getDefaultName ( )

protectedvirtual

Returns: Default name of the device.

Implements INDI::DefaultDevice.

◆ getFirmwareVersion()

bool FlipFlat::getFirmwareVersion ( )

private

◆ getStartupData()

bool FlipFlat::getStartupData ( )

private

◆ getStatus()

bool FlipFlat::getStatus ( )

private

◆ Handshake()

bool FlipFlat::Handshake ( )

private

◆ initProperties()

bool FlipFlat::initProperties ( )

virtual

Initilize properties initial state and value.

The child class must implement this function.

Returns: True if initilization is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ ISGetProperties()

void FlipFlat::ISGetProperties ( const char * dev )

virtual

define the driver's properties to the client.

Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device.

Parameters

dev	name of the device

Note: This function is called by the INDI framework, do not call it directly. See LX200 Generic driver for an example implementation

Reimplemented from INDI::DefaultDevice.

◆ ISNewNumber()

bool FlipFlat::ISNewNumber	(	const char *	dev,
		const char *	name,
		double	values[],
		char *	names[],
		int	n
	)

virtual

Process the client newNumber command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ ISNewSwitch()

bool FlipFlat::ISNewSwitch	(	const char *	dev,
		const char *	name,
		ISState *	states,
		char *	names[],
		int	n
	)

virtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ ISNewText()

bool FlipFlat::ISNewText	(	const char *	dev,
		const char *	name,
		char *	texts[],
		char *	names[],
		int	n
	)

virtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ ISSnoopDevice()

bool FlipFlat::ISSnoopDevice ( XMLEle * root )

virtual

Process a snoop event from INDI server.

This function is called when a snooped property is updated in a snooped driver.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ ParkCap()

IPState FlipFlat::ParkCap ( )

protectedvirtual

Park dust cap (close cover).

Must be implemented by child.

Returns: If command completed immediatly, return IPS_OK. If command is in progress, return IPS_BUSY. If there is an error, return IPS_ALERT

Reimplemented from INDI::DustCapInterface.

◆ ping()

bool FlipFlat::ping ( )

private

◆ saveConfigItems()

bool FlipFlat::saveConfigItems ( FILE * fp )

protectedvirtual

saveConfigItems Save specific properties in the provide config file handler.

Child class usually override this function to save their own properties and the base class saveConfigItems(fp) must be explicitly called by each child class. The Default Device saveConfigItems(fp) only save Debug properties options in the config file.

Parameters

fp	Pointer to config file handler

Returns: True if successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

◆ SetLightBoxBrightness()

bool FlipFlat::SetLightBoxBrightness ( uint16_t value )

protectedvirtual

setBrightness Set light level.

Must be impelemented in the child class, if supported.

Parameters

value level of light box

Returns: True if successful, false otherwise.

Reimplemented from INDI::LightBoxInterface.

◆ TimerHit()

void FlipFlat::TimerHit ( )

protectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

◆ UnParkCap()

IPState FlipFlat::UnParkCap ( )

protectedvirtual

unPark dust cap (open cover).

Must be implemented by child.

Returns: If command completed immediatly, return IPS_OK. If command is in progress, return IPS_BUSY. If there is an error, return IPS_ALERT

Reimplemented from INDI::DustCapInterface.

◆ updateProperties()

bool FlipFlat::updateProperties ( )

virtual

updateProperties is called whenever there is a change in the CONNECTION status of the driver.

This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.

Returns: True if update is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Member Data Documentation

◆ FirmwareT

IText FlipFlat::FirmwareT[1] {}

private

◆ FirmwareTP

ITextVectorProperty FlipFlat::FirmwareTP

private

◆ isFlipFlat

bool FlipFlat::isFlipFlat { false }

private

◆ PortFD

int FlipFlat::PortFD { -1 }

private

◆ prevBrightness

uint8_t FlipFlat::prevBrightness { 0xFF }

private

◆ prevCoverStatus

uint8_t FlipFlat::prevCoverStatus { 0xFF }

private

◆ prevLightStatus

uint8_t FlipFlat::prevLightStatus { 0xFF }

private

◆ prevMotorStatus

uint8_t FlipFlat::prevMotorStatus { 0xFF }

private

◆ productID

int FlipFlat::productID { 0 }

private

◆ serialConnection

Connection::Serial* FlipFlat::serialConnection { nullptr }

private

◆ simulationWorkCounter

uint8_t FlipFlat::simulationWorkCounter { 0 }

private

◆ StatusT

IText FlipFlat::StatusT[3] {}

private

◆ StatusTP

ITextVectorProperty FlipFlat::StatusTP

private

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

ln/3rdparty/src/indilib/indi-1.7.4/libindi/drivers/auxiliary/flip_flat.h
ln/3rdparty/src/indilib/indi-1.7.4/libindi/drivers/auxiliary/flip_flat.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ FlipFlat()

◆ ~FlipFlat()

Member Function Documentation

◆ EnableLightBox()

◆ getBrightness()

◆ getDefaultName()

◆ getFirmwareVersion()

◆ getStartupData()

◆ getStatus()

◆ Handshake()

◆ initProperties()

◆ ISGetProperties()

◆ ISNewNumber()

◆ ISNewSwitch()

◆ ISNewText()

◆ ISSnoopDevice()

◆ ParkCap()

◆ ping()

◆ saveConfigItems()

◆ SetLightBoxBrightness()

◆ TimerHit()

◆ UnParkCap()

◆ updateProperties()

Member Data Documentation

◆ FirmwareT

◆ FirmwareTP

◆ isFlipFlat

◆ PortFD

◆ prevBrightness

◆ prevCoverStatus

◆ prevLightStatus

◆ prevMotorStatus

◆ productID

◆ serialConnection

◆ simulationWorkCounter

◆ StatusT

◆ StatusTP