File: writePWMVoltage.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 (73 lines) | stat: -rw-r--r-- 2,122 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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
## 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 {} {} writePWMVoltage (@var{ar}, @var{pin}, @var{voltage})
## Emulate an approximate voltage out of a pin using PWM.
##
## @subsubheading Inputs
## @var{ar} - connected arduino object
##
## @var{pin} - pin to write to.
##
## @var{voltage} - voltage to emulate with PWM, between 0 - 5.0
##
## @subsubheading Example
## @example
## @code{
## a = arduino();
## writePWMVoltage(a,'D5',1.0);
## }
## @end example
##
## @seealso{arduino, writePWMDutyCycle}
## @end deftypefn

function writePWMVoltage (obj, pin, value)
  if nargin < 3
    error ("@arduino.writePWMVoltage: expected pin name and value");
  endif

  # TODO: need look at board type for what voltage range is allowed
  # and convert
  maxvolts = obj.board_voltage();
  if !isnumeric(value) || value < 0 || value > maxvolts
    error('writePWMVoltage: value must be between 0 and %f', maxvolts);
  endif

  # assuming here for now 0 .. 5V is linear to 0 - 100% pwm
  val = value/maxvolts;
  writePWMDutyCycle(obj, pin, val);
  
endfunction

%!shared ar, pwmpin
%! ar = arduino();
%! pwmpin = getPinsFromTerminals(ar, getPWMTerminals(ar)){1};

%!test
%! writePWMVoltage(ar, pwmpin, ar.AnalogReference);

%!error <undefined> writePWMVoltage();

%!error <expected> writePWMVoltage(ar)

%!error <expected pin> writePWMVoltage(ar, pwmpin)

%!error <unknown pin> writePWMVoltage(ar, "xd1", 1)

%!error <value must be between> writePWMVoltage(ar, pwmpin, -1)

%!error <value must be between> writePWMVoltage(ar, pwmpin, 5.1)

%!test
%! writePWMVoltage(ar, pwmpin, 0.0);