rtic/dev/api/nrf52840_pac/qdec/index.html
2024-12-06 13:35:18 +00:00

3 lines
No EOL
16 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="Quadrature Decoder"><title>nrf52840_pac::qdec - 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="nrf52840_pac" 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="../../nrf52840_pac/index.html">nrf52840_<wbr>pac</a><span class="version">0.12.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module qdec</a></h2><h3><a href="#reexports">Module Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate nrf52840_<wbr>pac</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">nrf52840_pac</a></span><h1>Module <span>qdec</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/nrf52840_pac/qdec.rs.html#1-160">source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Quadrature Decoder</p>
</div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name" id="reexport.PSEL"><code>pub use psel::<a class="struct" href="psel/struct.PSEL.html" title="struct nrf52840_pac::qdec::psel::PSEL">PSEL</a>;</code></div></li></ul><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="acc/index.html" title="mod nrf52840_pac::qdec::acc">acc</a></div><div class="desc docblock-short">Register accumulating the valid transitions</div></li><li><div class="item-name"><a class="mod" href="accdbl/index.html" title="mod nrf52840_pac::qdec::accdbl">accdbl</a></div><div class="desc docblock-short">Register accumulating the number of detected double transitions</div></li><li><div class="item-name"><a class="mod" href="accdblread/index.html" title="mod nrf52840_pac::qdec::accdblread">accdblread</a></div><div class="desc docblock-short">Snapshot of the ACCDBL, updated by the READCLRACC or RDCLRDBL task</div></li><li><div class="item-name"><a class="mod" href="accread/index.html" title="mod nrf52840_pac::qdec::accread">accread</a></div><div class="desc docblock-short">Snapshot of the ACC register, updated by the READCLRACC or RDCLRACC task</div></li><li><div class="item-name"><a class="mod" href="dbfen/index.html" title="mod nrf52840_pac::qdec::dbfen">dbfen</a></div><div class="desc docblock-short">Enable input debounce filters</div></li><li><div class="item-name"><a class="mod" href="enable/index.html" title="mod nrf52840_pac::qdec::enable">enable</a></div><div class="desc docblock-short">Enable the quadrature decoder</div></li><li><div class="item-name"><a class="mod" href="events_accof/index.html" title="mod nrf52840_pac::qdec::events_accof">events_<wbr>accof</a></div><div class="desc docblock-short">ACC or ACCDBL register overflow</div></li><li><div class="item-name"><a class="mod" href="events_dblrdy/index.html" title="mod nrf52840_pac::qdec::events_dblrdy">events_<wbr>dblrdy</a></div><div class="desc docblock-short">Double displacement(s) detected</div></li><li><div class="item-name"><a class="mod" href="events_reportrdy/index.html" title="mod nrf52840_pac::qdec::events_reportrdy">events_<wbr>reportrdy</a></div><div class="desc docblock-short">Non-null report ready</div></li><li><div class="item-name"><a class="mod" href="events_samplerdy/index.html" title="mod nrf52840_pac::qdec::events_samplerdy">events_<wbr>samplerdy</a></div><div class="desc docblock-short">Event being generated for every new sample value written to the SAMPLE register</div></li><li><div class="item-name"><a class="mod" href="events_stopped/index.html" title="mod nrf52840_pac::qdec::events_stopped">events_<wbr>stopped</a></div><div class="desc docblock-short">QDEC has been stopped</div></li><li><div class="item-name"><a class="mod" href="intenclr/index.html" title="mod nrf52840_pac::qdec::intenclr">intenclr</a></div><div class="desc docblock-short">Disable interrupt</div></li><li><div class="item-name"><a class="mod" href="intenset/index.html" title="mod nrf52840_pac::qdec::intenset">intenset</a></div><div class="desc docblock-short">Enable interrupt</div></li><li><div class="item-name"><a class="mod" href="ledpol/index.html" title="mod nrf52840_pac::qdec::ledpol">ledpol</a></div><div class="desc docblock-short">LED output pin polarity</div></li><li><div class="item-name"><a class="mod" href="ledpre/index.html" title="mod nrf52840_pac::qdec::ledpre">ledpre</a></div><div class="desc docblock-short">Time period the LED is switched ON prior to sampling</div></li><li><div class="item-name"><a class="mod" href="psel/index.html" title="mod nrf52840_pac::qdec::psel">psel</a></div><div class="desc docblock-short">Cluster
Unspecified</div></li><li><div class="item-name"><a class="mod" href="reportper/index.html" title="mod nrf52840_pac::qdec::reportper">reportper</a></div><div class="desc docblock-short">Number of samples to be taken before REPORTRDY and DBLRDY events can be generated</div></li><li><div class="item-name"><a class="mod" href="sample/index.html" title="mod nrf52840_pac::qdec::sample">sample</a></div><div class="desc docblock-short">Motion sample value</div></li><li><div class="item-name"><a class="mod" href="sampleper/index.html" title="mod nrf52840_pac::qdec::sampleper">sampleper</a></div><div class="desc docblock-short">Sample period</div></li><li><div class="item-name"><a class="mod" href="shorts/index.html" title="mod nrf52840_pac::qdec::shorts">shorts</a></div><div class="desc docblock-short">Shortcut register</div></li><li><div class="item-name"><a class="mod" href="tasks_rdclracc/index.html" title="mod nrf52840_pac::qdec::tasks_rdclracc">tasks_<wbr>rdclracc</a></div><div class="desc docblock-short">Read and clear ACC</div></li><li><div class="item-name"><a class="mod" href="tasks_rdclrdbl/index.html" title="mod nrf52840_pac::qdec::tasks_rdclrdbl">tasks_<wbr>rdclrdbl</a></div><div class="desc docblock-short">Read and clear ACCDBL</div></li><li><div class="item-name"><a class="mod" href="tasks_readclracc/index.html" title="mod nrf52840_pac::qdec::tasks_readclracc">tasks_<wbr>readclracc</a></div><div class="desc docblock-short">Read and clear ACC and ACCDBL</div></li><li><div class="item-name"><a class="mod" href="tasks_start/index.html" title="mod nrf52840_pac::qdec::tasks_start">tasks_<wbr>start</a></div><div class="desc docblock-short">Task starting the quadrature decoder</div></li><li><div class="item-name"><a class="mod" href="tasks_stop/index.html" title="mod nrf52840_pac::qdec::tasks_stop">tasks_<wbr>stop</a></div><div class="desc docblock-short">Task stopping the quadrature decoder</div></li></ul><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.RegisterBlock.html" title="struct nrf52840_pac::qdec::RegisterBlock">Register<wbr>Block</a></div><div class="desc docblock-short">Register block</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.ACC.html" title="type nrf52840_pac::qdec::ACC">ACC</a></div><div class="desc docblock-short">ACC (r) register accessor: an alias for <code>Reg&lt;ACC_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.ACCDBL.html" title="type nrf52840_pac::qdec::ACCDBL">ACCDBL</a></div><div class="desc docblock-short">ACCDBL (r) register accessor: an alias for <code>Reg&lt;ACCDBL_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.ACCDBLREAD.html" title="type nrf52840_pac::qdec::ACCDBLREAD">ACCDBLREAD</a></div><div class="desc docblock-short">ACCDBLREAD (r) register accessor: an alias for <code>Reg&lt;ACCDBLREAD_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.ACCREAD.html" title="type nrf52840_pac::qdec::ACCREAD">ACCREAD</a></div><div class="desc docblock-short">ACCREAD (r) register accessor: an alias for <code>Reg&lt;ACCREAD_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.DBFEN.html" title="type nrf52840_pac::qdec::DBFEN">DBFEN</a></div><div class="desc docblock-short">DBFEN (rw) register accessor: an alias for <code>Reg&lt;DBFEN_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.ENABLE.html" title="type nrf52840_pac::qdec::ENABLE">ENABLE</a></div><div class="desc docblock-short">ENABLE (rw) register accessor: an alias for <code>Reg&lt;ENABLE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_ACCOF.html" title="type nrf52840_pac::qdec::EVENTS_ACCOF">EVENTS_<wbr>ACCOF</a></div><div class="desc docblock-short">EVENTS_ACCOF (rw) register accessor: an alias for <code>Reg&lt;EVENTS_ACCOF_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_DBLRDY.html" title="type nrf52840_pac::qdec::EVENTS_DBLRDY">EVENTS_<wbr>DBLRDY</a></div><div class="desc docblock-short">EVENTS_DBLRDY (rw) register accessor: an alias for <code>Reg&lt;EVENTS_DBLRDY_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_REPORTRDY.html" title="type nrf52840_pac::qdec::EVENTS_REPORTRDY">EVENTS_<wbr>REPORTRDY</a></div><div class="desc docblock-short">EVENTS_REPORTRDY (rw) register accessor: an alias for <code>Reg&lt;EVENTS_REPORTRDY_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_SAMPLERDY.html" title="type nrf52840_pac::qdec::EVENTS_SAMPLERDY">EVENTS_<wbr>SAMPLERDY</a></div><div class="desc docblock-short">EVENTS_SAMPLERDY (rw) register accessor: an alias for <code>Reg&lt;EVENTS_SAMPLERDY_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.EVENTS_STOPPED.html" title="type nrf52840_pac::qdec::EVENTS_STOPPED">EVENTS_<wbr>STOPPED</a></div><div class="desc docblock-short">EVENTS_STOPPED (rw) register accessor: an alias for <code>Reg&lt;EVENTS_STOPPED_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.INTENCLR.html" title="type nrf52840_pac::qdec::INTENCLR">INTENCLR</a></div><div class="desc docblock-short">INTENCLR (rw) register accessor: an alias for <code>Reg&lt;INTENCLR_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.INTENSET.html" title="type nrf52840_pac::qdec::INTENSET">INTENSET</a></div><div class="desc docblock-short">INTENSET (rw) register accessor: an alias for <code>Reg&lt;INTENSET_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.LEDPOL.html" title="type nrf52840_pac::qdec::LEDPOL">LEDPOL</a></div><div class="desc docblock-short">LEDPOL (rw) register accessor: an alias for <code>Reg&lt;LEDPOL_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.LEDPRE.html" title="type nrf52840_pac::qdec::LEDPRE">LEDPRE</a></div><div class="desc docblock-short">LEDPRE (rw) register accessor: an alias for <code>Reg&lt;LEDPRE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.REPORTPER.html" title="type nrf52840_pac::qdec::REPORTPER">REPORTPER</a></div><div class="desc docblock-short">REPORTPER (rw) register accessor: an alias for <code>Reg&lt;REPORTPER_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.SAMPLE.html" title="type nrf52840_pac::qdec::SAMPLE">SAMPLE</a></div><div class="desc docblock-short">SAMPLE (r) register accessor: an alias for <code>Reg&lt;SAMPLE_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.SAMPLEPER.html" title="type nrf52840_pac::qdec::SAMPLEPER">SAMPLEPER</a></div><div class="desc docblock-short">SAMPLEPER (rw) register accessor: an alias for <code>Reg&lt;SAMPLEPER_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.SHORTS.html" title="type nrf52840_pac::qdec::SHORTS">SHORTS</a></div><div class="desc docblock-short">SHORTS (rw) register accessor: an alias for <code>Reg&lt;SHORTS_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_RDCLRACC.html" title="type nrf52840_pac::qdec::TASKS_RDCLRACC">TASKS_<wbr>RDCLRACC</a></div><div class="desc docblock-short">TASKS_RDCLRACC (w) register accessor: an alias for <code>Reg&lt;TASKS_RDCLRACC_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_RDCLRDBL.html" title="type nrf52840_pac::qdec::TASKS_RDCLRDBL">TASKS_<wbr>RDCLRDBL</a></div><div class="desc docblock-short">TASKS_RDCLRDBL (w) register accessor: an alias for <code>Reg&lt;TASKS_RDCLRDBL_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_READCLRACC.html" title="type nrf52840_pac::qdec::TASKS_READCLRACC">TASKS_<wbr>READCLRACC</a></div><div class="desc docblock-short">TASKS_READCLRACC (w) register accessor: an alias for <code>Reg&lt;TASKS_READCLRACC_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_START.html" title="type nrf52840_pac::qdec::TASKS_START">TASKS_<wbr>START</a></div><div class="desc docblock-short">TASKS_START (w) register accessor: an alias for <code>Reg&lt;TASKS_START_SPEC&gt;</code></div></li><li><div class="item-name"><a class="type" href="type.TASKS_STOP.html" title="type nrf52840_pac::qdec::TASKS_STOP">TASKS_<wbr>STOP</a></div><div class="desc docblock-short">TASKS_STOP (w) register accessor: an alias for <code>Reg&lt;TASKS_STOP_SPEC&gt;</code></div></li></ul></section></div></main></body></html>