@@ -97,10 +97,10 @@ void setup()
9797
9898 // Connect to the module.
9999 /*
100- * There is an optional argument for connect()/attemptConnect(), which, if set to false, will make it so extra identification will not be requested
100+ - There is an optional argument for connect()/attemptConnect(), which, if set to false, will make it so extra identification will not be requested
101101 if the module supports it.
102- * This would save almost one second of the connection time, with the downside being that getExtraIdentification() will return an empty string.
103- * It has no effect if the module doesn't support extra identification.
102+ - This would save almost one second of the connection time, with the downside being that getExtraIdentification() will return an empty string.
103+ - It has no effect if the module doesn't support extra identification.
104104 */
105105 diag.connect (connect_to_module, module_baud_rate, false );
106106
@@ -110,10 +110,10 @@ void setup()
110110
111111 // Disconnect from the module.
112112 /*
113- * There is an optional argument for disconnect(), which, if set to false, will make it so the library doesn't wait for a response.
114- * When disconnecting, some modules send a response, some don't.
115- * If the module doesn't send a response, not waiting saves [diag.responseTimeout] milliseconds, by default 2 seconds.
116- * If the module sends a response, not waiting for it shouldn't really have consequences.
113+ - There is an optional argument for disconnect(), which, if set to false, will make it so the library doesn't wait for a response.
114+ - When disconnecting, some modules send a response, some don't.
115+ - If the module doesn't send a response, not waiting saves [diag.responseTimeout] milliseconds, by default 2 seconds.
116+ - If the module sends a response, not waiting for it shouldn't really have consequences.
117117 */
118118 diag.disconnect (false );
119119 Serial.println (" Disconnected." );
@@ -133,9 +133,12 @@ void showDTCs()
133133 Always check the return value of functions!
134134
135135 The readFaults() function can return:
136- *KLineKWP1281Lib::SUCCESS - received fault codes
137- *KLineKWP1281Lib::FAIL - the module doesn't support fault codes
138- *KLineKWP1281Lib::ERROR - communication error
136+ KLineKWP1281Lib::SUCCESS - received fault codes
137+ KLineKWP1281Lib::FAIL - the module doesn't support fault codes
138+ KLineKWP1281Lib::ERROR - communication error
139+
140+ Technically, there are 3 more values defined for the KLineKWP1281Lib::executionStatus data type,
141+ but they only apply to the readGroup() function, so they will never be returned by other functions.
139142 */
140143
141144 // If fault codes were read successfully, display them.
0 commit comments