From edb4e3750503059c3180eb5d0ef8eb775859183c Mon Sep 17 00:00:00 2001 From: rusefi Date: Thu, 2 May 2019 17:52:48 -0400 Subject: [PATCH] docs --- firmware/console/binary/tunerstudio.cpp | 2 +- firmware/console/status_loop.cpp | 4 ++-- firmware/controllers/algo/engine.h | 2 +- firmware/controllers/engine_controller.cpp | 12 ++++++------ firmware/controllers/scheduling/signal_executor.cpp | 2 +- firmware/controllers/trigger/rpm_calculator.cpp | 2 +- firmware/controllers/trigger/rpm_calculator.h | 2 +- firmware/development/engine_sniffer.cpp | 6 +++--- firmware/development/engine_sniffer.h | 4 ++-- firmware/development/wave_analyzer.cpp | 4 ++-- firmware/rusefi.cpp | 2 +- java_console/opensr5/src/com/opensr5/Main.java | 2 +- 12 files changed, 22 insertions(+), 22 deletions(-) diff --git a/firmware/console/binary/tunerstudio.cpp b/firmware/console/binary/tunerstudio.cpp index 5334e116fd..9c2fbb8dde 100644 --- a/firmware/console/binary/tunerstudio.cpp +++ b/firmware/console/binary/tunerstudio.cpp @@ -656,7 +656,7 @@ void handleTestCommand(ts_channel_s *tsChannel) { chsnprintf(testOutputBuffer, sizeof(testOutputBuffer), " uptime=%ds", getTimeNowSeconds()); sr5WriteData(tsChannel, (const uint8_t *) testOutputBuffer, strlen(testOutputBuffer)); /** - * Please note that this response is a magic constant used by dev console for protocol detection + * Please note that this response is a magic constant used by rusEfi console for protocol detection * @see EngineState#TS_PROTOCOL_TAG */ sr5WriteData(tsChannel, (const uint8_t *) TEST_RESPONSE_TAG, sizeof(TEST_RESPONSE_TAG)); diff --git a/firmware/console/status_loop.cpp b/firmware/console/status_loop.cpp index 82d917ac91..d23828e405 100644 --- a/firmware/console/status_loop.cpp +++ b/firmware/console/status_loop.cpp @@ -2,7 +2,7 @@ * @file status_loop.cpp * @brief Human-readable protocol status messages * - * http://rusefi.com/forum/viewtopic.php?t=263 Dev console overview + * http://rusefi.com/forum/viewtopic.php?t=263 rusEfi console overview * http://rusefi.com/forum/viewtopic.php?t=210 Commands overview * * @@ -426,7 +426,7 @@ void printOverallStatus(systime_t nowSeconds) { static systime_t timeOfPreviousReport = (systime_t) -1; /** - * @brief Sends all pending data to dev console + * @brief Sends all pending data to rusEfi console * * This method is periodically invoked by the main loop */ diff --git a/firmware/controllers/algo/engine.h b/firmware/controllers/algo/engine.h index 1c9f039c6d..df7a35c741 100644 --- a/firmware/controllers/algo/engine.h +++ b/firmware/controllers/algo/engine.h @@ -427,7 +427,7 @@ public: efitick_t stopEngineRequestTimeNt = 0; /** - * This counter is incremented every time user adjusts ECU parameters online (either via dev console or other + * This counter is incremented every time user adjusts ECU parameters online (either via rusEfi console or other * tuning software) */ volatile int globalConfigurationVersion = 0; diff --git a/firmware/controllers/engine_controller.cpp b/firmware/controllers/engine_controller.cpp index 791ce093db..e16012f777 100644 --- a/firmware/controllers/engine_controller.cpp +++ b/firmware/controllers/engine_controller.cpp @@ -423,7 +423,7 @@ static void getShort(int offset) { uint16_t *ptr = (uint16_t *) (&((char *) engineConfiguration)[offset]); uint16_t value = *ptr; /** - * this response is part of dev console API + * this response is part of rusEfi console API */ scheduleMsg(&logger, "short%s%d is %d", CONSOLE_DATA_PROTOCOL_TAG, offset, value); } @@ -434,7 +434,7 @@ static void getByte(int offset) { uint8_t *ptr = (uint8_t *) (&((char *) engineConfiguration)[offset]); uint8_t value = *ptr; /** - * this response is part of dev console API + * this response is part of rusEfi console API */ scheduleMsg(&logger, "byte%s%d is %d", CONSOLE_DATA_PROTOCOL_TAG, offset, value); } @@ -471,7 +471,7 @@ static void setBit(const char *offsetStr, const char *bitStr, const char *valueS int *ptr = (int *) (&((char *) engineConfiguration)[offset]); *ptr ^= (-value ^ *ptr) & (1 << bit); /** - * this response is part of dev console API + * this response is part of rusEfi console API */ scheduleMsg(&logger, "bit%s%d/%d is %d", CONSOLE_DATA_PROTOCOL_TAG, offset, bit, value); onConfigurationChanged(); @@ -501,7 +501,7 @@ static void getBit(int offset, int bit) { int *ptr = (int *) (&((char *) engineConfiguration)[offset]); int value = (*ptr >> bit) & 1; /** - * this response is part of dev console API + * this response is part of rusEfi console API */ scheduleMsg(&logger, "bit%s%d/%d is %d", CONSOLE_DATA_PROTOCOL_TAG, offset, bit, value); } @@ -512,7 +512,7 @@ static void getInt(int offset) { int *ptr = (int *) (&((char *) engineConfiguration)[offset]); int value = *ptr; /** - * this response is part of dev console API + * this response is part of rusEfi console API */ scheduleMsg(&logger, "int%s%d is %d", CONSOLE_DATA_PROTOCOL_TAG, offset, value); } @@ -532,7 +532,7 @@ static void getFloat(int offset) { float *ptr = (float *) (&((char *) engineConfiguration)[offset]); float value = *ptr; /** - * this response is part of dev console API + * this response is part of rusEfi console API */ scheduleMsg(&logger, "float%s%d is %.5f", CONSOLE_DATA_PROTOCOL_TAG, offset, value); } diff --git a/firmware/controllers/scheduling/signal_executor.cpp b/firmware/controllers/scheduling/signal_executor.cpp index c613454508..0fbb855f0a 100644 --- a/firmware/controllers/scheduling/signal_executor.cpp +++ b/firmware/controllers/scheduling/signal_executor.cpp @@ -28,7 +28,7 @@ #include "engine.h" /** - * Signal executors feed digital events right into WaveChart used by Sniffer tab of Dev Console + * Signal executors feed digital events right into WaveChart used by Engine Sniffer tab of rusEfi Console */ #include "rpm_calculator.h" diff --git a/firmware/controllers/trigger/rpm_calculator.cpp b/firmware/controllers/trigger/rpm_calculator.cpp index 8c9fb906fb..50c4d1f0ab 100644 --- a/firmware/controllers/trigger/rpm_calculator.cpp +++ b/firmware/controllers/trigger/rpm_calculator.cpp @@ -293,7 +293,7 @@ static char rpmBuffer[_MAX_FILLER]; #if EFI_PROD_CODE || EFI_SIMULATOR /** - * This callback has nothing to do with actual engine control, it just sends a Top Dead Center mark to the dev console + * This callback has nothing to do with actual engine control, it just sends a Top Dead Center mark to the rusEfi console * digital sniffer. */ static void onTdcCallback(void) { diff --git a/firmware/controllers/trigger/rpm_calculator.h b/firmware/controllers/trigger/rpm_calculator.h index 6f26cc78be..bc9c9835bc 100644 --- a/firmware/controllers/trigger/rpm_calculator.h +++ b/firmware/controllers/trigger/rpm_calculator.h @@ -17,7 +17,7 @@ #define WC_DOWN "d" #define WC_UP "u" /** - * See also 'CRANK1' in java dev console code + * See also 'CRANK1' in java rusEfi console code */ #define CRANK1 "t1" #define CRANK2 "t2" diff --git a/firmware/development/engine_sniffer.cpp b/firmware/development/engine_sniffer.cpp index a04ad650fc..24e15204c0 100644 --- a/firmware/development/engine_sniffer.cpp +++ b/firmware/development/engine_sniffer.cpp @@ -1,14 +1,14 @@ /** * @file engine_sniffer.cpp - * @brief Dev console wave sniffer logic + * @brief rusEfi console wave sniffer logic * * Here we have our own build-in logic analyzer. The data we aggregate here is sent to the - * java UI Dev Console so that it can be displayed nicely in the Sniffer tab. + * java UI rusEfi Console so that it can be displayed nicely in the Sniffer tab. * * Both external events (see wave_analyzer.c) and internal (see signal executors) are supported * * @date Jun 23, 2013 - * @author Andrey Belomutskiy, (c) 2012-2018 + * @author Andrey Belomutskiy, (c) 2012-2019 * * This file is part of rusEfi - see http://rusefi.com * diff --git a/firmware/development/engine_sniffer.h b/firmware/development/engine_sniffer.h index a2e8241b18..c0a96133a6 100644 --- a/firmware/development/engine_sniffer.h +++ b/firmware/development/engine_sniffer.h @@ -1,6 +1,6 @@ /** * @file engine_sniffer.h - * @brief Dev console wave sniffer + * @brief rusEfi console wave sniffer * * @date Jun 23, 2013 * @author Andrey Belomutskiy, (c) 2012-2017 @@ -15,7 +15,7 @@ #include "datalogging.h" /** - * @brief Dev console sniffer data buffer + * @brief rusEfi console sniffer data buffer */ class WaveChart { public: diff --git a/firmware/development/wave_analyzer.cpp b/firmware/development/wave_analyzer.cpp index fb13fefe25..fe811dd24b 100644 --- a/firmware/development/wave_analyzer.cpp +++ b/firmware/development/wave_analyzer.cpp @@ -1,9 +1,9 @@ /** * @file wave_analyzer.cpp - * @brief Initialization of Input Capture pins used for dev console sniffer + * @brief Initialization of Input Capture pins used for rusEfi console sniffer * * This file is responsible for sniffing of external digital signals and registering - * these digital events in WaveChart used by the Sniffer tab of Dev Console. + * these digital events in WaveChart used by the Engine Sniffer tab of rusEfi Console. * * this is rusEfi build-in logic analyzer * diff --git a/firmware/rusefi.cpp b/firmware/rusefi.cpp index 110b720f0b..47a5fff249 100644 --- a/firmware/rusefi.cpp +++ b/firmware/rusefi.cpp @@ -238,7 +238,7 @@ void runRusEfi(void) { efiAssertVoid(CUSTOM_RM_STACK, getCurrentRemainingStack() > 128, "stack#1"); #if EFI_CLI_SUPPORT && !EFI_UART_ECHO_TEST_MODE - // sensor state + all pending messages for our own dev console + // sensor state + all pending messages for our own rusEfi console updateDevConsoleState(); #endif /* EFI_CLI_SUPPORT */ diff --git a/java_console/opensr5/src/com/opensr5/Main.java b/java_console/opensr5/src/com/opensr5/Main.java index 7d379090d4..89e3c6b75a 100644 --- a/java_console/opensr5/src/com/opensr5/Main.java +++ b/java_console/opensr5/src/com/opensr5/Main.java @@ -10,7 +10,7 @@ public class Main { public static void main(String[] args) { System.out.println("OpenSR5 - load/program tune via serial port utility"); - System.out.println(" (c) Andrey Belomutskiy 2013-2018"); + System.out.println(" (c) Andrey Belomutskiy 2012-2019"); System.out.println(" https://github.com/rusefi/opensr5_flash"); System.out.flush();