Constructor Detail

• SPI

  public SPI(SPI.Port port)

  Constructor

  Parameters:

  port - the physical SPI port

Method Detail

• free

  public void free()

  Free the resources used by this object

  Overrides:

  free in class SensorBase

• setClockRate

  public final void setClockRate(int hz)

  Configure the rate of the generated clock signal. The default value is 500,000 Hz. The maximum value is 4,000,000 Hz.

  Parameters:

  hz - The clock rate in Hertz.

• setMSBFirst

  public final void setMSBFirst()

  Configure the order that bits are sent and received on the wire to be most significant bit first.

• setLSBFirst

  public final void setLSBFirst()

  Configure the order that bits are sent and received on the wire to be least significant bit first.

• setClockActiveLow

  public final void setClockActiveLow()

  Configure the clock output line to be active low. This is sometimes called clock polarity high or clock idle high.

• setClockActiveHigh

  public final void setClockActiveHigh()

  Configure the clock output line to be active high. This is sometimes called clock polarity low or clock idle low.

• setSampleDataOnFalling

  public final void setSampleDataOnFalling()

  Configure that the data is stable on the falling edge and the data changes on the rising edge.

• setSampleDataOnRising

  public final void setSampleDataOnRising()

  Configure that the data is stable on the rising edge and the data changes on the falling edge.

• setChipSelectActiveHigh

  public final void setChipSelectActiveHigh()

  Configure the chip select line to be active high.

• setChipSelectActiveLow

  public final void setChipSelectActiveLow()

  Configure the chip select line to be active low.

• write

  public int write(byte[] dataToSend,
                   int size)

  Write data to the slave device. Blocks until there is space in the output FIFO. If not running in output only mode, also saves the data received on the MISO input during the transfer into the receive FIFO.

• read

  public int read(boolean initiate,
                  byte[] dataReceived,
                  int size)

  Read a word from the receive FIFO. Waits for the current transfer to complete if the receive FIFO is empty. If the receive FIFO is empty, there is no active transfer, and initiate is false, errors.

  Parameters:

  initiate - If true, this function pushes "0" into the transmit buffer and initiates a transfer. If false, this function assumes that data is already in the receive FIFO from a previous write.

• transaction

  public int transaction(byte[] dataToSend,
                         byte[] dataReceived,
                         int size)

  Perform a simultaneous read/write transaction with the device

  Parameters:

  dataToSend - The data to be written out to the device

  dataReceived - Buffer to receive data from the device

  size - The length of the transaction, in bytes