| <?xml version="1.0" encoding="utf-8" standalone="yes"?> |
| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"> |
| <channel> |
| <title>API on Eclipse Hono&trade;</title> |
| <link>https://www.eclipse.org/hono/docs/api/</link> |
| <description>Recent content in API on Eclipse Hono&trade;</description> |
| <generator>Hugo -- gohugo.io</generator> |
| <language>en-us</language><atom:link href="https://www.eclipse.org/hono/docs/api/index.xml" rel="self" type="application/rss+xml" /> |
| <item> |
| <title>Telemetry API Specification</title> |
| <link>https://www.eclipse.org/hono/docs/api/telemetry/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/event/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/command-and-control/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/kafka-api/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/telemetry-kafka/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/event-kafka/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/command-and-control-kafka/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/tenant/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/command-router/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/device-connection/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/device-registration/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/credentials/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/authentication/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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/api/management/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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 ], layout: "StandaloneLayout", docExpansion: "none", defaultModelRendering: "model", defaultModelExpandDepth: 0, defaultModelsExpandDepth: -1, validatorUrl: null }) window.</description> |
| </item> |
| |
| <item> |
| <title>Metrics</title> |
| <link>https://www.eclipse.org/hono/docs/api/metrics/</link> |
| <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate> |
| |
| <guid>https://www.eclipse.org/hono/docs/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> |
| |
| </channel> |
| </rss> |