IoAbstraction
Public Member Functions | List of all members
AnalogJoystickToButtons Class Reference
Inheritance diagram for AnalogJoystickToButtons:
BasicIoAbstraction

Public Member Functions

 AnalogJoystickToButtons (AnalogDevice *device, pinid_t pin, float centre)
 
uint8_t readValue (pinid_t pin) override
 
uint8_t readPort (pinid_t pin) override
 
bool runLoop () override
 
void pinDirection (pinid_t pin, uint8_t mode) override
 
bool hasErrorOccurred () const
 
void writeValue (pinid_t pin, uint8_t value) override
 
void writePort (pinid_t pin, uint8_t portVal) override
 
- Public Member Functions inherited from BasicIoAbstraction
uint8_t digitalRead (pinid_t p)
 
void digitalWrite (pinid_t p, uint8_t v)
 
uint8_t digitalReadS (pinid_t p)
 
void digitalWriteS (pinid_t p, uint8_t v)
 
void writePortS (pinid_t p, uint8_t v)
 
uint8_t readPortS (pinid_t p)
 
void pinMode (pinid_t pin, uint8_t mode)
 
bool sync ()
 
virtual void attachInterrupt (pinid_t pin, RawIntHandler interruptHandler, uint8_t mode)
 

Member Function Documentation

◆ readValue()

uint8_t AnalogJoystickToButtons::readValue ( pinid_t  pin)
inlineoverridevirtual

Reads a value from a pin for this abstraction as per digitalRead. For serial devices may need a sync first.

Parameters
pinthe pin to be read

Reimplemented from BasicIoAbstraction.

◆ readPort()

uint8_t AnalogJoystickToButtons::readPort ( pinid_t  pin)
inlineoverridevirtual

Reads a whole port at once, on Arduino pins this is achieved by providing any pin within that port. On Arduino pins you should take care not to use ports that are providing core functions.

Parameters
pinthe pin determines the hardware port to use.
Returns
the 8 bit value read from the port.

Reimplemented from BasicIoAbstraction.

◆ runLoop()

bool AnalogJoystickToButtons::runLoop ( )
inlineoverridevirtual

This method is not needed on Arduino pins, but for most serial implementations it causes the device and abstraction to be synced. Returns true if the write call worked, normally true, false indicates error

Reimplemented from BasicIoAbstraction.

◆ pinDirection()

void AnalogJoystickToButtons::pinDirection ( pinid_t  pin,
uint8_t  mode 
)
inlineoverridevirtual

sets the pin direction for a pin controlled by this abstraction - as per pinMode

Parameters
pinthe pin to be changed
modethe new mode, as per pinMode (or on Mbed you can use PinMode enum values)

Reimplemented from BasicIoAbstraction.

◆ writeValue()

void AnalogJoystickToButtons::writeValue ( pinid_t  pin,
uint8_t  value 
)
inlineoverridevirtual

Writes a value to a pin on this abstraction, as per digitalWrite. For serial devices, may need a sync first.

Parameters
pinthe pin to be written to
valuethe new value such as HIGH / LOW

Reimplemented from BasicIoAbstraction.

◆ writePort()

void AnalogJoystickToButtons::writePort ( pinid_t  pin,
uint8_t  portVal 
)
inlineoverridevirtual

Writes out a whole port at once, on Arduino pins this is achieved by providing any pin within that port. On Arduino pins you should take care not to use ports that are providing core functions.

Parameters
pinthe pin determines the hardware port to use.
portValthe 8 bit value to write to the port. Use with care.

Reimplemented from BasicIoAbstraction.


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