Обновить README.md

README.md

@@ -1,73 +1,79 @@
 # Diod_Test
 
 ## Управление тестером 
-Тест может запускаться по кнопке или по коилу №2 StartTest. 
+Тест может запускаться по кнопке или по коилу №2 `StartTest`. 
 Режим тестирования (прямое/обратное включение) выставляется в двух коилах:
-- №0 PositiveTest
+- 0: `ForwardTest` - тест напряжения при прямом включении
-- №1 NegativeTest
+- 1: `ReverseTest` - тест скачка напряжения при обратном включении
-Если включены оба, то будет тест перехода от прямого подлключения к обратному. 
+
+Если включены оба, то будет тест скачка напряжения при переходе от прямого подлключения к обратному. 
 
 ## Настройка таймингов
 Тайминги выставляются в регистрах модбас №0-4:
-  - TimeForPositiveDC - миллисекундная задержка для положительного напряжения (только миллисекунды_
+  - 0: `TimeForForward` - миллисекундная задержка для прямого включения (только миллисекунды)
-  - TimeBeforeTest - задержка перед началом тестирования (миллисекундная или тики for())
+  - 1: `TimeBeforeTest` - задержка перед началом тестирования (миллисекундная или микросекундная)
-  - TimeBeforePeak - задержка между включением АЦП и предполагаемым скачком напряжения (миллисекундная или тики for())
+  - 2: `TimeDeadtime` - задержка при переключении с прямого включения в обратное (миллисекундная или микросекундная)
-  - TimeBeforeDisconnect - задержка перед выключением питания (миллисекундная или тики for())
+  - 3: `TimeBeforePeak` - задержка между включением АЦП и предполагаемым скачком напряжения (миллисекундная или микросекундная)
+  - 4: `TimeBeforeDisconnect` - задержка перед выключением питания (миллисекундная или микросекундная)
 
-В коилах модбас №16-18, можно выставить флаги - использовать миллисекундную или пустой цикл for() для соответствующей задержки:
+В коилах модбас №16-19, можно выставить флаги - использовать миллисекундную задержку вместо микросекундной для соответствующего тайминга:
-  - msTimeBeforeTest_enable
+  - 16: `msTimeBeforeTest_enable`
-  - msTimeBeforePeak_enable
+  - 17: `msTimeDeadtime_enable`
-  - msTimeBeforeDisconnect_enable  
+  - 18: `msTimeBeforePeak_enable`
+  - 19: `msTimeBeforeDisconnect_enable`
 
 ## Настройка АЦП
 Настройки АЦП выставляются в регистрах модбас №5-9:
-  - Adc_PulseWidth - ожидаемая длительность импульса в отчетах ацп
+  - 5: `Adc_PulseWidth` - ожидаемая длительность импульса в отчетах ацп
-  - Adc_PulseSign - полярность импульса
+  - 6: `Adc_PulseSign` - полярность импульса
-  - Adc_CalibrValue - калибровочное значение ацп
+  - 7: `Adc_CalibrValue` - калибровочное значение ацп
-  - Adc_ZeroValue - нулевое значение ацп
+  - 8: `Adc_ZeroValue` - нулевое значение ацп
-  - Adc_U_Calibr - калибровочное напряжение ацп
+  - 9: `Adc_U_Calibr` - калибровочное напряжение ацп
 
-Из этого рассчитывается шаг АЦП: Adc_U_Calibr/(Adc_CalibrValue - Adc_ZeroValue)
+Из этого рассчитывается шаг АЦП: `Adc_U_Calibr/(Adc_CalibrValue - Adc_ZeroValue)`
 
 
 # Тестирование
-## Тест в прямом подключении (TESTER_TestDiode_PositivePower)
+## Тест в прямом подключении (`TESTER_TestDiode_Forward`)
-- ожидается задержка, перед началом работы ticks_before_test
+- ожидается задержка, перед началом работы `ticks_before_test`
 - включается АЦП в континуес режиме 
-- подключается положительное напряжение на заданное время msticks_for_positive_dc. и все это время считывается АЦП и накапливаются заданное количество для расчета среднего.
+- диод подключается в прямом направлении на заданное время `msticks_for_forward`.
+- считывается АЦП и накапливаются заданное количество для расчета среднего. и так по кругу пока диод подключен
 - после таймаута отключается напряжение и останавливается АЦП
 
-По итогу сохраняется напряжение прямого включения диода
+По итогу сохраняется напряжение прямого включения диода `htest->DiodeForwardVolt`.
 
-## Тест в обратном подключении (TESTER_TestDiode_NegativePower)
+## Тест в обратном подключении (`TESTER_TestDiode_Reverse`)
-- ожидается задержка, перед началом работы ticks_before_test
+- ожидается задержка, перед началом работы `ticks_before_test`
 - включается АЦП в дма режиме 
-- ожидается задержка, перед предполагаемым скачком ticks_before_go_to_peak
+- ожидается задержка, перед предполагаемым скачком `ticks_before_peak`
-- подключается отрицательное напряжение на заданное время ticks_before_disconnect, и отключается
+- диод подключается в обратном направлении на заданное время `ticks_before_disconnect`, и отключается
 - после дожидается окончание заполнения буфера ДМА и обрабатывается: находится минимальный/максимальный пик и среднее напряжение в том районе
 
-По итогу сохраняется скачок напряжение при обратном включении диода
+По итогу сохраняется скачок напряжение при обратном включении диода `htest->DiodeReversePeakVolt`.
 
-## Тест перехода из прямого подключении в обратное (TESTER_TestDiode_PosNegPower)
+## Тест перехода из прямого подключении в обратное (`TESTER_TestDiode_SwitchConnection`)
-- ожидается задержка, перед началом работы ticks_before_test
+- ожидается задержка, перед началом работы `ticks_before_test`
-- подключается положительное напряжение на заданное время msticks_for_positive_dc
+- диод подключается в прямом направлении на заданное время `msticks_for_forward`
-- включается АЦП в дма режиме 
+- после истечения задержки сохраняется прямое напражение на диоде
-- ожидается задержка, перед предполагаемым скачком ticks_before_go_to_peak
+- диод отключается от питания и выжидается мертвое время `ticks_deadtime`
-- переключается положительное напряжение на отрицательное на заданное время ticks_before_disconnect
+- включается АЦП в дма режиме
+- ожидается задержка, перед предполагаемым скачком `ticks_before_peak`
+- диод подключается в обратном направлении на заданное время `ticks_before_disconnect`
 - дожидается окончание заполнения буфера ДМА и обрабатывается: находится минимальный/максимальный пик и среднее напряжение в том районе
 
-По итогу сохраняется напряжение прямого включения диода и скачок при обратном
+По итогу сохраняется напряжение прямого включения диода `htest->DiodeForwardVolt` и скачок при обратном `htest->DiodeReversePeakVolt`.
 
 
 
 # Внутренняя настройка
-В начале программы в регистрах модбас выставляются дефолтные настройки из tester_config.h (TESTER_Set_Default_Settings)
+В начале программы в регистрах модбас выставляются дефолтные настройки из tester_config.h (`TESTER_Set_Default_Settings`)
-После эти настройки подтягиваются в структуры тестера, через отдельную функцию (TESTER_UpdateSettings). Она вызывается перед каждым тестом.
+После эти настройки подтягиваются в структуры тестера, через отдельную функцию (`TESTER_UpdateSettings`). Она вызывается перед каждым тестом.
 ## tester_config.h
-Содержит дефолтные настройки для таймингов (TESTER_SW_TIMINGS_CONFIG):
+Содержит дефолтные настройки для таймингов (`TESTER_SW_TIMINGS_CONFIG`):
-- количество тиков и дефайн для включения миллисекундной задержки.
+- количество тиков и дефайн для включения миллисекундной разных задержек.
 
-для светодиода и кнопки (TESTER_INTERFACE_CONFIG):
+для светодиода и кнопки (`TESTER_INTERFACE_CONFIG`):
 - состояния пина для включения и выключения светодиода
 - порт и пин светодиода
 - частоты моргания для разных режимов работы
@@ -75,17 +81,26 @@
 - порт и пин кнопки
 - задержка для выжидания дребезга
 
-для управления ключами (TESTER_ADC_CONFIG):
+для управления ключами (`TESTER_PHASE_SW_CONFIG`):
-- USE_HAL_GPIO_FUNCTIONS - использовать HAL_GPIO-функции. Без неё переключается быстрее
+- `USE_HAL_GPIO_FUNCTIONS` - использовать HAL_GPIO-функции. Без неё переключается быстрее
-- ALL_SW_USE_SAME_PORT - используется один пор для всех ключей. Если не используется HAL, то позволяет переключить ключи на обоих источникам синхронно
+- `RECONNECT_WITHOUT_DEADTIME` - отключить дедтайм при переключении. Если отключить еще и USE_HAL_GPIO_FUNCTIONS, то переключатся фазы будут почти синхронно (быстрее десятков мкс). Хз надо ли такое, но возможность есть
-- состояния пина для подключения и отключения питания
+- порт и пины для двух ключей обратного подключения диода (порт общий для двух ключей)
-- порт и пины для ключей положительного питания (порт общий для двух ключей)
+- порт и пины для двух ключей обратного подключения диода (порт общий для двух ключей)
-- порт и пины для ключей положительного питания
 
-для АЦП (TESTER_ADC_CONFIG):
+для АЦП (`TESTER_ADC_CONFIG`):
-- размер dma буффера (ADC_BUFF_SIZE, ADC_DMA_BUFF_SIZE)
+- размер dma буффера (`ADC_BUFF_SIZE, ADC_DMA_BUFF_SIZE`)
-- калибровочное напряжение АЦП (ADC_U_CALIBR)
+- калибровочное напряжение АЦП (`ADC_U_CALIBR`)
-- значение АЦП при калибровочном напряжении (ADC_VALUE_CALIBR)
+- значение АЦП при калибровочном напряжении (`ADC_VALUE_CALIBR`)
-- значение АЦП при нулевом напряжении (ADC_VALUE_ZERO)
+- значение АЦП при нулевом напряжении (`ADC_VALUE_ZERO`)
-- таймаут на чтение АЦП (ADC_READ_TIMEOUT_MS)
+- таймаут на чтение АЦП (`ADC_READ_TIMEOUT_MS`)
-- ожидаемая длина импульса в отсчетах АЦП (TESTER_ADC_PULES_EXPETCED_WIDTH)
+- ожидаемая длина импульса в отсчетах АЦП (`TESTER_ADC_PULES_EXPETCED_WIDTH`)
+Из этого рассчитывается шаг АЦП: `Adc_U_Calibr/(Adc_CalibrValue - Adc_ZeroValue)`
+
+## Структуры для настроек
+Настройки для таймингов записываются в структуру `SwTimings`, которая находится в `htest`/`hTestDiode (глобально)`, а она уже в главной структуре проекта `TESTER`.
+
+Настройки светодиода и кнопки записываются в структуры `leds.LED1` и `SwStart`. Они находятся в структуре проекта `TESTER`
+
+Настройки для портов и пинов ключей записываются в структуры `SwPhaseForward` и `SwPhaseReverse`, которые находится в `htest`/`hTestDiode (глобально)`, а она уже в главной структуре проекта `TESTER`.
+
+Настройки для АЦП записыватся в структуру `TESTER.htest->adc->chAdc.s` (`ADC_ParamsTypeDef`).