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
|
## Copyright (C) 2018-2020 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/>.
classdef shiftRegister < handle
## -*- texinfo -*-
## @deftypefn {} {@var{register} =} shiftRegister (@var{ar}, @var{shifttype}, @var{dataPin}, @var{clockPin} ...)
## @deftypefnx {} {@var{register} =} shiftRegister (@var{ar},'74hc164', @var{dataPin}, @var{clockPin}, @var{resetPin})
## @deftypefnx {} {@var{register} =} shiftRegister (@var{ar},'74hc165', @var{dataPin}, @var{clockPin}, @var{loadPin}, @var{clockEnablePin})
## @deftypefnx {} {@var{register} =} shiftRegister(@var{ar},'74hc595', @var{dataPin}, @var{clockPin}, @var{latchPin} , @var{resetPin})
## Create shift register of a given type, controlled by the input pins.
##
## @subsubheading Inputs
## Common function parameter definition:
##
## @var{ar} - connected arduino object.
##
## @var{shifttype} - string name of the shift register type.
##
## @var{dataPin} - pin used for data in/out of the device.
##
## @var{clockPin} - pin used for clocking data on the shiftRegister.
##
##
## Other variables are dependent on the shift register type:
## @table @asis
## @item '74hc164'
## Additional inputs:
##
## @var{resetPin} - optional pin for resetting the shift register.
##
## @item '74hc165'
## Additional inputs:
##
## @var{loadPin} - load pin to the shift register.
## @var{clockEnablePin} - clock enable pin.
##
## @item '74hc595'
## Additional inputs:
##
## @var{latchPin} - latching data to the shift register.
## @var{resetPin} - optional pin for resetting the shift register.
##
## @end table
##
## @subsubheading Outputs
## @var{register} - register object
##
## @subsubheading Properties
## The shiftRegister object has the following public properties:
## @table @asis
## @item parent
## The parent (arduino) for this device
## @item pins
## pins used by this object
## @item model
## model set for object
## @end table
##
## @seealso{arduino}
## @end deftypefn
properties (Access = private)
parent = [];
model = "none";
datapin = "";
clockpin = "";
id = 0;
pins = {};
resourceowner = "";
endproperties
methods (Access = public)
function p = shiftRegister(ar,type,dataPin,clockPin, varargin)
persistent ARDUINO_SHIFTREG_CONFIG = 1;
if (nargin == 1 && isa (ar, "shiftRegister"))
register = ar; # Copy constructor
elseif nargin < 4
error ('Expected type, dataPin and clockPin');
else
p.parent = ar;
p.model = toupper(type);
p.datapin = dataPin;
p.clockpin = clockPin;
p.id = 0;
pins = {};
pins{end+1} = ar.get_pin(dataPin);
pins{end}.func = "datapin";
# datapin used also to address this register
p.id = pins{1}.id;
name = ["shiftregister_" pins{1}.name];
p.resourceowner = name;
count = getResourceCount(ar, name);
if count > 0
error ("@shiftRegister.shiftRegister: already have a shift register using this pin");
endif
pins{end+1} = ar.get_pin(clockPin);
pins{end}.func = "clockpin";
init_data = [];
switch (p.model)
case '74HC164'
init_data = [0 pins{2}.id];
case '74HC165'
init_data = [1 pins{2}.id];
if nargin != 6
error('74HC165 expects loadPin and clockEnablePin');
endif
pins{end+1} = ar.get_pin(varargin{1});
pins{end}.func = "loadpin";
pins{end+1} = ar.get_pin(varargin{2});
pins{end}.func = "clockenablepin";
init_data = [ init_data pins{3}.id pins{4}.id ];
case '74HC595'
init_data = [2 pins{2}.id];
if nargin != 5 && nargin != 6
error('74HC595 expects latchPin and optional resetPin');
endif
pins{end+1} = ar.get_pin(varargin{1});
pins{end}.func = "latchpin";
init_data = [ init_data pins{end}.id ];
# optional reset
if nargin == 6
pins{end+1} = ar.get_pin(varargin{2});
pins{end}.func = "resetpin";
init_data = [ init_data pins{end}.id ];
endif
otherwise
error ("Unknown shiftRegister type '%s'", p.model);
endswitch
# verify pins support digital i/o
for i = 1:numel(pins)
pin = pins{i}.name;
validatePin(ar, pin, "digital");
endfor
p.pins = pins;
# TODO: save old modes and set them via force if we fail trying to alloc the whole group
try
for i=1:numel(pins)
pin = pins{i}.name;
configurePin(ar, pin, "digitaloutput");
endfor
[tmp, sz] = sendCommand(ar, "shiftregister", ARDUINO_SHIFTREG_CONFIG, [p.id 1 init_data]);
incrementResourceCount(ar, name);
catch
# restore pin state
for i=1:numel(pins)
pin = pins{i};
configurePinResource(ar, pin.name, pin.owner, pin.mode, true)
configurePin(ar, pin.name, pin.mode)
endfor
rethrow (lasterror);
end_try_catch
#p.cleanup = onCleanup (@() cleanupShiftRegister (ar, name, pins));
endif
endfunction
endmethods
endclassdef
%!shared ar
%! ar = arduino();
%!test
%! # validate pins not allocated
%! assert(configurePin(ar, "d2"), "unset");
%! assert(configurePin(ar, "d3"), "unset");
%!
%! register = shiftRegister(ar, '74hc164', "d2", "d3");
%! assert (isa (register, "shiftRegister"))
%!
%! #pins allocated ?
%! assert(configurePin(ar, "d2"), "digitaloutput");
%! assert(configurePin(ar, "d3"), "digitaloutput");
%!
%! #free
%! delete(register)
%! assert(configurePin(ar, "d2"), "unset");
%! assert(configurePin(ar, "d3"), "unset");
|
