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 85 86 87 88 89 90 91 92 93
|
## 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 {} {} writePWMDutyCyle (@var{ar}, @var{pin}, @var{value})
## Set pin to output a square wave with a specified duty cycle.
##
## @subsubheading Inputs
## @var{ar} - connected arduino object
##
## @var{pin} - pin to write to.
##
## @var{value} - duty cycle value where 0 = off, 0.5 = 50% on, 1 = always on.
##
## @subsubheading Example
## @example
## @code{
## a = arduino();
## writePWMDutyCycle(a,'D5',0.5);
## }
## @end example
##
## @seealso{arduino, writePWMVoltage}
##
## @end deftypefn
function writePWMDutyCycle (obj, pin, value)
ARDUINO_PWM = 5;
if nargin < 3
error ("@arduino.writePWMDutyCycle: expected pin name and value");
endif
if !ischar(pin) && !isnumeric(pin)
error ("@arduino.writePWMDutyCycle: expected pin name as string");
endif
if (!isnumeric(value) || value > 1.0 || value < 0)
error ("@arduino.writePWMDutyCycle: expected value between 0 .. 1");
endif
pininfo = obj.get_pin(pin);
# first use ?
if strcmp(pininfo.mode, "unset")
configurePin(obj, pin, "pwm")
else
[pinstate, pinmode] = pinStateMode(pininfo.mode);
if !strcmp(pinmode, "pwm")
error ("@arduino.PWMDutyCycle: pin is in incompatable mode");
endif
endif
val = 255*value;
datain = uint8([pininfo.id val]);
[dataout, status] = __sendCommand__ (obj, 0, ARDUINO_PWM, datain);
if status != 0
error ("@arduino.writePWMDutyCycle: failed to set pin state err=%d - %s", status, char(dataout));
endif
endfunction
%!shared ar, pwmpin
%! ar = arduino();
%! pwmpin = getPinsFromTerminals(ar, getPWMTerminals(ar)){1};
%!test
%! writePWMDutyCycle(ar, pwmpin, 0.5);
%!error <undefined> writePWMDutyCycle();
%!error <expected> writePWMDutyCycle(ar)
%!error <expected pin> writePWMDutyCycle(ar, pwmpin)
%!error <unknown pin> writePWMDutyCycle(ar, "xd1", 1)
%!error <expected value between> writePWMDutyCycle(ar, pwmpin, -1)
%!error <expected value between> writePWMDutyCycle(ar, pwmpin, 1.1)
%!test
%! writePWMDutyCycle(ar, pwmpin, 0.0);
|