Skip to content

Commit b094843

Browse files
J-RiosJ-Rios
committed
Update examples to builtin CLI printf
1 parent 9144d30 commit b094843

File tree

8 files changed

+93
-148
lines changed

8 files changed

+93
-148
lines changed

‎examples/arduino/basic_usage/basic_usage.ino‎

Lines changed: 23 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/**
22
* @file examples/arduino/basic_usage/basic_usage.ino
33
* @author Jose Miguel Rios Rubio <[email protected]>
4-
* @date 03-06-2021
5-
* @version 1.0.0
4+
* @date 02-04-2022
5+
* @version 1.0.1
66
*
77
* @section DESCRIPTION
88
*
@@ -51,8 +51,8 @@
5151
#define COMMAND_LED 13
5252
#endif
5353

54-
// Current Firmware Version
55-
#define FW_VER "1.0.0"
54+
// Current Firmware Application Version
55+
#define FW_APP_VERSION "1.0.0"
5656

5757
/*****************************************************************************/
5858

@@ -67,15 +67,16 @@ MINBASECLI Cli;
6767

6868
void setup()
6969
{
70-
// Serial Init
71-
Serial.begin(SERIAL_BAUDS);
72-
7370
// LED Init
7471
digitalWrite(COMMAND_LED, LOW);
7572
pinMode(COMMAND_LED, OUTPUT);
7673

74+
// Serial Init
75+
Serial.begin(SERIAL_BAUDS);
76+
7777
// CLI init to use Serial as interface
7878
Cli.setup(&Serial);
79+
Cli.printf("\nCommand Line Interface is ready\n\n");
7980
}
8081

8182
void loop()
@@ -86,22 +87,19 @@ void loop()
8687
if(Cli.manage(&cli_read))
8788
{
8889
// Show read result element
89-
Serial.print("Command received: "); Serial.println(cli_read.cmd);
90-
Serial.print("Number of arguments: "); Serial.println(cli_read.argc);
91-
for(uint8_t i = 0; i < cli_read.argc; i++)
92-
{
93-
Serial.print(" Argument "); Serial.print(i);
94-
Serial.print(":"); Serial.println(cli_read.argv[i]);
95-
}
96-
Serial.println();
90+
Cli.printf("Command received: %s\n", cli_read.cmd);
91+
Cli.printf("Number of arguments: %d\n", (int)(cli_read.argc));
92+
for(int i = 0; i < cli_read.argc; i++)
93+
Cli.printf(" Argument %d: %s", i, cli_read.argv[i]);
94+
Cli.printf("\n");
9795

9896
// Handle Commands
9997
if(strcmp(cli_read.cmd, "help") == 0)
10098
{
101-
Serial.println("Available Commands:");
102-
Serial.println(" help - Current info.");
103-
Serial.println(" led [on/off] - Turn LED ON or OFF");
104-
Serial.println(" version - Shows current firmware version");
99+
Cli.printf("Available Commands:\n");
100+
Cli.printf(" help - Current info.\n");
101+
Cli.printf(" led [on/off] - Turn LED ON or OFF\n");
102+
Cli.printf(" version - Shows current firmware version\n");
105103
}
106104
else if(strcmp(cli_read.cmd, "led") == 0)
107105
{
@@ -116,29 +114,28 @@ void loop()
116114
led_mode = cli_read.argv[0];
117115
if(strcmp(led_mode, "on") == 0)
118116
{
119-
Serial.println("Turning LED ON.");
117+
Cli.printf("Turning LED ON.\n");
120118
digitalWrite(COMMAND_LED, HIGH);
121119
}
122120
else if(strcmp(led_mode, "off") == 0)
123121
{
124-
Serial.println("Turning LED OFF.");
122+
Cli.printf("Turning LED OFF.\n");
125123
digitalWrite(COMMAND_LED, LOW);
126124
}
127125
else
128126
invalid_argv = true;
129127
}
130128

131129
if(invalid_argv)
132-
Serial.println("led command needs \"on\" or \"off\" arg.");
130+
Cli.printf("led command needs \"on\" or \"off\" arg.\n");
133131
}
134132
else if(strcmp(cli_read.cmd, "version") == 0)
135133
{
136-
Serial.print("Fw Version: ");
137-
Serial.println(FW_VER);
134+
Cli.printf("FW App Version: %s\n", FW_APP_VERSION);
138135
}
139136
// ...
140137
else
141-
Serial.println("Unkown command.");
142-
Serial.println();
138+
Cli.printf("Unkown command.\n");
139+
Cli.printf("\n");
143140
}
144141
}

‎examples/avr/basic_usage/inc/constants.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
#define COMMAND_LED_PORT PORTB
5252
#define COMMAND_LED_PIN PB5 // == Arduino Uno Board Pin 13
5353

54-
// Firmware Application Version
54+
// Current Firmware Application Version
5555
#define FW_APP_VERSION "1.0.0"
5656

5757
/*****************************************************************************/

‎examples/avr/basic_usage/src/main.cpp‎

Lines changed: 21 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
/**
33
* @file main.cpp
44
* @author Jose Miguel Rios Rubio <[email protected]>
5-
* @date 02-02-2022
6-
* @version 1.0.0
5+
* @date 02-04-2022
6+
* @version 1.0.1
77
*
88
* @section DESCRIPTION
99
*
@@ -61,12 +61,6 @@ static void led_init(void);
6161
static void led_on(void);
6262
static void led_off(void);
6363

64-
static void serial_print(uint8_t data_byte);
65-
static void serial_println(uint8_t data_byte);
66-
static void serial_println(void);
67-
static void serial_print(const char* str);
68-
static void serial_println(const char* str);
69-
7064
/*****************************************************************************/
7165

7266
/* Global Elements */
@@ -82,14 +76,15 @@ int main(void)
8276
// Command Line Interface
8377
MINBASECLI Cli;
8478

79+
// Set LED Pin as digital Output
80+
led_init();
81+
8582
// Initilize UART0
8683
Serial.setup(SERIAL_BAUDS);
8784

8885
// CLI init to use Serial as interface
8986
Cli.setup(&Serial);
90-
91-
// Set LED Pin as digital Output
92-
led_init();
87+
Cli.printf("\nCommand Line Interface is ready\n\n");
9388

9489
while (1)
9590
{
@@ -99,22 +94,19 @@ int main(void)
9994
if(Cli.manage(&cli_read))
10095
{
10196
// Show read result element
102-
serial_print("Command received: "); serial_println(cli_read.cmd);
103-
serial_print("Number of arguments: "); serial_println(cli_read.argc);
104-
for(uint8_t i = 0; i < cli_read.argc; i++)
105-
{
106-
serial_print(" Argument "); serial_print(i);
107-
serial_print(":"); serial_println(cli_read.argv[i]);
108-
}
109-
serial_println();
97+
Cli.printf("Command received: %s\n", cli_read.cmd);
98+
Cli.printf("Number of arguments: %d\n", (int)(cli_read.argc));
99+
for(int i = 0; i < cli_read.argc; i++)
100+
Cli.printf(" Argument %d: %s", i, cli_read.argv[i]);
101+
Cli.printf("\n");
110102

111103
// Handle Commands
112104
if(strcmp(cli_read.cmd, "help") == 0)
113105
{
114-
serial_println("Available Commands:");
115-
serial_println(" help - Current info.");
116-
serial_println(" led [on/off] - Turn LED ON or OFF");
117-
serial_println(" version - Shows current firmware version");
106+
Cli.printf("Available Commands:\n");
107+
Cli.printf(" help - Current info\n");
108+
Cli.printf(" led [on/off] - Turn LED ON or OFF\n");
109+
Cli.printf(" version - Shows current firmware version\n");
118110
}
119111
else if(strcmp(cli_read.cmd, "led") == 0)
120112
{
@@ -129,30 +121,29 @@ int main(void)
129121
led_mode = cli_read.argv[0];
130122
if(strcmp(led_mode, "on") == 0)
131123
{
132-
serial_println("Turning LED ON.");
124+
Cli.printf("Turning LED ON.\n");
133125
led_on();
134126
}
135127
else if(strcmp(led_mode, "off") == 0)
136128
{
137-
serial_println("Turning LED OFF.");
129+
Cli.printf("Turning LED OFF.\n");
138130
led_off();
139131
}
140132
else
141133
invalid_argv = true;
142134
}
143135

144136
if(invalid_argv)
145-
serial_println("led command needs \"on\" or \"off\" arg.");
137+
Cli.printf("led command needs \"on\" or \"off\" arg.\n");
146138
}
147139
else if(strcmp(cli_read.cmd, "version") == 0)
148140
{
149-
serial_print("Fw Version: ");
150-
serial_println(FW_APP_VERSION);
141+
Cli.printf("FW App Version: %s\n", FW_APP_VERSION);
151142
}
152143
// ...
153144
else
154-
serial_println("Unkown command.");
155-
serial_println();
145+
Cli.printf("Unkown command.\n");
146+
Cli.printf("\n");
156147
}
157148
}
158149
}
@@ -176,46 +167,3 @@ static void led_off(void)
176167
{
177168
COMMAND_LED_PORT &= ~(1 << COMMAND_LED_PIN);
178169
}
179-
180-
/*****************************************************************************/
181-
182-
/* Auxiliar Serial Functions */
183-
184-
static void serial_println(void)
185-
{
186-
Serial.write((uint8_t)('\n'));
187-
}
188-
189-
static void serial_print(const char* str)
190-
{
191-
while (*str != '\0')
192-
{
193-
Serial.write(*str);
194-
str = str + 1;
195-
}
196-
}
197-
198-
static void serial_println(const char* str)
199-
{
200-
serial_print(str);
201-
Serial.write((uint8_t)('\n'));
202-
}
203-
204-
static void serial_print(uint8_t data_byte)
205-
{
206-
char str[4];
207-
char* ptr_str = str;
208-
209-
snprintf(str, 4, "%u", data_byte);
210-
while (*ptr_str != '\0')
211-
{
212-
Serial.write(*ptr_str);
213-
ptr_str = ptr_str + 1;
214-
}
215-
}
216-
217-
static void serial_println(uint8_t data_byte)
218-
{
219-
serial_print(data_byte);
220-
serial_println();
221-
}

‎examples/espidf/basic_usage/platformio.ini‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ default_envs = espidf_esp32 ; Build ESP32 with ESP-IDF Framework
2222
;default_envs = espidf_esp32_c3 ; Build ESP32-C3 with ESP-IDF Framework
2323

2424
[env]
25-
lib_deps = [email protected].0
25+
lib_deps = [email protected].1
2626

2727
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
2828

@@ -31,7 +31,7 @@ lib_deps = [email protected]
3131
; ESP-IDF ESP32
3232
[env:espidf_esp32]
3333
platform = [email protected]
34-
board = esp32doit-devkit-v1
34+
board = esp32dev
3535
framework = espidf
3636
build_flags =
3737
-DLOG_LOCAL_LEVEL=ESP_LOG_INFO

‎examples/espidf/basic_usage/src/main.cpp‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/**
22
* @file examples/espidf/basic_usage/main.cpp
33
* @author Jose Miguel Rios Rubio <[email protected]>
4-
* @date 03-06-2021
5-
* @version 1.0.0
4+
* @date 02-04-2022
5+
* @version 1.0.1
66
*
77
* @section DESCRIPTION
88
*
@@ -56,8 +56,8 @@
5656
// Delay milli-seconds Macro
5757
#define delay_ms(x) do { vTaskDelay(x/portTICK_PERIOD_MS); } while(0)
5858

59-
// Current Firmware Version
60-
#define FW_VER "1.0.0"
59+
// Current Firmware Application Version
60+
#define FW_APP_VERSION "1.0.0"
6161

6262
// Command Line Interface Interpreter Thread Stack Size
6363
#define CLI_TASK_STACK 4096
@@ -262,7 +262,7 @@ void cli_interpreter(t_cli_result* cli_read)
262262
else if(strcmp(cli_read->cmd, "version") == 0)
263263
{
264264
printf("ESP-IDF Version: %s\n", esp_get_idf_version());
265-
printf("Firmware Version: %s\n", FW_VER);
265+
printf("FW App Version: %s\n", FW_APP_VERSION);
266266
}
267267
// ...
268268
else

‎examples/linux/basic_usage/build/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ NM = nm --line-numbers --print-size --size-sort --radix=d
6161
SIZE = size
6262

6363
# Setup compilation flags
64-
CFLAGS = -Os -Wall -g -fstack-usage -flto -pthread
64+
CFLAGS = -Os -Wall -g -fstack-usage -flto -pthread -Wno-write-strings
6565
ifeq ($(TEST), 1)
6666
CFLAGS += -DTEST
6767
endif

0 commit comments

Comments
 (0)