├── .gitignore ├── rename-readme.rhai ├── rust-toolchain.toml ├── cargo-generate.toml ├── LICENSE-MIT ├── .cargo └── config.toml ├── README-template.md ├── src └── main.rs ├── Cargo.toml ├── README.md ├── Ravedude.toml └── LICENSE-APACHE /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | -------------------------------------------------------------------------------- /rename-readme.rhai: -------------------------------------------------------------------------------- 1 | file::rename("README-template.md", "README.md"); 2 | -------------------------------------------------------------------------------- /rust-toolchain.toml: -------------------------------------------------------------------------------- 1 | [toolchain] 2 | channel = "nightly-2025-04-27" 3 | components = ["rust-src"] 4 | profile = "minimal" 5 | -------------------------------------------------------------------------------- /cargo-generate.toml: -------------------------------------------------------------------------------- 1 | [placeholders.board] 2 | type = "string" 3 | prompt = "Which board do you use?" 4 | choices = [ 5 | "Adafruit Trinket", 6 | "Adafruit Trinket Pro", 7 | "Arduino Leonardo", 8 | "Arduino Mega 2560", 9 | "Arduino Mega 1280", 10 | "Arduino Nano", 11 | "Arduino Nano New Bootloader", 12 | "Arduino Uno", 13 | "SparkFun ProMicro", 14 | "SparkFun ProMini 3v3", 15 | "SparkFun ProMini 5v", 16 | "Nano168", 17 | ] 18 | default = "Arduino Uno" 19 | 20 | [template] 21 | ignore=["README.md"] 22 | 23 | [hooks] 24 | post = ["rename-readme.rhai"] 25 | -------------------------------------------------------------------------------- /LICENSE-MIT: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) [year] [fullname] 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /.cargo/config.toml: -------------------------------------------------------------------------------- 1 | [build] 2 | target = "avr-none" 3 | {% case board -%} 4 | {%- when "Adafruit Trinket" -%} 5 | rustflags = ["-C", "target-cpu=attiny85"] 6 | {%- when "Adafruit Trinket Pro" -%} 7 | rustflags = ["-C", "target-cpu=atmega328p"] 8 | {%- when "Arduino Leonardo" -%} 9 | rustflags = ["-C", "target-cpu=atmega32u4"] 10 | {%- when "Arduino Mega 2560" -%} 11 | rustflags = ["-C", "target-cpu=atmega2560"] 12 | {%- when "Arduino Mega 1280" -%} 13 | rustflags = ["-C", "target-cpu=atmega1280"] 14 | {%- when "Arduino Nano" -%} 15 | rustflags = ["-C", "target-cpu=atmega328p"] 16 | {%- when "Arduino Nano New Bootloader" -%} 17 | rustflags = ["-C", "target-cpu=atmega328p"] 18 | {%- when "Arduino Uno" -%} 19 | rustflags = ["-C", "target-cpu=atmega328p"] 20 | {%- when "SparkFun ProMicro" -%} 21 | rustflags = ["-C", "target-cpu=atmega32u4"] 22 | {%- when "SparkFun ProMini 3v3" -%} 23 | rustflags = ["-C", "target-cpu=atmega328p"] 24 | {%- when "SparkFun ProMini 5v" -%} 25 | rustflags = ["-C", "target-cpu=atmega328p"] 26 | {%- when "Nano168" -%} 27 | rustflags = ["-C", "target-cpu=atmega168"] 28 | {%- endcase %} 29 | 30 | [target.'cfg(target_arch = "avr")'] 31 | runner = "ravedude" 32 | 33 | [unstable] 34 | build-std = ["core"] 35 | {%- comment %} 36 | # vim: ft=toml.jinja2 37 | {% endcomment %} 38 | -------------------------------------------------------------------------------- /README-template.md: -------------------------------------------------------------------------------- 1 | {{ project-name }} 2 | {{ '=================================================' | slice: 0 , project-name.size }} 3 | 4 | Rust project for the _{{ board }}_. 5 | 6 | ## Build Instructions 7 | 1. Install prerequisites as described in the [`avr-hal` README] (`avr-gcc`, `avr-libc`, `avrdude`, [`ravedude`]). 8 | 9 | 2. Run `cargo build` to build the firmware. 10 | 11 | 3. Run `cargo run` to flash the firmware to a connected board. If `ravedude` 12 | fails to detect your board, check its documentation at 13 | . 14 | 15 | 4. `ravedude` will open a console session after flashing where you can interact 16 | with the UART console of your board. 17 | 18 | [`avr-hal` README]: https://github.com/Rahix/avr-hal#readme 19 | [`ravedude`]: https://crates.io/crates/ravedude 20 | 21 | ## License 22 | Licensed under either of 23 | 24 | - Apache License, Version 2.0 25 | ([LICENSE-APACHE](LICENSE-APACHE) or ) 26 | - MIT license 27 | ([LICENSE-MIT](LICENSE-MIT) or ) 28 | 29 | at your option. 30 | 31 | ## Contribution 32 | Unless you explicitly state otherwise, any contribution intentionally submitted 33 | for inclusion in the work by you, as defined in the Apache-2.0 license, shall 34 | be dual licensed as above, without any additional terms or conditions. 35 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | #![no_std] 2 | #![no_main] 3 | 4 | use panic_halt as _; 5 | 6 | #[arduino_hal::entry] 7 | fn main() -> ! { 8 | let dp = arduino_hal::Peripherals::take().unwrap(); 9 | let pins = arduino_hal::pins!(dp); 10 | 11 | /* 12 | * For examples (and inspiration), head to 13 | * 14 | * https://github.com/Rahix/avr-hal/tree/main/examples 15 | * 16 | * NOTE: Not all examples were ported to all boards! There is a good chance though, that code 17 | * for a different board can be adapted for yours. The Arduino Uno currently has the most 18 | * examples available. 19 | */ 20 | 21 | {% case board -%} 22 | {%- when "Adafruit Trinket" -%} 23 | let mut led = pins.d1.into_output(); 24 | {%- when 25 | "Arduino Leonardo", 26 | "Arduino Mega 2560", 27 | "Arduino Mega 1280", 28 | "Arduino Nano", 29 | "Arduino Nano New Bootloader", 30 | "Arduino Uno", 31 | "Nano168", 32 | "Adafruit Trinket Pro", 33 | "SparkFun ProMini 3v3", 34 | "SparkFun ProMini 5v" 35 | -%} 36 | let mut led = pins.d13.into_output(); 37 | {%- when "SparkFun ProMicro" -%} 38 | let mut led = pins.led_rx.into_output(); 39 | {%- endcase %} 40 | 41 | loop { 42 | led.toggle(); 43 | arduino_hal::delay_ms(1000); 44 | } 45 | } 46 | {%- comment %} 47 | # vim: ft=rust.jinja2 48 | {% endcomment %} 49 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "{{project-name}}" 3 | version = "0.1.0" 4 | authors = ["{{authors}}"] 5 | edition = "2021" 6 | license = "MIT OR Apache-2.0" 7 | 8 | [[bin]] 9 | name = "{{project-name}}" 10 | test = false 11 | bench = false 12 | 13 | [dependencies] 14 | panic-halt = "1.0.0" 15 | ufmt = "0.2.0" 16 | nb = "1.1.0" 17 | embedded-hal = "1.0" 18 | 19 | [dependencies.arduino-hal] 20 | git = "https://github.com/rahix/avr-hal" 21 | rev = "0f7fa4d01755f1985d95ed2015d5464a29154b05" 22 | {% case board -%} 23 | {%- when "Adafruit Trinket" -%} 24 | features = ["trinket"] 25 | {%- when "Adafruit Trinket Pro" -%} 26 | features = ["trinket-pro"] 27 | {%- when "Arduino Leonardo" -%} 28 | features = ["arduino-leonardo"] 29 | {%- when "Arduino Mega 2560" -%} 30 | features = ["arduino-mega2560"] 31 | {%- when "Arduino Mega 1280" -%} 32 | features = ["arduino-mega1280"] 33 | {%- when "Arduino Nano" -%} 34 | features = ["arduino-nano"] 35 | {%- when "Arduino Nano New Bootloader" -%} 36 | features = ["arduino-nano"] 37 | {%- when "Arduino Uno" -%} 38 | features = ["arduino-uno"] 39 | {%- when "SparkFun ProMicro" -%} 40 | features = ["sparkfun-promicro"] 41 | {%- when "SparkFun ProMini 3v3" -%} 42 | features = ["sparkfun-promini-3v3"] 43 | {%- when "SparkFun ProMini 5v" -%} 44 | features = ["sparkfun-promini-5v"] 45 | {%- when "Nano168" -%} 46 | features = ["nano168"] 47 | {%- endcase %} 48 | 49 | # Configure the build for minimal size - AVRs have very little program memory 50 | [profile.dev] 51 | panic = "abort" 52 | lto = true 53 | opt-level = "s" 54 | 55 | [profile.release] 56 | panic = "abort" 57 | codegen-units = 1 58 | debug = true 59 | lto = true 60 | opt-level = "s" 61 | {%- comment %} 62 | # vim: ft=toml.jinja2 63 | {% endcomment %} 64 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | `avr-hal-template` 2 | ================== 3 | [`cargo-generate`] template for jumpstarting projects on common AVR 4 | microcontroller boards. This template supports the following hardware at this 5 | time: 6 | 7 | - Arduino Leonardo 8 | - Arduino Mega 2560 9 | - Arduino Mega 1280 10 | - Arduino Nano 11 | - Arduino Nano New Bootloader (Manufactured after January 2018) 12 | - Arduino Uno 13 | - SparkFun ProMicro 14 | - SparkFun ProMini 3.3V 15 | - SparkFun ProMini 5v 16 | - Adafruit Trinket 17 | - Adafruit Trinket Pro 18 | 19 | ## Usage 20 | If you don't have them already, install [`cargo-generate`] and [`ravedude`]: 21 | 22 | ```bash 23 | cargo install cargo-generate 24 | cargo install ravedude 25 | ``` 26 | 27 | Then instantiate this template: 28 | 29 | ```bash 30 | cargo generate --git https://github.com/Rahix/avr-hal-template.git 31 | ``` 32 | 33 | You will be prompted to select your board - do so and you're ready to roll! 34 | Everything is prepared so you should be able to just 35 | 36 | ```bash 37 | cargo run 38 | ``` 39 | 40 | and see a blinky flashed to your board! 41 | 42 | [`cargo-generate`]: https://github.com/cargo-generate/cargo-generate 43 | [`ravedude`]: https://github.com/Rahix/avr-hal/tree/next/ravedude 44 | 45 | ## License 46 | Licensed under either of 47 | 48 | - Apache License, Version 2.0 49 | ([LICENSE-APACHE](LICENSE-APACHE) or ) 50 | - MIT license 51 | ([LICENSE-MIT](LICENSE-MIT) or ) 52 | 53 | at your option. 54 | 55 | ## Contribution 56 | Unless you explicitly state otherwise, any contribution intentionally submitted 57 | for inclusion in the work by you, as defined in the Apache-2.0 license, shall 58 | be dual licensed as above, without any additional terms or conditions. 59 | -------------------------------------------------------------------------------- /Ravedude.toml: -------------------------------------------------------------------------------- 1 | [general] 2 | {% case board -%} 3 | {%- when "Adafruit Trinket" -%} 4 | board = "trinket" 5 | {%- when "Adafruit Trinket Pro" -%} 6 | board = "trinket-pro" 7 | {%- when "Arduino Leonardo" -%} 8 | board = "leonardo" 9 | {%- when "Arduino Mega 2560" -%} 10 | board = "mega2560" 11 | {%- when "Arduino Mega 1280" -%} 12 | board = "mega1280" 13 | {%- when "Arduino Nano" -%} 14 | board = "nano" 15 | {%- when "Arduino Nano New Bootloader" -%} 16 | board = "nano-new" 17 | {%- when "Arduino Uno" -%} 18 | board = "uno" 19 | {%- when "SparkFun ProMicro" -%} 20 | board = "promicro" 21 | {%- when "SparkFun ProMini 3v3" -%} 22 | board = "promini-3v3" 23 | {%- when "SparkFun ProMini 5v" -%} 24 | board = "promini-5v" 25 | {%- when "Nano168" -%} 26 | board = "nano168" 27 | {%- endcase %} 28 | {% case board -%} 29 | {%- when 30 | "Arduino Mega 2560", 31 | "Arduino Mega 1280", 32 | "Arduino Nano", 33 | "Arduino Nano New Bootloader", 34 | "Arduino Uno", 35 | "Nano168" 36 | -%} 37 | # After flashing, open the serial console at 57600 baud. 38 | open-console = true 39 | serial-baudrate = 57600 40 | {%- when 41 | "Arduino Leonardo", 42 | "Arduino ProMicro" 43 | -%} 44 | # The {{ board }} does not have a UART console like other Arduino boards. 45 | # Instead, it can emulate a console device over USB, but this is not yet 46 | # supported in `avr-hal`. To get console output from an {{ board }}, you 47 | # need to connect an external usb-serial converter to the TX/RX pins of your 48 | # board. 49 | open-console = false 50 | {%- endcase %} 51 | 52 | # For documentation about this file, check here: 53 | # https://github.com/Rahix/avr-hal/blob/main/ravedude/README.md#ravedudetoml-format 54 | {%- comment %} 55 | # vim: ft=toml.jinja2 56 | {% endcomment %} 57 | -------------------------------------------------------------------------------- /LICENSE-APACHE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------