mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-25 19:39:32 +01:00
20 lines
No EOL
7.9 KiB
HTML
20 lines
No EOL
7.9 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A single PWM channel / pin"><title>PwmPin in embedded_hal - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="embedded_hal" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-0111fcff984fae8f.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../embedded_hal/index.html">embedded_<wbr>hal</a><span class="version">0.2.7</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">PwmPin</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Duty" title="Duty">Duty</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.disable" title="disable">disable</a></li><li><a href="#tymethod.enable" title="enable">enable</a></li><li><a href="#tymethod.get_duty" title="get_duty">get_duty</a></li><li><a href="#tymethod.get_max_duty" title="get_max_duty">get_max_duty</a></li><li><a href="#tymethod.set_duty" title="set_duty">set_duty</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate embedded_<wbr>hal</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">embedded_hal</a></span><h1>Trait <span class="trait">PwmPin</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/embedded_hal/lib.rs.html#894-915">source</a> </span></div><pre class="rust item-decl"><code>pub trait PwmPin {
|
|
type <a href="#associatedtype.Duty" class="associatedtype">Duty</a>;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.disable" class="fn">disable</a>(&mut self);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.enable" class="fn">enable</a>(&mut self);
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.get_duty" class="fn">get_duty</a>(&self) -> Self::<a class="associatedtype" href="trait.PwmPin.html#associatedtype.Duty" title="type embedded_hal::PwmPin::Duty">Duty</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.get_max_duty" class="fn">get_max_duty</a>(&self) -> Self::<a class="associatedtype" href="trait.PwmPin.html#associatedtype.Duty" title="type embedded_hal::PwmPin::Duty">Duty</a>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.set_duty" class="fn">set_duty</a>(&mut self, duty: Self::<a class="associatedtype" href="trait.PwmPin.html#associatedtype.Duty" title="type embedded_hal::PwmPin::Duty">Duty</a>);
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A single PWM channel / pin</p>
|
|
<p>See <code>Pwm</code> for details</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Duty" class="method"><a class="src rightside" href="../src/embedded_hal/lib.rs.html#899">source</a><h4 class="code-header">type <a href="#associatedtype.Duty" class="associatedtype">Duty</a></h4></section></summary><div class="docblock"><p>Type for the <code>duty</code> methods</p>
|
|
<p>The implementer is free to choose a float / percentage representation
|
|
(e.g. <code>0.0 .. 1.0</code>) or an integer representation (e.g. <code>0 .. 65535</code>)</p>
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.disable" class="method"><a class="src rightside" href="../src/embedded_hal/lib.rs.html#902">source</a><h4 class="code-header">fn <a href="#tymethod.disable" class="fn">disable</a>(&mut self)</h4></section></summary><div class="docblock"><p>Disables a PWM <code>channel</code></p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.enable" class="method"><a class="src rightside" href="../src/embedded_hal/lib.rs.html#905">source</a><h4 class="code-header">fn <a href="#tymethod.enable" class="fn">enable</a>(&mut self)</h4></section></summary><div class="docblock"><p>Enables a PWM <code>channel</code></p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.get_duty" class="method"><a class="src rightside" href="../src/embedded_hal/lib.rs.html#908">source</a><h4 class="code-header">fn <a href="#tymethod.get_duty" class="fn">get_duty</a>(&self) -> Self::<a class="associatedtype" href="trait.PwmPin.html#associatedtype.Duty" title="type embedded_hal::PwmPin::Duty">Duty</a></h4></section></summary><div class="docblock"><p>Returns the current duty cycle</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.get_max_duty" class="method"><a class="src rightside" href="../src/embedded_hal/lib.rs.html#911">source</a><h4 class="code-header">fn <a href="#tymethod.get_max_duty" class="fn">get_max_duty</a>(&self) -> Self::<a class="associatedtype" href="trait.PwmPin.html#associatedtype.Duty" title="type embedded_hal::PwmPin::Duty">Duty</a></h4></section></summary><div class="docblock"><p>Returns the maximum duty cycle value</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.set_duty" class="method"><a class="src rightside" href="../src/embedded_hal/lib.rs.html#914">source</a><h4 class="code-header">fn <a href="#tymethod.set_duty" class="fn">set_duty</a>(&mut self, duty: Self::<a class="associatedtype" href="trait.PwmPin.html#associatedtype.Duty" title="type embedded_hal::PwmPin::Duty">Duty</a>)</h4></section></summary><div class="docblock"><p>Sets a new duty cycle</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../trait.impl/embedded_hal/trait.PwmPin.js" async></script></section></div></main></body></html> |