isobus-docs/spi__hardware__plugin_8hpp_source.html

//================================================================================================

//================================================================================================


#ifndef SPI_HARDWARE_PLUGIN_HPP

#define SPI_HARDWARE_PLUGIN_HPP


#include "isobus/hardware_integration/spi_transaction_frame.hpp"


#include <cstdint>

#include <vector>


namespace isobus

{

    //================================================================================================

    //================================================================================================


    class SPIHardwarePlugin

    {

    public:

        virtual void begin_transaction(){};


        virtual void transmit(SPITransactionFrame *frame) = 0;


        virtual bool end_transaction() = 0;

    };


}

#endif // SPI_HARDWARE_PLUGIN_HPP

isobus::SPIHardwarePlugin
An abstract base class for SPI communication.
Definition spi_hardware_plugin.hpp:27

isobus::SPIHardwarePlugin::transmit
virtual void transmit(SPITransactionFrame *frame)=0
Write a frame to the SPI bus. This should only be called after begin_transaction()....

isobus::SPIHardwarePlugin::begin_transaction
virtual void begin_transaction()
Begin a transaction on the SPI bus. This should be called before any of the read/write operations.
Definition spi_hardware_plugin.hpp:32

isobus::SPIHardwarePlugin::end_transaction
virtual bool end_transaction()=0
End a transaction on the SPI bus. This must be called after all write operations and before any read ...

isobus::SPITransactionFrame
A class containing the data for a single SPI transaction.
Definition spi_transaction_frame.hpp:24

isobus
This namespace encompasses all of the ISO11783 stack's functionality to reduce global namespace pollu...
Definition can_address_claim_state_machine.hpp:17

spi_transaction_frame.hpp
A class containing the data for a single SPI transaction. Used in combination with SPIHardwarePlugin ...