enphex v0.1.0 Enphex
Enphex is an Elixir wrapper for Enphase API
All the API calls defined here follow the API documentation Please refer to the documentation.
You can pass a map of URL parameters as the params
value.
Currently, Enphex
requires you to specify user_id
in your configuration as the authentication flow
is not implemented on Enphex
yet. However, to use as API, this implementation is more than enough.
Summary
Functions
Returns a time series of energy produced on the system over its lifetime
Returns a listing of all active Envoys currently deployed on the system
Returns a listing of active devices on the given system. A device is considered active if it has not been retired in Enlighten. “Active” does not imply that the device is currently reporting, producing, or measuring energy
Returns the energy production of the system for the month starting on the given date. The start date must be at least one month ago
Returns performance statistics as measured by the revenue-grade meters installed on the specified system
Returns performance statistics for the specified system as reported by microinverters installed on the system
Returns summary information for the specified system
Returns a list of systems for which the user can make API requests
Types
Functions
energy_lifetime(system_id, params) :: Enphex.Parser.response
Returns a time series of energy produced on the system over its lifetime.
Returns a listing of all active Envoys currently deployed on the system.
Returns a listing of active devices on the given system. A device is considered active if it has not been retired in Enlighten. “Active” does not imply that the device is currently reporting, producing, or measuring energy.
monthly_production(system_id, params) :: Enphex.Parser.response
Returns the energy production of the system for the month starting on the given date. The start date must be at least one month ago.
Returns performance statistics as measured by the revenue-grade meters installed on the specified system.
Returns performance statistics for the specified system as reported by microinverters installed on the system.
Returns summary information for the specified system.
Returns a list of systems for which the user can make API requests.
Pagination and limit must be handled by user right now through the params.