Suggestion small change Bricklet 20x4 Custom Character Documentation Java

[rwblinn]

Just a suggestion for a small change regarding writing a custom character with Java.

Test Java Snippet

// Custom Char battery assigned to index 0 (from max 7)
short[] battery = new short[]{14,27,17,17,17,17,17,31};
lcd.setCustomCharacter((short)0, battery);
// Display the custom char with some text
lcd.writeLine((short)0, (short)0, "Battery: " + (char)0x08);

Suggestion Java documentation:
For section

void BrickletLCD20x4.setCustomCharacter(short index, short[] character) 

change the line:

The characters can later be written with writeLine() by using the characters with the byte representation 8 ("x08") to 15 ("x0F").

to

The characters can later be written with writeLine() by using the characters with the byte representation 8 ( (char)0x08 ) to 15 ( (char)0x0F ).

 

[photron]

The documentation should actually have said "\x08" for the \x escape sequence, but due to incomplete escaping the documentation on the website was missing the backslash. Thank you for reporting this bug.

The documentation text cannot be programming language specific, that's why it used the common \x escape sequence. Unfortunately, Java doesn't support the \x escape sequence.

I've added the missing backslash for the \x escape sequence and also added the \u escape sequence for programming languages that lack support for \x.

[rwblinn]

OK = thanks for the update.

Tested successfully:

lcd.writeLine((short)0, (short)0, "Battery: " + "\u0008");