RADLib
RADical C++ application framework
RADDevice::PwmChannel Class Reference

PWM sysfs channel helper. More...

#include <RADDevice.h>

Public Member Functions

 PwmChannel (int chip, int channel, DevicePaths paths={})
 Creates a PWM channel wrapper. More...
 
bool exportChannel (std::string *error=nullptr) const
 Exports the PWM channel. More...
 
bool setEnabled (bool enabled, std::string *error=nullptr) const
 Enables or disables output. More...
 
bool setPeriodNs (uint64_t periodNs, std::string *error=nullptr) const
 Sets period in nanoseconds. More...
 
bool setDutyCycleNs (uint64_t dutyNs, std::string *error=nullptr) const
 Sets duty cycle in nanoseconds. More...
 
std::string channelPath () const
 Returns sysfs PWM path. More...
 

Detailed Description

PWM sysfs channel helper.

Constructor & Destructor Documentation

◆ PwmChannel()

RADDevice::PwmChannel::PwmChannel ( int  chip,
int  channel,
DevicePaths  paths = {} 
)

Creates a PWM channel wrapper.

Member Function Documentation

◆ channelPath()

std::string RADDevice::PwmChannel::channelPath ( ) const

Returns sysfs PWM path.

◆ exportChannel()

bool RADDevice::PwmChannel::exportChannel ( std::string *  error = nullptr) const

Exports the PWM channel.

◆ setDutyCycleNs()

bool RADDevice::PwmChannel::setDutyCycleNs ( uint64_t  dutyNs,
std::string *  error = nullptr 
) const

Sets duty cycle in nanoseconds.

◆ setEnabled()

bool RADDevice::PwmChannel::setEnabled ( bool  enabled,
std::string *  error = nullptr 
) const

Enables or disables output.

◆ setPeriodNs()

bool RADDevice::PwmChannel::setPeriodNs ( uint64_t  periodNs,
std::string *  error = nullptr 
) const

Sets period in nanoseconds.


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