├── .clang-format ├── .github └── workflows │ ├── checks.yml │ └── publish.yml ├── .gitignore ├── LICENSE ├── Makefile ├── README.md ├── doc ├── mounting.md ├── parts.md └── pictures │ ├── image1.jpg │ ├── image10.jpg │ ├── image11.jpg │ ├── image12.jpg │ ├── image13.jpg │ ├── image14.jpg │ ├── image15.jpg │ ├── image16.jpg │ ├── image17.jpg │ ├── image18.jpg │ ├── image19.jpg │ ├── image2.jpg │ ├── image20.jpg │ ├── image21.jpg │ ├── image22.jpg │ ├── image23.jpg │ ├── image24.jpg │ ├── image25.jpg │ ├── image26.jpg │ ├── image27.jpg │ ├── image28.jpg │ ├── image29.jpg │ ├── image3.jpg │ ├── image30.jpg │ ├── image31.jpg │ ├── image32.jpg │ ├── image33.jpg │ ├── image4.jpg │ ├── image5.jpg │ ├── image6.jpg │ ├── image7.jpg │ ├── image8.jpg │ ├── image9.jpg │ ├── t.txt │ ├── wiring_breadboard.jpg │ ├── wiring_robot.jpg │ └── wiring_schematic.png ├── installer ├── .eslintignore ├── .eslintrc.cjs ├── .gitignore ├── .prettierignore ├── .prettierrc.cjs ├── README.md ├── index.html ├── lefthook.yml.sample ├── package-lock.json ├── package.json ├── postcss.config.js ├── public │ ├── 128x128.png │ └── tauri.svg ├── src-tauri │ ├── .gitignore │ ├── Cargo.lock │ ├── Cargo.toml │ ├── build.rs │ ├── icons │ │ ├── 128x128.png │ │ ├── 128x128@2x.png │ │ ├── 32x32.png │ │ ├── Square107x107Logo.png │ │ ├── Square142x142Logo.png │ │ ├── Square150x150Logo.png │ │ ├── Square284x284Logo.png │ │ ├── Square30x30Logo.png │ │ ├── Square310x310Logo.png │ │ ├── Square44x44Logo.png │ │ ├── Square71x71Logo.png │ │ ├── Square89x89Logo.png │ │ ├── StoreLogo.png │ │ ├── icon.icns │ │ ├── icon.ico │ │ └── icon.png │ ├── src │ │ └── main.rs │ └── tauri.conf.json ├── src │ ├── App.css │ ├── App.jsx │ ├── components │ │ ├── FormControl.jsx │ │ └── LoadingButton.jsx │ ├── main.jsx │ ├── reducers │ │ └── state-reducer.js │ ├── services │ │ └── arduino-cli.js │ ├── styles.css │ ├── supported-boards.js │ └── utils │ │ ├── capitalize.js │ │ └── tail.js ├── tailwind.config.js └── vite.config.js ├── lefthook.yml ├── package-lock.json ├── package.json ├── scratch-arduino-extensions ├── scratch-gui │ └── src │ │ └── components │ │ └── dismissable-banner │ │ ├── dismissable-banner.css │ │ └── dismissable-banner.jsx ├── scratch-l10n │ └── locales │ │ └── include-msgs.json ├── scratch-vm │ └── src │ │ └── extensions │ │ └── scratch3_arduino │ │ ├── blockIconURI.js │ │ ├── constants.js │ │ ├── index.js │ │ ├── peripheral.js │ │ └── utils.js └── scripts │ ├── add-banner.js │ └── patch-gui.js ├── scripts ├── add-config.py ├── compile.sh └── upload.sh └── sketches ├── .gitignore ├── BLE_Scratch ├── BLE_Scratch.ino ├── robot.cpp ├── robot.h └── sketch.yaml └── USB_Scratch_FW └── USB_Scratch_FW.ino /.clang-format: -------------------------------------------------------------------------------- 1 | # Source: https://github.com/arduino/tooling-project-assets/tree/main/other/clang-format-configuration 2 | --- 3 | AccessModifierOffset: -2 4 | AlignAfterOpenBracket: Align 5 | AlignArrayOfStructures: None 6 | AlignConsecutiveAssignments: None 7 | AlignConsecutiveBitFields: None 8 | AlignConsecutiveDeclarations: None 9 | AlignConsecutiveMacros: None 10 | AlignEscapedNewlines: DontAlign 11 | AlignOperands: Align 12 | AlignTrailingComments: true 13 | AllowAllArgumentsOnNextLine: true 14 | AllowAllConstructorInitializersOnNextLine: true 15 | AllowAllParametersOfDeclarationOnNextLine: true 16 | AllowShortBlocksOnASingleLine: Always 17 | AllowShortCaseLabelsOnASingleLine: true 18 | AllowShortEnumsOnASingleLine: true 19 | AllowShortFunctionsOnASingleLine: Empty 20 | AllowShortIfStatementsOnASingleLine: AllIfsAndElse 21 | AllowShortLambdasOnASingleLine: Empty 22 | AllowShortLoopsOnASingleLine: true 23 | AlwaysBreakAfterDefinitionReturnType: None 24 | AlwaysBreakAfterReturnType: None 25 | AlwaysBreakBeforeMultilineStrings: false 26 | AlwaysBreakTemplateDeclarations: No 27 | AttributeMacros: 28 | - __capability 29 | BasedOnStyle: LLVM 30 | BinPackArguments: true 31 | BinPackParameters: true 32 | BitFieldColonSpacing: Both 33 | BraceWrapping: 34 | AfterCaseLabel: false 35 | AfterClass: false 36 | AfterControlStatement: Never 37 | AfterEnum: false 38 | AfterFunction: false 39 | AfterNamespace: false 40 | AfterObjCDeclaration: false 41 | AfterStruct: false 42 | AfterUnion: false 43 | AfterExternBlock: false 44 | BeforeCatch: false 45 | BeforeElse: false 46 | BeforeLambdaBody: false 47 | BeforeWhile: false 48 | IndentBraces: false 49 | SplitEmptyFunction: true 50 | SplitEmptyRecord: true 51 | SplitEmptyNamespace: true 52 | BreakAfterJavaFieldAnnotations: false 53 | BreakBeforeBinaryOperators: NonAssignment 54 | BreakBeforeBraces: Attach 55 | BreakBeforeConceptDeclarations: false 56 | BreakBeforeInheritanceComma: false 57 | BreakBeforeTernaryOperators: true 58 | BreakConstructorInitializers: BeforeColon 59 | BreakConstructorInitializersBeforeComma: false 60 | BreakInheritanceList: BeforeColon 61 | BreakStringLiterals: false 62 | ColumnLimit: 0 63 | CommentPragmas: '' 64 | CompactNamespaces: false 65 | ConstructorInitializerAllOnOneLineOrOnePerLine: false 66 | ConstructorInitializerIndentWidth: 2 67 | ContinuationIndentWidth: 2 68 | Cpp11BracedListStyle: false 69 | DeriveLineEnding: true 70 | DerivePointerAlignment: true 71 | DisableFormat: false 72 | EmptyLineAfterAccessModifier: Leave 73 | EmptyLineBeforeAccessModifier: Leave 74 | ExperimentalAutoDetectBinPacking: false 75 | FixNamespaceComments: false 76 | ForEachMacros: 77 | - foreach 78 | - Q_FOREACH 79 | - BOOST_FOREACH 80 | IfMacros: 81 | - KJ_IF_MAYBE 82 | IncludeBlocks: Preserve 83 | IncludeCategories: 84 | - Regex: '^"(llvm|llvm-c|clang|clang-c)/' 85 | Priority: 2 86 | SortPriority: 0 87 | CaseSensitive: false 88 | - Regex: '^(<|"(gtest|gmock|isl|json)/)' 89 | Priority: 3 90 | SortPriority: 0 91 | CaseSensitive: false 92 | - Regex: '.*' 93 | Priority: 1 94 | SortPriority: 0 95 | CaseSensitive: false 96 | IncludeIsMainRegex: '' 97 | IncludeIsMainSourceRegex: '' 98 | IndentAccessModifiers: false 99 | IndentCaseBlocks: true 100 | IndentCaseLabels: true 101 | IndentExternBlock: Indent 102 | IndentGotoLabels: false 103 | IndentPPDirectives: None 104 | IndentRequires: true 105 | IndentWidth: 2 106 | IndentWrappedFunctionNames: false 107 | InsertTrailingCommas: None 108 | JavaScriptQuotes: Leave 109 | JavaScriptWrapImports: true 110 | KeepEmptyLinesAtTheStartOfBlocks: true 111 | LambdaBodyIndentation: Signature 112 | Language: Cpp 113 | MacroBlockBegin: '' 114 | MacroBlockEnd: '' 115 | MaxEmptyLinesToKeep: 100000 116 | NamespaceIndentation: None 117 | ObjCBinPackProtocolList: Auto 118 | ObjCBlockIndentWidth: 2 119 | ObjCBreakBeforeNestedBlockParam: true 120 | ObjCSpaceAfterProperty: false 121 | ObjCSpaceBeforeProtocolList: true 122 | PPIndentWidth: -1 123 | PackConstructorInitializers: BinPack 124 | PenaltyBreakAssignment: 1 125 | PenaltyBreakBeforeFirstCallParameter: 1 126 | PenaltyBreakComment: 1 127 | PenaltyBreakFirstLessLess: 1 128 | PenaltyBreakOpenParenthesis: 1 129 | PenaltyBreakString: 1 130 | PenaltyBreakTemplateDeclaration: 1 131 | PenaltyExcessCharacter: 1 132 | PenaltyIndentedWhitespace: 1 133 | PenaltyReturnTypeOnItsOwnLine: 1 134 | PointerAlignment: Right 135 | QualifierAlignment: Leave 136 | ReferenceAlignment: Pointer 137 | ReflowComments: false 138 | RemoveBracesLLVM: false 139 | SeparateDefinitionBlocks: Leave 140 | ShortNamespaceLines: 0 141 | SortIncludes: Never 142 | SortJavaStaticImport: Before 143 | SortUsingDeclarations: false 144 | SpaceAfterCStyleCast: false 145 | SpaceAfterLogicalNot: false 146 | SpaceAfterTemplateKeyword: false 147 | SpaceAroundPointerQualifiers: Default 148 | SpaceBeforeAssignmentOperators: true 149 | SpaceBeforeCaseColon: false 150 | SpaceBeforeCpp11BracedList: false 151 | SpaceBeforeCtorInitializerColon: true 152 | SpaceBeforeInheritanceColon: true 153 | SpaceBeforeParens: ControlStatements 154 | SpaceBeforeParensOptions: 155 | AfterControlStatements: true 156 | AfterForeachMacros: true 157 | AfterFunctionDefinitionName: false 158 | AfterFunctionDeclarationName: false 159 | AfterIfMacros: true 160 | AfterOverloadedOperator: false 161 | BeforeNonEmptyParentheses: false 162 | SpaceBeforeRangeBasedForLoopColon: true 163 | SpaceBeforeSquareBrackets: false 164 | SpaceInEmptyBlock: false 165 | SpaceInEmptyParentheses: false 166 | SpacesBeforeTrailingComments: 2 167 | SpacesInAngles: Leave 168 | SpacesInCStyleCastParentheses: false 169 | SpacesInConditionalStatement: false 170 | SpacesInContainerLiterals: false 171 | SpacesInLineCommentPrefix: 172 | Minimum: 0 173 | Maximum: -1 174 | SpacesInParentheses: false 175 | SpacesInSquareBrackets: false 176 | Standard: Auto 177 | StatementAttributeLikeMacros: 178 | - Q_EMIT 179 | StatementMacros: 180 | - Q_UNUSED 181 | - QT_REQUIRE_VERSION 182 | TabWidth: 2 183 | UseCRLF: false 184 | UseTab: Never 185 | WhitespaceSensitiveMacros: 186 | - STRINGIZE 187 | - PP_STRINGIZE 188 | - BOOST_PP_STRINGIZE 189 | - NS_SWIFT_NAME 190 | - CF_SWIFT_NAME 191 | -------------------------------------------------------------------------------- /.github/workflows/checks.yml: -------------------------------------------------------------------------------- 1 | name: C/C++ CI 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | pull_request: 7 | branches: [ main ] 8 | 9 | jobs: 10 | build: 11 | runs-on: ubuntu-latest 12 | 13 | steps: 14 | - uses: actions/checkout@v4 15 | 16 | - name: "install required packages" 17 | run: | 18 | sudo apt-get install -y clang-format make 19 | npm install --include=dev 20 | 21 | - name: "check code format" 22 | run: make fmt-check 23 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: "publish" 2 | on: 3 | push: 4 | branches: 5 | - release 6 | 7 | # This is the example from the readme. 8 | # On each push to the `release` branch it will create or update a GitHub release, build your app, and upload the artifacts to the release. 9 | 10 | jobs: 11 | publish-tauri: 12 | permissions: 13 | contents: write 14 | strategy: 15 | fail-fast: false 16 | matrix: 17 | include: 18 | - platform: "macos-latest" # for Arm based macs (M1 and above). 19 | args: "--target aarch64-apple-darwin" 20 | - platform: "macos-latest" # for Intel based macs. 21 | args: "--target x86_64-apple-darwin" 22 | - platform: "ubuntu-20.04" # for Tauri v2 you could replace this with ubuntu-22.04. 23 | args: "" 24 | - platform: "windows-latest" 25 | args: "" 26 | 27 | runs-on: ${{ matrix.platform }} 28 | steps: 29 | - uses: actions/checkout@v4 30 | 31 | - name: setup node 32 | uses: actions/setup-node@v4 33 | with: 34 | node-version: lts/* 35 | 36 | - name: install Rust stable 37 | uses: dtolnay/rust-toolchain@stable 38 | with: 39 | # Those targets are only used on macos runners so it's in an `if` to slightly speed up windows and linux builds. 40 | targets: ${{ matrix.platform == 'macos-latest' && 'aarch64-apple-darwin,x86_64-apple-darwin' || '' }} 41 | 42 | - name: install dependencies (ubuntu only) 43 | if: matrix.platform == 'ubuntu-20.04' # This must match the platform value defined above. 44 | run: | 45 | sudo apt-get update 46 | sudo apt-get install -y libwebkit2gtk-4.0-dev libappindicator3-dev librsvg2-dev patchelf 47 | # webkitgtk 4.0 is for Tauri v1 - webkitgtk 4.1 is for Tauri v2. 48 | # You can remove the one that doesn't apply to your app to speed up the workflow a bit. 49 | 50 | - name: install frontend dependencies 51 | run: npm install 52 | working-directory: ./installer 53 | 54 | - uses: tauri-apps/tauri-action@v0 55 | env: 56 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 57 | with: 58 | tagName: app-v__VERSION__ # the action automatically replaces \_\_VERSION\_\_ with the app version. 59 | releaseName: "App v__VERSION__" 60 | releaseBody: "See the assets to download this version and install." 61 | releaseDraft: true 62 | prerelease: false 63 | args: ${{ matrix.args }} 64 | projectPath: ./installer 65 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | scratch-gui/ 3 | build/ 4 | node_modules/ 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | scratch-gui-version = v3.2.37 2 | 3 | .PHONY: init 4 | init: 5 | npm install --include=dev 6 | brew install clang-format 7 | make scratch-gui-install 8 | 9 | .PHONY: scratch-gui-install 10 | scratch-gui-install: 11 | git clone --depth 1 --branch $(scratch-gui-version) https://github.com/scratchfoundation/scratch-gui.git 12 | cd scratch-gui && npm install 13 | 14 | .PHONY: scratch-gui-patch 15 | scratch-gui-patch: 16 | cd scratch-gui && node ../scratch-arduino-extensions/scripts/patch-gui.js 17 | cd scratch-gui && node ../scratch-arduino-extensions/scripts/add-banner.js 18 | 19 | .PHONY: scratch-gui-start 20 | scratch-gui-start: 21 | cd scratch-gui && npm start 22 | 23 | .PHONY: scratch-gui-watch 24 | scratch-gui-watch: 25 | cd scratch-gui && npm run watch 26 | 27 | .PHONY: scratch-gui-clean 28 | scratch-gui-clean: 29 | rm -rf scratch-gui 30 | 31 | .PHONY: fmt 32 | fmt: 33 | npx prettier --write "scratch-arduino-extensions/**/*.{js,jsx,ts,tsx,json,css,scss,md}" 34 | find . -name '*.ino' -or -name '*.cpp' -or -name '*.h' | xargs clang-format -i 35 | 36 | .PHONY: fmt-check 37 | fmt-check: 38 | npx prettier --check "scratch-arduino-extensions/**/*.{js,jsx,ts,tsx,json,css,scss,md}" 39 | find . -name '*.ino' -or -name '*.cpp' -or -name '*.h' | xargs clang-format -n -Werror 40 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # include-robot 2 | 3 | Experimental software and hardware project by Arduino 4 | 5 | Instructions: 6 | 7 | 1. Read [required parts](doc/parts.md) 8 | 2. Execute 3D printing of the robot shell - coming soon 9 | 3. Mount the robot following [mounting instructions](doc/mounting.md) 10 | 4. Upload base firmware on the robot using [Arduino IDE](https://arduino.cc/software) (sketches can be found in the /sketches folder of this repo) 11 | 5. Open [Arduino lab for Scratch](https://labs-scratch.arduino.cc) and program your robot 12 | 6. Have fun! 13 | 14 | 15 | ## Development 16 | 17 | ### How to install Scratch locally with Arduino extensions 18 | 19 | If you want to install and launch Scratch on your local machine for development purposes you need to 20 | follow the instructions in [scratch-arduino-extensions](./scratch-arduino-extensions/README.md) folder. 21 | 22 | #### How to install Scratch3-Arduino-Extensions 23 | 24 | Scratch is a free programming platform where you can create your own interactive stories, games, and animations. 25 | 26 | If you want to connect to an Arduino board via Bluetooth Low Energy (BLE) you need to install a couple of 27 | Arduino specific extensions. 28 | 29 | Then you need to install Scratch link (https://scratch.mit.edu/download/scratch-link) which allows you to 30 | connect your Scratch project to a BLE device. 31 | 32 | ## Development guide 33 | 34 | 1. Clone and install the scratch-gui repository 35 | ``` 36 | make init 37 | ``` 38 | to install everything needed for the project or 39 | ``` 40 | make scratch-gui-install 41 | ``` 42 | to install only the stuff related with the Scratch GUI. 43 | 44 | 2. Then apply the patches 45 | 46 | ``` 47 | make scratch-gui-patch 48 | ``` 49 | ### Notes about patch scripts 50 | 51 | 1. the `patch-gui.js` script copies a custom Arduino extension in the extensions folder and modifies the code of 52 | Scratch's extension manager to include that extension 53 | 54 | 2. the `add-banner.js` script copies a new React component in the `scratch-gui` folder and modifies the `gui.jsx` file 55 | to include that component 56 | 57 | 3. Finally, start the local server at `http://127.0.0.1:8601` 58 | ``` 59 | make scratch-gui-start 60 | ``` 61 | 62 | 4. To remove and clean the scratch-gui directory 63 | ``` 64 | make scratch-gui-clean 65 | ``` 66 | 67 | 68 | -------------------------------------------------------------------------------- /doc/mounting.md: -------------------------------------------------------------------------------- 1 | # Mounting instructions 2 | | Step | Image | 3 | | --- | --- | 4 | | Fix the leg of the robot to the bottom part of the case | | 5 | | Add the roller ball to help in the moving | | 6 | | Set the two motors in place | | 7 | | Put the motors cover and fix it with the screws | | 8 | | Set out the wheels and fix them with the body of the robot | | 9 | | Attach the Nano IoT board to the carrier by putting headers in the right place | | 10 | | Add a wire to bring power to the servomotor part of the carrier board (VIN screw = red cable, GND screw = black cable) | | 11 | | Connect the two motors to the carrier board as follows: left cable at 9, right cable at 10 | | 12 | | Set the batteries in the holder and together inside near to the motors | | 13 | | Add the carrier board on top of the battery holder and motors | | 14 | | Fix the proximity sensors ("eyes") in the top part of the robot | | 15 | | Connec the proximity sensor to ??????????? | xxxx | 16 | | Close the top part | | 17 | 18 | 19 | ## Wiring with a Breadboard 20 | 21 | The robot can be assembled using a breadboard. 22 | 23 | | Type | Image | 24 | | --- | --- | 25 | | Schematic | | 26 | | Breadboard preview | | 27 | | Final robot wiring | | 28 | -------------------------------------------------------------------------------- /doc/parts.md: -------------------------------------------------------------------------------- 1 | # Required parts 2 | 3 | The robot consists of multiple parts. 4 | 5 | Case components: 6 | | Component | Image | 7 | | --- | --- | 8 | | The top and the bottom of the robot | | 9 | | Two wheels compatible with Feetech FS90R servos.
E.g. https://www.pololu.com/product/4910 | | 10 | | The leg/stand of the robot | | 11 | | The cover/holder of the motor | | 12 | | Roller ball 10mm diameter | | 13 | 14 | 15 | Electronics: 16 | | Component | Image | 17 | | --- | --- | 18 | | Main board: Arduino Nano 33 IoT with headers https://docs.arduino.cc/hardware/nano-33-iot | | 19 | | Carrier board: DFRobots DFR0012 https://wiki.dfrobot.com/Arduino_Nano_IO_Shield__SKU__DFR0012_ | | 20 | | Eyes of the robot: proximity sensors SRF05 https://www.robot-electronics.co.uk/htm/srf05tech.htm | | 21 | | Two motors Feetech FS90R | | 22 | | Self Tapping Screws | | 23 | | Battery compartment for 4 AA 1.5V | | 24 | 25 | Software: 26 | * to prepare the robot: Arduino IDE https://www.arduino.cc/en/software 27 | * to program the robot interactively: online Scratch app modified to support this robot available at [Arduino Scratch lab](https://labs-scratch.arduino.cc/) 28 | -------------------------------------------------------------------------------- /doc/pictures/image1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image1.jpg -------------------------------------------------------------------------------- /doc/pictures/image10.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image10.jpg -------------------------------------------------------------------------------- /doc/pictures/image11.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image11.jpg -------------------------------------------------------------------------------- /doc/pictures/image12.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image12.jpg -------------------------------------------------------------------------------- /doc/pictures/image13.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image13.jpg -------------------------------------------------------------------------------- /doc/pictures/image14.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image14.jpg -------------------------------------------------------------------------------- /doc/pictures/image15.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image15.jpg -------------------------------------------------------------------------------- /doc/pictures/image16.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image16.jpg -------------------------------------------------------------------------------- /doc/pictures/image17.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image17.jpg -------------------------------------------------------------------------------- /doc/pictures/image18.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image18.jpg -------------------------------------------------------------------------------- /doc/pictures/image19.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image19.jpg -------------------------------------------------------------------------------- /doc/pictures/image2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image2.jpg -------------------------------------------------------------------------------- /doc/pictures/image20.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image20.jpg -------------------------------------------------------------------------------- /doc/pictures/image21.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image21.jpg -------------------------------------------------------------------------------- /doc/pictures/image22.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image22.jpg -------------------------------------------------------------------------------- /doc/pictures/image23.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image23.jpg -------------------------------------------------------------------------------- /doc/pictures/image24.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image24.jpg -------------------------------------------------------------------------------- /doc/pictures/image25.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image25.jpg -------------------------------------------------------------------------------- /doc/pictures/image26.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image26.jpg -------------------------------------------------------------------------------- /doc/pictures/image27.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image27.jpg -------------------------------------------------------------------------------- /doc/pictures/image28.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image28.jpg -------------------------------------------------------------------------------- /doc/pictures/image29.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image29.jpg -------------------------------------------------------------------------------- /doc/pictures/image3.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image3.jpg -------------------------------------------------------------------------------- /doc/pictures/image30.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image30.jpg -------------------------------------------------------------------------------- /doc/pictures/image31.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image31.jpg -------------------------------------------------------------------------------- /doc/pictures/image32.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image32.jpg -------------------------------------------------------------------------------- /doc/pictures/image33.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image33.jpg -------------------------------------------------------------------------------- /doc/pictures/image4.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image4.jpg -------------------------------------------------------------------------------- /doc/pictures/image5.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image5.jpg -------------------------------------------------------------------------------- /doc/pictures/image6.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image6.jpg -------------------------------------------------------------------------------- /doc/pictures/image7.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image7.jpg -------------------------------------------------------------------------------- /doc/pictures/image8.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image8.jpg -------------------------------------------------------------------------------- /doc/pictures/image9.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/image9.jpg -------------------------------------------------------------------------------- /doc/pictures/t.txt: -------------------------------------------------------------------------------- 1 | empty 2 | -------------------------------------------------------------------------------- /doc/pictures/wiring_breadboard.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/wiring_breadboard.jpg -------------------------------------------------------------------------------- /doc/pictures/wiring_robot.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/wiring_robot.jpg -------------------------------------------------------------------------------- /doc/pictures/wiring_schematic.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/doc/pictures/wiring_schematic.png -------------------------------------------------------------------------------- /installer/.eslintignore: -------------------------------------------------------------------------------- 1 | src-tauri 2 | node_modules 3 | resources -------------------------------------------------------------------------------- /installer/.eslintrc.cjs: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | env: { 3 | browser: true, 4 | es2021: true, 5 | }, 6 | extends: [ 7 | 'airbnb', 8 | 'eslint:recommended', 9 | 'plugin:react/recommended', 10 | 'plugin:prettier/recommended', 11 | 'prettier', 12 | ], 13 | overrides: [ 14 | { 15 | env: { 16 | node: true, 17 | }, 18 | files: ['.eslintrc.{js,cjs}'], 19 | parserOptions: { 20 | sourceType: 'script', 21 | }, 22 | }, 23 | ], 24 | parserOptions: { 25 | ecmaVersion: 'latest', 26 | sourceType: 'module', 27 | }, 28 | rules: { 29 | 'react/react-in-jsx-scope': 'off', 30 | 'react/prop-types': 'off', 31 | 'no-console': 'off', 32 | 'import/no-extraneous-dependencies': [ 33 | 'error', 34 | { devDependencies: true }, 35 | ], 36 | }, 37 | }; 38 | -------------------------------------------------------------------------------- /installer/.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | pnpm-debug.log* 8 | lerna-debug.log* 9 | 10 | node_modules 11 | dist 12 | dist-ssr 13 | *.local 14 | 15 | # Editor directories and files 16 | .vscode/* 17 | !.vscode/extensions.json 18 | .idea 19 | .DS_Store 20 | *.suo 21 | *.ntvs* 22 | *.njsproj 23 | *.sln 24 | *.sw? 25 | 26 | resources/ 27 | -------------------------------------------------------------------------------- /installer/.prettierignore: -------------------------------------------------------------------------------- 1 | src-tauri 2 | node_modules 3 | resources -------------------------------------------------------------------------------- /installer/.prettierrc.cjs: -------------------------------------------------------------------------------- 1 | /** @type {import("prettier").Config} */ 2 | const config = { 3 | trailingComma: 'es5', 4 | tabWidth: 4, 5 | singleQuote: true, 6 | }; 7 | 8 | module.exports = config; 9 | -------------------------------------------------------------------------------- /installer/README.md: -------------------------------------------------------------------------------- 1 | # How to use this app 2 | 3 | ## Prerequisites: 4 | 5 | - rustc 1.89 6 | - node 18 7 | 8 | ## Installation 9 | 10 | Install dependencies with 11 | 12 | ```sh 13 | npm install 14 | ``` 15 | 16 | ## Development 17 | 18 | Run development version with command: 19 | 20 | ```sh 21 | npm run tauri dev 22 | ``` 23 | 24 | Note: at the moment it works **only on a Mac Intel**, due to the presence of only the Mac version of the Arduino CLI in folder `resources/arduino-cli/` 25 | 26 | If you want to run it on other platforms, just add the right "sidecar" binary 27 | as explained here: 28 | https://tauri.app/v1/guides/building/sidecar 29 | 30 | Please see the section which starts with 31 | 32 | > A binary with the same name and a -$TARGET_TRIPLE suffix must exist on the specified path. 33 | 34 | ## Build 35 | 36 | The following command will produce a .dmg file on a Mac 37 | 38 | ```sh 39 | npm run tauri build 40 | ``` 41 | 42 | --- 43 | 44 | # Tauri + React 45 | 46 | This template should help get you started developing with Tauri and React in Vite. 47 | 48 | ## Recommended IDE Setup 49 | 50 | - [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) 51 | -------------------------------------------------------------------------------- /installer/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | Tauri + React 8 | 9 | 10 | 11 |
12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /installer/lefthook.yml.sample: -------------------------------------------------------------------------------- 1 | # EXAMPLE USAGE 2 | # Refer for explanation to following link: 3 | # https://github.com/evilmartians/lefthook/blob/master/docs/full_guide.md 4 | # 5 | # pre-push: 6 | # commands: 7 | # packages-audit: 8 | # tags: frontend security 9 | # run: yarn audit 10 | # gems-audit: 11 | # tags: backend security 12 | # run: bundle audit 13 | # 14 | # pre-commit: 15 | # parallel: true 16 | # commands: 17 | # eslint: 18 | # glob: "*.{js,ts}" 19 | # run: yarn eslint {staged_files} 20 | # rubocop: 21 | # tags: backend style 22 | # glob: "*.rb" 23 | # exclude: "application.rb|routes.rb" 24 | # run: bundle exec rubocop --force-exclusion {all_files} 25 | # govet: 26 | # tags: backend style 27 | # files: git ls-files -m 28 | # glob: "*.go" 29 | # run: go vet {files} 30 | # scripts: 31 | # "hello.js": 32 | # runner: node 33 | # "any.go": 34 | # runner: go run 35 | -------------------------------------------------------------------------------- /installer/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "myra-installer", 3 | "private": true, 4 | "version": "0.0.0", 5 | "type": "module", 6 | "scripts": { 7 | "dev": "vite", 8 | "build": "vite build", 9 | "preview": "vite preview", 10 | "tauri": "tauri", 11 | "lint": "eslint src/**/*.{js,jsx} --max-warnings=0", 12 | "format": "prettier src/**/*.{js,jsx} --write" 13 | }, 14 | "dependencies": { 15 | "@tauri-apps/api": "^1", 16 | "react": "^18.2.0", 17 | "react-dom": "^18.2.0", 18 | "react-tooltip": "^5.26.3" 19 | }, 20 | "devDependencies": { 21 | "@arkweid/lefthook": "^0.7.7", 22 | "@tauri-apps/cli": "^1", 23 | "@vitejs/plugin-react": "^4.2.1", 24 | "autoprefixer": "^10.4.18", 25 | "eslint": "^8.57.0", 26 | "eslint-config-airbnb": "^19.0.4", 27 | "eslint-config-prettier": "^9.1.0", 28 | "eslint-plugin-import": "^2.29.1", 29 | "eslint-plugin-jsx-a11y": "^6.8.0", 30 | "eslint-plugin-prettier": "^5.1.3", 31 | "eslint-plugin-react": "^7.34.1", 32 | "eslint-plugin-react-hooks": "^4.6.0", 33 | "postcss": "^8.4.35", 34 | "prettier": "^3.2.5", 35 | "tailwindcss": "^3.4.1", 36 | "vite": "^5.0.0" 37 | } 38 | } 39 | -------------------------------------------------------------------------------- /installer/postcss.config.js: -------------------------------------------------------------------------------- 1 | export default { 2 | plugins: { 3 | tailwindcss: {}, 4 | autoprefixer: {}, 5 | }, 6 | }; 7 | -------------------------------------------------------------------------------- /installer/public/128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/public/128x128.png -------------------------------------------------------------------------------- /installer/public/tauri.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /installer/src-tauri/.gitignore: -------------------------------------------------------------------------------- 1 | # Generated by Cargo 2 | # will have compiled files and executables 3 | /target/ 4 | 5 | -------------------------------------------------------------------------------- /installer/src-tauri/Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "myra-installer" 3 | version = "0.0.0" 4 | description = "Arduino Myra Robot Installer" 5 | authors = ["you"] 6 | edition = "2021" 7 | 8 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 9 | 10 | [build-dependencies] 11 | tauri-build = { version = "1", features = [] } 12 | reqwest = { version = "0.11", features = ["blocking"] } 13 | tar = "0.4" 14 | flate2 = "1.0" 15 | zip = "0.5" 16 | bytes = "1.5.0" 17 | anyhow = "1.0" 18 | 19 | [dependencies] 20 | rmp-serde = "1.1.2" 21 | thiserror = "1.0.58" 22 | tauri = { version = "1", features = [ 23 | "window-set-min-size", 24 | "window-set-fullscreen", 25 | "os-all", 26 | "path-all", 27 | "fs-read-file", 28 | "shell-sidecar", 29 | "shell-open", 30 | ] } 31 | serde = { version = "1", features = ["derive"] } 32 | serde_json = "1" 33 | 34 | [features] 35 | # This feature is used for production builds or when a dev server is not specified, DO NOT REMOVE!! 36 | custom-protocol = ["tauri/custom-protocol"] 37 | -------------------------------------------------------------------------------- /installer/src-tauri/build.rs: -------------------------------------------------------------------------------- 1 | use anyhow; 2 | use bytes::Bytes; 3 | use flate2::read::GzDecoder; 4 | use reqwest; 5 | use std::borrow::Cow; 6 | use std::env; 7 | use std::fs; 8 | use std::io; 9 | use std::path; 10 | use std::path::PathBuf; 11 | use std::process::Command; 12 | use zip::read::ZipArchive; 13 | 14 | const ARDUINO_CLI_VERSION: &str = "0.35.3"; 15 | 16 | fn main() { 17 | let base_dir = PathBuf::from(env::var("CARGO_MANIFEST_DIR").unwrap()); 18 | 19 | let resource_dir = base_dir.join("../resources"); 20 | 21 | download_resources( &resource_dir,&[ 22 | Resource { 23 | name: "arduino-cli".into(), 24 | url: format!("https://github.com/arduino/arduino-cli/releases/download/v{0}/arduino-cli_{0}_Linux_64bit.tar.gz", ARDUINO_CLI_VERSION).into(), 25 | file: "arduino-cli-x86_64-unknown-linux-gnu".into(), 26 | download: unpack_tar, 27 | }, 28 | Resource { 29 | name: "arduino-cli".into(), 30 | url: format!("https://github.com/arduino/arduino-cli/releases/download/v{0}/arduino-cli_{0}_macOS_64bit.tar.gz", ARDUINO_CLI_VERSION).into(), 31 | file: "arduino-cli-x86_64-apple-darwin".into(), 32 | download: unpack_tar, 33 | }, 34 | Resource { 35 | name: "arduino-cli".into(), 36 | url: format!("https://github.com/arduino/arduino-cli/releases/download/v{0}/arduino-cli_{0}_macOS_arm64.tar.gz", ARDUINO_CLI_VERSION).into(), 37 | file: "arduino-cli-aarch64-apple-darwin".into(), 38 | download: unpack_tar, 39 | }, 40 | Resource { 41 | name: "arduino-cli.exe".into(), 42 | url: format!("https://github.com/arduino/arduino-cli/releases/download/v{0}/arduino-cli_{0}_Windows_64bit.zip", ARDUINO_CLI_VERSION).into(), 43 | file: "arduino-cli-x86_64-pc-windows-msvc.exe".into(), 44 | download: unpack_zip, 45 | } 46 | ]).expect("Failed to download resources"); 47 | 48 | let arduino_cli = get_arduino_cli_path(&resource_dir); 49 | 50 | let sketches = base_dir.join("../../sketches/BLE_Scratch/BLE_Scratch.ino"); 51 | 52 | compile_sketch( 53 | &arduino_cli, 54 | &sketches, 55 | &resource_dir.join("sketch.bin"), 56 | "arduino:mbed_nano:nano33ble", 57 | ) 58 | .expect("Failed to compile sketch"); 59 | 60 | println!("cargo:rerun-if-changed={}", sketches.to_str().unwrap()); 61 | 62 | tauri_build::build() 63 | } 64 | 65 | struct Resource { 66 | name: Cow<'static, str>, 67 | url: Cow<'static, str>, 68 | file: Cow<'static, str>, 69 | download: fn(Bytes, &path::Path, &Resource) -> anyhow::Result<()>, 70 | } 71 | 72 | fn download_resources(base_dir: &path::Path, resources: &[Resource]) -> anyhow::Result<()> { 73 | let resource_dir = base_dir.join("arduino-cli"); 74 | 75 | println!("Download resources to {:?}", resource_dir); 76 | 77 | fs::create_dir_all(&resource_dir)?; 78 | 79 | for resource in resources.iter() { 80 | let file_path = resource_dir.join(resource.file.as_ref()); 81 | if !file_path.exists() { 82 | println!("Downloading {}", resource.file.as_ref()); 83 | let bytes = reqwest::blocking::get(resource.url.as_ref()) 84 | .unwrap() 85 | .bytes() 86 | .unwrap(); 87 | 88 | println!("Unpacking {}", resource.file.as_ref()); 89 | (resource.download)(bytes, &resource_dir, resource)?; 90 | } 91 | } 92 | 93 | Ok(()) 94 | } 95 | 96 | fn get_arduino_cli_path(resource_dir: &path::Path) -> PathBuf { 97 | let target_triplet = std::env::var("TARGET").unwrap(); 98 | 99 | return resource_dir 100 | .join("arduino-cli") 101 | .join(format!("arduino-cli-{}", target_triplet)); 102 | } 103 | 104 | fn compile_sketch( 105 | arduino_cli: &path::Path, 106 | sketch: &path::Path, 107 | to: &path::Path, 108 | fqbn: &str, 109 | ) -> anyhow::Result<()> { 110 | if to.exists() && fs::metadata(to)?.modified()? >= fs::metadata(sketch)?.modified()? { 111 | println!("Binary up to date"); 112 | 113 | return Ok(()); 114 | } 115 | 116 | println!("Compiling sketch '{}'", sketch.to_str().unwrap_or_default()); 117 | 118 | let profile = fqbn.rsplit(':').next().unwrap(); 119 | 120 | let output = Command::new(arduino_cli) 121 | .args(&[ 122 | "compile", 123 | "-e", 124 | "--profile", 125 | profile, 126 | sketch.to_str().unwrap(), 127 | ]) 128 | .output()?; 129 | println!( 130 | "compilation output:\n{}\n{}", 131 | String::from_utf8_lossy(&output.stderr), 132 | String::from_utf8_lossy(&output.stdout), 133 | ); 134 | 135 | if !output.status.success() { 136 | return Err(anyhow::anyhow!("Compilation failed")); 137 | } 138 | 139 | let path_fqbn: String = fqbn 140 | .chars() 141 | .map(|c| if c == ':' { '.' } else { c }) 142 | .collect(); 143 | 144 | let dir = sketch.parent().unwrap(); 145 | let file = sketch.file_name().unwrap(); 146 | let bin = dir 147 | .join("build") 148 | .join(path_fqbn) 149 | .join(file) 150 | .with_extension("ino.bin"); 151 | 152 | println!("Copying {:?} binary to {:?}", bin, to); 153 | fs::copy(bin, to)?; 154 | 155 | Ok(()) 156 | } 157 | 158 | fn unpack_tar(bytes: Bytes, resource_dir: &path::Path, resource: &Resource) -> anyhow::Result<()> { 159 | let reader = io::Cursor::new(bytes); 160 | 161 | let tar = GzDecoder::new(reader); 162 | let mut archive = tar::Archive::new(tar); 163 | 164 | for file in archive.entries()? { 165 | let mut file = file?; 166 | if file.path()?.ends_with(resource.name.as_ref()) { 167 | file.unpack_in(&resource_dir)?; 168 | fs::rename( 169 | resource_dir.join(resource.name.as_ref()), 170 | resource_dir.join(resource.file.as_ref()), 171 | )? 172 | } 173 | } 174 | 175 | Ok(()) 176 | } 177 | 178 | fn unpack_zip(bytes: Bytes, resource_dir: &path::Path, resource: &Resource) -> anyhow::Result<()> { 179 | let reader = io::Cursor::new(bytes); 180 | 181 | let mut archive = ZipArchive::new(reader)?; 182 | 183 | for i in 0..archive.len() { 184 | let mut file = archive.by_index(i)?; 185 | if file.name() == resource.name.as_ref() { 186 | let mut outfile = fs::File::create(&resource_dir.join(resource.file.as_ref()))?; 187 | io::copy(&mut file, &mut outfile)?; 188 | } 189 | } 190 | 191 | Ok(()) 192 | } 193 | -------------------------------------------------------------------------------- /installer/src-tauri/icons/128x128.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/128x128.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/128x128@2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/128x128@2x.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/32x32.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/32x32.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/Square107x107Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/Square107x107Logo.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/Square142x142Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/Square142x142Logo.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/Square150x150Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/Square150x150Logo.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/Square284x284Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/Square284x284Logo.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/Square30x30Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/Square30x30Logo.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/Square310x310Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/Square310x310Logo.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/Square44x44Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/Square44x44Logo.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/Square71x71Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/Square71x71Logo.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/Square89x89Logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/Square89x89Logo.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/StoreLogo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/StoreLogo.png -------------------------------------------------------------------------------- /installer/src-tauri/icons/icon.icns: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/icon.icns -------------------------------------------------------------------------------- /installer/src-tauri/icons/icon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/icon.ico -------------------------------------------------------------------------------- /installer/src-tauri/icons/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/arduino/include-robot/82a5a7a5defbe2a988a242d67b64f37b63f2d752/installer/src-tauri/icons/icon.png -------------------------------------------------------------------------------- /installer/src-tauri/src/main.rs: -------------------------------------------------------------------------------- 1 | // Prevents additional console window on Windows in release, DO NOT REMOVE!! 2 | #![cfg_attr(not(debug_assertions), windows_subsystem = "windows")] 3 | 4 | use std::fmt::Debug; 5 | use std::fs::{self, File, OpenOptions}; 6 | use std::io; 7 | use std::io::Write; 8 | use std::path::Path; 9 | use std::path::PathBuf; 10 | 11 | use serde::{Deserialize, Serialize}; 12 | use thiserror::Error; 13 | 14 | // Learn more about Tauri commands at https://tauri.app/v1/guides/features/command 15 | #[tauri::command] 16 | fn greet(name: &str) -> String { 17 | format!("Hello, {}! You've been greeted from Rust!", name) 18 | } 19 | 20 | const HEADER: &[u8] = b"\x8a\x48\x92\xdf\xaa\x69\x5c\x41"; 21 | const MAGIC: &[u8] = b"\x7f"; 22 | 23 | #[derive(Debug, Error)] 24 | enum CmdError { 25 | #[error("io error: {0}")] 26 | Io(#[from] io::Error), 27 | #[error("msgpack encode error: {0}")] 28 | Encode(#[from] rmp_serde::encode::Error), 29 | #[error("fail to resolve '{0}'")] 30 | Resolve(&'static str), 31 | } 32 | 33 | // we must manually implement serde::Serialize 34 | impl serde::Serialize for CmdError { 35 | fn serialize(&self, serializer: S) -> Result 36 | where 37 | S: serde::ser::Serializer, 38 | { 39 | serializer.serialize_str(self.to_string().as_ref()) 40 | } 41 | } 42 | 43 | // Config order should match the order in the Arduino sketch, because we are using msgpack array. 44 | #[derive(Debug, Serialize, Deserialize)] 45 | struct Config { 46 | ble_name: String, 47 | left_servo: u8, 48 | right_servo: u8, 49 | } 50 | 51 | #[tauri::command] 52 | fn append_config( 53 | app_handle: tauri::AppHandle, 54 | bin_path: &Path, 55 | config: Config, 56 | ) -> Result { 57 | let path = app_handle.path_resolver(); 58 | 59 | let config_buf = rmp_serde::to_vec(&config)?; 60 | 61 | let src_path = path 62 | .resolve_resource(bin_path) 63 | .ok_or(CmdError::Resolve("source path"))?; 64 | 65 | let cache_dir = path 66 | .app_cache_dir() 67 | .ok_or(CmdError::Resolve("cache dir path"))?; 68 | 69 | fs::create_dir_all(&cache_dir)?; 70 | 71 | let dst_path = cache_dir.join("sketch.cfg.bin"); 72 | 73 | let mut src = File::open(src_path)?; 74 | let mut dst = OpenOptions::new() 75 | .write(true) 76 | .create(true) 77 | .truncate(true) 78 | .open(&dst_path)?; 79 | 80 | io::copy(&mut src, &mut dst)?; 81 | dst.write_all(HEADER)?; 82 | dst.write_all(MAGIC)?; 83 | dst.write_all(&config_buf)?; 84 | 85 | Ok(dst_path.to_owned()) 86 | } 87 | 88 | fn main() { 89 | tauri::Builder::default() 90 | .invoke_handler(tauri::generate_handler![greet]) 91 | .invoke_handler(tauri::generate_handler![append_config]) 92 | .run(tauri::generate_context!()) 93 | .expect("error while running tauri application"); 94 | } 95 | -------------------------------------------------------------------------------- /installer/src-tauri/tauri.conf.json: -------------------------------------------------------------------------------- 1 | { 2 | "build": { 3 | "beforeDevCommand": "npm run dev", 4 | "beforeBuildCommand": "npm run build", 5 | "devPath": "http://localhost:1420", 6 | "distDir": "../dist" 7 | }, 8 | "package": { 9 | "productName": "Arduino Myra Robot Installer", 10 | "version": "0.0.0" 11 | }, 12 | "tauri": { 13 | "allowlist": { 14 | "all": false, 15 | "path": { 16 | "all": true 17 | }, 18 | "os": { 19 | "all": true 20 | }, 21 | "window": { 22 | "setMinSize": true, 23 | "setFullscreen": true 24 | }, 25 | "shell": { 26 | "sidecar": true, 27 | "scope": [ 28 | { 29 | "name": "../resources/arduino-cli/arduino-cli", 30 | "sidecar": true, 31 | "args": true 32 | } 33 | ], 34 | "all": false, 35 | "open": true 36 | }, 37 | "fs": { 38 | "scope": [ 39 | "$RESOURCE/sketch.bin" 40 | ], 41 | "readFile": true 42 | } 43 | }, 44 | "windows": [ 45 | { 46 | "title": "Arduino Myra Robot Installer", 47 | "width": 1000, 48 | "height": 800, 49 | "minWidth": 1000, 50 | "minHeight": 800 51 | 52 | } 53 | ], 54 | "security": { 55 | "csp": null 56 | }, 57 | "bundle": { 58 | "resources": [ 59 | "../resources/sketch.bin" 60 | ], 61 | "externalBin": [ 62 | "../resources/arduino-cli/arduino-cli" 63 | ], 64 | "active": true, 65 | "targets": "all", 66 | "identifier": "cc.arduino.myra-installer", 67 | "icon": [ 68 | "icons/32x32.png", 69 | "icons/128x128.png", 70 | "icons/128x128@2x.png", 71 | "icons/icon.icns", 72 | "icons/icon.ico" 73 | ] 74 | } 75 | } 76 | } -------------------------------------------------------------------------------- /installer/src/App.css: -------------------------------------------------------------------------------- 1 | input[type='number']::-webkit-inner-spin-button, 2 | input[type='number']::-webkit-outer-spin-button { 3 | opacity: 0; 4 | } 5 | -------------------------------------------------------------------------------- /installer/src/App.jsx: -------------------------------------------------------------------------------- 1 | import { invoke } from '@tauri-apps/api/tauri'; 2 | import { useEffect, useReducer, useRef, useState } from 'react'; 3 | import FormControl from './components/FormControl'; 4 | import LoadingButton from './components/LoadingButton'; 5 | import reducer from './reducers/state-reducer'; 6 | import supportedBoards from './supported-boards'; 7 | import { 8 | getBoards, 9 | getVersion as getVersionFromCLI, 10 | upload, 11 | installRequiredCores, 12 | } from './services/arduino-cli'; 13 | 14 | import './App.css'; 15 | 16 | function App() { 17 | // these properties are not part of the "internal state" of the component (preferential) 18 | const [version, setVersion] = useState(''); 19 | const [name, setName] = useState(''); 20 | const [leftServo, setLeftServo] = useState(3); 21 | const [rightServo, setRightServo] = useState(4); 22 | 23 | const textAreaRef = useRef(null); 24 | const initialState = { 25 | stdout: '', // stdout (or stderr) as provided by the arduino-cli 26 | code: null, // code as provided by the arduino-cli 27 | boards: [], 28 | selectedBoard: null, 29 | uploading: false, 30 | uploadButtonEnabled: false, 31 | error: null, 32 | }; 33 | 34 | const [state, dispatch] = useReducer(reducer, initialState); 35 | 36 | const handleError = (error) => dispatch({ type: 'GENERIC_ERROR', error }); 37 | 38 | useEffect(() => { 39 | textAreaRef.current.scrollTop = textAreaRef.current.scrollHeight; 40 | }, [state.stdout]); 41 | 42 | /* writes the version of the CLI at mount time */ 43 | useEffect(() => { 44 | const writeVersion = async () => { 45 | const versionString = await getVersionFromCLI(); 46 | setVersion(versionString); 47 | }; 48 | writeVersion().catch(handleError); 49 | }, []); 50 | 51 | /* Checking if there are connected boards every 3 seconds */ 52 | useEffect(() => { 53 | const interval = setInterval(async () => { 54 | await getBoards({ 55 | fqbnList: supportedBoards.map( 56 | (supportedBoard) => supportedBoard.fqbn 57 | ), 58 | onBoardRetrieved: (connectedBoards) => 59 | dispatch({ 60 | type: 'BOARDS_RETRIEVED', 61 | boards: connectedBoards, 62 | }), 63 | onBoardDisconnected: () => 64 | dispatch({ type: 'BOARDS_DISCONNECTED' }), 65 | onError: handleError, 66 | }); 67 | }, 2000); 68 | 69 | return () => clearInterval(interval); 70 | }, []); 71 | 72 | const updateLeftServo = (ev) => { 73 | setLeftServo(Number(ev.currentTarget.value)); 74 | }; 75 | const updateRightServo = (ev) => { 76 | setRightServo(Number(ev.currentTarget.value)); 77 | }; 78 | 79 | const updateName = (ev) => { 80 | setName(ev.currentTarget.value); 81 | }; 82 | 83 | const onData = (line) => dispatch({ type: 'APPEND_STDOUT', stdout: line }); 84 | 85 | const onUploadFinished = (data) => { 86 | if (data.code === 0) { 87 | dispatch({ 88 | type: 'UPLOAD_COMPLETE', 89 | code: data.code, // atm code is not used 90 | }); 91 | } else { 92 | dispatch({ 93 | type: 'GENERIC_ERROR', 94 | error: new Error('Error uploading sketch'), 95 | }); 96 | } 97 | }; 98 | 99 | const asyncUpload = async () => { 100 | dispatch({ type: 'UPLOAD_STARTED' }); 101 | let board; 102 | let dstPath; 103 | try { 104 | board = state.boards.find((x) => x.name === state.selectedBoard); 105 | dstPath = await invoke('append_config', { 106 | binPath: '../resources/sketch.bin', 107 | config: { 108 | ble_name: name, 109 | left_servo: leftServo, 110 | right_servo: rightServo, 111 | }, 112 | }); 113 | } catch (error) { 114 | handleError(error); 115 | return; 116 | } 117 | 118 | dispatch({ 119 | type: 'APPEND_STDOUT', 120 | stdout: 'Checking installed Arduino cores', 121 | }); 122 | 123 | try { 124 | await installRequiredCores({ 125 | // `...new Set()` removes duplicate plaforms 126 | fqbnList: [ 127 | ...new Set( 128 | supportedBoards.map( 129 | (supportedBoard) => supportedBoard.platform 130 | ) 131 | ), 132 | ], 133 | onData, 134 | }); 135 | } catch (error) { 136 | handleError(error); 137 | return; 138 | } 139 | 140 | const uploadMsg = `Uploading binary ${dstPath.split(/.*[/|\\]/)[1]} to ${board.port}\n`; 141 | dispatch({ type: 'APPEND_STDOUT', stdout: uploadMsg }); 142 | 143 | try { 144 | await upload({ 145 | dstPath, 146 | fqbn: board.fqbn, 147 | port: board.port, 148 | onData, 149 | onClose: onUploadFinished, 150 | onError: handleError, 151 | }); 152 | } catch (error) { 153 | handleError(error); 154 | } 155 | }; 156 | 157 | const selectBoard = (ev) => { 158 | const selectedBoard = ev.target.value; 159 | dispatch({ type: 'BOARDS_SELECTED', selectedBoard }); 160 | }; 161 | 162 | return ( 163 |
164 |
165 |
166 |

167 | Myra Robot logo 174 | Myra Robot Installer 175 |

176 | 177 |

178 | Install the software you need to interact with Scratch 179 | via Bluetooth (BLE) on your Arduino 180 |

181 |

182 | Check out{' '} 183 | 189 | our documentation 190 | 191 |

192 |
{ 194 | e.preventDefault(); 195 | asyncUpload(); 196 | }} 197 | > 198 | 206 | 214 | 222 | 223 |
224 |
225 |
226 | 227 | Available boards 228 | 229 | * 230 | 231 | 232 |
233 |
234 | {state.boards.length ? ( 235 | state.boards.map((board) => ( 236 |
240 | 250 | 256 |
257 | )) 258 | ) : ( 259 |
260 | No boards found 261 |
262 | )} 263 |
264 |
265 |
266 |
267 |
268 |
269 | 273 |
274 |
275 | 276 | {state.error && ( 277 |

278 | {state.error?.message} 279 |

280 | )} 281 |