libgpiod  2.0.1
Data Structures
C++ bindings

C++ bindings for libgpiod. More...

Data Structures

class  gpiod::chip_info
 Represents an immutable snapshot of GPIO chip information. More...
 
class  gpiod::chip
 Represents a GPIO chip. More...
 
class  gpiod::edge_event_buffer
 Object into which edge events are read for better performance. More...
 
class  gpiod::edge_event
 Immutable object containing data about a single edge event. More...
 
class  gpiod::chip_closed
 Exception thrown when an already closed chip is used. More...
 
class  gpiod::info_event
 Immutable object containing data about a single line info event. More...
 
class  gpiod::line_config
 Contains a set of line config options used in line requests and reconfiguration. More...
 
class  gpiod::line_info
 Contains an immutable snapshot of the line's state at the time when the object of this class was instantiated. More...
 
class  gpiod::line_request
 Stores the context of a set of requested GPIO lines. More...
 
class  gpiod::line_settings
 Stores GPIO line settings. More...
 
class  gpiod::line::offset
 Wrapper around unsigned int for representing line offsets. More...
 
class  gpiod::request_builder
 Intermediate object storing the configuration for a line request. More...
 
class  gpiod::request_config
 Stores a set of options passed to the kernel when making a line request. More...
 
class  gpiod::timestamp
 Stores the edge and info event timestamps as returned by the kernel and allows to convert them to std::chrono::time_point. More...
 
bool gpiod::is_gpiochip_device (const ::std::filesystem::path &path)
 Check if the file pointed to by path is a GPIO chip character device. More...
 
const ::std::string & gpiod::api_version ()
 Get the human readable version string for libgpiod API. More...
 

Detailed Description

C++ bindings for libgpiod.

Function Documentation

◆ api_version()

const ::std::string& gpiod::api_version ( )

Get the human readable version string for libgpiod API.

Returns
String containing the library version.

◆ is_gpiochip_device()

bool gpiod::is_gpiochip_device ( const ::std::filesystem::path &  path)

Check if the file pointed to by path is a GPIO chip character device.

Parameters
pathPath to check.
Returns
True if the file exists and is a GPIO chip character device or a symbolic link to it.