README

Logo

Logo">rowatt API for Inverter

this is an Node for the API on the Growatt© Shine Webserver. (Shine provided by Growatt©. I'm not affiliated.)

This implementation is based on the refectured eebinterface from Growatt&copy Shine.

Install

npm install growatt

Debug

This API supported debugging. you have to set the environment variable DEBUG

set DEBUG=growatt:*
set DEBUG=growatt:api
set DEBUG=growatt:verbose

Promise

This NODE-Implementation works with promise.

Understanding javascript promises

Modern Asynchronous JavaScript with Async and Await

Simple Impemation

"use strict"
const api = require('growatt')

const user="xxx"
const passwort="xx"
const options={}

async function test() {
  const growatt = new api({})
  let login = await growatt.login(user,passwort).catch(e => {console.log(e)})
  console.log('login:',login)
  let getAllPlantData = await growatt.getAllPlantData(options).catch(e => {console.log(e)})
  console.log('getAllPlatData:',JSON.stringify(getAllPlantData,null,' '));
  let logout = await growatt.logout().catch(e => {console.log(e)})
  console.log('logout:',logout)
}

test()

Constructor

Please note that you have to create an instance since version 0.2.0.

Parameter	Type	Default	Description
config	Object	See below	Controls the processing

The constructor has a config object as parameter. This is optional.

Config

config	Type	Default	Description
timeout	Integer	5000	Session timeout in ms.
headers	Object	{}	custom header like {'X-Custom-Header': 'foobar'}.

const api = require('growatt')
const growatt = new api()

Login

There are several options for logging in:

Login with user and password

Parameter	Type	Default	Description
user	String	-	The username
passord	String	-	The password

  let login = await growatt.login(user,passwort).catch(e => {console.log(e)})

With resolve, the response from the website is returned. Usually the object: { result: 1, msg: 'OK' }

With reject an exception is thrown which contains the error object with result less then 1.

Login with key

Parameter	Type	Default	Description
key	String	-	The key

You can get the key by having an email sent to you on the Grwatt website for a third party to display the data. The key is the combination of numbers and letters in the link. It has 96 characters.

  let login = await Growatt.sharePlantLogin(key).catch(e => {console.log(e)})

With resolve, the response from the website is returned. Usually the object: { result: 1, msg: 'OK' }

With reject an exception is thrown which contains the error object with result less then 1.

Login to Demo

Parameter	Type	Default	Description

This plugin is intended for testing. On the Growatt page you can view the data from many systems. The problem is that the ID of the system is different here every time you login.

I needed it so that I could see how the messages to the different inverters are structured.

  let login = await Growatt.demoLogin().catch(e => {console.log(e)})

Get all plant data

Parameter	Type	Default	Description
option	Object	See below	Controls the processing

This function knows the individual types of the inverter and calls up the data.

This function can be controlled via an option so that you don't always have to call up all the data that is possible:

Option

Option	Type	Default	Description
plantData	Boolean	true	True calls the description dataset of the plant.
deviceData	Boolean	true	True calls the description dataset of the plantdevice.
weather	Boolean	true	True calls the weather dataset of the plant.
plantId	Integer	undefined	The ID of a plant. So that the output can be restricted. Attention, the ID is constantly changing on demologin.
totalData	Boolean	true	Retrieves the data integrals. The sums since start time.
statusData	Boolean	true	This is not available for all systems. Here, the current operating status, fuel injection, battery charge and generation is called up. However, the data is also contained in historyLast.
deviceTyp	Boolean	false	Add the device typ to the Output.
historyLast	Boolean	true	The last data record from the system history table is called up here.
historyLastStartDate	new Date()	tomorrow	The start time for retrieving the history.
historyLastEndDate	new Date()	yesterday	The end time for retrieving the history.
chartLast	Boolean	false	deprecated please use historyLast
chartLastDate	new Date()	now	deprecated please use historyLast
chartLastArrayAsJson	Boolean	true	deprecated please use historyLast
chartLastArray	Boolean	false	deprecated please use historyLast

The call

After waiting to log in with await. Can the data be retrieved using this method. In response, an object comes out that contains the data of the length.

  options = {plantData:false,deviceData:true,deviceTyp:true,weather:false,chartLastArray:true}
  let getAllPlantData = await growatt.getAllPlantData(options).catch(e => {console.log(e)})
  console.log('getAllPlatData:',JSON.stringify(getAllPlantData,null,' '));

Logout

After retrieving the data, you should log out of the page again. It is the same call for all three login variants.

  let logout = await growatt.logout().catch(e => {console.log(e)})

isConnected()

It is also possible to have the connection open and to check whether the API is still connected.

  if (growatt.isConnected()) {
  }

Speedup data interval

You can set the logger interval from 5 minutes to 1 minute

Remove the rubber plug of the KEY button from ShineWiFi-S, and short press the button inside. The blue LED will light up. Use your phone or computer to connect to the wireless network emitted by the ShineWiFi-S module. The network name/SSID is the serial number of the ShineWiFi-S module.

Login Page

After the connection is successfully established, open the web browser on your phone or computer and type 192.168.10.100 in the address bar. The username is admin, the default password is 12345678. Login Page

Advanced Settings

Change the data interval time to 1 minute Advanced Settings

System Restart

Restart your ShineWiFi-S module on this page, click “Restart Immediate” to enable the new settings you just made and logout from the internal webserver of your ShineWiFi module. System Restart

There is no change to the charts on growatt side. There you can only see a change in the data from the datalogger.

License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!