Documentation on setBrightness is incorrect

[apirek]

Subject of the issue

The documentation on HT16K33::setBrightness (

SparkFun_Alphanumeric_Display_Arduino_Library/src/SparkFun_Alphanumeric_Display.cpp

Line 325 in a399e8a

// Duty cycle valid between 0 (off) and 15 (full brightness)

) and in Example_04_SetBrightness (

SparkFun_Alphanumeric_Display_Arduino_Library/examples/Example_04_SetBrightness/Example_04_SetBrightness.ino

Line 38 in a399e8a

//So, acceptable inputs to this function are ints between 0 (display off) and 15 (full brightness)

) claim that a value 0 turns the display off.

This is incorrect, the value 0 specifies 1/16 duty cycle as per the datasheet, p.12 (https://www.holtek.com/documents/10179/116711/HT16K33v120.pdf).

Your workbench

• What development board or microcontroller are you using?
• What version of hardware or breakout board are you using?
• How is the breakout board wired to your microcontroller?
• How is everything being powered?
• Are there any additional details that may help us help you?

Steps to reproduce

display.setBrightness(0);, read datasheet.

Expected behavior

Documentation matches what the code does.

Actual behavior

Documentation does not match what the code does.

[sfe-SparkFro]

Thanks for the note, should be fixed in v2.2.6!