summaryrefslogtreecommitdiff
path: root/help/en_US/AVRPWM1SetDuty.xml
diff options
context:
space:
mode:
Diffstat (limited to 'help/en_US/AVRPWM1SetDuty.xml')
-rw-r--r--help/en_US/AVRPWM1SetDuty.xml66
1 files changed, 66 insertions, 0 deletions
diff --git a/help/en_US/AVRPWM1SetDuty.xml b/help/en_US/AVRPWM1SetDuty.xml
new file mode 100644
index 0000000..83230ea
--- /dev/null
+++ b/help/en_US/AVRPWM1SetDuty.xml
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+ *
+ * This help file was generated from AVRPWM1SetDuty.sci using help_from_sci().
+ *
+ -->
+
+<refentry version="5.0-subset Scilab" xml:id="AVRPWM1SetDuty" xml:lang="en"
+ xmlns="http://docbook.org/ns/docbook"
+ xmlns:xlink="http://www.w3.org/1999/xlink"
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns:ns3="http://www.w3.org/1999/xhtml"
+ xmlns:mml="http://www.w3.org/1998/Math/MathML"
+ xmlns:scilab="http://www.scilab.org"
+ xmlns:db="http://docbook.org/ns/docbook">
+
+ <refnamediv>
+ <refname>AVRPWM1SetDuty</refname>
+ <refpurpose>Function to Set Duty cycle of PWM Output generated by Timer1 at OC1A or OC1B pin.</refpurpose>
+ </refnamediv>
+
+
+<refsection>
+ <title>Parameters</title>
+ <variablelist>
+ <varlistentry><term>ouput_pin:</term>
+ <listitem><para> integer, 0 (for OC1A) or 1 (for OC1B)</para></listitem></varlistentry>
+ <varlistentry><term>duty:</term>
+ <listitem><para> It holds an integer value from 0 to 100 which sets the percentage of time for which signal is active.</para></listitem></varlistentry>
+ <varlistentry><term>Top_Value:</term>
+ <listitem><para> It holds an integer value from 0 to 65535.This value sets the Top value of the counter TCNT1 i.e ICR.(for more info refer datasheet)</para></listitem></varlistentry>
+ </variablelist>
+</refsection>
+
+<refsection>
+ <title>Description</title>
+ <para>
+Each Micro controller has PWM output pins which can generate varying voltage
+from 0V-5V.This function Sets the duty cycle of output PWM signal.Also this function
+decides the Top Vale of TCNT1 and the output pin to output PWM signal.
+ </para>
+ <para>
+This is curretly dummy function. It provides no functionality but is required
+for providing support for generating C code for AVR.
+ </para>
+ <para>
+Example
+AVRPWM1SetDuty(0,50,40000); //This function will produce PWM signal of 50% duty cycle on OC1A pin and TCNT1 will reset at 40000 instead at 65535.
+</para>
+</refsection>
+
+<refsection>
+ <title>See also</title>
+ <simplelist type="inline">
+ <member><link linkend="AVRPWM1Setup">AVRPWM1Setup</link></member>
+ </simplelist>
+</refsection>
+
+<refsection>
+ <title>Authors</title>
+ <simplelist type="vert">
+ <member>Ashish Kamble</member>
+ </simplelist>
+</refsection>
+</refentry>