File: uptime.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 (59 lines) | stat: -rw-r--r-- 1,795 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
52
53
54
55
56
57
58
59
## 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{sec} =} uptime (@var{ar})
## Get the number of seconds the arduino board has been running concurrently.
##
##
## @subsubheading Inputs
## @var{ar} - the arduino object of the connection to an arduino board.
##
## @subsubheading Outputs
## @var{sec} - the number seconds the board has been running. Note that the count will wrap around after
## approximately 50 days.
##
## @seealso{arduino}
##
## @end deftypefn

function retval = uptime (obj)

  persistent ARDUINO_UPTIME = 21;

  if nargin != 1
    error ("@arduino.version expects no arguments");
  endif

  [dataout, status] = __sendCommand__ (obj, 0, ARDUINO_UPTIME, []);
    
  if status != 0
    error ("@arduino.uptime: failed err=%d - %s", status, char(dataout));
  else
    value = uint32(dataout(1))*256*256*256 + uint32(dataout(2))*256*256 + uint32(dataout(3))*256 + uint32(dataout(4));
    retval = double(value)/1000.0;
  endif
  
endfunction

%!test
%! ar = arduino();
%! assert(!isempty(ar));
%! t1 = uptime(ar);
%! pause (1);
%! t2 = uptime(ar);
%! assert(t1 < t2);