Information
- Requires firmware v.4.7 or higher.
- This is an advanced function
Custom Data sharing can be configured to push eGauge data to an arbitrary URI. Both http (unencrypted) and https (encrypted) schemes are supported. Data can be provided in XML or JSON format depending on the included options. (JSON is recommended and require specification of the json option.)
Access this functionality from the main menu by navigating to Setup → Data Sharing. Enable the ‘Share meter data’ option to edit settings.
Options & Settings
-
Share with:
-
Custom:
- Server URL: Add the URL of the destination web-server to which the data should be pushed.
- Push Interval: Interval between pushes. Several options are available ranging from 1 minute to 24 hours.
- Push Options: Add any desired push options. Options are detailed in the table shown below.
-
Custom:
The chart below assumes the latest stable firmware version is installed.
| Option | Function |
| json | Output the data as a JSON object rather than as XML. |
| totals | Also push the values of virtual (calculated) registers. |
| formulas | Output virtual registers as formulas. This option only has an effect if JSON-output is selected. |
| msec | Push data with millisecond granularity (to the degree available). This option only has an effect if JSON-output is specified. For XML-output, it is treated as if sec had been specified. |
| sec | Push second-by-second granularity (to the degree available) |
| hour | Push data with hour granularity (to the degree available). |
| day | Push data with day granularity (to the degree available). |
| max=N | Push at most N rows of data in a single push. N defaults to 900, must be at least 9, but cannot be more than 9000. (Starting in v.4.7 N can be < 9) |
| skip=N | skip N rows before pushing another one. For example, with minute granularity, "skip=14" would end up pushing one data row for every 15 minutes. |
| secure | Require that the server have a certificate that can be verified as being valid. This option only has an effect if a secure (https) connection is used |
| deflate | Compress push data with the deflate content encoding. |
| gzip | Compress push data with the gzip content encoding. |
| old_first | Push pending old data before newer data. Normally, the most recent N rows of data are pushed (as specified by the max=N option). However, if this option is specified and if there are more than N rows of data that have not been pushed yet, the old data will be sent first. If data is being generated faster than can be pushed, this option can have the effect that the pushed data falls further and further behind the current time. Note that within a push, the rows are still ordered from youngest to oldest. |
| epoch | Report register values relative to the start of recording defined by Date & Time when recording started. |
| user | The user-name to be supplied during a push via HTTP basic authentication. If no user-name is specified, no basic authentication information will be supplied. |
| pw | The password to be supplied during a push via HTTP basic authentication. |
Additional Notes regarding Options
- When the json option is not specified, data will default to XML format.
- Pushed data will default to minute granularity unless msec, sec, hour or day are specified.