├── .gitattributes ├── .github ├── cla-signatures │ └── cla.json └── workflows │ ├── ci.yml │ ├── cla.yml │ └── stale.yml ├── .gitignore ├── CLA.md ├── CODE_OF_CONDUCT.md ├── LICENSE ├── README.md ├── docs ├── feature.png ├── preview.png └── pro-preview.png ├── examples ├── Demo │ └── Demo.ino ├── Demo_AP │ └── Demo_AP.ino ├── HighPerf │ └── HighPerf.ino └── Logging │ └── Logging.ino ├── keywords.txt ├── library.json ├── library.properties ├── platformio.ini └── src ├── WebSerial.cpp ├── WebSerial.h ├── wslp.cpp └── wslp.h /.gitattributes: -------------------------------------------------------------------------------- 1 | # Auto detect text files and perform LF normalization 2 | * text=auto 3 | -------------------------------------------------------------------------------- /.github/cla-signatures/cla.json: -------------------------------------------------------------------------------- 1 | { 2 | "signedContributors": [ 3 | { 4 | "name": "JorritPosthuma", 5 | "id": 412253, 6 | "comment_id": 2495621851, 7 | "created_at": "2024-11-23T18:59:09Z", 8 | "repoId": 191947254, 9 | "pullRequestNo": 108 10 | } 11 | ] 12 | } -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: Arduino Library CI 2 | 3 | on: 4 | push: 5 | paths-ignore: 6 | - "**/**.md" 7 | - "LICENSE" 8 | - "keywords.txt" 9 | - "library.json" 10 | - "library.properties" 11 | - "portal" 12 | - "docs/*" 13 | pull_request: 14 | paths-ignore: 15 | - "**/**.md" 16 | - "LICENSE" 17 | - "keywords.txt" 18 | - "library.json" 19 | - "library.properties" 20 | - "portal" 21 | - "docs/*" 22 | 23 | jobs: 24 | arduino: 25 | name: Arduino - ${{ matrix.name }} 26 | runs-on: ubuntu-latest 27 | strategy: 28 | fail-fast: false 29 | matrix: 30 | include: 31 | - name: ESP8266 32 | core: esp8266:esp8266 33 | board: esp8266:esp8266:huzzah 34 | index_url: https://arduino.esp8266.com/stable/package_esp8266com_index.json 35 | 36 | - name: ESP32 37 | core: esp32:esp32 38 | board: esp32:esp32:esp32 39 | index_url: https://espressif.github.io/arduino-esp32/package_esp32_index.json 40 | 41 | - name: ESP32 (Dev Branch) 42 | core: esp32:esp32 43 | board: esp32:esp32:esp32 44 | index_url: https://espressif.github.io/arduino-esp32/package_esp32_dev_index.json 45 | 46 | - name: Pico W | RP2040+W 47 | core: rp2040:rp2040 48 | board: rp2040:rp2040:rpipicow 49 | index_url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json 50 | 51 | - name: Pico 2W | RP2350+W 52 | core: rp2040:rp2040 53 | board: rp2040:rp2040:rpipico2w 54 | index_url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json 55 | 56 | steps: 57 | - name: Checkout 58 | uses: actions/checkout@v4 59 | 60 | - name: Arduino Lint 61 | uses: arduino/arduino-lint-action@v1 62 | with: 63 | library-manager: update 64 | 65 | - name: Install arduino-cli 66 | run: curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | BINDIR=/usr/local/bin sh 67 | 68 | - name: Update core index 69 | run: arduino-cli core update-index --additional-urls "${{ matrix.index_url }}" 70 | 71 | - name: Install core 72 | run: arduino-cli core install --additional-urls "${{ matrix.index_url }}" ${{ matrix.core }} 73 | 74 | - name: Install AsyncTCP (ESP32) 75 | if: ${{ matrix.core == 'esp32:esp32' }} 76 | run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/ESP32Async/AsyncTCP#v3.3.7 77 | 78 | - name: Install ESPAsyncTCP (ESP8266) 79 | if: ${{ matrix.core == 'esp8266:esp8266' }} 80 | run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/ESP32Async/ESPAsyncTCP#v2.0.0 81 | 82 | - name: Install RPAsyncTCP (RP2040) 83 | if: ${{ matrix.core == 'rp2040:rp2040' }} 84 | run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/ayushsharma82/RPAsyncTCP#v1.3.2 85 | 86 | - name: Install ESPAsyncWebServer 87 | run: ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true arduino-cli lib install --git-url https://github.com/ESP32Async/ESPAsyncWebServer#v3.7.3 88 | 89 | - name: Build Demo 90 | run: arduino-cli compile --library . --warnings none -b ${{ matrix.board }} "examples/Demo/Demo.ino" 91 | 92 | - name: Build Demo_AP 93 | run: arduino-cli compile --library . --warnings none -b ${{ matrix.board }} "examples/Demo_AP/Demo_AP.ino" 94 | 95 | - name: Build HighPerf 96 | run: arduino-cli compile --library . --warnings none -b ${{ matrix.board }} "examples/HighPerf/HighPerf.ino" 97 | 98 | - name: Build Logging 99 | run: arduino-cli compile --library . --warnings none -b ${{ matrix.board }} "examples/Logging/Logging.ino" 100 | 101 | platformio: 102 | name: PlatformIO - ${{ matrix.name }} 103 | runs-on: ubuntu-latest 104 | strategy: 105 | fail-fast: false 106 | matrix: 107 | include: 108 | - name: ESP8266 (Huzzah) 109 | env: ci-esp8266 110 | board: huzzah 111 | 112 | - name: ESP8266 (D1 Mini) 113 | env: ci-esp8266 114 | board: d1_mini 115 | 116 | - name: ESP32 (Arduino Core v2) 117 | env: ci-esp32-arduino-2 118 | board: esp32dev 119 | 120 | - name: ESP32 121 | env: ci-esp32 122 | board: esp32dev 123 | 124 | - name: ESP32-S2 125 | env: ci-esp32 126 | board: esp32-s2-saola-1 127 | 128 | - name: ESP32-S3 129 | env: ci-esp32 130 | board: esp32-s3-devkitc-1 131 | 132 | - name: ESP32-C3 133 | env: ci-esp32 134 | board: esp32-c3-devkitc-02 135 | 136 | - name: ESP32-C6 137 | env: ci-esp32 138 | board: esp32-c6-devkitc-1 139 | 140 | - name: Pico W | RP2040+W 141 | env: ci-rp2040 142 | board: rpipicow 143 | 144 | - name: Pico 2W | RP2350+W 145 | env: ci-rp2350 146 | board: rpipico2w 147 | steps: 148 | - uses: actions/checkout@v4 149 | 150 | - name: Set up cache 151 | uses: actions/cache@v4 152 | with: 153 | key: ${{ runner.os }}-pio 154 | path: | 155 | ~/.platformio 156 | ~/.cache/pip 157 | 158 | - name: Setup Python 159 | uses: actions/setup-python@v5 160 | with: 161 | python-version: "3.x" 162 | 163 | - name: Setup PlatformIO 164 | run: | 165 | python -m pip install --upgrade pip 166 | pip install --upgrade platformio 167 | 168 | - run: PLATFORMIO_SRC_DIR=examples/Demo PIO_BOARD=${{ matrix.board }} pio run -e ${{ matrix.env }} 169 | - run: PLATFORMIO_SRC_DIR=examples/Demo_AP PIO_BOARD=${{ matrix.board }} pio run -e ${{ matrix.env }} 170 | - run: PLATFORMIO_SRC_DIR=examples/HighPerf PIO_BOARD=${{ matrix.board }} pio run -e ${{ matrix.env }} 171 | - run: PLATFORMIO_SRC_DIR=examples/Logging PIO_BOARD=${{ matrix.board }} pio run -e ${{ matrix.env }} 172 | - run: PLATFORMIO_BUILD_FLAGS="-DWSL_HIGH_PERF" PLATFORMIO_SRC_DIR="examples/Demo" PIO_BOARD=${{ matrix.board }} pio run -e ${{ matrix.env }} 173 | - run: PLATFORMIO_BUILD_FLAGS="-DWSL_HIGH_PERF" PLATFORMIO_SRC_DIR="examples/Demo_AP" PIO_BOARD=${{ matrix.board }} pio run -e ${{ matrix.env }} 174 | - run: PLATFORMIO_BUILD_FLAGS="-DWSL_HIGH_PERF" PLATFORMIO_SRC_DIR="examples/Logging" PIO_BOARD=${{ matrix.board }} pio run -e ${{ matrix.env }} 175 | - run: PLATFORMIO_BUILD_FLAGS="-DWSL_HIGH_PERF" PLATFORMIO_SRC_DIR="examples/HighPerf" PIO_BOARD=${{ matrix.board }} pio run -e ${{ matrix.env }} -------------------------------------------------------------------------------- /.github/workflows/cla.yml: -------------------------------------------------------------------------------- 1 | name: "CLA Assistant" 2 | on: 3 | issue_comment: 4 | types: [created] 5 | pull_request_target: 6 | types: [opened,closed,synchronize] 7 | 8 | # explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings 9 | permissions: 10 | actions: write 11 | contents: write # this can be 'read' if the signatures are in remote repository 12 | pull-requests: write 13 | statuses: write 14 | 15 | jobs: 16 | CLAAssistant: 17 | runs-on: ubuntu-latest 18 | steps: 19 | - name: "CLA Assistant" 20 | if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target' 21 | uses: contributor-assistant/github-action@v2.6.1 22 | env: 23 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 24 | with: 25 | path-to-signatures: '.github/cla-signatures/cla.json' 26 | path-to-document: 'https://github.com/ayushsharma82/WebSerial/blob/master/CLA.md' # e.g. a CLA or a DCO document 27 | # branch should not be protected 28 | branch: 'dev' 29 | allowlist: ayushsharma82,bot* -------------------------------------------------------------------------------- /.github/workflows/stale.yml: -------------------------------------------------------------------------------- 1 | name: 'Close stale issues and PR' 2 | on: 3 | schedule: 4 | - cron: '30 6 * * *' 5 | 6 | jobs: 7 | stale: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/stale@v9 11 | with: 12 | stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.' 13 | stale-pr-message: 'This PR is marked as stale because it has been open 45 days with no activity. You can remove stale label or comment if this PR is still valid.' 14 | close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.' 15 | exempt-issue-labels: bug,triage,feature_request 16 | exempt-pr-labels: wip,feature_request 17 | exempt-all-assignees: true 18 | days-before-stale: 30 19 | days-before-close: 7 20 | days-before-pr-close: -1 -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | .docusaurus 3 | # Prerequisites 4 | .DS_Store 5 | *.d 6 | .vscode/ 7 | 8 | # Object files 9 | *.o 10 | *.ko 11 | *.obj 12 | *.elf 13 | 14 | # Linker output 15 | *.ilk 16 | *.map 17 | *.exp 18 | 19 | # Precompiled Headers 20 | *.gch 21 | *.pch 22 | 23 | # Libraries 24 | *.lib 25 | *.a 26 | *.la 27 | *.lo 28 | 29 | # Shared objects (inc. Windows DLLs) 30 | *.dll 31 | *.so 32 | *.so.* 33 | *.dylib 34 | 35 | # Executables 36 | *.exe 37 | *.out 38 | *.app 39 | *.i*86 40 | *.x86_64 41 | *.hex 42 | 43 | # Debug files 44 | *.dSYM/ 45 | *.su 46 | *.idb 47 | *.pdb 48 | 49 | # Kernel Module Compile Results 50 | *.mod* 51 | *.cmd 52 | .tmp_versions/ 53 | modules.order 54 | Module.symvers 55 | Mkfile.old 56 | dkms.conf 57 | 58 | /portal 59 | /.pio 60 | /logs 61 | /.docusaurus 62 | /node_modules 63 | -------------------------------------------------------------------------------- /CLA.md: -------------------------------------------------------------------------------- 1 | # Contributor Agreement 2 | 3 | ## Individual Contributor Non-Exclusive License Agreement 4 | 5 | Thank you for your interest in contributing to Softt's Software ("We" or "Us"). 6 | 7 | The purpose of this contributor agreement ("Agreement") is to clarify and document the rights granted by contributors to Us. 8 | 9 | ### How to use this Contributor Agreement 10 | 11 | If You are an employee and have created the Contribution as part of your employment, You need to have Your employer approve this Agreement or sign the Entity version of this document. If You do not own the Copyright in the entire work of authorship, any other author of the Contribution should also sign this – in any event, please contact Us at 12 | 13 | ### 1\. Definitions 14 | 15 | **"You"** means the individual Copyright owner who Submits a Contribution to Us. 16 | 17 | **"Legal Entity"** means an entity that is not a natural person. 18 | 19 | **"Affiliate"** means any other Legal Entity that controls, is controlled by, or under common control with that Legal Entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such Legal Entity, whether by contract or otherwise, (ii) ownership of fifty percent (50%) or more of the outstanding shares or securities that vote to elect the management or other persons who direct such Legal Entity or (iii) beneficial ownership of such entity. 20 | 21 | **"Contribution"** means any original work of authorship, including any original modifications or additions to an existing work of authorship, Submitted by You to Us, in which You own the Copyright. 22 | 23 | **"Copyright"** means all rights protecting works of authorship, including copyright, moral and neighboring rights, as appropriate, for the full term of their existence. 24 | 25 | **"Material"** means the software or documentation made available by Us to third parties. When this Agreement covers more than one software project, the Material means the software or documentation to which the Contribution was Submitted. After You Submit the Contribution, it may be included in the Material. 26 | 27 | **"Submit"** means any act by which a Contribution is transferred to Us by You by means of tangible or intangible media, including but not limited to electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, Us, but excluding any transfer that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution." 28 | 29 | **"Documentation"** means any non-software portion of a Contribution. 30 | 31 | ### 2\. License grant 32 | 33 | #### 2.1 Copyright license to Us 34 | 35 | Subject to the terms and conditions of this Agreement, You hereby grant to Us a worldwide, royalty-free, NON-exclusive, perpetual and irrevocable (except as stated in Section 8.2) license, with the right to transfer an unlimited number of non-exclusive licenses or to grant sublicenses to third parties, under the Copyright covering the Contribution to use the Contribution by all means, including, but not limited to: 36 | 37 | * publish the Contribution, 38 | * modify the Contribution, 39 | * prepare derivative works based upon or containing the Contribution and/or to combine the Contribution with other Materials, 40 | * reproduce the Contribution in original or modified form, 41 | * distribute, to make the Contribution available to the public, display and publicly perform the Contribution in original or modified form. 42 | 43 | #### 2.2 Moral rights 44 | 45 | Moral Rights remain unaffected to the extent they are recognized and not waivable by applicable law. Notwithstanding, You may add your name to the attribution mechanism customary used in the Materials you Contribute to, such as the header of the source code files of Your Contribution, and We will respect this attribution when using Your Contribution. 46 | 47 | ### 3\. Patents 48 | 49 | #### 3.1 Patent license 50 | 51 | Subject to the terms and conditions of this Agreement You hereby grant to Us and to recipients of Materials distributed by Us a worldwide, royalty-free, non-exclusive, perpetual and irrevocable (except as stated in Section 3.2) patent license, with the right to transfer an unlimited number of non-exclusive licenses or to grant sublicenses to third parties, to make, have made, use, sell, offer for sale, import and otherwise transfer the Contribution and the Contribution in combination with any Material (and portions of such combination). This license applies to all patents owned or controlled by You, whether already acquired or hereafter acquired, that would be infringed by making, having made, using, selling, offering for sale, importing or otherwise transferring of Your Contribution(s) alone or by combination of Your Contribution(s) with any Material. 52 | 53 | #### 3.2 Revocation of patent license 54 | 55 | You reserve the right to revoke the patent license stated in section 3.1 if We make any infringement claim that is targeted at your Contribution and not asserted for a Defensive Purpose. An assertion of claims of the Patents shall be considered for a "Defensive Purpose" if the claims are asserted against an entity that has filed, maintained, threatened, or voluntarily participated in a patent infringement lawsuit against Us or any of Our licensees. 56 | 57 | ### 4. Disclaimer 58 | 59 | THE CONTRIBUTION IS PROVIDED "AS IS". MORE PARTICULARLY, ALL EXPRESS OR IMPLIED WARRANTIES INCLUDING, WITHOUT LIMITATION, ANY IMPLIED WARRANTY OF SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE EXPRESSLY DISCLAIMED BY YOU TO US AND BY US TO YOU. TO THE EXTENT THAT ANY SUCH WARRANTIES CANNOT BE DISCLAIMED, SUCH WARRANTY IS LIMITED IN DURATION AND EXTENT TO THE MINIMUM PERIOD AND EXTENT PERMITTED BY LAW. 60 | 61 | ### 5. Consequential damage waiver 62 | 63 | TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL YOU OR WE BE LIABLE FOR ANY LOSS OF PROFITS, LOSS OF ANTICIPATED SAVINGS, LOSS OF DATA, INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL AND EXEMPLARY DAMAGES ARISING OUT OF THIS AGREEMENT REGARDLESS OF THE LEGAL OR EQUITABLE THEORY (CONTRACT, TORT OR OTHERWISE) UPON WHICH THE CLAIM IS BASED. 64 | 65 | ### 6. Approximation of disclaimer and damage waiver 66 | 67 | IF THE DISCLAIMER AND DAMAGE WAIVER MENTIONED IN SECTION 4. AND SECTION 5. CANNOT BE GIVEN LEGAL EFFECT UNDER APPLICABLE LOCAL LAW, REVIEWING COURTS SHALL APPLY LOCAL LAW THAT MOST CLOSELY APPROXIMATES AN ABSOLUTE WAIVER OF ALL CIVIL OR CONTRACTUAL LIABILITY IN CONNECTION WITH THE CONTRIBUTION. 68 | 69 | ### 7. Term 70 | 71 | 7.1 This Agreement shall come into effect upon Your acceptance of the terms and conditions. 72 | 73 | 7.3 In the event of a termination of this Agreement Sections 4, 5, 6, 7 and 8 shall survive such termination and shall remain in full force thereafter. For the avoidance of doubt, Free and Open Source Software (sub)licenses that have already been granted for Contributions at the date of the termination shall remain in full force after the termination of this Agreement. 74 | 75 | ### 8 Miscellaneous 76 | 77 | 8.1 This Agreement and all disputes, claims, actions, suits or other proceedings arising out of this agreement or relating in any way to it shall be governed by the laws of India excluding its private international law provisions. 78 | 79 | 8.2 This Agreement sets out the entire agreement between You and Us for Your Contributions to Us and overrides all other agreements or understandings. 80 | 81 | 8.3 In case of Your death, this agreement shall continue with Your heirs. In case of more than one heir, all heirs must exercise their rights through a commonly authorized person. 82 | 83 | 8.4 If any provision of this Agreement is found void and unenforceable, such provision will be replaced to the extent possible with a provision that comes closest to the meaning of the original provision and that is enforceable. The terms and conditions set forth in this Agreement shall apply notwithstanding any failure of essential purpose of this Agreement or any limited remedy to the maximum extent possible under law. 84 | 85 | 8.5 You agree to notify Us of any facts or circumstances of which you become aware that would make this Agreement inaccurate in any respect. -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | 2 | # Contributor Covenant Code of Conduct 3 | 4 | ## Our Pledge 5 | 6 | We as members, contributors, and leaders pledge to make participation in our 7 | community a harassment-free experience for everyone, regardless of age, body 8 | size, visible or invisible disability, ethnicity, sex characteristics, gender 9 | identity and expression, level of experience, education, socio-economic status, 10 | nationality, personal appearance, race, religion, or sexual identity 11 | and orientation. 12 | 13 | We pledge to act and interact in ways that contribute to an open, welcoming, 14 | diverse, inclusive, and healthy community. 15 | 16 | ## Our Standards 17 | 18 | Examples of behavior that contributes to a positive environment for our 19 | community include: 20 | 21 | * Demonstrating empathy and kindness toward other people 22 | * Being respectful of differing opinions, viewpoints, and experiences 23 | * Giving and gracefully accepting constructive feedback 24 | * Accepting responsibility and apologizing to those affected by our mistakes, 25 | and learning from the experience 26 | * Focusing on what is best not just for us as individuals, but for the 27 | overall community 28 | 29 | Examples of unacceptable behavior include: 30 | 31 | * The use of sexualized language or imagery, and sexual attention or 32 | advances of any kind 33 | * Trolling, insulting or derogatory comments, and personal or political attacks 34 | * Public or private harassment 35 | * Publishing others' private information, such as a physical or email 36 | address, without their explicit permission 37 | * Other conduct which could reasonably be considered inappropriate in a 38 | professional setting 39 | 40 | ## Enforcement Responsibilities 41 | 42 | Community leaders are responsible for clarifying and enforcing our standards of 43 | acceptable behavior and will take appropriate and fair corrective action in 44 | response to any behavior that they deem inappropriate, threatening, offensive, 45 | or harmful. 46 | 47 | Community leaders have the right and responsibility to remove, edit, or reject 48 | comments, commits, code, wiki edits, issues, and other contributions that are 49 | not aligned to this Code of Conduct, and will communicate reasons for moderation 50 | decisions when appropriate. 51 | 52 | ## Scope 53 | 54 | This Code of Conduct applies within all community spaces, and also applies when 55 | an individual is officially representing the community in public spaces. 56 | Examples of representing our community include using an official e-mail address, 57 | posting via an official social media account, or acting as an appointed 58 | representative at an online or offline event. 59 | 60 | ## Enforcement 61 | 62 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 63 | reported to the community leaders responsible for enforcement at 64 | . 65 | All complaints will be reviewed and investigated promptly and fairly. 66 | 67 | All community leaders are obligated to respect the privacy and security of the 68 | reporter of any incident. 69 | 70 | ## Enforcement Guidelines 71 | 72 | Community leaders will follow these Community Impact Guidelines in determining 73 | the consequences for any action they deem in violation of this Code of Conduct: 74 | 75 | ### 1. Correction 76 | 77 | **Community Impact**: Use of inappropriate language or other behavior deemed 78 | unprofessional or unwelcome in the community. 79 | 80 | **Consequence**: A private, written warning from community leaders, providing 81 | clarity around the nature of the violation and an explanation of why the 82 | behavior was inappropriate. A public apology may be requested. 83 | 84 | ### 2. Warning 85 | 86 | **Community Impact**: A violation through a single incident or series 87 | of actions. 88 | 89 | **Consequence**: A warning with consequences for continued behavior. No 90 | interaction with the people involved, including unsolicited interaction with 91 | those enforcing the Code of Conduct, for a specified period of time. This 92 | includes avoiding interactions in community spaces as well as external channels 93 | like social media. Violating these terms may lead to a temporary or 94 | permanent ban. 95 | 96 | ### 3. Temporary Ban 97 | 98 | **Community Impact**: A serious violation of community standards, including 99 | sustained inappropriate behavior. 100 | 101 | **Consequence**: A temporary ban from any sort of interaction or public 102 | communication with the community for a specified period of time. No public or 103 | private interaction with the people involved, including unsolicited interaction 104 | with those enforcing the Code of Conduct, is allowed during this period. 105 | Violating these terms may lead to a permanent ban. 106 | 107 | ### 4. Permanent Ban 108 | 109 | **Community Impact**: Demonstrating a pattern of violation of community 110 | standards, including sustained inappropriate behavior, harassment of an 111 | individual, or aggression toward or disparagement of classes of individuals. 112 | 113 | **Consequence**: A permanent ban from any sort of public interaction within 114 | the community. 115 | 116 | ## Attribution 117 | 118 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 119 | version 2.0, available at 120 | . 121 | 122 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 123 | enforcement ladder](https://github.com/mozilla/diversity). 124 | 125 | [homepage]: https://www.contributor-covenant.org 126 | 127 | For answers to common questions about this code of conduct, see the FAQ at 128 | . Translations are available at 129 | . -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | 3 | 4 | 5 |

6 | 7 |
8 | 9 |

10 | 11 |   12 | 13 |   14 | 15 |

16 | 17 |
18 | 19 | **WebSerial** is a remote terminal to log, monitor or debug your firmware without being connected by wire. It lives on your wireless microcontroller itself and can be accessed anytime through your browser. 20 | 21 |
22 |
23 | 24 | ## Features 25 | 26 | - 📜 Log, monitor or debug your firmware/product with ease 27 | - 🔥 A powerful tool that lives in your microcontroller itself 28 | - 🛜 Access it anytime & from anywhere within same network (LAN) 29 | - 🎷 No need to learn HTML/CSS/JS 30 | - 🛫 Ready to use within 4-5 lines of code 31 | 32 |
33 | 34 | ## Supported MCUs 35 | 36 | WebSerial works on the following microcontrollers/boards: 37 | 38 | - ESP8266 39 | - ESP32 40 | - RP2040+W (Example: Raspberry Pico W) 41 | - RP2350+W (Example: Raspberry Pico 2W) 42 | - *( more coming soon )* 43 | 44 |
45 | 46 | ## Documentation 47 | 48 | Learn more about Installation & Usage: [Click Here](https://docs.webserial.pro?ref=gitreadme) 49 | 50 |
51 | 52 | ## OSS Preview 53 | 54 | Once you have integrated WebSerial library in your code, a terminal like below will be accessible over your WiFi microcontroller's IP: 55 | 56 |

57 | 58 |
59 |
60 | 61 | ## Looking for more? Upgrade to Pro. 62 | 63 | WebSerial Pro comes with the following extended functionality: 64 | 65 | - Export logs into TXT, JSON or CSV file 66 | - Lock scroll feature 67 | - Timestamps 68 | - Enable/Disable Command Input Bar 69 | - Customizable font & terminal font size from UI itself 70 | - Branding (Add your own Logo) 71 | - Commercial License 72 | 73 |
Available here: 74 | 75 | - [Official Website ( webserial.pro )](https://webserial.pro?ref=ghrepo) 76 | 77 |
78 | 79 | 80 | WebSerial Pro 81 | 82 | 83 |
84 | 85 | ## Contributions 86 | 87 | Every contribution to this repository is highly appreciated! If you spot any bug or problem, open a issue or pull request so that it can be rectified for everyone. 88 | 89 | **For feature requests:** Please open a issue and I'll add the feature in a future release once I get some time in my hands. 90 | 91 |
92 | 93 | ## License 94 | 95 | WebSerial open-source edition is licensed under Affero General Public License v3.0 ( AGPL-3.0 ). 96 | 97 | If you are intending to use WebSerial in a commercial project, please consider purchasing [WebSerial Pro](https://webserial.pro?ref=ghlicense) which comes with a less restrictive SOFTT Commercial License 1.2 ( SCL-1.2 ). 98 | -------------------------------------------------------------------------------- /docs/feature.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ayushsharma82/WebSerial/3145252bce445c5e5bc944a45715a88fb42e8f8c/docs/feature.png -------------------------------------------------------------------------------- /docs/preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ayushsharma82/WebSerial/3145252bce445c5e5bc944a45715a88fb42e8f8c/docs/preview.png -------------------------------------------------------------------------------- /docs/pro-preview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ayushsharma82/WebSerial/3145252bce445c5e5bc944a45715a88fb42e8f8c/docs/pro-preview.png -------------------------------------------------------------------------------- /examples/Demo/Demo.ino: -------------------------------------------------------------------------------- 1 | /* 2 | -------------- 3 | WebSerial Demo 4 | -------------- 5 | 6 | Skill Level: Beginner 7 | 8 | This example provides with a bare minimal app with WebSerial functionality. 9 | 10 | Github: https://github.com/ayushsharma82/WebSerial 11 | Wiki: https://docs.webserial.pro 12 | 13 | Works with following hardware: 14 | - ESP8266 15 | - ESP32 16 | - RP2040+W 17 | - RP2350+W 18 | 19 | WebSerial terminal will be accessible at your microcontroller's /webserial URL. 20 | 21 | Checkout WebSerial Pro: https://webserial.pro 22 | */ 23 | 24 | #include 25 | #if defined(ESP8266) 26 | #include 27 | #include 28 | #elif defined(ESP32) 29 | #include 30 | #include 31 | #elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) 32 | #include 33 | #include 34 | #endif 35 | #include 36 | #include 37 | 38 | AsyncWebServer server(80); 39 | 40 | const char* ssid = ""; // Your WiFi SSID 41 | const char* password = ""; // Your WiFi Password 42 | 43 | unsigned long last_print_time = millis(); 44 | 45 | void setup() { 46 | Serial.begin(115200); 47 | WiFi.mode(WIFI_STA); 48 | WiFi.begin(ssid, password); 49 | 50 | if (WiFi.waitForConnectResult() != WL_CONNECTED) { 51 | Serial.printf("WiFi Failed!\n"); 52 | return; 53 | } 54 | 55 | // Once connected, print IP 56 | Serial.print("IP Address: "); 57 | Serial.println(WiFi.localIP()); 58 | 59 | server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { 60 | request->send(200, "text/plain", "Hi! This is WebSerial demo. You can access webserial interface at http://" + WiFi.localIP().toString() + "/webserial"); 61 | }); 62 | 63 | // WebSerial is accessible at "/webserial" in browser 64 | WebSerial.begin(&server); 65 | 66 | /* Attach Message Callback */ 67 | WebSerial.onMessage([&](uint8_t *data, size_t len) { 68 | Serial.printf("Received %u bytes from WebSerial: ", len); 69 | Serial.write(data, len); 70 | Serial.println(); 71 | WebSerial.println("Received Data..."); 72 | String d = ""; 73 | for(size_t i=0; i < len; i++){ 74 | d += char(data[i]); 75 | } 76 | WebSerial.println(d); 77 | }); 78 | 79 | // Start server 80 | server.begin(); 81 | } 82 | 83 | void loop() { 84 | // Print every 2 seconds (non-blocking) 85 | if ((unsigned long)(millis() - last_print_time) > 2000) { 86 | WebSerial.print(F("IP address: ")); 87 | WebSerial.println(WiFi.localIP()); 88 | WebSerial.printf("Uptime: %lums\n", millis()); 89 | #if defined(ESP8266) 90 | WebSerial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); 91 | #elif defined(ESP32) 92 | WebSerial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); 93 | #elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) 94 | WebSerial.printf("Free heap: %" PRIu32 "\n", rp2040.getFreeHeap()); 95 | #endif 96 | last_print_time = millis(); 97 | } 98 | 99 | WebSerial.loop(); 100 | } 101 | -------------------------------------------------------------------------------- /examples/Demo_AP/Demo_AP.ino: -------------------------------------------------------------------------------- 1 | /* 2 | -------------- 3 | WebSerial Demo 4 | -------------- 5 | 6 | Skill Level: Beginner 7 | 8 | This example provides with a bare minimal app with WebSerial functionality using softAP mode. 9 | 10 | Github: https://github.com/ayushsharma82/WebSerial 11 | Wiki: https://docs.webserial.pro 12 | 13 | Works with following hardware: 14 | - ESP8266 15 | - ESP32 16 | - RP2040+W 17 | - RP2350+W 18 | 19 | WebSerial terminal will be accessible at your microcontroller's /webserial URL. 20 | 21 | Checkout WebSerial Pro: https://webserial.pro 22 | */ 23 | 24 | #include 25 | #if defined(ESP8266) 26 | #include 27 | #include 28 | #elif defined(ESP32) 29 | #include 30 | #include 31 | #elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) 32 | #include 33 | #include 34 | #endif 35 | #include 36 | #include 37 | 38 | AsyncWebServer server(80); 39 | 40 | const char* ssid = "WSLDemo"; // WiFi AP SSID 41 | const char* password = ""; // WiFi AP Password 42 | 43 | unsigned long last_print_time = millis(); 44 | 45 | void setup() { 46 | Serial.begin(115200); 47 | WiFi.softAP(ssid, password); 48 | // Once connected, print IP 49 | Serial.print("IP Address: "); 50 | Serial.println(WiFi.softAPIP()); 51 | 52 | server.on("/", HTTP_GET, [](AsyncWebServerRequest *request) { 53 | request->send(200, "text/plain", "Hi! This is WebSerial demo. You can access webserial interface at http://" + WiFi.softAPIP().toString() + "/webserial"); 54 | }); 55 | 56 | // WebSerial is accessible at "/webserial" in browser 57 | WebSerial.begin(&server); 58 | 59 | /* Attach Message Callback */ 60 | WebSerial.onMessage([&](uint8_t *data, size_t len) { 61 | Serial.printf("Received %u bytes from WebSerial: ", len); 62 | Serial.write(data, len); 63 | Serial.println(); 64 | WebSerial.println("Received Data..."); 65 | String d = ""; 66 | for(size_t i=0; i < len; i++){ 67 | d += char(data[i]); 68 | } 69 | WebSerial.println(d); 70 | }); 71 | 72 | // Start server 73 | server.begin(); 74 | } 75 | 76 | void loop() { 77 | // Print every 2 seconds (non-blocking) 78 | if ((unsigned long)(millis() - last_print_time) > 2000) { 79 | WebSerial.print(F("IP address: ")); 80 | WebSerial.println(WiFi.softAPIP()); 81 | WebSerial.printf("Uptime: %lums\n", millis()); 82 | #if defined(ESP8266) 83 | WebSerial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); 84 | #elif defined(ESP32) 85 | WebSerial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); 86 | #elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) 87 | WebSerial.printf("Free heap: %" PRIu32 "\n", rp2040.getFreeHeap()); 88 | #endif 89 | last_print_time = millis(); 90 | } 91 | 92 | WebSerial.loop(); 93 | } 94 | -------------------------------------------------------------------------------- /examples/HighPerf/HighPerf.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * This example shows how to use WebSerial variant to send data to the browser when timing, speed and latency are important. 3 | * WebSerial focuses on reducing latency and increasing speed by enqueueing messages and sending them in a single packet. 4 | * 5 | * The responsibility is left to the caller to ensure that the messages sent are not too large or not too small and frequent. 6 | * For example, use of printf(), write(c), print(c), etc are not recommended. 7 | * 8 | * This variant can allow WebSerial to support a high speed of more than 20 messages per second like in this example. 9 | * 10 | * It can be used to log data, debug, or send data to the browser in real-time without any delay. 11 | * 12 | * You might want to look at the Logging variant to see how to better use WebSerial for streaming logging. 13 | * 14 | * You might want to control these flags to control the async library performance: 15 | * -D CONFIG_ASYNC_TCP_QUEUE_SIZE=128 16 | * -D CONFIG_ASYNC_TCP_RUNNING_CORE=1 17 | * -D WS_MAX_QUEUED_MESSAGES=128 18 | */ 19 | #include 20 | 21 | #if defined(ESP8266) 22 | #include 23 | #include 24 | #elif defined(ESP32) 25 | #include 26 | #include 27 | #elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) 28 | #include 29 | #include 30 | #endif 31 | 32 | #include 33 | #include 34 | #include 35 | #include 36 | 37 | AsyncWebServer server(80); 38 | 39 | static const char* dict = "AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz1234567890"; 40 | static uint32_t last = millis(); 41 | static uint32_t count = 0; 42 | 43 | void setup() { 44 | Serial.begin(115200); 45 | 46 | WiFi.softAP("WSLDemo"); 47 | Serial.print("IP Address: "); 48 | Serial.println(WiFi.softAPIP().toString()); 49 | 50 | WebSerial.onMessage([](const String& msg) { Serial.println(msg); }); 51 | WebSerial.begin(&server); 52 | 53 | server.onNotFound([](AsyncWebServerRequest* request) { request->redirect("/webserial"); }); 54 | server.begin(); 55 | } 56 | 57 | void loop() { 58 | #ifdef ESP8266 59 | if (millis() - last > 500) { 60 | #else 61 | if (millis() - last > 50) { 62 | #endif 63 | count++; 64 | 65 | long r = random(10, 250) + 15; 66 | String buffer; 67 | buffer.reserve(r); 68 | buffer += count; 69 | while (buffer.length() < 10) { 70 | buffer += " "; 71 | } 72 | buffer += ""; 73 | for (int i = 0; i < r; i++) { 74 | buffer += dict[random(0, 62)]; 75 | } 76 | 77 | #ifdef WSL_HIGH_PERF 78 | // Using internal websocket buffer to improve memory consumption and avoid another internal copy when enqueueing the message 79 | AsyncWebSocketMessageBuffer* wsBuffer = WebSerial.makeBuffer(buffer.length()); 80 | memmove(wsBuffer->get(), buffer.c_str(), buffer.length()); 81 | WebSerial.send(wsBuffer); 82 | #else 83 | WebSerial.print(buffer); 84 | #endif 85 | 86 | last = millis(); 87 | } 88 | } 89 | -------------------------------------------------------------------------------- /examples/Logging/Logging.ino: -------------------------------------------------------------------------------- 1 | /* 2 | * This example shows how to use WebSerial variant to send logging data to the browser. 3 | * 4 | * Before using this example, make sure to look at the WebSerial example before and its description.\ 5 | * 6 | * You might want to control these flags to control the async library performance: 7 | * -D CONFIG_ASYNC_TCP_QUEUE_SIZE=128 8 | * -D CONFIG_ASYNC_TCP_RUNNING_CORE=1 9 | * -D WS_MAX_QUEUED_MESSAGES=128 10 | */ 11 | #include 12 | 13 | #if defined(ESP8266) 14 | #include 15 | #include 16 | #elif defined(ESP32) 17 | #include 18 | #include 19 | #elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) 20 | #include 21 | #include 22 | #endif 23 | 24 | #include 25 | #include 26 | #include 27 | #include 28 | 29 | AsyncWebServer server(80); 30 | 31 | static uint32_t last = millis(); 32 | static uint32_t count = 0; 33 | 34 | void setup() { 35 | Serial.begin(115200); 36 | 37 | WiFi.softAP("WSLDemo"); 38 | Serial.print("IP Address: "); 39 | Serial.println(WiFi.softAPIP().toString()); 40 | 41 | WebSerial.onMessage([](const String& msg) { Serial.println(msg); }); 42 | WebSerial.begin(&server); 43 | WebSerial.setBuffer(100); 44 | 45 | server.onNotFound([](AsyncWebServerRequest* request) { request->redirect("/webserial"); }); 46 | server.begin(); 47 | } 48 | 49 | void loop() { 50 | if (millis() - last > 1000) { 51 | count++; 52 | 53 | WebSerial.print(F("IP address: ")); 54 | WebSerial.println(WiFi.softAPIP()); 55 | WebSerial.printf("Uptime: %lums\n", millis()); 56 | #if defined(ESP8266) 57 | WebSerial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); 58 | #elif defined(ESP32) 59 | WebSerial.printf("Free heap: %" PRIu32 "\n", ESP.getFreeHeap()); 60 | #elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) 61 | WebSerial.printf("Free heap: %" PRIu32 "\n", rp2040.getFreeHeap()); 62 | #endif 63 | 64 | last = millis(); 65 | } 66 | } 67 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | WebSerial KEYWORD1 2 | begin KEYWORD2 3 | loop KEYWORD2 4 | print KEYWORD2 5 | println KEYWORD2 6 | printf KEYWORD2 7 | write KEYWORD2 8 | onMessage KEYWORD2 -------------------------------------------------------------------------------- /library.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "WebSerial", 3 | "keywords": "WebSerial, remote, terminal, serial, monitor, ESP8266, ESP32, RP2040, RP2350, webpage, websocket, wireless", 4 | "description": "WebSerial is a remote terminal which is accessible via browser to log, monitor or debug your firmware remotely.", 5 | "repository": 6 | { 7 | "type": "git", 8 | "url": "https://github.com/ayushsharma82/WebSerial.git" 9 | }, 10 | "authors": 11 | [ 12 | { 13 | "name": "Ayush Sharma", 14 | "email": "asrocks5@gmail.com", 15 | "maintainer": true 16 | } 17 | ], 18 | "version": "2.1.1", 19 | "frameworks": "arduino", 20 | "platforms": ["espressif8266", "espressif32", "raspberrypi"], 21 | "dependencies": [ 22 | { 23 | "owner": "esp32async", 24 | "name": "ESPAsyncWebServer", 25 | "version": "^3.7.3", 26 | "platforms": ["espressif8266", "espressif32", "raspberrypi"] 27 | } 28 | ] 29 | } 30 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=WebSerial 2 | version=2.1.1 3 | author=Ayush Sharma 4 | category=Communication 5 | maintainer=Ayush Sharma 6 | sentence=Remote terminal for wireless microcontrollers 7 | paragraph=WebSerial is a remote terminal which is accessible via browser to log, monitor or debug your firmware remotely. 8 | url=https://github.com/ayushsharma82/WebSerial 9 | architectures=esp8266,esp32,rp2040 10 | -------------------------------------------------------------------------------- /platformio.ini: -------------------------------------------------------------------------------- 1 | [env] 2 | framework = arduino 3 | build_flags = 4 | -Wall -Wextra 5 | -D CONFIG_ARDUHAL_LOG_COLORS 6 | -D CORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_DEBUG 7 | lib_deps = 8 | esp32async/ESPAsyncWebServer@^3.7.3 9 | upload_protocol = esptool 10 | monitor_speed = 115200 11 | monitor_filters = esp32_exception_decoder, log2file 12 | 13 | [platformio] 14 | lib_dir = . 15 | src_dir = examples/Demo 16 | ; src_dir = examples/Demo_AP 17 | 18 | [env:esp32] 19 | build_flags = ${env.build_flags} 20 | platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.13/platform-espressif32.zip 21 | board = esp32-s3-devkitc-1 22 | lib_deps = 23 | esp32async/AsyncTCP@^3.3.7 24 | ${env.lib_deps} 25 | 26 | [env:esp8266] 27 | platform = espressif8266 28 | board = huzzah 29 | lib_deps = 30 | esp32async/ESPAsyncTCP@^2.0.0 31 | ${env.lib_deps} 32 | 33 | [env:picow] 34 | platform = https://github.com/maxgerhardt/platform-raspberrypi.git 35 | board = rpipicow 36 | framework = arduino 37 | board_build.core = earlephilhower 38 | lib_deps = 39 | ayushsharma82/RPAsyncTCP@^1.3.2 40 | ${env.lib_deps} 41 | lib_ignore = 42 | lwIP_ESPHost 43 | 44 | [env:pico2w] 45 | platform = https://github.com/maxgerhardt/platform-raspberrypi.git 46 | board = rpipico2w 47 | framework = arduino 48 | board_build.core = earlephilhower 49 | lib_deps = 50 | ayushsharma82/RPAsyncTCP@^1.3.2 51 | ${env.lib_deps} 52 | lib_ignore = 53 | lwIP_ESPHost 54 | 55 | ; ------------ 56 | ; CI Workflows 57 | ; ------------ 58 | 59 | [env:ci-esp8266] 60 | platform = espressif8266 61 | board = ${sysenv.PIO_BOARD} 62 | lib_deps = 63 | esp32async/ESPAsyncTCP@^2.0.0 64 | ${env.lib_deps} 65 | 66 | [env:ci-esp32-arduino-2] 67 | platform = espressif32@6.7.0 68 | board = ${sysenv.PIO_BOARD} 69 | lib_deps = 70 | esp32async/AsyncTCP@^3.3.7 71 | ${env.lib_deps} 72 | 73 | [env:ci-esp32] 74 | platform = https://github.com/pioarduino/platform-espressif32/releases/download/53.03.13/platform-espressif32.zip 75 | board = ${sysenv.PIO_BOARD} 76 | lib_deps = 77 | esp32async/AsyncTCP@^3.3.7 78 | ${env.lib_deps} 79 | 80 | [env:ci-rp2040] 81 | platform = https://github.com/maxgerhardt/platform-raspberrypi.git 82 | board = rpipicow 83 | framework = arduino 84 | board_build.core = earlephilhower 85 | lib_deps = 86 | ayushsharma82/RPAsyncTCP@^1.3.2 87 | ${env.lib_deps} 88 | lib_ignore = 89 | lwIP_ESPHost 90 | 91 | [env:ci-rp2350] 92 | platform = https://github.com/maxgerhardt/platform-raspberrypi.git 93 | board = rpipico2w 94 | framework = arduino 95 | board_build.core = earlephilhower 96 | lib_deps = 97 | ayushsharma82/RPAsyncTCP@^1.3.2 98 | ${env.lib_deps} 99 | lib_ignore = 100 | lwIP_ESPHost -------------------------------------------------------------------------------- /src/WebSerial.cpp: -------------------------------------------------------------------------------- 1 | #include "WebSerial.h" 2 | 3 | #include "wslp.h" 4 | 5 | #include 6 | 7 | // DO NOT change magic bytes 8 | #define WSL_MAGIC_BYTE_1 0xAB 9 | #define WSL_MAGIC_BYTE_2 0xCD 10 | #define WSL_LOG_PACKET_HEADER_SIZE 14 11 | #define WSL_CALC_LOG_PACKET_SIZE(len) (WSL_LOG_PACKET_HEADER_SIZE + len) 12 | 13 | typedef enum { 14 | WSL_WRITE_ROW = 0x01, 15 | WSL_MESSAGE = 0x02, 16 | WSL_PING = 0x03, 17 | WSL_PONG = 0x04, 18 | } WSLPacketType; 19 | 20 | static const uint8_t WSL_PONG_MSG[] = {WSL_MAGIC_BYTE_1, WSL_MAGIC_BYTE_2, WSLPacketType::WSL_PONG}; 21 | static const size_t WSL_PONG_MSG_LEN = sizeof(WSL_PONG_MSG) / sizeof(WSL_PONG_MSG[0]); 22 | 23 | static const uint8_t WSL_HEAD[] = { 24 | WSL_MAGIC_BYTE_1, // Magic Bytes 25 | WSL_MAGIC_BYTE_2, // Magic Bytes 26 | WSLPacketType::WSL_WRITE_ROW, // Packet Type (1 byte) 27 | 0x00, // Reserved 28 | 0x00, // Reserved 29 | 0x00, // Reserved 30 | 0x00, // Reserved 31 | 0x00, // Padding 32 | 0x00, // Padding 33 | 0x00, // Padding 34 | 0x00, // Padding 35 | 0x00 // Reserved 36 | }; 37 | static const size_t WSL_HEAD_LEN = sizeof(WSL_HEAD) / sizeof(WSL_HEAD[0]); 38 | 39 | static const size_t WSL_MSG_SIZE_LEN = sizeof(uint16_t); 40 | 41 | void WebSerialClass::setAuthentication(const String& username, const String& password){ 42 | _username = username; 43 | _password = password; 44 | _authenticate = !_username.isEmpty() && !_password.isEmpty(); 45 | if (_ws != nullptr) { 46 | _ws->setAuthentication(_username.c_str(), _password.c_str()); 47 | } 48 | } 49 | 50 | void WebSerialClass::begin(AsyncWebServer *server, const char* url) { 51 | _server = server; 52 | _ws = new AsyncWebSocket("/wserial"); 53 | 54 | if (_authenticate) { 55 | _ws->setAuthentication(_username.c_str(), _password.c_str()); 56 | } 57 | 58 | // Webpage Handler 59 | _server->on(url, HTTP_GET, [&](AsyncWebServerRequest *request){ 60 | if(_authenticate){ 61 | if(!request->authenticate(_username.c_str(), _password.c_str())) 62 | return request->requestAuthentication(); 63 | } 64 | AsyncWebServerResponse *response = request->beginResponse(200, "text/html", WEBSERIAL_HTML, sizeof(WEBSERIAL_HTML)); 65 | response->addHeader("Content-Encoding", "gzip"); 66 | request->send(response); 67 | }); 68 | 69 | // WS Handler 70 | _ws->onEvent([&](__unused AsyncWebSocket * server, AsyncWebSocketClient * client, AwsEventType type, __unused void * arg, uint8_t *data, __unused size_t len) -> void { 71 | // if(type == WS_EVT_CONNECT){ 72 | // } else if(type == WS_EVT_DISCONNECT){ 73 | // } else if(type == WS_EVT_DATA){ 74 | if (type == WS_EVT_CONNECT) { 75 | client->setCloseClientOnQueueFull(false); 76 | return; 77 | } 78 | if(type == WS_EVT_DATA){ 79 | // Detect magic bytes 80 | if (data[0] == WSL_MAGIC_BYTE_1 && data[1] == WSL_MAGIC_BYTE_2) { 81 | if (data[2] == WSLPacketType::WSL_MESSAGE) { 82 | // Parse message size (uint16_t) 83 | size_t message_size = (data[4] << 8) | data[3]; 84 | // Issue callback 85 | if(_recv != nullptr){ 86 | _recv(data + 5, message_size); 87 | } 88 | } else if (data[2] == WSLPacketType::WSL_PING) { 89 | // Send pong 90 | client->binary(WSL_PONG_MSG, WSL_PONG_MSG_LEN); 91 | } 92 | } 93 | } 94 | }); 95 | 96 | // Attach AsyncWebServer with Websockets 97 | _server->addHandler(_ws); 98 | } 99 | 100 | // onMessage Callback Handler 101 | void WebSerialClass::onMessage(WSLMessageHandler recv) { 102 | _recv = recv; 103 | } 104 | 105 | void WebSerialClass::onMessage(WSLStringMessageHandler callback) { 106 | _recvString = callback; 107 | _recv = [&](uint8_t *data, size_t len) { 108 | if(data && len) { 109 | String msg; 110 | msg.reserve(len); 111 | msg.concat((char*)data, len); 112 | _recvString(msg); 113 | } 114 | }; 115 | } 116 | 117 | bool WebSerialClass::getConnectionCount() { 118 | return _ws->count(); 119 | } 120 | 121 | // Print func 122 | size_t WebSerialClass::write(uint8_t m) { 123 | if (!_ws) 124 | return 0; 125 | 126 | #ifdef WSL_HIGH_PERF 127 | // We do not support non-buffered write on webserial for the HIGH_PERF version 128 | // we fail with a stack trace allowing the user to change the code to use write(const uint8_t* buffer, size_t size) instead 129 | if(!_initialBufferCapacity) { 130 | #if defined(ESP8266) 131 | ets_printf("Non-buffered write is not supported. Please use write(const uint8_t* buffer, size_t size) instead."); 132 | #elif defined(ESP32) 133 | log_e("Non-buffered write is not supported. Please use write(const uint8_t* buffer, size_t size) instead."); 134 | #elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) 135 | Serial.println("Non-buffered write is not supported. Please use write(const uint8_t* buffer, size_t size) instead."); 136 | #endif 137 | assert(false); 138 | return 0; 139 | } 140 | #endif // WSL_HIGH_PERF 141 | 142 | write(&m, 1); 143 | return(1); 144 | } 145 | 146 | // Println / Printf / Write func 147 | size_t WebSerialClass::write(const uint8_t* buffer, size_t size) { 148 | if (!_ws || size == 0) 149 | return 0; 150 | 151 | #ifdef WSL_HIGH_PERF 152 | // No buffer, send directly (i.e. use case for log streaming) 153 | if (!_initialBufferCapacity) { 154 | size = buffer[size - 1] == '\n' ? size - 1 : size; 155 | _send(buffer, size); 156 | return size; 157 | } 158 | 159 | // fill the buffer while sending data for each EOL 160 | size_t start = 0, end = 0; 161 | while (end < size) { 162 | if (buffer[end] == '\n') { 163 | if (end > start) { 164 | _buffer.concat(reinterpret_cast(buffer + start), end - start); 165 | } 166 | _send(reinterpret_cast(_buffer.c_str()), _buffer.length()); 167 | start = end + 1; 168 | } 169 | end++; 170 | } 171 | if (end > start) { 172 | _buffer.concat(reinterpret_cast(buffer + start), end - start); 173 | } 174 | return size; 175 | #else 176 | loop(); 177 | 178 | if (_print_buffer_offset + size > WSL_PRINT_BUFFER_SIZE) { 179 | // Flush print buffer if full 180 | _flush_print_buffer(); 181 | } 182 | 183 | memcpy(_print_buffer + _print_buffer_offset, buffer, size); 184 | _print_buffer_offset += size; 185 | _last_print_buffer_write_time = micros(); 186 | return(size); 187 | #endif 188 | } 189 | 190 | #ifdef WSL_HIGH_PERF 191 | void WebSerialClass::_send(const uint8_t* buffer, size_t size) { 192 | if (_ws && size > 0) { 193 | _ws->cleanupClients(WSL_MAX_WS_CLIENTS); 194 | if (_ws->count()) { 195 | if (size > UINT16_MAX) 196 | size = UINT16_MAX; 197 | AsyncWebSocketMessageBuffer* wsbuffer = _ws->makeBuffer(WSL_HEAD_LEN + WSL_MSG_SIZE_LEN + size); 198 | _write_row_packet(wsbuffer->get(), buffer, size); 199 | _ws->binaryAll(wsbuffer); 200 | } 201 | } 202 | 203 | // if buffer grew too much, free it, otherwise clear it 204 | if (_initialBufferCapacity) { 205 | if (_buffer.length() > _initialBufferCapacity) { 206 | setBuffer(_initialBufferCapacity); 207 | } else { 208 | #if defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) 209 | _buffer = ""; 210 | #else 211 | _buffer.clear(); 212 | #endif 213 | } 214 | } 215 | } 216 | 217 | #else // WSL_HIGH_PERF 218 | 219 | bool WebSerialClass::_has_enough_space(size_t size) { 220 | // Check if total packet size exceeds buffer limit 221 | return (_buffer_offset + WSL_CALC_LOG_PACKET_SIZE(size) > WSL_BUFFER_SIZE); 222 | } 223 | 224 | size_t WebSerialClass::_write_row(uint8_t *data, size_t len) { 225 | // Split the logData into multiple packets 226 | size_t remaining_size = len; 227 | uint8_t* current_ptr = data; 228 | 229 | while (remaining_size > 0) { 230 | size_t packet_size = (remaining_size > WSL_MAX_ROW_PACKET_PAYLOAD_SIZE) ? WSL_MAX_ROW_PACKET_PAYLOAD_SIZE : remaining_size; 231 | 232 | // Clear if buffer is full 233 | if (!_has_enough_space(packet_size)) { 234 | _flush_global_buffer(); 235 | } 236 | 237 | // Write Packet to Buffer 238 | _buffer_offset += _write_row_packet(_buffer, current_ptr, packet_size); 239 | 240 | // Set remaining size 241 | remaining_size -= packet_size; 242 | current_ptr += packet_size; 243 | } 244 | 245 | return len; 246 | } 247 | 248 | void WebSerialClass::_flush_print_buffer() { 249 | if (_print_buffer_offset > 0) { 250 | if (_buffer_offset + _print_buffer_offset > WSL_BUFFER_SIZE) { 251 | // Flush global buffer to websocket 252 | _flush_global_buffer(); 253 | } 254 | 255 | // Flush print to global buffer and create a packet 256 | _write_row(_print_buffer, _print_buffer_offset); 257 | _print_buffer_offset = 0; 258 | _last_print_buffer_flush_time = millis(); 259 | } 260 | } 261 | 262 | void WebSerialClass::_flush_global_buffer() { 263 | if (_buffer_offset > 0) { 264 | // Flush buffer to websocket 265 | _ws->binaryAll(_buffer, _buffer_offset); 266 | // Reset buffer offset 267 | _buffer_offset = 0; 268 | } 269 | } 270 | #endif // WSL_HIGH_PERF 271 | 272 | void WebSerialClass::loop() { 273 | #ifndef WSL_HIGH_PERF 274 | if ((unsigned long)(millis() - _last_cleanup_time) > WSL_CLEANUP_TIME_MS) { 275 | _last_cleanup_time = millis(); 276 | _ws->cleanupClients(WSL_MAX_WS_CLIENTS); 277 | } 278 | 279 | // If FLUSH_TIME ms has been passed since last packet time, flush logs 280 | if (_last_print_buffer_write_time != 0) { 281 | if ((unsigned long)(micros() - _last_print_buffer_write_time) > WSL_PRINT_FLUSH_TIME_US) { 282 | _flush_print_buffer(); 283 | } 284 | } 285 | 286 | // If FLUSH_TIME ms has been passed since last flush time, flush logs 287 | if (_last_print_buffer_flush_time != 0) { 288 | if ((unsigned long)(millis() - _last_print_buffer_flush_time) > WSL_GLOBAL_FLUSH_TIME_MS) { 289 | _flush_global_buffer(); 290 | } 291 | } 292 | #endif // WSL_HIGH_PERF 293 | } 294 | 295 | void WebSerialClass::setBuffer(size_t initialCapacity) { 296 | #ifdef WSL_HIGH_PERF 297 | assert(initialCapacity <= UINT16_MAX); 298 | _initialBufferCapacity = initialCapacity; 299 | _buffer = String(); 300 | _buffer.reserve(initialCapacity); 301 | #endif 302 | } 303 | 304 | size_t WebSerialClass::_write_row_packet(uint8_t* dest, const uint8_t *payload, size_t payload_size) { 305 | // sanity check to ensure the payload size is within the hard limit 306 | if(payload_size > UINT16_MAX) 307 | payload_size = UINT16_MAX; 308 | // Write header 309 | memmove(dest, WSL_HEAD, WSL_HEAD_LEN); 310 | // Message Length (2 bytes) 311 | memset(dest + WSL_HEAD_LEN, static_cast(payload_size), WSL_MSG_SIZE_LEN); 312 | // Set Message 313 | memmove(dest + WSL_HEAD_LEN + WSL_MSG_SIZE_LEN, payload, payload_size); 314 | // Return total packet size 315 | return WSL_HEAD_LEN + WSL_MSG_SIZE_LEN + payload_size; 316 | } 317 | 318 | WebSerialClass WebSerial; -------------------------------------------------------------------------------- /src/WebSerial.h: -------------------------------------------------------------------------------- 1 | /* 2 | __ __ _ ____ _ _ 3 | \ \ / /__| |__/ ___| ___ _ __(_) __ _| | 4 | \ \ /\ / / _ \ '_ \___ \ / _ \ '__| |/ _` | | 5 | \ V V / __/ |_) |__) | __/ | | | (_| | | 6 | \_/\_/ \___|_.__/____/ \___|_| |_|\__,_|_| 7 | 8 | 9 | A remote terminal for wireless microcontrollers! 10 | 11 | Checkout Pro version at: https://webserial.pro 12 | 13 | ----- 14 | 15 | Author: Ayush Sharma (ayush@softt.io) 16 | License: AGPL-3.0 (https://www.gnu.org/licenses/agpl-3.0.html) 17 | */ 18 | 19 | #ifndef WebSerial_h 20 | #define WebSerial_h 21 | 22 | #include "Arduino.h" 23 | #include "stdlib_noniso.h" 24 | #include 25 | 26 | #if defined(ESP8266) 27 | #define HARDWARE "ESP8266" 28 | #include "ESP8266WiFi.h" 29 | #include "ESPAsyncTCP.h" 30 | #include "ESPAsyncWebServer.h" 31 | #elif defined(ESP32) 32 | #define HARDWARE "ESP32" 33 | #include "WiFi.h" 34 | #include "AsyncTCP.h" 35 | #include "ESPAsyncWebServer.h" 36 | #elif defined(TARGET_RP2040) || defined(TARGET_RP2350) || defined(PICO_RP2040) || defined(PICO_RP2350) 37 | #include "WiFi.h" 38 | #include "RPAsyncTCP.h" 39 | #include "ESPAsyncWebServer.h" 40 | #if defined(TARGET_RP2040) || defined(PICO_RP2040) 41 | #define HARDWARE "RP2040" 42 | #elif defined(TARGET_RP2350) || defined(PICO_RP2350) 43 | #define HARDWARE "RP2350" 44 | #endif 45 | #endif 46 | 47 | #ifndef WSL_MAX_WS_CLIENTS 48 | #define WSL_MAX_WS_CLIENTS DEFAULT_MAX_WS_CLIENTS 49 | #endif 50 | 51 | // High performance mode: 52 | // - Low memory footprint (no stack allocation, no global buffer by default) 53 | // - Low latency (messages sent immediately to the WebSocket queue) 54 | // - High throughput (up to 20 messages per second, no locking mechanism) 55 | // Activation with: -D WSL_HIGH_PERFORMANCE 56 | // Also recommended to tweak AsyncTCP and ESPAsyncWebServer settings, for example: 57 | // -D CONFIG_ASYNC_TCP_QUEUE_SIZE=128 // AsyncTCP queue size 58 | // -D CONFIG_ASYNC_TCP_RUNNING_CORE=1 // core for the async_task 59 | // -D WS_MAX_QUEUED_MESSAGES=128 // WS message queue size 60 | #ifndef WSL_HIGH_PERF 61 | // Global buffer ( buffers all packets ) 62 | #ifndef WSL_BUFFER_SIZE 63 | #define WSL_BUFFER_SIZE 2048 64 | #endif 65 | #ifndef WSL_PRINT_BUFFER_SIZE 66 | #define WSL_PRINT_BUFFER_SIZE 1024 67 | #endif 68 | #ifndef WSL_MAX_ROW_PACKET_PAYLOAD_SIZE 69 | #define WSL_MAX_ROW_PACKET_PAYLOAD_SIZE 512 70 | #endif 71 | 72 | #ifndef WSL_PRINT_FLUSH_TIME_US 73 | #define WSL_PRINT_FLUSH_TIME_US 100 74 | #endif 75 | #ifndef WSL_GLOBAL_FLUSH_TIME_MS 76 | #define WSL_GLOBAL_FLUSH_TIME_MS 100 77 | #endif 78 | #ifndef WSL_CLEANUP_TIME_MS 79 | #define WSL_CLEANUP_TIME_MS 5000 80 | #endif 81 | 82 | #if WSL_BUFFER_SIZE < 512 83 | #error "WSL_BUFFER_SIZE must be >= 512 bytes" 84 | #endif 85 | 86 | #if WSL_BUFFER_SIZE < WSL_PRINT_BUFFER_SIZE 87 | #error "WSL_BUFFER_SIZE must be >= WSL_PRINT_BUFFER_SIZE" 88 | #endif 89 | 90 | #if WSL_PRINT_FLUSH_TIME_US < 1 91 | #error "WSL_PRINT_FLUSH_TIME_US must be greater than 1us" 92 | #endif 93 | 94 | #if WSL_GLOBAL_FLUSH_TIME_MS < 50 95 | #error "WSL_GLOBAL_FLUSH_TIME_MS must be greater than 50ms" 96 | #endif 97 | #endif // WSL_HIGH_PERFORMANCE 98 | 99 | typedef std::function WSLMessageHandler; 100 | typedef std::function WSLStringMessageHandler; 101 | 102 | class WebSerialClass : public Print { 103 | public: 104 | void begin(AsyncWebServer *server, const char* url = "/webserial"); 105 | inline void setAuthentication(const char* username, const char* password) { setAuthentication(String(username), String(password)); } 106 | void setAuthentication(const String& username, const String& password); 107 | void onMessage(WSLMessageHandler recv); 108 | void onMessage(WSLStringMessageHandler recv); 109 | bool getConnectionCount(); 110 | size_t write(uint8_t) override; 111 | size_t write(const uint8_t* buffer, size_t size) override; 112 | 113 | // Only valid if WSL_HIGH_PERF is not activated (which is the default) 114 | // Housekeeping for WebSerial internals. 115 | // Calling this loop has no effect if WSL_HIGH_PERF is activated 116 | void loop(); 117 | 118 | // Only valid if WSL_HIGH_PERF is activated 119 | // A buffer (shared across cores) can be initialised with an initial capacity to be able to use any Print functions event those that are not buffered and would 120 | // create a performance impact for WS calls. The goal of this buffer is to be used with lines ending with '\n', like log messages. 121 | // The buffer size will eventually grow until a '\n' is found, then the message will be sent to the WS clients and a new buffer will be created. 122 | // Set initialCapacity to 0 to disable buffering. 123 | // Must be called before begin(): calling it after will erase the buffer and its content will be lost. 124 | // The buffer is not enabled by default. 125 | void setBuffer(size_t initialCapacity); 126 | 127 | #ifdef WSL_HIGH_PERF 128 | // Expose the internal WebSocket makeBuffer to even improve memory consumption on client-side 129 | // 1. make a AsyncWebSocketMessageBuffer 130 | // 2. put the data inside 131 | // 3. send the buffer 132 | // This method avoids a buffer copy when creating the WebSocket message 133 | AsyncWebSocketMessageBuffer* makeBuffer(size_t size = 0) { 134 | if (!_ws) 135 | return nullptr; 136 | return _ws->makeBuffer(size); 137 | } 138 | 139 | void send(AsyncWebSocketMessageBuffer* buffer) { 140 | if (!_ws || !buffer) 141 | return; 142 | _ws->cleanupClients(WSL_MAX_WS_CLIENTS); 143 | if (_ws->count()) 144 | _ws->textAll(buffer); 145 | } 146 | #endif 147 | 148 | private: 149 | // Server 150 | AsyncWebServer *_server; 151 | AsyncWebSocket *_ws; 152 | WSLMessageHandler _recv = nullptr; 153 | WSLStringMessageHandler _recvString = nullptr; 154 | bool _authenticate = false; 155 | String _username; 156 | String _password; 157 | 158 | #ifdef WSL_HIGH_PERF 159 | size_t _initialBufferCapacity = 0; 160 | String _buffer; 161 | void _send(const uint8_t* buffer, size_t size); 162 | #else 163 | unsigned long _last_cleanup_time = 0; 164 | 165 | // Global Buffer 166 | size_t _buffer_offset = 0; 167 | uint8_t _buffer[WSL_BUFFER_SIZE]; 168 | 169 | // Print buffer 170 | size_t _print_buffer_offset = 0; 171 | uint8_t _print_buffer[WSL_PRINT_BUFFER_SIZE]; 172 | unsigned long _last_print_buffer_write_time = 0; 173 | unsigned long _last_print_buffer_flush_time = 0; 174 | 175 | // Print 176 | bool _has_enough_space(size_t size); 177 | size_t _start_row(); 178 | size_t _write_row(uint8_t *data, size_t len); 179 | size_t _end_row(); 180 | void _flush_print_buffer(); 181 | void _flush_global_buffer(); 182 | #endif 183 | 184 | static size_t _write_row_packet(uint8_t* dest, const uint8_t *payload, size_t payload_size); 185 | }; 186 | 187 | extern WebSerialClass WebSerial; 188 | #endif -------------------------------------------------------------------------------- /src/wslp.h: -------------------------------------------------------------------------------- 1 | #ifndef wslp_h 2 | #define wslp_h 3 | 4 | #include 5 | 6 | #ifndef WEBSERIAL_USE_BROTLI_COMPRESSION 7 | #define WEBSERIAL_USE_BROTLI_COMPRESSION 0 8 | #endif 9 | 10 | #if WEBSERIAL_USE_BROTLI_COMPRESSION == 1 11 | extern const uint8_t WEBSERIAL_HTML[19124]; 12 | #else 13 | extern const uint8_t WEBSERIAL_HTML[21096]; 14 | #endif 15 | 16 | #endif 17 | --------------------------------------------------------------------------------