Skip to content

Commit e7a02c9

Browse files
authored
Update start page (#235)
* Remove unnecessary white space from main logo. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Reduce height of footer. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Added Zephyr and FreeRTOS to list of RTOS. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Reworked start page completely. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com> * Changed blog link to full url to satisfy CI. Signed-off-by: Ralph Lange <ralph.lange@de.bosch.com>
1 parent 25c0051 commit e7a02c9

4 files changed

Lines changed: 86 additions & 40 deletions

File tree

_docs/overview/features/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ Micro-ROS offers **seven key features** that make it ready for use in your micro
106106

107107
## Layered and Modular Architecture
108108

109-
Micro-ROS follows the [ROS 2 architecture](https://index.ros.org/doc/ros2/) and makes use of its middleware pluggability to use [DDS-XRCE](https://www.omg.org/spec/DDS-XRCE/), which is optimized for microcontrollers. Moreover, it uses POSIX-based RTOS (NuttX) instead of Linux.
109+
Micro-ROS follows the [ROS 2 architecture](https://index.ros.org/doc/ros2/) and makes use of its middleware pluggability to use [DDS-XRCE](https://www.omg.org/spec/DDS-XRCE/), which is optimized for microcontrollers. Moreover, it uses POSIX-based RTOS (FreeRTOS, Zephyr, or NuttX) instead of Linux.
110110

111111
<img src="/img/micro-ROS_architecture.png" style="display: block; margin: auto; width: 100%; max-width: 500px;"/>
112112

_includes/footer.html

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
<footer class="footer">
22
<div class="container">
33
<p class="text-center">
4-
</p>
5-
<p class="text-center">
6-
<a rel="license" href="http://creativecommons.org/licenses/by-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nd/4.0/88x31.png" /></a>.
7-
</p>
8-
<p class="text-center">
9-
{{ site.title }} {{ site.time | date: '%Y' }} |
4+
{{ site.title }} {{ site.time | date: '%Y' }} | <a rel="license" href="http://creativecommons.org/licenses/by-nd/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nd/4.0/80x15.png" /></a> |
105
Powered by <a href="https://github.com/aksakalli/jekyll-doc-theme">Jekyll Doc Theme</a>
116
| <a href="/privacy">privacy</a> | <a href="/docs/imprint">imprint</a>
127
</p>

img/micro-ROS_big_logo.png

4.87 KB
Loading

index.html

Lines changed: 84 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,28 @@ <h1>micro-ROS</h1>
1212
</div>
1313
</div-->
1414

15+
<style>
16+
ul#feature_list {
17+
list-style: none;
18+
padding-left: 0;
19+
margin-left: 0;
20+
}
21+
22+
ul#feature_list > li {
23+
padding-left: 1em;
24+
text-indent: -1em;
25+
}
26+
27+
ul#feature_list > li:before {
28+
content: "\2714";
29+
padding-right: 3px;
30+
}
31+
</style>
32+
1533
<div class="container">
1634
<div class="row">
1735
<div class="col-md-6">
18-
<h2 class="header-light regular-pad">micro-ROS</h2>
19-
<p class="lead">puts ROS 2 onto microcontrollers.</p>
36+
<h2 class="header-light regular-pad" style="line-height: 1.3;">&raquo;micro-ROS<br/><span style="color: white;">&raquo;</span>puts ROS 2 onto microcontrollers&laquo;</h2>
2037
</div>
2138
<div class="col-md-6 text-center">
2239
<img src="img/micro-ROS_big_logo.png" alt="micro-ROS" class="img-responsive">
@@ -25,48 +42,82 @@ <h2 class="header-light regular-pad">micro-ROS</h2>
2542
<hr>
2643
<div class="row">
2744
<div class="col-sm-4">
28-
<h3 class="text-center"><i class="fa fa-pencil" aria-hidden="true" style="font-size:200%;">&nbsp;</i>Main Ideas</h3>
29-
<p style="text-align:justify;">The major changes compared to "regular" ROS 2 is that micro-ROS uses a
30-
Real-Time Operating System (RTOS) instead of Linux, and DDS for eXtremely
31-
Resource Constrained Environments (DDS-XRCE) instead of classical DDS.
32-
Above that, we run the ROS 2 stack! Well, with a few cool improvements
33-
for taking advantage of microcontroller specific things, but largely the same.
34-
</p>
45+
<h3 class="text-center"><i class="fa fa-rocket" aria-hidden="true" style="font-size:180%;">&nbsp;</i>Mission</h3>
46+
<p style="text-align:justify;">Bridging the gap between resource-constrained microcontrollers and larger processors in robotic applications that are based on the Robot Operating Systems.</p>
3547
<p>
3648
<iframe width="356" height="200" src="https://www.youtube.com/embed/slMhPRnBVwM" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
3749
</p>
50+
<h3 class="text-center"><i class="fa fa-microchip" aria-hidden="true" style="font-size:180%;">&nbsp;</i>Why Microcontrollers?</h3>
51+
<p style="text-align:justify;">Microcontrollers are used in almost every robotic product. Typical reasons are:</p>
52+
<ul style="margin-left: 0; padding-left: 1em;">
53+
<li>Hardware access</li>
54+
<li>Hard, low-latency real-time</li>
55+
<li>Power saving</li>
56+
</ul>
57+
<p style="text-align:justify;">Another important reason is safety, but note that micro-ROS is not developed according to any safety standard.</p>
3858
</div>
3959
<div class="col-sm-4">
40-
<h3 class="text-center"><i class="fa fa-cogs" aria-hidden="true" style="font-size:200%;">&nbsp;</i>Getting Started</h3>
41-
<p style="text-align:justify;">To get you started quickly, header over to the <a href="/docs/tutorials/">tutorials</a> section. The basic ones
42-
can even be done without a microcontroller. For more background and details, see the
43-
<a href="/docs/concepts/">concepts section</a>.</p>
60+
<h3 class="text-center"><i class="fa fa-diamond" aria-hidden="true" style="font-size:180%;">&nbsp;</i>Key Features</h3>
61+
<ul id="feature_list">
62+
<li>Microcontroller-optimized client API supporting all major ROS concepts</li>
63+
<li>Seamless integration with ROS 2</li>
64+
<li>Multi-RTOS support with generic build system</li>
65+
<li>Extremely resource-constrained but flexible middleware</li>
66+
<li>Permissive license</li>
67+
<li>Vibrant community and ecosystem</li>
68+
<li>Long-term maintainability and interoperability</li>
69+
</ul>
70+
<h3 class="text-center"><i class="fa fa-cubes" aria-hidden="true" style="font-size:180%;">&nbsp;</i>Architecture</h3>
71+
<p style="text-align:justify;">The <a href="/docs/overview/features/">architecture of the micro-ROS stack</a> follows the ROS&nbsp;2 architecture. Dark blue components are developed specifically for micro-ROS. Light blue components are taken from the standard ROS 2 stack.</p>
72+
<p>
73+
<a href="/docs/overview/features/"><img src="img/micro-ROS_architecture.png" alt="micro-ROS architecture" style="max-width: 356px;" /></a>
74+
</p>
4475
</div>
4576
<div class="col-sm-4">
46-
<h3 class="text-center"><i class="fa fa-code-fork" aria-hidden="true" style="font-size:200%;">&nbsp;</i>Get Involved</h3>
47-
<p style="text-align:justify;">Source code can be found at
48-
<a href="https://github.com/micro-ROS/">https://github.com/micro-ROS/</a> and
49-
we answer both tickets and pull requests as usual.
50-
If you have questions on concepts and development, you're very welcome
51-
to post to <a href="https://discourse.ros.org/c/embedded">the embedded category on ROS Discourse</a>.
52-
For usage questions, head over to <a href="http://answers.ros.org/">ROS Answers</a>
53-
and please tag your question with <a href="https://answers.ros.org/questions/scope:all/sort:activity-desc/tags:embedded/">embedded</a>.
77+
<h3 class="text-center"><i class="fa fa-pencil" aria-hidden="true" style="font-size:180%;">&nbsp;</i>Getting Started</h3>
78+
<p style="text-align:justify;">Our <a href="/docs/tutorials/">tutorials</a> and <a href="/docs/tutorials/demos/">demos</a> give you a quick start with micro-ROS. The <a href="/docs/tutorials/core/first_application_linux/">basic tutorials</a> can even be completed without a microcontroller.</p>
79+
<p>
80+
<iframe width="356" height="200" src="https://www.youtube.com/embed/wgIKGUGSX7Y" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
5481
</p>
82+
<h3 class="text-center"><i class="fa fa-code-fork" aria-hidden="true" style="font-size:180%;">&nbsp;</i>Source Code</h3>
83+
<p style="text-align:justify;">Source code can be found at <a href="https://github.com/micro-ROS/">github.com/micro-ROS</a>. It comes under the permissive license Apache 2.0 just as the standard ROS 2 stack.</p>
84+
<p style="text-align:justify;">The primary repository is <a href="https://github.com/micro-ROS/micro_ros_setup">micro_ros_setup</a>, which provides command line scripts for creating your first micro-ROS application.</p>
85+
<p style="text-align:justify;">Developed an new feature or found a bug? We answer both pull requests and tickets.</p>
86+
</div>
87+
</div>
88+
<div class="row">
89+
<div class="col-sm-4">
90+
<h3 class="text-center"><i class="fa fa-newspaper-o" aria-hidden="true" style="font-size:180%;">&nbsp;</i>News</h3>
91+
<p style="text-align:justify;">Read about the latest developments in our <a href="https://micro-ros.github.io/allposts">blog</a> or attend the next ROS 2 Embedded Working Group Meeting, which take place online on a monthly basis. The meeting link can be found in the <a href="https://index.ros.org/doc/ros2/Governance/#upcoming-ros-events">ROS 2 Events calendar.</a></p>
92+
<p>
93+
<iframe width="356" height="200" src="https://www.youtube.com/embed/Vbab-YED2Us" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
94+
</p>
95+
</div>
96+
<div class="col-sm-4">
97+
<h3 class="text-center"><i class="fa fa-question-circle-o" aria-hidden="true" style="font-size:180%;">&nbsp;</i>Questions</h3>
98+
<p style="text-align:justify;">We are looking forward to answer your questions on concepts and development! You have the choice:</p>
99+
<ul style="margin-left: 0; padding-left: 1em;">
100+
<li><a href="https://discourse.ros.org/c/embedded">ROS Discourse</a> (in category <a href="https://discourse.ros.org/c/embedded">&ldquo;embedded&rdquo;</a>)</li>
101+
<li><a href="https://answers.ros.org/">ROS Answers</a> (tag with <a href="https://answers.ros.org/questions/scope:all/sort:activity-desc/tags:embedded/">&ldquo;embedded&rdquo;</a>)</li>
102+
<li><a href="https://micro-ros.slack.com/">micro-ROS Slack Channel</a></li>
103+
</ul>
104+
</div>
105+
<div class="col-sm-4">
55106
<div id="CommunityInviter"></div>
56107
<script>
57-
window.CommunityInviterAsyncInit = function () {
58-
    CommunityInviter.init({
59-
      app_url:'micro-ros',
60-
      team_id:'micro-ros'
61-
    })
62-
};
108+
window.CommunityInviterAsyncInit = function () {
109+
    CommunityInviter.init({
110+
      app_url:'micro-ros',
111+
      team_id:'micro-ros'
112+
    })
113+
};
63114
(function(d, s, id){
64-
    var js, fjs = d.getElementsByTagName(s)[0];
65-
    if (d.getElementById(id)) {return;}
66-
    js = d.createElement(s); js.id = id;
67-
    js.src = "https://communityinviter.com/js/communityinviter.js";
68-
    fjs.parentNode.insertBefore(js, fjs);
69-
}(document, 'script', 'Community_Inviter'));
115+
    var js, fjs = d.getElementsByTagName(s)[0];
116+
    if (d.getElementById(id)) {return;}
117+
    js = d.createElement(s); js.id = id;
118+
    js.src = "https://communityinviter.com/js/communityinviter.js";
119+
    fjs.parentNode.insertBefore(js, fjs);
120+
}(document, 'script', 'Community_Inviter'));
70121
</script>
71122
</div>
72123
</div>

0 commit comments

Comments
 (0)