solcast ts

Live -Panne? Demo?

Solcast TypeScript -API -Clientbibliothek

TypeScript -Bibliothek zur Abfrage der solcastischen API -Async/Versprechenbasierten

Mit diesem Modul können ein registrierter Benutzer die Solcast -API https://api.solcast.com.au abfragen. Sie müssen Ihr Benutzerkonto registrieren, um einen API -Schlüssel https://solcast.com.au/api/register zu erhalten. Ohne einen API -Schlüssel können Sie nicht erfolgreich gültige API -Ergebnisse erzielen.

API asynchron/versprach basiert

Power.Forecast (Latlng Point, PowerOptions -Optionen?)

Gibt ein PowerForeCast -Versprechen am Ort des Latlng -Punkteingangs zurück

 export interface PowerForecast {
    forecasts: Forecast [ ] ;
}

export interface Forecast {
    period_end: Date ;
    period: string ;
    pv_estimate: number ;
} 

Strahlung.forecast (Latlng Point, Strahlungsoptionen?)

RETATION DRADIATIONFORECAST -Versprechen am Ort des Latlng -Punkteingangs zurück

 export interface RadiationForecast {
    forecasts: Forecast [ ] ;
}

export interface Forecast {
    ghi: number ;
    ghi90: number ;
    ghi10: number ;
    ebh: number ;
    dni: number ;
    dni10: number ;
    dni90: number ;
    dhi: number ;
    air_temp: number ;
    zenith: number ;
    azimuth: number ;
    cloud_opacity: number ;
    period_end: Date ;
    period: string ;
}

Beispiele

NOTIZ:

Sie können Standardumgebungsvariablen verwenden, um Ihren API -Schlüssel zu halten, und müssen nicht das optionale {Strahlung | Power} -Optionsobjekt an jede Funktion übergeben

Umgebungsvariablennamen

 SOLCAST_API_KEY
SOLCAST_API_URL

Über gemeinsame Prozessumgebungsvariable zugänglich.

 process.env.SOLCAST_API_KEY
process.env.SOLCAST_API_URL

Typoskript

 import * as solcast from 'solcast' ;

const point = solcast . latLng ( - 33.865143 , 151.209900 ) ; // Sydney, Australia

const radiationOptions = solcast . Options . radiation ( ) ;
radiationOptions . APIKey = 'YOUR API KEY HERE' ;

const promiseFn = solcast . Radiation . forecast ( point , radiationOptions ) ;
promiseFn . then ( results => {
	console . log ( results ) ;
} )
. catch ( err => {
	console . log ( err ) ;
} ) ; 

JavaScript -Strahlung Async

 const solcast = require ( 'solcast' ) ;
const point = solcast . latLng ( - 33.865143 , 151.209900 ) ; // Sydney, Australia
const radiationOptions = solcast . Options . radiation ( ) ;
radiationOptions . APIKey = 'YOUR API KEY HERE' ;
const fn = async function ( ) {
	return await solcast . Radiation . forecast ( point , radiationOptions )
} ;
fn ( ) . then ( results => {
	console . log ( results ) ;
} )
. catch ( err => {
	console . log ( err ) ;
} ) ; 

JavaScript -Strahlungsversprechen

 const solcast = require ( 'solcast' ) ;
const point = solcast . latLng ( - 33.865143 , 151.209900 ) ; // Sydney, Australia
const radiationOptions = solcast . Options . radiation ( ) ;
radiationOptions . APIKey = 'YOUR API KEY HERE' ;
const results = solcast . Radiation . forecast ( point , radiationOptions ) ;
results . then ( results => {
    console . log ( results ) ;
} )
. catch ( err => {
    console . log ( err ) ;
} ) ; 

JSON -Beispielergebnisse

 { forecasts: 
   [ { ghi: 0,
       ghi90: 0,
       ghi10: 0,
       ebh: 0,
       dni: 0,
       dni10: 0,
       dni90: 0,
       dhi: 0,
       air_temp: 10,
       zenith: 103,
       azimuth: -88,
       cloud_opacity: 3,
       period_end: '2017-08-31T19:30:00.0000000Z',
       period: 'PT30M' },
    ...
   ]
}

Entwicklungsnotiz

1. Kopieren .env.json.sample nach .env.json
2. Setzen Sie SOLCAST_API_KEY in der JSON -Datei nach dem Register von https://solcast.com.au/api/register/