API Reference

Set reporting frequency of a gateway

put
https://example.com/v1/gateways//report-mode

Sets the toggle for the specified reporting frequencies that the gateway supports, e.g. realtime (1-10 seconds granularity) or 15 minutes interval

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The gateway EUI, both hex and dec representations are supported

Query Params

Configure if the command will be handled as a blocking or non blocking task

Body Params
string
enum
required

  • real_time_mode: Power and energy measurements are sent immediately to the platform.

  • real_time_override_mode: When low-resolution energy reporting configurations are active, it is possible to use
    the platform connection to request the SmartBridge to report real-time power data for a short period of time.

  • lc_mode: Measurements are buffered at the meter interface level and transmitted in batches to the platform when
    the load curve buffer is full. Applicable on SmartReader.

  • threshold_mode: Threshold mode is similar in concept to the lc_mode described above, but with the additional
    option to set a threshold value which, if exceeded by 2 consecutive measurements, will automatically trigger the
    report of the load-curve buffer to the platform. If this threshold has not been exceeded, the buffered data will be
    reported when the load curve buffer is full. Applicable on SmartReaders.

  • amr_mode: No power measurements in real time are sent to the platform. The energy measurements are reported in a
    frequency that is dependent on the device type (e.g. 5 minutes for SmartBridges and 15 minutes for SmartReaders).

  • status_mode: Device does not send measurements to the platform, only metadata.

  • real_time_inactive_mode (Deprecated) - Replaced by real_time_mode.

  • real_time_active_mode (Deprecated) - Replaced by real_time_override_mode.

When used in conjunction with the real_time_override_mode it sets the duration for which the gateway will report in real-time mode in seconds before it automatically reverts to the original report mode. If used with any other report mode it has no effect.

Controls the default intervals used for reporting the buffered data in the amr_mode.

The load curve threshold will be used by the SmartReader. When used along with the threshold_mode if it is exceeded by 2 consecutive measurements, will automatically trigger the report of the load-curve buffer to the platform. If used with any other report mode it has no effect. This threshold is expressed in Watts.

Responses
200

Successful Response

Updated over 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 1 year ago