The controller_configuration

Check the sakurajin::controller_configuration for more infomation about its functions or look for the Examples.

This tutorial explains some of the fields of the sakurajin::controller_configuration and how to use it properly. All the attributes are explained on the page for the sakurajin::controller_configuration, look there if anything is missing. On this page each option also lists when it was introduced.

Required choices/options

To determine the required options there are a few choices that need to be made.

SPI configuration

First off you need to choose between Hardware SPI and Software SPI. You can find more information about it on this page.

If you choose Software SPI you need to set the following options:

• sakurajin::controller_configuration.SPI_MOSI The pin that handles the Master Out Slave In Signal (since 1.7.2)
• sakurajin::controller_configuration.SPI_CLK The pin that handles the Clock Signal (since 1.7.2)
• sakurajin::controller_configuration.useHardwareSpi must be false (the default value) (since 1.7.2)

If you choose hardware SPI the following option need to be set:

• sakurajin::controller_configuration.useHardwareSpi must be true (since 1.7.2)

Multi Row configuration

First off this decision has to be made even if there is only one row (in that case it does not matter which one since they behave the same). For the multi row support you have to decide between virtual multi row or real multi row. You can read the page on multi row for more information on how this works.

Virtual multi row is the default and the enabled mode when no changes are mode from previous versions. For virtual multi row you have to set the following options:

• sakurajin::controller_configuration.SPI_CS The pin that enables the SPI transfer to the Matrix (since 1.7.2)
• sakurajin::controller_configuration.virtual_multi_row must be true (the default value) (since 2.0.0)

For real multi row the following option have to be set:

• sakurajin::controller_configuration.virtual_multi_row must be false (since 2.0.0)
• sakurajin::controller_configuration.row_SPI_CS has to be set. Each index has to differ from 0 and needs to be set (since 2.0.0)

If you only have one row you can set either SPI_CS or row_SPI_CS[0] and you can ignore virtual_multi_row.

Optional choices/options

The following options are optional and the default value should work fine in most cases.

• sakurajin::controller_configuration.debug_output Enables debug output via Serial.println (needs initilisation since that is not done by this library) (default: false) (since 2.0.0)
• sakurajin::controller_configuration.spiTransferSpeed Sets the transfer speed of the SPI Interface when hardware SPI is used (default: 8000000) (since 2.0.0)
• sakurajin::controller_configuration.onlySendOnChange When this option is set the sakurajin::LedController only sends needed changes (default: true) (since 2.0.0)
• sakurajin::controller_configuration.IntensityLevel The brightness all of the segments should have (default: 1) (since 1.7.2)

Removed choices/options

The following options where removed at some point.

• rows Lists the number of rows (only existing 1.7.2)
• row_SPI_CS has been changed from pointer to an actual array with fixed size (only existing 1.7.2)