| <!DOCTYPE html> |
| <html> |
| <!--Head section for CSS/Javascript --> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta content='width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no' name='viewport'> |
| <meta name="description" content="IoT Software Update"> |
| <meta name="author" content=""> |
| <!--base to have relative path for offline navigation --> |
| |
| |
| |
| |
| |
| |
| <title>Eclipse hawkBit - IoT Software Update</title> |
| |
| <!--Stylesheets--> |
| <!-- Bootstrap 3.3.1 --> |
| <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/css/bootstrap.min.css" rel="stylesheet" type="text/css" /> |
| <!-- Font Awesome Icons --> |
| <link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.2.0/css/font-awesome.css" rel="stylesheet" type="text/css" /> |
| <link rel="stylesheet" href="../../css/prettyPhoto.css" type="text/css" media="screen" title="prettyPhoto main stylesheet" charset="utf-8" /> |
| <!-- Custom CSS --> |
| <link href="../../css/hawkbit.css" rel="stylesheet"> |
| |
| <!--Javascript--> |
| <!-- JQuery 2.1.1--> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script> |
| <!-- Bootstrap 3.3.1 JS --> |
| <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js" type="text/javascript"></script> |
| <script src="../../js/jquery.prettyPhoto.js" type="text/javascript" charset="utf-8"></script> |
| <script type="text/javascript" charset="utf-8"> |
| $(document).ready(function(){ |
| $("a[rel^='prettyPhoto']").prettyPhoto(); |
| }); |
| </script> |
| </head> |
| |
| <body> |
| <!--Header section Site navigation --> |
| |
| <!--base to have relative path for offline navigation --> |
| |
| |
| |
| |
| |
| |
| <!-- Navigation --> |
| <nav class="navbar navbar-inverse navbar-fixed-top" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-collapse"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a class="navbar-brand" href="../../index.html">Eclipse hawkBitâ˘</a> |
| </div> |
| <div class="collapse navbar-collapse wow fadeIn" id="navbar-collapse" data-wow-delay="0.2s"> |
| <ul class="nav navbar-nav pull-right"> |
| |
| <li > |
| |
| <a href="../../news/index.html">News</a> |
| |
| |
| </li> |
| |
| <li > |
| |
| <a href="../../documentation/overview/introduction.html">Documentation</a> |
| |
| |
| </li> |
| |
| </ul> |
| </div> |
| <!-- /.navbar-collapse --> |
| </div> |
| <style>#forkongithub a{background:#8d0c0c;color:#fff;text-decoration:none;font-family:Arial, Helvetica, sans-serif;text-align:center;font-weight:bold;padding:5px 40px;font-size:12px;line-height:3rem;position:relative;transition:0.5s;}#forkongithub a:hover{background:#c11;color:#fff;}#forkongithub a::before,#forkongithub a::after{content:"";width:100%;display:block;position:absolute;top:1px;left:0;height:1px;background:#fff;}#forkongithub a::after{bottom:1px;top:auto;}@media screen and (min-width:800px){#forkongithub{position:fixed;display:block;top:0;right:0;width:50px;overflow:visible;height:200px;z-index:9999;}#forkongithub a{width:260px;position:absolute;top:40px;right:-60px;transform:rotate(45deg);-webkit-transform:rotate(45deg);-ms-transform:rotate(45deg);-moz-transform:rotate(45deg);-o-transform:rotate(45deg);}}</style><span id="forkongithub"><a href="https://github.com/eclipse/hawkbit">Fork me on GitHub</a></span> |
| <!-- /.container --> |
| </nav> |
| |
| <div id="header_wrapper" class="container"> |
| <div class="nav-bar col-md-3"> |
| <nav class="navmenu navmenu-default" role="navigation"> |
| <ul class="nav navmenu-nav"> |
| <!--base to have relative path for offline navigation --> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li> |
| Introduction |
| <ul class="nav navmenu-nav"> |
| <!-- 2nd level --> |
| <!--base to have relative path for offline navigation --> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/overview/introduction.html">Overview</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/overview/features.html">Features</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/overview/getting-started.html">Getting Started</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| Concepts |
| <ul class="nav navmenu-nav"> |
| <!-- 2nd level --> |
| <!--base to have relative path for offline navigation --> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/architecture/architecture.html">Architecture</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/architecture/datamodel.html">Data model</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/architecture/targetstate.html">Target States</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| Interfaces |
| <ul class="nav navmenu-nav"> |
| <!-- 2nd level --> |
| <!--base to have relative path for offline navigation --> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/interfaces/interfaces.html">Overview</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/interfaces/management-ui.html">Management UI</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/interfaces/management-api.html">Management API</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/interfaces/ddi-api.html">DDI API</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/interfaces/dmf-api.html">DMF API</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| Security |
| <ul class="nav navmenu-nav"> |
| <!-- 2nd level --> |
| <!--base to have relative path for offline navigation --> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/security/security.html">Overview</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| <li> |
| Guides |
| <ul class="nav navmenu-nav"> |
| <!-- 2nd level --> |
| <!--base to have relative path for offline navigation --> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/guide/runhawkbit.html">Build and Run hawkBit</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/guide/clustering.html">Clustering</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/guide/customtheme.html">Theme Customization</a> |
| |
| |
| </li> |
| |
| |
| |
| <li > |
| |
| <a href="../../documentation/guide/feignclient.html">Create Feign Client</a> |
| |
| |
| </li> |
| |
| |
| |
| </ul> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </div> |
| |
| |
| <div id="page" class="col-md-9"> |
| <div class="inner"> |
| <div id="maincontainer"> |
| <section id="top" class="documentation-section"> |
| <div class="row"> |
| <div class="span8 offset3"> |
| <!--base to have relative path for offline navigation --> |
| |
| <p><img src="../images/interfaces.png" alt="" width="100%" /></p> |
| |
| <h1 id="graphical-user-interface">Graphical User Interface</h1> |
| |
| <p>To get started <em>hawkBit</em> offers a <a href="https://github.com/eclipse/hawkbit/wiki/Management-UI">Management UI</a> that allows operators to manage the repository and trigger provisioning operations.</p> |
| |
| <p>In addition Eclipse <em>hawkBit</em> offers developers multiple options to integrate.</p> |
| |
| <h1 id="application-integration">Application Integration</h1> |
| <p>The <em>hawkBit</em> <a href="https://github.com/eclipse/hawkbit/wiki/Management-API">Management API</a> allows applications to manage the repository and trigger provisioning operations. It is in general feature compliant with the <em>Management UI</em>. However, small differences may occur here and there. The authentication and authorization structure is identical, i.e. a user can login both at Management API and UI with the same credentials and has the same permissions available.</p> |
| |
| <h1 id="device-integration">Device Integration</h1> |
| <p>For device integration two options exist.</p> |
| |
| <p>The <a href="https://github.com/eclipse/hawkbit/wiki/Direct-Device-Integration-API">Direct Device Integration API</a> allows direct integration from the device to the <em>hawkBit</em> server. It has been designed with simplicity in mind as its is fully focused on software update. It allows device integrators to separate concerns by means of having distinguished channels for business data and general device management tasks on one side and software update on the other. As a result it is possible to keep the <em>lifesaving</em> provisioning process controller on the device separate from the more complex business functionality. A benefit of such an architecture should not be underestimated.</p> |
| |
| <p>As result of such a simple HTTP/REST/JSON based API even a major back-end migration or disaster can be covered with simple web server hosting a text file that contains only the command to update one more time to execute a migration on the device. The API was designed on purpose in way to have that last resort even if the plan is that this will never be necessary.</p> |
| |
| <p>The <a href="https://github.com/eclipse/hawkbit/wiki/Device-Management-Federation-API">Device Management Federation API</a> however allows to combine the business data and <em>hawkBit</em> connectivity. This is especially usefull if a constrained device cannot handle a TLS/HTTP connection, is supporting a standard device management protocol that covers also the software update part (e.g. TR-069, OMA-DM, LWM2M) or the device is already connected and <em>hawkBit</em> is introduced later on.</p> |
| |
| <p>The decision for the right device integration path is up to the integration party.</p> |
| |
| </div> |
| </div> |
| </section> |
| </div> |
| </div> |
| </div> |
| </div> |
| <!-- Footer --> |
| <footer> |
| <div class="container"> |
| <div class="row"> |
| <div class="col-md-4"> |
| <h3 class="footer-links-header">Quick Links</h3> |
| <ul class="footer-links clearfix"> |
| <li><a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li> |
| <li><a href="http://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li> |
| <li><a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li> |
| <li><a href="http://www.eclipse.org/legal/">Legal</a></li> |
| </ul> |
| <ul class="footer-links clearfix"> |
| <li><a href="http://www.eclipse.org">Eclipse Home</a></li> |
| <li><a href="http://marketplace.eclipse.org/">Market Place</a></li> |
| <li><a href="http://live.eclipse.org/">Eclipse Live</a></li> |
| <li><a href="http://www.planeteclipse.org/">Eclipse Planet</a></li> |
| </ul> |
| </div> |
| <div class="col-md-2"> |
| |
| </div> |
| </footer> |
| |
| <!--/.Footer--> |
| |
| </body> |
| |
| </html> |
