mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-27 04:19:33 +01:00
120 lines
19 KiB
HTML
120 lines
19 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="Async I2c."><title>I2c in embedded_hal_async::i2c - 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-492a78a4a87dcc01.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="embedded_hal_async" data-themes="" data-resource-suffix="" data-rustdoc-version="1.82.0 (f6e511eec 2024-10-15)" data-channel="1.82.0" data-search-js="search-a99f1315e7cc5121.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-921df33f47b8780c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-3b12f09e550e0385.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_async/index.html">embedded_<wbr>hal_<wbr>async</a><span class="version">1.0.0</span></h2></div><h2 class="location"><a href="#">I2c</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.transaction">transaction</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.read">read</a></li><li><a href="#method.write">write</a></li><li><a href="#method.write_read">write_read</a></li></ul><h3><a href="#foreign-impls">Implementations on Foreign Types</a></h3><ul class="block"><li><a href="#impl-I2c%3CA%3E-for-%26mut+T">&mut T</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In embedded_<wbr>hal_<wbr>async::<wbr>i2c</a></h2></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"><h1>Trait <a href="../index.html">embedded_hal_async</a>::<wbr><a href="index.html">i2c</a>::<wbr><a class="trait" href="#">I2c</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/embedded_hal_async/i2c.rs.html#25-126">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait I2c<A: <a class="trait" href="trait.AddressMode.html" title="trait embedded_hal_async::i2c::AddressMode">AddressMode</a> = <a class="type" href="type.SevenBitAddress.html" title="type embedded_hal_async::i2c::SevenBitAddress">SevenBitAddress</a>>: <a class="trait" href="trait.ErrorType.html" title="trait embedded_hal_async::i2c::ErrorType">ErrorType</a> {
|
||
|
|
// Required method
|
||
|
|
async fn <a href="#tymethod.transaction" class="fn">transaction</a>(
|
||
|
|
&mut self,
|
||
|
|
address: A,
|
||
|
|
operations: &mut [<a class="enum" href="enum.Operation.html" title="enum embedded_hal_async::i2c::Operation">Operation</a><'_>],
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>>;
|
||
|
|
|
||
|
|
// Provided methods
|
||
|
|
async fn <a href="#method.read" class="fn">read</a>(
|
||
|
|
&mut self,
|
||
|
|
address: A,
|
||
|
|
read: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>],
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>> { ... }
|
||
|
|
<span class="item-spacer"></span> async fn <a href="#method.write" class="fn">write</a>(
|
||
|
|
&mut self,
|
||
|
|
address: A,
|
||
|
|
write: &[<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>],
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>> { ... }
|
||
|
|
<span class="item-spacer"></span> async fn <a href="#method.write_read" class="fn">write_read</a>(
|
||
|
|
&mut self,
|
||
|
|
address: A,
|
||
|
|
write: &[<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>],
|
||
|
|
read: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>],
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>> { ... }
|
||
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Async I2c.</p>
|
||
|
|
</div></details><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.transaction" class="method"><a class="src rightside" href="../../src/embedded_hal_async/i2c.rs.html#121-125">source</a><h4 class="code-header">async fn <a href="#tymethod.transaction" class="fn">transaction</a>(
|
||
|
|
&mut self,
|
||
|
|
address: A,
|
||
|
|
operations: &mut [<a class="enum" href="enum.Operation.html" title="enum embedded_hal_async::i2c::Operation">Operation</a><'_>],
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>></h4></section></summary><div class="docblock"><p>Execute the provided operations on the I2C bus as a single transaction.</p>
|
||
|
|
<p>Transaction contract:</p>
|
||
|
|
<ul>
|
||
|
|
<li>
|
||
|
|
<p>Before executing the first operation an ST is sent automatically. This is followed by SAD+R/W as appropriate.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>Data from adjacent operations of the same type are sent after each other without an SP or SR.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>Between adjacent operations of a different type an SR and SAD+R/W is sent.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>After executing the last operation an SP is sent automatically.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p>If the last operation is a <code>Read</code> the master does not send an acknowledge for the last byte.</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>ST</code> = start condition</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>SAD+R/W</code> = slave address followed by bit 1 to indicate reading or 0 to indicate writing</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>SR</code> = repeated start condition</p>
|
||
|
|
</li>
|
||
|
|
<li>
|
||
|
|
<p><code>SP</code> = stop condition</p>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.read" class="method"><a class="src rightside" href="../../src/embedded_hal_async/i2c.rs.html#45-48">source</a><h4 class="code-header">async fn <a href="#method.read" class="fn">read</a>(&mut self, address: A, read: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>></h4></section></summary><div class="docblock"><p>Reads enough bytes from slave with <code>address</code> to fill <code>buffer</code>.</p>
|
||
|
|
<h5 id="i2c-events-contract"><a class="doc-anchor" href="#i2c-events-contract">§</a>I2C Events (contract)</h5><div class="example-wrap"><pre class="language-text"><code>Master: ST SAD+R MAK MAK ... NMAK SP
|
||
|
|
Slave: SAK B0 B1 ... BN
|
||
|
|
</code></pre></div>
|
||
|
|
<p>Where</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>ST</code> = start condition</li>
|
||
|
|
<li><code>SAD+R</code> = slave address followed by bit 1 to indicate reading</li>
|
||
|
|
<li><code>SAK</code> = slave acknowledge</li>
|
||
|
|
<li><code>Bi</code> = ith byte of data</li>
|
||
|
|
<li><code>MAK</code> = master acknowledge</li>
|
||
|
|
<li><code>NMAK</code> = master no acknowledge</li>
|
||
|
|
<li><code>SP</code> = stop condition</li>
|
||
|
|
</ul>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.write" class="method"><a class="src rightside" href="../../src/embedded_hal_async/i2c.rs.html#67-70">source</a><h4 class="code-header">async fn <a href="#method.write" class="fn">write</a>(&mut self, address: A, write: &[<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>></h4></section></summary><div class="docblock"><p>Writes bytes to slave with address <code>address</code>.</p>
|
||
|
|
<h5 id="i2c-events-contract-1"><a class="doc-anchor" href="#i2c-events-contract-1">§</a>I2C Events (contract)</h5><div class="example-wrap"><pre class="language-text"><code>Master: ST SAD+W B0 B1 ... BN SP
|
||
|
|
Slave: SAK SAK SAK ... SAK
|
||
|
|
</code></pre></div>
|
||
|
|
<p>Where</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>ST</code> = start condition</li>
|
||
|
|
<li><code>SAD+W</code> = slave address followed by bit 0 to indicate writing</li>
|
||
|
|
<li><code>SAK</code> = slave acknowledge</li>
|
||
|
|
<li><code>Bi</code> = ith byte of data</li>
|
||
|
|
<li><code>SP</code> = stop condition</li>
|
||
|
|
</ul>
|
||
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.write_read" class="method"><a class="src rightside" href="../../src/embedded_hal_async/i2c.rs.html#95-106">source</a><h4 class="code-header">async fn <a href="#method.write_read" class="fn">write_read</a>(
|
||
|
|
&mut self,
|
||
|
|
address: A,
|
||
|
|
write: &[<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>],
|
||
|
|
read: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>],
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>></h4></section></summary><div class="docblock"><p>Writes bytes to slave with address <code>address</code> and then reads enough bytes to fill <code>read</code> <em>in a
|
||
|
|
single transaction</em>.</p>
|
||
|
|
<h5 id="i2c-events-contract-2"><a class="doc-anchor" href="#i2c-events-contract-2">§</a>I2C Events (contract)</h5><div class="example-wrap"><pre class="language-text"><code>Master: ST SAD+W O0 O1 ... OM SR SAD+R MAK MAK ... NMAK SP
|
||
|
|
Slave: SAK SAK SAK ... SAK SAK I0 I1 ... IN
|
||
|
|
</code></pre></div>
|
||
|
|
<p>Where</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>ST</code> = start condition</li>
|
||
|
|
<li><code>SAD+W</code> = slave address followed by bit 0 to indicate writing</li>
|
||
|
|
<li><code>SAK</code> = slave acknowledge</li>
|
||
|
|
<li><code>Oi</code> = ith outgoing byte of data</li>
|
||
|
|
<li><code>SR</code> = repeated start condition</li>
|
||
|
|
<li><code>SAD+R</code> = slave address followed by bit 1 to indicate reading</li>
|
||
|
|
<li><code>Ii</code> = ith incoming byte of data</li>
|
||
|
|
<li><code>MAK</code> = master acknowledge</li>
|
||
|
|
<li><code>NMAK</code> = master no acknowledge</li>
|
||
|
|
<li><code>SP</code> = stop condition</li>
|
||
|
|
</ul>
|
||
|
|
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.82.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="foreign-impls" class="section-header">Implementations on Foreign Types<a href="#foreign-impls" class="anchor">§</a></h2><details class="toggle implementors-toggle"><summary><section id="impl-I2c%3CA%3E-for-%26mut+T" class="impl"><a class="src rightside" href="../../src/embedded_hal_async/i2c.rs.html#128-157">source</a><a href="#impl-I2c%3CA%3E-for-%26mut+T" class="anchor">§</a><h3 class="code-header">impl<A: <a class="trait" href="trait.AddressMode.html" title="trait embedded_hal_async::i2c::AddressMode">AddressMode</a>, T: <a class="trait" href="trait.I2c.html" title="trait embedded_hal_async::i2c::I2c">I2c</a><A> + ?<a class="trait" href="https://doc.rust-lang.org/1.82.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.I2c.html" title="trait embedded_hal_async::i2c::I2c">I2c</a><A> for <a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.reference.html">&mut T</a></h3></section></summary><div class="impl-items"><section id="method.read-1" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_async/i2c.rs.html#130-132">source</a><a href="#method.read-1" class="anchor">§</a><h4 class="code-header">async fn <a href="#method.read" class="fn">read</a>(&mut self, address: A, read: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>></h4></section><section id="method.write-1" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_async/i2c.rs.html#135-137">source</a><a href="#method.write-1" class="anchor">§</a><h4 class="code-header">async fn <a href="#method.write" class="fn">write</a>(&mut self, address: A, write: &[<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>></h4></section><section id="method.write_read-1" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_async/i2c.rs.html#140-147">source</a><a href="#method.write_read-1" class="anchor">§</a><h4 class="code-header">async fn <a href="#method.write_read" class="fn">write_read</a>(
|
||
|
|
&mut self,
|
||
|
|
address: A,
|
||
|
|
write: &[<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>],
|
||
|
|
read: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.u8.html">u8</a>],
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>></h4></section><section id="method.transaction" class="method trait-impl"><a class="src rightside" href="../../src/embedded_hal_async/i2c.rs.html#150-156">source</a><a href="#method.transaction" class="anchor">§</a><h4 class="code-header">async fn <a href="#tymethod.transaction" class="fn">transaction</a>(
|
||
|
|
&mut self,
|
||
|
|
address: A,
|
||
|
|
operations: &mut [<a class="enum" href="enum.Operation.html" title="enum embedded_hal_async::i2c::Operation">Operation</a><'_>],
|
||
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.82.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.82.0/core/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.ErrorType.html#associatedtype.Error" title="type embedded_hal_async::i2c::ErrorType::Error">Error</a>></h4></section></div></details><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_async/i2c/trait.I2c.js" async></script></section></div></main></body></html>
|