"use strict";(self.webpackChunkwebserial_docs=self.webpackChunkwebserial_docs||[]).push([[217],{3905:(e,t,r)=>{r.d(t,{Zo:()=>p,kt:()=>m});var a=r(7294);function n(e,t,r){return t in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}function i(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),r.push.apply(r,a)}return r}function l(e){for(var t=1;t<arguments.length;t++){var r=null!=arguments[t]?arguments[t]:{};t%2?i(Object(r),!0).forEach((function(t){n(e,t,r[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(r)):i(Object(r)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(r,t))}))}return e}function o(e,t){if(null==e)return{};var r,a,n=function(e,t){if(null==e)return{};var r,a,n={},i=Object.keys(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||(n[r]=e[r]);return n}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a<i.length;a++)r=i[a],t.indexOf(r)>=0||Object.prototype.propertyIsEnumerable.call(e,r)&&(n[r]=e[r])}return n}var s=a.createContext({}),u=function(e){var t=a.useContext(s),r=t;return e&&(r="function"==typeof e?e(t):l(l({},t),e)),r},p=function(e){var t=u(e.components);return a.createElement(s.Provider,{value:t},e.children)},c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var r=e.components,n=e.mdxType,i=e.originalType,s=e.parentName,p=o(e,["components","mdxType","originalType","parentName"]),d=u(r),m=n,h=d["".concat(s,".").concat(m)]||d[m]||c[m]||i;return r?a.createElement(h,l(l({ref:t},p),{},{components:r})):a.createElement(h,l({ref:t},p))}));function m(e,t){var r=arguments,n=t&&t.mdxType;if("string"==typeof e||n){var i=r.length,l=new Array(i);l[0]=d;var o={};for(var s in t)hasOwnProperty.call(t,s)&&(o[s]=t[s]);o.originalType=e,o.mdxType="string"==typeof e?e:n,l[1]=o;for(var u=2;u<i;u++)l[u]=r[u];return a.createElement.apply(null,l)}return a.createElement.apply(null,r)}d.displayName="MDXCreateElement"},9803:(e,t,r)=>{r.r(t),r.d(t,{assets:()=>s,contentTitle:()=>l,default:()=>c,frontMatter:()=>i,metadata:()=>o,toc:()=>u});var a=r(7462),n=(r(7294),r(3905));const i={title:"Installation",sidebar_label:"Installation",sidebar_position:2},l=void 0,o={unversionedId:"installation",id:"installation",title:"Installation",description:"This document explains the installation procedure for getting started with WebSerial.",source:"@site/docs/installation.md",sourceDirName:".",slug:"/installation",permalink:"/installation",draft:!1,tags:[],version:"current",sidebarPosition:2,frontMatter:{title:"Installation",sidebar_label:"Installation",sidebar_position:2},sidebar:"tutorialSidebar",previous:{title:"Introduction",permalink:"/"},next:{title:"Getting Started",permalink:"/getting-started"}},s={},u=[{value:"Dependencies",id:"dependencies",level:3},{value:"For ESP8266",id:"for-esp8266",level:4},{value:"For ESP32",id:"for-esp32",level:4},{value:"Installing WebSerial",id:"installing-webserial",level:3},{value:"1. Directly Through Arduino IDE - Library Manager",id:"1-directly-through-arduino-ide---library-manager",level:4},{value:"2. Manual Install",id:"2-manual-install",level:4},{value:"For Windows",id:"for-windows",level:5},{value:"For Linux",id:"for-linux",level:5},{value:"3. Import through Arduino IDE",id:"3-import-through-arduino-ide",level:4}],p={toc:u};function c(e){let{components:t,...r}=e;return(0,n.kt)("wrapper",(0,a.Z)({},p,r,{components:t,mdxType:"MDXLayout"}),(0,n.kt)("p",null,"This document explains the installation procedure for getting started with WebSerial."),(0,n.kt)("h3",{id:"dependencies"},"Dependencies"),(0,n.kt)("p",null,(0,n.kt)("em",{parentName:"p"},"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.")),(0,n.kt)("admonition",{title:"Note on Dependencies",type:"important"},(0,n.kt)("p",{parentName:"admonition"},"As of v2, WebSerial has officially switched to using fork of ESPAsyncWebServer and its dependencies from ",(0,n.kt)("a",{parentName:"p",href:"https://github.com/mathieucarbou"},"@mathieucarbou"),". This fork of ESPAsyncWebServer is being maintained regularly and contains many bug fixes along with arduino-esp32 core v3 support."),(0,n.kt)("p",{parentName:"admonition"},"It's suggested to migrate all your projects to using this fork as the original me-no-dev/ESPAsyncWebServer repo is not being maintained  ",(0,n.kt)("em",{parentName:"p"},"since years"),".")),(0,n.kt)("h4",{id:"for-esp8266"},"For ESP8266"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"https://github.com/esp8266/Arduino"},"ESP8266 Arduino Core")," - ",(0,n.kt)("strong",{parentName:"li"},"v3.1.2")),(0,n.kt)("li",{parentName:"ul"},"(mathieucarbou) ",(0,n.kt)("a",{parentName:"li",href:"https://github.com/mathieucarbou/esphome-ESPAsyncTCP#v2.0.0"},"esphome-ESPAsyncTCP")," - ",(0,n.kt)("strong",{parentName:"li"},"v2.0.0")),(0,n.kt)("li",{parentName:"ul"},"(mathieucarbou) ",(0,n.kt)("a",{parentName:"li",href:"https://github.com/mathieucarbou/ESPAsyncWebServer#v3.0.6"},"ESPAsyncWebServer")," - ",(0,n.kt)("strong",{parentName:"li"},"v3.1.1"))),(0,n.kt)("h4",{id:"for-esp32"},"For ESP32"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},(0,n.kt)("a",{parentName:"li",href:"https://github.com/espressif/arduino-esp32"},"ESP32 Arduino Core")," @ ",(0,n.kt)("strong",{parentName:"li"},"v3.0.3")),(0,n.kt)("li",{parentName:"ul"},"(mathieucarbou) ",(0,n.kt)("a",{parentName:"li",href:"https://github.com/mathieucarbou/AsyncTCP#v3.1.4"},"AsyncTCP")," @ ",(0,n.kt)("strong",{parentName:"li"},"v3.2.3")),(0,n.kt)("li",{parentName:"ul"},"(mathieucarbou) ",(0,n.kt)("a",{parentName:"li",href:"https://github.com/mathieucarbou/ESPAsyncWebServer#v3.0.6"},"ESPAsyncWebServer")," - ",(0,n.kt)("strong",{parentName:"li"},"v3.1.1"))),(0,n.kt)("h3",{id:"installing-webserial"},"Installing WebSerial"),(0,n.kt)("h4",{id:"1-directly-through-arduino-ide---library-manager"},"1. Directly Through Arduino IDE - Library Manager"),(0,n.kt)("p",null,'Go to Sketch > Include Library > Library Manager > Search for "WebSerial" > Install'),(0,n.kt)("h4",{id:"2-manual-install"},"2. Manual Install"),(0,n.kt)("h5",{id:"for-windows"},"For Windows"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Download the ",(0,n.kt)("a",{parentName:"li",href:"https://github.com/ayushsharma82/WebSerial/archive/master.zip"},"Repository")),(0,n.kt)("li",{parentName:"ul"},"Extract the .zip in ",(0,n.kt)("inlineCode",{parentName:"li"},'Documents > Arduino > Libraries > {Place "WebSerial" folder Here}'))),(0,n.kt)("h5",{id:"for-linux"},"For Linux"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Download the ",(0,n.kt)("a",{parentName:"li",href:"https://github.com/ayushsharma82/WebSerial/archive/master.zip"},"Repository")),(0,n.kt)("li",{parentName:"ul"},"Extract the .zip in ",(0,n.kt)("inlineCode",{parentName:"li"},'Sketchbook > Libraries > {Place "WebSerial" folder Here}'))),(0,n.kt)("h4",{id:"3-import-through-arduino-ide"},"3. Import through Arduino IDE"),(0,n.kt)("ul",null,(0,n.kt)("li",{parentName:"ul"},"Download the ",(0,n.kt)("a",{parentName:"li",href:"https://github.com/ayushsharma82/WebSerial/archive/master.zip"},"Repository")),(0,n.kt)("li",{parentName:"ul"},"Go to ",(0,n.kt)("inlineCode",{parentName:"li"},"Sketch > Include Library > Add .zip Library > Select the Downloaded .zip File."))))}c.isMDXComponent=!0}}]);