Update docs
This commit is contained in:
1 parent
e648e5dfa2
commit
d17660f018
13 files changed
+2947
-129
No files matched your search
+13
-12
@@ -53,13 +53,15 @@ const uint32_t clr_bit_arr[6] = {
|
||||
*
|
||||
* This structure is used to store the data and length of a DCC packet.
|
||||
*
|
||||
* @typedef dcc_packet_t
|
||||
* @struct dcc_packet_t
|
||||
*
|
||||
* @field data An array of bytes representing the DCC packet data.
|
||||
* @field length The length of the DCC packet data.
|
||||
* @param data An array of bytes representing the DCC packet data.
|
||||
* @param length The length of the DCC packet data.
|
||||
*/
|
||||
typedef struct dcc_packet_t {
|
||||
/*! An array of bytes representing the DCC packet data. */
|
||||
uint8_t data[RING_BUFFER_BYTES];
|
||||
/*! The length of the DCC packet data. */
|
||||
size_t length;
|
||||
}dcc_packet_t;
|
||||
|
||||
@@ -69,16 +71,15 @@ typedef struct dcc_packet_t {
|
||||
* This structure is used to manage a ring buffer that stores DCC packets.
|
||||
* It contains an array of packets and indices for writing and reading.
|
||||
*
|
||||
* @typedef dcc_ring_buffer_t
|
||||
*
|
||||
* @field packets Array of DCC packets stored in the ring buffer.
|
||||
* @field wr_idx Index for the next write operation in the ring buffer.
|
||||
* @field rd_idx Index for the next read operation in the ring buffer.
|
||||
* @struct dcc_ring_buffer_t
|
||||
*/
|
||||
typedef struct dcc_ring_buffer_t {
|
||||
dcc_packet_t packets[RING_BUFFER_PACKETS];
|
||||
size_t wr_idx;
|
||||
size_t rd_idx;
|
||||
/*! Array of DCC packets stored in the ring buffer. */
|
||||
dcc_packet_t packets[RING_BUFFER_PACKETS];
|
||||
/*! Index for the next write operation in the ring buffer. */
|
||||
size_t wr_idx;
|
||||
/*! Index for the next read operation in the ring buffer. */
|
||||
size_t rd_idx;
|
||||
} dcc_ring_buffer_t;
|
||||
|
||||
|
||||
@@ -208,7 +209,7 @@ static void reset_cv_array_to_default();
|
||||
*
|
||||
* Procedure:
|
||||
* 1. Checks for a valid programming command.
|
||||
* 2. Evaluates the type of programming instruction (Write byte / Verify byte / Verify bit) and runs the corresponding function.
|
||||
* 2. Evaluates the type of programming instruction (Write byte / Verify byte / Verify bit) and runs the corresponding function. See verify_cv_byte(), verify_cv_bit() and write_cv_byte().
|
||||
*
|
||||
* @param number_of_bytes The number of bytes in the array.
|
||||
* @param byte_array A pointer to the byte array.
|
||||
|
||||
+3
-5
@@ -151,7 +151,7 @@ uint16_t get_initial_level(controller_parameter_t * ctrl_par);
|
||||
/**
|
||||
* @brief Controller function for startup mode.
|
||||
*
|
||||
* This is called inside the controller_general function when the controller mode is set to STARTUP_MODE.
|
||||
* This is called inside the controller_general() function when the controller mode is set to STARTUP_MODE.
|
||||
*
|
||||
* @param ctrl_par Pointer to the controller parameter structure.
|
||||
*/
|
||||
@@ -160,7 +160,7 @@ void controller_startup_mode(controller_parameter_t * ctrl_par);
|
||||
/**
|
||||
* @brief Controller function for PID mode.
|
||||
*
|
||||
* This is called inside the controller_general function when the controller mode is set to PID_MODE.
|
||||
* This is called inside the controller_general() function when the controller mode is set to PID_MODE.
|
||||
*
|
||||
* @param ctrl_par Pointer to the controller parameter structure.
|
||||
*/
|
||||
@@ -174,9 +174,7 @@ void controller_pid_mode(controller_parameter_t *const ctrl_par);
|
||||
void controller_general(controller_parameter_t * ctrl_par);
|
||||
|
||||
/**
|
||||
* @brief Initialize the all controller variables, measurement parameters, and speed table.
|
||||
*
|
||||
* ctrl_par contains all controller variables and is passed to the other controller functions.
|
||||
* @brief Initialize controller variables, measurement parameters, and speed table.
|
||||
*
|
||||
* @param ctrl_par Pointer to the controller parameter structure.
|
||||
*/
|
||||
|
||||
Reference in new issue
Block a user