interact with controller V1 devices More...

#include <ControllerV1.h>

Public Member Functions
	ControllerV1 (int controllerFeatures=0)
	create a new ControllerV1 controller
int	getControllerType () const override
	int value of the controller class version
std::pair< int, int >	getXVersion () const
	get the firmware xinput mode version
std::pair< int, int >	getKVersion () const
	get the firmware keyboard mode version
bool	readConfig () override
	read the whole configuration
bool	writeConfig () const override
	write the configuration
bool	setButton (Button btn, const std::string &key) const override
	set a new `key` for the button `btn`
std::string	getButton (Button btn) const override
	get the current key of button `btn`
bool	setBackButton (int num, int slot, const std::string &key) const override
	set a new `key` in slot `slot` for back button `num`
std::string	getBackButton (int num, int slot) const override
	get the current key in slot `slot` of back button `num`
void	setBackButtonStartTime (int num, int slot, int timeMs) const override
	set start time for key in slot `slot` of back button `num`
int	getBackButtonStartTime (int num, int slot) const override
	get start time for key in slot `slot` of back button `num`
void	setRumble (RumbleMode mode) const override
	set vibration intensity
RumbleMode	getRumbleMode () const override
	get current vibration intesity
void	setLedMode (LedMode mode) const override
	set led mode
LedMode	getLedMode () const override
	get current led mode
void	setLedColor (int r, int g, int b) const override
	set a custom color for the leds
std::tuple< int, int, int >	getLedColor () const override
	get current led custom color
void	setAnalogCenter (int center, bool left) const override
	set the analog stick offset from center (deadzone)
int	getAnalogCenter (bool left) const override
	get the current analog stick offset from center (deadzone)
void	setAnalogBoundary (int boundary, bool left) const override
	set the analog stick boundary offset (circularity)
int	getAnalogBoundary (bool left) const override
	get the current analog stick boundary offset (circularity)
Public Member Functions inherited from OWC::Controller
void	enableLogging (const std::function< void(const std::wstring &)> &logCB)
	Enable log messages.
bool	init ()
	Initialize the controller.
bool	hasFeature (int feature) const
	Check if `feature` is enabled for this controller.

Detailed Description

interact with controller V1 devices

Constructor & Destructor Documentation

◆ ControllerV1()

OWC::ControllerV1::ControllerV1 ( int controllerFeatures = 0 )

explicit

create a new ControllerV1 controller

Parameters

controllerFeatures ControllerFeature flag

Member Function Documentation

◆ getAnalogBoundary()

int OWC::ControllerV1::getAnalogBoundary ( bool left ) const

nodiscardoverridevirtual

get the current analog stick boundary offset (circularity)

Parameters

left	flag indicating to which analog this setting applies to (left or right)

Returns: boundary offset

Implements OWC::Controller.

◆ getAnalogCenter()

int OWC::ControllerV1::getAnalogCenter ( bool left ) const

nodiscardoverridevirtual

get the current analog stick offset from center (deadzone)

Parameters

left	flag indicating to which analog this setting applies to (left or right)

Returns: center offset

Implements OWC::Controller.

◆ getBackButton()

std::string OWC::ControllerV1::getBackButton	(	int	num,
		int	slot ) const

nodiscardoverridevirtual

get the current key in slot slot of back button num

num is the order of appearance in firmware config

See also: https://github.com/OpenWinControls/libOpenWinControls/tree/main/docs

Parameters

num	back button number (1,2 ..)
slot	back button key slot

Returns: one of HIDUsageIDMap or XinputUsageIDMap values

Implements OWC::Controller.

◆ getBackButtonStartTime()

int OWC::ControllerV1::getBackButtonStartTime	(	int	num,
		int	slot ) const

nodiscardoverridevirtual

get start time for key in slot slot of back button num

num is the order of appearance in firmware config

See also: https://github.com/OpenWinControls/libOpenWinControls/tree/main/docs

Parameters

num	back button number (1,2 ..)
slot	back button key slot

Returns: start time in milliseconds

Implements OWC::Controller.

◆ getButton()

std::string OWC::ControllerV1::getButton ( Button btn ) const

nodiscardoverridevirtual

get the current key of button btn

Parameters

btn	the controller button to read

Returns: one of HIDUsageIDMap or XinputUsageIDMap values

Implements OWC::Controller.

◆ getControllerType()

int OWC::ControllerV1::getControllerType ( ) const

inlinenodiscardoverridevirtual

int value of the controller class version

Returns: controller type (1,2, ..)

Implements OWC::Controller.

◆ getKVersion()

std::pair< int, int > OWC::ControllerV1::getKVersion ( ) const

inlinenodiscard

get the firmware keyboard mode version

Returns: major and minor version as a pair

◆ getLedColor()

std::tuple< int, int, int > OWC::ControllerV1::getLedColor ( ) const

nodiscardoverridevirtual

get current led custom color

returned color is valid only when mode is one of LedMode::Solid or LedMode::Breathe

Returns: red,green,blue values of the color as tuple

Implements OWC::Controller.

◆ getLedMode()

LedMode OWC::ControllerV1::getLedMode ( ) const

nodiscardoverridevirtual

get current led mode

Returns: LedMode

Implements OWC::Controller.

◆ getRumbleMode()

RumbleMode OWC::ControllerV1::getRumbleMode ( ) const

nodiscardoverridevirtual

get current vibration intesity

Returns: RumbleMode

Implements OWC::Controller.

◆ getXVersion()

std::pair< int, int > OWC::ControllerV1::getXVersion ( ) const

inlinenodiscard

get the firmware xinput mode version

Returns: major and minor version as a pair

◆ readConfig()

bool OWC::ControllerV1::readConfig ( )

nodiscardoverridevirtual

read the whole configuration

Returns: true on success

Implements OWC::Controller.

◆ setAnalogBoundary()

void OWC::ControllerV1::setAnalogBoundary	(	int	boundary,
		bool	left ) const

overridevirtual

set the analog stick boundary offset (circularity)

Parameters

boundary	offset
left	flag indicating to which analog this setting applies to (left or right)

Implements OWC::Controller.

◆ setAnalogCenter()

void OWC::ControllerV1::setAnalogCenter	(	int	center,
		bool	left ) const

overridevirtual

set the analog stick offset from center (deadzone)

Parameters

center	offset
left	flag indicating to which analog this setting applies to (left or right)

Implements OWC::Controller.

◆ setBackButton()

bool OWC::ControllerV1::setBackButton	(	int	num,
		int	slot,
		const std::string &	key ) const

nodiscardoverridevirtual

set a new key in slot slot for back button num

num is the order of appearance in firmware config

See also: https://github.com/OpenWinControls/libOpenWinControls/tree/main/docs

Parameters

num	back button number (1,2, ..)
slot	back button key slot
key	one of HIDUsageIDMap or XinputUsageIDMap values (case insensitive)

Returns: true on success

Implements OWC::Controller.

◆ setBackButtonStartTime()

void OWC::ControllerV1::setBackButtonStartTime	(	int	num,
		int	slot,
		int	timeMs ) const

overridevirtual

set start time for key in slot slot of back button num

num is the order of appearance in firmware config

See also: https://github.com/OpenWinControls/libOpenWinControls/tree/main/docs

Parameters

num	back button number (1,2 ..)
slot	back button key slot
timeMs	start time in milliseconds

Implements OWC::Controller.

◆ setButton()

bool OWC::ControllerV1::setButton	(	Button	btn,
		const std::string &	key ) const

nodiscardoverridevirtual

set a new key for the button btn

Parameters

btn	the controller button to remap
key	one of HIDUsageIDMap or XinputUsageIDMap values (case insensitive)

Returns: true on success

Implements OWC::Controller.

◆ setLedColor()

void OWC::ControllerV1::setLedColor	(	int	r,
		int	g,
		int	b ) const

overridevirtual

set a custom color for the leds

has no effect for modes other than LedMode::Solid and LedMode::Breathe

Parameters

r	red value of the color
g	green value of the color
b	blue value of the color

Implements OWC::Controller.

◆ setLedMode()

void OWC::ControllerV1::setLedMode ( LedMode mode ) const

overridevirtual

set led mode

Parameters

mode	one of LedMode

Implements OWC::Controller.

◆ setRumble()

void OWC::ControllerV1::setRumble ( RumbleMode mode ) const

overridevirtual

set vibration intensity

Parameters

mode	one of RumbleMode

Implements OWC::Controller.

◆ writeConfig()

bool OWC::ControllerV1::writeConfig ( ) const

nodiscardoverridevirtual

write the configuration

Returns: true on success

Implements OWC::Controller.

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

src/controller/ControllerV1.h
src/controller/ControllerV1.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ControllerV1()

Member Function Documentation

◆ getAnalogBoundary()

◆ getAnalogCenter()

◆ getBackButton()

◆ getBackButtonStartTime()

◆ getButton()

◆ getControllerType()

◆ getKVersion()

◆ getLedColor()

◆ getLedMode()

◆ getRumbleMode()

◆ getXVersion()

◆ readConfig()

◆ setAnalogBoundary()

◆ setAnalogCenter()

◆ setBackButton()

◆ setBackButtonStartTime()

◆ setButton()

◆ setLedColor()

◆ setLedMode()

◆ setRumble()

◆ writeConfig()