Technical Preview

OpenEI

Client-mode REST API connector for a curated OpenEI Utility Rates slice: look up rates for an address.

Hub category: Energy.
Base: https://api.openei.org

Template reference

Generated from the shipped broker template openei (-routeCode OPENEI). It lists every event the template defines.

Auth

The template sets no auth header. Check the event headers below.

Template parameters

Placeholder	Type	Description	Required
`RouteName`	string	Name of the OpenEI connector	no
`BaseUrl`	string	OpenEI base URL without trailing slash (e.g. https://api.openei.org)	yes

BASE_ADDRESS default: https://api.openei.org.

Events

Event	Method	Endpoint	Request topic	Response topic	Payload fields
`Getrates`	GET	`/utility_rates?version=8&format=json&api_key={value.json.api_token}&address={value.json.address}`	`energy/openei/rates`	`energy/openei/rates/response`	`address`, `api_token`

Deploy

Get the template card (JSON with template and metadata) from the broker, then deploy the connector:

mosquitto_pub -t '$SYS/Coreflux/Command' -m "-routeCode OPENEI"

The deployable connector from the REST API app, with BASE_ADDRESS already filled in:

DEFINE ROUTE OpenEiRestApi WITH TYPE REST_API
    ADD REST_API_CONFIG
        WITH BASE_ADDRESS "https://api.openei.org"
        WITH ENABLE_CLIENT "true"
        WITH USE_SSL "true"
        WITH REQUEST_TIMEOUT '60'
        WITH DEFAULT_CONTENT_TYPE "application/json"
    ADD EVENT Getrates
        WITH SOURCE_TOPIC "energy/openei/rates"
        WITH DESTINATION_TOPIC "energy/openei/rates/response"
        WITH METHOD "GET"
        WITH ENDPOINT "/utility_rates?version=8&format=json&api_key={value.json.api_token}&address={value.json.address}"
        WITH HEADERS
            ADD "Accept" "application/json"

Deploy it with -addRoute (do not include ADD METADATA).

Usage example

Call Getrates by publishing a JSON payload to its request topic, and read the reply on the response topic:

mosquitto_sub -t 'energy/openei/rates/response' &
mosquitto_pub -t 'energy/openei/rates' -m '{"address": "<address>", "api_token": "<api_token>"}'

Quick Start

Coreflux MQTT Broker

LoT Language

Coreflux HUB

VS Code - LoT Notebooks

Coreflux Portal

Using AI with Coreflux

Product Updates

OpenEI

OpenEI

Template reference

Auth

Template parameters

Events

Deploy

Usage example

​OpenEI

​Template reference

​Auth

​Template parameters

​Events

​Deploy

​Usage example

OpenEI

Template reference

Auth

Template parameters

Events

Deploy

Usage example