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
|
## Copyright (C) 2018-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/>.
## -*- texinfo -*-
## @deftypefn {} {@var{retval} =} arduinosetup ()
## @deftypefnx {} {@var{retval} =} arduinosetup (@var{propertyname}, @var{propertyvalue})
## Open the arduino config / programming tool to program the arduino hardware for usage with
## the Octave arduino functions.
##
## arduinosetup will create a temporary project using the arduino IDE and allow
## compiling and programming of the code to an arduino.
##
## @subsubheading Inputs
##
## @var{propertyname}, @var{propertyvalue} - A sequence of property name/value pairs can be given
## to set defaults while programming.
##
## Currently the following properties can be set:
## @table @asis
## @item libraries
## The value should be the name of a library, or string array of libraries to program on the
## arduino board.
## @item arduinobinary
## The value should be the name/path of the arduino IDE binary for programming. If not specified,
## the function will use getpref preferences of arduino.arduino_binary, and if not found, the
## function will attempt to find the binary itself.
##
## If provided, the value will be saved to preferences for future calls.
## @end table
##
## @subsubheading Outputs
## @var{retval} - return 1 if arduino IDE returned without an error
##
## @seealso{arduino, __arduino_binary__}
## @end deftypefn
function retval = arduinosetup (varargin)
retval = 0;
if mod (nargin, 2) != 0
error ("arduinosetup: expected property name, value pairs");
endif
if !iscellstr (varargin(1:2:nargin))
error ("arduinosetup: expected property names to be strings");
endif
libs = {};
arduinobinary = {};
debug = false;
baudrate = [];
def_baudrate = 9600;
for i = 1:2:nargin
propname = tolower (varargin{i});
propvalue = varargin{i+1};
if strcmp (propname, "libraries")
if iscell (propvalue)
libs = propvalue;
elseif ischar (propvalue)
libs{end+1} = propvalue;
else
error ("arduinosetup Expected libraries to be a cellarray or string");
endif
elseif strcmp (propname, "arduinobinary")
arduinobinary = propvalue;
elseif strcmp (propname, "baudrate")
baudrate = int32(propvalue);
elseif strcmp (propname, "debug")
debug = propvalue;
elseif
warning ("arduinosetup: unknown property '%s', ignoring it", propname);
endif
endfor
if isempty(libs)
# default libs if not are provided
libs{end+1} = "SPI";
libs{end+1} = "I2C";
libs{end+1} = "Servo";
libs{end+1} = "ShiftRegister";
endif
# we have the libs ?
availlibs = listArduinoLibraries ();
addonlibs = __addons__ ();
# for any addons, check the dependancies and add it we need to
for i = 1:numel(libs)
idx = find (cellfun(@(x) strcmpi(x.libraryname, libs{i}), addonlibs), 1);
if !isempty(idx)
lib = addonlibs{idx};
for n = 1:numel(lib.dependentlibraries)
addlib = lib.dependentlibraries{n};
idx = find (cellfun(@(x) strcmpi(x, addlib), libs), 1);
if isempty(idx)
libs{end+1} = addlib;
if (debug)
printf("arduinosetup: adding %s as a dependency\n", addlib);
endif
endif
endfor
endif
endfor
builtinlibs = {};
for i = 1:numel(libs)
idx = find (cellfun(@(x) strcmpi(x.libraryname, libs{i}), addonlibs), 1);
if isempty(idx)
idx = find (cellfun(@(x) strcmpi(x, libs{i}), availlibs), 1);
if isempty (idx)
error ("arduinosetup: unknown library '%s'", libs{i});
elseif (debug)
printf("arduinosetup: using builtin lib %s\n", libs{i});
endif
builtinlibs{end+1} = libs{i};
libs{i} = [];
else
if (debug)
printf("arduinosetup: using addon lib %s\n", libs{i});
endif
libs{i} = addonlibs{idx};
endif
endfor
libfiles = arduinoio.LibFiles();
if isempty (libfiles)
error ("arduinosetup: couldn't find library files");
endif
# make a temp folder and create a arduino project in it
tmpdir = tempname ();
mkdir (tmpdir);
unwind_protect
mkdir (fullfile (tmpdir, "octave"));
# copy all the libfiles
copyfile (libfiles, fullfile (tmpdir, "octave"));
fd = fopen (fullfile (tmpdir, "octave", "settings.h"), "w+t");
fprintf (fd, "// generated from arduinosetup for buildin library configuration\n");
fprintf (fd, "\n");
fprintf (fd, "// override target voltage (x10) by uncommenting and providing a value\n");
fprintf (fd, "//#define BOARD_VOLTAGE 50\n");
fprintf (fd, "\n");
fprintf (fd, "// override baudrate by providing a value\n");
if !isempty(baudrate)
fprintf (fd, "#define ARDUINO_BAUDRATE %d\n", baudrate);
else
fprintf (fd, "//#define ARDUINO_BAUDRATE %d\n", def_baudrate);
endif
fprintf (fd, "\n");
fprintf (fd, "// builtin library support\n");
idx = find (cellfun(@(x) strcmpi(x, "SPI"), builtinlibs), 1);
if !isempty(idx)
fprintf (fd, "#define USE_SPI\n");
else
fprintf (fd, "//#define USE_SPI\n");
endif
idx = find (cellfun(@(x) strcmpi(x, "I2C"), builtinlibs), 1);
if !isempty(idx)
fprintf (fd, "#define USE_I2C\n");
else
fprintf (fd, "//#define USE_I2C\n");
endif
idx = find (cellfun(@(x) strcmpi(x, "Servo"), builtinlibs), 1);
if !isempty(idx)
fprintf (fd, "#define USE_SERVO\n");
else
fprintf (fd, "//#define USE_SERVO\n");
endif
idx = find (cellfun(@(x) strcmpi(x, "ShiftRegister"), builtinlibs), 1);
if !isempty(idx)
fprintf (fd, "#define USE_SHIFTREG\n");
else
fprintf (fd, "//#define USE_SHIFTREG\n");
endif
idx = find (cellfun(@(x) strcmpi(x, "RotaryEncoder"), builtinlibs), 1);
if !isempty(idx)
fprintf (fd, "#define USE_ROTARYENCODER\n");
else
fprintf (fd, "//#define USE_ROTARYENCODER\n");
endif
idx = find (cellfun(@(x) strcmpi(x, "Ultrasonic"), builtinlibs), 1);
if !isempty(idx)
fprintf (fd, "#define USE_ULTRASONIC\n");
else
fprintf (fd, "//#define USE_ULTRASONIC\n");
endif
idx = find (cellfun(@(x) strcmpi(x, "Serial"), builtinlibs), 1);
if !isempty(idx)
fprintf (fd, "#define USE_SERIAL\n");
else
fprintf (fd, "//#define USE_SERIAL\n");
endif
# if able to do network, add network settings here
fprintf (fd, "//#define OCTAVE_USE_WIFI_COMMS\n");
fprintf (fd, "#ifdef OCTAVE_USE_WIFI_COMMS\n");
fprintf (fd, " // Provide these settings for network use\n");
fprintf (fd, "# define WIFI_SECRET_SSID \"\"\n");
fprintf (fd, "# define WIFI_SECRET_PASS \"\"\n");
fprintf (fd, "# define WIFI_PORT 9500\n");
fprintf (fd, " //uncomment and define if using static IP\n");
fprintf (fd, "//# define WIFI_STATIC_IP \"192.168.0.10\"\n");
fprintf (fd, "#endif");
fclose (fd);
# requested additional libs
fd = fopen (fullfile (tmpdir, "octave", "addons.h"), "w+t");
fprintf(fd, "// generated from arduinosetup for addon library addidtions\n");
for i = 1:numel (libs)
l = libs{i};
if !isempty (l)
if !isempty (l.cppheaderfile)
copyfile (l.cppheaderfile, fullfile(tmpdir, "octave"));
[d,f,e] = fileparts (l.cppheaderfile);
fprintf (fd, '#include "%s%s"\n', f,e);
if !isempty (l.cppclassname)
fprintf (fd, "%s addon%d(octavearduino);\n", l.cppclassname, i);
endif
endif
if !isempty (l.cppsourcefile)
copyfile (l.cppsourcefile, fullfile(tmpdir, "octave"));
endif
endif
endfor
fclose(fd);
# start the arduino ide
if isempty (arduinobinary)
arduinobinary = __arduino_binary__ ();
else
arduinobinary = __arduino_binary__ (arduinobinary);
endif
filename = fullfile (tmpdir, "octave", "octave.ino");
cmdline = sprintf ("\"%s\" \"%s\"", arduinobinary, filename);
printf ("Running %s\n", cmdline);
[status, ~] = system (cmdline);
retval = (status == 0);
unwind_protect_cleanup
confirm_recursive_rmdir (false, "local");
rmdir(tmpdir, "s");
end_unwind_protect
endfunction
|
