[!tip] TL;DR
As a public beta, we’re launching a new API and ZenDesk App to run health checks against a system.
Fellow Green-Energy Enthusiasts
As of today, you can try out our new ZenDesk application: Enter a gridBox’s serial number or the ID of a system and a series of health checks are run to ensure the system behaves as expected. You will get a list of results indicating if the check passed and the system is a-ok, the check failed and something needs to be done or the check was skipped due to technical issues. The ZenDesk application will run a preconfigured set of checks with some default values. Should you have the need to fine-tune them, there is more good news: We’re also opening up the API behind the ZenDesk application so that you can create your own health check configuration.
So far, we support only a few checks but more are in the pipeline and will be launched in the coming days and weeks. As the API is still considered a beta, we heavily rely on your feedback: Should something not work as expected or is broken or unclear, please let us know, we’re more than happy to fix it. Are you missing a check? Shoot us a message and we’ll add it to our backlog.
FAQ
How do I install the ZenDesk App?
Please refer to the Readme of the ZenDesk App repository.
What permission do I need to call the API?
You will need the SystemViewer role.
Can I check multiple systems at once?
In the ZenDesk App, you are limited to one system at a time. Through the API you can check multiple systems at once. However, if the check takes too long, you might experience some troubles with timeouts.
I only have the Serial Number, can I still run checks?
Yes, you can. The API accepts both Serial Numbers, System IDs or the combination of both. In the response, you will only get the system ID though.
I only have the System ID, can I still run checks?
Yes, you can. The API accepts both Serial Numbers, System IDs or the combination of both. In the response, you will only get the system ID though.
How far back does the check go?
Currently, only the last 24 hours are checked. We’re working on extending this to a longer period.
My check says “fail”, what do I do?
Check the output of the check. Ideally, it gives you some indication what failed and when.
My check says “N/A” or “Skipped”, what do I do?
There was some internal issue that prevented us from running the check. If the issue persists, please reach out to us with the check’s name, the time you ran it and the system ID or serial number you used to run the check.
What checks are currently supported?
Right now, there are seven checks:
- Do all appliances that need authentication have authentication?
- Is the battery ever charged?
- Is the battery ever discharged?
- Are production and consumption correlated?
- Is there grid feed-in?
- Is PV production only between sunrise and sunset?
- Does the PV production match the inverters nominal power?
We’re working on adding more checks in the coming days and weeks.