SensorLib 0.5.0
Multi-platform sensor driver library for Arduino, PlatformIO, and ESP-IDF
Loading...
Searching...
No Matches
SPIParam Class Reference

SPI communication parameters. More...

#include <SensorCommBase.hpp>

Inheritance diagram for SPIParam:
[legend]

Public Member Functions

 SPIParam (SPISettings setting)
 Construct an SPI parameter object from an SPISettings.
 
SPISettings getSetting () const
 Retrieve the stored SPI settings.
 
- Public Member Functions inherited from CommParamsBase
virtual ~CommParamsBase ()=default
 

Detailed Description

SPI communication parameters.

Wraps an SPISettings object.

Definition at line 186 of file SensorCommBase.hpp.

Constructor & Destructor Documentation

◆ SPIParam()

SPIParam::SPIParam ( SPISettings  setting)
inline

Construct an SPI parameter object from an SPISettings.

Parameters
settingThe SPI configuration to use.

Definition at line 196 of file SensorCommBase.hpp.

Member Function Documentation

◆ getSetting()

SPISettings SPIParam::getSetting ( ) const
inline

Retrieve the stored SPI settings.

Returns
SPISettings The current SPI configuration.

Definition at line 202 of file SensorCommBase.hpp.


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