ZennDev1337/Rust-for-Arduboy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

edit the docs

Browse source
This commit is contained in:
ZennDev1337 2023-10-11 18:41:22 +02:00
parent ffb6d42f10
commit 3d5d8ccf49
65 changed files with 178 additions and 128 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/doc/arduboy_rust/prelude/serial/index.html
View file

@ -1,4 +1,4 @@
<!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="This is the Module to interact in a save way with the Arduino Serial C++ library."><title>arduboy_rust::prelude::serial - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="arduboy_rust" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0-nightly (2bbb61989 2023-10-04)" data-channel="nightly" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../../../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="../../../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-5d8b3c7633ad77ba.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><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">&#9776;</button><a class="logo-container" href="../../../arduboy_rust/index.html"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../../../arduboy_rust/index.html"><img class="rust-logo" src="../../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">Module serial</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">arduboy_rust</a>::<wbr><a href="../index.html">prelude</a>::<wbr><a class="mod" href="#">serial</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/arduboy_rust/libraries\arduino_system/serial_print.rs.html#1-418">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This is the Module to interact in a save way with the Arduino Serial C++ library.</p>
<p>You will need to uncomment the Arduino_Serial_Library in the import_config.h file.</p>
<p>You will need to uncomment the Serial in the config.toml file.</p>
</div></details><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Serialprintable.html" title="trait arduboy_rust::prelude::serial::Serialprintable">Serialprintable</a></div></li><li><div class="item-name"><a class="trait" href="trait.Serialprintlnable.html" title="trait arduboy_rust::prelude::serial::Serialprintlnable">Serialprintlnable</a></div></li></ul><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.available.html" title="fn arduboy_rust::prelude::serial::available">available</a></div><div class="desc docblock-short">Get the number of bytes (characters) available for reading from the serial port. This is data that’s already arrived and stored in the serial receive buffer (which holds 64 bytes).</div></li><li><div class="item-name"><a class="fn" href="fn.begin.html" title="fn arduboy_rust::prelude::serial::begin">begin</a></div><div class="desc docblock-short">Sets the data rate in bits per second (baud) for serial data transmission. For communicating with Serial Monitor, make sure to use one of the baud rates listed in the menu at the bottom right corner of its screen. You can, however, specify other rates - for example, to communicate over pins 0 and 1 with a component that requires a particular baud rate.</div></li><li><div class="item-name"><a class="fn" href="fn.end.html" title="fn arduboy_rust::prelude::serial::end">end</a></div><div class="desc docblock-short">Disables serial communication, allowing the RX and TX pins to be used for general input and output. To re-enable serial communication, call <a href="fn.begin.html" title="fn arduboy_rust::prelude::serial::begin">begin()</a>.</div></li><li><div class="item-name"><a class="fn" href="fn.print.html" title="fn arduboy_rust::prelude::serial::print">print</a></div><div class="desc docblock-short">The Arduino Serial Print class is available for writing text to the screen buffer.</div></li><li><div class="item-name"><a class="fn" href="fn.println.html" title="fn arduboy_rust::prelude::serial::println">println</a></div><div class="desc docblock-short">The Arduino Serial Print class is available for writing text to the screen buffer.</div></li><li><div class="item-name"><a class="fn" href="fn.read.html" title="fn arduboy_rust::prelude::serial::read">read</a></div><div class="desc docblock-short">Reads incoming serial data.
Use only inside of <a href="fn.available.html" title="fn arduboy_rust::prelude::serial::available">available()</a>:</div></li><li><div class="item-name"><a class="fn" href="fn.read_as_utf8_str.html" title="fn arduboy_rust::prelude::serial::read_as_utf8_str">read_as_utf8_str</a></div><div class="desc docblock-short">Reads incoming serial data.</div></li></ul></section></div></main></body></html>