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

Customisation point for low‑level GPIO callbacks. More...

#include <SensorCommBase.hpp>

Inheritance diagram for SensorHalCustom:
[legend]

Public Types

using CustomWrite = void(*)(uint8_t pin, uint8_t level)
 Set pin level (0/1)
 
using CustomRead = uint8_t(*)(uint8_t pin)
 Read pin level.
 
using CustomMode = void(*)(uint8_t pin, uint8_t mode)
 Set pin mode (INPUT/OUTPUT, etc.)
 

Public Member Functions

 SensorHalCustom ()
 
void setCustomWrite (CustomWrite callback)
 Set a custom digitalWrite implementation.
 
void setCustomRead (CustomRead callback)
 Set a custom digitalRead implementation.
 
void setCustomMode (CustomMode callback)
 Set a custom pinMode implementation.
 

Protected Attributes

CustomWrite writeCallback
 Custom digitalWrite, nullptr if not set.
 
CustomRead readCallback
 Custom digitalRead, nullptr if not set.
 
CustomMode modeCallback
 Custom pinMode, nullptr if not set.
 

Detailed Description

Customisation point for low‑level GPIO callbacks.

Allows injection of user‑defined functions for pin manipulation.

Definition at line 421 of file SensorCommBase.hpp.

Member Typedef Documentation

◆ CustomMode

using SensorHalCustom::CustomMode = void(*)(uint8_t pin, uint8_t mode)

Set pin mode (INPUT/OUTPUT, etc.)

Definition at line 427 of file SensorCommBase.hpp.

◆ CustomRead

using SensorHalCustom::CustomRead = uint8_t(*)(uint8_t pin)

Read pin level.

Definition at line 426 of file SensorCommBase.hpp.

◆ CustomWrite

using SensorHalCustom::CustomWrite = void(*)(uint8_t pin, uint8_t level)

Set pin level (0/1)

Definition at line 425 of file SensorCommBase.hpp.

Constructor & Destructor Documentation

◆ SensorHalCustom()

SensorHalCustom::SensorHalCustom ( )
inline

Definition at line 429 of file SensorCommBase.hpp.

Member Function Documentation

◆ setCustomMode()

void SensorHalCustom::setCustomMode ( CustomMode  callback)
inline

Set a custom pinMode implementation.

Parameters
callbackFunction pointer to be used as pinMode.

Definition at line 453 of file SensorCommBase.hpp.

References modeCallback.

◆ setCustomRead()

void SensorHalCustom::setCustomRead ( CustomRead  callback)
inline

Set a custom digitalRead implementation.

Parameters
callbackFunction pointer to be used as digitalRead.

Definition at line 444 of file SensorCommBase.hpp.

References readCallback.

◆ setCustomWrite()

void SensorHalCustom::setCustomWrite ( CustomWrite  callback)
inline

Set a custom digitalWrite implementation.

Parameters
callbackFunction pointer to be used as digitalWrite.

Definition at line 435 of file SensorCommBase.hpp.

References writeCallback.

Member Data Documentation

◆ modeCallback

CustomMode SensorHalCustom::modeCallback
protected

Custom pinMode, nullptr if not set.

Definition at line 461 of file SensorCommBase.hpp.

Referenced by SensorCommCustomHal::pinMode(), and setCustomMode().

◆ readCallback

CustomRead SensorHalCustom::readCallback
protected

Custom digitalRead, nullptr if not set.

Definition at line 460 of file SensorCommBase.hpp.

Referenced by SensorCommCustomHal::digitalRead(), and setCustomRead().

◆ writeCallback

CustomWrite SensorHalCustom::writeCallback
protected

Custom digitalWrite, nullptr if not set.

Definition at line 459 of file SensorCommBase.hpp.

Referenced by SensorCommCustomHal::digitalWrite(), and setCustomWrite().


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