INDI::Controller Class Reference

The Controller class provides functionality to access a controller (e.g. More...

#include <indicontroller.h>

Collaboration diagram for INDI::Controller:

Public Types
enum	ControllerType {   CONTROLLER_JOYSTICK, CONTROLLER_AXIS, CONTROLLER_BUTTON, CONTROLLER_UNKNOWN,   CONTROLLER_JOYSTICK, CONTROLLER_AXIS, CONTROLLER_BUTTON, CONTROLLER_UNKNOWN }
enum	ControllerType {   CONTROLLER_JOYSTICK, CONTROLLER_AXIS, CONTROLLER_BUTTON, CONTROLLER_UNKNOWN,   CONTROLLER_JOYSTICK, CONTROLLER_AXIS, CONTROLLER_BUTTON, CONTROLLER_UNKNOWN }
typedef std::function< void(const char *joystick_n, double mag, double angle, void *context)>	joystickFunc
	joystickFunc Joystick callback function signature. More...
typedef std::function< void(const char *axis_n, double value, void *context)>	axisFunc
	axisFunc Axis callback function signature. More...
typedef std::function< void(const char *button_n, ISState state, void *context)>	buttonFunc
	buttonFunc Button callback function signature. More...
typedef std::function< void(const char *joystick_n, double mag, double angle, void *context)>	joystickFunc
	joystickFunc Joystick callback function signature. More...
typedef std::function< void(const char *axis_n, double value, void *context)>	axisFunc
	axisFunc Axis callback function signature. More...
typedef std::function< void(const char *button_n, ISState state, void *context)>	buttonFunc
	buttonFunc Button callback function signature. More...

Public Member Functions
	Controller (INDI::DefaultDevice *cdevice)
	Controller Default ctor. More...
virtual	~Controller ()
virtual void	ISGetProperties (const char *dev)
virtual bool	initProperties ()
virtual bool	updateProperties ()
virtual bool	ISSnoopDevice (XMLEle *root)
virtual bool	ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
virtual bool	ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
virtual bool	saveConfigItems (FILE *fp)
void	mapController (const char *propertyName, const char *propertyLabel, ControllerType type, const char *initialValue)
	mapController adds a new property to the joystick's settings. More...
void	clearMap ()
	clearMap clears all properties added previously by mapController() More...
void	setJoystickCallback (joystickFunc joystickCallback)
	setJoystickCallback Sets the callback function when a new joystick input is detected. More...
void	setAxisCallback (axisFunc axisCallback)
	setAxisCallback Sets the callback function when a new axis input is detected. More...
void	setButtonCallback (buttonFunc buttonCallback)
	setButtonCallback Sets the callback function when a new button input is detected. More...
ControllerType	getControllerType (const char *name)
const char *	getControllerSetting (const char *name)
	Controller (INDI::DefaultDevice *cdevice)
	Controller Default ctor. More...
virtual	~Controller ()
virtual void	ISGetProperties (const char *dev)
virtual bool	initProperties ()
virtual bool	updateProperties ()
virtual bool	ISSnoopDevice (XMLEle *root)
virtual bool	ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
virtual bool	ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
virtual bool	saveConfigItems (FILE *fp)
void	mapController (const char *propertyName, const char *propertyLabel, ControllerType type, const char *initialValue)
	mapController adds a new property to the joystick's settings. More...
void	clearMap ()
	clearMap clears all properties added previously by mapController() More...
void	setJoystickCallback (joystickFunc joystickCallback)
	setJoystickCallback Sets the callback function when a new joystick input is detected. More...
void	setAxisCallback (axisFunc axisCallback)
	setAxisCallback Sets the callback function when a new axis input is detected. More...
void	setButtonCallback (buttonFunc buttonCallback)
	setButtonCallback Sets the callback function when a new button input is detected. More...
ControllerType	getControllerType (const char *name)
const char *	getControllerSetting (const char *name)

Protected Member Functions
void	enableJoystick ()
void	disableJoystick ()
void	enableJoystick ()
void	disableJoystick ()

Static Protected Member Functions
static void	joystickEvent (const char *joystick_n, double mag, double angle, void *context)
static void	axisEvent (const char *axis_n, int value, void *context)
static void	buttonEvent (const char *button_n, int value, void *context)
static void	joystickEvent (const char *joystick_n, double mag, double angle, void *context)
static void	axisEvent (const char *axis_n, int value, void *context)
static void	buttonEvent (const char *button_n, int value, void *context)

Protected Attributes
joystickFunc	joystickCallbackFunc
buttonFunc	buttonCallbackFunc
axisFunc	axisCallbackFunc
INDI::DefaultDevice *	device

Private Attributes
ISwitchVectorProperty	UseJoystickSP
ISwitch	UseJoystickS [2]
ITextVectorProperty	JoystickSettingTP
IText *	JoystickSettingT = nullptr

Detailed Description

The Controller class provides functionality to access a controller (e.g.

joystick) input and send it to the requesting driver.

• To use the class in an INDI::DefaultDevice based driver:
  1. Set the callback functions for each of input type requested.
  2. Map the properties you wish to /e listen to from the joystick driver by specifying the type of input requested and the initial default value. For example:

     mapController("ABORT", "Abort Telescope", INDI::Controller::CONTROLLER_BUTTON, "BUTTON_1");

     After mapping all the desired controls, call the class initProperties() function. If the user enables joystick support in the driver and presses a button on the joystick, the button callback function will be invoked with the name & state of the button.
  3. Call the Controller's ISGetProperties(), initProperties(), updateProperties(), saveConfigItems(), and ISNewXXX functions from the same standard functions in your driver.

The class communicates with INDI joystick driver which in turn enumerates the game pad and provides three types of constrcuts:

• Joysticks: Each joystick displays a normalized magnitude [0 to 1] and an angle. The angle is measured counter clock wise starting from the right/east direction [0 to 360]. They are defined as JOYSTICK_# where # is the joystick number.
• Axes: Each joystick has two or more axes. Each axis has a raw value and angle. The raw value ranges from -32767.0 to 32767.0 They are defined as AXIS_# where # is the axis number.
• Buttons: Buttons are either on or off. They are defined as BUTTON_# where # is the button number.

Note

All indexes start from 1. i.e. There is no BUTTON_0 or JOYSTICK_0.

See also

See the LX200 Generic & Celestron GPS drivers for an example implementation.

Warning

Both the indi_joystick driver and the driver using this class must be running in the same INDI server (or chained INDI servers) in order for it to work as it depends on snooping among drivers.

Author

Jasem Multaq

Member Typedef Documentation

axisFunc [1/2]

typedef std::function<void(const char *axis_n, double value, void *context)> INDI::Controller::axisFunc

axisFunc Axis callback function signature.

axisFunc [2/2]

typedef std::function<void(const char *axis_n, double value, void *context)> INDI::Controller::axisFunc

axisFunc Axis callback function signature.

buttonFunc [1/2]

typedef std::function<void(const char *button_n, ISState state, void *context)> INDI::Controller::buttonFunc

buttonFunc Button callback function signature.

buttonFunc [2/2]

typedef std::function<void(const char *button_n, ISState state, void *context)> INDI::Controller::buttonFunc

buttonFunc Button callback function signature.

joystickFunc [1/2]

typedef std::function<void(const char *joystick_n, double mag, double angle, void *context)> INDI::Controller::joystickFunc

joystickFunc Joystick callback function signature.

joystickFunc [2/2]

typedef std::function<void(const char *joystick_n, double mag, double angle, void *context)> INDI::Controller::joystickFunc

joystickFunc Joystick callback function signature.

Member Enumeration Documentation

ControllerType [1/2]

enum INDI::Controller::ControllerType

Enumerator
CONTROLLER_JOYSTICK
CONTROLLER_AXIS
CONTROLLER_BUTTON
CONTROLLER_UNKNOWN
CONTROLLER_JOYSTICK
CONTROLLER_AXIS
CONTROLLER_BUTTON
CONTROLLER_UNKNOWN

ControllerType [2/2]

enum INDI::Controller::ControllerType

Enumerator
CONTROLLER_JOYSTICK
CONTROLLER_AXIS
CONTROLLER_BUTTON
CONTROLLER_UNKNOWN
CONTROLLER_JOYSTICK
CONTROLLER_AXIS
CONTROLLER_BUTTON
CONTROLLER_UNKNOWN

Constructor & Destructor Documentation

Controller() [1/2]

INDI::Controller::Controller

(

INDI::DefaultDevice *

cdevice

)

Controller Default ctor.

Parameters

cdevice

INDI::DefaultDevice device

~Controller() [1/2]

INDI::Controller::~Controller ( )

virtual

Controller() [2/2]

INDI::Controller::Controller

(

INDI::DefaultDevice *

cdevice

)

Controller Default ctor.

Parameters

cdevice

INDI::DefaultDevice device

~Controller() [2/2]

virtual INDI::Controller::~Controller ( )

virtual

Member Function Documentation

axisEvent() [1/2]

void INDI::Controller::axisEvent ( const char *  axis_n, int  value, void *  context  )

staticprotected

axisEvent() [2/2]

static void INDI::Controller::axisEvent ( const char *  axis_n, int  value, void *  context  )

staticprotected

buttonEvent() [1/2]

void INDI::Controller::buttonEvent ( const char *  button_n, int  value, void *  context  )

staticprotected

buttonEvent() [2/2]

static void INDI::Controller::buttonEvent ( const char *  button_n, int  value, void *  context  )

staticprotected

clearMap() [1/2]

void INDI::Controller::clearMap

(

)

clearMap clears all properties added previously by mapController()

clearMap() [2/2]

void INDI::Controller::clearMap

(

)

clearMap clears all properties added previously by mapController()

disableJoystick() [1/2]

void INDI::Controller::disableJoystick ( )

protected

disableJoystick() [2/2]

void INDI::Controller::disableJoystick ( )

protected

enableJoystick() [1/2]

void INDI::Controller::enableJoystick ( )

protected

enableJoystick() [2/2]

void INDI::Controller::enableJoystick ( )

protected

getControllerSetting() [1/2]

const char* INDI::Controller::getControllerSetting

(

const char *

name

)

getControllerSetting() [2/2]

const char * INDI::Controller::getControllerSetting

(

const char *

name

)

getControllerType() [1/2]

ControllerType INDI::Controller::getControllerType

(

const char *

name

)

getControllerType() [2/2]

Controller::ControllerType INDI::Controller::getControllerType

(

const char *

name

)

initProperties() [1/2]

bool INDI::Controller::initProperties ( )

virtual

initProperties() [2/2]

virtual bool INDI::Controller::initProperties ( )

virtual

ISGetProperties() [1/2]

void INDI::Controller::ISGetProperties ( const char *  dev )

virtual

ISGetProperties() [2/2]

virtual void INDI::Controller::ISGetProperties ( const char *  dev )

virtual

ISNewSwitch() [1/2]

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

virtual

ISNewSwitch() [2/2]

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

virtual

ISNewText() [1/2]

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

virtual

ISNewText() [2/2]

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

virtual

ISSnoopDevice() [1/2]

bool INDI::Controller::ISSnoopDevice ( XMLEle *  root )

virtual

ISSnoopDevice() [2/2]

virtual bool INDI::Controller::ISSnoopDevice ( XMLEle *  root )

virtual

joystickEvent() [1/2]

static void INDI::Controller::joystickEvent ( const char *  joystick_n, double  mag, double  angle, void *  context  )

staticprotected

joystickEvent() [2/2]

void INDI::Controller::joystickEvent ( const char *  joystick_n, double  mag, double  angle, void *  context  )

staticprotected

mapController() [1/2]

void INDI::Controller::mapController	(	const char *	propertyName,
		const char *	propertyLabel,
		ControllerType	type,
		const char *	initialValue
	)

mapController adds a new property to the joystick's settings.

Parameters

propertyName	Name
propertyLabel	Label
type	The input type of the property. This value cannot be updated.
initialValue	Initial value for the property.

mapController() [2/2]

void INDI::Controller::mapController	(	const char *	propertyName,
		const char *	propertyLabel,
		ControllerType	type,
		const char *	initialValue
	)

mapController adds a new property to the joystick's settings.

Parameters

propertyName	Name
propertyLabel	Label
type	The input type of the property. This value cannot be updated.
initialValue	Initial value for the property.

saveConfigItems() [1/2]

virtual bool INDI::Controller::saveConfigItems ( FILE *  fp )

virtual

saveConfigItems() [2/2]

bool INDI::Controller::saveConfigItems ( FILE *  fp )

virtual

setAxisCallback() [1/2]

void INDI::Controller::setAxisCallback

(

axisFunc

axisCallback

)

setAxisCallback Sets the callback function when a new axis input is detected.

Parameters

axisCallback

the callback function.

setAxisCallback() [2/2]

void INDI::Controller::setAxisCallback

(

axisFunc

axisCallback

)

setAxisCallback Sets the callback function when a new axis input is detected.

Parameters

axisCallback

the callback function.

setButtonCallback() [1/2]

void INDI::Controller::setButtonCallback

(

buttonFunc

buttonCallback

)

setButtonCallback Sets the callback function when a new button input is detected.

Parameters

buttonCallback

the callback function.

setButtonCallback() [2/2]

void INDI::Controller::setButtonCallback

(

buttonFunc

buttonCallback

)

setButtonCallback Sets the callback function when a new button input is detected.

Parameters

buttonCallback

the callback function.

setJoystickCallback() [1/2]

void INDI::Controller::setJoystickCallback

(

joystickFunc

joystickCallback

)

setJoystickCallback Sets the callback function when a new joystick input is detected.

Parameters

joystickCallback

the callback function.

setJoystickCallback() [2/2]

void INDI::Controller::setJoystickCallback

(

joystickFunc

joystickCallback

)

setJoystickCallback Sets the callback function when a new joystick input is detected.

Parameters

joystickCallback

the callback function.

updateProperties() [1/2]

bool INDI::Controller::updateProperties ( )

virtual

updateProperties() [2/2]

virtual bool INDI::Controller::updateProperties ( )

virtual

Member Data Documentation

axisCallbackFunc

axisFunc INDI::Controller::axisCallbackFunc

protected

buttonCallbackFunc

buttonFunc INDI::Controller::buttonCallbackFunc

protected

device

INDI::DefaultDevice * INDI::Controller::device

protected

joystickCallbackFunc

joystickFunc INDI::Controller::joystickCallbackFunc

protected

JoystickSettingT

IText * INDI::Controller::JoystickSettingT = nullptr

private

JoystickSettingTP

ITextVectorProperty INDI::Controller::JoystickSettingTP

private

UseJoystickS

ISwitch INDI::Controller::UseJoystickS

private

UseJoystickSP

ISwitchVectorProperty INDI::Controller::UseJoystickSP

private

---

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

• /home/nirva/insroot/include/libindi/indicontroller.h
• ln/3rdparty/src/indilib/indi-1.7.4/libindi/libs/indibase/indicontroller.cpp