docs/dev/user-guide/sigfox-adapter/index.html - gerrit/www.eclipse.org/hono - Git at Google

 <!DOCTYPE html>
 <html lang="dev" class="js csstransforms3d">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <meta name="generator" content="Hugo 0.58.3" />
     <meta name="description" content="A set of micro-services for connecting millions of devices.">
 <meta name="author" content="The Eclipse Hono Project">

     <link rel="apple-touch-icon" sizes="180x180" href="/hono/docs/favicon/apple-touch-icon.png">
 <link rel="icon" type="image/png" sizes="48x48" href="/hono/docs/favicon/favicon-48x48.png">
 <link rel="icon" type="image/png" sizes="32x32" href="/hono/docs/favicon/favicon-32x32.png">
 <link rel="icon" type="image/png" sizes="16x16" href="/hono/docs/favicon/favicon-16x16.png">
 <link rel="manifest" href="/hono/docs/favicon/site.webmanifest">
 <link rel="mask-icon" href="/hono/docs/favicon/safari-pinned-tab.svg" color="#5bbad5">
 <link rel="shortcut icon" href="/hono/docs/favicon/favicon.ico">
 <meta name="msapplication-TileColor" content="#da532c">
 <meta name="msapplication-config" content="/hono/docs/favicon/browserconfig.xml">
 <meta name="theme-color" content="#ffffff">

     <title>Sigfox Adapter :: Eclipse Hono&trade; Vers.: dev</title>


     <link href="/hono/docs/css/nucleus.css?1607825473" rel="stylesheet">
     <link href="/hono/docs/css/fontawesome-all.min.css?1607825473" rel="stylesheet">
     <link href="/hono/docs/css/hybrid.css?1607825473" rel="stylesheet">
     <link href="/hono/docs/css/featherlight.min.css?1607825473" rel="stylesheet">
     <link href="/hono/docs/css/perfect-scrollbar.min.css?1607825473" rel="stylesheet">
     <link href="/hono/docs/css/auto-complete.css?1607825473" rel="stylesheet">
     <link href="/hono/docs/css/theme.css?1607825473" rel="stylesheet">
     <link href="/hono/docs/css/hugo-theme.css?1607825473" rel="stylesheet">

       <link href="/hono/docs/css/theme-hono.css?1607825473" rel="stylesheet">


     <script src="/hono/docs/js/jquery-2.x.min.js?1607825473"></script>

     <style type="text/css">
       :root #header + #content > #left > #rlblock_left{
           display:none !important;
       }

         :not(pre) > code + span.copy-to-clipboard {
             display: none;
         }

     </style>


 <link rel="stylesheet" href="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/stylesheets/vendor/cookieconsent/cookieconsent.min.css">
 <link rel="stylesheet" href='/hono/docs/css/hono.css'>


 <meta name="twitter:card" content="summary_large_image">
 <meta name="twitter:site" content="@EclipseHono">
 <meta name="twitter:title" content="Sigfox Adapter :: Eclipse Hono&amp;trade; Vers.: dev">
 <meta name="twitter:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png">
 <meta name="twitter:description" content="A set of micro-services for connecting millions of devices.">


 <meta property="og:title" content="Sigfox Adapter :: Eclipse Hono&amp;trade; Vers.: dev" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://www.eclipse.org/hono/docs/dev/user-guide/sigfox-adapter//" />
 <meta property="og:image" content="https://www.eclipse.org/hono/docs/images/twitter_image.png" />

   </head>
   <body class="" data-url="/hono/docs/dev/user-guide/sigfox-adapter/">
     <nav id="sidebar" class="">


   <div id="header-wrapper">
     <div id="header">
       <a href="https://www.eclipse.org/hono/">
     <img src="/hono/docs/images/HONO-Logo_Bild-Wort_quer-w-310x120px.svg" alt="Hono logo" class="logo-img">
 </a>

     </div>

         <div class="searchbox">
     <label for="search-by"><i class="fas fa-search"></i></label>
     <input data-search-input id="search-by" type="search" placeholder="Search...">
     <span data-search-clear=""><i class="fas fa-times"></i></span>
 </div>

 <script type="text/javascript" src="/hono/docs/js/lunr.min.js?1607825473"></script>
 <script type="text/javascript" src="/hono/docs/js/auto-complete.js?1607825473"></script>
 <script type="text/javascript">

         var baseurl = "https:\/\/www.eclipse.org\/hono\/docs\/\/dev";

 </script>
 <script type="text/javascript" src="/hono/docs/js/search.js?1607825473"></script>


   </div>

     <div class="highlightable">
     <ul class="topics">


     <li data-nav-id="/hono/docs/dev/concepts/" title="Concepts" class="dd-item


         ">
       <a href="/hono/docs/dev/concepts/">
           <i class="far fa-lightbulb"></i> Concepts

       </a>


         <ul>


       <li data-nav-id="/hono/docs/dev/concepts/device-identity/" title="Device Identity" class="dd-item ">
         <a href="/hono/docs/dev/concepts/device-identity/">
         Device Identity

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/concepts/tenancy/" title="Multi-Tenancy" class="dd-item ">
         <a href="/hono/docs/dev/concepts/tenancy/">
         Multi-Tenancy

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/concepts/device-provisioning/" title="Device Provisioning" class="dd-item ">
         <a href="/hono/docs/dev/concepts/device-provisioning/">
         Device Provisioning

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/concepts/connecting-devices/" title="Connecting Devices" class="dd-item ">
         <a href="/hono/docs/dev/concepts/connecting-devices/">
         Connecting Devices

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/concepts/device-notifications/" title="Device Notifications" class="dd-item ">
         <a href="/hono/docs/dev/concepts/device-notifications/">
         Device Notifications

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/concepts/command-and-control/" title="Command &amp; Control" class="dd-item ">
         <a href="/hono/docs/dev/concepts/command-and-control/">
         Command &amp; Control

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/concepts/resource-limits/" title="Resource limits" class="dd-item ">
         <a href="/hono/docs/dev/concepts/resource-limits/">
         Resource limits

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/concepts/connection-events/" title="Connection Events" class="dd-item ">
         <a href="/hono/docs/dev/concepts/connection-events/">
         Connection Events

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/dev/user-guide/" title="User Guide" class="dd-item
         parent


         ">
       <a href="/hono/docs/dev/user-guide/">
           <i class="fas fa-book-reader"></i> User Guide

       </a>


         <ul>


       <li data-nav-id="/hono/docs/dev/user-guide/mongodb-based-device-registry/" title="MongoDB Based Device Registry" class="dd-item ">
         <a href="/hono/docs/dev/user-guide/mongodb-based-device-registry/">
         MongoDB Based Device Registry

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/user-guide/file-based-device-registry/" title="File Based Device Registry" class="dd-item ">
         <a href="/hono/docs/dev/user-guide/file-based-device-registry/">
         File Based Device Registry

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/user-guide/http-adapter/" title="HTTP Adapter" class="dd-item ">
         <a href="/hono/docs/dev/user-guide/http-adapter/">
         HTTP Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/user-guide/mqtt-adapter/" title="MQTT Adapter" class="dd-item ">
         <a href="/hono/docs/dev/user-guide/mqtt-adapter/">
         MQTT Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/user-guide/amqp-adapter/" title="AMQP Adapter" class="dd-item ">
         <a href="/hono/docs/dev/user-guide/amqp-adapter/">
         AMQP Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/user-guide/coap-adapter/" title="CoAP Adapter" class="dd-item ">
         <a href="/hono/docs/dev/user-guide/coap-adapter/">
         CoAP Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/user-guide/kura-adapter/" title="Kura Adapter" class="dd-item ">
         <a href="/hono/docs/dev/user-guide/kura-adapter/">
         Kura Adapter

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/user-guide/sigfox-adapter/" title="Sigfox Adapter" class="dd-item active">
         <a href="/hono/docs/dev/user-guide/sigfox-adapter/">
         Sigfox Adapter

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/dev/admin-guide/" title="Admin Guide" class="dd-item


         ">
       <a href="/hono/docs/dev/admin-guide/">
           <i class="fas fa-sliders-h"></i> Admin Guide

       </a>


         <ul>


       <li data-nav-id="/hono/docs/dev/admin-guide/common-config/" title="Common Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/common-config/">
         Common Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/auth-server-config/" title="Auth Server Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/auth-server-config/">
         Auth Server Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/jdbc-device-registry-config/" title="JDBC Based Device Registry Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/jdbc-device-registry-config/">
         JDBC Based Device Registry Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/mongodb-device-registry-config/" title="MongoDB Based Device Registry Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/mongodb-device-registry-config/">
         MongoDB Based Device Registry Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/file-based-device-registry-config/" title="File Based Device Registry Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/file-based-device-registry-config/">
         File Based Device Registry Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/command-router-config/" title="Configuring the Command Router Service" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/command-router-config/">
         Command Router Service Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/device-connection-config/" title="Configuring the Device Connection Service" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/device-connection-config/">
         Device Connection Service Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/http-adapter-config/" title="HTTP Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/http-adapter-config/">
         HTTP Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/mqtt-adapter-config/" title="MQTT Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/mqtt-adapter-config/">
         MQTT Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/amqp-adapter-config/" title="AMQP Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/amqp-adapter-config/">
         AMQP Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/coap-adapter-config/" title="CoAP Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/coap-adapter-config/">
         CoAP Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/kura-adapter-config/" title="Kura Adapter Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/kura-adapter-config/">
         Kura Adapter Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/hono-client-configuration/" title="Hono Client Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/hono-client-configuration/">
         Hono Client Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/amqp-network-config/" title="AMQP 1.0 Messaging Network Configuration" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/amqp-network-config/">
         AMQP 1.0 Messaging Network Configuration

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/secure_communication/" title="Secure Communication" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/secure_communication/">
         Secure Communication

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/admin-guide/monitoring-tracing-config/" title="Monitoring &amp; Tracing" class="dd-item ">
         <a href="/hono/docs/dev/admin-guide/monitoring-tracing-config/">
         Monitoring &amp; Tracing

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/dev/dev-guide/" title="Developer Guide" class="dd-item


         ">
       <a href="/hono/docs/dev/dev-guide/">
           <i class="fas fa-tools"></i> Developer Guide

       </a>


         <ul>


       <li data-nav-id="/hono/docs/dev/dev-guide/building_hono/" title="Building from Source" class="dd-item ">
         <a href="/hono/docs/dev/dev-guide/building_hono/">
         Building from Source

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/dev-guide/amqp_adapter_client/" title="AMQP Adapter Client for Java" class="dd-item ">
         <a href="/hono/docs/dev/dev-guide/amqp_adapter_client/">
         AMQP Adapter Client for Java

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/dev-guide/java_client_consumer/" title="Consuming Messages from Java" class="dd-item ">
         <a href="/hono/docs/dev/dev-guide/java_client_consumer/">
         Consuming Messages from Java

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/dev-guide/custom_http_adapter/" title="Implement a Custom Hono HTTP Protocol Adapter" class="dd-item ">
         <a href="/hono/docs/dev/dev-guide/custom_http_adapter/">
         Implement a Custom Hono HTTP Protocol Adapter

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/dev/api/" title="API" class="dd-item


         ">
       <a href="/hono/docs/dev/api/">
           &nbsp;<i class='fas fa-plug'></i>&nbsp;API

       </a>


         <ul>


       <li data-nav-id="/hono/docs/dev/api/telemetry/" title="Telemetry API Specification" class="dd-item ">
         <a href="/hono/docs/dev/api/telemetry/">
         Telemetry API

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/api/event/" title="Event API Specification" class="dd-item ">
         <a href="/hono/docs/dev/api/event/">
         Event API

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/api/command-and-control/" title="Command &amp; Control API Specification" class="dd-item ">
         <a href="/hono/docs/dev/api/command-and-control/">
         Command &amp; Control API

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/api/tenant/" title="Tenant API Specification" class="dd-item ">
         <a href="/hono/docs/dev/api/tenant/">
         Tenant API

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/api/command-router/" title="Command Router API Specification" class="dd-item ">
         <a href="/hono/docs/dev/api/command-router/">
         Command Router API

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/api/device-connection/" title="Device Connection API Specification" class="dd-item ">
         <a href="/hono/docs/dev/api/device-connection/">
         Device Connection API

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/api/device-registration/" title="Device Registration API Specification" class="dd-item ">
         <a href="/hono/docs/dev/api/device-registration/">
         Device Registration API

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/api/credentials/" title="Credentials API Specification" class="dd-item ">
         <a href="/hono/docs/dev/api/credentials/">
         Credentials API

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/api/authentication/" title="Authentication API Specification" class="dd-item ">
         <a href="/hono/docs/dev/api/authentication/">
         Authentication API

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/api/management/" title="Device Registry Management API Specification" class="dd-item ">
         <a href="/hono/docs/dev/api/management/">
         Device Registry Management API

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/api/metrics/" title="Metrics" class="dd-item ">
         <a href="/hono/docs/dev/api/metrics/">
         Metrics

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/dev/deployment/" title="Deployment" class="dd-item


         ">
       <a href="/hono/docs/dev/deployment/">
           <i class="fas fa-shipping-fast"></i> Deployment

       </a>


         <ul>


       <li data-nav-id="/hono/docs/dev/deployment/helm-based-deployment/" title="Helm based Deployment" class="dd-item ">
         <a href="/hono/docs/dev/deployment/helm-based-deployment/">
         Helm based Deployment

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/deployment/openshift/" title="OpenShift / OKD" class="dd-item ">
         <a href="/hono/docs/dev/deployment/openshift/">
         OpenShift / OKD

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/deployment/create-kubernetes-cluster/" title="Setting up a Kubernetes Cluster" class="dd-item ">
         <a href="/hono/docs/dev/deployment/create-kubernetes-cluster/">
         Setting up a Kubernetes Cluster

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/deployment/resource-limitation/" title="Limiting Resource Usage" class="dd-item ">
         <a href="/hono/docs/dev/deployment/resource-limitation/">
         Limiting Resource Usage

         </a>
     </li>


         </ul>

     </li>


     <li data-nav-id="/hono/docs/dev/architecture/" title="Architecture" class="dd-item


         ">
       <a href="/hono/docs/dev/architecture/">
           <i class="fas fa-landmark"></i> Architecture

       </a>


         <ul>


       <li data-nav-id="/hono/docs/dev/architecture/component-view/" title="Component View" class="dd-item ">
         <a href="/hono/docs/dev/architecture/component-view/">
         Component View

         </a>
     </li>


       <li data-nav-id="/hono/docs/dev/architecture/auth/" title="Authentication/Authorization" class="dd-item ">
         <a href="/hono/docs/dev/architecture/auth/">
         Authentication/Authorization

         </a>
     </li>


         </ul>

     </li>


     </ul>


       <section id="shortcuts">
         <h3></h3>
         <ul>

               <li>
                   <a class="padding" href="https://www.eclipse.org/hono/" title="Hono&#39;s Homepage"><i class='fas fa-home'></i> Hono Home</a>
               </li>

               <li>
                   <a class="padding" href="https://www.eclipse.org/hono/getting-started/" title="Getting started with Eclipse Hono"><i class='fas fa-plane-departure'></i> Getting Started</a>
               </li>

         </ul>
       </section>


     <section id="prefooter">
       <hr/>
       <ul>

         <li>
           <div id="select-box-wrapper">
           <div id="select-box">
           <a class="padding">
             Version:&nbsp;
           <div class="select-style">
             <select id="select-language" onchange="location = this.value;">


                       <option id="stable" value="/hono/docs/user-guide/sigfox-adapter/">stable (1.4)</option>


                       <option id="1.4" value="/hono/docs/1.4/user-guide/sigfox-adapter/">1.4</option>


                       <option id="1.3" value="/hono/docs/1.3/user-guide/sigfox-adapter/">1.3</option>


                       <option id="1.2" value="/hono/docs/1.2/user-guide/sigfox-adapter/">1.2</option>


                       <option id="1.1" value="/hono/docs/1.1/user-guide/sigfox-adapter/">1.1</option>


                       <option id="1.0" value="/hono/docs/1.0/user-guide/sigfox-adapter/">1.0</option>


                       <option id="dev" value="/hono/docs/dev/user-guide/sigfox-adapter/" selected>dev</option>


         </select>
         <svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
           width="255px" height="255px" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255;" xml:space="preserve">
           <g>
             <g id="arrow-drop-down">
               <polygon points="0,63.75 127.5,191.25 255,63.75 		" />
             </g>
           </g>
         </svg>
         </div>
         </a>
         </div>
         </div>
         </li>


       </ul>
     </section>

     <section id="footer">


 <p>&copy; 2020 <a href="https://www.eclipse.org/hono/">The Eclipse Hono Project</a></p>

 <p>
     Documentation built with
     <a href="https://gohugo.io/" target="_blank">Hugo</a>
     using the
     <a href="https://github.com/matcornic/hugo-theme-learn" target="_blank">Learn</a> theme.
 </p>

 <div class="eclipse-logo">
     <a href="https://www.eclipse.org" target="_blank">
         <img src="https://www.eclipse.org/hono/docs/images/eclipse_foundation_logo.svg"/>
     </a>
 </div>

     </section>
   </div>
 </nav>


         <section id="body">
         <div id="overlay"></div>


     <div class="old-version-hint">
         <p>This page refers to version <em>dev</em>.
             You might want to use the <a href="https://www.eclipse.org/hono/docs/">current stable</a> version.
         </p>
     </div>


         <div class="padding highlightable">

               <div>
                 <div id="top-bar">


                   <div id="top-github-link">
                     <a class="github-link" title='Edit this page' href="https://github.com/eclipse/hono/edit/master/site/documentation/content/user-guide/sigfox-adapter.md" target="blank">
                       <i class="fas fa-code-branch"></i>
                       <span id="top-github-link-text">Edit this page</span>
                     </a>
                   </div>


                 <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
                     <span id="sidebar-toggle-span">
                         <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
                           <i class="fas fa-bars"></i>
                         </a>
                     </span>

                   <span id="toc-menu"><i class="fas fa-list-alt"></i></span>

                   <span class="links">


             <a href='/hono/docs/dev/'>Documentation</a> > <a href='/hono/docs/dev/user-guide/'>User Guide</a> > Sigfox Adapter


                   </span>
                 </div>

                     <div class="progress">
     <div class="wrapper">
 <nav id="TableOfContents">
 <ul>
 <li>
 <ul>
 <li><a href="#pre-requisites">Pre-requisites</a></li>
 <li><a href="#devices-and-credentials">Devices and credentials</a></li>
 <li><a href="#setup-example">Setup example</a>
 <ul>
 <li><a href="#registering-devices">Registering devices</a></li>
 <li><a href="#setting-up-callbacks">Setting up callbacks</a></li>
 <li><a href="#enabling-command-control">Enabling command &amp; control</a></li>
 </ul></li>
 <li><a href="#events">Events</a></li>
 <li><a href="#consuming-data">Consuming data</a></li>
 <li><a href="#known-bugs-and-limitations">Known bugs and limitations</a></li>
 </ul></li>
 </ul>
 </nav>
     </div>
 </div>


               </div>
             </div>


         <div id="body-inner">

             <h1>Sigfox Adapter</h1>


 <p>The Sigfox protocol adapter exposes an HTTP endpoint for connecting up with
 the Sigfox backend for publishing telemetry, events and use command &amp; control.</p>

 <div class="alert alert-notice">
     <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Tech preview</h4>
     <div>This protocol adapter is not considered production ready. Its APIs might still
 be subject to change without warning.</div>
 </div>

 <h2 id="pre-requisites">Pre-requisites</h2>

 <p>This Sigfox adapter only connects to the Sigfox backend system
 (<code>backend.sigfox.com</code>). It does not allow direct access to Sigfox devices.</p>

 <p>So you need to set up your Sigfox devices on <code>backend.sigfox.com</code> and then
 configure the callbacks connect to your installation of Hono.</p>

 <h2 id="devices-and-credentials">Devices and credentials</h2>

 <p>In a nutshell, the Sigfox adapter requires a single <em>device</em> identity, acting
 as a gateway device. This identity will be used to connect to Hono. All devices
 registered with Sigfox (the actual Sigfox devices), will be registered in Hono
 to allow this first identity as their gateway device.</p>

 <h2 id="setup-example">Setup example</h2>

 <p>The following sub-sections walk you through an example setup.</p>

 <h3 id="registering-devices">Registering devices</h3>

 <p>This example assumes that the Sigfox protocol adapter is available as
 <code>https://iot-sigfox-adapter.my.hono</code>.</p>

 <p>Create a new <em>gateway device</em> with the following registration:</p>

 <pre><code class="language-json">{
   &quot;device-id&quot;: &quot;sigfox-backend&quot;
 }
 </code></pre>

 <p>Create new credentials for the <em>gateway device</em>. For example, using
 a username of <code>sigfox</code> and a password of <code>test12</code>:</p>

 <pre><code class="language-json">{
   &quot;auth-id&quot;: &quot;sigfox&quot;,
   &quot;device-id&quot;: &quot;sigfox-backend&quot;,
   &quot;enabled&quot;: true,
   &quot;secrets&quot;: [
     {
       &quot;pwd-plain&quot;: &quot;test12&quot;
     }
   ],
   &quot;type&quot;: &quot;hashed-password&quot;
 }
 </code></pre>

 <p>Create a new <em>device</em>, referencing the previous <em>gateway device</em>. The
 <em>device id</em> must be your Sigfox device ID (e.g. <code>1AB2C3</code>):</p>

 <pre><code class="language-json">{
   &quot;device-id&quot;: &quot;1AB2C3&quot;,
   &quot;via&quot;: &quot;sigfox-backend&quot;
 }
 </code></pre>

 <h3 id="setting-up-callbacks">Setting up callbacks</h3>

 <p>Log in to the Sigfox backend at <a href="https://backend.sigfox.com">https://backend.sigfox.com</a> and then open up
 the view <code>Device Type</code> -&gt; <code>Callbacks</code>.</p>

 <p>Create a new &ldquo;Custom&rdquo; callback, with the following settings
 (replacing <code>&lt;TENANT&gt;</code> with the name of the tenant):</p>

 <ul>
 <li><strong>Type</strong>: <code>DATA</code> – <code>UPLINK</code></li>
 <li><strong>Channel</strong>: <code>URL</code></li>
 <li><strong>Url pattern</strong>: <code>https://iot-sigfox-adapter.my.hono/data/telemetry/&lt;TENANT&gt;?device={device}&amp;data={data}</code></li>
 <li><strong>Use HTTP Method</strong>: <code>GET</code></li>
 <li><strong>Headers</strong>

 <ul>
 <li><code>Authorization</code> – <code>Basic …</code> (see note below)</li>
 </ul></li>
 <li><strong>Send SNI</strong>: ☑ (Enabled)</li>
 </ul>

 <div class="alert alert-notice">
     <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Credentials</h4>
     <div><p>At the moment you need to manually put in the <code>Authorization</code> header,
 you cannot put the credentials into the URL, as there is a bug in the
 Sigfox backend, which cannot be fixed by Hono. The backend does not
 properly escape the <code>@</code> character, and thus sends <code>foo%40tenant</code>
 instead of <code>foo@tenant</code> to the Hono protocol adapter.</p>

 <p>As a workaround, you can explicitly set the <code>Authorization</code> header to a
 value of <code>Basic &lt;base64 encoded credentials&gt;</code>. You can encode the
 credentials using:</p>

 <pre><code class="language-sh">echo -n &quot;sigfox@tenant:password&quot; | base64
 </code></pre>

 <p>To get the full value, including the <code>Basic</code> you may use:</p>

 <pre><code class="language-sh">echo &quot;Basic $(echo -n &quot;sigfox@tenant:password&quot; | base64)&quot;
 </code></pre>
 </div>
 </div>

 <h3 id="enabling-command-control">Enabling command &amp; control</h3>

 <p>It is possible to enable command &amp; control as well. For this you need to:</p>

 <ul>
 <li>Switch the <strong>Type</strong> of the <code>DATA</code> callback from <code>UPLINK</code> to <code>BIDIR</code></li>
 <li>Add the <code>ack</code> query parameter to the <strong>Url pattern</strong>, e.g. <code>https://iot-sigfox-adapter.my.hono/data/telemetry/&lt;TENANT&gt;?device={device}&amp;data={data}&amp;ack={ack}</code></li>
 </ul>

 <div class="alert alert-notice">
     <h4 class="alert-heading"><i class="fas fa-info-circle"></i> Command requirements</h4>
     <div>Sigfox allows only a very specific payload in command messages. You must send
 exactly 8 bytes of data. It only supports <em>one way commands</em>.</div>
 </div>

 <h2 id="events">Events</h2>

 <p>You can send events by using the path <code>/data/event</code> on the URL.</p>

 <h2 id="consuming-data">Consuming data</h2>

 <p>Use the standard way of consuming Hono messages.</p>

 <h2 id="known-bugs-and-limitations">Known bugs and limitations</h2>

 <ul>
 <li>Only the simple <code>URL</code> and only <em>data</em> (no <em>service</em> or <em>device events</em> are
 currently supported.</li>
 </ul>

 <footer class=" footline" >

 </footer>


         </div>


       </div>

     <div id="navigation">


     </div>

     </section>

     <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
       <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
     </div>
     <script src="/hono/docs/js/clipboard.min.js?1607825473"></script>
     <script src="/hono/docs/js/perfect-scrollbar.min.js?1607825473"></script>
     <script src="/hono/docs/js/perfect-scrollbar.jquery.min.js?1607825473"></script>
     <script src="/hono/docs/js/jquery.sticky.js?1607825473"></script>
     <script src="/hono/docs/js/featherlight.min.js?1607825473"></script>
     <script src="/hono/docs/js/html5shiv-printshiv.min.js?1607825473"></script>
     <script src="/hono/docs/js/highlight.pack.js?1607825473"></script>
     <script>hljs.initHighlightingOnLoad();</script>
     <script src="/hono/docs/js/modernizr.custom.71422.js?1607825473"></script>
     <script src="/hono/docs/js/learn.js?1607825473"></script>
     <script src="/hono/docs/js/hugo-learn.js?1607825473"></script>

     <link href="/hono/docs/mermaid/mermaid.css?1607825473" type="text/css" rel="stylesheet" />
     <script src="/hono/docs/mermaid/mermaid.js?1607825473"></script>
     <script>
         mermaid.initialize({ startOnLoad: true });
     </script>


 <script>
     (function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
             new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
         j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
         'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
     })(window,document,'script','dataLayer','GTM-5WLCZXC');
 </script>


 <script src="https://www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>

   </body>
 </html>