rtic/2/api/rtic_sync/arbiter/i2c/index.html

45 lines
5.2 KiB
HTML
Raw Normal View History

<!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="I2C bus sharing using `Arbiter`"><title>rtic_sync::arbiter::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-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="rtic_sync" 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 mod"><!--[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="../../../rtic_sync/index.html">rtic_<wbr>sync</a><span class="version">1.3.1-alpha.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module i2c</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In rtic_<wbr>sync::<wbr>arbiter</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">rtic_sync</a>::<wbr><a href="../index.html">arbiter</a></span><h1>Module <span>i2c</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/rtic_sync/arbiter.rs.html#324">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>I2C bus sharing using <a href="../struct.Arbiter.html" title="struct rtic_sync::arbiter::Arbiter"><code>Arbiter</code></a></p>
<p>An Example how to use it in RTIC application:</p>
<div class="example-wrap"><pre class="language-text"><code>#[app(device = some_hal, peripherals = true, dispatchers = [TIM16])]
mod app {
use core::mem::MaybeUninit;
use rtic_sync::{arbiter::{i2c::ArbiterDevice, Arbiter},
#[shared]
struct Shared {}
#[local]
struct Local {
ens160: Ens160&lt;ArbiterDevice&lt;&#39;static, I2c&lt;&#39;static, I2C1&gt;&gt;&gt;,
}
#[init(local = [
i2c_arbiter: MaybeUninit&lt;Arbiter&lt;I2c&lt;&#39;static, I2C1&gt;&gt;&gt; = MaybeUninit::uninit(),
])]
fn init(cx: init::Context) -&gt; (Shared, Local) {
let i2c = I2c::new(cx.device.I2C1);
let i2c_arbiter = cx.local.i2c_arbiter.write(Arbiter::new(i2c));
let ens160 = Ens160::new(ArbiterDevice::new(i2c_arbiter), 0x52);
i2c_sensors::spawn(i2c_arbiter).ok();
(Shared {}, Local { ens160 })
}
#[task(local = [ens160])]
async fn i2c_sensors(cx: i2c_sensors::Context, i2c: &amp;&#39;static Arbiter&lt;I2c&lt;&#39;static, I2C1&gt;&gt;) {
use sensor::Asensor;
loop {
// Use scope to make sure I2C access is dropped.
{
// Read from sensor driver that wants to use I2C directly.
let mut i2c = i2c.access().await;
let status = Asensor::status(&amp;mut i2c).await;
}
// Read ENS160 sensor.
let eco2 = cx.local.ens160.eco2().await;
}
}
}</code></pre></div></div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.ArbiterDevice.html" title="struct rtic_sync::arbiter::i2c::ArbiterDevice">Arbiter<wbr>Device</a></div><div class="desc docblock-short"><a href="../struct.Arbiter.html" title="struct rtic_sync::arbiter::Arbiter"><code>Arbiter</code></a>-based shared bus implementation for I2C.</div></li></ul></section></div></main></body></html>