Unlock the Full Potential of Your Arduino - Interactive Terminal

1/*
2 * Created on Aug 10 2020
3 *
4 * Copyright (c) 2023 - Daniel Hajnal
5 * hajnal.daniel96@gmail.com
6 * This file is part of the Shellminator project.
7 * Modified 2023.05.13
8*/
9
10
11#include "Commander-API.hpp"
12#include "Shellminator.hpp"
13#include "Shellminator-Commander-Interface.hpp"
14
15
16// We have to create an object from Commander class.
17Commander commander;
18
19bool millis_func( char *args, CommandCaller* caller );
20bool dog_func( char *args, CommandCaller* caller );
21bool sum_func( char *args, CommandCaller* caller );
22
23Commander::systemCommand_t API_tree[] = {
24    systemCommand( "millis", "Prints milliseconds since program start", millis_func ),
25    systemCommand( "dog", "Description for dog command.", dog_func ),
26    systemCommand( "sum", "This function sums two number from the argument list.", sum_func )
27};
28
29// Create a ShellminatorCommanderInterface object, and initialize it to use Serial
30ShellminatorCommanderInterface shell( &Serial );
31
32
33
34
35// System init section.
36void setup(){
37
38    Serial.begin(115200);
39
40    // Clear the terminal
41    shell.clear();
42
43    commander.attachDebugChannel( &Serial );
44    commander.attachTree( API_tree );
45    commander.init();
46
47    shell.attachCommander( &commander );
48
49    // Initialize shell object.
50    shell.begin( "arnold" );
51
52
53}
54
55// Infinite loop.
56void loop(){
57
58    // Process the new data.
59    shell.update();
60
61
62}
63
64/// This is an example function for the cat command
65bool millis_func(char *args, CommandCaller* caller ){
66
67    caller -> println( millis() );
68    return true;
69
70}
71
72/// This is an example function for the dog command
73bool dog_func(char *args, CommandCaller* caller ){
74
75    caller -> print("Hello from dog function!\r\n");
76    return true;
77
78}
79
80/// This is an example function for the sum command
81bool sum_func(char *args, CommandCaller* caller ){
82
83    // These variables will hold the value of the
84    // two numbers, that has to be summed.
85    int a = 0;
86    int b = 0;
87
88    // This variable will hold the result of the
89    // argument parser.
90    int argResult;
91
92    // This variable will hold the sum result.
93    int sum = 0;
94
95    argResult = sscanf( args, "%d %d", &a, &b );
96
97    // We have to check that we parsed successfully the two
98    // numbers from the argument string.
99    if( argResult != 2 ){
100
101        // If we could not parse two numbers, we have an argument problem.
102        // We print out the problem to the response channel.
103        caller -> print( "Argument error! Two numbers required, separated with a blank space.\r\n" );
104
105        // Sadly we have to stop the command execution and return.
106        return false;
107
108    }
109
110    // Calculate the sum.
111    sum = a + b;
112
113    // Print out the result.
114    caller -> print( a );
115    caller -> print( " + " );
116    caller -> print( b );
117    caller -> print( " = " );
118    caller -> println( sum );
119    return true;
120}