Instrument Neutral Distributed Interface INDI 2.2.5
Public Member Functions | List of all members
GeminiFlatpanelLiteAdapter Class Reference

Concrete adapter implementation for Gemini Flatpanel Lite firmware. More...

#include <gemini_flatpanel_adapters.h>

Inheritance diagram for GeminiFlatpanelLiteAdapter:
GeminiFlatpanelAdapter

Public Member Functions

 GeminiFlatpanelLiteAdapter ()
 
bool ping () override
 Ping the device to check if it responds to this adapter's protocol.
 
int getRevision () const override
 Get the firmware revision this adapter supports.
 
bool getFirmwareVersion (int *version) override
 Get the firmware version from the device.
 
bool supportsBeep () const override
 Check if device supports beep functionality.
 
bool supportsDustCap () const override
 Check if device supports dust cap functionality.
 
bool supportsBrightnessMode () const override
 Check if device supports brightness mode selection (high/low)
 
bool getConfigStatus (int *status) override
 Get the current configuration status.
 
bool getBrightness (int *brightness) override
 Get the current brightness level.
 
bool setBrightness (int value) override
 Set the brightness level.
 
bool lightOn () override
 Turn the light on.
 
bool lightOff () override
 Turn the light off.
 
bool openCover () override
 Open the dust cover.
 
bool closeCover () override
 Close the dust cover.
 
bool getStatus (int *coverStatus, int *lightStatus, int *motorStatus) override
 Get the current device status.
 
bool move (uint16_t value, int direction) override
 Move the cover by a specified amount.
 
bool setClosePosition () override
 Set the current position as the closed position.
 
bool setOpenPosition () override
 Set the current position as the open position.
 
bool setBeep (bool enable) override
 Enable or disable beep functionality.
 
bool setBrightnessMode (int mode) override
 Set the brightness mode (high/low)
 
char getCommandTerminator () const override
 Get the command terminator character for this revision.
 
void setupCommunication (int portFD) override
 Set up communication parameters for this revision.
 
- Public Member Functions inherited from GeminiFlatpanelAdapter
virtual ~GeminiFlatpanelAdapter ()=default
 

Detailed Description

Concrete adapter implementation for Gemini Flatpanel Lite firmware.

This adapter handles the specific protocol and commands for Lite devices:

Definition at line 451 of file gemini_flatpanel_adapters.h.

Constructor & Destructor Documentation

◆ GeminiFlatpanelLiteAdapter()

GeminiFlatpanelLiteAdapter::GeminiFlatpanelLiteAdapter ( )
inline

Definition at line 487 of file gemini_flatpanel_adapters.h.

Member Function Documentation

◆ closeCover()

bool GeminiFlatpanelLiteAdapter::closeCover ( )
overridevirtual

Close the dust cover.

Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 1033 of file gemini_flatpanel_adapters.cpp.

◆ getBrightness()

bool GeminiFlatpanelLiteAdapter::getBrightness ( int *  brightness)
overridevirtual

Get the current brightness level.

Parameters
brightnesspointer to store the brightness value (0-255)
Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 918 of file gemini_flatpanel_adapters.cpp.

◆ getCommandTerminator()

char GeminiFlatpanelLiteAdapter::getCommandTerminator ( ) const
inlineoverridevirtual

Get the command terminator character for this revision.

Returns
terminator character ('
' for rev1, '#' for rev2)

Implements GeminiFlatpanelAdapter.

Definition at line 542 of file gemini_flatpanel_adapters.h.

◆ getConfigStatus()

bool GeminiFlatpanelLiteAdapter::getConfigStatus ( int *  status)
overridevirtual

Get the current configuration status.

Parameters
statuspointer to store the configuration status
Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 910 of file gemini_flatpanel_adapters.cpp.

◆ getFirmwareVersion()

bool GeminiFlatpanelLiteAdapter::getFirmwareVersion ( int *  version)
overridevirtual

Get the firmware version from the device.

Parameters
versionpointer to store the firmware version
Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 869 of file gemini_flatpanel_adapters.cpp.

◆ getRevision()

int GeminiFlatpanelLiteAdapter::getRevision ( ) const
inlineoverridevirtual

Get the firmware revision this adapter supports.

Returns
revision number (1, 2, etc.)

Implements GeminiFlatpanelAdapter.

Definition at line 491 of file gemini_flatpanel_adapters.h.

◆ getStatus()

bool GeminiFlatpanelLiteAdapter::getStatus ( int *  coverStatus,
int *  lightStatus,
int *  motorStatus 
)
overridevirtual

Get the current device status.

Parameters
coverStatuspointer to store cover status
lightStatuspointer to store light status
motorStatuspointer to store motor status
Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 1039 of file gemini_flatpanel_adapters.cpp.

◆ lightOff()

bool GeminiFlatpanelLiteAdapter::lightOff ( )
overridevirtual

Turn the light off.

Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 1009 of file gemini_flatpanel_adapters.cpp.

◆ lightOn()

bool GeminiFlatpanelLiteAdapter::lightOn ( )
overridevirtual

Turn the light on.

Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 991 of file gemini_flatpanel_adapters.cpp.

◆ move()

bool GeminiFlatpanelLiteAdapter::move ( uint16_t  value,
int  direction 
)
inlineoverridevirtual

Move the cover by a specified amount.

Parameters
valuenumber of steps to move
directiondirection of movement (1 for open, -1 for close)
Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 522 of file gemini_flatpanel_adapters.h.

◆ openCover()

bool GeminiFlatpanelLiteAdapter::openCover ( )
overridevirtual

Open the dust cover.

Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 1027 of file gemini_flatpanel_adapters.cpp.

◆ ping()

bool GeminiFlatpanelLiteAdapter::ping ( )
overridevirtual

Ping the device to check if it responds to this adapter's protocol.

Returns
true if device responds correctly, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 850 of file gemini_flatpanel_adapters.cpp.

◆ setBeep()

bool GeminiFlatpanelLiteAdapter::setBeep ( bool  enable)
overridevirtual

Enable or disable beep functionality.

Parameters
enabletrue to enable beep, false to disable
Returns
true if successful, false if not supported or failed

Implements GeminiFlatpanelAdapter.

Definition at line 1079 of file gemini_flatpanel_adapters.cpp.

◆ setBrightness()

bool GeminiFlatpanelLiteAdapter::setBrightness ( int  value)
overridevirtual

Set the brightness level.

Parameters
valuebrightness value (0-255)
Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 947 of file gemini_flatpanel_adapters.cpp.

◆ setBrightnessMode()

bool GeminiFlatpanelLiteAdapter::setBrightnessMode ( int  mode)
overridevirtual

Set the brightness mode (high/low)

Parameters
modebrightness mode (GEMINI_BRIGHTNESS_MODE_LOW or GEMINI_BRIGHTNESS_MODE_HIGH)
Returns
true if successful, false if not supported or failed

Implements GeminiFlatpanelAdapter.

Definition at line 1091 of file gemini_flatpanel_adapters.cpp.

◆ setClosePosition()

bool GeminiFlatpanelLiteAdapter::setClosePosition ( )
inlineoverridevirtual

Set the current position as the closed position.

Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 528 of file gemini_flatpanel_adapters.h.

◆ setOpenPosition()

bool GeminiFlatpanelLiteAdapter::setOpenPosition ( )
inlineoverridevirtual

Set the current position as the open position.

Returns
true if successful, false otherwise

Implements GeminiFlatpanelAdapter.

Definition at line 532 of file gemini_flatpanel_adapters.h.

◆ setupCommunication()

void GeminiFlatpanelLiteAdapter::setupCommunication ( int  portFD)
inlineoverridevirtual

Set up communication parameters for this revision.

Parameters
portFDfile descriptor for the serial port

Implements GeminiFlatpanelAdapter.

Definition at line 546 of file gemini_flatpanel_adapters.h.

◆ supportsBeep()

bool GeminiFlatpanelLiteAdapter::supportsBeep ( ) const
inlineoverridevirtual

Check if device supports beep functionality.

Returns
true if beep is supported

Implements GeminiFlatpanelAdapter.

Definition at line 498 of file gemini_flatpanel_adapters.h.

◆ supportsBrightnessMode()

bool GeminiFlatpanelLiteAdapter::supportsBrightnessMode ( ) const
inlineoverridevirtual

Check if device supports brightness mode selection (high/low)

Returns
true if brightness modes are supported

Implements GeminiFlatpanelAdapter.

Definition at line 506 of file gemini_flatpanel_adapters.h.

◆ supportsDustCap()

bool GeminiFlatpanelLiteAdapter::supportsDustCap ( ) const
inlineoverridevirtual

Check if device supports dust cap functionality.

Returns
true if dust cap is supported

Implements GeminiFlatpanelAdapter.

Definition at line 502 of file gemini_flatpanel_adapters.h.


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