Skip to content

Commit

Permalink
Added final chapter and thank you page
Browse files Browse the repository at this point in the history
  • Loading branch information
Vaishnav-Sabari-Girish committed Dec 24, 2024
1 parent a891908 commit d6c9cb0
Show file tree
Hide file tree
Showing 17 changed files with 627 additions and 32 deletions.
7 changes: 7 additions & 0 deletions book/chapter_3.html
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ <h2 id="install-libraries"><a class="header" href="#install-libraries">Install L
<p>To check if the library has been installed , type <code>arduino-cli lib list</code> and check the table
for the library you just installed. If it is present then the library has been installed successfully.</p>
<p><img src="images/recordings/lib_install.gif" alt="Lib Install" /></p>
<p>You have successuflly , compiled and uploaded a sketch and also installed a library.</p>

</main>

Expand All @@ -207,6 +208,9 @@ <h2 id="install-libraries"><a class="header" href="#install-libraries">Install L
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="chapter_4.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>

<div style="clear: both"></div>
</nav>
Expand All @@ -218,6 +222,9 @@ <h2 id="install-libraries"><a class="header" href="#install-libraries">Install L
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="chapter_4.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>

</div>
Expand Down
253 changes: 253 additions & 0 deletions book/chapter_4.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
<!DOCTYPE HTML>
<html lang="en" class="light sidebar-visible" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Chapter 4 - Arduino CLI Interactive (aci)</title>


<!-- Custom HTML head -->

<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">

<link rel="icon" href="favicon.svg">
<link rel="shortcut icon" href="favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">

<!-- Fonts -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">

<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="highlight.css">
<link rel="stylesheet" href="tomorrow-night.css">
<link rel="stylesheet" href="ayu-highlight.css">

<!-- Custom theme stylesheets -->


<!-- Provide site root to javascript -->
<script>
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
<!-- Start loading toc.js asap -->
<script src="toc.js"></script>
</head>
<body>
<div id="body-container">
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');

if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}

if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>

<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
const html = document.documentElement;
html.classList.remove('light')
html.classList.add(theme);
html.classList.add("js");
</script>

<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">

<!-- Hide / unhide sidebar before it is displayed -->
<script>
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>

<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<!-- populated by js -->
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
</noscript>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>

<div id="page-wrapper" class="page-wrapper">

<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>

<h1 class="menu-title">Arduino CLI Interactive (aci)</h1>

<div class="right-buttons">
<a href="print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>

</div>
</div>

<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>

<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>

<div id="content" class="content">
<main>
<h1 id="chapter-4--how-to-use-aci-part-3"><a class="header" href="#chapter-4--how-to-use-aci-part-3">Chapter 4 (How to use <code>aci</code> Part 3)</a></h1>
<p>By the end of this chapter , you will be able to add 3rd party cores to the <code>aci</code> tools.
These 3rd party cores are required to be able to use boards like ESP32 and ESP8266.</p>
<p>To do this , we have to first create the config file.
To create the config file , type the following in the terminal</p>
<pre><code class="language-bash">arduino-cli config init
</code></pre>
<p>This will create the <code>config.yaml</code> file at <code>/home/&lt;username&gt;/.arduino15/arduino-cli.yaml</code>.</p>
<p>The previous step is optional. Because the script itself will create it for you.
Just incase it doesn't , you have to create the .yaml file using the command given above.</p>
<p>To do the above , type <code>aci</code> in the terminal , navigate to <strong>Edit Configurations</strong> option and choose your
preferred editor.</p>
<p>Then copy and paste the following links for :</p>
<ol>
<li>ESP8266</li>
</ol>
<p><code>http://arduino.esp8266.com/stable/package_esp8266com_index.json</code></p>
<ol start="2">
<li>ESP32</li>
</ol>
<p><code>https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json</code></p>
<p>Then exit the editor.</p>
<p>Then in the terminal type :</p>
<pre><code class="language-bash">arduino-cli core update-index
arduino-cli core install esp32:esp32 (esp8266:esp8266 for ESP8266)
arduino-cli board install

#To list all boards
arduino-cli board listall
</code></pre>
<p><img src="images/recordings/new_core.gif" alt="New Core" /></p>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="chapter_3.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="ty.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>

<div style="clear: both"></div>
</nav>
</div>
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="chapter_3.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="ty.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>

</div>

<!-- Livereload script (if served using the cli tool) -->
<script>
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
const socket = new WebSocket(wsAddress);
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};

window.onbeforeunload = function() {
socket.close();
}
</script>



<script>
window.playground_copyable = true;
</script>


<script src="elasticlunr.min.js"></script>
<script src="mark.min.js"></script>
<script src="searcher.js"></script>

<script src="clipboard.min.js"></script>
<script src="highlight.js"></script>
<script src="book.js"></script>

<!-- Custom JS scripts -->


</div>
</body>
</html>
14 changes: 0 additions & 14 deletions book/images/recordings/MyFirstSketch/MyFirstSketch.ino

This file was deleted.

Binary file added book/images/recordings/new_core.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added book/images/thank_you.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 53 additions & 0 deletions book/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,59 @@ <h2 id="install-libraries"><a class="header" href="#install-libraries">Install L
<p>To check if the library has been installed , type <code>arduino-cli lib list</code> and check the table
for the library you just installed. If it is present then the library has been installed successfully.</p>
<p><img src="images/recordings/lib_install.gif" alt="Lib Install" /></p>
<p>You have successuflly , compiled and uploaded a sketch and also installed a library.</p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="chapter-4--how-to-use-aci-part-3"><a class="header" href="#chapter-4--how-to-use-aci-part-3">Chapter 4 (How to use <code>aci</code> Part 3)</a></h1>
<p>By the end of this chapter , you will be able to add 3rd party cores to the <code>aci</code> tools.
These 3rd party cores are required to be able to use boards like ESP32 and ESP8266.</p>
<p>To do this , we have to first create the config file.
To create the config file , type the following in the terminal</p>
<pre><code class="language-bash">arduino-cli config init
</code></pre>
<p>This will create the <code>config.yaml</code> file at <code>/home/&lt;username&gt;/.arduino15/arduino-cli.yaml</code>.</p>
<p>The previous step is optional. Because the script itself will create it for you.
Just incase it doesn't , you have to create the .yaml file using the command given above.</p>
<p>To do the above , type <code>aci</code> in the terminal , navigate to <strong>Edit Configurations</strong> option and choose your
preferred editor.</p>
<p>Then copy and paste the following links for :</p>
<ol>
<li>ESP8266</li>
</ol>
<p><code>http://arduino.esp8266.com/stable/package_esp8266com_index.json</code></p>
<ol start="2">
<li>ESP32</li>
</ol>
<p><code>https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json</code></p>
<p>Then exit the editor.</p>
<p>Then in the terminal type :</p>
<pre><code class="language-bash">arduino-cli core update-index
arduino-cli core install esp32:esp32 (esp8266:esp8266 for ESP8266)
arduino-cli board install

#To list all boards
arduino-cli board listall
</code></pre>
<p><img src="images/recordings/new_core.gif" alt="New Core" /></p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="thank-you"><a class="header" href="#thank-you">Thank you</a></h1>
<p>I want to take a moment to express my heartfelt gratitude to you for choosing arduino-cli-interactive.
Your support and feedback have been invaluable in shaping this tool into what it is today.
Whether you’re a hobbyist, a student, or a professional, your trust motivates me to keep improving
and delivering a better experience for everyone in the Arduino community.</p>
<p>Your enthusiasm for this project means the world to me! If you’ve enjoyed using arduino-cli-interactive,
I kindly request you to star ⭐ the repository on <a href="https://github.com/Vaishnav-Sabari-Girish/arduino-cli-interactive">GitHub</a>
to help it reach more users. You can also fork 🍴
it to make your own contributions or explore its capabilities further.</p>
<p>I also invite you to stay connected with me as I continue this exciting journey.
Be sure to follow me on <a href="https://medium.com/@forgamesonly684">Medium</a> ,
<a href="https://dev.to/vaishnav_sabari_girish">Dev.to</a> and <a href="https://github.com/Vaishnav-Sabari-Girish">GitHub</a>
for insightful blogs, updates, and tutorials related to Arduino, CLI tools, and embedded systems.
There’s so much more coming your way, including new features for this tool and engaging content on
these platforms.</p>
<p>Your support keeps this project alive, and your feedback helps me grow. If you have any suggestions,
feature requests, or just want to share how this tool has helped you, don’t hesitate to reach out.
Together, we can make arduino-cli-interactive an even more powerful tool for the Arduino community.</p>
<p>Thank you once again for your trust and support. Let’s build something amazing, one project at a time!
<br><br></p>
<p><img src="images/thank_you.png" alt="Thank You" /></p>

</main>

Expand Down
2 changes: 1 addition & 1 deletion book/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion book/searchindex.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion book/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@
<!-- Custom theme stylesheets -->
</head>
<body class="sidebar-iframe-inner">
<ol class="chapter"><li class="chapter-item expanded affix "><a href="intro.html" target="_parent">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">User Guide</li><li class="chapter-item expanded "><a href="chapter_1.html" target="_parent"><strong aria-hidden="true">1.</strong> Chapter 1</a></li><li class="chapter-item expanded "><a href="chapter_2.html" target="_parent"><strong aria-hidden="true">2.</strong> Chapter 2</a></li><li class="chapter-item expanded "><a href="chapter_3.html" target="_parent"><strong aria-hidden="true">3.</strong> Chapter 3</a></li></ol>
<ol class="chapter"><li class="chapter-item expanded affix "><a href="intro.html" target="_parent">Introduction</a></li><li class="chapter-item expanded affix "><li class="part-title">User Guide</li><li class="chapter-item expanded "><a href="chapter_1.html" target="_parent"><strong aria-hidden="true">1.</strong> Chapter 1</a></li><li class="chapter-item expanded "><a href="chapter_2.html" target="_parent"><strong aria-hidden="true">2.</strong> Chapter 2</a></li><li class="chapter-item expanded "><a href="chapter_3.html" target="_parent"><strong aria-hidden="true">3.</strong> Chapter 3</a></li><li class="chapter-item expanded "><a href="chapter_4.html" target="_parent"><strong aria-hidden="true">4.</strong> Chapter 4</a></li><li class="chapter-item expanded "><a href="ty.html" target="_parent"><strong aria-hidden="true">5.</strong> Thank you</a></li></ol>
</body>
</html>
Loading

0 comments on commit d6c9cb0

Please sign in to comment.