Solar

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

The Solar product allows users to combine smart charging with their home solar generation, enabling them to use excess generation for charging their vehicles. More details about how solar charging works is here.

The Solar product consists of the following APIs:

• Solar Array /solar_array: to manage details about the solar panel array
• Inverter /inverter: to connect an inverter, which is the hardware that connects the solar panel array to the home’s electrical system.
• Charging Session Settings (TBD): to enable solar charging

The typical flow for interacting with the Solar product and enabling solar charging is:

1. Use the Solar Array API to set up the user’s solar array.
   • The user will need a default home location set up, otherwise you will get the SolarLocationRequired error.
   • We currently only support a single array per user. Attempting to set up multiple arrays will result in the SolarArrayAlreadyExists error.
2. Then use the Inverter API to integrate with the inverter, if applicable.
   • The inverter needs to be compatible with our system and connected to the internet so that we can read the solar power generation and throttle the charging accordingly. Check compatibility via the /inverter_makes and /inverter_models endpoints.
   • If this is not possible, we provide an alternative software-only solution which approximates the solar power generation based on location, see Solar only (software solution).
3. Then use the Charging Session Settings to enable solar charging.

Errors

SolarArrayAlreadyExists

Currently the API allows only one solar array to be registered per user account. If you manage multiple arrays, consider setting up your array_capacity_watts to a size that sums the total capacity available for your vehicle’s charging.

SolarLocationRequired

To use the solar API, each user must configure a default location. This location is used to calculate the solar power available to you when forecasting and scheduling charging sessions.

Set up your default location through the User Update API.