#include <nightcrawler.h>

Inheritance diagram for NightCrawler:

Collaboration diagram for NightCrawler:

Public Types
enum	MotorType { MOTOR_FOCUS, MOTOR_ROTATOR, MOTOR_AUX }

Public Types inherited from INDI::Focuser
enum	{ CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }

enum	{ CONNECTION_NONE = 1 << 0, CONNECTION_SERIAL = 1 << 1, CONNECTION_TCP = 1 << 2 }

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::FocuserInterface
enum	FocusDirection { FOCUS_INWARD, FOCUS_OUTWARD, FOCUS_INWARD, FOCUS_OUTWARD }

enum	{ FOCUSER_CAN_ABS_MOVE = 1 << 0, FOCUSER_CAN_REL_MOVE = 1 << 1, FOCUSER_CAN_ABORT = 1 << 2, FOCUSER_HAS_VARIABLE_SPEED = 1 << 3 }

enum	FocusDirection { FOCUS_INWARD, FOCUS_OUTWARD, FOCUS_INWARD, FOCUS_OUTWARD }

enum	{ FOCUSER_CAN_ABS_MOVE = 1 << 0, FOCUSER_CAN_REL_MOVE = 1 << 1, FOCUSER_CAN_ABORT = 1 << 2, FOCUSER_HAS_VARIABLE_SPEED = 1 << 3 }

Public Types inherited from INDI::RotatorInterface
enum	{ ROTATOR_CAN_ABORT = 1 << 0, ROTATOR_CAN_HOME = 1 << 1, ROTATOR_CAN_SYNC = 1 << 2, ROTATOR_CAN_REVERSE = 1 << 3 }

enum	{ ROTATOR_CAN_ABORT = 1 << 0, ROTATOR_CAN_HOME = 1 << 1, ROTATOR_CAN_SYNC = 1 << 2, ROTATOR_CAN_REVERSE = 1 << 3 }

Public Member Functions
	NightCrawler ()

virtual	~NightCrawler ()=default

virtual bool	Handshake ()
	perform handshake with device to check communication More...

const char *	getDefaultName ()

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

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

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

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

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

virtual	~Focuser ()

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

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

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

void	setSupportedConnections (const uint8_t &value)
	setConnection Set Focuser connection mode. More...

uint8_t	getSupportedConnections () const

	Focuser ()

virtual	~Focuser ()

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

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

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

void	setSupportedConnections (const uint8_t &value)
	setConnection Set Focuser connection mode. More...

uint8_t	getSupportedConnections () const

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 ()

Public Member Functions inherited from INDI::FocuserInterface
uint32_t	GetCapability () const
	GetFocuserCapability returns the capability of the focuser. More...

void	SetCapability (uint32_t cap)
	FI::SetCapability sets the focuser capabilities. More...

bool	CanAbsMove ()

bool	CanRelMove ()

bool	CanAbort ()

bool	HasVariableSpeed ()

uint32_t	GetCapability () const
	GetFocuserCapability returns the capability of the focuser. More...

void	SetCapability (uint32_t cap)
	FI::SetCapability sets the focuser capabilities. More...

bool	CanAbsMove ()

bool	CanRelMove ()

bool	CanAbort ()

bool	HasVariableSpeed ()

Public Member Functions inherited from INDI::RotatorInterface
uint32_t	GetCapability () const
	GetRotatorCapability returns the capability of the Rotator. More...

void	SetCapability (uint32_t cap)
	SetRotatorCapability sets the Rotator capabilities. More...

bool	CanAbort ()

bool	CanHome ()

bool	CanSync ()

bool	CanReverse ()

uint32_t	GetCapability () const
	GetRotatorCapability returns the capability of the Rotator. More...

void	SetCapability (uint32_t cap)
	SetRotatorCapability sets the Rotator capabilities. More...

bool	CanAbort ()

bool	CanHome ()

bool	CanSync ()

bool	CanReverse ()

Protected Member Functions
virtual IPState	MoveAbsFocuser (uint32_t targetTicks)
	MoveFocuser the focuser to an absolute position. More...

virtual IPState	MoveRelFocuser (FocusDirection dir, uint32_t ticks)
	MoveFocuser the focuser to an relative position. More...

virtual bool	AbortFocuser ()
	AbortFocuser all focus motion. More...

virtual IPState	HomeRotator ()
	HomeRotator Go to home position. More...

virtual IPState	MoveRotator (double angle)
	MoveRotator Go to specific angle. More...

virtual bool	SyncRotator (double angle)
	SyncRotator Set current angle as the supplied angle without moving the rotator. More...

virtual bool	AbortRotator ()
	AbortRotator Abort all motion. More...

virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Saves the Device Port and Focuser Presets in the configuration file More...

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

Protected Member Functions inherited from INDI::Focuser
void	processButton (const char *button_n, ISState state)

void	processButton (const char *button_n, ISState state)

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::FocuserInterface
	FocuserInterface (DefaultDevice *defaultDevice)

virtual	~FocuserInterface ()=default

void	initProperties (const char *groupName)
	Initilize focuser properties. More...

bool	updateProperties ()
	updateProperties Define or Delete Rotator properties based on the connection status of the base device More...

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

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

virtual bool	SetFocuserSpeed (int speed)
	SetFocuserSpeed Set Focuser speed. More...

virtual IPState	MoveFocuser (FocusDirection dir, int speed, uint16_t duration)
	MoveFocuser the focuser in a particular direction with a specific speed for a finite duration. More...

	FocuserInterface (DefaultDevice *defaultDevice)

virtual	~FocuserInterface ()=default

void	initProperties (const char *groupName)
	Initilize focuser properties. More...

bool	updateProperties ()
	updateProperties Define or Delete Rotator properties based on the connection status of the base device More...

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

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

virtual bool	SetFocuserSpeed (int speed)
	SetFocuserSpeed Set Focuser speed. More...

virtual IPState	MoveFocuser (FocusDirection dir, int speed, uint16_t duration)
	MoveFocuser the focuser in a particular direction with a specific speed for a finite duration. More...

Protected Member Functions inherited from INDI::RotatorInterface
	RotatorInterface (DefaultDevice *defaultDevice)

void	initProperties (const char *groupName)
	Initilize Rotator properties. More...

bool	updateProperties ()
	updateProperties Define or Delete Rotator properties based on the connection status of the base device More...

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

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

virtual bool	ReverseRotator (bool enabled)
	ReverseRotator Reverse the direction of the rotator. More...

	RotatorInterface (DefaultDevice *defaultDevice)

void	initProperties (const char *groupName)
	Initilize Rotator properties. More...

bool	updateProperties ()
	updateProperties Define or Delete Rotator properties based on the connection status of the base device More...

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

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

virtual bool	ReverseRotator (bool enabled)
	ReverseRotator Reverse the direction of the rotator. More...

Private Types
enum	{ SENSOR_TEMPERATURE, SENSOR_VOLTAGE }

enum	{ ROTATION_SWITCH, OUT_SWITCH, IN_SWITCH }

enum	{ BRIGHTNESS_DISPLAY, BRIGHTNESS_SLEEP }

Private Member Functions
bool	getFirmware ()

bool	getFocuserType ()

bool	Ack ()

bool	gotoMotor (MotorType type, int32_t position)

bool	getPosition (MotorType type)

bool	syncMotor (MotorType type, uint32_t position)

bool	startMotor (MotorType type)

bool	stopMotor (MotorType type)

bool	isMotorMoving (MotorType type)

bool	getTemperature ()

bool	getVoltage ()

bool	setTemperatureOffset (double offset)

bool	getStepDelay (MotorType type)

bool	setStepDelay (MotorType type, uint32_t delay)

bool	getLimitSwitchStatus ()

bool	findHome (uint8_t motorTypes)

bool	isHomingComplete ()

bool	setEncodersEnabled (bool enable)

bool	setDisplayBrightness (uint8_t value)

bool	setSleepBrightness (uint8_t value)

Private Attributes
INumber	GotoAuxN [1]

INumberVectorProperty	GotoAuxNP

INumber	SyncFocusN [1]

INumberVectorProperty	SyncFocusNP

INumber	SyncAuxN [1]

INumberVectorProperty	SyncAuxNP

ISwitch	AbortAuxS [1]

ISwitchVectorProperty	AbortAuxSP

INumber	SensorN [2]

INumberVectorProperty	SensorNP

INumber	TemperatureOffsetN [1]

INumberVectorProperty	TemperatureOffsetNP

INumber	FocusStepDelayN [1]

INumberVectorProperty	FocusStepDelayNP

INumber	RotatorStepDelayN [1]

INumberVectorProperty	RotatorStepDelayNP

INumber	AuxStepDelayN [1]

INumberVectorProperty	AuxStepDelayNP

ILight	LimitSwitchL [3]

ILightVectorProperty	LimitSwitchLP

ISwitch	HomeSelectionS [3]

ISwitchVectorProperty	HomeSelectionSP

ISwitch	FindHomeS [1]

ISwitchVectorProperty	FindHomeSP

ISwitch	EncoderS [2]

ISwitchVectorProperty	EncoderSP

INumber	BrightnessN [2]

INumberVectorProperty	BrightnessNP

INumber	RotatorAbsPosN [1]

INumberVectorProperty	RotatorAbsPosNP

double	lastTemperature { 0 }

double	lastVoltage { 0 }

double	ticksPerDegree { 0 }

uint32_t	lastFocuserPosition { 0 }

uint32_t	lastRotatorPosition { 0 }

uint32_t	lastAuxPosition { 0 }

uint32_t	targetPosition { 0 }

IPState	rotationLimit { IPS_IDLE }

IPState	outSwitchLimit { IPS_IDLE }

IPState	inSwitchLimit { IPS_IDLE }

Additional Inherited Members
Static Public Member Functions inherited from INDI::Focuser
static void	buttonHelper (const char button_n, ISState state, void context)

static void	buttonHelper (const char button_n, ISState state, void context)

Public Attributes inherited from INDI::Focuser
enum INDI::Focuser:: { ... }	FocuserConnection

enum INDI::Focuser:: { ... }	FocuserConnection

Public Attributes inherited from INDI::FocuserInterface
enum INDI::FocuserInterface:: { ... }	FocuserCapability

enum INDI::FocuserInterface:: { ... }	FocuserCapability

Public Attributes inherited from INDI::RotatorInterface
enum INDI::RotatorInterface:: { ... }	RotatorCapability

enum INDI::RotatorInterface:: { ... }	RotatorCapability

Protected Types inherited from INDI::RotatorInterface
enum	{ REVERSE_ENABLED, REVERSE_DISABLED }

enum	{ REVERSE_ENABLED, REVERSE_DISABLED }

Protected Attributes inherited from INDI::Focuser
INumber	PresetN [3]

INumberVectorProperty	PresetNP

ISwitch	PresetGotoS [3]

ISwitchVectorProperty	PresetGotoSP

Controller *	controller

Connection::Serial *	serialConnection = nullptr

Connection::TCP *	tcpConnection = nullptr

int	PortFD = -1

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::FocuserInterface
INumberVectorProperty	FocusSpeedNP

INumber	FocusSpeedN [1]

ISwitchVectorProperty	FocusMotionSP

ISwitch	FocusMotionS [2]

INumberVectorProperty	FocusTimerNP

INumber	FocusTimerN [1]

INumberVectorProperty	FocusAbsPosNP

INumber	FocusAbsPosN [1]

INumberVectorProperty	FocusRelPosNP

INumber	FocusRelPosN [1]

ISwitchVectorProperty	AbortSP

ISwitch	AbortS [1]

uint32_t	capability

double	lastTimerValue = { 0 }

DefaultDevice *	m_defaultDevice { nullptr }

Protected Attributes inherited from INDI::RotatorInterface
INumber	GotoRotatorN [1]

INumberVectorProperty	GotoRotatorNP

INumber	SyncRotatorN [1]

INumberVectorProperty	SyncRotatorNP

ISwitch	AbortRotatorS [1]

ISwitchVectorProperty	AbortRotatorSP

ISwitch	HomeRotatorS [1]

ISwitchVectorProperty	HomeRotatorSP

ISwitch	ReverseRotatorS [2]

ISwitchVectorProperty	ReverseRotatorSP

uint32_t	rotatorCapability = 0

DefaultDevice *	m_defaultDevice { nullptr }

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Enumerator
SENSOR_TEMPERATURE
SENSOR_VOLTAGE

◆ anonymous enum

anonymous enum

private

Enumerator
ROTATION_SWITCH
OUT_SWITCH
IN_SWITCH

◆ anonymous enum

anonymous enum

private

Enumerator
BRIGHTNESS_DISPLAY
BRIGHTNESS_SLEEP

◆ MotorType

enum NightCrawler::MotorType

Enumerator
MOTOR_FOCUS
MOTOR_ROTATOR
MOTOR_AUX

Constructor & Destructor Documentation

◆ NightCrawler()

NightCrawler::NightCrawler ( )

◆ ~NightCrawler()

virtual NightCrawler::~NightCrawler ( )

virtualdefault

Member Function Documentation

◆ AbortFocuser()

bool NightCrawler::AbortFocuser ( )

protectedvirtual

AbortFocuser all focus motion.

Returns: True if abort is successful, false otherwise.

Reimplemented from INDI::FocuserInterface.

◆ AbortRotator()

bool NightCrawler::AbortRotator ( )

protectedvirtual

AbortRotator Abort all motion.

Returns: True if successful, false otherwise.

Reimplemented from INDI::RotatorInterface.

◆ Ack()

bool NightCrawler::Ack ( )

private

◆ findHome()

bool NightCrawler::findHome ( uint8_t motorTypes )

private

◆ getDefaultName()

const char * NightCrawler::getDefaultName ( )

virtual

Returns: Default name of the device.

Implements INDI::DefaultDevice.

◆ getFirmware()

bool NightCrawler::getFirmware ( )

private

◆ getFocuserType()

bool NightCrawler::getFocuserType ( )

private

◆ getLimitSwitchStatus()

bool NightCrawler::getLimitSwitchStatus ( )

private

◆ getPosition()

bool NightCrawler::getPosition ( MotorType type )

private

◆ getStepDelay()

bool NightCrawler::getStepDelay ( MotorType type )

private

◆ getTemperature()

bool NightCrawler::getTemperature ( )

private

◆ getVoltage()

bool NightCrawler::getVoltage ( )

private

◆ gotoMotor()

bool NightCrawler::gotoMotor	(	MotorType	type,
		int32_t	position
	)

private

◆ Handshake()

bool NightCrawler::Handshake ( )

virtual

perform handshake with device to check communication

Reimplemented from INDI::Focuser.

◆ HomeRotator()

IPState NightCrawler::HomeRotator ( )

protectedvirtual

HomeRotator Go to home position.

Returns: State of operation: IPS_OK is motion is completed, IPS_BUSY if motion in progress, IPS_ALERT on error.

Reimplemented from INDI::RotatorInterface.

◆ initProperties()

bool NightCrawler::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::Focuser.

◆ isHomingComplete()

bool NightCrawler::isHomingComplete ( )

private

◆ isMotorMoving()

bool NightCrawler::isMotorMoving ( MotorType type )

private

◆ ISNewNumber()

bool NightCrawler::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::Focuser.

◆ ISNewSwitch()

bool NightCrawler::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::Focuser.

◆ MoveAbsFocuser()

IPState NightCrawler::MoveAbsFocuser ( uint32_t targetTicks )

protectedvirtual

MoveFocuser the focuser to an absolute position.

Parameters

ticks The new position of the focuser.

Returns: Return IPS_OK if motion is completed and focuser reached requested position. Return IPS_BUSY if focuser started motion to requested position and is in progress. Return IPS_ALERT if there is an error.

Reimplemented from INDI::FocuserInterface.

◆ MoveRelFocuser()

IPState NightCrawler::MoveRelFocuser	(	FocusDirection	dir,
		uint32_t	ticks
	)

protectedvirtual

MoveFocuser the focuser to an relative position.

Parameters

dir	Direction of focuser, either FOCUS_INWARD or FOCUS_OUTWARD.
ticks	The relative ticks to move.

Returns: Return IPS_OK if motion is completed and focuser reached requested position. Return IPS_BUSY if focuser started motion to requested position and is in progress. Return IPS_ALERT if there is an error.

Reimplemented from INDI::FocuserInterface.

◆ MoveRotator()

IPState NightCrawler::MoveRotator ( double angle )

protectedvirtual

MoveRotator Go to specific angle.

Parameters

angle Target angle in degrees.

Returns: State of operation: IPS_OK is motion is completed, IPS_BUSY if motion in progress, IPS_ALERT on error.

Implements INDI::RotatorInterface.

◆ saveConfigItems()

bool NightCrawler::saveConfigItems ( FILE * fp )

protectedvirtual

saveConfigItems Saves the Device Port and Focuser Presets in the configuration file

Parameters

fp	pointer to configuration file

Returns: true if successful, false otherwise.

Reimplemented from INDI::Focuser.

◆ setDisplayBrightness()

bool NightCrawler::setDisplayBrightness ( uint8_t value )

private

◆ setEncodersEnabled()

bool NightCrawler::setEncodersEnabled ( bool enable )

private

◆ setSleepBrightness()

bool NightCrawler::setSleepBrightness ( uint8_t value )

private

◆ setStepDelay()

bool NightCrawler::setStepDelay	(	MotorType	type,
		uint32_t	delay
	)

private

◆ setTemperatureOffset()

bool NightCrawler::setTemperatureOffset ( double offset )

private

◆ startMotor()

bool NightCrawler::startMotor ( MotorType type )

private

◆ stopMotor()

bool NightCrawler::stopMotor ( MotorType type )

private

◆ syncMotor()

bool NightCrawler::syncMotor	(	MotorType	type,
		uint32_t	position
	)

private

◆ SyncRotator()

bool NightCrawler::SyncRotator ( double angle )

protectedvirtual

SyncRotator Set current angle as the supplied angle without moving the rotator.

Parameters

ticks Desired new angle.

Returns: True if successful, false otherwise.

Reimplemented from INDI::RotatorInterface.

◆ TimerHit()

void NightCrawler::TimerHit ( )

protectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

◆ updateProperties()

bool NightCrawler::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::Focuser.

Member Data Documentation

◆ AbortAuxS

ISwitch NightCrawler::AbortAuxS[1]

private

◆ AbortAuxSP

ISwitchVectorProperty NightCrawler::AbortAuxSP

private

◆ AuxStepDelayN

INumber NightCrawler::AuxStepDelayN[1]

private

◆ AuxStepDelayNP

INumberVectorProperty NightCrawler::AuxStepDelayNP

private

◆ BrightnessN

INumber NightCrawler::BrightnessN[2]

private

◆ BrightnessNP

INumberVectorProperty NightCrawler::BrightnessNP

private

◆ EncoderS

ISwitch NightCrawler::EncoderS[2]

private

◆ EncoderSP

ISwitchVectorProperty NightCrawler::EncoderSP

private

◆ FindHomeS

ISwitch NightCrawler::FindHomeS[1]

private

◆ FindHomeSP

ISwitchVectorProperty NightCrawler::FindHomeSP

private

◆ FocusStepDelayN

INumber NightCrawler::FocusStepDelayN[1]

private

◆ FocusStepDelayNP

INumberVectorProperty NightCrawler::FocusStepDelayNP

private

◆ GotoAuxN

INumber NightCrawler::GotoAuxN[1]

private

◆ GotoAuxNP

INumberVectorProperty NightCrawler::GotoAuxNP

private

◆ HomeSelectionS

ISwitch NightCrawler::HomeSelectionS[3]

private

◆ HomeSelectionSP

ISwitchVectorProperty NightCrawler::HomeSelectionSP

private

◆ inSwitchLimit

IPState NightCrawler::inSwitchLimit { IPS_IDLE }

private

◆ lastAuxPosition

uint32_t NightCrawler::lastAuxPosition { 0 }

private

◆ lastFocuserPosition

uint32_t NightCrawler::lastFocuserPosition { 0 }

private

◆ lastRotatorPosition

uint32_t NightCrawler::lastRotatorPosition { 0 }

private

◆ lastTemperature

double NightCrawler::lastTemperature { 0 }

private

◆ lastVoltage

double NightCrawler::lastVoltage { 0 }

private

◆ LimitSwitchL

ILight NightCrawler::LimitSwitchL[3]

private

◆ LimitSwitchLP

ILightVectorProperty NightCrawler::LimitSwitchLP

private

◆ outSwitchLimit

IPState NightCrawler::outSwitchLimit { IPS_IDLE }

private

◆ rotationLimit

IPState NightCrawler::rotationLimit { IPS_IDLE }

private

◆ RotatorAbsPosN

INumber NightCrawler::RotatorAbsPosN[1]

private

◆ RotatorAbsPosNP

INumberVectorProperty NightCrawler::RotatorAbsPosNP

private

◆ RotatorStepDelayN

INumber NightCrawler::RotatorStepDelayN[1]

private

◆ RotatorStepDelayNP

INumberVectorProperty NightCrawler::RotatorStepDelayNP

private

◆ SensorN

INumber NightCrawler::SensorN[2]

private

◆ SensorNP

INumberVectorProperty NightCrawler::SensorNP

private

◆ SyncAuxN

INumber NightCrawler::SyncAuxN[1]

private

◆ SyncAuxNP

INumberVectorProperty NightCrawler::SyncAuxNP

private

◆ SyncFocusN

INumber NightCrawler::SyncFocusN[1]

private

◆ SyncFocusNP

INumberVectorProperty NightCrawler::SyncFocusNP

private

◆ targetPosition

uint32_t NightCrawler::targetPosition { 0 }

private

◆ TemperatureOffsetN

INumber NightCrawler::TemperatureOffsetN[1]

private

◆ TemperatureOffsetNP

INumberVectorProperty NightCrawler::TemperatureOffsetNP

private

◆ ticksPerDegree

double NightCrawler::ticksPerDegree { 0 }

private

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

ln/3rdparty/src/indilib/indi-1.7.4/libindi/drivers/rotator/nightcrawler.h
ln/3rdparty/src/indilib/indi-1.7.4/libindi/drivers/rotator/nightcrawler.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ MotorType

Constructor & Destructor Documentation

◆ NightCrawler()

◆ ~NightCrawler()

Member Function Documentation

◆ AbortFocuser()

◆ AbortRotator()

◆ Ack()

◆ findHome()

◆ getDefaultName()

◆ getFirmware()

◆ getFocuserType()

◆ getLimitSwitchStatus()

◆ getPosition()

◆ getStepDelay()

◆ getTemperature()

◆ getVoltage()

◆ gotoMotor()

◆ Handshake()

◆ HomeRotator()

◆ initProperties()

◆ isHomingComplete()

◆ isMotorMoving()

◆ ISNewNumber()

◆ ISNewSwitch()

◆ MoveAbsFocuser()

◆ MoveRelFocuser()

◆ MoveRotator()

◆ saveConfigItems()

◆ setDisplayBrightness()

◆ setEncodersEnabled()

◆ setSleepBrightness()

◆ setStepDelay()

◆ setTemperatureOffset()

◆ startMotor()

◆ stopMotor()

◆ syncMotor()

◆ SyncRotator()

◆ TimerHit()

◆ updateProperties()

Member Data Documentation

◆ AbortAuxS

◆ AbortAuxSP

◆ AuxStepDelayN

◆ AuxStepDelayNP

◆ BrightnessN

◆ BrightnessNP

◆ EncoderS

◆ EncoderSP

◆ FindHomeS

◆ FindHomeSP

◆ FocusStepDelayN

◆ FocusStepDelayNP

◆ GotoAuxN

◆ GotoAuxNP

◆ HomeSelectionS

◆ HomeSelectionSP

◆ inSwitchLimit

◆ lastAuxPosition

◆ lastFocuserPosition

◆ lastRotatorPosition

◆ lastTemperature

◆ lastVoltage

◆ LimitSwitchL

◆ LimitSwitchLP

◆ outSwitchLimit

◆ rotationLimit

◆ RotatorAbsPosN

◆ RotatorAbsPosNP