├── CODE_OF_CONDUCT.md ├── LICENSE ├── Photos ├── Serial-Console.jpg ├── lutron-light-bulbs-changers-adapters-lzl-4b-wh-l01-64_1000.jpg ├── lutron-light-bulbs-changers-adapters-lzl-4b-wh-l01-c3_1000.jpg └── pycharm-screen.png ├── README.md ├── images ├── add-things.png ├── dimmable-color-light.png ├── empty-things-screen.png ├── get-property.png ├── get-thing.png ├── jwt.png ├── login.png ├── open-websocket.png ├── postman.png ├── request-action.png ├── set-property.png ├── virtual-things.png └── wot_gw.png └── tools ├── dd-from-sdcard.sh ├── dd-to-sdcard.sh ├── mount-img.sh ├── mount-img2.sh ├── umount-img.sh └── umount-img2.sh /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Community Participation Guidelines 2 | 3 | This repository is governed by Mozilla's code of conduct and etiquette guidelines. 4 | For more details, please read the 5 | [Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/). 6 | 7 | ## How to Report 8 | For more information on how to report violations of the Community Participation Guidelines, please read our '[How to Report](https://www.mozilla.org/about/governance/policies/participation/reporting/)' page. 9 | 10 | 16 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Attribution-ShareAlike 4.0 International 2 | 3 | ======================================================================= 4 | 5 | Creative Commons Corporation ("Creative Commons") is not a law firm and 6 | does not provide legal services or legal advice. Distribution of 7 | Creative Commons public licenses does not create a lawyer-client or 8 | other relationship. Creative Commons makes its licenses and related 9 | information available on an "as-is" basis. Creative Commons gives no 10 | warranties regarding its licenses, any material licensed under their 11 | terms and conditions, or any related information. Creative Commons 12 | disclaims all liability for damages resulting from their use to the 13 | fullest extent possible. 14 | 15 | Using Creative Commons Public Licenses 16 | 17 | Creative Commons public licenses provide a standard set of terms and 18 | conditions that creators and other rights holders may use to share 19 | original works of authorship and other material subject to copyright 20 | and certain other rights specified in the public license below. The 21 | following considerations are for informational purposes only, are not 22 | exhaustive, and do not form part of our licenses. 23 | 24 | Considerations for licensors: Our public licenses are 25 | intended for use by those authorized to give the public 26 | permission to use material in ways otherwise restricted by 27 | copyright and certain other rights. Our licenses are 28 | irrevocable. Licensors should read and understand the terms 29 | and conditions of the license they choose before applying it. 30 | Licensors should also secure all rights necessary before 31 | applying our licenses so that the public can reuse the 32 | material as expected. Licensors should clearly mark any 33 | material not subject to the license. This includes other CC- 34 | licensed material, or material used under an exception or 35 | limitation to copyright. More considerations for licensors: 36 | wiki.creativecommons.org/Considerations_for_licensors 37 | 38 | Considerations for the public: By using one of our public 39 | licenses, a licensor grants the public permission to use the 40 | licensed material under specified terms and conditions. If 41 | the licensor's permission is not necessary for any reason--for 42 | example, because of any applicable exception or limitation to 43 | copyright--then that use is not regulated by the license. Our 44 | licenses grant only permissions under copyright and certain 45 | other rights that a licensor has authority to grant. Use of 46 | the licensed material may still be restricted for other 47 | reasons, including because others have copyright or other 48 | rights in the material. A licensor may make special requests, 49 | such as asking that all changes be marked or described. 50 | Although not required by our licenses, you are encouraged to 51 | respect those requests where reasonable. More considerations 52 | for the public: 53 | wiki.creativecommons.org/Considerations_for_licensees 54 | 55 | ======================================================================= 56 | 57 | Creative Commons Attribution-ShareAlike 4.0 International Public 58 | License 59 | 60 | By exercising the Licensed Rights (defined below), You accept and agree 61 | to be bound by the terms and conditions of this Creative Commons 62 | Attribution-ShareAlike 4.0 International Public License ("Public 63 | License"). To the extent this Public License may be interpreted as a 64 | contract, You are granted the Licensed Rights in consideration of Your 65 | acceptance of these terms and conditions, and the Licensor grants You 66 | such rights in consideration of benefits the Licensor receives from 67 | making the Licensed Material available under these terms and 68 | conditions. 69 | 70 | 71 | Section 1 -- Definitions. 72 | 73 | a. Adapted Material means material subject to Copyright and Similar 74 | Rights that is derived from or based upon the Licensed Material 75 | and in which the Licensed Material is translated, altered, 76 | arranged, transformed, or otherwise modified in a manner requiring 77 | permission under the Copyright and Similar Rights held by the 78 | Licensor. For purposes of this Public License, where the Licensed 79 | Material is a musical work, performance, or sound recording, 80 | Adapted Material is always produced where the Licensed Material is 81 | synched in timed relation with a moving image. 82 | 83 | b. Adapter's License means the license You apply to Your Copyright 84 | and Similar Rights in Your contributions to Adapted Material in 85 | accordance with the terms and conditions of this Public License. 86 | 87 | c. BY-SA Compatible License means a license listed at 88 | creativecommons.org/compatiblelicenses, approved by Creative 89 | Commons as essentially the equivalent of this Public License. 90 | 91 | d. Copyright and Similar Rights means copyright and/or similar rights 92 | closely related to copyright including, without limitation, 93 | performance, broadcast, sound recording, and Sui Generis Database 94 | Rights, without regard to how the rights are labeled or 95 | categorized. For purposes of this Public License, the rights 96 | specified in Section 2(b)(1)-(2) are not Copyright and Similar 97 | Rights. 98 | 99 | e. Effective Technological Measures means those measures that, in the 100 | absence of proper authority, may not be circumvented under laws 101 | fulfilling obligations under Article 11 of the WIPO Copyright 102 | Treaty adopted on December 20, 1996, and/or similar international 103 | agreements. 104 | 105 | f. Exceptions and Limitations means fair use, fair dealing, and/or 106 | any other exception or limitation to Copyright and Similar Rights 107 | that applies to Your use of the Licensed Material. 108 | 109 | g. License Elements means the license attributes listed in the name 110 | of a Creative Commons Public License. The License Elements of this 111 | Public License are Attribution and ShareAlike. 112 | 113 | h. Licensed Material means the artistic or literary work, database, 114 | or other material to which the Licensor applied this Public 115 | License. 116 | 117 | i. Licensed Rights means the rights granted to You subject to the 118 | terms and conditions of this Public License, which are limited to 119 | all Copyright and Similar Rights that apply to Your use of the 120 | Licensed Material and that the Licensor has authority to license. 121 | 122 | j. Licensor means the individual(s) or entity(ies) granting rights 123 | under this Public License. 124 | 125 | k. Share means to provide material to the public by any means or 126 | process that requires permission under the Licensed Rights, such 127 | as reproduction, public display, public performance, distribution, 128 | dissemination, communication, or importation, and to make material 129 | available to the public including in ways that members of the 130 | public may access the material from a place and at a time 131 | individually chosen by them. 132 | 133 | l. Sui Generis Database Rights means rights other than copyright 134 | resulting from Directive 96/9/EC of the European Parliament and of 135 | the Council of 11 March 1996 on the legal protection of databases, 136 | as amended and/or succeeded, as well as other essentially 137 | equivalent rights anywhere in the world. 138 | 139 | m. You means the individual or entity exercising the Licensed Rights 140 | under this Public License. Your has a corresponding meaning. 141 | 142 | 143 | Section 2 -- Scope. 144 | 145 | a. License grant. 146 | 147 | 1. Subject to the terms and conditions of this Public License, 148 | the Licensor hereby grants You a worldwide, royalty-free, 149 | non-sublicensable, non-exclusive, irrevocable license to 150 | exercise the Licensed Rights in the Licensed Material to: 151 | 152 | a. reproduce and Share the Licensed Material, in whole or 153 | in part; and 154 | 155 | b. produce, reproduce, and Share Adapted Material. 156 | 157 | 2. Exceptions and Limitations. For the avoidance of doubt, where 158 | Exceptions and Limitations apply to Your use, this Public 159 | License does not apply, and You do not need to comply with 160 | its terms and conditions. 161 | 162 | 3. Term. The term of this Public License is specified in Section 163 | 6(a). 164 | 165 | 4. Media and formats; technical modifications allowed. The 166 | Licensor authorizes You to exercise the Licensed Rights in 167 | all media and formats whether now known or hereafter created, 168 | and to make technical modifications necessary to do so. The 169 | Licensor waives and/or agrees not to assert any right or 170 | authority to forbid You from making technical modifications 171 | necessary to exercise the Licensed Rights, including 172 | technical modifications necessary to circumvent Effective 173 | Technological Measures. For purposes of this Public License, 174 | simply making modifications authorized by this Section 2(a) 175 | (4) never produces Adapted Material. 176 | 177 | 5. Downstream recipients. 178 | 179 | a. Offer from the Licensor -- Licensed Material. Every 180 | recipient of the Licensed Material automatically 181 | receives an offer from the Licensor to exercise the 182 | Licensed Rights under the terms and conditions of this 183 | Public License. 184 | 185 | b. Additional offer from the Licensor -- Adapted Material. 186 | Every recipient of Adapted Material from You 187 | automatically receives an offer from the Licensor to 188 | exercise the Licensed Rights in the Adapted Material 189 | under the conditions of the Adapter's License You apply. 190 | 191 | c. No downstream restrictions. You may not offer or impose 192 | any additional or different terms or conditions on, or 193 | apply any Effective Technological Measures to, the 194 | Licensed Material if doing so restricts exercise of the 195 | Licensed Rights by any recipient of the Licensed 196 | Material. 197 | 198 | 6. No endorsement. Nothing in this Public License constitutes or 199 | may be construed as permission to assert or imply that You 200 | are, or that Your use of the Licensed Material is, connected 201 | with, or sponsored, endorsed, or granted official status by, 202 | the Licensor or others designated to receive attribution as 203 | provided in Section 3(a)(1)(A)(i). 204 | 205 | b. Other rights. 206 | 207 | 1. Moral rights, such as the right of integrity, are not 208 | licensed under this Public License, nor are publicity, 209 | privacy, and/or other similar personality rights; however, to 210 | the extent possible, the Licensor waives and/or agrees not to 211 | assert any such rights held by the Licensor to the limited 212 | extent necessary to allow You to exercise the Licensed 213 | Rights, but not otherwise. 214 | 215 | 2. Patent and trademark rights are not licensed under this 216 | Public License. 217 | 218 | 3. To the extent possible, the Licensor waives any right to 219 | collect royalties from You for the exercise of the Licensed 220 | Rights, whether directly or through a collecting society 221 | under any voluntary or waivable statutory or compulsory 222 | licensing scheme. In all other cases the Licensor expressly 223 | reserves any right to collect such royalties. 224 | 225 | 226 | Section 3 -- License Conditions. 227 | 228 | Your exercise of the Licensed Rights is expressly made subject to the 229 | following conditions. 230 | 231 | a. Attribution. 232 | 233 | 1. If You Share the Licensed Material (including in modified 234 | form), You must: 235 | 236 | a. retain the following if it is supplied by the Licensor 237 | with the Licensed Material: 238 | 239 | i. identification of the creator(s) of the Licensed 240 | Material and any others designated to receive 241 | attribution, in any reasonable manner requested by 242 | the Licensor (including by pseudonym if 243 | designated); 244 | 245 | ii. a copyright notice; 246 | 247 | iii. a notice that refers to this Public License; 248 | 249 | iv. a notice that refers to the disclaimer of 250 | warranties; 251 | 252 | v. a URI or hyperlink to the Licensed Material to the 253 | extent reasonably practicable; 254 | 255 | b. indicate if You modified the Licensed Material and 256 | retain an indication of any previous modifications; and 257 | 258 | c. indicate the Licensed Material is licensed under this 259 | Public License, and include the text of, or the URI or 260 | hyperlink to, this Public License. 261 | 262 | 2. You may satisfy the conditions in Section 3(a)(1) in any 263 | reasonable manner based on the medium, means, and context in 264 | which You Share the Licensed Material. For example, it may be 265 | reasonable to satisfy the conditions by providing a URI or 266 | hyperlink to a resource that includes the required 267 | information. 268 | 269 | 3. If requested by the Licensor, You must remove any of the 270 | information required by Section 3(a)(1)(A) to the extent 271 | reasonably practicable. 272 | 273 | b. ShareAlike. 274 | 275 | In addition to the conditions in Section 3(a), if You Share 276 | Adapted Material You produce, the following conditions also apply. 277 | 278 | 1. The Adapter's License You apply must be a Creative Commons 279 | license with the same License Elements, this version or 280 | later, or a BY-SA Compatible License. 281 | 282 | 2. You must include the text of, or the URI or hyperlink to, the 283 | Adapter's License You apply. You may satisfy this condition 284 | in any reasonable manner based on the medium, means, and 285 | context in which You Share Adapted Material. 286 | 287 | 3. You may not offer or impose any additional or different terms 288 | or conditions on, or apply any Effective Technological 289 | Measures to, Adapted Material that restrict exercise of the 290 | rights granted under the Adapter's License You apply. 291 | 292 | 293 | Section 4 -- Sui Generis Database Rights. 294 | 295 | Where the Licensed Rights include Sui Generis Database Rights that 296 | apply to Your use of the Licensed Material: 297 | 298 | a. for the avoidance of doubt, Section 2(a)(1) grants You the right 299 | to extract, reuse, reproduce, and Share all or a substantial 300 | portion of the contents of the database; 301 | 302 | b. if You include all or a substantial portion of the database 303 | contents in a database in which You have Sui Generis Database 304 | Rights, then the database in which You have Sui Generis Database 305 | Rights (but not its individual contents) is Adapted Material, 306 | 307 | including for purposes of Section 3(b); and 308 | c. You must comply with the conditions in Section 3(a) if You Share 309 | all or a substantial portion of the contents of the database. 310 | 311 | For the avoidance of doubt, this Section 4 supplements and does not 312 | replace Your obligations under this Public License where the Licensed 313 | Rights include other Copyright and Similar Rights. 314 | 315 | 316 | Section 5 -- Disclaimer of Warranties and Limitation of Liability. 317 | 318 | a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE 319 | EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS 320 | AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF 321 | ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, 322 | IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, 323 | WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR 324 | PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, 325 | ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT 326 | KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT 327 | ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. 328 | 329 | b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE 330 | TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, 331 | NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, 332 | INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, 333 | COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR 334 | USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN 335 | ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR 336 | DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR 337 | IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. 338 | 339 | c. The disclaimer of warranties and limitation of liability provided 340 | above shall be interpreted in a manner that, to the extent 341 | possible, most closely approximates an absolute disclaimer and 342 | waiver of all liability. 343 | 344 | 345 | Section 6 -- Term and Termination. 346 | 347 | a. This Public License applies for the term of the Copyright and 348 | Similar Rights licensed here. However, if You fail to comply with 349 | this Public License, then Your rights under this Public License 350 | terminate automatically. 351 | 352 | b. Where Your right to use the Licensed Material has terminated under 353 | Section 6(a), it reinstates: 354 | 355 | 1. automatically as of the date the violation is cured, provided 356 | it is cured within 30 days of Your discovery of the 357 | violation; or 358 | 359 | 2. upon express reinstatement by the Licensor. 360 | 361 | For the avoidance of doubt, this Section 6(b) does not affect any 362 | right the Licensor may have to seek remedies for Your violations 363 | of this Public License. 364 | 365 | c. For the avoidance of doubt, the Licensor may also offer the 366 | Licensed Material under separate terms or conditions or stop 367 | distributing the Licensed Material at any time; however, doing so 368 | will not terminate this Public License. 369 | 370 | d. Sections 1, 5, 6, 7, and 8 survive termination of this Public 371 | License. 372 | 373 | 374 | Section 7 -- Other Terms and Conditions. 375 | 376 | a. The Licensor shall not be bound by any additional or different 377 | terms or conditions communicated by You unless expressly agreed. 378 | 379 | b. Any arrangements, understandings, or agreements regarding the 380 | Licensed Material not stated herein are separate from and 381 | independent of the terms and conditions of this Public License. 382 | 383 | 384 | Section 8 -- Interpretation. 385 | 386 | a. For the avoidance of doubt, this Public License does not, and 387 | shall not be interpreted to, reduce, limit, restrict, or impose 388 | conditions on any use of the Licensed Material that could lawfully 389 | be made without permission under this Public License. 390 | 391 | b. To the extent possible, if any provision of this Public License is 392 | deemed unenforceable, it shall be automatically reformed to the 393 | minimum extent necessary to make it enforceable. If the provision 394 | cannot be reformed, it shall be severed from this Public License 395 | without affecting the enforceability of the remaining terms and 396 | conditions. 397 | 398 | c. No term or condition of this Public License will be waived and no 399 | failure to comply consented to unless expressly agreed to by the 400 | Licensor. 401 | 402 | d. Nothing in this Public License constitutes or may be interpreted 403 | as a limitation upon, or waiver of, any privileges and immunities 404 | that apply to the Licensor or You, including from the legal 405 | processes of any jurisdiction or authority. 406 | 407 | 408 | ======================================================================= 409 | 410 | Creative Commons is not a party to its public 411 | licenses. Notwithstanding, Creative Commons may elect to apply one of 412 | its public licenses to material it publishes and in those instances 413 | will be considered the “Licensor.” The text of the Creative Commons 414 | public licenses is dedicated to the public domain under the CC0 Public 415 | Domain Dedication. Except for the limited purpose of indicating that 416 | material is shared under a Creative Commons public license or as 417 | otherwise permitted by the Creative Commons policies published at 418 | creativecommons.org/policies, Creative Commons does not authorize the 419 | use of the trademark "Creative Commons" or any other trademark or logo 420 | of Creative Commons without its prior written consent including, 421 | without limitation, in connection with any unauthorized modifications 422 | to any of its public licenses or any other arrangements, 423 | understandings, or agreements concerning use of licensed material. For 424 | the avoidance of doubt, this paragraph does not form part of the 425 | public licenses. 426 | 427 | Creative Commons may be contacted at creativecommons.org. 428 | -------------------------------------------------------------------------------- /Photos/Serial-Console.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/Photos/Serial-Console.jpg -------------------------------------------------------------------------------- /Photos/lutron-light-bulbs-changers-adapters-lzl-4b-wh-l01-64_1000.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/Photos/lutron-light-bulbs-changers-adapters-lzl-4b-wh-l01-64_1000.jpg -------------------------------------------------------------------------------- /Photos/lutron-light-bulbs-changers-adapters-lzl-4b-wh-l01-c3_1000.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/Photos/lutron-light-bulbs-changers-adapters-lzl-4b-wh-l01-c3_1000.jpg -------------------------------------------------------------------------------- /Photos/pycharm-screen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/Photos/pycharm-screen.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | WebThings Developer Wiki 2 | 3 | Click on the Wiki link above or follow [this link](https://github.com/moziot/wiki/wiki). 4 | -------------------------------------------------------------------------------- /images/add-things.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/add-things.png -------------------------------------------------------------------------------- /images/dimmable-color-light.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/dimmable-color-light.png -------------------------------------------------------------------------------- /images/empty-things-screen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/empty-things-screen.png -------------------------------------------------------------------------------- /images/get-property.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/get-property.png -------------------------------------------------------------------------------- /images/get-thing.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/get-thing.png -------------------------------------------------------------------------------- /images/jwt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/jwt.png -------------------------------------------------------------------------------- /images/login.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/login.png -------------------------------------------------------------------------------- /images/open-websocket.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/open-websocket.png -------------------------------------------------------------------------------- /images/postman.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/postman.png -------------------------------------------------------------------------------- /images/request-action.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/request-action.png -------------------------------------------------------------------------------- /images/set-property.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/set-property.png -------------------------------------------------------------------------------- /images/virtual-things.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/virtual-things.png -------------------------------------------------------------------------------- /images/wot_gw.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/WebThingsIO/wiki/b974e794e8b14db2a8f99b57f452250a413f3886/images/wot_gw.png -------------------------------------------------------------------------------- /tools/dd-from-sdcard.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | SCRIPT_NAME="$0" 4 | 5 | usage() { 6 | echo "Usage: ${SCRIPT_NAME} dd-device img-filename" 7 | } 8 | 9 | DD_DEV="$1" 10 | if [ -z "${DD_DEV}" ]; then 11 | echo "Must provide the device node for the sdcard" 12 | usage 13 | exit 1 14 | fi 15 | DD_NAME=$(basename ${DD_DEV}) 16 | if [[ "${DD_DEV:0:1}" != '/' ]]; then 17 | DD_DEV="/dev/${DD_DEV}" 18 | fi 19 | REMOVABLE=$(cat /sys/block/${DD_NAME}/removable) 20 | if [ "${REMOVABLE}" != "1" ]; then 21 | echo "${DD_DEV} isn't a removable drive" 22 | exit 1 23 | fi 24 | MEDIA_SIZE=$(cat /sys/block/${DD_NAME}/size) 25 | if [ "${MEDIA_SIZE}" == "0" ]; then 26 | echo "No media present at ${DD_DEV}" 27 | exit 1 28 | fi 29 | if [ $(( ${MEDIA_SIZE} / 2048 / 1024 )) -gt 100 ]; then 30 | echo "${DD_DEV} media size is larger than 100 Gb - wrong device?" 31 | exit 1 32 | fi 33 | 34 | IMG_FILENAME="$2" 35 | if [ -z "${IMG_FILENAME}" ]; then 36 | echo "Must provide the imsage name for the sdcard" 37 | usage 38 | exit 1 39 | fi 40 | 41 | # Unmount anything on the source device 42 | mount | grep "${DD_DEV}" | while read dev rest; do 43 | echo "Unmounting '${dev}'" 44 | sudo umount "${dev}" 45 | done 46 | echo "Reading image from '${DD_DEV}' to '${IMG_FILENAME}'" 47 | sudo dd status=progress bs=10M if="${DD_DEV}" of="${IMG_FILENAME}" 48 | -------------------------------------------------------------------------------- /tools/dd-to-sdcard.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | SCRIPT_NAME="$0" 4 | 5 | usage() { 6 | echo "Usage: ${SCRIPT_NAME} dd-device img-filename" 7 | } 8 | 9 | DD_DEV="$1" 10 | if [ -z "${DD_DEV}" ]; then 11 | echo "Must provide the device node for the sdcard" 12 | usage 13 | exit 1 14 | fi 15 | DD_NAME=$(basename ${DD_DEV}) 16 | if [[ "${DD_DEV:0:1}" != '/' ]]; then 17 | DD_DEV="/dev/${DD_DEV}" 18 | fi 19 | REMOVABLE=$(cat /sys/block/${DD_NAME}/removable) 20 | if [ "${REMOVABLE}" != "1" ]; then 21 | echo "${DD_DEV} isn't a removable drive" 22 | exit 1 23 | fi 24 | MEDIA_SIZE=$(cat /sys/block/${DD_NAME}/size) 25 | if [ "${MEDIA_SIZE}" == "0" ]; then 26 | echo "No media present at ${DD_DEV}" 27 | exit 1 28 | fi 29 | if [ $(( ${MEDIA_SIZE} / 2048 / 1024 )) -gt 100 ]; then 30 | echo "${DD_DEV} media size is larger than 100 Gb - wrong device?" 31 | exit 1 32 | fi 33 | 34 | IMG_FILENAME="$2" 35 | if [ -z "${IMG_FILENAME}" ]; then 36 | echo "Must provide the image name for the sdcard" 37 | usage 38 | exit 1 39 | fi 40 | 41 | # Unmount anything on the source device 42 | mount | grep "${DD_DEV}" | while read dev rest; do 43 | echo "Unmounting '${dev}'" 44 | sudo umount "${dev}" 45 | done 46 | 47 | if [[ "${IMG_FILENAME}" == *.zip ]]; then 48 | echo "Unzipping image from '${IMG_FILENAME}' to '${DD_DEV}'" 49 | unzip -p ${IMG_FILENAME} | sudo dd status=progress bs=10M of="${DD_DEV}" 50 | elif [[ "${IMG_FILENAME}" == *.gz ]]; then 51 | echo "gunzipping image from '${IMG_FILENAME}' to '${DD_DEV}'" 52 | gunzip -c ${IMG_FILENAME} | sudo dd status=progress bs=10M of="${DD_DEV}" 53 | else 54 | echo "Writing image to '${DD_DEV}' from '${IMG_FILENAME}'" 55 | sudo dd status=progress bs=10M of="${DD_DEV}" if="${IMG_FILENAME}" 56 | fi 57 | -------------------------------------------------------------------------------- /tools/mount-img.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | # Script which loop mounts an image 4 | 5 | SCRIPT_NAME=$(basename $0) 6 | 7 | VERBOSE=0 8 | ROOT_MOUNTED=0 9 | LEAVE_MOUNTED=0 10 | 11 | ########################################################################### 12 | # 13 | # Prints the program usage 14 | # 15 | usage() { 16 | echo "Usage: ${SCRIPT_NAME} [-v] IMAGE_FILE" 17 | } 18 | 19 | ########################################################################### 20 | # 21 | # Parses command line arguments and run the program. 22 | # 23 | main () { 24 | while getopts "v" opt "$@"; do 25 | case $opt in 26 | v) 27 | VERBOSE=1 28 | ;; 29 | ?) 30 | echo "Unrecognized option: ${opt}" 31 | usage 32 | exit 1 33 | ;; 34 | esac 35 | done 36 | shift $((${OPTIND} - 1)) 37 | IMAGE_FILE=$1 38 | if [ -z "${IMAGE_FILE}" ]; then 39 | echo "No image file provided." 40 | usage 41 | exit 1 42 | fi 43 | 44 | if [ "${VERBOSE}" == "1" ]; then 45 | echo "Image File: ${IMAGE_FILE}" 46 | fi 47 | 48 | if [ ! -f "${IMAGE_FILE}" ]; then 49 | echo "Image File: '${IMAGE_FILE}' not a file." 50 | exit 1 51 | fi 52 | 53 | # Figure out the device names that kpartx will create 54 | declare -a KPARTX_DEVS 55 | KPARTX_DEVS=($(while read dev rest; do 56 | echo "/dev/mapper/${dev}" 57 | done < <(sudo kpartx -v -l "${IMAGE_FILE}"))) 58 | 59 | BOOT_DEV=${KPARTX_DEVS[0]} 60 | ROOT_DEV=${KPARTX_DEVS[1]} 61 | 62 | ROOT_MOUNTPOINT=rpi-root 63 | MOZILLA_IOT_DIR=${ROOT_MOUNTPOINT}/home/pi/mozilla-iot 64 | 65 | if [ "${VERBOSE}" == "1" ]; then 66 | echo " BOOT_DEV: ${BOOT_DEV}" 67 | echo " ROOT_DEV: ${ROOT_DEV}" 68 | fi 69 | 70 | # Create the loop mounts 71 | if sudo kpartx -v -a "${IMAGE_FILE}"; then 72 | # It seems that there is sometimes a race and that the loop files don't 73 | # always exist by the time kpartx exits, so we wait until we actually 74 | # see the loop file before continuing. 75 | iter=0 76 | while [ ! -e ${ROOT_DEV} ]; do 77 | echo "Waiting for loop mount to be created" 78 | sleep 1 79 | iter=$(( ${iter} + 1 )) 80 | if [ ${iter} -gt 5 ]; then 81 | echo "Timeout waiting for loop mount" 82 | exit 1 83 | fi 84 | done 85 | echo "Loop mounts created successfully" 86 | else 87 | echo "Failed to create loop mounts" 88 | exit 1 89 | fi 90 | LOOP_MOUNT_CREATED=1 91 | 92 | # Mount the root parition of the image 93 | mkdir -p ${ROOT_MOUNTPOINT} 94 | if sudo mount ${ROOT_DEV} ${ROOT_MOUNTPOINT}; then 95 | echo "Root partition mounted successfully" 96 | else 97 | echo "Failed to mount root partition" 98 | exit 1 99 | fi 100 | ROOT_MOUNTED=1 101 | 102 | LEAVE_MOUNTED=1 103 | } 104 | 105 | ########################################################################### 106 | # 107 | # Do required cleanup. We use a trap so that if the script dies for any 108 | # reason then we'll still undo whatever is needed. 109 | # 110 | function cleanup() { 111 | if [ "${LEAVE_MOUNTED}" == 1 ]; then 112 | return 113 | fi 114 | if [ "${ROOT_MOUNTED}" == 1 ]; then 115 | echo "Unmounting ${ROOT_DEV}" 116 | sudo umount ${ROOT_MOUNTPOINT} 117 | ROOT_MOUNTED=0 118 | fi 119 | if [ -d ${ROOT_MOUNTPOINT} ]; then 120 | sudo rmdir ${ROOT_MOUNTPOINT} 121 | fi 122 | if [ "${LOOP_MOUNT_CREATED}" == 1 ]; then 123 | echo "Removing loop mounts" 124 | sudo kpartx -v -d "${IMAGE_FILE}" 125 | LOOP_MOUNT_CREATED=0 126 | fi 127 | } 128 | 129 | trap cleanup EXIT 130 | 131 | main "$@" -------------------------------------------------------------------------------- /tools/mount-img2.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | # Script which loop mounts an image 4 | 5 | SCRIPT_NAME=$(basename $0) 6 | 7 | VERBOSE=0 8 | ROOT_MOUNTED=0 9 | LEAVE_MOUNTED=0 10 | 11 | ########################################################################### 12 | # 13 | # Prints the program usage 14 | # 15 | usage() { 16 | echo "Usage: ${SCRIPT_NAME} [-v] IMAGE_FILE" 17 | } 18 | 19 | ########################################################################### 20 | # 21 | # Parses command line arguments and run the program. 22 | # 23 | main () { 24 | while getopts "v" opt "$@"; do 25 | case $opt in 26 | v) 27 | VERBOSE=1 28 | ;; 29 | ?) 30 | echo "Unrecognized option: ${opt}" 31 | usage 32 | exit 1 33 | ;; 34 | esac 35 | done 36 | shift $((${OPTIND} - 1)) 37 | IMAGE_FILE=$1 38 | if [ -z "${IMAGE_FILE}" ]; then 39 | echo "No image file provided." 40 | usage 41 | exit 1 42 | fi 43 | 44 | if [ "${VERBOSE}" == "1" ]; then 45 | echo "Image File: ${IMAGE_FILE}" 46 | fi 47 | 48 | if [ ! -f "${IMAGE_FILE}" ]; then 49 | echo "Image File: '${IMAGE_FILE}' not a file." 50 | exit 1 51 | fi 52 | 53 | # Figure out the device names that kpartx will create 54 | declare -a KPARTX_DEVS 55 | KPARTX_DEVS=($(while read dev rest; do 56 | echo "/dev/mapper/${dev}" 57 | done < <(sudo kpartx -v -l "${IMAGE_FILE}"))) 58 | 59 | BOOT_DEV=${KPARTX_DEVS[0]} 60 | ROOT_DEV=${KPARTX_DEVS[1]} 61 | 62 | ROOT_MOUNTPOINT=rpi-root 63 | BOOT_MOUNTPOINT=rpi-boot 64 | MOZILLA_IOT_DIR=${ROOT_MOUNTPOINT}/home/pi/mozilla-iot 65 | 66 | if [ "${VERBOSE}" == "1" ]; then 67 | echo " BOOT_DEV: ${BOOT_DEV}" 68 | echo " ROOT_DEV: ${ROOT_DEV}" 69 | fi 70 | 71 | # Create the loop mounts 72 | if sudo kpartx -v -a "${IMAGE_FILE}"; then 73 | # It seems that there is sometimes a race and that the loop files don't 74 | # always exist by the time kpartx exits, so we wait until we actually 75 | # see the loop file before continuing. 76 | iter=0 77 | while [ ! -e ${ROOT_DEV} ]; do 78 | echo "Waiting for loop mount to be created" 79 | sleep 1 80 | iter=$(( ${iter} + 1 )) 81 | if [ ${iter} -gt 5 ]; then 82 | echo "Timeout waiting for loop mount" 83 | exit 1 84 | fi 85 | done 86 | echo "Loop mounts created successfully" 87 | else 88 | echo "Failed to create loop mounts" 89 | exit 1 90 | fi 91 | LOOP_MOUNT_CREATED=1 92 | 93 | # Mount the root parition of the image 94 | mkdir -p ${ROOT_MOUNTPOINT} 95 | if sudo mount ${ROOT_DEV} ${ROOT_MOUNTPOINT}; then 96 | echo "Root partition mounted successfully" 97 | else 98 | echo "Failed to mount root partition" 99 | exit 1 100 | fi 101 | ROOT_MOUNTED=1 102 | 103 | # Mount the boot parition of the image 104 | mkdir -p ${BOOT_MOUNTPOINT} 105 | if sudo mount ${BOOT_DEV} ${BOOT_MOUNTPOINT}; then 106 | echo "Boot partition mounted successfully" 107 | else 108 | echo "Failed to mount boot partition" 109 | exit 1 110 | fi 111 | BOOT_MOUNTED=1 112 | 113 | LEAVE_MOUNTED=1 114 | } 115 | 116 | ########################################################################### 117 | # 118 | # Do required cleanup. We use a trap so that if the script dies for any 119 | # reason then we'll still undo whatever is needed. 120 | # 121 | function cleanup() { 122 | if [ "${LEAVE_MOUNTED}" == 1 ]; then 123 | return 124 | fi 125 | if [ "${BOOT_MOUNTED}" == 1 ]; then 126 | echo "Unmounting ${BOOT_DEV}" 127 | sudo umount ${BOOT_MOUNTPOINT} 128 | BOOT_MOUNTED=0 129 | fi 130 | if [ -d ${BOOT_MOUNTPOINT} ]; then 131 | sudo rmdir ${BOOT_MOUNTPOINT} 132 | fi 133 | if [ "${ROOT_MOUNTED}" == 1 ]; then 134 | echo "Unmounting ${ROOT_DEV}" 135 | sudo umount ${ROOT_MOUNTPOINT} 136 | ROOT_MOUNTED=0 137 | fi 138 | if [ -d ${ROOT_MOUNTPOINT} ]; then 139 | sudo rmdir ${ROOT_MOUNTPOINT} 140 | fi 141 | if [ "${LOOP_MOUNT_CREATED}" == 1 ]; then 142 | echo "Removing loop mounts" 143 | sudo kpartx -v -d "${IMAGE_FILE}" 144 | LOOP_MOUNT_CREATED=0 145 | fi 146 | } 147 | 148 | trap cleanup EXIT 149 | 150 | main "$@" -------------------------------------------------------------------------------- /tools/umount-img.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | # Script which loop mounts an image 4 | 5 | SCRIPT_NAME=$(basename $0) 6 | 7 | VERBOSE=0 8 | ROOT_MOUNTED=0 9 | LEAVE_MOUNTED=0 10 | 11 | ########################################################################### 12 | # 13 | # Prints the program usage 14 | # 15 | usage() { 16 | echo "Usage: ${SCRIPT_NAME} [-v] IMAGE_FILE" 17 | } 18 | 19 | ########################################################################### 20 | # 21 | # Parses command line arguments and run the program. 22 | # 23 | main () { 24 | while getopts "v" opt "$@"; do 25 | case $opt in 26 | v) 27 | VERBOSE=1 28 | ;; 29 | ?) 30 | echo "Unrecognized option: ${opt}" 31 | usage 32 | exit 1 33 | ;; 34 | esac 35 | done 36 | shift $((${OPTIND} - 1)) 37 | IMAGE_FILE=$1 38 | if [ -z "${IMAGE_FILE}" ]; then 39 | echo "No image file provided." 40 | usage 41 | exit 1 42 | fi 43 | 44 | if [ "${VERBOSE}" == "1" ]; then 45 | echo "Image File: ${IMAGE_FILE}" 46 | fi 47 | 48 | if [ ! -f "${IMAGE_FILE}" ]; then 49 | echo "Image File: '${IMAGE_FILE}' not a file." 50 | exit 1 51 | fi 52 | 53 | ROOT_MOUNTPOINT=rpi-root 54 | 55 | # Unmount the root parition of the image 56 | if sudo umount ${ROOT_MOUNTPOINT}; then 57 | echo "Root partition unmounted successfully" 58 | else 59 | echo "Failed to unmount root partition" 60 | exit 1 61 | fi 62 | 63 | # Remove the loop mounts 64 | if sudo kpartx -v -d "${IMAGE_FILE}"; then 65 | echo "Loop mounts removed successfully" 66 | else 67 | echo "Failed to remove loop mounts" 68 | exit 1 69 | fi 70 | 71 | rmdir ${ROOT_MOUNTPOINT} 72 | } 73 | 74 | main "$@" -------------------------------------------------------------------------------- /tools/umount-img2.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # 3 | # Script which loop mounts an image 4 | 5 | SCRIPT_NAME=$(basename $0) 6 | 7 | VERBOSE=0 8 | ROOT_MOUNTED=0 9 | LEAVE_MOUNTED=0 10 | 11 | ########################################################################### 12 | # 13 | # Prints the program usage 14 | # 15 | usage() { 16 | echo "Usage: ${SCRIPT_NAME} [-v] IMAGE_FILE" 17 | } 18 | 19 | ########################################################################### 20 | # 21 | # Parses command line arguments and run the program. 22 | # 23 | main () { 24 | while getopts "v" opt "$@"; do 25 | case $opt in 26 | v) 27 | VERBOSE=1 28 | ;; 29 | ?) 30 | echo "Unrecognized option: ${opt}" 31 | usage 32 | exit 1 33 | ;; 34 | esac 35 | done 36 | shift $((${OPTIND} - 1)) 37 | IMAGE_FILE=$1 38 | if [ -z "${IMAGE_FILE}" ]; then 39 | echo "No image file provided." 40 | usage 41 | exit 1 42 | fi 43 | 44 | if [ "${VERBOSE}" == "1" ]; then 45 | echo "Image File: ${IMAGE_FILE}" 46 | fi 47 | 48 | if [ ! -f "${IMAGE_FILE}" ]; then 49 | echo "Image File: '${IMAGE_FILE}' not a file." 50 | exit 1 51 | fi 52 | 53 | ROOT_MOUNTPOINT=rpi-root 54 | BOOT_MOUNTPOINT=rpi-boot 55 | 56 | # Unmount the boot parition of the image 57 | if sudo umount ${BOOT_MOUNTPOINT}; then 58 | echo "Boot partition unmounted successfully" 59 | else 60 | echo "Failed to unmount boot partition" 61 | exit 1 62 | fi 63 | 64 | # Unmount the root parition of the image 65 | if sudo umount ${ROOT_MOUNTPOINT}; then 66 | echo "Root partition unmounted successfully" 67 | else 68 | echo "Failed to unmount root partition" 69 | exit 1 70 | fi 71 | 72 | # Remove the loop mounts 73 | if sudo kpartx -v -d "${IMAGE_FILE}"; then 74 | echo "Loop mounts removed successfully" 75 | else 76 | echo "Failed to remove loop mounts" 77 | exit 1 78 | fi 79 | 80 | rmdir ${BOOT_MOUNTPOINT} 81 | rmdir ${ROOT_MOUNTPOINT} 82 | } 83 | 84 | main "$@" --------------------------------------------------------------------------------