|
42 | 42 | BRK_SITE_DETAILED,
|
43 | 43 | CUSTOM_HOUR_SENSOR,
|
44 | 44 | DATE_FORMAT,
|
45 |
| - # DATE_FORMAT_UTC, |
46 | 45 | DOMAIN,
|
47 | 46 | HARD_LIMIT_API,
|
48 | 47 | KEY_ESTIMATE,
|
@@ -172,42 +171,7 @@ class ConnectionOptions:
|
172 | 171 |
|
173 | 172 |
|
174 | 173 | class SolcastApi: # pylint: disable=too-many-public-methods
|
175 |
| - """The Solcast API. |
176 |
| -
|
177 |
| - Public functions: |
178 |
| - get_forecast_update: Request forecast data for all sites. |
179 |
| - set_next_update: Set the next forecast update time displayed. |
180 |
| - get_data: Return the data dictionary. |
181 |
| - build_forecast_data: Build the forecast, adjusting if dampening or setting a hard limit. |
182 |
| - check_data_records: Verify that forecasts for day 0..7 contain all forecast periods |
183 |
| -
|
184 |
| - get_real_now_utc: Get the complete time now, including seconds and microseconds |
185 |
| - get_forecast_list: Service event to get list of forecasts. |
186 |
| - delete_solcast_file: Service event to delete the solcast.json file. |
187 |
| - get_sites_and_usage: Get the sites and usage, and validate API key changes against the cache files in use. |
188 |
| - reset_api_usage: Reset the daily API usage counter. |
189 |
| - load_saved_data: Load the saved solcast.json data. |
190 |
| - serialise_granular_dampening: Serialise the granular dampening file. |
191 |
| - granular_dampening_data: Read the current granular dampening file. |
192 |
| - get_dampening: Return the currently set dampening factors for a service call. |
193 |
| -
|
194 |
| - get_last_updated: Return when the forecast was last updated. |
195 |
| - is_stale_data: Return whether the forecast was last updated some time ago (i.e. is stale). |
196 |
| - is_stale_usage_cache: Return whether the API usage cache needs to be reset |
197 |
| - get_api_limit: Return API polling limit for this UTC 24hr period (minimum of all API keys). |
198 |
| - get_api_used_count: Return API polling count for this UTC 24hr period (minimum of all API keys). |
199 |
| -
|
200 |
| - get_rooftop_site_total_today: Return total kW for today for a site. |
201 |
| - get_rooftop_site_extra_data: Return information about a site. |
202 |
| - get_forecast_day: Return forecast for the Nth day ahead. |
203 |
| - get_forecast_n_hour: Return forecast for the Nth hour. Based from prior hour point. |
204 |
| - get_forecast_custom_hours: Return forecast for the next N hours. Interpolated, based from prior 5-minute point. |
205 |
| - get_power_n_minutes: Return expected power generation in the next N minutes. Based from prior half-hour point. |
206 |
| - get_peak_power_day: Return max kW for site N days ahead. |
207 |
| - get_peak_time_day: Return hour of max kW for site N days ahead. |
208 |
| - get_forecast_remaining_today: Return remaining forecasted production for today. Interpolated, based from prior 5-minute point. |
209 |
| - get_total_energy_forecast_day: Return forecast kWh total for site N days ahead. |
210 |
| - """ |
| 174 | + """The Solcast API.""" |
211 | 175 |
|
212 | 176 | def __init__(
|
213 | 177 | self,
|
|
0 commit comments