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
|
## 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{currmode} =} configurePinResource (@var{ar}, @var{pin})
## @deftypefnx {} {} configurePinResource (@var{ar}, @var{pin}, @var{owner}, @var{mode})
## @deftypefnx {} {} configurePinResource (@var{ar}, @var{pin}, @var{owner}, @var{mode}, @var{force})
## Set/Get pin mode for a specified pin on arduino connection.
##
## configurePinResource (@var{ar}, @var{pin}) will get the current mode of the specified pin.
##
## configurePinResource (@var{ar}, @var{pin}, @var{owner}, @var{mode}) will attempt set the pin to the specified
## mode and owner.
##
## If the pin is already owned by another owner, the configure will fail unless the force option is used.
## If the mode is already set, configure will fail unless force is used.
##
## @subsubheading Inputs
## @var{ar} - the arduino object of the connection to an arduino board.
##
## @var{pin} - string name of the pin to set/get the mode of.
##
## @var{mode} - string mode to set the pin to.
##
## @var{owner} - string name to use as the pin owner.
##
## @var{force} - boolean to force mode change. If not set, it will be false.
##
## @subsubheading Outputs
## @var{currmode} - current string mode of the pin.
##
## Valid modes can be:
## @itemize @bullet
## @item AnalogInput
## - Acquire analog signals from pin
## @item DigitalInput
## - Acquire digital signals from pin
## @item DigitalOutput
## - Generate digital signals from pin
## @item I2C
## - Specify a pin to use with I2C protocol
## @item Pullup
## - Specify pin to use a pullup switch
## @item PWM
## - Specify pin to use a pulse width modulator
## @item Servo
## - Specify pin to use a servo
## @item SPI
## - Specify a pin to use with SPI protocol
## @item Interrupt
## - Specify a pin to use with interrupts
## @item Reserved
## - Pin marked reserved, but not for of any particular mode
## @item Unset
## - Clears pin designation. The pin is no longer reserved and can be automatically
## set at the next operation.
## @end itemize
##
## @seealso{arduino, configurePin}
## @end deftypefn
function retval = configurePinResource (obj, pin, owner, mode, forceconfig)
if nargin != 2 && nargin != 4 && nargin != 5
error ('@arduino.configurePinResource: invalid number of arduments supplied');
endif
if !ischar(pin)
error ("@arduino.configurePinResource: expected pin name as string");
endif
pininfo = obj.get_pin (pin);
if nargin == 2
% return current mode
retval = pininfo.mode;
else
if nargin == 4
forceconfig = false;
endif
if !isempty (pininfo.owner) && !strcmpi (pininfo.owner, owner) && !forceconfig
error ("@arduino.configurePinResource: pin already owned");
endif
if !strcmpi (pininfo.mode, "unset") && !strcmpi (pininfo.mode, mode) && !forceconfig && !strcmpi (mode, "unset")
error ("@arduino.configurePinResource: pin mode already set");
endif
if (strcmpi (mode, "unset"))
owner = "";
endif
pininfo.owner = owner;
pininfo.mode = mode;
obj.set_pin (pin, pininfo);
endif
endfunction
%!shared ar
%! ar = arduino();
%!test
%! configurePinResource(ar, "d2", "test", "digitaloutput");
%! assert(getResourceOwner(ar,"d2"), "test")
%! assert(getTerminalMode(ar, "d2"), "digitaloutput");
%!test
%! configurePinResource(ar, "a0", "test1", "analoginput");
%! assert(getResourceOwner(ar,"a0"), "test1")
%! assert(getTerminalMode(ar, "a0"), "analoginput");
|
