diff --git a/3rd-party-licenses.txt b/3rd-party-licenses.txt new file mode 100644 index 00000000..7616f437 --- /dev/null +++ b/3rd-party-licenses.txt @@ -0,0 +1,5 @@ +Third Party Licenses +==================== + +This repository contains the project Lab Project FreeRTOS POSIX released under a MIT License: https://github.com/FreeRTOS/Lab-Project-FreeRTOS-POSIX + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..7b9cf80e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,107 @@ +# Contributing + +Want to contribute? Great! You can do so through the standard GitHub pull +request model. For large contributions we do encourage you to file a ticket in +the GitHub issues tracking system prior to any code development to coordinate +with the system_modes development team early in the process. Coordinating up +front helps to avoid frustration later on. + +Your contribution must be licensed under the Apache-2.0 license, the license +used by this project. + +## Add / retain copyright notices + +Include a copyright notice and license in each new file to be contributed, +consistent with the style used by this project. If your contribution contains +code under the copyright of a third party, document its origin, license, and +copyright holders. + +## Sign your work + +This project tracks patch provenance and licensing using a modified Developer +Certificate of Origin (DCO; from [OSDL][DCO]) and Signed-off-by tags initially +developed by the Linux kernel project. + +``` +system_modes Developer's Certificate of Origin. Version 1.0 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the "Apache License, Version 2.0" + ("Apache-2.0"); or + +(b) The contribution is based upon previous work that is covered by + an appropriate open source license and I have the right under + that license to submit that work with modifications, whether + created in whole or in part by me, under the Apache-2.0 license; + or + +(c) The contribution was provided directly to me by some other + person who certified (a) or (b) and I have not modified it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + metadata and personal information I submit with it, including my + sign-off) is maintained indefinitely and may be redistributed + consistent with this project and the requirements of the Apache-2.0 + license or any open source license(s) involved, where they are + relevant. + +(e) I am granting the contribution to this project under the terms of + Apache-2.0. + + http://www.apache.org/licenses/LICENSE-2.0 +``` + +With the sign-off in a commit message you certify that you authored the patch +or otherwise have the right to submit it under an open source license. The +procedure is simple: To certify above system_modes Developer's Certificate of +Origin 1.0 for your contribution just append a line + + Signed-off-by: Random J Developer + +to every commit message using your real name or your pseudonym and a valid +email address. + +If you have set your `user.name` and `user.email` git configs you can +automatically sign the commit by running the git-commit command with the `-s` +option. There may be multiple sign-offs if more than one developer was +involved in authoring the contribution. + +For a more detailed description of this procedure, please see +[SubmittingPatches][] which was extracted from the Linux kernel project, and +which is stored in an external repository. + +### Individual vs. Corporate Contributors + +Often employers or academic institution have ownership over code that is +written in certain circumstances, so please do due diligence to ensure that +you have the right to submit the code. + +If you are a developer who is authorized to contribute to system_modes on +behalf of your employer, then please use your corporate email address in the +Signed-off-by tag. Otherwise please use a personal email address. + +## Maintain Copyright holder / Contributor list + +Each contributor is responsible for identifying themselves in the +[NOTICE](NOTICE) file, the project's list of copyright holders and authors. +Please add the respective information corresponding to the Signed-off-by tag +as part of your first pull request. + +If you are a developer who is authorized to contribute to system_modes on +behalf of your employer, then add your company / organization to the list of +copyright holders in the [NOTICE](NOTICE) file. As author of a corporate +contribution you can also add your name and corporate email address as in the +Signed-off-by tag. + +If your contribution is covered by this project's DCO's clause "(c) The +contribution was provided directly to me by some other person who certified +(a) or (b) and I have not modified it", please add the appropriate copyright +holder(s) to the [NOTICE](NOTICE) file as part of your contribution. + + +[DCO]: http://web.archive.org/web/20070306195036/http://osdlab.org/newsroom/press_releases/2004/2004_05_24_dco.html + +[SubmittingPatches]: https://github.com/wking/signed-off-by/blob/7d71be37194df05c349157a2161c7534feaf86a4/Documentation/SubmittingPatches diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..5aa4e65b --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2019 Robert Bosch GmbH + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/NOTICE b/NOTICE new file mode 100644 index 00000000..96aa93f7 --- /dev/null +++ b/NOTICE @@ -0,0 +1,27 @@ + +# This is the official list of copyright holders and authors. +# +# Often employers or academic institutions have ownership over code that is +# written in certain circumstances, so please do due diligence to ensure that +# you have the right to submit the code. +# +# When adding J Random Contributor's name to this file, either J's name on its +# own or J's name associated with J's organization's name should be added, +# depending on whether J's employer (or academic institution) has ownership +# over code that is written for this project. +# +# How to add names to this file: +# Individual's name . +# +# If Individual's organization is copyright holder of her contributions add the +# organization's name, optionally also the contributor's name: +# +# Organization's name +# Individual's name +# +# Please keep the list sorted. + +eProsima + Jose Antonio Moral + Pablo Garrido + diff --git a/README.md b/README.md index 404b8226..5503973b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,35 @@ -# Introduction -Set of example applications for micro-ROS running over FreeRTOS. +# micro-ROS FreeRTOS Apps + +This repository contains micro-ROS demos and support code for platforms based on FreeRTOS. # Supported platforms Supported hardware platforms are: * Olimex STM32-E407 development board. * Crazyflie 2.1 drone. +* ST Nucleo F446ZE (community supported). + # Usage These applications are integrated within the [micro-ROS build system](https://github.com/micro-ROS/micro-ros-build). Please refer to this repository's documentation for further information about how to configure, build and flash them. + + +## Purpose of the Project + +This software is not ready for production use. It has neither been developed nor +tested for a specific use case. However, the license conditions of the +applicable Open Source licenses allow you to adapt the software to your needs. +Before using it in a safety relevant setting, make sure that the software +fulfills your requirements and adjust it according to any applicable safety +standards, e.g., ISO 26262. + +## License + +This repository is open-sourced under the Apache-2.0 license. See the [LICENSE](LICENSE) file for details. + +For a list of other open-source components included in ROS 2 system_modes, +see the file [3rd-party-licenses.txt](3rd-party-licenses.txt). + +## Known Issues/Limitations + +There are no known limitations. \ No newline at end of file