Leosac::Module::Libgpiod::LibgpiodModule Class Reference

Handle GPIO management over libgpiod. More...

#include <LibgpiodModule.hpp>

Inheritance diagram for Leosac::Module::Libgpiod::LibgpiodModule:

Collaboration diagram for Leosac::Module::Libgpiod::LibgpiodModule:

Public Member Functions
	LibgpiodModule (zmqpp::context &ctx, zmqpp::socket *module_manager_pipe, const boost::property_tree::ptree &config, CoreUtilsPtr utils)
	~LibgpiodModule ()
	LibgpiodModule (const LibgpiodModule &)=delete
LibgpiodModule &	operator= (LibgpiodModule &&)=delete
void	publish_on_bus (zmqpp::message &msg)
	Write the message eon the bus. More...
std::shared_ptr< LibgpiodConfig >	general_config () const
	Retrieve the config object. More...
virtual void	run () override
	This is the main loop of the module. More...
Public Member Functions inherited from Leosac::Module::BaseModule
	BaseModule (zmqpp::context &ctx, zmqpp::socket *pipe, const boost::property_tree::ptree &cfg, CoreUtilsPtr utils)
	Constructor of BaseModule. More...
virtual	~BaseModule ()=default

Private Member Functions
void	process_config (const boost::property_tree::ptree &cfg)
	Process the configuration, preparing configured GPIO pin. More...
void	process_general_config ()
	General configuration (file paths, etc). More...

Private Attributes
zmqpp::socket	bus_push_
	Socket to write the bus. More...
std::vector< std::shared_ptr< LibgpiodPin > >	gpios_
	Vector of underlying pin object. More...
std::shared_ptr< LibgpiodConfig >	general_cfg_
	General configuration for module. More...

Additional Inherited Members
Protected Member Functions inherited from Leosac::Module::BaseModule
virtual void	handle_pipe ()
	The base class register the pipe_ socket to its reactor_ so that this function is called when the pipe_ is available from reading. More...
virtual void	handle_control ()
	Handle called when a message on the module's control socket arrives. More...
virtual void	dump_additional_config (zmqpp::message *out) const
	Dump additional configuration (for example module specific config file). More...
void	dump_config (ConfigManager::ConfigFormat fmt, zmqpp::message *out_msg) const
	Fills a message with the module's configuration information. More...
void	config_check (const std::string &obj_name, Leosac::Hardware::DeviceClass type)
	An helper that checks configuration the existence of some objects. More...
void	config_check (const std::string &obj_name)
	An helper that checks configuration the existence of some objects. More...
Protected Attributes inherited from Leosac::Module::BaseModule
zmqpp::context &	ctx_
	A reference to the ZeroMQ context in case you need it to create additional socket. More...
zmqpp::socket &	pipe_
	A reference to the pair socket that link back to the module manager. More...
boost::property_tree::ptree	config_
	The configuration tree passed to the start_module function. More...
CoreUtilsPtr	utils_
	Pointer to the core utils, which gives access to scheduler and others. More...
bool	is_running_
	Boolean indicating whether the main loop should run or not. More...
zmqpp::socket	control_
	Control REP socket. More...
zmqpp::reactor	reactor_
	The reactor object we poll() on in the main loop. More...
std::string	name_

Detailed Description

Handle GPIO management over libgpiod.

See also

Configuration Options for configuration information.

Definition at line 49 of file LibgpiodModule.hpp.

Constructor & Destructor Documentation

LibgpiodModule() [1/2]

LibgpiodModule::LibgpiodModule	(	zmqpp::context &	ctx,
		zmqpp::socket *	module_manager_pipe,
		const boost::property_tree::ptree &	config,
		CoreUtilsPtr	utils
	)

Definition at line 35 of file LibgpiodModule.cpp.

~LibgpiodModule()

LibgpiodModule::~LibgpiodModule

(

)

Definition at line 110 of file LibgpiodModule.cpp.

LibgpiodModule() [2/2]

Leosac::Module::Libgpiod::LibgpiodModule::LibgpiodModule ( const LibgpiodModule &  )

delete

Member Function Documentation

general_config()

std::shared_ptr< LibgpiodConfig > LibgpiodModule::general_config

(

)

const

Retrieve the config object.

Definition at line 127 of file LibgpiodModule.cpp.

operator=()

LibgpiodModule& Leosac::Module::Libgpiod::LibgpiodModule::operator= ( LibgpiodModule &&  )

delete

process_config()

void LibgpiodModule::process_config ( const boost::property_tree::ptree &  cfg )

private

Process the configuration, preparing configured GPIO pin.

Definition at line 66 of file LibgpiodModule.cpp.

process_general_config()

void LibgpiodModule::process_general_config ( )

private

General configuration (file paths, etc).

Definition at line 121 of file LibgpiodModule.cpp.

publish_on_bus()

void LibgpiodModule::publish_on_bus

(

zmqpp::message &

msg

)

Write the message eon the bus.

This is intended for use by the LibgpiodPin

Definition at line 116 of file LibgpiodModule.cpp.

run()

void LibgpiodModule::run ( )

overridevirtual

This is the main loop of the module.

It should only exit when receiving signal::stop on its pipe_ socket. This is completely handled by this base class. In case you override this, make sure you watch the pipe_ socket.

Reimplemented from Leosac::Module::BaseModule.

Definition at line 132 of file LibgpiodModule.cpp.

Member Data Documentation

bus_push_

zmqpp::socket Leosac::Module::Libgpiod::LibgpiodModule::bus_push_

private

Socket to write the bus.

Definition at line 89 of file LibgpiodModule.hpp.

general_cfg_

std::shared_ptr<LibgpiodConfig> Leosac::Module::Libgpiod::LibgpiodModule::general_cfg_

private

General configuration for module.

Definition at line 99 of file LibgpiodModule.hpp.

gpios_

std::vector<std::shared_ptr<LibgpiodPin> > Leosac::Module::Libgpiod::LibgpiodModule::gpios_

private

Vector of underlying pin object.

Definition at line 94 of file LibgpiodModule.hpp.

---

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

• src/modules/libgpiod/LibgpiodModule.hpp
• src/modules/libgpiod/LibgpiodModule.cpp