Package ninja.codingsolutions.solaredgeapiclient.interfaces

Interface SolarEdgeApiClient

  • All Known Implementing Classes:
    SolarEdgeApiClientImpl
    public interface SolarEdgeApiClient
    Interface defining the interactions available for the client to enact

    • Method Detail

      • getSiteDetails

        java.util.concurrent.CompletionStage<SiteDetailsResponse> getSiteDetails​(int siteId)
        Fetch the site details from the API
        Parameters:
        siteId - integer id of the site
        Returns:
        future that resolve with the site details associated with the provided site id

      • getOverviewResponse

        java.util.concurrent.CompletionStage<OverviewResponse> getOverviewResponse​(int siteId)
        Fetch a high level summary/overview of the site
        Parameters:
        siteId - integer id of the site
        Returns:
        future that resolves with the overview response

      • getVersion

        java.util.concurrent.CompletionStage<VersionResponse> getVersion()
        Get the current version of the API
        Returns:
        response object detailing the current version of the API server

      • getSupportedVersions

        java.util.concurrent.CompletionStage<SupportedVersionsResponse> getSupportedVersions()
        Get the list of supported versions by the API server
        Returns:
        response object detailing the list of versions that the API server supports

      • getEnvironmentalBenefits

        java.util.concurrent.CompletionStage<EnvironmentalBenefitsResponse> getEnvironmentalBenefits​(int siteId)
        Fetches the estimated environmental benefits impact information associated with the targeted site id
        Parameters:
        siteId - targeted site id
        Returns:
        response object containing the estimated environmental impacts

      • getDetailedEnergyReport

        java.util.concurrent.CompletionStage<DetailedEnergyResponse> getDetailedEnergyReport​(int siteId,
                                                                                     java.util.List<MeterType> meters,
                                                                                     TimeUnitType timeUnitType,
                                                                                     java.time.ZonedDateTime startTime,
                                                                                     java.time.ZonedDateTime endTime)
        Fetches a detailed energy report as recorded by the specified meter types, at the targeted site, within the time window, and in the specified time resolution. The times should be in the same time zone as the site.
        Parameters:
        siteId - integer id of the site id
        meters - which meters to include the response
        timeUnitType - what time resolution is desired in the response
        startTime - the start time of the data window
        endTime - the end time of the data window
        Returns:
        a response containing the energy details as specified by the query parameters