| 12345678910111213141516171819 |
- <!doctype html>
- <html lang="en" dir="ltr" class="docs-wrapper docs-doc-page docs-version-current plugin-docs plugin-id-default docs-doc-id-installation">
- <head>
- <meta charset="UTF-8">
- <meta name="generator" content="Docusaurus v2.2.0">
- <title data-rh="true">Installation | WebSerial Docs</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.webserial.pro/installation/"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Installation | WebSerial Docs"><meta data-rh="true" name="description" content="This document explains the installation procedure for getting started with WebSerial."><meta data-rh="true" property="og:description" content="This document explains the installation procedure for getting started with WebSerial."><link data-rh="true" rel="canonical" href="https://docs.webserial.pro/installation/"><link data-rh="true" rel="alternate" href="https://docs.webserial.pro/installation/" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.webserial.pro/installation/" hreflang="x-default"><link rel="preconnect" href="https://www.google-analytics.com">
- <link rel="preconnect" href="https://www.googletagmanager.com">
- <script async src="https://www.googletagmanager.com/gtag/js?id=G-BCT2ENBRLE"></script>
- <script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-BCT2ENBRLE",{anonymize_ip:!0})</script><link rel="stylesheet" href="/assets/css/styles.2702d93e.css">
- <link rel="preload" href="/assets/js/runtime~main.bd196cc2.js" as="script">
- <link rel="preload" href="/assets/js/main.5657af05.js" as="script">
- </head>
- <body class="navigation-with-keyboard">
- <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"dark")}()</script><div id="__docusaurus">
- <div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#docusaurus_skipToContent_fallback">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/v2/img/logo.png" alt="WebSerial" class="themedImage_ToTc themedImage--light_HNdA" width="180"><img src="/v2/img/logo.png" alt="WebSerial" class="themedImage_ToTc themedImage--dark_i4oU" width="180"></div><b class="navbar__title text--truncate"></b></a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/ayushsharma82/WebSerial/" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link header-github-link" aria-label="GitHub repository"></a><div class="toggle_vylO colorModeToggle_x44X"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently dark mode)" aria-label="Switch between dark and light mode (currently dark mode)" aria-live="polite"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/">Introduction</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" href="/installation/">Installation</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/getting-started/">Getting Started</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/examples/">Examples</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/authentication/">Authentication</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/callbacks/">Callbacks</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/printing/">Printing Logs</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/toggle-input/">Toggle Input (Pro)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/export/">Export Logs (Pro)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/timestamps/">Timestamps (Pro)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/font/">Font Settings (Pro)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/hardware-id/">Hardware ID (Pro)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/custom-title/">Custom Title (Pro)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/branding/">Branding (Pro)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/commercial-license/">Commercial License</a></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row docitem-content"><div class="col docItemCol_z5aJ"><div class="docItemContainer_c0TR"><article><div class="breadcrumb-row"><div><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Installation</span><meta itemprop="position" content="1"></li></ul></nav></div><div></div></div><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header class="mdx-heading"><h1>Installation</h1></header><p>This document explains the installation procedure for getting started with WebSerial.</p><h3 class="anchor anchorWithStickyNavbar_LWe7" id="dependencies">Dependencies<a class="hash-link" href="#dependencies" title="Direct link to heading"></a></h3><p><em>WebSerial depends on the following libraries present in your libraries folder. Please stricly install the compatible versions of these dependencies only! Using any other version might break WebSerial or may cause WebSerial to work partially.</em></p><div class="theme-admonition theme-admonition-important alert alert--info admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 14 16"><path fill-rule="evenodd" d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"></path></svg></span>Note on Dependencies</div><div class="admonitionContent_S0QG"><p>As of v2, WebSerial has officially switched to using fork of ESPAsyncWebServer and its dependencies from <a href="https://github.com/mathieucarbou" target="_blank" rel="noopener noreferrer">@mathieucarbou</a>. This fork of ESPAsyncWebServer is being maintained regularly and contains many bug fixes along with arduino-esp32 core v3 support.</p><p>It's suggested to migrate all your projects to using this fork as the original me-no-dev/ESPAsyncWebServer repo is not being maintained <em>since years</em>.</p></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="for-esp8266">For ESP8266<a class="hash-link" href="#for-esp8266" title="Direct link to heading"></a></h4><ul><li><a href="https://github.com/esp8266/Arduino" target="_blank" rel="noopener noreferrer">ESP8266 Arduino Core</a> - <strong>v3.1.2</strong></li><li>(mathieucarbou) <a href="https://github.com/mathieucarbou/esphome-ESPAsyncTCP#v2.0.0" target="_blank" rel="noopener noreferrer">esphome-ESPAsyncTCP</a> - <strong>v2.0.0</strong></li><li>(mathieucarbou) <a href="https://github.com/mathieucarbou/ESPAsyncWebServer#v3.0.6" target="_blank" rel="noopener noreferrer">ESPAsyncWebServer</a> - <strong>v3.1.1</strong></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="for-esp32">For ESP32<a class="hash-link" href="#for-esp32" title="Direct link to heading"></a></h4><ul><li><a href="https://github.com/espressif/arduino-esp32" target="_blank" rel="noopener noreferrer">ESP32 Arduino Core</a> @ <strong>v3.0.3</strong></li><li>(mathieucarbou) <a href="https://github.com/mathieucarbou/AsyncTCP#v3.1.4" target="_blank" rel="noopener noreferrer">AsyncTCP</a> @ <strong>v3.2.3</strong></li><li>(mathieucarbou) <a href="https://github.com/mathieucarbou/ESPAsyncWebServer#v3.0.6" target="_blank" rel="noopener noreferrer">ESPAsyncWebServer</a> - <strong>v3.1.1</strong></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="installing-webserial">Installing WebSerial<a class="hash-link" href="#installing-webserial" title="Direct link to heading"></a></h3><h4 class="anchor anchorWithStickyNavbar_LWe7" id="1-directly-through-arduino-ide---library-manager">1. Directly Through Arduino IDE - Library Manager<a class="hash-link" href="#1-directly-through-arduino-ide---library-manager" title="Direct link to heading"></a></h4><p>Go to Sketch > Include Library > Library Manager > Search for "WebSerial" > Install</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="2-manual-install">2. Manual Install<a class="hash-link" href="#2-manual-install" title="Direct link to heading"></a></h4><h5 class="anchor anchorWithStickyNavbar_LWe7" id="for-windows">For Windows<a class="hash-link" href="#for-windows" title="Direct link to heading"></a></h5><ul><li>Download the <a href="https://github.com/ayushsharma82/WebSerial/archive/master.zip" target="_blank" rel="noopener noreferrer">Repository</a></li><li>Extract the .zip in <code>Documents > Arduino > Libraries > {Place "WebSerial" folder Here}</code></li></ul><h5 class="anchor anchorWithStickyNavbar_LWe7" id="for-linux">For Linux<a class="hash-link" href="#for-linux" title="Direct link to heading"></a></h5><ul><li>Download the <a href="https://github.com/ayushsharma82/WebSerial/archive/master.zip" target="_blank" rel="noopener noreferrer">Repository</a></li><li>Extract the .zip in <code>Sketchbook > Libraries > {Place "WebSerial" folder Here}</code></li></ul><h4 class="anchor anchorWithStickyNavbar_LWe7" id="3-import-through-arduino-ide">3. Import through Arduino IDE<a class="hash-link" href="#3-import-through-arduino-ide" title="Direct link to heading"></a></h4><ul><li>Download the <a href="https://github.com/ayushsharma82/WebSerial/archive/master.zip" target="_blank" rel="noopener noreferrer">Repository</a></li><li>Go to <code>Sketch > Include Library > Add .zip Library > Select the Downloaded .zip File.</code></li></ul></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Introduction</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/getting-started/"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Getting Started</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#dependencies" class="table-of-contents__link toc-highlight">Dependencies</a></li><li><a href="#installing-webserial" class="table-of-contents__link toc-highlight">Installing WebSerial</a></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/getting-started/">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/examples/">Examples</a></li><li class="footer__item"><a class="footer__link-item" href="/commercial-license/">Commercial License</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/ayushsharma82/WebSerial/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Github<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://twitter.com/asrocks5" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title">Support</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/ayushsharma82/WebSerial/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">Create an Issue (Repo)<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://webserial.pro/support" target="_blank" rel="noopener noreferrer" class="footer__link-item">Contact me<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">Copyright © 2024 SOFTT. All rights reserved.</div></div></div></footer></div>
- <script src="/assets/js/runtime~main.bd196cc2.js"></script>
- <script src="/assets/js/main.5657af05.js"></script>
- </body>
- </html>
|
