Instructions for Data Retrieval in Esmart

Christopher Gautschi Updated by Christopher Gautschi

Preparation

To prepare for the import of data from an esmart site, you need to ensure you have the following information:

  1. For the gateway:
    1. The base address of the API (base url) and the API password. Often these are the same for all esmart projects.
    2. The external site ID. This link points to the esmart project on their API.
  2. For the meters:
    1. Once the site ID is found, rely on the esmart platform (link in 1password) to explore the associated meters. You should use the "Instruments" feature of the API.
    2. Convert the found JSON to a table to import it into Google Sheets.
    3. Import the meters in bulk from this file.

Configuration

You then need to configure the received information as follows on the platform:

  1. Configure an esmart type gateway with the following information filled in. Under "Communication > Gateways":
    1. Type: esmart
    2. API version: 2.0
    3. API Address (base url): according to the 1password account "esmart"
    4. API Username: empty
    5. API Password: according to the 1password account "esmart"
    6. External site ID: specified by the esmart partner
  2. Add the meters in bulk from the file:
    1. Meter Name: as specified by the esmart partner
    2. Model: e_smart
    3. Protocol: API
    4. Baudrate: empty
    5. In "additional model-related parameters", add the pair:
      1. "foreign_key" associated with the meter number specified by esmart

How Did We Do?

Contact