File: getI2CTerminals.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 (52 lines) | stat: -rw-r--r-- 1,550 bytes parent folder | download | duplicates (2)
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
## 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{pinlist} =} getI2CTerminals (@var{ar})
## @deftypefnx {} {@var{pinlist} =} getI2CTerminals (@var{ar}, @var{bus})
## Get a cell list of pin Ids available are used for I2C mode.
##
## @subsubheading Inputs
## @var{ar} - the arduino object.
##
## @var{bus} - optional bus number 0 or 1 for boards that support more than 1 bus.
##
## @subsubheading Outputs
## @var{pinlist} - cell list of pin numbers available for I2C use.
##
## @seealso{arduino}
## @end deftypefn

function retval = getI2CTerminals (obj, bus)

  if nargin < 1 || nargin > 2
    print_usage()
  endif

  if nargin < 2
    bus = 0;
  endif

  retval = getTypeTerminals(obj, sprintf("i2c%d", bus));
  if isempty(retval) && bus == 0
    retval = getTypeTerminals(obj, "i2c");
  endif

endfunction

%!test
%! ar = arduino();
%! assert(!isempty(ar));
%! terms = getI2CTerminals(ar);
%! assert (numel(terms) > 0)
%! # should be pairs of i2c pins
%! assert (mod(numel(terms),2), 0)