| <?xml version="1.0" encoding="utf-8" standalone="yes"?> |
| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> |
| <channel> |
| <title>Documentation on Eclipse Hono&trade; Vers.: dev</title> |
| <link>https://www.eclipse.org/hono/docs/dev/</link> |
| <description>Recent content in Documentation on Eclipse Hono&trade; Vers.: dev</description> |
| <generator>Hugo -- gohugo.io</generator> |
| <language>en-us</language><atom:link href="https://www.eclipse.org/hono/docs/dev/index.xml" rel="self" type="application/rss+xml" /> |
| <item> |
| <title>Device Identity</title> |
| <link>https://www.eclipse.org/hono/docs/dev/concepts/device-identity/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/concepts/device-identity/</guid> |
| <description><p>This page describes how devices are represented and identified throughout Hono and its APIs.</p></description> |
| </item> |
| |
| <item> |
| <title>Multi-Tenancy</title> |
| <link>https://www.eclipse.org/hono/docs/dev/concepts/tenancy/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/concepts/tenancy/</guid> |
| <description>Hono is designed to structure the set of all internally managed data and data streams into strictly isolated subsets. This includes the registration data and credentials of devices, internal users that are used for authentication, and the Business Applications that are part of such subsets as well. |
| This way of strict isolation is generally known as multi-tenancy, where a tenant is the term for such a subset. Such an isolation is essential for enabling a scalable distributed architecture to handle independent subsets as if each subset had its own installation (which would be much harder to maintain and would not benefit from runtime cost sharing).</description> |
| </item> |
| |
| <item> |
| <title>Device Provisioning</title> |
| <link>https://www.eclipse.org/hono/docs/dev/concepts/device-provisioning/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/concepts/device-provisioning/</guid> |
| <description>This page describes how devices are provisioned in Hono, i.e. how their digital representation is generated. For each device, registration information is stored that defines a device identity. Each device belongs to exactly one tenant. Each device must have at least one set of credentials that are used to authenticate to Hono. |
| To get an understanding of what is meant by the terms tenant, device registration and credentials, it is recommended to read the Device Identity page first.</description> |
| </item> |
| |
| <item> |
| <title>Connecting Devices</title> |
| <link>https://www.eclipse.org/hono/docs/dev/concepts/connecting-devices/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/concepts/connecting-devices/</guid> |
| <description>One of the most important features of Eclipse Hono™ is to abstract away the specific communication protocols used by devices. This page describes the different ways of how devices can be connected to Hono. |
| Before a device can connect to Hono and upload data or receive commands from downstream applications, it needs to be provisioned to the system. As part of device provisioning, the device is associated with the tenant that it belongs to and gets assigned a logical identifier which is unique within the tenant.</description> |
| </item> |
| |
| <item> |
| <title>Device Notifications</title> |
| <link>https://www.eclipse.org/hono/docs/dev/concepts/device-notifications/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/concepts/device-notifications/</guid> |
| <description><p><em>Business Applications</em> need to know when an attempt to send a command to device is feasible, e.g. because the device is then known to be connected to a protocol adapter. <em>Devices</em> and <em>Protocol Adapters</em> can indicate to <em>Business Applications</em> a device&rsquo;s intent to e.g. receive commands using specific <em>notifications</em>.</p></description> |
| </item> |
| |
| <item> |
| <title>Command & Control</title> |
| <link>https://www.eclipse.org/hono/docs/dev/concepts/command-and-control/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/concepts/command-and-control/</guid> |
| <description><p><em>Business applications</em> can send commands to devices following the <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/command-and-control/">Command &amp; Control API</a>. This concept page describes how this API is used by applications to send commands and describes how Hono&rsquo;s protocol adapters process the commands so that they reach their target device.</p></description> |
| </item> |
| |
| <item> |
| <title>Resource limits</title> |
| <link>https://www.eclipse.org/hono/docs/dev/concepts/resource-limits/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/concepts/resource-limits/</guid> |
| <description>Resource limits such as the maximum number of device connections allowed per tenant or the allowed data volume of the messages over a period of time per tenant can be set in Hono. |
| Hono specifies an API ResourceLimitChecks that is used by the protocol adapters for the verification of the configured resource limits. A default implementation of this API is shipped with Hono. This default implementation uses the live metrics data retrieved from a Prometheus server to verify the resource-limits, if configured.</description> |
| </item> |
| |
| <item> |
| <title>Connection Events</title> |
| <link>https://www.eclipse.org/hono/docs/dev/concepts/connection-events/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/concepts/connection-events/</guid> |
| <description>Hono&rsquo;s protocol adapters can use connection events to indicate the connection status of a device. In particular, an adapter can notify downstream components about a newly established connection with a device or about a device having disconnected. |
| The connection status of devices using stateful protocols like MQTT and AMQP can usually be determined quite easily because these protocols often require peers to explicitly open or close a connection and often also support a kind of heart beat which can be used to determine if a connection is still alive.</description> |
| </item> |
| |
| <item> |
| <title>MongoDB Based Device Registry</title> |
| <link>https://www.eclipse.org/hono/docs/dev/user-guide/mongodb-based-device-registry/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/user-guide/mongodb-based-device-registry/</guid> |
| <description>The MongoDB based Device Registry component provides implementations of Hono&rsquo;s Tenant API, Device Registration API and Credentials API. As such, it exposes AMQP 1.0 based endpoints for retrieving the relevant information. Protocol adapters use these APIs to determine a device&rsquo;s registration status, e.g. if it is enabled and if it is registered with a particular tenant, and to authenticate a device before accepting any data for processing from it. |
| In addition to the above APIs, this Device Registry also exposes HTTP endpoints for managing the contents of the Device Registry according to the Device Registry Management API.</description> |
| </item> |
| |
| <item> |
| <title>JDBC Based Device Registry</title> |
| <link>https://www.eclipse.org/hono/docs/dev/user-guide/jdbc-based-device-registry/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/user-guide/jdbc-based-device-registry/</guid> |
| <description>The JDBC based Device Registry component provides implementations of Hono&rsquo;s Tenant API, Device Registration API and Credentials API. As such it exposes AMQP 1.0 based endpoints for retrieving the relevant information. Protocol adapters use these APIs to determine a device&rsquo;s registration status, e.g. if it is enabled and if it is registered with a particular tenant, and to authenticate a device before accepting any data for processing from it. |
| In addition to the above APIs, this Device Registry also exposes HTTP endpoints for managing the contents of the Device Registry according to the Device Registry Management API.</description> |
| </item> |
| |
| <item> |
| <title>File Based Device Registry</title> |
| <link>https://www.eclipse.org/hono/docs/dev/user-guide/file-based-device-registry/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/user-guide/file-based-device-registry/</guid> |
| <description><p>The Device Registry component provides exemplary implementations of Hono&rsquo;s <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/tenant/">Tenant API</a>, <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/device-registration/">Device Registration API</a> and <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/credentials/">Credentials API</a>.</p></description> |
| </item> |
| |
| <item> |
| <title>HTTP Adapter</title> |
| <link>https://www.eclipse.org/hono/docs/dev/user-guide/http-adapter/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/user-guide/http-adapter/</guid> |
| <description><p>The HTTP protocol adapter exposes HTTP based endpoints for Eclipse Hono™&rsquo;s south bound Telemetry, Event and Command &amp; Control APIs.</p></description> |
| </item> |
| |
| <item> |
| <title>MQTT Adapter</title> |
| <link>https://www.eclipse.org/hono/docs/dev/user-guide/mqtt-adapter/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/user-guide/mqtt-adapter/</guid> |
| <description><p>The MQTT protocol adapter exposes an MQTT topic hierarchy for publishing telemetry data and events to downstream consumers and for receiving commands from applications and sending back responses.</p></description> |
| </item> |
| |
| <item> |
| <title>AMQP Adapter</title> |
| <link>https://www.eclipse.org/hono/docs/dev/user-guide/amqp-adapter/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/user-guide/amqp-adapter/</guid> |
| <description><p>The AMQP protocol adapter allows clients (devices or gateway components) supporting the AMQP 1.0 protocol to publish |
| messages to Eclipse Hono™&rsquo;s Telemetry, Event and Command &amp; Control endpoints.</p></description> |
| </item> |
| |
| <item> |
| <title>CoAP Adapter</title> |
| <link>https://www.eclipse.org/hono/docs/dev/user-guide/coap-adapter/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/user-guide/coap-adapter/</guid> |
| <description><p>The CoAP protocol adapter exposes <a href="https://tools.ietf.org/html/rfc7252">CoAP</a> based endpoints for Eclipse Hono™&rsquo;s south bound Telemetry, Event and Command &amp; Control APIs.</p></description> |
| </item> |
| |
| <item> |
| <title>Kura Adapter</title> |
| <link>https://www.eclipse.org/hono/docs/dev/user-guide/kura-adapter/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/user-guide/kura-adapter/</guid> |
| <description><p>The Kura protocol adapter exposes an MQTT topic hierarchy allowing Eclipse Kura™ based gateways to publish <em>control</em> and <em>data</em> messages to Eclipse Hono™&rsquo;s Telemetry and Event endpoints.</p></description> |
| </item> |
| |
| <item> |
| <title>Sigfox Adapter</title> |
| <link>https://www.eclipse.org/hono/docs/dev/user-guide/sigfox-adapter/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/user-guide/sigfox-adapter/</guid> |
| <description><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></description> |
| </item> |
| |
| <item> |
| <title>Common Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/common-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/common-config/</guid> |
| <description><p>Many Hono components support a common set of configuration options. This section |
| describes those options.</p></description> |
| </item> |
| |
| <item> |
| <title>Auth Server Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/auth-server-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/auth-server-config/</guid> |
| <description><p>The Auth Server component exposes a service endpoint implementing Eclipse Hono™&rsquo;s <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/authentication/">Authentication</a> API. Other services use this component for authenticating clients and retrieving a token asserting the client&rsquo;s identity and corresponding authorities.</p></description> |
| </item> |
| |
| <item> |
| <title>MongoDB Based Device Registry Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/mongodb-device-registry-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/mongodb-device-registry-config/</guid> |
| <description>The MongoDB based Device Registry component provides an implementation of Eclipse Hono™&rsquo;s Device Registration, Credentials and Tenant APIs. Protocol adapters use these APIs to determine a device&rsquo;s registration status, e.g. if it is enabled and if it is registered with a particular tenant, and to authenticate a device before accepting any data for processing from it. In addition to the above, this Device Registry also provides an implementation of Device Registry Management APIs for managing tenants, registration information and credentials of devices.</description> |
| </item> |
| |
| <item> |
| <title>JDBC Based Device Registry Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/jdbc-device-registry-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/jdbc-device-registry-config/</guid> |
| <description>The JDBC based Device Registry components provides an implementation of Eclipse Hono™'s Device Registration, Credentials and Tenant APIs. Protocol adapters use these APIs to determine a device&rsquo;s registration status, e.g. if it is enabled and if it is registered with a particular tenant, and to authenticate a device before accepting any data for processing from it. In addition to the above, this Device Registry also provides an implementation of Device Registry Management APIs for managing tenants, registration information and credentials of devices.</description> |
| </item> |
| |
| <item> |
| <title>File Based Device Registry Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/file-based-device-registry-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/file-based-device-registry-config/</guid> |
| <description><p>The File based Device Registry component provides an exemplary implementation of Eclipse Hono™&rsquo;s <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/device-registration/">Device Registration</a>, <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/credentials/">Credentials</a>, <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/tenant/">Tenant</a> and <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/device-connection/">Device Connection</a> APIs.</p> |
| <p>Protocol adapters use these APIs to determine a device&rsquo;s registration status, e.g. if it is enabled and if it is registered with a particular tenant, and to authenticate a device before accepting any data for processing from it.</p></description> |
| </item> |
| |
| <item> |
| <title>Configuring the Command Router Service</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/command-router-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/command-router-config/</guid> |
| <description><p>The Command Router service provides an implementation of Eclipse Hono™&rsquo;s <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/command-router/">Command Router API</a>.</p> |
| <p><em>Protocol Adapters</em> use the <em>Command Router API</em> to supply information with which a Command Router service component can route command &amp; control messages to the protocol adapters that the target devices are connected to.</p></description> |
| </item> |
| |
| <item> |
| <title>Configuring the Device Connection Service</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/device-connection-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/device-connection-config/</guid> |
| <description><p>The Device Connection service provides an implementation of Eclipse Hono™&rsquo;s <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/api/device-connection/">Device Connection API</a>.</p> |
| <p>Protocol adapters use this API to store and retrieve information about the gateway that a device is using to connect to Hono&rsquo;s protocol adapters. This information is necessary for routing commands to the particular protocol adapter instance that the gateway used by the device is connected to.</p></description> |
| </item> |
| |
| <item> |
| <title>HTTP Adapter Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/http-adapter-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/http-adapter-config/</guid> |
| <description><p>The HTTP protocol adapter exposes HTTP based endpoints for Eclipse Hono™&rsquo;s south bound Telemetry, Event and Command &amp; Control APIs.</p></description> |
| </item> |
| |
| <item> |
| <title>MQTT Adapter Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/mqtt-adapter-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/mqtt-adapter-config/</guid> |
| <description><p>The MQTT protocol adapter exposes an MQTT topic hierarchy for Eclipse Hono™&rsquo;s south bound Telemetry, Event and Command &amp; Control APIs.</p></description> |
| </item> |
| |
| <item> |
| <title>AMQP Adapter Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/amqp-adapter-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/amqp-adapter-config/</guid> |
| <description><p>The AMQP protocol adapter exposes AMQP based endpoints for Eclipse Hono™&rsquo;s south bound Telemetry, Event and Command &amp; Control APIs.</p></description> |
| </item> |
| |
| <item> |
| <title>CoAP Adapter Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/coap-adapter-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/coap-adapter-config/</guid> |
| <description><p>The CoAP protocol adapter exposes CoAP based endpoints for Eclipse Hono™&rsquo;s south bound Telemetry, Event and Command &amp; Control APIs.</p></description> |
| </item> |
| |
| <item> |
| <title>Kura Adapter Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/kura-adapter-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/kura-adapter-config/</guid> |
| <description><p>The Kura protocol adapter exposes an MQTT topic hierarchy allowing Eclipse Kura™ based gateways to access Eclipse Hono™&rsquo;s |
| south bound Telemetry, Event and Command &amp; Control APIs.</p></description> |
| </item> |
| |
| <item> |
| <title>Hono Client Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/hono-client-configuration/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/hono-client-configuration/</guid> |
| <description><p>The <code>org.eclipse.hono.client.HonoConnection</code> factory can be used to create AMQP 1.0 connections to Hono&rsquo;s service components.</p></description> |
| </item> |
| |
| <item> |
| <title>Hono Kafka Client Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/hono-kafka-client-configuration/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/hono-kafka-client-configuration/</guid> |
| <description>Protocol adapters can be configured to use Kafka for the messaging. The Kafka client used there can be configured with environment variables and/or command line options. |
| Tech preview The support of Kafka as a messaging system is currently a preview and not yet ready for production. The implementation as well as its APIs may change with the next version. Configure for Kafka based Messaging The selection of whether to use AMQP or Kafka for the messaging can be configured on the tenant.</description> |
| </item> |
| |
| <item> |
| <title>AMQP 1.0 Messaging Network Configuration</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/amqp-network-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/amqp-network-config/</guid> |
| <description><p>The <em>Qpid Dispatch Router</em>, together with the <em>Apache Artemis</em> message broker, serves as the default <em>AMQP 1.0 Messaging Network</em> that is used in Hono&rsquo;s example deployment as described in the <a href="https://www.eclipse.org/hono/docs/hono/docs/dev/deployment/">Deployment Guides</a>.</p></description> |
| </item> |
| |
| <item> |
| <title>Secure Communication</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/secure_communication/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/secure_communication/</guid> |
| <description><p>The individual components of an Eclipse Hono™ installation, e.g. the protocol adapters, <em>AMQP Messaging Network</em>, <em>Hono Auth</em> etc., and the clients attaching to Hono in order to send and receive data all communicate with each other using AMQP 1.0 over TCP. The Hono components and the clients will usually not be located on the same local network but will probably communicate over public networking infrastructure. For most use cases it is therefore desirable, if not necessary, to provide for confidentiality of the data being transferred between these components. This section describes how Hono supports confidentiality by means of <em>Transport Layer Security</em> (TLS) and how to configure it.</p></description> |
| </item> |
| |
| <item> |
| <title>Monitoring & Tracing</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/monitoring-tracing-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/monitoring-tracing-config/</guid> |
| <description><p>The individual components of an Eclipse Hono™ installation need to work together in order to provide their |
| functionality to devices and applications. Under normal circumstances these interactions work flawlessly. |
| However, due to the nature of distributed systems, any one (or more) of the components may crash or become otherwise |
| unavailable due to arbitrary reasons. This page describes how Hono supports operations teams by providing insights |
| into the individual service components and their interactions with each other by means of reporting metrics and |
| tracing the processing of individual messages through the system.</p></description> |
| </item> |
| |
| <item> |
| <title>Building from Source</title> |
| <link>https://www.eclipse.org/hono/docs/dev/dev-guide/building_hono/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/dev-guide/building_hono/</guid> |
| <description>Hono can be deployed using the pre-built Docker images available from our Docker Hub repositories. However, customizing and/or extending Hono&rsquo;s functionality requires building the images from source code. |
| This page provides step by step instructions for getting the source code and building the Hono&rsquo;s Docker images from it. |
| Prerequisites for building Hono Docker Creating Hono&rsquo;s container images using the Hono build process requires a Docker daemon running either locally or on another host you have access to.</description> |
| </item> |
| |
| <item> |
| <title>AMQP Adapter Client for Java</title> |
| <link>https://www.eclipse.org/hono/docs/dev/dev-guide/amqp_adapter_client/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/dev-guide/amqp_adapter_client/</guid> |
| <description>Eclipse Hono™ comes with a Java client for the AMQP adapter. It is intended for the implementation of (prototype) devices, (protocol) gateways or (end-to-end) tests. The client is based on Eclipse Vert.x. |
| The starting point is the class AmqpAdapterClientFactory. |
| The factory provides methods to get a receiver for receiving commands and a sender for each of the following actions: |
| send a telemetry message send an event message send a response to a previously received command Do not re-use sender instances The senders manage the underlying AMQP sender links, which are restored after temporary interruption of the connection (HonoConnection manages the automatic reconnection).</description> |
| </item> |
| |
| <item> |
| <title>Consuming Messages from Java</title> |
| <link>https://www.eclipse.org/hono/docs/dev/dev-guide/java_client_consumer/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/dev-guide/java_client_consumer/</guid> |
| <description>To illustrate how Eclipse Hono™ can be integrated with Java code, a simple application is provided that consumes telemetry and event data for devices belonging to the default tenant. |
| It also includes support for Command and Control: |
| if indicated by a received downstream message that contains a ttd value (refer to Device notifications for details) it tries to send a command to the device. If the value of ttd indicates that the device stays connected for an unlimited time (ttd == -1), the application will periodically repeat to send a command until notified the device is disconnected again (ttd == 0).</description> |
| </item> |
| |
| <item> |
| <title>Implement a Custom Hono HTTP Protocol Adapter</title> |
| <link>https://www.eclipse.org/hono/docs/dev/dev-guide/custom_http_adapter/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/dev-guide/custom_http_adapter/</guid> |
| <description><p>Eclipse Hono™ comes with a default <em>HTTP Adapter</em> which can be used to interact with devices via HTTP. |
| The default HTTP Adapter also serves as a blueprint for implementing a <em>custom</em> HTTP protocol adapter.</p></description> |
| </item> |
| |
| <item> |
| <title>Telemetry API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/telemetry/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/telemetry/</guid> |
| <description><p>The <em>Telemetry</em> API is used by <em>Protocol Adapters</em> to send telemetry data downstream. |
| <em>Business Applications</em> and other consumers use the API to receive data published by devices belonging to a particular tenant.</p></description> |
| </item> |
| |
| <item> |
| <title>Event API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/event/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/event/</guid> |
| <description><p>The <em>Event</em> API is used by <em>Protocol Adapters</em> to send event messages downstream. |
| <em>Business Applications</em> and other consumers use the API to receive messages published by devices belonging to a particular tenant.</p></description> |
| </item> |
| |
| <item> |
| <title>Command & Control API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/command-and-control/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/command-and-control/</guid> |
| <description><p>The <em>Command &amp; Control</em> API of Eclipse Hono™ is used by <em>Business Applications</em> to send commands to connected devices.</p> |
| <p>Commands can be used to trigger actions on devices. Examples include updating a configuration property, installing a software component or switching the state of an actuator.</p></description> |
| </item> |
| |
| <item> |
| <title>Kafka-based APIs</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/kafka-api/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/kafka-api/</guid> |
| <description><p>The Kafka-based APIs of Eclipse Hono™ provide an alternative to the existing APIs based on AMQP 1.0. |
| With these APIs, clients publish data to as well as consume data from an Apache Kafka® cluster instead of using an AMQP messaging network.</p></description> |
| </item> |
| |
| <item> |
| <title>Telemetry API for Kafka Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/telemetry-kafka/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/telemetry-kafka/</guid> |
| <description>The Telemetry API is used by Protocol Adapters to send telemetry data downstream. Business Applications and other consumers use the API to receive data published by devices belonging to a particular tenant. |
| The Telemetry API for Kafka is an alternative to the Telemetry API for AMQP. With this API, clients publish telemetry data to an Apache Kafka® cluster instead of an AMQP Messaging Network. |
| See Kafka-based APIs for fundamental information about Hono&rsquo;s Kafka-based APIs.</description> |
| </item> |
| |
| <item> |
| <title>Event API for Kafka Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/event-kafka/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/event-kafka/</guid> |
| <description>The Event API is used by Protocol Adapters to send event messages downstream. Business Applications and other consumers use the API to receive messages published by devices belonging to a particular tenant. |
| The Event API for Kafka is an alternative to the Event API for AMQP. With this API, clients publish event messages to an Apache Kafka® cluster instead of an AMQP Messaging Network. |
| See Kafka-based APIs for fundamental information about Hono&rsquo;s Kafka-based APIs.</description> |
| </item> |
| |
| <item> |
| <title>Command & Control API for Kafka Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/command-and-control-kafka/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/command-and-control-kafka/</guid> |
| <description><p>The <em>Command &amp; Control</em> API of Eclipse Hono™ is used by <em>Business Applications</em> to send commands to connected devices.</p> |
| <p>Commands can be used to trigger actions on devices. Examples include updating a configuration property, installing a software component or switching the state of an actuator.</p></description> |
| </item> |
| |
| <item> |
| <title>Tenant API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/tenant/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/tenant/</guid> |
| <description><p>The <em>Tenant API</em> is used by Hono&rsquo;s protocol adapters to retrieve information that affects all devices belonging to a particular tenant. |
| A tenant is a logical entity, which groups together a set of devices. The information registered for a tenant is used for example to |
| determine if devices belonging to the tenant are allowed to connect to a certain protocol adapter or if devices are required to authenticate.</p></description> |
| </item> |
| |
| <item> |
| <title>Command Router API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/command-router/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/command-router/</guid> |
| <description><p><em>Protocol Adapters</em> use the <em>Command Router API</em> to supply information with which a Command Router service component can route command &amp; control messages to the protocol adapters that the target devices are connected to.</p></description> |
| </item> |
| |
| <item> |
| <title>Device Connection API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/device-connection/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/device-connection/</guid> |
| <description><p>The <em>Device Connection API</em> is used by <em>Protocol Adapters</em> to set and retrieve information about the connections from devices or gateways to the protocol adapters.</p></description> |
| </item> |
| |
| <item> |
| <title>Device Registration API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/device-registration/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/device-registration/</guid> |
| <description><p>The <em>Device Registration API</em> is used by Hono&rsquo;s protocol adapters to get information about devices connecting to the adapters.</p></description> |
| </item> |
| |
| <item> |
| <title>Credentials API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/credentials/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/credentials/</guid> |
| <description><p>The <em>Credentials API</em> is used by <em>Protocol Adapters</em> to retrieve credentials used to authenticate <em>Devices</em> connecting to the adapter. In particular, the API supports to look up <em>shared secrets</em> which are often used by IoT devices by means of <em>username/password</em> based authentication schemes.</p></description> |
| </item> |
| |
| <item> |
| <title>Authentication API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/authentication/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/authentication/</guid> |
| <description><p>The <em>Authentication API</em> is used to retrieve a <em>token</em> asserting a subject&rsquo;s identity and granted authorities. Other service implementations use such a token to make authorization decisions on a client&rsquo;s request to read or write from/to a resource or to invoke a certain operation.</p></description> |
| </item> |
| |
| <item> |
| <title>Device Registry Management API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/management/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/management/</guid> |
| <description>window.onload = function() { const TryItOutButtonWithHonoSandboxInfo = function() { return { wrapComponents: { TryItOutButton: (Original, { React }) = (props) = { return React.createElement("div", {style: {"font-size": '14px'}}, React.createElement(Original, props), 'using the ', React.createElement('a', {href: 'https://www.eclipse.org/hono/sandbox/'}, "Hono Sandbox") ) } } } } const ui = SwaggerUIBundle({ url: "device-registry-v1.yaml", dom_id: '#swagger-ui', deepLinking: true, presets: [ SwaggerUIBundle.presets.apis, SwaggerUIStandalonePreset ], plugins: [ TryItOutButtonWithHonoSandboxInfo, SwaggerUIBundle.plugins.DownloadUrl ], supportedSubmitMethods: [], layout: "StandaloneLayout", docExpansion: "none", defaultModelRendering: "</description> |
| </item> |
| |
| <item> |
| <title>Metrics</title> |
| <link>https://www.eclipse.org/hono/docs/dev/api/metrics/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/api/metrics/</guid> |
| <description><p>Eclipse Hono™&rsquo;s components report several metrics which may be used to gain some insight |
| into the running system. For instance, the HTTP adapter reports the number of successfully |
| processed telemetry messages. Some of these metrics are considered part of Hono&rsquo;s external |
| interface. This section describes the semantics and format of the metrics, how they can be retrieved |
| and how to interpret actual values.</p></description> |
| </item> |
| |
| <item> |
| <title>Helm based Deployment</title> |
| <link>https://www.eclipse.org/hono/docs/dev/deployment/helm-based-deployment/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/deployment/helm-based-deployment/</guid> |
| <description><p>Eclipse Hono™&rsquo;s components are provided as container images which can be run on arbitrary container orchestration platforms. |
| This page describes the steps necessary to deploy Hono to a <a href="https://kubernetes.io">Kubernetes</a> cluster using the |
| <a href="https://helm.sh">Helm package manager</a>.</p></description> |
| </item> |
| |
| <item> |
| <title>OpenShift / OKD</title> |
| <link>https://www.eclipse.org/hono/docs/dev/deployment/openshift/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/deployment/openshift/</guid> |
| <description>In Hono version 1.0 we dropped the OpenShift specific deployment using the source-to-image (S2I) model, in favor of the Helm charts and the Eclipse IoT Packages project. |
| You can still deploy to OpenShift and OKD, using the Helm charts. And you can also use routes to expose services. Deploying using S2I is also still possible, however the Hono project simply no longer provides out-of-the box scripts for doing so.</description> |
| </item> |
| |
| <item> |
| <title>Setting up a Kubernetes Cluster</title> |
| <link>https://www.eclipse.org/hono/docs/dev/deployment/create-kubernetes-cluster/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/deployment/create-kubernetes-cluster/</guid> |
| <description><p>This guide describes how to set up a Kubernetes cluster which can be used to run Eclipse Hono™.</p></description> |
| </item> |
| |
| <item> |
| <title>Limiting Resource Usage</title> |
| <link>https://www.eclipse.org/hono/docs/dev/deployment/resource-limitation/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/deployment/resource-limitation/</guid> |
| <description><p>Deploying Eclipse Hono™ to a container orchestration platform is easy thanks to the provided Docker images. This page provides some guidance for configuring the resource consumption of these containers in order to make sure that they get enough memory and CPU to run properly, but to also make sure that individual containers do not use up all the resources causing other containers to starve.</p></description> |
| </item> |
| |
| <item> |
| <title>Component View</title> |
| <link>https://www.eclipse.org/hono/docs/dev/architecture/component-view/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/architecture/component-view/</guid> |
| <description><p>This page describes the high level components constituting an Eclipse Hono™ instance and their relations to each other.</p></description> |
| </item> |
| |
| <item> |
| <title>Authentication/Authorization</title> |
| <link>https://www.eclipse.org/hono/docs/dev/architecture/auth/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/architecture/auth/</guid> |
| <description><p>This page describes how authentication and authorization of devices, consumers (back end applications) and system components works in Hono.</p></description> |
| </item> |
| |
| <item> |
| <title>Device Registries</title> |
| <link>https://www.eclipse.org/hono/docs/dev/user-guide/device-registry/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/user-guide/device-registry/</guid> |
| <description>Eclipse Hono™ provides these device registry implementations: |
| File Based Device Registry |
| MongoDB Based Device Registry.</description> |
| </item> |
| |
| <item> |
| <title>Device Registry Configurations</title> |
| <link>https://www.eclipse.org/hono/docs/dev/admin-guide/device-registry-config/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/dev/admin-guide/device-registry-config/</guid> |
| <description>The configuration of Eclipse Hono™s Device Registry implementations for the File Based Device Registry and for the MongoDB Based Device Registry.</description> |
| </item> |
| |
| </channel> |
| </rss> |
