> For the complete documentation index, see [llms.txt](https://docs.net2grid.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.net2grid.com/integration-guide/cloud-data-streaming/data-streams.md). # Data Streams All messages in our streams share a common header structure, shown in the next table. The `data` attribute varies depending on the specific streaming flavor. Each streaming flavor can be independently **enabled or disabled** and **configured** on a per-label-partner basis. **Default values will be applied immediately upon enabling a flavor.**
AttributeRequiredTypeDescription
meter_idYesstringThe hexadecimal representation of the gateway (EUI64)
installation_idNostringThe external installation identifier
account_idNostringThe external account identifier
labelpartnerYesstringThe label-partner short name in which the installation of the device reporting data belongs to
dataYesobjectThe main Data object containing measurements or events
## Triggered Temporary High-Resolution Power Stream This stream provides real-time, high-frequency active power data for a configurable duration after a trigger is received. **Configuration (per Label-partner):** * **Enable/Disable**: Control whether this feature is active for the labelpartner. * **Streaming Timeout**: Duration the device continues streaming high-resolution data after being triggered. **Default: 300 seconds.** **Supported OBIS Codes:** * `1-0:16.7.0`: Instantaneous Active Power Kinesis stream name: `triggered_hires_stream` **Data Structure Example:** ```json { "meter_id": "84DF0C0000010203", "installation_id": "InstABC", "account_id": "Acc123", "labelpartner": "lpx", "type": "current/historic", "data": { "1-0:16.7.0": [ { "t": 1111, "v": 32, "u": "W" } ] } } ``` ## Continuous Low-Resolution Energy Stream Regularly reported energy consumption data at a fixed interval. **Configuration (per Label-partner):** * **Enable/Disable**: Control whether this feature is active for the labelpartner. * **Metric Selection**: Choose to include Energy Offtake (CSD), Energy Feed-In Energy (CSR), or both. **Default: Both enabled** * **Reporting Interval**: Frequency of reporting (e.g., 15, 30, or 60 minutes). **Default: 15 minutes.** **Supported OBIS Codes:** * `1-0:16.7.0`: Instantaneous Active Power (electricity) * `1-0:1.8.0`: Offtake Energy (electricity) * `1-0:2.8.0`: Feed-in Energy (electricity) * `7-0:24.2.1`: Offtake Energy (Gas) reported in cubic meters (m3) Kinesis stream name: `continuous_lr_stream` **Data Structure Example:** ```json { "meter_id": "84DF0C0000010203", "installation_id": "InstABC", "account_id": "Acc123", "labelpartner": "default", "data": { "1-0:16.7.0": [{ "t": 1723783508, "v": 250, "u": "W" }], "1-0:1.8.0": [{ "t": 1723783508, "v": 180000, "u": "Wh" }], "7-0:24.2.1": [{ "t": 1723783508, "v": 450000, "u": "L" }] } } ``` ## Real-time Edge Events Messages triggered by specific events detected at the edge, such as capacity peaks or power threshold crossings. **Configuration (per Label-partner):** * **Enable/Disable**: Control whether edge event reporting is active. * **Event Selection**: Enable or disable specific event types (Capacity Peaks, Power Thresholds). * **Threshold Parameters**: Configure the specific values and intervals that trigger an event. **Default Capacity Peak Interval: 15 minutes (900 seconds).** ### **a. Capacity Peaks** Triggered when consumption exceeds a threshold within a specific interval. | Attribute | Type | Description | | --------- | ------- | -------------------------------------------------------- | | th | integer | The value of the threshold in Wh | | wh | integer | Total energy consumed in Wh when the event was triggered | | intv | integer | The time interval checked (in minutes) | | td | integer | Time delta since the last check (in seconds) | **Data Structure Example:** ```json { "meter_id": "84DF0C0000010203", "installation_id": "InstABC", "account_id": "Acc123", "labelpartner": "lpx", "type": "capacity_peaks", "data": { "th": 2, "wh": 326328, "intv": 900, "td": 62 } } ``` ### **b. Power Thresholds** Triggered when instantaneous power crosses a predefined threshold. | Attribute | Type | Description | | --------- | ------- | ---------------------------------------------------- | | tid | integer | The index of the triggered threshold (0-15) | | v | integer | The power value that triggered the threshold (Watts) | | tr | integer | The transition type: LOHI (1) or HILO (2) | | th | integer | The value of the threshold crossed (Watts) | **Data Structure Example:** ```json { "meter_id": "84DF0C0000010203", "installation_id": "InstABC", "account_id": "Acc123", "labelpartner": "lpx", "type": "power_thresholds", "data": { "tid": 1, "v": 200, "tr": 1, "th": 150 } } ``` Kinesis stream name: `edge_events_stream` ## Continuous Dynamic Reporting Reports data only when specific threshold-exceeded changes are detected. **Configuration (per Labelpartner):** * **Enable/Disable**: Control whether dynamic reporting is active. * **Metric Selection**: Choose which metrics to include (IDD, CSD, CSR). **Default: IDD, CSD, and CSR.** * **Reporting Threshold**: Minimum power value required to trigger a report. **Default: 100 Watts.** * **Time-of-Day Filter**: Option to restrict reporting to daylight hours only. **Default: Disabled (False).** **Supported OBIS Codes:** * `1-0:16.7.0`: Instantaneous Active Power (electricity) * `1-0:1.8.0`: Offtake Energy (electricity) * `1-0:2.8.0`: Feed-in Energy (electricity) * `7-0:24.2.1`: Offtake Energy (gas) reported in cubic meters (m3) Kinesis Stream name: `continuous_dr_stream` **Data Structure Example:** ```json { "meter_id": "84DF0C0000010203", "installation_id": "InstABC", "account_id": "Acc123", "labelpartner": "default", "data": { "1-0:16.7.0": [{ "t": 1723783508, "v": 250, "u": "W" }], "1-0:1.8.0": [{ "t": 1723783508, "v": 180000, "u": "Wh" }], "7-0:24.2.1": [{ "t": 1723783508, "v": 450000, "u": "L" }] } } ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.net2grid.com/integration-guide/cloud-data-streaming/data-streams.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.