Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
ezeio2:apiref:subscribe [2021-01-27 19:02] – andreh | ezeio2:apiref:subscribe [2021-01-28 23:49] (current) – andreh | ||
---|---|---|---|
Line 1: | Line 1: | ||
==== subscribe ==== | ==== subscribe ==== | ||
- | Request a websocket data stream, and commands to manage the data stream | + | Request a websocket data stream, and commands to manage the data stream. |
=== Description === | === Description === | ||
Line 11: | Line 11: | ||
Subsequent calls using the subscribe command are used to manage the data stream. | Subsequent calls using the subscribe command are used to manage the data stream. | ||
+ | |||
+ | <WRAP center round important 60%> | ||
+ | This functionality requires firmware 21012701 or later in the device. | ||
+ | </ | ||
+ | |||
=== Parameters === | === Parameters === | ||
Line 104: | Line 109: | ||
The data received will have a '' | The data received will have a '' | ||
- | | LOGDATA | The field data is from the 'fast log'. The interval is determined by the log interval setting on each field. | | + | | '' |
- | | STATUS | The field data is from the ' | + | | '' |
Note that the ezeio normally buffers data before the data is uploaded to the cloud servers, so the data may be delayed with up to 20 minutes | Note that the ezeio normally buffers data before the data is uploaded to the cloud servers, so the data may be delayed with up to 20 minutes | ||
The STATUS updates will be sent every 10 minutes even if a faster subscription is active. | The STATUS updates will be sent every 10 minutes even if a faster subscription is active. | ||
+ | |||
+ | This is an example of what a '' | ||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | Note that the fields array will include all configured fields for this unit - regardless of their log setting. All fields are always logged every 10 minutes. | ||
+ | |||
+ | A '' | ||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | Note that this message only includes the fields that are configured for fast logging (interval less than 10 minutes). Please see below for the meaning of the '' | ||
**Step 3 : Request subscription changes** | **Step 3 : Request subscription changes** | ||
Line 118: | Line 163: | ||
< | < | ||
The log updates will revert to normal (buffered) mode after 30 minutes. | The log updates will revert to normal (buffered) mode after 30 minutes. | ||
- | |||
- | To request 10s status updates, the call is: | ||
- | < | ||
- | The status updates will revert to normal (10 minute) updates after 5 minutes. | ||
To cancel updates, the call is: | To cancel updates, the call is: | ||
Line 127: | Line 168: | ||
Multiple requests can be sent in the same command: | Multiple requests can be sent in the same command: | ||
- | < | + | < |
+ | Up to 50 devices can be included in the same command | ||
- | === Example code (PHP) === | + | === Example code to set up the websocket channel and receive data (PHP) === |
<code php> | <code php> | ||
<?php | <?php |