Skip to content

Chore: ensure that all function prototypes are CamelCase. #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 20, 2024
Merged

Chore: ensure that all function prototypes are CamelCase. #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 65 additions & 65 deletions docs/api.md
View file
Open in desktop

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions examples/opta_opcua_server/opta_opcua_server.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ void setup()
if (epoch > 0) {
set_time(epoch); /* Directly set RTC of Arduino Opta. */
} else {
set_time(opcua::cvt_time(__DATE__)); /* Configure Arduino Opta with time at compile time as last time of defense. */
set_time(opcua::timeToStr(__DATE__)); /* Configure Arduino Opta with time at compile time as last time of defense. */
}

/* Initialize Opta Expansion module controller. */
Expand Down Expand Up @@ -165,8 +165,8 @@ void setup()

/* Determine the Arduino OPC UA hardware variant. */
opcua::OptaVariant::Type opta_type;
if (!opcua::OptaVariant::get_opta_variant(opta_type)) {
UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "opcua::OptaVariant::get_opta_variant(...) failed");
if (!opcua::OptaVariant::getOptaVariant(opta_type)) {
UA_LOG_ERROR(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "opcua::OptaVariant::getOptaVariant(...) failed");
return;
}
UA_LOG_INFO(UA_Log_Stdout, UA_LOGCATEGORY_SERVER, "Arduino Opta Variant: %s", opcua::OptaVariant::toString(opta_type).c_str());
Expand All @@ -186,34 +186,34 @@ void setup()
}

/* Add the various digital input pins. */
opta_opcua->add_analog_input(opc_ua_server, "Analog Input I1", []() { return arduino_opta_analog_read(A0); });
opta_opcua->add_analog_input(opc_ua_server, "Analog Input I2", []() { return arduino_opta_analog_read(A1); });
opta_opcua->add_analog_input(opc_ua_server, "Analog Input I3", []() { return arduino_opta_analog_read(A2); });
opta_opcua->add_analog_input(opc_ua_server, "Analog Input I4", []() { return arduino_opta_analog_read(A3); });
opta_opcua->add_analog_input(opc_ua_server, "Analog Input I5", []() { return arduino_opta_analog_read(A4); });
opta_opcua->add_analog_input(opc_ua_server, "Analog Input I6", []() { return arduino_opta_analog_read(A5); });
opta_opcua->add_analog_input(opc_ua_server, "Analog Input I7", []() { return arduino_opta_analog_read(A6); });
opta_opcua->add_analog_input(opc_ua_server, "Analog Input I8", []() { return arduino_opta_analog_read(A7); });
opta_opcua->addAnalogInput(opc_ua_server, "Analog Input I1", []() { return arduino_opta_analog_read(A0); });
opta_opcua->addAnalogInput(opc_ua_server, "Analog Input I2", []() { return arduino_opta_analog_read(A1); });
opta_opcua->addAnalogInput(opc_ua_server, "Analog Input I3", []() { return arduino_opta_analog_read(A2); });
opta_opcua->addAnalogInput(opc_ua_server, "Analog Input I4", []() { return arduino_opta_analog_read(A3); });
opta_opcua->addAnalogInput(opc_ua_server, "Analog Input I5", []() { return arduino_opta_analog_read(A4); });
opta_opcua->addAnalogInput(opc_ua_server, "Analog Input I6", []() { return arduino_opta_analog_read(A5); });
opta_opcua->addAnalogInput(opc_ua_server, "Analog Input I7", []() { return arduino_opta_analog_read(A6); });
opta_opcua->addAnalogInput(opc_ua_server, "Analog Input I8", []() { return arduino_opta_analog_read(A7); });

/* Add the various digital input pins. */
opta_opcua->add_digital_input(opc_ua_server, "Digital Input I1", []() { return arduino_opta_digital_read(A0); });
opta_opcua->add_digital_input(opc_ua_server, "Digital Input I2", []() { return arduino_opta_digital_read(A1); });
opta_opcua->add_digital_input(opc_ua_server, "Digital Input I3", []() { return arduino_opta_digital_read(A2); });
opta_opcua->add_digital_input(opc_ua_server, "Digital Input I4", []() { return arduino_opta_digital_read(A3); });
opta_opcua->add_digital_input(opc_ua_server, "Digital Input I5", []() { return arduino_opta_digital_read(A4); });
opta_opcua->add_digital_input(opc_ua_server, "Digital Input I6", []() { return arduino_opta_digital_read(A5); });
opta_opcua->add_digital_input(opc_ua_server, "Digital Input I7", []() { return arduino_opta_digital_read(A6); });
opta_opcua->add_digital_input(opc_ua_server, "Digital Input I8", []() { return arduino_opta_digital_read(A7); });
opta_opcua->addDigitalInput(opc_ua_server, "Digital Input I1", []() { return arduino_opta_digital_read(A0); });
opta_opcua->addDigitalInput(opc_ua_server, "Digital Input I2", []() { return arduino_opta_digital_read(A1); });
opta_opcua->addDigitalInput(opc_ua_server, "Digital Input I3", []() { return arduino_opta_digital_read(A2); });
opta_opcua->addDigitalInput(opc_ua_server, "Digital Input I4", []() { return arduino_opta_digital_read(A3); });
opta_opcua->addDigitalInput(opc_ua_server, "Digital Input I5", []() { return arduino_opta_digital_read(A4); });
opta_opcua->addDigitalInput(opc_ua_server, "Digital Input I6", []() { return arduino_opta_digital_read(A5); });
opta_opcua->addDigitalInput(opc_ua_server, "Digital Input I7", []() { return arduino_opta_digital_read(A6); });
opta_opcua->addDigitalInput(opc_ua_server, "Digital Input I8", []() { return arduino_opta_digital_read(A7); });

/* Add the various relay outputs. */
opta_opcua->add_relay_output(opc_ua_server, "Relay 1", [](bool const value) { pinMode(RELAY1, OUTPUT); digitalWrite(RELAY1, value); pinMode(LED_D0, OUTPUT); digitalWrite(LED_D0, value); });
opta_opcua->add_relay_output(opc_ua_server, "Relay 2", [](bool const value) { pinMode(RELAY2, OUTPUT); digitalWrite(RELAY2, value); pinMode(LED_D1, OUTPUT); digitalWrite(LED_D1, value);});
opta_opcua->add_relay_output(opc_ua_server, "Relay 3", [](bool const value) { pinMode(RELAY3, OUTPUT); digitalWrite(RELAY3, value); pinMode(LED_D2, OUTPUT); digitalWrite(LED_D2, value);});
opta_opcua->add_relay_output(opc_ua_server, "Relay 4", [](bool const value) { pinMode(RELAY4, OUTPUT); digitalWrite(RELAY4, value); pinMode(LED_D3, OUTPUT); digitalWrite(LED_D3, value);});
opta_opcua->addRelayOutput(opc_ua_server, "Relay 1", [](bool const value) { pinMode(RELAY1, OUTPUT); digitalWrite(RELAY1, value); pinMode(LED_D0, OUTPUT); digitalWrite(LED_D0, value); });
opta_opcua->addRelayOutput(opc_ua_server, "Relay 2", [](bool const value) { pinMode(RELAY2, OUTPUT); digitalWrite(RELAY2, value); pinMode(LED_D1, OUTPUT); digitalWrite(LED_D1, value);});
opta_opcua->addRelayOutput(opc_ua_server, "Relay 3", [](bool const value) { pinMode(RELAY3, OUTPUT); digitalWrite(RELAY3, value); pinMode(LED_D2, OUTPUT); digitalWrite(LED_D2, value);});
opta_opcua->addRelayOutput(opc_ua_server, "Relay 4", [](bool const value) { pinMode(RELAY4, OUTPUT); digitalWrite(RELAY4, value); pinMode(LED_D3, OUTPUT); digitalWrite(LED_D3, value);});

/* Add the various LED outputs. */
if (opta_type == opcua::OptaVariant::Type::WiFi) {
opta_opcua->add_led_output(opc_ua_server, "User LED", [](bool const value) { pinMode(LEDB, OUTPUT); digitalWrite(LEDB, value); });
opta_opcua->addLedOutput(opc_ua_server, "User LED", [](bool const value) { pinMode(LEDB, OUTPUT); digitalWrite(LEDB, value); });
}

/* Check availability of expansion modules. */
Expand Down Expand Up @@ -251,16 +251,16 @@ void setup()
{
opcua::DigitalExpansion::SharedPtr exp_dig = nullptr;
if (exp_type == EXPANSION_OPTA_DIGITAL_MEC)
exp_dig = opta_expansion_manager_opcua->create_digital_mechanical_expansion(i);
exp_dig = opta_expansion_manager_opcua->createDigitalMechanicalExpansion(i);
else
exp_dig = opta_expansion_manager_opcua->create_digital_solid_state_expansion(i);
exp_dig = opta_expansion_manager_opcua->createDigitalSolidStateExpansion(i);

/* Expose digital/analog pins via OPC UA. */
for (uint8_t d = 0; d < OPTA_DIGITAL_IN_NUM; d++)
{
char analog_in_name[32] = {0};
snprintf(analog_in_name, sizeof(analog_in_name), "Analog Input I%d", d + 1);
exp_dig->add_analog_input(
exp_dig->addAnalogInput(
opc_ua_server,
analog_in_name,
[i, d]()
Expand All @@ -270,7 +270,7 @@ void setup()

char digital_in_name[32] = {0};
snprintf(digital_in_name, sizeof(digital_in_name), "Digital Input I%d", d + 1);
exp_dig->add_digital_input(
exp_dig->addDigitalInput(
opc_ua_server,
digital_in_name,
[i, d]()
Expand All @@ -284,7 +284,7 @@ void setup()
{
char mech_relay_name[32] = {0};
snprintf(mech_relay_name, sizeof(mech_relay_name), "Relay %d", r + 1);
exp_dig->add_relay_output(
exp_dig->addRelayOutput(
opc_ua_server,
mech_relay_name,
[i, r](bool const value)
Expand All @@ -295,7 +295,7 @@ void setup()
}
else if (exp_type == EXPANSION_OPTA_ANALOG)
{
auto const exp_analog = opta_expansion_manager_opcua->create_analog_expansion(i);
auto const exp_analog = opta_expansion_manager_opcua->createAnalogExpansion(i);

std::list<int> ANALOG_EXPANSION_MODULE_ANALOG_INPUT_LIST = {OA_CH_0, OA_CH_1, OA_CH_2, OA_CH_3, OA_CH_5, OA_CH_6};

Expand All @@ -315,7 +315,7 @@ void setup()
/* Expose analog inputs as readable OPC UA properties. */
char analog_in_name[32] = {0};
snprintf(analog_in_name, sizeof(analog_in_name), "Analog Input I%d", input_num);
exp_analog->add_analog_input(
exp_analog->addAnalogInput(
opc_ua_server,
analog_in_name,
[i, a]()
Expand All @@ -342,7 +342,7 @@ void setup()
/* Expose analog inputs as readable OPC UA properties. */
char analog_out_name[32] = {0};
snprintf(analog_out_name, sizeof(analog_out_name), "Analog Output O%d", output_num);
exp_analog->add_analog_output(
exp_analog->addAnalogOutput(
opc_ua_server,
analog_out_name,
[i, a]()
Expand All @@ -362,7 +362,7 @@ void setup()
{
char pwm_out_name[32] = {0};
snprintf(pwm_out_name, sizeof(pwm_out_name), "PWM%d", pwm_output_num);
exp_analog->add_pwm_output(
exp_analog->addPwmOutput(
opc_ua_server,
pwm_out_name,
[i, p](uint32_t const pwm_period_us, uint32_t const pwm_pulse_width_us)
Expand All @@ -385,7 +385,7 @@ void setup()
{
char led_name[32] = {0};
snprintf(led_name, sizeof(led_name), "LED%d", l + 1);
exp_analog->add_led_output(
exp_analog->addLedOutput(
opc_ua_server,
led_name,
[i, l](bool const value)
Expand Down
28 changes: 14 additions & 14 deletions keywords.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,25 +47,25 @@ NTPUtils KEYWORD1

create KEYWORD2

create_digital_mechanical_expansion KEYWORD2
create_digital_solid_state_expansion KEYWORD2
create_analog_expansion KEYWORD2

add_analog_input KEYWORD2
add_analog_output KEYWORD2
add_digital_input KEYWORD2
add_relay_output KEYWORD2
add_led_output KEYWORD2
add_pwm_output KEYWORD2
add_led_output KEYWORD2

get_opta_variant KEYWORD2
createDigitalMechanicalExpansion KEYWORD2
createDigitalSolidStateExpansion KEYWORD2
createAnalogExpansion KEYWORD2

addAnalogInput KEYWORD2
addAnalogOutput KEYWORD2
addDigitalInput KEYWORD2
addRelayOutput KEYWORD2
addLedOutput KEYWORD2
addPwmOutput KEYWORD2
addLedOutput KEYWORD2

getOptaVariant KEYWORD2
toString KEYWORD2
toStr KEYWORD2
toSKUString KEYWORD2

getTime KEYWORD2
cvt_time KEYWORD2
timeToStr KEYWORD2

#######################################
# Constants (LITERAL1)
Expand Down
2 changes: 1 addition & 1 deletion src/Arduino_OPC_UA.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

#include "util/o1heap/o1heap.h"
#include "util/o1heap/o1heap_wrapper.h"
#include "util/time/cvt_time.h"
#include "util/time/timeToStr.h"
#include "util/time/NTPUtils.h"
#include "util/toStr/ExpansionType.h"

Expand Down
16 changes: 8 additions & 8 deletions src/Opta.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,40 +143,40 @@ Opta::create(
}

void
Opta::add_analog_input(
Opta::addAnalogInput(
UA_Server * server,
const char * display_name,
AnalogInput::OnReadRequestFunc const on_read_request)
{
_analog_input_mgr->add_analog_input(server, display_name, on_read_request);
_analog_input_mgr->addAnalogInput(server, display_name, on_read_request);
}

void
Opta::add_digital_input(
Opta::addDigitalInput(
UA_Server * server,
const char * display_name,
DigitalInput::OnReadRequestFunc const on_read_request)
{
_digital_input_mgr->add_digital_input(server, display_name, on_read_request);
_digital_input_mgr->addDigitalInput(server, display_name, on_read_request);
}

void
Opta::add_relay_output(
Opta::addRelayOutput(
UA_Server * server,
const char * display_name,
Relay::OnSetRelayStateFunc const on_set_relay_state)
{
_relay_mgr->add_relay_output(server, display_name, on_set_relay_state);
_relay_mgr->addRelayOutput(server, display_name, on_set_relay_state);
}

void
Opta::add_led_output(
Opta::addLedOutput(
UA_Server * server,
const char * display_name,
Led::OnSetLedStateFunc const on_set_led_state)
{
if (_led_mgr) /* Only available for Arduino Opta WiFi. */
_led_mgr->add_led_output(server, display_name, on_set_led_state);
_led_mgr->addLedOutput(server, display_name, on_set_led_state);
}

/**************************************************************************************
Expand Down
8 changes: 4 additions & 4 deletions src/Opta.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ class Opta
* @param on_read_request Function pointer which is called during a read-access on the variable node representing the analog input.
*/
void
add_analog_input(
addAnalogInput(
UA_Server * server,
const char * display_name,
AnalogInput::OnReadRequestFunc const on_read_request);
Expand All @@ -100,7 +100,7 @@ class Opta
* @param on_read_request Function pointer which is called during a read-access on the variable node representing the digital input.
*/
void
add_digital_input(
addDigitalInput(
UA_Server * server,
const char * display_name,
DigitalInput::OnReadRequestFunc const on_read_request);
Expand All @@ -112,7 +112,7 @@ class Opta
* @param on_set_relay_state Function pointer which is called during a write-access on the variable node representing the relay output.
*/
void
add_relay_output(
addRelayOutput(
UA_Server * server,
const char * display_name,
Relay::OnSetRelayStateFunc const on_set_relay_state);
Expand All @@ -124,7 +124,7 @@ class Opta
* @param on_set_led_state Function pointer which is called during a write-access on the variable node representing the LED output.
*/
void
add_led_output(
addLedOutput(
UA_Server * server,
const char * display_name,
Led::OnSetLedStateFunc const on_set_led_state);
Expand Down
6 changes: 3 additions & 3 deletions src/OptaExpansionManager.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace opcua
**************************************************************************************/

DigitalMechExpansion::SharedPtr
OptaExpansionManager::create_digital_mechanical_expansion(
OptaExpansionManager::createDigitalMechanicalExpansion(
uint8_t const exp_num)
{
auto const exp_mech_opcua = opcua::DigitalMechExpansion::create(
Expand All @@ -38,7 +38,7 @@ OptaExpansionManager::create_digital_mechanical_expansion(
}

DigitalStSolidExpansion::SharedPtr
OptaExpansionManager::create_digital_solid_state_expansion(
OptaExpansionManager::createDigitalSolidStateExpansion(
uint8_t const exp_num)
{
auto const exp_solid_state_opcua = opcua::DigitalStSolidExpansion::create(
Expand All @@ -51,7 +51,7 @@ OptaExpansionManager::create_digital_solid_state_expansion(
}

AnalogExpansion::SharedPtr
OptaExpansionManager::create_analog_expansion(
OptaExpansionManager::createAnalogExpansion(
uint8_t const exp_num)
{
auto const exp_analog_opcua = opcua::AnalogExpansion::create(
Expand Down
6 changes: 3 additions & 3 deletions src/OptaExpansionManager.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ class OptaExpansionManager
* @return std::shared_ptr holding the newly allocated instance of opcua::DigitalMechExpansion.
*/
DigitalMechExpansion::SharedPtr
create_digital_mechanical_expansion(
createDigitalMechanicalExpansion(
uint8_t const exp_num);

/**
Expand All @@ -85,7 +85,7 @@ class OptaExpansionManager
* @return std::shared_ptr holding the newly allocated instance of opcua::DigitalStSolidExpansion.
*/
DigitalStSolidExpansion::SharedPtr
create_digital_solid_state_expansion(
createDigitalSolidStateExpansion(
uint8_t const exp_num);

/**
Expand All @@ -94,7 +94,7 @@ class OptaExpansionManager
* @return std::shared_ptr holding the newly allocated instance of opcua::AnalogExpansion.
*/
AnalogExpansion::SharedPtr
create_analog_expansion(
createAnalogExpansion(
uint8_t const exp_num);


Expand Down
2 changes: 1 addition & 1 deletion src/OptaVariant.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ namespace opcua
**************************************************************************************/

bool
OptaVariant::get_opta_variant(
OptaVariant::getOptaVariant(
Type & type)
{
OptaBoardInfo * info = boardInfo();
Expand Down
2 changes: 1 addition & 1 deletion src/OptaVariant.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ class OptaVariant
* @return True if the Opta variant could be obtained successfully.
*/
static bool
get_opta_variant(
getOptaVariant(
Type & type);

/**
Expand Down
Loading
Loading