Skip to content

Commit 75ebaed

Browse files
Sgw32Sgw32
authored
Merge pull request #36 from PHOL-LABS/codex/add-documentation-for-digifiz-next-parameters
Add Digifiz Next parameter reference appendix
2 parents f975e8e + 3abfeac commit 75ebaed

File tree

2 files changed

+111
-3
lines changed

2 files changed

+111
-3
lines changed

‎chapters/Appendix.tex‎

Lines changed: 109 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,115 @@ \section{Classic \ReplicaGenOneShort{} Default Values}
9999
\end{tblr}}
100100
\end{table}
101101

102-
\section{Change Log} \label{app:change-log}
102+
\chapter{\ReplicaNextShort{} Parameter Catalogue}\label{appendix:next-parameters}
103+
104+
\begin{longtblr}[
105+
caption={\ReplicaNextShort{} firmware parameters available through the \emph{Settings} tab.},
106+
label={tbl:next-parameters},
107+
]{
108+
colspec = {Q[l,0.22\linewidth] Q[l,0.32\linewidth] Q[c,0.09\linewidth] Q[c,0.12\linewidth] Q[l,0.23\linewidth]},
109+
rowhead = 1,
110+
rowsep = 2pt,
111+
}
112+
\toprule
113+
\textbf{UI label} & \textbf{Description} & \textbf{Type} & \textbf{Default} & \textbf{Range / notes} \\
114+
\midrule
115+
\SetCell[c=5]{l}{\textbf{Regional options and diagnostic toggles}} \\
116+
MFA Option Enable & Enable MFA steering column switch integration. & \texttt{U8} & 1 & Boolean toggle (0--1). \\
117+
Miles option & Display mileage in miles instead of kilometres. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
118+
Gallons option & Show fuel consumption in gallons. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
119+
Fahrenheit option & Display temperatures in degrees Fahrenheit. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
120+
Kelvin option & Display temperatures in degrees Kelvin. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
121+
Reserved option & Reserved flag for future units. & \texttt{U8} & 0 & Boolean toggle (0--1); no user-facing function. \\
122+
Linear fuel calculation & Calculate fuel level with a linear curve instead of table lookup. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
123+
Test mode & Enable firmware test mode. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
124+
\midrule
125+
\SetCell[c=5]{l}{\textbf{Tachometer and drivetrain}} \\
126+
Redline segments & Number of red warning segments on the tachometer scale. & \texttt{U8} & 8 & 0--31 segments. \\
127+
Diesel option & Use diesel-specific tachometer scaling. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
128+
7k option & Switch to a \SI{7000}{rpm} tachometer scale. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
129+
RPM Coefficient & Tachometer calibration coefficient. & \texttt{U16} & 3000 & Typical range 1000--6000. \\
130+
Maximum RPM & Maximum displayed RPM. & \texttt{U16} & 8000 & Selectable 6000, 7000, or 8000. \\
131+
RPM LPF coeff. & Low-pass filter coefficient applied while RPM increases. & \texttt{U16} & 70 & Higher values respond faster. \\
132+
RPM LPF coeff. fall & Low-pass filter coefficient applied while RPM decreases. & \texttt{U16} & 200 & Higher values respond faster. \\
133+
Stable RPM input & Optimise RPM input for modern ECUs. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
134+
Gear change indicator & Blink the gear indicator on detected shifts. & \texttt{U8} & 1 & Boolean toggle (0--1). \\
135+
Rear gear coefficient & Ratio of vehicle speed to reverse gear input frequency. & \texttt{U32} & 9999999 & Sentinel value indicates not configured. \\
136+
1-st gear coefficient & Ratio of vehicle speed to first gear input frequency. & \texttt{U32} & 1000 & Increase to lower the detected gear. \\
137+
2-nd gear coefficient & Ratio of vehicle speed to second gear input frequency. & \texttt{U32} & 2000 & Increase to lower the detected gear. \\
138+
3-rd gear coefficient & Ratio of vehicle speed to third gear input frequency. & \texttt{U32} & 3000 & Increase to lower the detected gear. \\
139+
4-th gear coefficient & Ratio of vehicle speed to fourth gear input frequency. & \texttt{U32} & 4000 & Increase to lower the detected gear. \\
140+
5-th gear coefficient & Ratio of vehicle speed to fifth gear input frequency. & \texttt{U32} & 5000 & Increase to lower the detected gear. \\
141+
6-th gear coefficient & Ratio of vehicle speed to sixth gear input frequency. & \texttt{U32} & 10000 & Default indicates ``no gear''. \\
142+
\midrule
143+
\SetCell[c=5]{l}{\textbf{Temperature and fuel gauges}} \\
144+
Red segments count & Number of red warning segments on the temperature gauge. & \texttt{U8} & 0 & 0--3 segments. \\
145+
Indicate temp. sensor & Indicate a connected temperature sensor using one segment. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
146+
Lower atten. enable & Enable the lower attenuator for the oil channel. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
147+
Temp. alarm function & Flash the temperature gauge when an alarm triggers. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
148+
Min. coolant temp. & Minimum coolant temperature shown as a single segment. & \texttt{U16} & 60 & Expressed in \si{\celsius}. \\
149+
Max. coolant temp. & Coolant temperature mapped to a full-scale reading. & \texttt{U16} & 120 & Expressed in \si{\celsius}. \\
150+
Coolant LPF coeff. & Low-pass filter constant for coolant readings. & \texttt{U16} & 2 & Higher values respond faster. \\
151+
Oil LPF coeff. & Low-pass filter constant for oil readings. & \texttt{U16} & 2 & Higher values respond faster. \\
152+
Air LPF coeff. & Low-pass filter constant for ambient readings. & \texttt{U16} & 2 & Higher values respond faster. \\
153+
Tank LPF coeff. & Low-pass filter constant for fuel level readings. & \texttt{U16} & 2 & Higher values respond faster. \\
154+
Fuel tank min. resistance & Minimum resistance of the fuel level sender. & \texttt{U16} & 35 & Expressed in \ohm. \\
155+
Fuel tank max. resistance & Maximum resistance of the fuel level sender. & \texttt{U16} & 265 & Expressed in \ohm. \\
156+
Fuel tank capacity & Fuel tank capacity. & \texttt{U8} & 63 & Expressed in litres. \\
157+
\midrule
158+
\SetCell[c=5]{l}{\textbf{Signal processing and measurement}} \\
159+
Other blink & Use dedicated left/right indicator inputs instead of the common wire. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
160+
Touch sensor option & Enable the wireless touch sensor input. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
161+
Invert light signal input & Invert the headlight brightness trigger input. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
162+
Consumption sensor option & Enable the external consumption MAF sensor. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
163+
Indicator filter cycles & Cycles required to confirm indicator changes. & \texttt{U16} & 0 & 0--65535 cycles. \\
164+
Turn signal filter cycles & Cycles required to confirm turn signal changes. & \texttt{U16} & 0 & 0--65535 cycles. \\
165+
Speedometer measurement period in ms & Pulse counter integration period. & \texttt{U32} & 1000 & Adjustable 250--2000~ms. \\
166+
Speedometer measurement window in ms & Averaging window for the speed pulse counter. & \texttt{U32} & 1000 & Adjustable 250--2000~ms. \\
167+
Stable Speed input & Optimise the speed input for electronic vehicle speed sensors. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
168+
Filtered Speed input & Enable software filtering of the speed input. & \texttt{U8} & 1 & Boolean toggle (0--1). \\
169+
LPF coefficient for speed calculation & Low-pass filter constant for speed calculations. & \texttt{U16} & -- & Default depends on firmware build. \\
170+
Median filter threshold & Legacy display filter threshold. & \texttt{U16} & 65535 & Reserved for diagnostics. \\
171+
\midrule
172+
\SetCell[c=5]{l}{\textbf{Sensor calibration constants}} \\
173+
Speed coefficient & Speedometer calibration factor. & \texttt{U16} & 100 & Increase to raise the indicated speed. \\
174+
Coolant thermistor beta & Beta coefficient for the coolant temperature sensor curve. & \texttt{U16} & 4000 & Typical range 3000--4500. \\
175+
Oil thermistor beta & Beta coefficient for the oil temperature sensor curve. & \texttt{U16} & 4000 & Typical range 3000--4500. \\
176+
Air thermistor beta & Beta coefficient for the ambient temperature sensor curve. & \texttt{U16} & 3812 & Generation~2 panels use \num{3812}. \\
177+
Coolant default resistance & Coolant sensor resistance at \SI{25}{\celsius}. & \texttt{U16} & 1000 & Expressed in \ohm. \\
178+
Oil default resistance & Oil sensor resistance at \SI{25}{\celsius}. & \texttt{U16} & 1000 & Expressed in \ohm. \\
179+
Air default resistance & Ambient sensor resistance at \SI{25}{\celsius}. & \texttt{U16} & 2991 & Expressed in \ohm. \\
180+
Coolant pull-up & Pull-up resistor used for the coolant sensor. & \texttt{U16} & 220 & Expressed in \ohm. \\
181+
Oil pull-up & Pull-up resistor used for the oil sensor. & \texttt{U16} & 3300 & Expressed in \ohm. \\
182+
Amb. air pull-up & Pull-up resistor used for the ambient sensor. & \texttt{U16} & 3300 & Expressed in \ohm. \\
183+
\midrule
184+
\SetCell[c=5]{l}{\textbf{Display, brightness, and audio}} \\
185+
Auto brightness & Enable automatic display brightness control. & \texttt{U8} & 1 & Boolean toggle (0--1). \\
186+
Brightness level & Manual brightness level. & \texttt{U8} & 25 & Adjustable 0--70. \\
187+
Light signal min & ADC reading that maps to minimum brightness. & \texttt{U16} & 300 & Raw ADC units. \\
188+
Light signal max & ADC reading that maps to maximum brightness. & \texttt{U16} & 800 & Raw ADC units. \\
189+
Brightness min & Minimum automatic brightness level. & \texttt{U8} & 6 & Display intensity units. \\
190+
Brightness max & Maximum automatic brightness level. & \texttt{U8} & 25 & Display intensity units. \\
191+
Brightness speed & Percentage applied per adjustment step. & \texttt{U8} & 10 & Adjustable 0--100\%. \\
192+
Buzzer option & Enable or disable the integrated buzzer. & \texttt{U8} & 1 & 1 disables, 0 enables. \\
193+
Blinking dot & Control the colon animation on the clock. & \texttt{U8} & -- & 0 blinks, 1 holds steady. \\
194+
Bkclt power & Enable the backlight power rail. & \texttt{U8} & 1 & Boolean toggle (0--1). \\
195+
Main R color & Red component of the main theme. & \texttt{U8} & 180 & RGB value (0--255). \\
196+
Main G color & Green component of the main theme. & \texttt{U8} & 240 & RGB value (0--255). \\
197+
Main B color & Blue component of the main theme. & \texttt{U8} & 6 & RGB value (0--255). \\
198+
Back R color & Red component of the backlight. & \texttt{U8} & 180 & RGB value (0--255). \\
199+
Back G color & Green component of the backlight. & \texttt{U8} & 240 & RGB value (0--255). \\
200+
Back B color & Blue component of the backlight. & \texttt{U8} & 6 & RGB value (0--255). \\
201+
Custom scheme & Enable loading of a custom colour scheme. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
202+
WiFi Auto Off & Automatically disable Wi-Fi after one minute of ignition on. & \texttt{U8} & 0 & Boolean toggle (0--1). \\
203+
\midrule
204+
\SetCell[c=5]{l}{\textbf{Runtime values}} \\
205+
MFA function state & Current MFA page index. & \texttt{U8} & -- & Runtime value (not stored). \\
206+
MFA Block ind. & Selected MFA memory block. & \texttt{U8} & -- & Runtime value (not stored). \\
207+
\bottomrule
208+
\end{longtblr}
209+
210+
\chapter{Document Change Log} \label{app:change-log}
103211

104212
\begin{table}[htbp]
105213
\centering

‎chapters/ReplicaNextMaintenance.tex‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,8 @@ \section{Service commands}
156156
Recent firmware revisions accept human-readable parameter names, for example \verb|PARAMETER_RPMCOEFFICIENT 3000|. The diagnostic command \verb|adc 0| prints raw ADC readings for sensor troubleshooting. Firmware updates add visual colour controls, so update regularly through the \emph{WiFi} tab to access the latest features.
157157

158158
\section{Settings tab parameter editor}
159-
The \emph{Settings} tab mirrors the parameter list in \autoref{tbl:next-commands} and \autoref{tbl:next-defaults} while adding metadata about ranges, descriptions, and data types.
160-
Use it whenever you prefer a graphical workflow instead of typing command numbers.
159+
The \emph{Settings} tab mirrors the parameter list in \autoref{tbl:next-commands} and \autoref{tbl:next-defaults} while adding metadata about ranges, descriptions, and data types.\@{}\autoref{tbl:next-parameters} summarises every firmware parameter.
160+
Use the Settings tab whenever you prefer a graphical workflow instead of typing command numbers; it exposes the same catalogue, including range validation, so you can adjust values quickly without memorising numeric IDs.
161161

162162
\begin{enumerate}
163163
\item Press \emph{Load Parameters} to fetch the live values from the dashboard. The browser displays each item with its name, current value, tooltip, and type.

0 commit comments

Comments
 (0)