Live Ecomesure Agent

<< Click to Display Table of Contents >>

Navigation:  Live > Agents > Web API Agents > Web API Vendor >

Live Ecomesure Agent

The Ecomesure Agent is a data loading agent available in EQuIS Live for obtaining environmental data from Ecomesure.

 

Note: The Ecomesure Agent is in beta. Please contact EarthSoft Support to report any issues.

 

Adding Sensor

 

Before using the Ecomesure Agent, add one or more sensors (stations) to the DT_LOGGER table:

1.Execute the equis.get_ids stored procedure to get a new LOGGER_ID or add the station (DT_LOGGER row) in EQuIS Professional.

2.Set LIVE_DATA_SOURCE to ECOMESURE.

3.Set CUSTOM_FIELD_1 to an encrypted token from Ecomesure. Please contact EarthSoft Support to encrypt your token.
To get/display a token:

a.Log into Ecomesure.

b.Click on username (top right).

c.Click on API access.

d.The token is displayed (e.g. d18c1b6f1614e30dcd1e49330019ed7fd4765316).

4.Set LOGGER_CODE to a sensor ID.
To get a sensor ID:

a.Repeat the steps to get/display the token.

b.Click on Web browsable API.

c.Click on https://i-comesure.com/api/sensors/.

d.The sensor IDs are displayed in the results, in the id values (e.g. 243).

5.Set STATUS_FLAG to 'A' to activate the logger.

 

Loading Data

 

The Ecomesure Agent or Historical Data Loader can be run as a scheduled EQuIS Information Agent (EIA), at the desired frequency, to automatically load data as often as needed.

 

The Ecomesure Agent or Historical Data Loader can also be run in EQuIS Professional or Enterprise (using the EZView widget) to load the data manually, without having to schedule an EIA.

 

The Ecomesure Agent will load data for all loggers with LIVE_DATA_SOURCE set to ECOMESURE. The agent will request data from the logger's most recent date (in DT_LOGGER_DATUM.DATUM_UTC_DT) until today's date. If a logger does not have any values, the agent will get values for the past day.

 

The Ecomesure Historical Data Loader allows for the selection of the loggers, date range, and whether or not to update existing values.

 

The Ecomesure Agent and Historical Data Loader adds a DT_LOGGER_SERIES for each of a sensor's measures. A series can be deactivated, by setting its STATUS_FLAG = R, to stop obtaining data for it. A series' SERIES_DESC and SERIES_UNIT may be changed, but not the SERIES_NAME; it uniquely identifies the series using the measurement type (e.g., 'PM 10') from the Ecomesure API.