File: checkI2CAddress.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 (84 lines) | stat: -rw-r--r-- 2,499 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
78
79
80
81
82
83
84
## Copyright (C) 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{retval} =} checkI2CAddress (@var{ar}, @var{address})
## @deftypefnx {} {@var{retval} =} checkI2CAddress (@var{ar}, @var{address}, @var{bus})
## Check that an address of given address responds on the I2C bus
##
## @subsubheading Inputs
## @var{ar} - arduino object connected to a arduino board.
##
## @var{address} - I2C address number to check
##
## @var{bus} - bus number to check for I2C device, when multiple buses are available.
## If the bus is not specified, it will default to 0.
## 
## @subsubheading Outputs
## @var{retval} - boolean value of true if address responds on the I2C bus
##
## @subsubheading Example
## @example
## @code {
## # create arduino connection.
## ar = arduino();
## # scan for devices on the I2C bus
## checkI2CAddress (ar)
## # output if a device using that address is attached
## ans =
##   1
## }
## @end example
##
## @seealso{arduino, scanI2Cbus}
## @end deftypefn

function ret = checkI2CAddress (ar, address, bus)

  persistent ARDUINO_I2C_SCAN = 0;

  ret = false;

  if nargin < 2 || nargin > 3
    print_usage ();
  endif

  if nargin == 2
    bus = 0;
  elseif !isnumeric (bus) || bus < 0 || bus > 1
    error ('checkI2CAddress: expected bus to be numeric and 0 or 1');
  endif

  if (!isa (ar, "arduino"))
    error ("checkI2CAddress: expects arduino object as 1st argument");
  endif

  if !isnumeric (address) || address < 1 || address > 127
    error ('checkI2CAddress: expected address to be numeric 1 > address <= 127');
  endif
  
  # TODO: configure SPI pins if not already done??

  [tmp, sz] = sendCommand (ar, "i2c", ARDUINO_I2C_SCAN, [bus address]);
  if tmp(3) == 1
    ret = true;
  endif
endfunction

%!test
%! ar = arduino();
%! assert(!isempty(ar));
%! checkI2CAddress(ar, 12);