C++ bindings

Data Structures
class	gpiod::chip
	Represents a GPIO chip. More...
struct	gpiod::line_request
	Stores the configuration for line requests. More...
class	gpiod::line
	Represents a single GPIO line. More...
struct	gpiod::line_event
	Describes a single GPIO line event. More...
class	gpiod::line_bulk
	Represents a set of GPIO lines. More...
class	gpiod::chip_iter
	Allows to iterate over all GPIO chips present on the system. More...
class	gpiod::line_iter
	Allows to iterate over all lines owned by a GPIO chip. More...

Functions
GPIOD_API line	gpiod::find_line (const ::std::string &name)
	Find a GPIO line by name. More...
GPIOD_API chip_iter	gpiod::make_chip_iter (void)
	Create a new chip_iter. More...
GPIOD_API chip_iter	gpiod::begin (chip_iter iter) noexcept
	Support for range-based loops for chip iterators. More...
GPIOD_API chip_iter	gpiod::end (const chip_iter &iter) noexcept
	Support for range-based loops for chip iterators. More...
GPIOD_API line_iter	gpiod::begin (line_iter iter) noexcept
	Support for range-based loops for line iterators. More...
GPIOD_API line_iter	gpiod::end (const line_iter &iter) noexcept
	Support for range-based loops for line iterators. More...

Detailed Description

Function Documentation

begin() [1/2]

GPIOD_API chip_iter gpiod::begin ( chip_iter  iter )

noexcept

Support for range-based loops for chip iterators.

Parameters

iter	A chip iterator.

Returns

Iterator unchanged.

begin() [2/2]

GPIOD_API line_iter gpiod::begin ( line_iter  iter )

noexcept

Support for range-based loops for line iterators.

Parameters

iter	A line iterator.

Returns

Iterator unchanged.

end() [1/2]

GPIOD_API chip_iter gpiod::end ( const chip_iter &  iter )

noexcept

Support for range-based loops for chip iterators.

Parameters

iter	A chip iterator.

Returns

New end iterator.

end() [2/2]

GPIOD_API line_iter gpiod::end ( const line_iter &  iter )

noexcept

Support for range-based loops for line iterators.

Parameters

iter	A line iterator.

Returns

New end iterator.

find_line()

GPIOD_API line gpiod::find_line

(

const ::std::string &

name

)

Find a GPIO line by name.

Search all GPIO chips present on the system.

Parameters

name	Name of the line.

Returns

Returns a line object - empty if the line was not found.

make_chip_iter()

GPIOD_API chip_iter gpiod::make_chip_iter

(

void

)

Create a new chip_iter.

Returns

New chip iterator object pointing to the first GPIO chip on the system.

Note

This function is needed as we already use the default constructor of gpiod::chip_iter as the return value of gpiod::end.