File: getTerminalsFromPins.m

package info (click to toggle)
octave-arduino 0.12.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,616 kB
  • sloc: cpp: 3,221; python: 438; makefile: 152; xml: 22; sh: 1
file content (51 lines) | stat: -rw-r--r-- 1,657 bytes parent folder | download | duplicates (4)
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
## 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.

## -*- texinfo -*- 
## @deftypefn {} {@var{pinnums} =} getTerminalsFromPins (@var{ar}, @var{pins})
## Get the terminal number for each pin.
##
## @subsubheading Inputs
## @var{ar} - connected arduino object
##
## @var{pins} - single pin name or cell or vector array of pin names.
##
## @subsubheading Outputs
## @var{pinnums} - pin number of each named pin. If the input was a single string, returns a number.
## if the input pins was a vector or cell array, return a cell array of pin numbers corresponding
## to each input pin name.
##
## @seealso{arduino, getPinsFromTerminals}
## @end deftypefn

function retval = getTerminalsFromPins(obj, pins)

  if nargin != 2
    print_usage()
  endif

  if iscell (pins)
    retval = {};
    for i=1:numel(pins)
      retval{end+1} = obj.get_pin(pins{i}).id;
    endfor
  elseif ischar(pins)
    retval = obj.get_pin(pins).id;
  elseif isvector (pins)
    retval = {};
    for i=1:numel(pins)
      retval{end+1} = obj.get_pin(pins(i)).id;
    endfor
  else
    error ("getTerminalFromPins: expected pins as cell or string");
  endif
endfunction