|
|
| (One intermediate revision by one other user not shown) |
| Line 1: |
Line 1: |
| − | =Overview=
| |
| − | Hubitat allows for opening and maintaining a connection to an event stream endpoint from the hub. All code needs to be contained in a driver, there is no option to open an event stream connection from an app. Hubitat provides methods to connect and disconnect to the endpoint, in addition it is required to create a method in the driver that accepts incoming messages (parse) and another method that will be called with any status updates for the endpoint (eventStreamStatus).
| |
| | | | |
| − | =Methods=
| + | <big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> |
| | | | |
| − | ==Hubitat Provided Methods==
| + | <big> |
| − | | + | This document is available at: http://docs2.hubitat.com/en/developer/interfaces/eventstream-interface |
| − | ===<code>connect</code>===
| + | </big> |
| − | :;Signature
| |
| − | :: <code>void connect(String url)</code>
| |
| − | :: <code>void connect(String url, [options (name/value pairs)])</code> | |
| − | | |
| − | :;Parameters
| |
| − | :: url - The url to connect to.
| |
| − | :: options - Optional parameters to configure the web socket connection. Possible values:
| |
| − | :::''pingInterval'' - The number of seconds to send a ping message. Defaults to 0 (disabled).
| |
| − | :::''headers'' - A Map of key/value pairs to send as header values when connecting to the web socket server.
| |
| − | | |
| − | ===<code>close</code>===
| |
| − | | |
| − | :;Signature
| |
| − | :: <code>void close()</code>
| |
| − | | |
| − | :;Examples
| |
| − | | |
| − | // Close connection
| |
| − | interfaces.eventStream.close()
| |
| − | | |
| − | | |
| − | ==User defined methods==
| |
| − | | |
| − | : '''<code>parse(String message)</code>''' - This method is called with any incoming messages from the event stream server. This is a standard method for drivers.
| |
| − | | |
| − | : '''<code>eventStreamStatus(String message)</code>''' - This method is called with any status messages from the event stream client connection (disconnections, errors during connect, etc)
| |
Latest revision as of 04:07, 25 September 2022
