Difference between revisions of "Websocket Interface"

From Hubitat Documentation
Jump to: navigation, search
(Created page with "=Overview= Hubitat allows for opening and maintaining a connection to a websocket endpoint from the hub. All code needs to be contained in a driver, there is no option to ope...")
 
(Replaced content with "<big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> <big> This document is available at: http://docs2.hubitat.com/en/develo...")
(Tag: Replaced)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
=Overview=
+
<big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big>
−
Hubitat allows for opening and maintaining a connection to a websocket endpoint from the hub. All code needs to be contained in a driver, there is no option to open a websocket 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 (webSocketStatus).
 
  
−
=Methods=
+
<big>
−
 
+
This document is available at: http://docs2.hubitat.com/en/developer/interfaces/websocket-interface
−
==Hubitat Provided Methods==
+
</big>
−
 
 
−
===<code>webSocketConnect</code>===
 
−
 
 
−
:;Signature
 
−
:: <code>void hubitat.helper.InterfaceUtils.webSocketConnect(Map options = [:], DeviceWrapper device, String url)</code>
 
−
 
 
−
:;Parameters
 
−
:: device - The current device that is calling the method.
 
−
:: url - The url to connect to.
 
−
:: options - Optional parameters to configure the web socket connection. Possible values:
 
−
:::''byteInterface''
 
−
:::''pingInterval''
 
−
:::''headers''
 
−
 
 
−
===<code>webSocketClose</code>===
 
−
 
 
−
:;Signature
 
−
:: <code>void webSocketClose(DeviceWrapper device)</code>
 
−
 
 
−
:;Parameters
 
−
:: device - The current device that is calling the method.
 
−
 
 
−
===<code>sendWebSocketMessage</code>===
 
−
 
 
−
:;Signature
 
−
:: <code>void sendWebSocketMessage(DeviceWrapper device, String message)</code>
 
−
 
 
−
:;Parameters
 
−
:: device - The current device that is calling the method.
 
−
:: message - The message to send.  If this connection is a byte interface, then this must be a hex encoded String.
 
−
 
 
−
==User defined methods==
 
−
 
 
−
: '''<code>parse(String message)</code>'''  - This method is called with any incoming messages from the web socket server. This is a standard method for drivers.
 
−
 
 
−
: '''<code>webSocketStatus(String message)</code>''' - This method is called with any status messages from the web socket client connection (disconnections, errors during connect, etc)
 

Latest revision as of 20:28, 25 September 2022

We're moving! Please visit http://docs2.hubitat.com for the latest documentation.

This document is available at: http://docs2.hubitat.com/en/developer/interfaces/websocket-interface

Retrieved from "https://docs.hubitat.com/index.php?title=Websocket_Interface&oldid=5874"