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
Copy file name to clipboardExpand all lines: docs/man/man9/hostmot2.9
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -871,7 +871,7 @@ Sets the master RC PWM frequency. Maximum is 1 kHz, minimum is .01 Hz. Defaults
871
871
872
872
.TP
873
873
(float rw) width
874
-
Sets the per channel pulse width in (ms/scale)
874
+
Sets the per channel pulse width in (ms/scale).
875
875
876
876
.TP
877
877
(float rw) offset
@@ -1123,7 +1123,7 @@ Only full GPIO pins have this parameter.
1123
1123
(bit r/w) is_opendrain
1124
1124
This parameter only has an effect if the "is_output" parameter is True.
1125
1125
If this parameter is False, the GPIO behaves as a normal output pin:
1126
-
the IO pin on the connector is driven to the value specified by the "out" HAL pin (possibly inverted), and the value of the "in" and "in_not" HAL pins is undefined.
1126
+
The IO pin on the connector is driven to the value specified by the "out" HAL pin (possibly inverted), and the value of the "in" and "in_not" HAL pins is undefined.
1127
1127
If this parameter is True, the GPIO behaves as an open-drain pin.
1128
1128
Writing 0 to the "out" HAL pin drives the IO pin low, writing 1 to the "out" HAL pin puts the IO pin in a high-impedance state.
1129
1129
In this high-impedance state the IO pin floats (weakly pulled high), and other devices can drive the value;
Copy file name to clipboardExpand all lines: docs/man/man9/lcd.9
+22-40Lines changed: 22 additions & 40 deletions
Original file line number
Diff line number
Diff line change
@@ -46,35 +46,28 @@ and, as the output format mimics the ADM3 terminal format, it could be used
46
46
to stream data to a serial device. Perhaps even a genuine ADM3.
47
47
The strings contain a mixture of text values (which are displayed directly),
48
48
"escaped" formatting codes and numerical format descriptors.
49
-
For a detailed description of formatting codes see:
50
-
http://en.wikipedia.org/wiki/Printf
49
+
For a detailed description of formatting codes see: http://en.wikipedia.org/wiki/Printf .
51
50
52
-
The component can be configured to display an unlimited number of
53
-
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.
54
52
.TP
55
53
\fBEscapedcodes\fR
56
-
\en Inserts a clear-to-end, carriage return and line feed character. This will
57
-
still linefeed and clear even if an automatic wrap has occurred (lcd has no
58
-
knowledge of the width of the lcd display.) To print in the rightmost column it
59
-
is necessary to allow the format to wrap and omit the \en code.
54
+
\en Inserts a clear-to-end, carriage return and line feed character.
55
+
This will still linefeed and clear even if an automatic wrap has occurred (lcd has no knowledge of the width of the lcd display).
56
+
To print in the rightmost column it is necessary to allow the format to wrap and omit the \en code.
60
57
61
-
\et Inserts a tab (actually 4 spaces in the current version rather than a true
62
-
tab.)
58
+
\et Inserts a tab (actually 4 spaces in the current version rather than a true tab.)
63
59
64
60
\eNN inserts the character defined by the hexadecimal code NN.
65
-
As the ',' character is used in the format string to separate LCD instances
66
-
it must be represented by \e2C in the format string. (the decimal
67
-
separator is handled differently)
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).
68
62
69
63
\e\e Inserts a literal \e.
70
64
71
65
.TP
72
66
\fBNumericalformats\fR
73
67
74
68
\fBlcd\fR differs slightly from the standard printf conventions.
75
-
One significant difference is that width limits are strictly enforced to prevent the LCD display
76
-
wrapping and spoiling the layout. The field width includes the sign character
77
-
so that negative numbers will often have a smaller valid range than positive.
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.
78
71
Numbers that do not fit in the specified width are displayed as a line of asterisks (\fB********\fR).
79
72
80
73
Each format begins with a "%" symbol. (For a literal % use "%%").
@@ -85,41 +78,33 @@ This is the default and is not strictly necessary.
85
78
86
79
"0" Pad the number to the specified width with the numeral 0.
87
80
88
-
"+" Force display of a + symbol before positive numbers. This (like the \- sign)
89
-
will appear immediately to the left of the digits for a space-padded number
90
-
and in the extreme left position for a 0-padded number.
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.
91
83
92
-
"1234567890" A numerical entry (other than the leading 0 above) defines the
93
-
total number of characters to display including the decimal separator and the sign.
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.
94
85
Whilst this number can be as many digits as required, the maximum field width is 20 characters.
95
-
The inherent precision of the "double" data type means
96
-
that more than 14 digits will tend to show errors in the least significant digits.
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.
97
87
The integer data types will never fill more than 10 decimal digits.
98
88
99
89
Following the width specifier should be the decimal specifier.
100
90
This can only be a full-stop character (.) as the comma (,) is used as the instance separator.
101
-
Currently lcd does not access the locale information to determine the correct separator
102
-
but the \fBdecimal\-separator\fR HAL parameter can be used to choose any desired separator.
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.
103
92
104
-
Following the decimal separator should be a number that determines
105
-
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.
106
94
107
-
All the above modifiers are optional, but to specify a decimal precision the
108
-
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".
109
96
The default decimal precision is 4.
110
97
111
98
The numerical formats supported are:
112
99
113
100
\fB%f%F\fR (for example, %+09.3f) These create a floating-point type HAL pin.
114
-
The example would be displayed in a 9-character field, with 3 places of decimals,
115
-
as a decimal separator, padded to the left with 0s and with a sign displayed for
116
-
both positive and negative. Conversely a plain %f would be 6 digits of decimal,
101
+
The example would be displayed in a 9-character field, with 3 places of decimals, as a decimal separator,
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,
117
103
variable format width, with a sign only shown for negative numbers.
118
104
Both %f and %F create exactly the same format.
119
105
120
106
\fB%i%d\fR (For example %+ 4d) Creates a signed (s32) HAL pin.
121
-
The example would display the value at a fixed 4 characters, space padded,
122
-
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.
123
108
124
109
\fB%u\fR (for example %08u) Creates an unsigned (u32) HAL pin.
125
110
The example would be a fixed 8 characters wide, padded with zeros.
@@ -131,16 +116,14 @@ A width may be specified, though the u32 HAL type is only 8 hex digits wide.
131
116
\fB%o\fR Creates an unsigned (u32) pin and displays the value in octal representation.
132
117
133
118
\fB%c\fR Creates a u32 HAL pin and displays the character corresponding to the value of the pin.
134
-
Values less than 32 (space) are suppressed. A width specifier may be used,
135
-
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.
136
120
137
121
\fB%b\fR This specifier has no equivalent in printf.
138
122
It creates a bit (boolean) type HAL pin. The b should be followed by two characters
139
123
and the display will show the first of these when the pin is true, and the second when false.
140
124
Note that the characters follow, not precede the "b", unlike the case with other formats.
141
125
The characters may be "escaped" Hex values.
142
-
For example "%b\eFF " will display a solid black block if true,
143
-
and a space if false and "%b\e7F\e7E" would display right-arrow for false and left-arrow for true.
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.
144
127
An unexpected value of 'E' indicates a formatting error.
145
128
146
129
\fBPages\fR
@@ -150,8 +133,7 @@ A "Page" in this context refers to a separate format which may be displayed on t
150
133
\fBInstances\fR
151
134
The instance separator is the comma. This creates a completely separate lcd instance,
152
135
for example to drive a second lcd display on the second 7I73.
153
-
The use of comma to separate instances is built in to the modparam reading code
154
-
so not even escaped commas "\e," can be used.
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.
155
137
A comma may be displayed by using the \e2C sequence.
Copy file name to clipboardExpand all lines: docs/man/man9/pwmgen.9
+4-9Lines changed: 4 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -15,8 +15,7 @@ The number of channels actually loaded depends on the number of \fItype\fR value
15
15
The value of each \fItype\fR determines the outputs for that channel.
16
16
.P
17
17
.TP
18
-
type 0: single output A single output pin, \fBpwm\fR, whose duty cycle is determined by the input value for positive inputs,
19
-
and which is off (or at \fBmin\-dc\fR) for negative inputs.
18
+
type 0: single output A single output pin, \fBpwm\fR, whose duty cycle is determined by the input value for positive inputs, and which is off (or at \fBmin\-dc\fR) for negative inputs.
20
19
Suitable for single ended circuits.
21
20
.TP
22
21
type 1: pwm/direction
@@ -47,9 +46,7 @@ Operates on all channels at once.
47
46
Enables PWM generator \fIN\fR - when false, all \fBpwmgen.\fIN\fR output pins are low.
48
47
.TP
49
48
\fBpwmgen.\fIN\fB.value\fR float in
50
-
Commanded value. When \fBvalue\fR = 0.0, duty cycle is 0%,
51
-
and when \fBvalue\fR = \(+-\fBscale\fR, duty cycle is \(+- 100%
52
-
(subject to \fBmin\-dc\fR and \fBmax\-dc\fR limitations).
49
+
Commanded value. When \fBvalue\fR = 0.0, duty cycle is 0%, and when \fBvalue\fR = \(+-\fBscale\fR, duty cycle is \(+- 100% (subject to \fBmin\-dc\fR and \fBmax\-dc\fR limitations).
53
50
.TP
54
51
\fBpwmgen.\fIN\fB.pwm\fR bit out (output types 0 and 1 only)
55
52
PWM/PDM waveform.
@@ -69,8 +66,7 @@ Range is from \-1.0 to +1.0.
69
66
.TP
70
67
\fBpwmgen.\fIN\fB.max\-dc\fR float in/out
71
68
The maximum duty cycle. A value of 1.0 corresponds to 100%.
72
-
This can be useful when using transistor drivers with bootstrapped power supplies,
73
-
since the supply requires some low time to recharge.
69
+
This can be useful when using transistor drivers with bootstrapped power supplies, since the supply requires some low time to recharge.
74
70
.TP
75
71
\fBpwmgen.\fIN\fB.min\-dc\fR float in/out
76
72
The minimum duty cycle. A value of 1.0 corresponds to 100%.
@@ -95,6 +91,5 @@ Because software-generated PWM uses a fairly slow timebase (several to many micr
95
91
For example, if \fBmake\-pulses\fR is called at a 20 kHz rate, and \fBpwm\-freq\fR is 2 kHz, there are only 10 possible duty cycles.
96
92
If \fBdither\-pwm\fR is false, the commanded duty cycle will be rounded to the nearest of those values.
97
93
Assuming \fBvalue\fR remains constant, the same output will repeat every PWM cycle.
98
-
If \fBdither\-pwm\fR is true, the output duty cycle will be dithered between the two closest values,
99
-
so that the long-term average is closer to the desired level.
94
+
If \fBdither\-pwm\fR is true, the output duty cycle will be dithered between the two closest values, so that the long-term average is closer to the desired level.
100
95
\fBdither\-pwm\fR has no effect if \fBpwm\-freq\fR is zero (PDM mode), since PDM is an inherently dithered process.
0 commit comments