Skip to content

Chainlink Adapter for OpenWeatherMap (Monthly Historical Aggregated)

Notifications You must be signed in to change notification settings

Vulcan-Exchange/Chainlink-OpenWeatherMap-History

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chainlink OpenWeatherApi History (aggregated)

This adapter allows to communicate with the OpenWeatherApi historical endpoints and features monthly aggregation of HDD (Heating Day Degrees) and CDD (Cooling Day Degrees)

Note that this is a work in progress. More parameters are possible to be aggregated with this adapter and will be added in the future.

Requirements

In order to use this key you need at least a "starter" plan that allows access to historic data on openweathermap.

Input

Format of the request_payload is in LAT|LON|DAYS|ENDDATEUTC

curl -X POST -H "content-type:application/json" "localhost:8080" --data '{ "id": 0, "data": { "request_payload": "51.523|-0.22|30|1620798416" } }'

Output

{
 "jobRunID": "1",
 "data": {
  "HDD": 100,
  "SDD": 0
 },
 "statusCode": 200
}

Install Locally

Install dependencies:

yarn

Test

Run the local tests:

yarn test

Natively run the application (defaults to port 8080):

Run

yarn start

Call the external adapter/API server

curl -X POST -H "content-type:application/json" "http://localhost:8080/" --data '{ "id": 0, "data": { "city_name": "Amsterdam ,NL", "days": "30", "end": "1615868673" } }'
 }'

Docker

If you wish to use Docker to run the adapter, you can build the image by running the following command:

docker build . -t external-adapter

Then run it with:

docker run -p 8080:8080 -it external-adapter:latest

Serverless hosts

After installing locally:

Create the zip

zip -r external-adapter.zip .

Install to AWS Lambda

  • In Lambda Functions, create function
  • On the Create function page:
    • Give the function a name
    • Use Node.js 12.x for the runtime
    • Choose an existing role or create a new one
    • Click Create Function
  • Under Function code, select "Upload a .zip file" from the Code entry type drop-down
  • Click Upload and select the external-adapter.zip file
  • Handler:
    • index.handler for REST API Gateways
    • index.handlerv2 for HTTP API Gateways
  • Add the environment variable (repeat for all environment variables):
    • Key: API_KEY
    • Value: Your_API_key
  • Save

To Set Up an API Gateway (HTTP API)

If using a HTTP API Gateway, Lambda's built-in Test will fail, but you will be able to externally call the function successfully.

  • Click Add Trigger
  • Select API Gateway in Trigger configuration
  • Under API, click Create an API
  • Choose HTTP API
  • Select the security for the API
  • Click Add

To Set Up an API Gateway (REST API)

If using a REST API Gateway, you will need to disable the Lambda proxy integration for Lambda-based adapter to function.

  • Click Add Trigger
  • Select API Gateway in Trigger configuration
  • Under API, click Create an API
  • Choose REST API
  • Select the security for the API
  • Click Add
  • Click the API Gateway trigger
  • Click the name of the trigger (this is a link, a new window opens)
  • Click Integration Request
  • Uncheck Use Lamba Proxy integration
  • Click OK on the two dialogs
  • Return to your function
  • Remove the API Gateway and Save
  • Click Add Trigger and use the same API Gateway
  • Select the deployment stage and security
  • Click Add

Install to GCP

  • In Functions, create a new function, choose to ZIP upload
  • Click Browse and select the external-adapter.zip file
  • Select a Storage Bucket to keep the zip in
  • Function to execute: gcpservice
  • Click More, Add variable (repeat for all environment variables)
    • NAME: API_KEY
    • VALUE: Your_API_key

About

Chainlink Adapter for OpenWeatherMap (Monthly Historical Aggregated)

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published