File: readCount.m

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 (77 lines) | stat: -rw-r--r-- 2,571 bytes parent folder | download | duplicates (3)
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
## Copyright (C) 2018 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{count}, @var{time}] =} readCount (@var{obj})
## @deftypefnx {} {[@var{count}, @var{time}] =} readCount (@var{obj}, @var{name}, @var{value})
## read count value from the rotary encoder.
##
## subsubheading Inputs
## @var{obj} - rotary encoder object created with rotaryEncoder call.
##
## @var{name}, @var{value} - optional name,value pairs
##
## Valid option name pairs currently are:
## @table @asis
## @item reset
## Reset the count after reading (if true)
## @end table
##
## @subsubheading Outputs
## @var{count} - returned count read from the encoder.
##
## @var{time} - seconds since arduino started
##
## @seealso{rotaryEncoder, resetCount}
## @end deftypefn

function [value, time] = readCount(obj, reset, resetvalue)
  persistent ARDUINO_ROTARYENCODER_READCOUNT = 2;

  if nargin != 1 && nargin != 3
    error ("arduino: expected rotaryencoder object and optional property name, value pairs");
  endif

  if nargin != 3
    reset = "reset";
    resetvalue = false;
  endif

  if !strcmpi (reset, "reset")
    error ("arduino: expected property name of 'reset'");
  endif
  if !(isnumeric(resetvalue) || islogical(resetvalue)) || (resetvalue != 0 && resetvalue != 1)
    error ("arduino: expected resetvalue of 0 or 1");
  endif
 
  # attempt to clock out precision bits
  [tmp, sz] = sendCommand(obj.parent, "rotaryencoder", ARDUINO_ROTARYENCODER_READCOUNT, [obj.id resetvalue]);
  value = typecast(uint16(tmp(2))*256 + uint16(tmp(3)), 'int16');

  time = uint32(tmp(4))*(256*256*256) + uint32(tmp(5))*(256*256) + uint32(tmp(6))*256 + uint32(tmp(7));
  time = double(time)/1000.0;
endfunction

%!test
%! ar = arduino ();
%! e = rotaryEncoder(ar, "d2","d3");
%! readCount(e);
%! readCount(e, "reset", 0);
%! readCount(e, "reset", 1);
%! readCount(e, "reset", true);
%! delete(e)

%!error readCount();