LiquidCrystal::begin() documentation update request

[wolfman1138]

Hi Folks,

I ran across an interesting 1 line LCD display that had 5x10 characters instead of the normal 5x8.

I searched google a bunch and found the source table for the 32 extended characters (http://lcd-linux.sourceforge.net/pdfdocs/hd44780.pdf; Table 4) but could not find anywhere how to get them to display properly using my Arduino and the LiquidCrystal library.

I tried a number of things to to get it to display the extended characters with no success. But when I dug into the library source code I found that there was a hidden option in lcd.begin() that allowed me to define the extended 5x10 font support. (yeah!)

If the documentation (https://www.arduino.cc/en/Reference/LiquidCrystalBegin) could be updated to something along the lines of this, that would be great.

lcd.begin(cols, rows [, dotsize])

Optional Parameters:

dotsize: enable 5x10 extended fonts on compatible one line displays (1 = Enable 5x10, 0 = Enable 5x8)

The third optional parameter dotsize is set to a 1 to enable drop fonts for displays with 5x10 characters. This allows for printing characters like g,j,p,q and y that extend below the virtual line. These extending characters can be found in the lcd character map between xE0 and xFF. If set to a 0, the extended characters are truncated to 5x8.

[buddywhitman]

hey @kengdahl are you working on this issue... if not, i can try to fix the docs by the next weekend (:

[kengdahl]

@buddywhitman Please make a pull request with the changes you want and me and @per1234 will look at the suggestions :)

[igmtz]

Hey @kengdahl ! I'm looking for my first issue in the open-source world. I would like to contribute with this, is someone currently working on the documentation?

[buddywhitman]

@buddywhitman Please make a pull request with the changes you want and me and @per1234 will look at the suggestions :)

@kengdahl and @per1234, I figured it out but realised that the reference files for official libraries are not located on the arduino org, but on the arduino-libraries org under the LiquidCrystal repository.

I've created a pull request there, kindly refer to the admins of the repo if possible. I believe you can close this issue now (it won't reflect as my first open source contribution sadly 😭 )

[per1234]

Thanks so much for your pull request @buddywhitman, and for your attention to this issue!

As you pointed out, we now have a dedicated repository for the LiquidCrystal library so the issue is off topic for this repository. Since we have your pull request, we can close this issue without risking forgetting about the task so I'll do that now.