Skip to content

Commit 451fd9d

Browse files
committed
fix spelling and make unit tests more readable
1 parent 3e452fe commit 451fd9d

File tree

3 files changed

+17
-22
lines changed

3 files changed

+17
-22
lines changed

include/command_manager.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -201,18 +201,18 @@ class CommandManager : public ParamListenerInterface
201201

202202
/**
203203
* @brief Checks which channels are overridden
204-
* @details There are many reasons that a channel could be overriden. These reasons include:
204+
* @details There are many reasons that a channel could be overridden. These reasons include:
205205
* - A stick is deflected
206206
* - The commanded throttle is less than the RC throttle, and the MIN_THROTTLE parameter is set
207207
* - The attitude or throttle override switch is flipped
208208
* - The onboard computer has not sent any commands recently
209209
* The returned bitfield indicates which reasons have caused an override.
210210
* By anding with a constant such as X_OVERRIDDEN, you can check if a specific channel is overridden.
211-
* @return A bitfield, with overriden reasons indicated
211+
* @return A bitfield, with overridden reasons indicated
212212
*/
213213
uint16_t determine_override_status();
214-
uint16_t check_if_attitude_channel_is_overriden_by_rc(MuxChannel channel);
215-
uint16_t check_if_throttle_channel_is_overriden_by_rc();
214+
uint16_t check_if_attitude_channel_is_overridden_by_rc(MuxChannel channel);
215+
uint16_t check_if_throttle_channel_is_overridden_by_rc();
216216
void do_muxing(uint16_t rc_override);
217217
void do_channel_muxing(MuxChannel channel, uint16_t rc_override);
218218

@@ -225,15 +225,15 @@ class CommandManager : public ParamListenerInterface
225225
bool run();
226226
/**
227227
* @brief Checks which channels are overridden, and why
228-
* @details There are many reasons that a channel could be overriden. These reasons include:
228+
* @details There are many reasons that a channel could be overridden. These reasons include:
229229
* - A stick is deflected
230230
* - The commanded throttle is less than the RC throttle, and the MIN_THROTTLE parameter is set
231231
* - The attitude or throttle override switch is flipped
232232
* - The onboard computer has not sent any commands recently
233233
* The returned bitfield indicates which reasons have caused an override.
234234
* Because c++ can use integers as booleans, this function can be treated as providing a boolean
235235
* This value is updated if a new RC command is available
236-
* @return A bitfield, with overriden reasons indicated
236+
* @return A bitfield, with overridden reasons indicated
237237
*/
238238
uint16_t get_rc_override() const;
239239
bool offboard_control_active();

src/command_manager.cpp

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -203,15 +203,15 @@ uint16_t CommandManager::determine_override_status()
203203
rc_override |= OVERRIDE_THR_SWITCH;
204204
}
205205

206-
rc_override |= check_if_attitude_channel_is_overriden_by_rc(MUX_QX);
207-
rc_override |= check_if_attitude_channel_is_overriden_by_rc(MUX_QY);
208-
rc_override |= check_if_attitude_channel_is_overriden_by_rc(MUX_QZ);
209-
rc_override |= check_if_throttle_channel_is_overriden_by_rc();
206+
rc_override |= check_if_attitude_channel_is_overridden_by_rc(MUX_QX);
207+
rc_override |= check_if_attitude_channel_is_overridden_by_rc(MUX_QY);
208+
rc_override |= check_if_attitude_channel_is_overridden_by_rc(MUX_QZ);
209+
rc_override |= check_if_throttle_channel_is_overridden_by_rc();
210210

211211
return rc_override;
212212
}
213213

214-
uint16_t CommandManager::check_if_attitude_channel_is_overriden_by_rc(MuxChannel channel)
214+
uint16_t CommandManager::check_if_attitude_channel_is_overridden_by_rc(MuxChannel channel)
215215
{
216216
uint16_t rc_overrides{0};
217217
if (stick_deviated(channel)) {
@@ -223,7 +223,7 @@ uint16_t CommandManager::check_if_attitude_channel_is_overriden_by_rc(MuxChannel
223223
return rc_overrides;
224224
}
225225

226-
uint16_t CommandManager::check_if_throttle_channel_is_overriden_by_rc()
226+
uint16_t CommandManager::check_if_throttle_channel_is_overridden_by_rc()
227227
{
228228
MuxChannel selected_channel;
229229
// Determine which channel to check based on which axis the RC F channel corresponds to

test/command_manager_test.cpp

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -445,17 +445,15 @@ TEST_F(CommandManagerTest, OffboardCommandMuxLag)
445445

446446
control_t output = rf.command_manager_.combined_control();
447447
EXPECT_CLOSE(output.Qx.value, -0.5 * rf.params_.get_param_float(PARAM_RC_MAX_ROLL));
448-
EXPECT_EQ(rf.command_manager_.get_rc_override(),
449-
rf.command_manager_.get_rc_override() | CommandManager::OVERRIDE_X);
448+
EXPECT_NE(rf.command_manager_.get_rc_override() & CommandManager::OVERRIDE_X, 0);
450449

451450
rc_values[0] = 1500; // return stick to center
452451

453452
stepFirmware(500000);
454453
setOffboard(offboard_command);
455454
output = rf.command_manager_.combined_control();
456455
EXPECT_CLOSE(output.Qx.value, 0.0); // lag
457-
EXPECT_EQ(rf.command_manager_.get_rc_override(),
458-
rf.command_manager_.get_rc_override() | CommandManager::OVERRIDE_X);
456+
EXPECT_NE(rf.command_manager_.get_rc_override() & CommandManager::OVERRIDE_X, 0);
459457

460458
stepFirmware(600000);
461459
setOffboard(offboard_command);
@@ -466,8 +464,7 @@ TEST_F(CommandManagerTest, OffboardCommandMuxLag)
466464
stepFirmware(20000);
467465
output = rf.command_manager_.combined_control();
468466
EXPECT_CLOSE(output.Qx.value, OFFBOARD_QX);
469-
EXPECT_NE(rf.command_manager_.get_rc_override(),
470-
rf.command_manager_.get_rc_override() | CommandManager::OVERRIDE_X);
467+
EXPECT_EQ(rf.command_manager_.get_rc_override() & CommandManager::OVERRIDE_X, 0);
471468
}
472469

473470
TEST_F(CommandManagerTest, StaleOffboardCommand)
@@ -481,8 +478,7 @@ TEST_F(CommandManagerTest, StaleOffboardCommand)
481478

482479
control_t output = rf.command_manager_.combined_control();
483480
EXPECT_CLOSE(output.Qx.value, 0.0);
484-
EXPECT_EQ(rf.command_manager_.get_rc_override(),
485-
rf.command_manager_.get_rc_override() | CommandManager::OVERRIDE_OFFBOARD_X_INACTIVE);
481+
EXPECT_NE(rf.command_manager_.get_rc_override() & CommandManager::OVERRIDE_OFFBOARD_X_INACTIVE, 0);
486482
}
487483

488484
TEST_F(CommandManagerTest, PartialMux)
@@ -499,8 +495,7 @@ TEST_F(CommandManagerTest, PartialMux)
499495
EXPECT_CLOSE(output.Fx.value, 0.0);
500496
EXPECT_CLOSE(output.Fy.value, 0.0);
501497
EXPECT_CLOSE(output.Fz.value, 0.0);
502-
EXPECT_EQ(rf.command_manager_.get_rc_override(),
503-
rf.command_manager_.get_rc_override() | CommandManager::OVERRIDE_OFFBOARD_X_INACTIVE);
498+
EXPECT_NE(rf.command_manager_.get_rc_override() & CommandManager::OVERRIDE_OFFBOARD_X_INACTIVE, 0);
504499
}
505500

506501
TEST_F(CommandManagerTest, MixedTypes)

0 commit comments

Comments
 (0)