OpenSourceSimWheelESP32
Open-source wireless steering wheel/button box for ESP32 boards
Loading...
Searching...
No Matches
ShiftRegistersInput Class Reference

State of switches connected to PISO shift registers. More...

#include <InputHardware.hpp>

Public Member Functions

 ShiftRegistersInput (OutputGPIO loadPin, OutputGPIO nextPin, InputGPIO inputPin, const ShiftRegisterChain &chain, InputNumber SER_inputNumber=UNSPECIFIED::VALUE, const bool loadHighOrLow=false, const bool nextHighToLowOrLowToHigh=false, const bool negativeLogic=true)
 Construct a new Shift Registers Input object.
 
virtual uint64_t read (uint64_t lastState) override
 Read the current state of the inputs (pressed or released)
 
- Public Member Functions inherited from DigitalInput

Additional Inherited Members

- Public Attributes inherited from DigitalInput
uint64_t mask = ~0ULL
 Input mask. For read-only.
 
- Protected Member Functions inherited from DigitalInput
void addToMask (uint64_t bitmap)
 Add an input bitmap to the current mask.
 

Detailed Description

State of switches connected to PISO shift registers.

Definition at line 399 of file InputHardware.hpp.

Constructor & Destructor Documentation

◆ ShiftRegistersInput()

ShiftRegistersInput::ShiftRegistersInput ( OutputGPIO loadPin,
OutputGPIO nextPin,
InputGPIO inputPin,
const ShiftRegisterChain & chain,
InputNumber SER_inputNumber = UNSPECIFIED::VALUE,
const bool loadHighOrLow = false,
const bool nextHighToLowOrLowToHigh = false,
const bool negativeLogic = true )

Construct a new Shift Registers Input object.

Parameters
loadPinGPIO number of the load pin
nextPinGPIO number of the next/clock pin
inputPinGPIO number of the serial output pin
chainChain of PISO shift registers
SER_inputNumberInput number assigned to the SER pin in the last chip of the chain.
loadHighOrLowIf true, parallel inputs are loaded when loadPinis HIGH. If false, parallel inputs are loaded when loadPinis LOW.
nextHighToLowOrLowToHighIf true, next bit is selected when an high-to-low pulse is detected at nextPin. If false, next bit is selected when a low-to-high pulse is detected.
negativeLogicIf true, all switches must be pulled down (the default), If false, all switches must be pulled up (positive logic).

Member Function Documentation

◆ read()

virtual uint64_t ShiftRegistersInput::read ( uint64_t lastState)
overridevirtual

Read the current state of the inputs (pressed or released)

Warning
This function must not set any bit outside of the input bitmask in the return value.
Parameters
lastStateState of the same inputs as recorded in the previous iteration. Whether the current state is unknown, lastState must be returned (properly masked). Must be set to zero at first call.
Returns
uint64_t Current state of the inputs (a bit set to 1 means a pressed button).

Implements DigitalInput.


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