solcast ts

Glitch en direct? Demo?

Bibliothèque client API Solcast TypeScript

Bibliothèque dactylographiée pour interroger l'API Solcast

Ce module permet à un utilisateur enregistré de demander l'API Solcast https://api.solcast.com.au. Vous devrez enregistrer votre compte d'utilisateur pour obtenir une clé API https://solcast.com.au/api/register. Sans une clé API, vous ne pourrez pas obtenir avec succès les résultats de l'API valides.

API Async / Promise Basée

Power.Forecast (point de latlng, options PowerOptions?)

Renvoie une promesse PowerForeCast à l'emplacement de l'entrée du point de latlng

 export interface PowerForecast {
    forecasts: Forecast [ ] ;
}

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

Radiation.Forecast (point de latlng, options de radiation-option?)

RETOUR RADIATION FORECAST PROMPRES À LA PRODESSE DE LA POINT LATLNG

 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 ;
}

Exemples

NOTE:

Vous pouvez utiliser des variables d'environnement standard pour maintenir votre clé API et ne pas avoir besoin de passer l'objet Options {Radiation | Power} facultatif à chaque fonction

Noms de variables d'environnement

 SOLCAST_API_KEY
SOLCAST_API_URL

Accessible par une variable d'environnement de processus commune.

 process.env.SOLCAST_API_KEY
process.env.SOLCAST_API_URL

Manuscrit

 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 ) ;
} ) ; 

Radiation JavaScript 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 ) ;
} ) ; 

Promesse de rayonnement javascript

 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 ) ;
} ) ; 

Résultats de l'échantillon JSON

 { 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' },
    ...
   ]
}

Note de développement

1. Copier .env.json.sample à .env.json
2. Définissez SOLCAST_API_KEY sur le fichier JSON APRÈS L'INSCRIPTION À partir de https://solcast.com.au/api/register/