You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The input pins have types matched to the format string specifiers.
20
+
The input pins have types matched to the format string specifiers.
21
21
.TP
22
22
.Blcd.\fINN\fB.page_num\fR(u32)in
23
23
Selects the page number. Multiple layouts may be defined, and this pin switches
@@ -26,7 +26,7 @@ between them.
26
26
.Blcd.\fINN\fB.contrast\fR(float)in
27
27
Attempts to set the contrast of the LCD screen using the byte sequence ESC C and
28
28
then a value from 0x20 to 0xBF (matching the Mesa 7I73).
29
-
The value should be between 0 and 1.
29
+
The value should be between 0 and 1.
30
30
31
31
.SH PARAMETERS
32
32
.TP
@@ -38,17 +38,17 @@ parameter to 44 (0x2C).
38
38
.SH DESCRIPTION
39
39
40
40
\fBlcd\fR takes format strings much like those used in C and many other languages
41
-
in the printf and scanf functions and their variants.
41
+
in the printf and scanf functions and their variants.
42
42
43
43
The component was written specifically to support the Mesa 7I73 pendant controller,
44
44
however, it may be of use streaming data to other character devices
45
45
and, as the output format mimics the ADM3 terminal format, it could be used
46
-
to stream data to a serial device. Perhaps even a genuine ADM3.
47
-
The strings contain a mixture of text values (which are displayed directly),
48
-
"escaped" formatting codes and numerical format descriptors.
46
+
to stream data to a serial device. Perhaps even a genuine ADM3.
47
+
The strings contain a mixture of text values (which are displayed directly),
48
+
"escaped" formatting codes and numerical format descriptors.
49
49
For a detailed description of formatting codes see: http://en.wikipedia.org/wiki/Printf .
50
50
51
-
The component can be configured to display an unlimited number of differently-formatted pages, which may be selected with a HAL pin.
51
+
The component can be configured to display an unlimited number of differently-formatted pages, which may be selected with a HAL pin.
52
52
.TP
53
53
\fBEscapedcodes\fR
54
54
\en Inserts a clear-to-end, carriage return and line feed character.
@@ -57,42 +57,42 @@ To print in the rightmost column it is necessary to allow the format to wrap and
57
57
58
58
\et Inserts a tab (actually 4 spaces in the current version rather than a true tab.)
59
59
60
-
\eNN inserts the character defined by the hexadecimal code NN.
60
+
\eNN inserts the character defined by the hexadecimal code NN.
61
61
As the ',' character is used in the format string to separate LCD instances it must be represented by \e2C in the format string (the decimal separator is handled differently).
62
-
62
+
63
63
\e\e Inserts a literal \e.
64
64
65
65
.TP
66
66
\fBNumericalformats\fR
67
67
68
68
\fBlcd\fR differs slightly from the standard printf conventions.
69
69
One significant difference is that width limits are strictly enforced to prevent the LCD display wrapping and spoiling the layout.
70
-
The field width includes the sign character so that negative numbers will often have a smaller valid range than positive.
70
+
The field width includes the sign character so that negative numbers will often have a smaller valid range than positive.
71
71
Numbers that do not fit in the specified width are displayed as a line of asterisks (\fB********\fR).
72
72
73
73
Each format begins with a "%" symbol. (For a literal % use "%%").
74
74
Immediately after the % the following modifiers may be used:
75
75
76
76
" " (space) Pad the number to the specified width with spaces.
77
-
This is the default and is not strictly necessary.
77
+
This is the default and is not strictly necessary.
78
78
79
-
"0" Pad the number to the specified width with the numeral 0.
79
+
"0" Pad the number to the specified width with the numeral 0.
80
80
81
81
"+" Force display of a + symbol before positive numbers.
82
-
This (like the \- sign) will appear immediately to the left of the digits for a space-padded number and in the extreme left position for a 0-padded number.
82
+
This (like the \- sign) will appear immediately to the left of the digits for a space-padded number and in the extreme left position for a 0-padded number.
83
83
84
84
"1234567890" A numerical entry (other than the leading 0 above) defines the total number of characters to display including the decimal separator and the sign.
85
85
Whilst this number can be as many digits as required, the maximum field width is 20 characters.
86
86
The inherent precision of the "double" data type means that more than 14 digits will tend to show errors in the least significant digits.
87
-
The integer data types will never fill more than 10 decimal digits.
87
+
The integer data types will never fill more than 10 decimal digits.
88
88
89
89
Following the width specifier should be the decimal specifier.
90
-
This can only be a full-stop character (.) as the comma (,) is used as the instance separator.
90
+
This can only be a full-stop character (.) as the comma (,) is used as the instance separator.
91
91
Currently lcd does not access the locale information to determine the correct separator but the \fBdecimal\-separator\fR HAL parameter can be used to choose any desired separator.
92
92
93
-
Following the decimal separator should be a number that determines how many places of decimals to display. This entry is ignored in the case of integer formats.
93
+
Following the decimal separator should be a number that determines how many places of decimals to display. This entry is ignored in the case of integer formats.
94
94
95
-
All the above modifiers are optional, but to specify a decimal precision the decimal point must precede the precision, e.g., as in "%.3f".
95
+
All the above modifiers are optional, but to specify a decimal precision the decimal point must precede the precision, e.g., as in "%.3f".
96
96
The default decimal precision is 4.
97
97
98
98
The numerical formats supported are:
@@ -101,40 +101,40 @@ The numerical formats supported are:
101
101
The example would be displayed in a 9-character field, with 3 places of decimals, as a decimal separator,
102
102
padded to the left with 0s and with a sign displayed for both positive and negative. Conversely a plain %f would be 6 digits of decimal,
103
103
variable format width, with a sign only shown for negative numbers.
104
-
Both %f and %F create exactly the same format.
104
+
Both %f and %F create exactly the same format.
105
105
106
106
\fB%i%d\fR (For example %+ 4d) Creates a signed (s32) HAL pin.
107
-
The example would display the value at a fixed 4 characters, space padded, width including the "+" giving a range of +999 to \-999. %i and %d create identical output.
107
+
The example would display the value at a fixed 4 characters, space padded, width including the "+" giving a range of +999 to \-999. %i and %d create identical output.
108
108
109
109
\fB%u\fR (for example %08u) Creates an unsigned (u32) HAL pin.
110
-
The example would be a fixed 8 characters wide, padded with zeros.
110
+
The example would be a fixed 8 characters wide, padded with zeros.
111
111
112
112
\fB%x,%X\fR Creates an unsigned (u32) HAL pin and displays the value in Hexadecimal.
113
113
Both %x and %X display capital letters for digits ABCDEF.
114
-
A width may be specified, though the u32 HAL type is only 8 hex digits wide.
114
+
A width may be specified, though the u32 HAL type is only 8 hex digits wide.
115
115
116
-
\fB%o\fR Creates an unsigned (u32) pin and displays the value in octal representation.
116
+
\fB%o\fR Creates an unsigned (u32) pin and displays the value in octal representation.
117
117
118
118
\fB%c\fR Creates a u32 HAL pin and displays the character corresponding to the value of the pin.
119
-
Values less than 32 (space) are suppressed. A width specifier may be used, for example %20c might be used to create a complete line of one character.
119
+
Values less than 32 (space) are suppressed. A width specifier may be used, for example %20c might be used to create a complete line of one character.
120
120
121
121
\fB%b\fR This specifier has no equivalent in printf.
122
122
It creates a bit (boolean) type HAL pin. The b should be followed by two characters
123
123
and the display will show the first of these when the pin is true, and the second when false.
124
124
Note that the characters follow, not precede the "b", unlike the case with other formats.
125
125
The characters may be "escaped" Hex values.
126
126
For example "%b\eFF " will display a solid black block if true, and a space if false and "%b\e7F\e7E" would display right-arrow for false and left-arrow for true.
127
-
An unexpected value of 'E' indicates a formatting error.
127
+
An unexpected value of 'E' indicates a formatting error.
128
128
129
129
\fBPages\fR
130
130
The page separator is the "|" (pipe) character (if the actual character is needed then \e7C may be used).
131
-
A "Page" in this context refers to a separate format which may be displayed on the same display.
131
+
A "Page" in this context refers to a separate format which may be displayed on the same display.
132
132
133
133
\fBInstances\fR
134
134
The instance separator is the comma. This creates a completely separate lcd instance,
135
-
for example to drive a second lcd display on the second 7I73.
135
+
for example to drive a second lcd display on the second 7I73.
136
136
The use of comma to separate instances is built in to the modparam reading code so not even escaped commas "\e," can be used.
137
-
A comma may be displayed by using the \e2C sequence.
137
+
A comma may be displayed by using the \e2C sequence.
0 commit comments