The JoyStick class provides an INDI driver that displays event data from game pads. The INDI driver can be encapsulated in any other driver via snooping on properties of interesting. More...

#include <joystick.h>

Inheritance diagram for JoyStick:

Public Member Functions
	JoyStick ()

virtual bool	initProperties () override
	Initialize properties initial state and value. The child class must implement this function.

virtual bool	updateProperties () override
	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.

virtual void	ISGetProperties (const char *dev) override
	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.

virtual bool	ISSnoopDevice (XMLEle *root) override
	Process a snoop event from INDI server. This function is called when a snooped property is updated in a snooped driver.

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

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

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

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

virtual	~DefaultDevice () override=default

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

void	addDebugControl ()
	Add Debug control to the driver.

void	addSimulationControl ()
	Add Simulation control to the driver.

void	addConfigurationControl ()
	Add Configuration control to the driver.

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

void	addNicknameControl ()
	Add Nickname text property to the driver.

void	resetProperties ()
	Set all properties to IDLE state.

void	defineNumber (INumberVectorProperty *nvp)
	Define number vector to client & register it. Alternatively, IDDefNumber can be used but the property will not get registered and the driver will not be able to save configuration files.

void	defineProperty (INumberVectorProperty *property)

void	defineText (ITextVectorProperty *tvp)
	Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files.

void	defineProperty (ITextVectorProperty *property)

void	defineSwitch (ISwitchVectorProperty *svp)
	Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files.

void	defineProperty (ISwitchVectorProperty *property)

void	defineLight (ILightVectorProperty *lvp)
	Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files.

void	defineProperty (ILightVectorProperty *property)

void	defineBLOB (IBLOBVectorProperty *bvp)
	Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files.

void	defineProperty (IBLOBVectorProperty *property)

void	defineProperty (INDI::Property &property)

virtual bool	deleteProperty (const char *propertyName)
	Delete a property and unregister it. It will also be deleted from all clients.

bool	deleteProperty (INDI::Property &property)
	deleteProperty Delete a property and unregister it. It will also be deleted from all clients.

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

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

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

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

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.

uint16_t	getMajorVersion () const

uint16_t	getMinorVersion () const

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.

bool	ISNewProperty (INDI::Property &property, const std::string &elementName, const std::any &value)
	Generic convenience function to update a property element as if by client request, simulating an ISNew... call.

template<typename PropertyType , typename ValueType >
bool	updateProperty (PropertyType &property, ValueType values, char names[], int n, std::function< bool()> updater, bool saveConfig=false)
	Generic helper function to update an INDI property based on an external operation.

uint32_t	getDriverInterface () const

void	setDriverInterface (uint32_t value)
	setInterface Set driver interface. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values.

void	watchDevice (const char *deviceName, const std::function< void(INDI::BaseDevice)> &callback)
	Add a device to the watch list.

Public Member Functions inherited from INDI::ParentDevice
	ParentDevice (Type type)

	~ParentDevice ()

	ParentDevice (ParentDevice &&other)=default

ParentDevice &	operator= (ParentDevice &&other)=default

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

virtual	~BaseDevice ()

void	registerProperty (const INDI::Property &property)
	Register the property to be able to observe and update.

void	registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type)

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

void	watchProperty (const char *name, const std::function< void(INDI::Property)> &callback, WATCH watch=WATCH_NEW)
	Call the callback function if property is available.

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

Properties	getProperties ()
	Return a list of all properties in the device.

const Properties	getProperties () const

INDI::PropertyNumber	getNumber (const char *name) const

INDI::PropertyText	getText (const char *name) const

INDI::PropertySwitch	getSwitch (const char *name) const

INDI::PropertyLight	getLight (const char *name) const

INDI::PropertyBlob	getBLOB (const char *name) const

IPState	getPropertyState (const char *name) const

IPerm	getPropertyPermission (const char *name) const

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

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

void	checkMessage (XMLEle *root)

void	doMessage (XMLEle *msg)

const std::string &	messageQueue (size_t index) const

const std::string &	lastMessage () const

bool	isValid () const

bool	isSameDevice (const BaseDevice &other) const

bool	isConnected () const

void	attach ()
	indicates that the device is ready

void	detach ()
	indicates that the device is being removed

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

INDI::BaseMediator *	getMediator () const

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

const char *	getDeviceName () const

bool	isDeviceNameMatch (const char *otherName) const
	Check that the device name matches the argument.

bool	isDeviceNameMatch (const std::string &otherName) const
	Check that the device name matches the argument.

const char *	getDriverName () const

const char *	getDriverExec () const

const char *	getDriverVersion () const

uint16_t	getDriverInterface () const
	getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver.

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

int	buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false)
	Build a property given the supplied XML element (defXXX)

int	setValue (const INDI::LilXmlElement &root, char *errmsg)
	handle SetXXX commands from client

	operator BaseDevice * ()

BaseDevice *	operator-> ()

bool	operator!= (std::nullptr_t) const

bool	operator== (std::nullptr_t) const

	operator bool () const

	operator bool ()

Static Public Member Functions
static void	joystickHelper (int joystick_n, double mag, double angle)

static void	axisHelper (int axis_n, int value)

static void	buttonHelper (int button_n, int value)

Static Public Member Functions inherited from INDI::BaseDevice
static std::string	getSharedFilePath (std::string fileName)

Protected Member Functions
virtual bool	Connect () override
	Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation.

virtual bool	Disconnect () override
	Disconnect from device.

virtual const char *	getDefaultName () override

bool	saveConfigItems (FILE *fp) override
	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.

void	setupParams ()

void	joystickEvent (int joystick_n, double mag, double angle)

void	axisEvent (int axis_n, int value)

void	buttonEvent (int button_n, int value)

Protected Member Functions inherited from INDI::DefaultDevice
void	setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
	setDynamicPropertiesBehavior controls handling of dynamic properties. Dynamic properties are those generated from an external skeleton XML file. By default all properties, including dynamic properties, are defined to the client in ISGetProperties(). Furthermore, when űdeleteProperty(properyName) is called, the dynamic property is deleted by default, and can only be restored by calling buildSkeleton(filename) again. However, it is sometimes desirable to skip the definition of the dynamic properties on startup and delegate this task to the child class. To control this behavior, set enabled to false.

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

bool	loadConfig (INDI::Property &property)
	Load property config from the configuration file. If the property configuration is successfully parsed, the corresponding ISNewXXX is called with the values parsed from the config file.

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

bool	saveConfig (INDI::Property &property)
	Save a property in the configuration file.

virtual bool	purgeConfig ()
	purgeConfig Remove config file from disk.

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

virtual bool	loadDefaultConfig ()
	Load the default configuration file.

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

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

virtual void	debugTriggered (bool enable)
	Inform driver that the debug option was triggered. This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled.

virtual void	simulationTriggered (bool enable)
	Inform driver that the simulation option was triggered. This function is called after setSimulation is triggered by the client. Reimplement this function if your driver needs to take specific action after simulation is enabled/disabled. Otherwise, you can use isSimulation() to check if simulation is enabled or disabled.

bool	isDebug () const

bool	isSimulation () const

void	registerConnection (Connection::Interface *newConnection)
	registerConnection Add new connection plugin to the existing connection pool. The connection type shall be defined to the client in ISGetProperties()

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

Connection::Interface *	getActiveConnection ()

void	setActiveConnection (Connection::Interface *existingConnection)
	setActiveConnection Switch the active connection to the passed connection plugin

void	setDefaultPollingPeriod (uint32_t msec)
	setDefaultPollingPeriod Change the default polling period to call TimerHit() function in the driver.

void	setPollingPeriodRange (uint32_t minimum, uint32_t maximum)
	setPollingPeriodRange Set the range permitted by the polling range in milliseconds

uint32_t	getPollingPeriod () const
	getPollingPeriod Return the polling period.

void	setCurrentPollingPeriod (uint32_t msec)
	setCurrentPollingPeriod Change the current polling period to call TimerHit() function in the driver.

uint32_t	getCurrentPollingPeriod () const
	getCurrentPollingPeriod Return the current polling period.

uint32_t &	refCurrentPollingPeriod () __attribute__((deprecated))

uint32_t	refCurrentPollingPeriod () const __attribute__((deprecated))

bool	isConfigLoading () const
	isConfigLoading Check if driver configuration is currently in the process of getting loaded.

bool	isInitializationComplete () const
	isInitializationComplete Check if driver initialization is complete.

void	syncDriverInfo ()
	syncDriverInfo sends the current driver information to the client.

void	setDeviceNickname (const char *nick)
	Set the device nickname.

const char *	getDeviceNickname ()

const char *	lookupDeviceNicknameFromId (const char identifier, const char device=nullptr)
	Lookup device nickname for an identifier.

bool	setDeviceNicknameFromId (const char *identifier)
	Set device nickname based on an identifier.

void	saveNicknameId (const char nickname, const char identifier)

virtual void	nicknameSet (const char *nickname)
	Inform driver that the nickname has been set.

	DefaultDevice (const std::shared_ptr< DefaultDevicePrivate > &dd)

Protected Member Functions inherited from INDI::ParentDevice
	ParentDevice (const std::shared_ptr< ParentDevicePrivate > &dd)

Protected Member Functions inherited from INDI::BaseDevice
	BaseDevice (BaseDevicePrivate &dd)

	BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd)

Protected Attributes
std::vector< INDI::PropertyNumber >	JoyStickNP

INDI::PropertyNumber	AxisNP {0}

INDI::PropertyNumber	DeadZoneNP {0}

INDI::PropertyNumber	FilterNP {1}

INDI::PropertySwitch	ButtonSP {0}

INDI::PropertyText	PortTP {1}

INDI::PropertyText	JoystickInfoTP {5}

INDI::PropertySwitch	CalibrationSP {2}
	CalibrationSP Start / End the calibration sweep.

INDI::PropertyNumber	AxisCalibrationNP {0}
	AxisCalibrationNP Per-axis calibration values (IP_RW).

INDI::PropertySwitch	AxisReverseSP {0}
	AxisReverseSP Per-axis polarity reversal toggles (IP_RW).

std::unique_ptr< JoyStickDriver >	driver

std::vector< double >	m_axisEMA

std::vector< double >	m_joystickAngleCosEMA

std::vector< double >	m_joystickAngleSinEMA

Protected Attributes inherited from INDI::BaseDevice
std::shared_ptr< BaseDevicePrivate >	d_ptr

Additional Inherited Members
Public Types inherited from INDI::ParentDevice
enum	Type { Valid , Invalid }

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 }

enum	{ INDI_ENABLED , INDI_DISABLED }

enum	WATCH { WATCH_NEW = 0 , WATCH_UPDATE , WATCH_NEW_OR_UPDATE }

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) , CORRELATOR_INTERFACE = (1 << 14) , AUX_INTERFACE = (1 << 15) , OUTPUT_INTERFACE = (1 << 16) , INPUT_INTERFACE = (1 << 17) , POWER_INTERFACE = (1 << 18) , IMU_INTERFACE = (1 << 19) , PAC_INTERFACE = (1 << 20) , SENSOR_INTERFACE = SPECTROGRAPH_INTERFACE \| DETECTOR_INTERFACE \| CORRELATOR_INTERFACE }
	The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...

typedef INDI::Properties	Properties

Detailed Description

The JoyStick class provides an INDI driver that displays event data from game pads. The INDI driver can be encapsulated in any other driver via snooping on properties of interesting.

Per-axis calibration is supported: record the center (rest) position and the physical min/max of each axis so that the reported magnitude and angle are deterministic regardless of hardware variation. Calibration data is stored per joystick name in ~/.indi/JoystickCalibrationData.xml and is reloaded automatically when the same device reconnects.

Definition at line 47 of file joystick.h.

Constructor & Destructor Documentation

◆ JoyStick()

JoyStick::JoyStick ( )

Definition at line 50 of file joystick.cpp.

Member Function Documentation

◆ axisEvent()

void JoyStick::axisEvent	(	int	axis_n,
		int	value
	)

protected

Definition at line 595 of file joystick.cpp.

◆ axisHelper()

void JoyStick::axisHelper	(	int	axis_n,
		int	value
	)

static

Definition at line 537 of file joystick.cpp.

◆ buttonEvent()

void JoyStick::buttonEvent	(	int	button_n,
		int	value
	)

protected

Definition at line 643 of file joystick.cpp.

◆ buttonHelper()

void JoyStick::buttonHelper	(	int	button_n,
		int	value
	)

static

Definition at line 532 of file joystick.cpp.

◆ Connect()

bool JoyStick::Connect ( )

overrideprotectedvirtual

Connect to the device. INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation.

Returns: True if connection is successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Definition at line 64 of file joystick.cpp.

◆ Disconnect()

bool JoyStick::Disconnect ( )

overrideprotectedvirtual

Disconnect from device.

Returns: True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Definition at line 85 of file joystick.cpp.

◆ getDefaultName()

const char * JoyStick::getDefaultName ( )

overrideprotectedvirtual

Returns: Default name of the device.

Implements INDI::DefaultDevice.

Definition at line 59 of file joystick.cpp.

◆ initProperties()

bool JoyStick::initProperties ( )

overridevirtual

Initialize properties initial state and value. The child class must implement this function.

Returns: True if initialization is successful, false otherwise.

Reimplemented from INDI::DefaultDevice.

Definition at line 218 of file joystick.cpp.

◆ ISGetProperties()

void JoyStick::ISGetProperties ( const char * dev )

overridevirtual

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.

Definition at line 349 of file joystick.cpp.

◆ ISNewNumber()

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

overridevirtual

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.

Definition at line 387 of file joystick.cpp.

◆ ISNewSwitch()

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

overridevirtual

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.

Definition at line 430 of file joystick.cpp.

◆ ISNewText()

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

overridevirtual

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.

Definition at line 366 of file joystick.cpp.

◆ ISSnoopDevice()

bool JoyStick::ISSnoopDevice ( XMLEle * root )

overridevirtual

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.

Definition at line 357 of file joystick.cpp.

◆ joystickEvent()

void JoyStick::joystickEvent	(	int	joystick_n,
		double	mag,
		double	angle
	)

protected

Definition at line 546 of file joystick.cpp.

◆ joystickHelper()

void JoyStick::joystickHelper	(	int	joystick_n,
		double	mag,
		double	angle
	)

static

Definition at line 527 of file joystick.cpp.

◆ saveConfigItems()

bool JoyStick::saveConfigItems ( FILE * fp )

overrideprotectedvirtual

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.

Definition at line 662 of file joystick.cpp.

◆ setupParams()

void JoyStick::setupParams ( )

protected

Definition at line 95 of file joystick.cpp.

◆ updateProperties()

bool JoyStick::updateProperties ( )

overridevirtual

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.

Definition at line 265 of file joystick.cpp.

Member Data Documentation

◆ AxisCalibrationNP

INDI::PropertyNumber JoyStick::AxisCalibrationNP {0}

protected

AxisCalibrationNP Per-axis calibration values (IP_RW).

Three elements per axis, laid out sequentially: AXIS_N_CENTER – raw value at rest / center. AXIS_N_MIN – raw value at maximum negative deflection. AXIS_N_MAX – raw value at maximum positive deflection.

Allocated dynamically in setupParams() to nAxes×3 elements. The user can also hand-edit these values at any time.

Definition at line 120 of file joystick.h.

◆ AxisNP

INDI::PropertyNumber JoyStick::AxisNP {0}

protected

Definition at line 82 of file joystick.h.

◆ AxisReverseSP

INDI::PropertySwitch JoyStick::AxisReverseSP {0}

protected

AxisReverseSP Per-axis polarity reversal toggles (IP_RW).

One switch element per axis using ISR_NOFMANY so each toggle is independent. When a switch is ON, the raw axis value is negated before calibration, effectively mirroring that axis.

Reversing both axes of a joystick pair produces the same effect as a full 180° reversal of the stick.

Allocated dynamically in setupParams() to nAxes elements. Settings are saved to the standard INDI config file (~/.indi/Joystick.xml).

Definition at line 135 of file joystick.h.

◆ ButtonSP

INDI::PropertySwitch JoyStick::ButtonSP {0}

protected

Definition at line 89 of file joystick.h.

◆ CalibrationSP

INDI::PropertySwitch JoyStick::CalibrationSP {2}

protected

CalibrationSP Start / End the calibration sweep.

CALIBRATION_START – snapshot current axis values as center; begin tracking min/max. User should be at rest when clicking this. CALIBRATION_END – stop tracking, save results to XML file, apply values to the low-level driver.

Definition at line 107 of file joystick.h.

◆ DeadZoneNP

INDI::PropertyNumber JoyStick::DeadZoneNP {0}

protected

Definition at line 83 of file joystick.h.

◆ driver

std::unique_ptr<JoyStickDriver> JoyStick::driver

protected

Definition at line 137 of file joystick.h.

◆ FilterNP

INDI::PropertyNumber JoyStick::FilterNP {1}

protected

Definition at line 86 of file joystick.h.

◆ JoystickInfoTP

INDI::PropertyText JoyStick::JoystickInfoTP {5}

protected

Definition at line 95 of file joystick.h.

◆ JoyStickNP

std::vector<INDI::PropertyNumber> JoyStick::JoyStickNP

protected

Definition at line 79 of file joystick.h.

◆ m_axisEMA

std::vector<double> JoyStick::m_axisEMA

protected

Definition at line 140 of file joystick.h.

◆ m_joystickAngleCosEMA

std::vector<double> JoyStick::m_joystickAngleCosEMA

protected

Definition at line 143 of file joystick.h.

◆ m_joystickAngleSinEMA

std::vector<double> JoyStick::m_joystickAngleSinEMA

protected

Definition at line 144 of file joystick.h.

◆ PortTP

INDI::PropertyText JoyStick::PortTP {1}

protected

Definition at line 92 of file joystick.h.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ JoyStick()

Member Function Documentation

◆ axisEvent()

◆ axisHelper()

◆ buttonEvent()

◆ buttonHelper()

◆ Connect()

◆ Disconnect()

◆ getDefaultName()

◆ initProperties()

◆ ISGetProperties()

◆ ISNewNumber()

◆ ISNewSwitch()

◆ ISNewText()

◆ ISSnoopDevice()

◆ joystickEvent()

◆ joystickHelper()

◆ saveConfigItems()

◆ setupParams()

◆ updateProperties()

Member Data Documentation

◆ AxisCalibrationNP

◆ AxisNP

◆ AxisReverseSP

◆ ButtonSP

◆ CalibrationSP

◆ DeadZoneNP

◆ driver

◆ FilterNP

◆ JoystickInfoTP

◆ JoyStickNP

◆ m_axisEMA

◆ m_joystickAngleCosEMA

◆ m_joystickAngleSinEMA

◆ PortTP