Reformatting and renaming some functions; replaced get_direction() with get_direction_of_speed_step() in order to simplify handling of direction; additional explanation comment in CV.h; add doxygen config file;

This commit is contained in:
gab-k committed 2024-01-01 19:21:47 +01:00
1 parent d7f4621b96
commit df9b0ba633
10 files changed
+3316 -396

No files matched your search

+38
View File
@@ -10,6 +10,7 @@
#include "pico/stdlib.h"
#include "pico/multicore.h"
#include "pico/printf.h"
#include "pico/platform.h"
#include "hardware/pwm.h"
#include "hardware/adc.h"
#include "hardware/flash.h"
@@ -58,7 +59,12 @@
extern repeating_timer_t pid_control_timer;
extern repeating_timer_t speed_helper_timer;
extern const uint8_t *CV_ARRAY_FLASH;
extern uint8_t speed_step_target;
extern uint8_t speed_step_target_prev;
void core1_entry();
void write_cv_handler(uint16_t cv_index, uint8_t cv_data);
float measure(uint8_t total_iterations,
uint8_t measurement_delay_us,
uint8_t l_side_arr_cutoff,
@@ -66,3 +72,35 @@ float measure(uint8_t total_iterations,
bool direction);
uint32_t get_32bit_CV (uint16_t CV_start_index);
uint16_t get_16bit_CV (uint16_t CV_start_index);
/*!
* @brief Get direction
* Function calculates direction.Direction is based on speed_step byte. <br>
* Refers to "128 Speed Control" - NMRA Standard 9.2.1 section 2.3.2.1 or RCN-212 section 2.2.2. <br>
*
* The following speed steps exist:
* * DEC | BIN | DIRECTION | DEFINITION
* * 000 | 0000 0000 | Reverse | STOP
* * 001 | 0000 0001 | Reverse | EMERGENCY STOP
* * 002 | 0000 0010 | Reverse | Speed step 001 (Lowest speed)
* * 003 | 0000 0011 | Reverse | Speed step 002
* * 004 | 0000 0100 | Reverse | Speed step 003
* * ... | .... .... | Reverse | .....
* * ... | .... .... | Reverse | .....
* * ... | .... .... | Reverse | .....
* * 126 | 0111 1110 | Reverse | Speed step 125
* * 127 | 0111 1111 | Reverse | Speed step 126 (Full speed)
* * 128 | 1000 0000 | Forward | STOP
* * 129 | 1000 0001 | Forward | EMERGENCY STOP
* * 130 | 1000 0010 | Forward | Speed step 001 (Lowest speed)
* * 131 | 1000 0011 | Forward | Speed step 002
* * 132 | 1000 0100 | Forward | Speed step 003
* * ... | .... .... | Forward | .....
* * ... | .... .... | Forward | .....
* * ... | .... .... | Forward | .....
* * 254 | 1111 1110 | Forward | Speed step 125
* * 255 | 1111 1111 | Forward | Speed step 126 (Full speed)
*
* @param speed_step speed step byte
* @return direction; false for reverse; true for forward;
*/
bool get_direction_of_speed_step(uint8_t speed_step);