dryer_cntrl/help.cpp at main · dancesWithMachines/dryer_cntrl · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
#include <Arduino.h>

const char * logo = "             __--^^|\r\n"
                    "       __--^^      |\r\n"
                    " __--^^      __--^^ \r\n"
                    "|           | .--^^|\r\n"
                    "|__--^^|    | |    |\r\n"
                    ".--^^| |    | |    |\r\n"
                    "|    | |    | |    |\r\n"
                    "|    | |    | |    |\r\n"
                    "|    | |    | |    |\r\n"
                    "|    | |    | |__--^\r\n"
                    "|    | |__--^\r\n"
                    "|__--^";

const char * author = "Mateusz Kusiak (Timax)\r\n"
                      "@dancesWithMachines";

const char * syntax = "Syntax: [MODE] [PARAM] [VALUE](in \"set\" mode)";

const char * modes = "Modes:\r\n"
                     "* get - retreive information,\r\n"
                     "* set - set parameters,\r\n"
                     "* help - print this message.";

const char * params = "Parameters:\r\n"
                      "* temp:\r\n"
                      "  * [get MODE] Get temperature from RP2040 internal sensor. Unit is degrees Celcius.\r\n"
                      "  * [set MODE] Set target temperature. Allowed values 45-65. Unit is degrees Celcius.\r\n"
                      "* time:\r\n"
                      "  * [get MODE] Get estimated time till finish. Counts time using RP2040 hardware timer.\r\n"
                      "  * [set MODE] Set target time. Allowed values 0-24. Unit is hours.\r\n"
                      "* state:\r\n"
                      "  * [get MODE] Check if job is currently running. Returns either \"running\" or \"stopped\".\r\n"
                      "  * [set MODE] \"start\" starts the job, \"stop\" stops the job.";

const char * flow = "Flow:\r\n"
                    "1. Set up temperature and time.\r\n"
                    "2. Set state to \"start\" to start the job.\r\n"
                    "Notes:\r\n"
                    "Once the job is running, the settings are applied live.\r\n"
                    "You can stop the job by setting state to \"stop\", this does not reset set up values.";

const char * responses = "Responses:\r\n"
                         "* Responses follow <state> or <state>:<value> format.\r\n"
                         "* Status is either \"OK\" on success or \"ERR\" on failure.\r\n"
                         "* If function provides any feedback, it will be printed after \":\".";

bool boot = true;

void printHelp() {
  if (boot) {
    Serial.printf("%s\r\n%s\r\n\r\n", logo, author);
    boot = false;
  }
  Serial.println(syntax);
  Serial.println(modes);
  Serial.println(params);
  Serial.println(flow);
  Serial.println(responses);
}