Library Instantiation

These functions set up the library for use and should be called as required.

begin() Mandatory

bool begin(uint32_t flashChipSize = 0)

Parameters Optional

uint32_t flashChipSize

Refer to Using with non-supported flash memory

What it does

Returns boolean

The function returns TRUE if successfully executed and FALSE if otherwise.

  • Must be called at the start in void setup(). This function detects the type of chip being used and sets parameters accordingly.
  • This function is essential to the functioning of the library and must be called before any other calls are made to the library.

Example code

#include <SPIMemory.h>

SPIFlash flash;

void setup() {
  flash.begin();  // This function has to be called first - before any other functions
                  // from this library are called
  ...
}

void loop() {
  ...
}

Advanced use flashChipSize

Using with non-supported flash memory

  • An optional flashChipSize parameter can be declared as an argument with this function (if library version > v2.6.0)
  • In an instance where the library is being used with a flash memory chip that is not officially supported by the Library, declaring the chip storage size in bytes as the flashChipSize parameter can - in many instances - enable the library to work with the chip
#include <SPIMemory.h>

SPIFlash flash;

void setup() {
  flash.begin(MB(32));  // This sets the flash chip size to 32 Megabytes
                        // - Refer to defines.h for the expansion of the MB(32) macro
  ...
}

void loop() {
  ...
}

setClock() Advanced use only: Use with care

void setClock(uint32_t clockSpeed)

Parameters Mandatory

uint32_t clockSpeed

A 32 bit unsigned integer that represents SPI Clock Speed in Hertz

What it does

Returns Nothing

  • This is an optional function and is used to set the SPI clock speed for all further comms using the library.
  • If required, this function must be called straight after begin().
  • This function takes a 32-bit value (in Hertz) as replacement for the default maximum clock speed (104MHz for Winbond NOR flash) thereby initiating future SPI transactions with the user-defined clock speed.

Example code

#include <SPIMemory.h>

SPIFlash flash;

void setup() {
  flash.begin();
  flash.setClock(20000000);     // this sets the clock spped to 20,000,000 Hz - i.e. 20MHz
  ...
}

void loop() {
  ...
}

Advanced use N/A