Mirror/ardupilot
5
0
Fork 0
mirror of https://github.com/ArduPilot/ardupilot synced 2025-01-24 09:38:29 -04:00
Code Issues Packages Projects Releases Wiki Activity

AP_Relay: capitalize function enum

Browse Source
This commit is contained in:
Iampete1 2023-12-12 14:02:14 +00:00 committed by Peter Barker
parent f907694c6e
commit c917480cde
4 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
libraries/AP_Relay/AP_Relay.cpp
View File

@ -183,28 +183,28 @@ void AP_Relay::convert_params()
} }
// Work out what function this relay should be // Work out what function this relay should be
AP_Relay_Params::Function new_fun; AP_Relay_Params::FUNCTION new_fun;
if (i == chute_relay) { if (i == chute_relay) {
new_fun = AP_Relay_Params::Function::parachute; new_fun = AP_Relay_Params::FUNCTION::PARACHUTE;
} else if (i == ice_relay) { } else if (i == ice_relay) {
new_fun = AP_Relay_Params::Function::ignition; new_fun = AP_Relay_Params::FUNCTION::IGNITION;
} else if (i == cam_relay) { } else if (i == cam_relay) {
new_fun = AP_Relay_Params::Function::camera; new_fun = AP_Relay_Params::FUNCTION::CAMERA;
#if APM_BUILD_TYPE(APM_BUILD_Rover) #if APM_BUILD_TYPE(APM_BUILD_Rover)
} else if (i == rover_relay[0]) { } else if (i == rover_relay[0]) {
new_fun = AP_Relay_Params::Function::brushed_reverse_1; new_fun = AP_Relay_Params::FUNCTION::BRUSHED_REVERSE_1;
} else if (i == rover_relay[1]) { } else if (i == rover_relay[1]) {
new_fun = AP_Relay_Params::Function::brushed_reverse_2; new_fun = AP_Relay_Params::FUNCTION::BRUSHED_REVERSE_2;
} else if (i == rover_relay[2]) { } else if (i == rover_relay[2]) {
new_fun = AP_Relay_Params::Function::brushed_reverse_3; new_fun = AP_Relay_Params::FUNCTION::BRUSHED_REVERSE_3;
} else if (i == rover_relay[3]) { } else if (i == rover_relay[3]) {
new_fun = AP_Relay_Params::Function::brushed_reverse_4; new_fun = AP_Relay_Params::FUNCTION::BRUSHED_REVERSE_4;
#endif #endif
} else { } else {
@ -214,7 +214,7 @@ void AP_Relay::convert_params()
// This will result in a pre-arm promoting the user to resolve // This will result in a pre-arm promoting the user to resolve
continue; continue;
} }
new_fun = AP_Relay_Params::Function::relay; new_fun = AP_Relay_Params::FUNCTION::RELAY;
} }
_params[i].function.set_and_save(int8_t(new_fun)); _params[i].function.set_and_save(int8_t(new_fun));
@ -257,13 +257,13 @@ void AP_Relay::init()
continue; continue;
} }
const AP_Relay_Params::Function function = _params[instance].function; const AP_Relay_Params::FUNCTION function = _params[instance].function;
if (function < AP_Relay_Params::Function::relay || function >= AP_Relay_Params::Function::num_functions) { if (function <= AP_Relay_Params::FUNCTION::NONE || function >= AP_Relay_Params::FUNCTION::NUM_FUNCTIONS) {
// invalid function, skip it // invalid function, skip it
continue; continue;
} }
if (function == AP_Relay_Params::Function::relay) { if (function == AP_Relay_Params::FUNCTION::RELAY) {
// relay by instance number, set the state to match our output // relay by instance number, set the state to match our output
const AP_Relay_Params::DefaultState default_state = _params[instance].default_state; const AP_Relay_Params::DefaultState default_state = _params[instance].default_state;
if ((default_state == AP_Relay_Params::DefaultState::OFF) || if ((default_state == AP_Relay_Params::DefaultState::OFF) ||
@ -279,8 +279,8 @@ void AP_Relay::init()
} }
} }
void AP_Relay::set(const AP_Relay_Params::Function function, const bool value) { void AP_Relay::set(const AP_Relay_Params::FUNCTION function, const bool value) {
if (function <= AP_Relay_Params::Function::none && function >= AP_Relay_Params::Function::num_functions) { if (function <= AP_Relay_Params::FUNCTION::NONE && function >= AP_Relay_Params::FUNCTION::NUM_FUNCTIONS) {
// invalid function // invalid function
return; return;
} }
@ -328,7 +328,7 @@ void AP_Relay::set(const uint8_t instance, const bool value)
return; return;
} }
if (_params[instance].function != AP_Relay_Params::Function::relay) { if (_params[instance].function != AP_Relay_Params::FUNCTION::RELAY) {
return; return;
} }
@ -383,11 +383,11 @@ bool AP_Relay::get(uint8_t instance) const
bool AP_Relay::enabled(uint8_t instance) const bool AP_Relay::enabled(uint8_t instance) const
{ {
// Must be a valid instance with function relay and pin set // Must be a valid instance with function relay and pin set
return (instance < AP_RELAY_NUM_RELAYS) && (_params[instance].pin != -1) && (_params[instance].function == AP_Relay_Params::Function::relay); return (instance < AP_RELAY_NUM_RELAYS) && (_params[instance].pin != -1) && (_params[instance].function == AP_Relay_Params::FUNCTION::RELAY);
} }
// see if the relay is enabled // see if the relay is enabled
bool AP_Relay::enabled(AP_Relay_Params::Function function) const bool AP_Relay::enabled(AP_Relay_Params::FUNCTION function) const
{ {
for (uint8_t instance = 0; instance < AP_RELAY_NUM_RELAYS; instance++) { for (uint8_t instance = 0; instance < AP_RELAY_NUM_RELAYS; instance++) {
if ((_params[instance].function == function) && (_params[instance].pin != -1)) { if ((_params[instance].function == function) && (_params[instance].pin != -1)) {

4
libraries/AP_Relay/AP_Relay.h
View File

@ -55,10 +55,10 @@ public:
bool send_relay_status(const class GCS_MAVLINK &link) const; bool send_relay_status(const class GCS_MAVLINK &link) const;
void set(AP_Relay_Params::Function function, bool value); void set(AP_Relay_Params::FUNCTION function, bool value);
// see if the relay is enabled // see if the relay is enabled
bool enabled(AP_Relay_Params::Function function) const; bool enabled(AP_Relay_Params::FUNCTION function) const;
private: private:
static AP_Relay *singleton; static AP_Relay *singleton;

2
libraries/AP_Relay/AP_Relay_Params.cpp
View File

@ -16,7 +16,7 @@ const AP_Param::GroupInfo AP_Relay_Params::var_info[] = {
// @Values{Rover}: 8:Bushed motor reverse 4 omni motor 4 // @Values{Rover}: 8:Bushed motor reverse 4 omni motor 4
// @User: Standard // @User: Standard
AP_GROUPINFO_FLAGS("FUNCTION", 1, AP_Relay_Params, function, (float)Function::none, AP_PARAM_FLAG_ENABLE), AP_GROUPINFO_FLAGS("FUNCTION", 1, AP_Relay_Params, function, (float)FUNCTION::NONE, AP_PARAM_FLAG_ENABLE),
// @Param: PIN // @Param: PIN
// @DisplayName: Relay pin // @DisplayName: Relay pin

24
libraries/AP_Relay/AP_Relay_Params.h
View File

@ -18,20 +18,20 @@ public:
NO_CHANGE = 2, NO_CHANGE = 2,
}; };
enum class Function : uint8_t { enum class FUNCTION : uint8_t {
none = 0, NONE = 0,
relay = 1, RELAY = 1,
ignition = 2, IGNITION = 2,
parachute = 3, PARACHUTE = 3,
camera = 4, CAMERA = 4,
brushed_reverse_1 = 5, BRUSHED_REVERSE_1 = 5,
brushed_reverse_2 = 6, BRUSHED_REVERSE_2 = 6,
brushed_reverse_3 = 7, BRUSHED_REVERSE_3 = 7,
brushed_reverse_4 = 8, BRUSHED_REVERSE_4 = 8,
num_functions // must be the last entry NUM_FUNCTIONS // must be the last entry
}; };
AP_Enum<Function> function; // relay function AP_Enum<FUNCTION> function; // relay function
AP_Int16 pin; // gpio pin number AP_Int16 pin; // gpio pin number
AP_Enum<DefaultState> default_state; // default state AP_Enum<DefaultState> default_state; // default state
}; };