EdgeControl Namespace Reference

Functions
int8_t	init ()
	Initialize edge sensor control.
int8_t	dispose ()
	Dispose edge sensor control and release resources.
bool	isActive ()
	Check whether edge sensor control is initialized and active.
int8_t	enableControl ()
	Start the sensor listening thread.
int8_t	disableControl ()
	Stop the sensor listening thread.
std::vector< IrSensor >	getSensors ()
	Get all IR sensor values.
std::vector< IrSensor >	getSensors (GpioState state)
	Get IR sensors filtered by GPIO state.
float	getVersion ()
	Get current library version.

Function Documentation

disableControl()

int8_t EdgeControl::disableControl

(

)

Stop the sensor listening thread.

Returns

Status code:

• 0 : success
• 1 : not running
• -1 : not initialized

dispose()

int8_t EdgeControl::dispose

(

)

Dispose edge sensor control and release resources.

Returns

Status code:

• 0 : success
• 1 : not initialized
• -1..-6 : GPIO release failed (specific code indicates which GPIO failed)

Examples

EdgeControl/main.cpp.

enableControl()

int8_t EdgeControl::enableControl

(

)

Start the sensor listening thread.

Returns

Status code:

• 0 : success
• 1 : already running
• -1 : not initialized

Note

The initialize function enables the module on startup.

getSensors() [1/2]

std::vector< IrSensor > EdgeControl::getSensors

(

)

Get all IR sensor values.

Returns

Vector containing the current state of all IR sensors.

getSensors() [2/2]

std::vector< IrSensor > EdgeControl::getSensors

(

GpioState

state

)

Get IR sensors filtered by GPIO state.

Parameters

state

Desired GPIO state to filter by. 0 = no ground detected (free) 1 = ground detected

Returns

Vector containing sensors matching the specified state.

getVersion()

float EdgeControl::getVersion

(

)

Get current library version.

Original note: format 0.XYZ (3 digits after major).

Returns

Version as float.

Examples

EdgeControl/main.cpp.

init()

int8_t EdgeControl::init

(

)

Initialize edge sensor control.

Must be called before enabling control or reading sensors.

Returns

Status code:

• 0 : success
• <0 : error (implementation-defined)

Examples

EdgeControl/main.cpp.

isActive()

bool EdgeControl::isActive

(

)

Check whether edge sensor control is initialized and active.

Returns

true if active, false otherwise.