├── .codespellrc ├── .github ├── dependabot.yml └── workflows │ ├── check-arduino.yml │ ├── compile-examples.yml │ ├── report-size-deltas.yml │ ├── spell-check.yml │ └── sync-labels.yml ├── LICENSE.txt ├── README.adoc ├── docs ├── api.md └── readme.md ├── examples ├── WiFi101_OTA │ ├── WiFi101_OTA.ino │ └── arduino_secrets.h └── WiFi101_SD_OTA │ ├── WiFi101_SD_OTA.ino │ └── arduino_secrets.h ├── keywords.txt ├── library.properties └── src ├── InternalStorage.cpp ├── InternalStorage.h ├── OTAStorage.h ├── SDStorage.cpp ├── SDStorage.h ├── SerialFlashStorage.cpp ├── SerialFlashStorage.h ├── WiFi101OTA.cpp └── WiFi101OTA.h /.codespellrc: -------------------------------------------------------------------------------- 1 | # See: https://github.com/codespell-project/codespell#using-a-config-file 2 | [codespell] 3 | # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: 4 | ignore-words-list = , 5 | check-filenames = 6 | check-hidden = 7 | skip = ./.git 8 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # See: https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#about-the-dependabotyml-file 2 | version: 2 3 | 4 | updates: 5 | # Configure check for outdated GitHub Actions actions in workflows. 6 | # See: https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-dependabot 7 | - package-ecosystem: github-actions 8 | directory: / # Check the repository's workflows under /.github/workflows/ 9 | schedule: 10 | interval: daily 11 | -------------------------------------------------------------------------------- /.github/workflows/check-arduino.yml: -------------------------------------------------------------------------------- 1 | name: Check Arduino 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | pull_request: 7 | schedule: 8 | # Run every Tuesday at 8 AM UTC to catch breakage caused by new rules added to Arduino Lint. 9 | - cron: "0 8 * * TUE" 10 | workflow_dispatch: 11 | repository_dispatch: 12 | 13 | jobs: 14 | lint: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout repository 19 | uses: actions/checkout@v4 20 | 21 | - name: Arduino Lint 22 | uses: arduino/arduino-lint-action@v2 23 | with: 24 | compliance: specification 25 | library-manager: update 26 | # Always use this setting for official repositories. Remove for 3rd party projects. 27 | official: true 28 | project-type: library 29 | -------------------------------------------------------------------------------- /.github/workflows/compile-examples.yml: -------------------------------------------------------------------------------- 1 | name: Compile Examples 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | paths: 7 | - ".github/workflows/compile-examples.yml" 8 | - "library.properties" 9 | - "examples/**" 10 | - "src/**" 11 | pull_request: 12 | paths: 13 | - ".github/workflows/compile-examples.yml" 14 | - "library.properties" 15 | - "examples/**" 16 | - "src/**" 17 | schedule: 18 | # Run every Tuesday at 8 AM UTC to catch breakage caused by changes to external resources (libraries, platforms). 19 | - cron: "0 8 * * TUE" 20 | workflow_dispatch: 21 | repository_dispatch: 22 | 23 | jobs: 24 | build: 25 | name: ${{ matrix.board.fqbn }} 26 | runs-on: ubuntu-latest 27 | 28 | env: 29 | SKETCHES_REPORTS_PATH: sketches-reports 30 | 31 | strategy: 32 | fail-fast: false 33 | 34 | matrix: 35 | board: 36 | - fqbn: arduino:samd:mkr1000 37 | platforms: | 38 | - name: arduino:samd 39 | artifact-name-suffix: arduino-samd-mkr1000 40 | 41 | steps: 42 | - name: Checkout repository 43 | uses: actions/checkout@v4 44 | 45 | - name: Compile examples 46 | uses: arduino/compile-sketches@v1 47 | with: 48 | github-token: ${{ secrets.GITHUB_TOKEN }} 49 | fqbn: ${{ matrix.board.fqbn }} 50 | platforms: ${{ matrix.board.platforms }} 51 | libraries: | 52 | # Install the library from the local path. 53 | - source-path: ./ 54 | # Install library dependencies. 55 | - name: SD 56 | - name: SerialFlash 57 | - name: WiFi101 58 | sketch-paths: | 59 | - examples 60 | enable-deltas-report: true 61 | sketches-report-path: ${{ env.SKETCHES_REPORTS_PATH }} 62 | 63 | - name: Save sketches report as workflow artifact 64 | uses: actions/upload-artifact@v4 65 | with: 66 | if-no-files-found: error 67 | path: ${{ env.SKETCHES_REPORTS_PATH }} 68 | name: sketches-report-${{ matrix.board.artifact-name-suffix }} 69 | -------------------------------------------------------------------------------- /.github/workflows/report-size-deltas.yml: -------------------------------------------------------------------------------- 1 | name: Report Size Deltas 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | paths: 7 | - ".github/workflows/report-size-deltas.yml" 8 | schedule: 9 | # Run at the minimum interval allowed by GitHub Actions. 10 | # Note: GitHub Actions periodically has outages which result in workflow failures. 11 | # In this event, the workflows will start passing again once the service recovers. 12 | - cron: "*/5 * * * *" 13 | workflow_dispatch: 14 | repository_dispatch: 15 | 16 | jobs: 17 | report: 18 | runs-on: ubuntu-latest 19 | steps: 20 | - name: Comment size deltas reports to PRs 21 | uses: arduino/report-size-deltas@v1 22 | with: 23 | # Regex matching the names of the workflow artifacts created by the "Compile Examples" workflow 24 | sketches-reports-source: ^sketches-report-.+ 25 | -------------------------------------------------------------------------------- /.github/workflows/spell-check.yml: -------------------------------------------------------------------------------- 1 | name: Spell Check 2 | 3 | # See: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows 4 | on: 5 | push: 6 | pull_request: 7 | schedule: 8 | # Run every Tuesday at 8 AM UTC to catch new misspelling detections resulting from dictionary updates. 9 | - cron: "0 8 * * TUE" 10 | workflow_dispatch: 11 | repository_dispatch: 12 | 13 | jobs: 14 | spellcheck: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout repository 19 | uses: actions/checkout@v4 20 | 21 | - name: Spell check 22 | uses: codespell-project/actions-codespell@master 23 | -------------------------------------------------------------------------------- /.github/workflows/sync-labels.yml: -------------------------------------------------------------------------------- 1 | # Source: https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/sync-labels.md 2 | name: Sync Labels 3 | 4 | # See: https://docs.github.com/en/actions/reference/events-that-trigger-workflows 5 | on: 6 | push: 7 | paths: 8 | - ".github/workflows/sync-labels.ya?ml" 9 | - ".github/label-configuration-files/*.ya?ml" 10 | pull_request: 11 | paths: 12 | - ".github/workflows/sync-labels.ya?ml" 13 | - ".github/label-configuration-files/*.ya?ml" 14 | schedule: 15 | # Run daily at 8 AM UTC to sync with changes to shared label configurations. 16 | - cron: "0 8 * * *" 17 | workflow_dispatch: 18 | repository_dispatch: 19 | 20 | env: 21 | CONFIGURATIONS_FOLDER: .github/label-configuration-files 22 | CONFIGURATIONS_ARTIFACT: label-configuration-files 23 | 24 | jobs: 25 | check: 26 | runs-on: ubuntu-latest 27 | 28 | steps: 29 | - name: Checkout repository 30 | uses: actions/checkout@v4 31 | 32 | - name: Download JSON schema for labels configuration file 33 | id: download-schema 34 | uses: carlosperate/download-file-action@v2 35 | with: 36 | file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/arduino-tooling-gh-label-configuration-schema.json 37 | location: ${{ runner.temp }}/label-configuration-schema 38 | 39 | - name: Install JSON schema validator 40 | run: | 41 | sudo npm install \ 42 | --global \ 43 | ajv-cli \ 44 | ajv-formats 45 | 46 | - name: Validate local labels configuration 47 | run: | 48 | # See: https://github.com/ajv-validator/ajv-cli#readme 49 | ajv validate \ 50 | --all-errors \ 51 | -c ajv-formats \ 52 | -s "${{ steps.download-schema.outputs.file-path }}" \ 53 | -d "${{ env.CONFIGURATIONS_FOLDER }}/*.{yml,yaml}" 54 | 55 | download: 56 | needs: check 57 | runs-on: ubuntu-latest 58 | 59 | strategy: 60 | matrix: 61 | filename: 62 | # Filenames of the shared configurations to apply to the repository in addition to the local configuration. 63 | # https://github.com/arduino/tooling-project-assets/blob/main/workflow-templates/assets/sync-labels 64 | - universal.yml 65 | 66 | steps: 67 | - name: Download 68 | uses: carlosperate/download-file-action@v2 69 | with: 70 | file-url: https://raw.githubusercontent.com/arduino/tooling-project-assets/main/workflow-templates/assets/sync-labels/${{ matrix.filename }} 71 | 72 | - name: Pass configuration files to next job via workflow artifact 73 | uses: actions/upload-artifact@v4 74 | with: 75 | path: | 76 | *.yaml 77 | *.yml 78 | if-no-files-found: error 79 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 80 | 81 | sync: 82 | needs: download 83 | runs-on: ubuntu-latest 84 | 85 | steps: 86 | - name: Set environment variables 87 | run: | 88 | # See: https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable 89 | echo "MERGED_CONFIGURATION_PATH=${{ runner.temp }}/labels.yml" >> "$GITHUB_ENV" 90 | 91 | - name: Determine whether to dry run 92 | id: dry-run 93 | if: > 94 | github.event_name == 'pull_request' || 95 | ( 96 | ( 97 | github.event_name == 'push' || 98 | github.event_name == 'workflow_dispatch' 99 | ) && 100 | github.ref != format('refs/heads/{0}', github.event.repository.default_branch) 101 | ) 102 | run: | 103 | # Use of this flag in the github-label-sync command will cause it to only check the validity of the 104 | # configuration. 105 | echo "::set-output name=flag::--dry-run" 106 | 107 | - name: Checkout repository 108 | uses: actions/checkout@v4 109 | 110 | - name: Download configuration files artifact 111 | uses: actions/download-artifact@v4 112 | with: 113 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 114 | path: ${{ env.CONFIGURATIONS_FOLDER }} 115 | 116 | - name: Remove unneeded artifact 117 | uses: geekyeggo/delete-artifact@v5 118 | with: 119 | name: ${{ env.CONFIGURATIONS_ARTIFACT }} 120 | 121 | - name: Merge label configuration files 122 | run: | 123 | # Merge all configuration files 124 | shopt -s extglob 125 | cat "${{ env.CONFIGURATIONS_FOLDER }}"/*.@(yml|yaml) > "${{ env.MERGED_CONFIGURATION_PATH }}" 126 | 127 | - name: Install github-label-sync 128 | run: sudo npm install --global github-label-sync 129 | 130 | - name: Sync labels 131 | env: 132 | GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }} 133 | run: | 134 | # See: https://github.com/Financial-Times/github-label-sync 135 | github-label-sync \ 136 | --labels "${{ env.MERGED_CONFIGURATION_PATH }}" \ 137 | ${{ steps.dry-run.outputs.flag }} \ 138 | ${{ github.repository }} 139 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | , 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | -------------------------------------------------------------------------------- /README.adoc: -------------------------------------------------------------------------------- 1 | :repository-owner: arduino-libraries 2 | :repository-name: WiFi101OTA 3 | 4 | = {repository-name} Library for Arduino = 5 | 6 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml/badge.svg["Check Arduino status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/check-arduino.yml"] 7 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"] 8 | image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] 9 | 10 | This library allows you to update sketches on your board over WiFi. 11 | It requires an Arduino SAMD board like the Zero or MKR1000. 12 | 13 | For more information about this library please visit us at 14 | https://www.arduino.cc/en/Reference/WiFi101OTA 15 | 16 | == License == 17 | 18 | Copyright (c) Arduino LLC. All right reserved. 19 | 20 | This library is free software; you can redistribute it and/or 21 | modify it under the terms of the GNU Lesser General Public 22 | License as published by the Free Software Foundation; either 23 | version 2.1 of the License, or (at your option) any later version. 24 | 25 | This library is distributed in the hope that it will be useful, 26 | but WITHOUT ANY WARRANTY; without even the implied warranty of 27 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 28 | Lesser General Public License for more details. 29 | 30 | You should have received a copy of the GNU Lesser General Public 31 | License along with this library; if not, write to the Free Software 32 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 33 | -------------------------------------------------------------------------------- /docs/api.md: -------------------------------------------------------------------------------- 1 | # WiFi101 OTA library 2 | 3 | ## Methods 4 | 5 | ### `WiFiOTA.begin()` 6 | 7 | #### Description 8 | 9 | Initializes the WiFi101 OTA library specifying board's network name, password and storage media 10 | 11 | #### Syntax 12 | 13 | ``` 14 | WiFiOTA.begin(name, password, storage); 15 | ``` 16 | 17 | #### Parameters 18 | 19 | **name:** the board's name to visualize in the network ports list 20 | 21 | **password:** the password to insert for the remote upload 22 | 23 | **storage:** the storage media to be used. Can be one between: 24 | 25 | - InternalStorage 26 | - SDStorage 27 | 28 | #### Example 29 | 30 | ``` 31 | #include 32 | #include 33 | #include 34 | 35 | char ssid[] = "yourNetwork"; // your network SSID (name) 36 | char pass[] = "secretPassword"; // your network password 37 | 38 | int status = WL_IDLE_STATUS; 39 | 40 | void setup() { 41 | //Initialize serial: 42 | Serial.begin(9600); 43 | 44 | // check for the presence of the shield: 45 | if (WiFi.status() == WL_NO_SHIELD) { 46 | Serial.println("WiFi shield not present"); 47 | // don't continue: 48 | while (true); 49 | } 50 | 51 | // attempt to connect to WiFi network: 52 | while ( status != WL_CONNECTED) { 53 | Serial.print("Attempting to connect to SSID: "); 54 | Serial.println(ssid); 55 | // Connect to WPA/WPA2 network. Change this line if using open or WEP network: 56 | status = WiFi.begin(ssid, pass); 57 | } 58 | 59 | // start the WiFi OTA library with internal (flash) based storage 60 | WiFiOTA.begin("Arduino", "password", InternalStorage); 61 | } 62 | 63 | void loop() { 64 | // check for WiFi OTA updates 65 | WiFiOTA.poll(); 66 | } 67 | ``` 68 | 69 | ### `WiFiOTA.poll()` 70 | 71 | #### Description 72 | 73 | Checks for WiFi OTA updates 74 | 75 | #### Syntax 76 | 77 | ``` 78 | WiFiOTA.poll(); 79 | ``` 80 | 81 | #### Parameters 82 | 83 | None 84 | 85 | #### Example 86 | 87 | ``` 88 | #include 89 | #include 90 | #include 91 | 92 | char ssid[] = "yourNetwork"; // your network SSID (name) 93 | char pass[] = "secretPassword"; // your network password 94 | 95 | int status = WL_IDLE_STATUS; 96 | 97 | void setup() { 98 | //Initialize serial: 99 | Serial.begin(9600); 100 | 101 | // check for the presence of the shield: 102 | if (WiFi.status() == WL_NO_SHIELD) { 103 | Serial.println("WiFi shield not present"); 104 | // don't continue: 105 | while (true); 106 | } 107 | 108 | // attempt to connect to WiFi network: 109 | while ( status != WL_CONNECTED) { 110 | Serial.print("Attempting to connect to SSID: "); 111 | Serial.println(ssid); 112 | // Connect to WPA/WPA2 network. Change this line if using open or WEP network: 113 | status = WiFi.begin(ssid, pass); 114 | } 115 | 116 | // start the WiFi OTA library with internal (flash) based storage 117 | WiFiOTA.begin("Arduino", "password", InternalStorage); 118 | } 119 | 120 | void loop() { 121 | // check for WiFi OTA updates 122 | WiFiOTA.poll(); 123 | } 124 | ``` -------------------------------------------------------------------------------- /docs/readme.md: -------------------------------------------------------------------------------- 1 | # WiFi101 OTA library 2 | 3 | This library allows you to have utilize OTA features [MKR1000](https://store-usa.arduino.cc/products/arduino-mkr1000-wifi) and the [WiFi Shield 101](https://docs.arduino.cc/retired/shields/arduino-wifi-shield-101). The sketch to be loaded Over The Air can be stored on two media: 4 | 5 | - the internal flash; 6 | - an external SD card; 7 | 8 | In the first case the new sketch can't exceed the half of the total memory (256/2 = 128kB) while in the second case you have all the MCU's flash available. 9 | 10 | To use this library 11 | 12 | ``` 13 | #include 14 | #include 15 | #include 16 | #include 17 | #include 18 | ``` -------------------------------------------------------------------------------- /examples/WiFi101_OTA/WiFi101_OTA.ino: -------------------------------------------------------------------------------- 1 | /* 2 | 3 | This example connects to an WPA encrypted WiFi network. 4 | Then it prints the MAC address of the WiFi shield, 5 | the IP address obtained, and other network details. 6 | It then polls for sketch updates over WiFi. Sketches 7 | can be updated by selecting a network port from within 8 | the Arduino IDE: Tools -> Port -> Network Ports ... 9 | 10 | Circuit: 11 | * WiFi shield attached 12 | 13 | created 13 July 2010 14 | by dlf (Metodo2 srl) 15 | modified 31 May 2012 16 | by Tom Igoe 17 | modified 16 January 2017 18 | by Sandeep Mistry 19 | */ 20 | 21 | #include 22 | #include 23 | #include 24 | 25 | #include "arduino_secrets.h" 26 | ///////please enter your sensitive data in the Secret tab/arduino_secrets.h 27 | /////// WiFi Settings /////// 28 | char ssid[] = SECRET_SSID; // your network SSID (name) 29 | char pass[] = SECRET_PASS; // your network password 30 | 31 | int status = WL_IDLE_STATUS; 32 | 33 | void setup() { 34 | //Initialize serial: 35 | Serial.begin(9600); 36 | 37 | // check for the presence of the shield: 38 | if (WiFi.status() == WL_NO_SHIELD) { 39 | Serial.println("WiFi shield not present"); 40 | // don't continue: 41 | while (true); 42 | } 43 | 44 | // attempt to connect to WiFi network: 45 | while ( status != WL_CONNECTED) { 46 | Serial.print("Attempting to connect to SSID: "); 47 | Serial.println(ssid); 48 | // Connect to WPA/WPA2 network. Change this line if using open or WEP network: 49 | status = WiFi.begin(ssid, pass); 50 | } 51 | 52 | // start the WiFi OTA library with internal (flash) based storage 53 | WiFiOTA.begin("Arduino", "password", InternalStorage); 54 | 55 | // you're connected now, so print out the status: 56 | printWifiStatus(); 57 | } 58 | 59 | void loop() { 60 | // check for WiFi OTA updates 61 | WiFiOTA.poll(); 62 | 63 | // add your normal loop code below ... 64 | } 65 | 66 | void printWifiStatus() { 67 | // print the SSID of the network you're attached to: 68 | Serial.print("SSID: "); 69 | Serial.println(WiFi.SSID()); 70 | 71 | // print your WiFi shield's IP address: 72 | IPAddress ip = WiFi.localIP(); 73 | Serial.print("IP Address: "); 74 | Serial.println(ip); 75 | 76 | // print the received signal strength: 77 | long rssi = WiFi.RSSI(); 78 | Serial.print("signal strength (RSSI):"); 79 | Serial.print(rssi); 80 | Serial.println(" dBm"); 81 | } 82 | -------------------------------------------------------------------------------- /examples/WiFi101_OTA/arduino_secrets.h: -------------------------------------------------------------------------------- 1 | #define SECRET_SSID "" 2 | #define SECRET_PASS "" 3 | 4 | -------------------------------------------------------------------------------- /examples/WiFi101_SD_OTA/WiFi101_SD_OTA.ino: -------------------------------------------------------------------------------- 1 | /* 2 | 3 | This example connects to an WPA encrypted WiFi network. 4 | Then it prints the MAC address of the WiFi shield, 5 | the IP address obtained, and other network details. 6 | It then polls for sketch updates over WiFi. Sketches 7 | can be updated by selecting a network port from within 8 | the Arduino IDE: Tools -> Port -> Network Ports ... 9 | 10 | Circuit: 11 | * WiFi shield attached 12 | * SD shield attached 13 | 14 | created 13 July 2010 15 | by dlf (Metodo2 srl) 16 | modified 31 May 2012 17 | by Tom Igoe 18 | modified 16 January 2017 19 | by Sandeep Mistry 20 | */ 21 | 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | 28 | #include "arduino_secrets.h" 29 | ///////please enter your sensitive data in the Secret tab/arduino_secrets.h 30 | /////// WiFi Settings /////// 31 | char ssid[] = SECRET_SSID; // your network SSID (name) 32 | char pass[] = SECRET_PASS; // your network password 33 | 34 | int status = WL_IDLE_STATUS; 35 | 36 | void setup() { 37 | //Initialize serial: 38 | Serial.begin(9600); 39 | 40 | // setup SD card 41 | Serial.print("Initializing SD card..."); 42 | if (!SD.begin(SDCARD_SS_PIN)) { 43 | Serial.println("initialization failed!"); 44 | // don't continue: 45 | while (true); 46 | } 47 | Serial.println("initialization done."); 48 | 49 | // check for the presence of the shield: 50 | if (WiFi.status() == WL_NO_SHIELD) { 51 | Serial.println("WiFi shield not present"); 52 | // don't continue: 53 | while (true); 54 | } 55 | 56 | // attempt to connect to WiFi network: 57 | while ( status != WL_CONNECTED) { 58 | Serial.print("Attempting to connect to SSID: "); 59 | Serial.println(ssid); 60 | // Connect to WPA/WPA2 network. Change this line if using open or WEP network: 61 | status = WiFi.begin(ssid, pass); 62 | } 63 | 64 | // start the WiFi OTA library with SD based storage 65 | WiFiOTA.begin("Arduino", "password", SDStorage); 66 | 67 | // you're connected now, so print out the status: 68 | printWifiStatus(); 69 | } 70 | 71 | void loop() { 72 | // check for WiFi OTA updates 73 | WiFiOTA.poll(); 74 | 75 | // add your normal loop code below ... 76 | } 77 | 78 | void printWifiStatus() { 79 | // print the SSID of the network you're attached to: 80 | Serial.print("SSID: "); 81 | Serial.println(WiFi.SSID()); 82 | 83 | // print your WiFi shield's IP address: 84 | IPAddress ip = WiFi.localIP(); 85 | Serial.print("IP Address: "); 86 | Serial.println(ip); 87 | 88 | // print the received signal strength: 89 | long rssi = WiFi.RSSI(); 90 | Serial.print("signal strength (RSSI):"); 91 | Serial.print(rssi); 92 | Serial.println(" dBm"); 93 | } 94 | -------------------------------------------------------------------------------- /examples/WiFi101_SD_OTA/arduino_secrets.h: -------------------------------------------------------------------------------- 1 | #define SECRET_SSID "" 2 | #define SECRET_PASS "" 3 | 4 | -------------------------------------------------------------------------------- /keywords.txt: -------------------------------------------------------------------------------- 1 | ####################################### 2 | # Syntax Coloring Map For WiFi101OTA 3 | ####################################### 4 | 5 | ####################################### 6 | # Datatypes (KEYWORD1) 7 | ####################################### 8 | 9 | WiFi101OTA KEYWORD1 10 | WiFiOTA KEYWORD1 11 | 12 | InternalStorage KEYWORD1 13 | SDStorage KEYWORD1 14 | 15 | ####################################### 16 | # Methods and Functions (KEYWORD2) 17 | ####################################### 18 | 19 | begin KEYWORD2 20 | poll KEYWORD2 21 | 22 | ####################################### 23 | # Constants (LITERAL1) 24 | ####################################### 25 | -------------------------------------------------------------------------------- /library.properties: -------------------------------------------------------------------------------- 1 | name=WiFi101OTA 2 | version=1.1.0 3 | author=Arduino 4 | maintainer=Arduino 5 | sentence=Update sketches on your board over WiFi 6 | paragraph=Requires an Arduino SAMD board 7 | category=Other 8 | url=http://www.arduino.cc/en/Reference/WiFi101OTA 9 | architectures=samd 10 | depends=SerialFlash, WiFi101 11 | -------------------------------------------------------------------------------- /src/InternalStorage.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Arduino LLC. All right reserved. 3 | 4 | This library is free software; you can redistribute it and/or 5 | modify it under the terms of the GNU Lesser General Public 6 | License as published by the Free Software Foundation; either 7 | version 2.1 of the License, or (at your option) any later version. 8 | 9 | This library is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 12 | See the GNU Lesser General Public License for more details. 13 | 14 | You should have received a copy of the GNU Lesser General Public 15 | License along with this library; if not, write to the Free Software 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 | */ 18 | 19 | #include 20 | 21 | #include "InternalStorage.h" 22 | 23 | #define PAGE_SIZE (64) 24 | #define PAGES (4096) 25 | #define MAX_FLASH (PAGE_SIZE * PAGES) 26 | #define ROW_SIZE (PAGE_SIZE * 4) 27 | 28 | #define SKETCH_START_ADDRESS (0x2000) 29 | #define MAX_PARTIONED_SKETCH_SIZE ((MAX_FLASH - SKETCH_START_ADDRESS) / 2) 30 | #define STORAGE_START_ADDRESS (SKETCH_START_ADDRESS + MAX_PARTIONED_SKETCH_SIZE) 31 | 32 | extern "C" { 33 | // these functions must be in RAM (.data) and NOT inlined 34 | // as they erase and copy the sketch data in flash 35 | 36 | __attribute__ ((long_call, noinline, section (".data#"))) 37 | static void eraseFlash(int address, int length) 38 | { 39 | for (int i = 0; i < length; i += ROW_SIZE) { 40 | NVMCTRL->ADDR.reg = ((uint32_t)(address + i)) / 2; 41 | NVMCTRL->CTRLA.reg = NVMCTRL_CTRLA_CMDEX_KEY | NVMCTRL_CTRLA_CMD_ER; 42 | 43 | while (!NVMCTRL->INTFLAG.bit.READY); 44 | } 45 | } 46 | 47 | __attribute__ ((long_call, noinline, section (".data#"))) 48 | static void copyFlashAndReset(int dest, int src, int length) 49 | { 50 | uint32_t* d = (uint32_t*)dest; 51 | uint32_t* s = (uint32_t*)src; 52 | 53 | eraseFlash(dest, length); 54 | 55 | for (int i = 0; i < length; i += 4) { 56 | *d++ = *s++; 57 | 58 | while (!NVMCTRL->INTFLAG.bit.READY); 59 | } 60 | 61 | NVIC_SystemReset(); 62 | } 63 | } 64 | 65 | int InternalStorageClass::open(int length) 66 | { 67 | (void)length; 68 | _writeIndex = 0; 69 | _writeAddress = (uint32_t*)STORAGE_START_ADDRESS; 70 | 71 | // enable auto page writes 72 | NVMCTRL->CTRLB.bit.MANW = 0; 73 | 74 | eraseFlash(STORAGE_START_ADDRESS, MAX_PARTIONED_SKETCH_SIZE); 75 | 76 | return 1; 77 | } 78 | 79 | size_t InternalStorageClass::write(uint8_t b) 80 | { 81 | _addressData.u8[_writeIndex] = b; 82 | _writeIndex++; 83 | 84 | if (_writeIndex == 4) { 85 | _writeIndex = 0; 86 | 87 | *_writeAddress = _addressData.u32; 88 | 89 | _writeAddress++; 90 | 91 | while (!NVMCTRL->INTFLAG.bit.READY); 92 | } 93 | 94 | return 1; 95 | } 96 | 97 | void InternalStorageClass::close() 98 | { 99 | while ((int)_writeAddress % PAGE_SIZE) { 100 | write(0xff); 101 | } 102 | } 103 | 104 | void InternalStorageClass::clear() 105 | { 106 | } 107 | 108 | void InternalStorageClass::apply() 109 | { 110 | // disable interrupts, as vector table will be erased during flash sequence 111 | noInterrupts(); 112 | 113 | copyFlashAndReset(SKETCH_START_ADDRESS, STORAGE_START_ADDRESS, MAX_PARTIONED_SKETCH_SIZE); 114 | } 115 | 116 | long InternalStorageClass::maxSize() 117 | { 118 | return MAX_PARTIONED_SKETCH_SIZE; 119 | } 120 | 121 | InternalStorageClass InternalStorage; 122 | -------------------------------------------------------------------------------- /src/InternalStorage.h: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Arduino LLC. All right reserved. 3 | 4 | This library is free software; you can redistribute it and/or 5 | modify it under the terms of the GNU Lesser General Public 6 | License as published by the Free Software Foundation; either 7 | version 2.1 of the License, or (at your option) any later version. 8 | 9 | This library is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 12 | See the GNU Lesser General Public License for more details. 13 | 14 | You should have received a copy of the GNU Lesser General Public 15 | License along with this library; if not, write to the Free Software 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 | */ 18 | 19 | #ifndef _INTERNAL_STORAGE_H_INCLUDED 20 | #define _INTERNAL_STORAGE_H_INCLUDED 21 | 22 | #include "OTAStorage.h" 23 | 24 | class InternalStorageClass : public OTAStorage { 25 | public: 26 | virtual int open(int length); 27 | virtual size_t write(uint8_t); 28 | virtual void close(); 29 | virtual void clear(); 30 | virtual void apply(); 31 | virtual long maxSize(); 32 | 33 | private: 34 | union { 35 | uint32_t u32; 36 | uint8_t u8[4]; 37 | } _addressData; 38 | 39 | int _writeIndex; 40 | uint32_t* _writeAddress; 41 | }; 42 | 43 | extern InternalStorageClass InternalStorage; 44 | 45 | #endif 46 | -------------------------------------------------------------------------------- /src/OTAStorage.h: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Arduino LLC. All right reserved. 3 | 4 | This library is free software; you can redistribute it and/or 5 | modify it under the terms of the GNU Lesser General Public 6 | License as published by the Free Software Foundation; either 7 | version 2.1 of the License, or (at your option) any later version. 8 | 9 | This library is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 12 | See the GNU Lesser General Public License for more details. 13 | 14 | You should have received a copy of the GNU Lesser General Public 15 | License along with this library; if not, write to the Free Software 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 | */ 18 | 19 | #ifndef _OTA_STORAGE_H_INCLUDED 20 | #define _OTA_STORAGE_H_INCLUDED 21 | 22 | class OTAStorage { 23 | public: 24 | virtual int open(int length) = 0; 25 | virtual size_t write(uint8_t) = 0; 26 | virtual void close() = 0; 27 | virtual void clear() = 0; 28 | virtual void apply() = 0; 29 | 30 | virtual long maxSize() { 31 | return ((256 * 1024) - 0x2000); 32 | } 33 | }; 34 | 35 | #endif 36 | -------------------------------------------------------------------------------- /src/SDStorage.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Arduino LLC. All right reserved. 3 | 4 | This library is free software; you can redistribute it and/or 5 | modify it under the terms of the GNU Lesser General Public 6 | License as published by the Free Software Foundation; either 7 | version 2.1 of the License, or (at your option) any later version. 8 | 9 | This library is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 12 | See the GNU Lesser General Public License for more details. 13 | 14 | You should have received a copy of the GNU Lesser General Public 15 | License along with this library; if not, write to the Free Software 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 | */ 18 | 19 | #include "SDStorage.h" 20 | 21 | #define UPDATE_FILE "UPDATE.BIN" 22 | 23 | int SDStorageClass::open(int length) 24 | { 25 | (void)length; 26 | _file = SD.open(UPDATE_FILE, FILE_WRITE); 27 | 28 | if (!_file) { 29 | return 0; 30 | } 31 | 32 | return 1; 33 | } 34 | 35 | size_t SDStorageClass::write(uint8_t b) 36 | { 37 | return _file.write(b); 38 | } 39 | 40 | void SDStorageClass::close() 41 | { 42 | _file.close(); 43 | } 44 | 45 | void SDStorageClass::clear() 46 | { 47 | SD.remove(UPDATE_FILE); 48 | } 49 | 50 | void SDStorageClass::apply() 51 | { 52 | // just reset, SDU copies the data to flash 53 | NVIC_SystemReset(); 54 | } 55 | 56 | SDStorageClass SDStorage; 57 | -------------------------------------------------------------------------------- /src/SDStorage.h: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Arduino LLC. All right reserved. 3 | 4 | This library is free software; you can redistribute it and/or 5 | modify it under the terms of the GNU Lesser General Public 6 | License as published by the Free Software Foundation; either 7 | version 2.1 of the License, or (at your option) any later version. 8 | 9 | This library is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 12 | See the GNU Lesser General Public License for more details. 13 | 14 | You should have received a copy of the GNU Lesser General Public 15 | License along with this library; if not, write to the Free Software 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 | */ 18 | 19 | #ifndef _SD_STORAGE_H_INCLUDED 20 | #define _SD_STORAGE_H_INCLUDED 21 | 22 | #include 23 | 24 | #include "OTAStorage.h" 25 | 26 | #ifndef SDCARD_SS_PIN 27 | #define SDCARD_SS_PIN 4 28 | #endif 29 | 30 | class SDStorageClass : public OTAStorage { 31 | public: 32 | virtual int open(int length); 33 | virtual size_t write(uint8_t); 34 | virtual void close(); 35 | virtual void clear(); 36 | virtual void apply(); 37 | 38 | private: 39 | File _file; 40 | }; 41 | 42 | extern SDStorageClass SDStorage; 43 | 44 | #endif 45 | -------------------------------------------------------------------------------- /src/SerialFlashStorage.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Arduino LLC. All right reserved. 3 | 4 | This library is free software; you can redistribute it and/or 5 | modify it under the terms of the GNU Lesser General Public 6 | License as published by the Free Software Foundation; either 7 | version 2.1 of the License, or (at your option) any later version. 8 | 9 | This library is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 12 | See the GNU Lesser General Public License for more details. 13 | 14 | You should have received a copy of the GNU Lesser General Public 15 | License along with this library; if not, write to the Free Software 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 | */ 18 | 19 | #include "SerialFlashStorage.h" 20 | 21 | #define UPDATE_FILE "UPDATE.BIN" 22 | 23 | int SerialFlashStorageClass::open(int contentLength) 24 | { 25 | if (!SerialFlash.begin(SERIAL_FLASH_CS)) { 26 | return 0; 27 | } 28 | 29 | while (!SerialFlash.ready()) {} 30 | 31 | if (SerialFlash.exists(UPDATE_FILE)) { 32 | SerialFlash.remove(UPDATE_FILE); 33 | } 34 | 35 | if (SerialFlash.create(UPDATE_FILE, contentLength)) { 36 | _file = SerialFlash.open(UPDATE_FILE); 37 | } 38 | 39 | if (!_file) { 40 | return 0; 41 | } 42 | 43 | return 1; 44 | } 45 | 46 | size_t SerialFlashStorageClass::write(uint8_t b) 47 | { 48 | while (!SerialFlash.ready()) {} 49 | int ret = _file.write(&b, 1); 50 | return ret; 51 | } 52 | 53 | void SerialFlashStorageClass::close() 54 | { 55 | _file.close(); 56 | } 57 | 58 | void SerialFlashStorageClass::clear() 59 | { 60 | SerialFlash.remove(UPDATE_FILE); 61 | } 62 | 63 | void SerialFlashStorageClass::apply() 64 | { 65 | // just reset, SDU copies the data to flash 66 | NVIC_SystemReset(); 67 | } 68 | 69 | SerialFlashStorageClass SerialFlashStorage; 70 | -------------------------------------------------------------------------------- /src/SerialFlashStorage.h: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Arduino LLC. All right reserved. 3 | 4 | This library is free software; you can redistribute it and/or 5 | modify it under the terms of the GNU Lesser General Public 6 | License as published by the Free Software Foundation; either 7 | version 2.1 of the License, or (at your option) any later version. 8 | 9 | This library is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 12 | See the GNU Lesser General Public License for more details. 13 | 14 | You should have received a copy of the GNU Lesser General Public 15 | License along with this library; if not, write to the Free Software 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 | */ 18 | 19 | #ifndef _SERIALFLASH_STORAGE_H_INCLUDED 20 | #define _SERIALFLASH_STORAGE_H_INCLUDED 21 | 22 | #include 23 | 24 | #include "OTAStorage.h" 25 | 26 | #define SERIAL_FLASH_BUFFER_SIZE 64 27 | #define SERIAL_FLASH_CS 5 28 | 29 | class SerialFlashStorageClass : public OTAStorage { 30 | public: 31 | virtual int open(int length); 32 | virtual size_t write(uint8_t); 33 | virtual void close(); 34 | virtual void clear(); 35 | virtual void apply(); 36 | 37 | private: 38 | SerialFlashFile _file; 39 | }; 40 | 41 | extern SerialFlashStorageClass SerialFlashStorage; 42 | 43 | #endif 44 | -------------------------------------------------------------------------------- /src/WiFi101OTA.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Arduino LLC. All right reserved. 3 | 4 | This library is free software; you can redistribute it and/or 5 | modify it under the terms of the GNU Lesser General Public 6 | License as published by the Free Software Foundation; either 7 | version 2.1 of the License, or (at your option) any later version. 8 | 9 | This library is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 12 | See the GNU Lesser General Public License for more details. 13 | 14 | You should have received a copy of the GNU Lesser General Public 15 | License along with this library; if not, write to the Free Software 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 | */ 18 | 19 | #include 20 | 21 | #include "WiFi101OTA.h" 22 | 23 | #if defined(ARDUINO_SAMD_ZERO) 24 | #define BOARD "arduino_zero_edbg" 25 | #elif defined(ARDUINO_SAMD_MKR1000) 26 | #define BOARD "mkr1000" 27 | #elif defined(ARDUINO_SAMD_MKRZERO) 28 | #define BOARD "mkrzero" 29 | #else 30 | #error "Unsupported board!" 31 | #endif 32 | 33 | #define BOARD_LENGTH (sizeof(BOARD) - 1) 34 | 35 | static String base64Encode(const String& in) 36 | { 37 | static const char* CODES = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/="; 38 | 39 | int b; 40 | String out; 41 | out.reserve((in.length()) * 4 / 3); 42 | 43 | for (unsigned int i = 0; i < in.length(); i += 3) { 44 | b = (in.charAt(i) & 0xFC) >> 2; 45 | out += CODES[b]; 46 | 47 | b = (in.charAt(i) & 0x03) << 4; 48 | if (i + 1 < in.length()) { 49 | b |= (in.charAt(i + 1) & 0xF0) >> 4; 50 | out += CODES[b]; 51 | b = (in.charAt(i + 1) & 0x0F) << 2; 52 | if (i + 2 < in.length()) { 53 | b |= (in.charAt(i + 2) & 0xC0) >> 6; 54 | out += CODES[b]; 55 | b = in.charAt(i + 2) & 0x3F; 56 | out += CODES[b]; 57 | } else { 58 | out += CODES[b]; 59 | out += '='; 60 | } 61 | } else { 62 | out += CODES[b]; 63 | out += "=="; 64 | } 65 | } 66 | 67 | return out; 68 | } 69 | 70 | WiFiOTAClass::WiFiOTAClass() : 71 | _storage(NULL), 72 | _server(65280), 73 | _lastMdnsResponseTime(0) 74 | { 75 | } 76 | 77 | void WiFiOTAClass::begin(const char* name, const char* password, OTAStorage& storage) 78 | { 79 | _name = name; 80 | _expectedAuthorization = "Basic " + base64Encode("arduino:" + String(password)); 81 | _storage = &storage; 82 | 83 | _server.begin(); 84 | 85 | _mdnsSocket.beginMulti(IPAddress(224, 0, 0, 251), 5353); 86 | } 87 | 88 | void WiFiOTAClass::poll() 89 | { 90 | pollMdns(); 91 | pollServer(); 92 | } 93 | 94 | void WiFiOTAClass::pollMdns() 95 | { 96 | int packetLength = _mdnsSocket.parsePacket(); 97 | 98 | if (packetLength <= 0) { 99 | return; 100 | } 101 | 102 | const byte ARDUINO_SERVICE_REQUEST[37] = { 103 | 0x00, 0x00, // transaction id 104 | 0x00, 0x00, // flags 105 | 0x00, 0x01, // questions 106 | 0x00, 0x00, // answer RRs 107 | 0x00, 0x00, // authority RRs 108 | 0x00, 0x00, // additional RRs 109 | 0x08, 110 | 0x5f, 0x61, 0x72, 0x64, 0x75, 0x69, 0x6e, 0x6f, // _arduino 111 | 0x04, 112 | 0x5f, 0x74, 0x63, 0x70, // _tcp 113 | 0x05, 114 | 0x6c, 0x6f, 0x63, 0x61, 0x6c, 0x00, // local 115 | 0x00, 0x0c, // PTR 116 | 0x00, 0x01 // Class IN 117 | }; 118 | 119 | if (packetLength != sizeof(ARDUINO_SERVICE_REQUEST)) { 120 | while (packetLength) { 121 | if (_mdnsSocket.available()) { 122 | packetLength--; 123 | _mdnsSocket.read(); 124 | } 125 | } 126 | return; 127 | } 128 | 129 | byte request[packetLength]; 130 | 131 | _mdnsSocket.read(request, sizeof(request)); 132 | 133 | if (memcmp(&request[2], &ARDUINO_SERVICE_REQUEST[2], packetLength - 2) != 0) { 134 | return; 135 | } 136 | 137 | if ((millis() - _lastMdnsResponseTime) < 1000) { 138 | // ignore request 139 | return; 140 | } 141 | _lastMdnsResponseTime = millis(); 142 | 143 | _mdnsSocket.beginPacket(IPAddress(224, 0, 0, 251), 5353); 144 | 145 | const byte responseHeader[] = { 146 | 0x00, 0x00, // transaction id 147 | 0x84, 0x00, // flags 148 | 0x00, 0x00, // questions 149 | 0x00, 0x04, // answers RRs 150 | 0x00, 0x00, // authority RRs 151 | 0x00, 0x00 // additional RRS 152 | }; 153 | _mdnsSocket.write(responseHeader, sizeof(responseHeader)); 154 | 155 | const byte ptrRecordStart[] = { 156 | 0x08, 157 | '_', 'a', 'r', 'd', 'u', 'i', 'n', 'o', 158 | 159 | 0x04, 160 | '_', 't', 'c', 'p', 161 | 162 | 0x05, 163 | 'l', 'o', 'c', 'a', 'l', 164 | 0x00, 165 | 166 | 0x00, 0x0c, // PTR 167 | 0x00, 0x01, // class IN 168 | 0x00, 0x00, 0x11, 0x94, // TTL 169 | 170 | 0x00, (byte)(_name.length() + 3), // length 171 | (byte)_name.length() 172 | }; 173 | 174 | const byte ptrRecordEnd[] = { 175 | 0xc0, 0x0c 176 | }; 177 | 178 | _mdnsSocket.write(ptrRecordStart, sizeof(ptrRecordStart)); 179 | _mdnsSocket.write(_name.c_str(), _name.length()); 180 | _mdnsSocket.write(ptrRecordEnd, sizeof(ptrRecordEnd)); 181 | 182 | const byte txtRecord[] = { 183 | 0xc0, 0x2b, 184 | 0x00, 0x10, // TXT strings 185 | 0x80, 0x01, // class 186 | 0x00, 0x00, 0x11, 0x94, // TTL 187 | 0x00, (50 + BOARD_LENGTH), 188 | 13, 189 | 's', 's', 'h', '_', 'u', 'p', 'l', 'o', 'a', 'd', '=', 'n', 'o', 190 | 12, 191 | 't', 'c', 'p', '_', 'c', 'h', 'e', 'c', 'k', '=', 'n', 'o', 192 | 15, 193 | 'a', 'u', 't', 'h', '_', 'u', 'p', 'l', 'o', 'a', 'd', '=', 'y', 'e', 's', 194 | (6 + BOARD_LENGTH), 195 | 'b', 'o', 'a', 'r', 'd', '=', 196 | }; 197 | _mdnsSocket.write(txtRecord, sizeof(txtRecord)); 198 | _mdnsSocket.write((byte*)BOARD, BOARD_LENGTH); 199 | 200 | const byte srvRecordStart[] = { 201 | 0xc0, 0x2b, 202 | 0x00, 0x21, // SRV 203 | 0x80, 0x01, // class 204 | 0x00, 0x00, 0x00, 0x78, // TTL 205 | 0x00, (byte)(_name.length() + 9), // length 206 | 0x00, 0x00, 207 | 0x00, 0x00, 208 | 0xff, 0x00, // port 209 | (byte)_name.length() 210 | }; 211 | 212 | const byte srvRecordEnd[] = { 213 | 0xc0, 0x1a 214 | }; 215 | 216 | _mdnsSocket.write(srvRecordStart, sizeof(srvRecordStart)); 217 | _mdnsSocket.write(_name.c_str(), _name.length()); 218 | _mdnsSocket.write(srvRecordEnd, sizeof(srvRecordEnd)); 219 | 220 | uint32_t localIp = WiFi.localIP(); 221 | 222 | byte aRecordNameOffset = sizeof(responseHeader) + 223 | sizeof(ptrRecordStart) + _name.length() + sizeof(ptrRecordEnd) + 224 | sizeof(txtRecord) + BOARD_LENGTH + 225 | sizeof(srvRecordStart) - 1; 226 | 227 | byte aRecord[] = { 228 | 0xc0, aRecordNameOffset, 229 | 230 | 0x00, 0x01, // A record 231 | 0x80, 0x01, // class 232 | 0x00, 0x00, 0x00, 0x78, // TTL 233 | 0x00, 0x04, 234 | 0xff, 0xff, 0xff, 0xff // IP 235 | }; 236 | memcpy(&aRecord[sizeof(aRecord) - 4], &localIp, sizeof(localIp)); 237 | _mdnsSocket.write(aRecord, sizeof(aRecord)); 238 | 239 | _mdnsSocket.endPacket(); 240 | } 241 | 242 | void WiFiOTAClass::pollServer() 243 | { 244 | WiFiClient client = _server.available(); 245 | 246 | if (client) { 247 | String request = client.readStringUntil('\n'); 248 | request.trim(); 249 | 250 | String header; 251 | long contentLength = -1; 252 | String authorization; 253 | 254 | do { 255 | header = client.readStringUntil('\n'); 256 | header.trim(); 257 | 258 | if (header.startsWith("Content-Length: ")) { 259 | header.remove(0, 16); 260 | 261 | contentLength = header.toInt(); 262 | } else if (header.startsWith("Authorization: ")) { 263 | header.remove(0, 15); 264 | 265 | authorization = header; 266 | } 267 | } while (header != ""); 268 | 269 | if (request != "POST /sketch HTTP/1.1") { 270 | flushRequestBody(client, contentLength); 271 | sendHttpResponse(client, 404, "Not Found"); 272 | return; 273 | } 274 | 275 | if (_expectedAuthorization != authorization) { 276 | flushRequestBody(client, contentLength); 277 | sendHttpResponse(client, 401, "Unauthorized"); 278 | return; 279 | } 280 | 281 | if (contentLength <= 0) { 282 | sendHttpResponse(client, 400, "Bad Request"); 283 | return; 284 | } 285 | 286 | if (_storage == NULL || !_storage->open(contentLength)) { 287 | flushRequestBody(client, contentLength); 288 | sendHttpResponse(client, 500, "Internal Server Error"); 289 | return; 290 | } 291 | 292 | if (contentLength > _storage->maxSize()) { 293 | _storage->close(); 294 | flushRequestBody(client, contentLength); 295 | sendHttpResponse(client, 413, "Payload Too Large"); 296 | return; 297 | } 298 | 299 | long read = 0; 300 | 301 | while (client.connected() && read < contentLength) { 302 | while (client.available()) { 303 | read++; 304 | 305 | _storage->write((char)client.read()); 306 | } 307 | } 308 | 309 | _storage->close(); 310 | 311 | if (read == contentLength) { 312 | sendHttpResponse(client, 200, "OK"); 313 | 314 | delay(500); 315 | 316 | // apply the update 317 | _storage->apply(); 318 | 319 | while (true); 320 | } else { 321 | 322 | sendHttpResponse(client, 414, "Payload size wrong"); 323 | _storage->clear(); 324 | 325 | delay(500); 326 | 327 | client.stop(); 328 | } 329 | } 330 | } 331 | 332 | void WiFiOTAClass::sendHttpResponse(Client& client, int code, const char* status) 333 | { 334 | while (client.available()) { 335 | client.read(); 336 | } 337 | 338 | client.print("HTTP/1.1 "); 339 | client.print(code); 340 | client.print(" "); 341 | client.println(status); 342 | client.println("Connection: close"); 343 | client.println(); 344 | client.stop(); 345 | } 346 | 347 | void WiFiOTAClass::flushRequestBody(Client& client, long contentLength) 348 | { 349 | long read = 0; 350 | 351 | while (client.connected() && read < contentLength) { 352 | if (client.available()) { 353 | read++; 354 | 355 | client.read(); 356 | } 357 | } 358 | } 359 | 360 | WiFiOTAClass WiFiOTA; 361 | -------------------------------------------------------------------------------- /src/WiFi101OTA.h: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright (c) 2017 Arduino LLC. All right reserved. 3 | 4 | This library is free software; you can redistribute it and/or 5 | modify it under the terms of the GNU Lesser General Public 6 | License as published by the Free Software Foundation; either 7 | version 2.1 of the License, or (at your option) any later version. 8 | 9 | This library is distributed in the hope that it will be useful, 10 | but WITHOUT ANY WARRANTY; without even the implied warranty of 11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 12 | See the GNU Lesser General Public License for more details. 13 | 14 | You should have received a copy of the GNU Lesser General Public 15 | License along with this library; if not, write to the Free Software 16 | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 17 | */ 18 | 19 | #ifndef _WIFI101_OTA_H_INCLUDED 20 | #define _WIFI101_OTA_H_INCLUDED 21 | 22 | #include 23 | 24 | #include "WiFi101.h" 25 | #include "WiFiUdp.h" 26 | 27 | #include "OTAStorage.h" 28 | #include "SDStorage.h" 29 | #include "InternalStorage.h" 30 | #include "SerialFlashStorage.h" 31 | 32 | class WiFiOTAClass { 33 | public: 34 | WiFiOTAClass(); 35 | 36 | void begin(const char* name, const char* password, OTAStorage& storage); 37 | void poll(); 38 | 39 | private: 40 | void pollMdns(); 41 | void pollServer(); 42 | void sendHttpResponse(Client& client, int code, const char* status); 43 | void flushRequestBody(Client& client, long contentLength); 44 | 45 | private: 46 | String _name; 47 | String _expectedAuthorization; 48 | OTAStorage* _storage; 49 | WiFiServer _server; 50 | WiFiUDP _mdnsSocket; 51 | 52 | uint32_t _lastMdnsResponseTime; 53 | }; 54 | 55 | extern WiFiOTAClass WiFiOTA; 56 | 57 | #endif 58 | --------------------------------------------------------------------------------