File: OctaveSerialLibrary.cpp

package info (click to toggle)
octave-arduino 0.12.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, trixie
  • size: 2,616 kB
  • sloc: cpp: 3,221; python: 438; makefile: 152; xml: 22; sh: 1
file content (294 lines) | stat: -rw-r--r-- 8,504 bytes parent folder | download | duplicates (2)
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
/*
 * Octave arduino serial interface
 * Copyright (C) 2019 John Donoghue <john.donoghue@ieee.org>
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/
#include "settings.h"
#include "OctaveSerialLibrary.h"

#define ARDUINO_CONFIGSERIAL   1
#define ARDUINO_WRITESERIAL    2
#define ARDUINO_READSERIAL     3
#define ARDUINO_STATSERIAL     4

#ifdef USE_SERIAL

#if defined(ARDUINO_AVR_NANO_EVERY)
# ifndef SERIAL_PORT_HARDWARE_OPEN
#  define SERIAL_PORT_HARDWARE_OPEN SERIAL_PORT_HARDWARE
# endif
#endif

#ifndef SERIAL_PORT_HARDWARE_OPEN
  #error "This device does not support the serial octave serial interface"
#endif

#if defined(ARDUINO_SAM_DUE)
static USARTClass * serial[] = {
#else
static HardwareSerial * serial[] = {
#endif
#ifdef SERIAL_PORT_HARDWARE_OPEN1
 0,
#endif
#ifdef SERIAL_PORT_HARDWARE_OPEN2
 0,
#endif
#ifdef SERIAL_PORT_HARDWARE_OPEN3
 0,
#endif
 0
};
#define NUM_SERIAL_PORTS (sizeof(serial)/sizeof(HardwareSerial*))
#endif

OctaveSerialLibrary::OctaveSerialLibrary (OctaveArduinoClass &oc) 
{
  libName = "Serial";

  oc.registerLibrary (this);
}

void
OctaveSerialLibrary::setup () 
{
#ifdef USE_SERIAL
  serial[0] = &SERIAL_PORT_HARDWARE_OPEN;
#ifdef SERIAL_PORT_HARDWARE_OPEN1
  serial[1] = &SERIAL_PORT_HARDWARE_OPEN1;
#endif
#ifdef SERIAL_PORT_HARDWARE_OPEN2
  serial[2] = &SERIAL_PORT_HARDWARE_OPEN2;
#endif
#ifdef SERIAL_PORT_HARDWARE_OPEN3
  serial[3] = &SERIAL_PORT_HARDWARE_OPEN3;
#endif
#endif
  OctaveLibraryBase::setup ();
}

void
OctaveSerialLibrary::commandHandler (uint8_t cmdID, uint8_t* data, uint8_t datasz)
{
  switch (cmdID)
    {
#ifdef USE_SERIAL
      case ARDUINO_WRITESERIAL:
        {
          if (datasz < 2 || datasz > 32)
            {
              // id
              // data
	      sendInvalidNumArgsMsg ();
            }
          else if (data[0] < 1 || data[0] > NUM_SERIAL_PORTS)
            { 
              sendErrorMsg_P (ERRORMSG_INVALID_DEVICE);
            }
          else
            {
              uint8_t id = data[0]-1;
	      serial[id]->write (&data[1], datasz-1);

              data[1] = 1;

              sendResponseMsg (cmdID, data, 2);
            }
          break;
        }
      case ARDUINO_READSERIAL:
        {
          if (datasz != 3)
            {
              // port
              // numbytes
	      // timeout in 10th of second
              sendInvalidNumArgsMsg ();
            }
          else if (data[0] < 1 || data[0] > NUM_SERIAL_PORTS)
            { 
              sendErrorMsg_P (ERRORMSG_INVALID_DEVICE);
            }
          else
            {
              uint8_t id = data[0]-1;
	      uint8_t timeout = data[2];

              byte c = 0;
              byte l = data[1];

	      // if have a timeout, try wait that time for enough data before returning
              if (timeout > 0)
	        {
	          sendWaitMsg ();

                  unsigned long t = millis();
	          unsigned long e = t + timeout * 100; // 10th of a seconf to millis

	          while (e > t && serial[id]->available() < l)
	            {
                      t = millis();
	            }
	        }

              datasz = 1;
              for (c=0; c<l; c++)
                {
                  if (serial[id]->available ())
                    {
                      data[datasz] = serial[id]->read ();
                      datasz ++;
                    }
                }

              sendResponseMsg(cmdID,data, datasz);
            }
          break;
        }
      case ARDUINO_STATSERIAL:
        {
          if (datasz != 1)
            {
              // port
              sendInvalidNumArgsMsg ();
            }
          else if (data[0] < 1 || data[0] > NUM_SERIAL_PORTS)
            { 
              sendErrorMsg_P (ERRORMSG_INVALID_DEVICE);
            }
          else
            {
              uint8_t id = data[0]-1;
              data[1] = serial[id]->available ();
              sendResponseMsg (cmdID, data, 2);
            }
          break;
        }
      case ARDUINO_CONFIGSERIAL:
        {
          if (datasz > 0 && (data[0] < 1 || data[0] > NUM_SERIAL_PORTS))
            { 
              sendErrorMsg_P(ERRORMSG_INVALID_DEVICE);
            }
          // enable
          else if (datasz == 9 && data[1] == 1)
            {
              uint8_t id = data[0]-1;
              // data[1] = enable
              uint32_t baud = ((uint32_t)data[2]<<24) | ((uint32_t)data[3]<<16) | ((uint32_t)data[4]<<8) | data[5];
#if defined(ARDUINO_SAM_DUE) || defined(ARDUINO_ARCH_RP2040) || defined(ARDUINO_SAMD_MKR1000)
              uint32_t conf = 0;
#else
              uint8_t conf = 0;
#endif
              // data[6] = databits
              // data[7] = stopbits
              // data[8] = parity
              if (data[8] == 2) // parity even
                {
                  if (data[7] == 1)
                    {
                      switch (data[6])
                        {
	                  case 5: conf = SERIAL_5E1; break;
	                  case 6: conf = SERIAL_6E1; break;
	                  case 7: conf = SERIAL_7E1; break;
	                  default: conf = SERIAL_8E1; break;
                        }
                    }
                  else // 2 stop bits
                    {
                      switch (data[6])
                        {
	                  case 5: conf = SERIAL_5E2; break;
	                  case 6: conf = SERIAL_6E2; break;
	                  case 7: conf = SERIAL_7E2; break;
	                  default: conf = SERIAL_8E2; break;
                        }
                    }
                }
              else if (data[8] == 1) // parity odd
                {
                  if (data[7] == 1)
                    {
                      switch (data[6])
                        {
	                  case 5: conf = SERIAL_5O1; break;
	                  case 6: conf = SERIAL_6O1; break;
	                  case 7: conf = SERIAL_7O1; break;
	                  default: conf = SERIAL_8O1; break;
                        }
                    }
                  else // 2 stop bits
                    {
                      switch (data[6])
                        {
	                  case 5: conf = SERIAL_5O2; break;
	                  case 6: conf = SERIAL_6O2; break;
	                  case 7: conf = SERIAL_7O2; break;
	                  default: conf = SERIAL_8O2; break;
                        }
                    }
                }
              else // parity none
                {
                  if (data[7] == 1)
                    {
                      switch (data[6])
                        {
	                  case 5: conf = SERIAL_5N1; break;
	                  case 6: conf = SERIAL_6N1; break;
                          case 7: conf = SERIAL_7N1; break;
                          default: conf = SERIAL_8N1; break;
                        }
                    }
                  else // 2 stop bits
                    {
                      switch (data[6])
                        {
                          case 5: conf = SERIAL_5N2; break;
                          case 6: conf = SERIAL_6N2; break;
                          case 7: conf = SERIAL_7N2; break;
                          default: conf = SERIAL_8N2; break;
                        }
                    }
                }

#if defined(ARDUINO_SAM_DUE)
            serial[id]->begin (baud, (USARTClass::USARTModes)conf);
#else
            serial[id]->begin (baud, conf);
#endif
            sendResponseMsg (cmdID, data, 2);
          }
        // disable
        else if (datasz == 2 && data[1] == 0)
          {
            uint8_t id = data[0]-1;
            serial[id]->end ();
            sendResponseMsg (cmdID, data, 2);
          }
        else
          {
            sendInvalidNumArgsMsg ();
          }
        break;
      }
#endif
    default:
      sendUnknownCmdIDMsg();
      break;
  }
}