Skip to content

Commit 7c6cdc2

Browse files
authored
Chore: ensure that all function prototypes are CamelCase. (#24)
1 parent bdddeb4 commit 7c6cdc2

28 files changed

+170
-170
lines changed

docs/api.md

Lines changed: 65 additions & 65 deletions
Large diffs are not rendered by default.

examples/opta_opcua_server/opta_opcua_server.ino

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ void setup()
135135
if (epoch > 0) {
136136
set_time(epoch); /* Directly set RTC of Arduino Opta. */
137137
} else {
138-
set_time(opcua::cvt_time(__DATE__)); /* Configure Arduino Opta with time at compile time as last time of defense. */
138+
set_time(opcua::timeToStr(__DATE__)); /* Configure Arduino Opta with time at compile time as last time of defense. */
139139
}
140140

141141
/* Initialize Opta Expansion module controller. */
@@ -165,8 +165,8 @@ void setup()
165165

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

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

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

208208
/* Add the various relay outputs. */
209-
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); });
210-
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);});
211-
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);});
212-
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);});
209+
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); });
210+
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);});
211+
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);});
212+
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);});
213213

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

219219
/* Check availability of expansion modules. */
@@ -251,16 +251,16 @@ void setup()
251251
{
252252
opcua::DigitalExpansion::SharedPtr exp_dig = nullptr;
253253
if (exp_type == EXPANSION_OPTA_DIGITAL_MEC)
254-
exp_dig = opta_expansion_manager_opcua->create_digital_mechanical_expansion(i);
254+
exp_dig = opta_expansion_manager_opcua->createDigitalMechanicalExpansion(i);
255255
else
256-
exp_dig = opta_expansion_manager_opcua->create_digital_solid_state_expansion(i);
256+
exp_dig = opta_expansion_manager_opcua->createDigitalSolidStateExpansion(i);
257257

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

271271
char digital_in_name[32] = {0};
272272
snprintf(digital_in_name, sizeof(digital_in_name), "Digital Input I%d", d + 1);
273-
exp_dig->add_digital_input(
273+
exp_dig->addDigitalInput(
274274
opc_ua_server,
275275
digital_in_name,
276276
[i, d]()
@@ -284,7 +284,7 @@ void setup()
284284
{
285285
char mech_relay_name[32] = {0};
286286
snprintf(mech_relay_name, sizeof(mech_relay_name), "Relay %d", r + 1);
287-
exp_dig->add_relay_output(
287+
exp_dig->addRelayOutput(
288288
opc_ua_server,
289289
mech_relay_name,
290290
[i, r](bool const value)
@@ -295,7 +295,7 @@ void setup()
295295
}
296296
else if (exp_type == EXPANSION_OPTA_ANALOG)
297297
{
298-
auto const exp_analog = opta_expansion_manager_opcua->create_analog_expansion(i);
298+
auto const exp_analog = opta_expansion_manager_opcua->createAnalogExpansion(i);
299299

300300
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};
301301

@@ -315,7 +315,7 @@ void setup()
315315
/* Expose analog inputs as readable OPC UA properties. */
316316
char analog_in_name[32] = {0};
317317
snprintf(analog_in_name, sizeof(analog_in_name), "Analog Input I%d", input_num);
318-
exp_analog->add_analog_input(
318+
exp_analog->addAnalogInput(
319319
opc_ua_server,
320320
analog_in_name,
321321
[i, a]()
@@ -342,7 +342,7 @@ void setup()
342342
/* Expose analog inputs as readable OPC UA properties. */
343343
char analog_out_name[32] = {0};
344344
snprintf(analog_out_name, sizeof(analog_out_name), "Analog Output O%d", output_num);
345-
exp_analog->add_analog_output(
345+
exp_analog->addAnalogOutput(
346346
opc_ua_server,
347347
analog_out_name,
348348
[i, a]()
@@ -362,7 +362,7 @@ void setup()
362362
{
363363
char pwm_out_name[32] = {0};
364364
snprintf(pwm_out_name, sizeof(pwm_out_name), "PWM%d", pwm_output_num);
365-
exp_analog->add_pwm_output(
365+
exp_analog->addPwmOutput(
366366
opc_ua_server,
367367
pwm_out_name,
368368
[i, p](uint32_t const pwm_period_us, uint32_t const pwm_pulse_width_us)
@@ -385,7 +385,7 @@ void setup()
385385
{
386386
char led_name[32] = {0};
387387
snprintf(led_name, sizeof(led_name), "LED%d", l + 1);
388-
exp_analog->add_led_output(
388+
exp_analog->addLedOutput(
389389
opc_ua_server,
390390
led_name,
391391
[i, l](bool const value)

keywords.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,25 +47,25 @@ NTPUtils KEYWORD1
4747

4848
create KEYWORD2
4949

50-
create_digital_mechanical_expansion KEYWORD2
51-
create_digital_solid_state_expansion KEYWORD2
52-
create_analog_expansion KEYWORD2
53-
54-
add_analog_input KEYWORD2
55-
add_analog_output KEYWORD2
56-
add_digital_input KEYWORD2
57-
add_relay_output KEYWORD2
58-
add_led_output KEYWORD2
59-
add_pwm_output KEYWORD2
60-
add_led_output KEYWORD2
61-
62-
get_opta_variant KEYWORD2
50+
createDigitalMechanicalExpansion KEYWORD2
51+
createDigitalSolidStateExpansion KEYWORD2
52+
createAnalogExpansion KEYWORD2
53+
54+
addAnalogInput KEYWORD2
55+
addAnalogOutput KEYWORD2
56+
addDigitalInput KEYWORD2
57+
addRelayOutput KEYWORD2
58+
addLedOutput KEYWORD2
59+
addPwmOutput KEYWORD2
60+
addLedOutput KEYWORD2
61+
62+
getOptaVariant KEYWORD2
6363
toString KEYWORD2
6464
toStr KEYWORD2
6565
toSKUString KEYWORD2
6666

6767
getTime KEYWORD2
68-
cvt_time KEYWORD2
68+
timeToStr KEYWORD2
6969

7070
#######################################
7171
# Constants (LITERAL1)

src/Arduino_OPC_UA.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
#include "util/o1heap/o1heap.h"
1919
#include "util/o1heap/o1heap_wrapper.h"
20-
#include "util/time/cvt_time.h"
20+
#include "util/time/timeToStr.h"
2121
#include "util/time/NTPUtils.h"
2222
#include "util/toStr/ExpansionType.h"
2323

src/Opta.cpp

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -143,40 +143,40 @@ Opta::create(
143143
}
144144

145145
void
146-
Opta::add_analog_input(
146+
Opta::addAnalogInput(
147147
UA_Server * server,
148148
const char * display_name,
149149
AnalogInput::OnReadRequestFunc const on_read_request)
150150
{
151-
_analog_input_mgr->add_analog_input(server, display_name, on_read_request);
151+
_analog_input_mgr->addAnalogInput(server, display_name, on_read_request);
152152
}
153153

154154
void
155-
Opta::add_digital_input(
155+
Opta::addDigitalInput(
156156
UA_Server * server,
157157
const char * display_name,
158158
DigitalInput::OnReadRequestFunc const on_read_request)
159159
{
160-
_digital_input_mgr->add_digital_input(server, display_name, on_read_request);
160+
_digital_input_mgr->addDigitalInput(server, display_name, on_read_request);
161161
}
162162

163163
void
164-
Opta::add_relay_output(
164+
Opta::addRelayOutput(
165165
UA_Server * server,
166166
const char * display_name,
167167
Relay::OnSetRelayStateFunc const on_set_relay_state)
168168
{
169-
_relay_mgr->add_relay_output(server, display_name, on_set_relay_state);
169+
_relay_mgr->addRelayOutput(server, display_name, on_set_relay_state);
170170
}
171171

172172
void
173-
Opta::add_led_output(
173+
Opta::addLedOutput(
174174
UA_Server * server,
175175
const char * display_name,
176176
Led::OnSetLedStateFunc const on_set_led_state)
177177
{
178178
if (_led_mgr) /* Only available for Arduino Opta WiFi. */
179-
_led_mgr->add_led_output(server, display_name, on_set_led_state);
179+
_led_mgr->addLedOutput(server, display_name, on_set_led_state);
180180
}
181181

182182
/**************************************************************************************

src/Opta.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ class Opta
8888
* @param on_read_request Function pointer which is called during a read-access on the variable node representing the analog input.
8989
*/
9090
void
91-
add_analog_input(
91+
addAnalogInput(
9292
UA_Server * server,
9393
const char * display_name,
9494
AnalogInput::OnReadRequestFunc const on_read_request);
@@ -100,7 +100,7 @@ class Opta
100100
* @param on_read_request Function pointer which is called during a read-access on the variable node representing the digital input.
101101
*/
102102
void
103-
add_digital_input(
103+
addDigitalInput(
104104
UA_Server * server,
105105
const char * display_name,
106106
DigitalInput::OnReadRequestFunc const on_read_request);
@@ -112,7 +112,7 @@ class Opta
112112
* @param on_set_relay_state Function pointer which is called during a write-access on the variable node representing the relay output.
113113
*/
114114
void
115-
add_relay_output(
115+
addRelayOutput(
116116
UA_Server * server,
117117
const char * display_name,
118118
Relay::OnSetRelayStateFunc const on_set_relay_state);
@@ -124,7 +124,7 @@ class Opta
124124
* @param on_set_led_state Function pointer which is called during a write-access on the variable node representing the LED output.
125125
*/
126126
void
127-
add_led_output(
127+
addLedOutput(
128128
UA_Server * server,
129129
const char * display_name,
130130
Led::OnSetLedStateFunc const on_set_led_state);

src/OptaExpansionManager.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ namespace opcua
2525
**************************************************************************************/
2626

2727
DigitalMechExpansion::SharedPtr
28-
OptaExpansionManager::create_digital_mechanical_expansion(
28+
OptaExpansionManager::createDigitalMechanicalExpansion(
2929
uint8_t const exp_num)
3030
{
3131
auto const exp_mech_opcua = opcua::DigitalMechExpansion::create(
@@ -38,7 +38,7 @@ OptaExpansionManager::create_digital_mechanical_expansion(
3838
}
3939

4040
DigitalStSolidExpansion::SharedPtr
41-
OptaExpansionManager::create_digital_solid_state_expansion(
41+
OptaExpansionManager::createDigitalSolidStateExpansion(
4242
uint8_t const exp_num)
4343
{
4444
auto const exp_solid_state_opcua = opcua::DigitalStSolidExpansion::create(
@@ -51,7 +51,7 @@ OptaExpansionManager::create_digital_solid_state_expansion(
5151
}
5252

5353
AnalogExpansion::SharedPtr
54-
OptaExpansionManager::create_analog_expansion(
54+
OptaExpansionManager::createAnalogExpansion(
5555
uint8_t const exp_num)
5656
{
5757
auto const exp_analog_opcua = opcua::AnalogExpansion::create(

src/OptaExpansionManager.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ class OptaExpansionManager
7676
* @return std::shared_ptr holding the newly allocated instance of opcua::DigitalMechExpansion.
7777
*/
7878
DigitalMechExpansion::SharedPtr
79-
create_digital_mechanical_expansion(
79+
createDigitalMechanicalExpansion(
8080
uint8_t const exp_num);
8181

8282
/**
@@ -85,7 +85,7 @@ class OptaExpansionManager
8585
* @return std::shared_ptr holding the newly allocated instance of opcua::DigitalStSolidExpansion.
8686
*/
8787
DigitalStSolidExpansion::SharedPtr
88-
create_digital_solid_state_expansion(
88+
createDigitalSolidStateExpansion(
8989
uint8_t const exp_num);
9090

9191
/**
@@ -94,7 +94,7 @@ class OptaExpansionManager
9494
* @return std::shared_ptr holding the newly allocated instance of opcua::AnalogExpansion.
9595
*/
9696
AnalogExpansion::SharedPtr
97-
create_analog_expansion(
97+
createAnalogExpansion(
9898
uint8_t const exp_num);
9999

100100

src/OptaVariant.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ namespace opcua
3333
**************************************************************************************/
3434

3535
bool
36-
OptaVariant::get_opta_variant(
36+
OptaVariant::getOptaVariant(
3737
Type & type)
3838
{
3939
OptaBoardInfo * info = boardInfo();

src/OptaVariant.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class OptaVariant
6666
* @return True if the Opta variant could be obtained successfully.
6767
*/
6868
static bool
69-
get_opta_variant(
69+
getOptaVariant(
7070
Type & type);
7171

7272
/**

0 commit comments

Comments
 (0)