Unsure what to replace in the redback_inverter_mode.yaml

[LachyGoshi]

Unsure what to replace in the redback_inverter_mode.yaml

[LachyGoshi]

i have also tried:

serialNumber: "RB23456789"
swVersion: "2.18.32305.2"

and with single quotes:
serialNumber: 'RB123456789'
swVersion: '2.18.32305.2'

[LachyGoshi]

I have also noticed that installing pyscript via hacs, it creates a pyscript folder at /config/custom_components/pyscript/

which looks normal when comparing to all other integrations I have added via hacs,

however, there is also a pyscript folder created directly in the config folder at /config/pyscript/

which one should I be copying your scripts to?

[LachyGoshi]

OK - ignore this for now, looks like i got it working (although had to hard code my serial number and software version in to the files as could not work out how to utilize the existing redback integration from Juice.

i will try and provide feedback to the process next week - there was alot of details different such as file locations and additional front end card things to install.

Amazing to have this control! thanks so much.

[cabberley]

Thanks
Sorry the difficulties you had with the serial and sw version sensors is due to my enhancements to juices code. Those sensors come from that integration, part of the updates I have pending for merging into that.
Sometime when I get enough time and in the coding mood, I will probably rewrite/merge everything into a single integration. I need to catchup with a friend I have at redback and ask again if they will expose via the api the inverter control.
Also atm, redback doesn't expose to customers the inverter modes that do curtailment, they are there in the inverter which is actually a GoodWe, they just have chosen in their product not to enable customers to use them.

[cabberley]

I have also noticed that installing pyscript via hacs, it creates a pyscript folder at /config/custom_components/pyscript/

which looks normal when comparing to all other integrations I have added via hacs,

however, there is also a pyscript folder created directly in the config folder at /config/pyscript/

which one should I be copying your scripts to?

So the HACS custom folder is where pyscript stores its code to enable Python scripts, the config/pyscripts folder is where you store scripts you create and want to run I.e this code.

[raeffer]

Wow I have wasted hours trying to get this to work. Thought it was my crap novice computer skills. I did find a typo in the secrets file with the use of 'redpack_password' instead of 'redback_password' but despite my enthusiasm fixing it didnt help.

@LachyGoshi any help would be greatly appreciated!
@cabberley this thread might be of interest to you also

https://community.home-assistant.io/t/syntax-error-creating-rest-sensor-from-api-call/470809?u=raeffer

[raeffer]

Sorry that last response doesn't read how intended. I meant like WOW I have finally figured out why it wasn't working and it wasn't me. I just wanted @cabberley to get a thankyou for the his work.

[cabberley]

Sorry for the typo in the secrets file. I have fixed that.

[cabberley]

It is been a while, looks like about 12 months since I touched this stuff. But did fork juices code and run my customised version which never got merged by Juice.
You might find that helpful as well. The readme o wrote here may have been on the assumption he would merge the code I started a pull request for.

[raeffer]

Sorry I am an idiot. I am not sure what that all means. I am not a programmer.
I am really keen to get this functionality working though. I have installed everything as per your read me ....the only bit I am not sure about is the what to replace in the redback_inverter_mode.yaml. But from your previous response 'Sorry the difficulties you had with the serial and sw version sensors is due to my enhancements to juices code. Those sensors come from that integration, part of the updates I have pending for merging into that.' Do we have to do something different now?

[LachyGoshi]

Yeah I remember I spent a bit of time copying and pasting serial numbers and stuff into various sections.

I'll have a look at my files over the weekend and let you know of I can reverse engineer what I actually did to get it working. To be honest, once I got it working I haven't had to touch it. I have even upgraded my home assistance from RPI to virtual and all o had to do after restoring my backup was re authorise the integration and log back in. No issues at all.

Will report back next week.

[raeffer]

@LachyGoshi That is awesome! Thanks so much.

[raeffer]

Not sure this helps in diagnostics but I am getting this error,

Logger: custom_components.pyscript.file.redback_inverter_service
Source: custom_components/pyscript/global_ctx.py:341
integration: Pyscript Python scripting (documentation, issues)
First occurred: 8:26:44 AM (2 occurrences)
Last logged: 8:32:04 AM

Exception in </config/pyscript/redback_inverter_service.py> line 1: import redback_function ^ ModuleNotFoundError: No module named 'redback_function'

But I have copied the modules folder and the redback_function script to my psyscript folder as seen in screenshot

[LachyGoshi]

ok, had a quick look through my config files and the readme's for both Juices integration (https://github.com/juicejuice/homeassistant_redback) and Chriss' Inverter Mode Set integration (https://github.com/cabberley/Home-Assistant_Redback_Invertor_Mode_Set) as well as the Pyscript pages (https://hacs-pyscript.readthedocs.io/en/stable/). I also had to install the layout card (https://github.com/thomasloven/lovelace-layout-card) as from memory, the example Chris gives for a card also relies on this layout card to be installed.... I think i remember having everything actually working sooner but just the display wasn't working until I installed this lovelace card.

essentially, Chris has a number of changes to juices integration that Juice has not merged in yet - ( @cabberley let me know if i can help get this done - i have a single phase SH5000 hybrid system. ) - and because these changes are not in juices integration, I had to manually hard code a few parameters such as serial number, swVersion and ROSS Version etc and while troubleshooting i removed the secretes file and just put login details in directly.

I replaced my actual serial number with RB00000000000000 for privacy.

Here is what i have in my: /homeassistant/configuration.yaml

homeassistant:
  packages:
    redback_inverter_mode: !include /config/packages/redback_inverter_mode/redback_inverter_mode.yaml

python_script:

in my: /homeassistant/packages/redback_inverter_mode.yaml
note that i didnt have success using secrets so had email and password in this file directly.

#Create entities to setup Redback Inverter mode
input_number:
  redback_inverter_power_setting_w:
    name: 'Redback Inverter Power Set Watts'
    unit_of_measurement: W
    icon: mdi:home-lightning-bolt-outline
    initial: 0
    min: 0
    max: 10000
    step: 100
    mode: box
input_select:
  redback_inverter_mode_setting:
    name: Redback Inverter Mode Select
    options:
      - Auto
      - Charge Battery
      - Discharge Battery
      - Import Power
      - Export Power
      - Conserve
    initial: Auto
    icon: mdi:transmission-tower
input_button:
  redback_inverter_set_mode:
    name: 'Redback Inverter Mode Set'
    icon: mdi:solar-power-variant
script:
  redback_inverter_mode_update:
    alias: Redback Inverter Mode Update
    sequence:
      - service: pyscript.set_invertor_mode
        data:
          email: '[email protected]'
          password: 'password'
          serialNumber: "RB00000000000000"
          swVersion: "2.18.32305.2"
          inverterMode: "{{ states( \"input_select.redback_inverter_mode_Setting\") | replace(\" \",\"\") }}"
          inverterPower: "{{ states( \"input_number.redback_inverter_power_setting_w\") | int }}"
    mode: queued
    max: 2

as is a common theme you will see with me, i was unsure of exact folder structure, so i also created a sub directory /homeassistant/packages/redback_inverter_mode/ where i had the same detail:

in my: /homeassistant/packages/redback_inverter_mode/redback_inverter_mode.yaml

#Create entities to setup Redback Inverter mode
input_number:
  redback_inverter_power_setting_w:
    name: 'Redback Inverter Power Set Watts'
    unit_of_measurement: W
    icon: mdi:home-lightning-bolt-outline
    initial: 0
    min: 0
    max: 10000
    step: 100
    mode: box
input_select:
  redback_inverter_mode_setting:
    name: Redback Inverter Mode Select
    options:
      - Auto
      - Charge Battery
      - Discharge Battery
      - Import Power
      - Export Power
      - Conserve
    initial: Auto
    icon: mdi:transmission-tower
input_button:
  redback_inverter_set_mode:
    name: 'Redback Inverter Mode Set'
    icon: mdi:solar-power-variant
script:
  redback_inverter_mode_update:
    alias: Redback Inverter Mode Update
    sequence:
      - service: pyscript.set_invertor_mode
        data:
          email: '[email protected]'
          password: 'password'
          serialNumber: 'RB00000000000000'
          swVersion: '2.18.32305.2'
          inverterMode: "{{ states( \"input_select.redback_inverter_mode_Setting\") | replace(\" \",\"\") }}"
          inverterPower: "{{ states( \"input_number.redback_inverter_power_setting_w\") | int }}"
    mode: queued
    max: 2

Only just now I am noting that the serial number and login details are within 'single' quotations unlike the file above in "double" quotations. I don't know if there is any logical difference.

in my: /homeassistant/pyscript/redback_inverter_service.py

import redback_function

@service
def set_invertor_mode(email,password, serialNumber, inverterMode, inverterPower, swVersion):
    if email =='secret':
        email = pyscript.config['secrets']['redback_email']
    if password =='secret':
        password = pyscript.config['secrets']['redback_password']
    if email =='' or password =='' or serialNumber =='' or inverterMode =='' or swVersion =='':
        return 'Error: Missing parameter'
    setInverter = redback_function.setInverterMode(rbEmail= email, rbPassword=password, rbSerialNumber='RB00000000000000', rbInverterMode=inverterMode, rbInverterPower=inverterPower, rbRossVersion='2.18.32305.2')

Now I still dont know on the exact file / folder structure required, so in
/homeassistant/pyscript/modules/
i have copies of the .py scripts, but also created a sub directory
/homeassistant/pyscript/modules/redback_inverter_mode/
that has the same .py script files. I don't know which location the integration actually calls but this double up structure works for me so I've left it. (side note, i had originally had all these .py script files in /homeassistant/custom_components/pyscript/modules/redback_inverter_mode/ but @cabberley confirmed above that this is the WRONG location for them as the custom_components is just for the pyscipt integration an not any sub scripts that is uses).
I have copies of all my scripts below.

in my: /homeassistant/pyscript/modules/redback_function.py

from bs4 import BeautifulSoup
import requests
import requests_oauthlib

@pyscript_executor

def setInverterMode(rbEmail, rbPassword, rbSerialNumber,  rbInverterMode,  rbInverterPower, rbRossVersion):
    loginUrl = "https://portal.redbacktech.com/Account/Login"
    configureurl = 'https://portal.redbacktech.com/productcontrol/Configure?serialNumber=RB00000000000000'
    inverterSetUrl = 'https://portal.redbacktech.com/productcontrol/Index'
    s = requests.Session()
    redbackLogin = s.get(loginUrl)
    soup = BeautifulSoup(redbackLogin.content , features="html.parser")
    form = soup.find("form", class_="login-form")
    hidden_input = form.find("input", type="hidden")
    globalAntiForgeryToken = hidden_input.attrs['value']
    redbackReq = s.post(loginUrl, data={"Email": rbEmail, "Password": rbPassword,"__RequestVerificationToken": globalAntiForgeryToken})
    redbackReq.raise_for_status()
    redbackSetInverter = s.get(configureurl)
    redbackSetInverter.raise_for_status()
    soup = BeautifulSoup(redbackSetInverter.content , features='html.parser')
    globalAntiForgeryToken = soup.find('form', id='GlobalAntiForgeryToken')
    hidden_input = globalAntiForgeryToken.find("input", type="hidden")
    globalAntiForgeryToken = hidden_input.attrs['value']
    inverterOperationType='Set'
    headers = {'X-Requested-With': 'XMLHttpRequest', 'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8', 'Referer': 'https://portal.redbacktech.com/productcontrol/Configure?serialNumber=' + rbSerialNumber}
    body = {'SerialNumber': rbSerialNumber,'AppliedTariffId':'','InverterOperation[Type]':inverterOperationType,'InverterOperation[Mode]':rbInverterMode, 'InverterOperation[PowerInWatts]':rbInverterPower, 'InverterOperation[AppliedTarrifId]':'','ProductModelName': '','RossVersion':rbRossVersion,'__RequestVerificationToken': globalAntiForgeryToken} 
    redbackSetInverter = s.post(inverterSetUrl, data = body,headers = headers)
    redbackSetInverter.raise_for_status()
    return redbackSetInverter.text

now I wasnt exactly sure on the folder and file structure in Pyscript, so I also have another sub directory with

/homeassistant/pyscript/modules/redback_inverter_mode/redback_function.py

from bs4 import BeautifulSoup
import requests
import requests_oauthlib

@pyscript_executor

def setInverterMode(rbEmail, rbPassword, rbSerialNumber,  rbInverterMode,  rbInverterPower, rbRossVersion):
    loginUrl = "https://portal.redbacktech.com/Account/Login"
    configureurl = 'https://portal.redbacktech.com/productcontrol/Configure?serialNumber=RB00000000000000'
    inverterSetUrl = 'https://portal.redbacktech.com/productcontrol/Index'
    s = requests.Session()
    redbackLogin = s.get(loginUrl)
    soup = BeautifulSoup(redbackLogin.content , features="html.parser")
    form = soup.find("form", class_="login-form")
    hidden_input = form.find("input", type="hidden")
    globalAntiForgeryToken = hidden_input.attrs['value']
    redbackReq = s.post(loginUrl, data={"Email": rbEmail, "Password": rbPassword,"__RequestVerificationToken": globalAntiForgeryToken})
    redbackReq.raise_for_status()
    redbackSetInverter = s.get(configureurl)
    redbackSetInverter.raise_for_status()
    soup = BeautifulSoup(redbackSetInverter.content , features='html.parser')
    globalAntiForgeryToken = soup.find('form', id='GlobalAntiForgeryToken')
    hidden_input = globalAntiForgeryToken.find("input", type="hidden")
    globalAntiForgeryToken = hidden_input.attrs['value']
    inverterOperationType='Set'
    headers = {'X-Requested-With': 'XMLHttpRequest', 'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8', 'Referer': 'https://portal.redbacktech.com/productcontrol/Configure?serialNumber=' + rbSerialNumber}
    body = {'SerialNumber': rbSerialNumber,'AppliedTariffId':'','InverterOperation[Type]':inverterOperationType,'InverterOperation[Mode]':rbInverterMode, 'InverterOperation[PowerInWatts]':rbInverterPower, 'InverterOperation[AppliedTarrifId]':'','ProductModelName': '','RossVersion':rbRossVersion,'__RequestVerificationToken': globalAntiForgeryToken} 
    redbackSetInverter = s.post(inverterSetUrl, data = body,headers = headers)
    redbackSetInverter.raise_for_status()
    return redbackSetInverter.text)

So as you can see its the same script file as the redback_function.py in the folder above.

Hopefully this helps, and if you have Juices integration working, then get pyscript installed and running (i use the GUI once its installed to Allow All Imports and Access hass as a global variable), then have your files in configuration.yaml and /homeassistant/pyscript and /homeassistant/packages/ directories as i have shared above, yours should also work. I used no secret files and manually entered login details, serial number, swVersion and ROSS version and i doubled up everywhere in Packages and Pyscript. Maybe now Chis may be able to confirm exact locations that are required.... its all new to me and i haven't touched it since i got it working.

That's about all I can offer as i am definitely no coder or programmer.

I think it would be easier if Juice approved Chris' Pull request from July last year and then a lot of the name mapping would be simpler... in a perfect world, both integrations would be merged in to a single one.... I'm happy to help test what ever is needed, I have an SI5000 straight inverter, and a SH5000 single phase hybrid with 20kwh of batteries.

Good luck, let us know how you go @raeffer

[raeffer]

I am so close! I can now see the functionality in my desktop but...

It seems I dont have the two sensors at the top even though I have the juice integration installed via HACS and working??

Also if i change the mode in the drop down in the GUI then push the button below it I get this error

Service pyscript.set_invertor_mode called service script.redback_inverter_mode_update which was not found.

[raeffer]

I have a ST10000 inverter by the way.

Also thankyou so much for making the effort to help @LachyGoshi

[cabberley]

They I am pretty sure are 2 additional sensors in my forked repo that never got merged into juices. If you look in sensors.py you will find them in there. https://github.com/cabberley/homeassistant_redback

[raeffer]

Ok i can see your sensors.py file but what do i di with it? sorry... do i copy it into the pyscript folder? or do i take out the two sensor entries and put them in my config.yaml under pyscipt:

[LachyGoshi]

Its the same for me, those 2 have never worked as I have the standard juice integration also. Glad you got it working though!

[raeffer]

Cheers @LachyGoshi for the help. Unfortunately it isn't working for me and i am not smart enough...yet... to figure it out.

When I try and use it I get this error...

Service pyscript.set_invertor_mode called service script.redback_inverter_mode_update which was not found.

[LachyGoshi]

I'm no expert either mate, but I can see the script at the bottom of the yaml file.

/homeassistant/packages/redback_inverter_mode.yaml

And I have the exact same at
/homeassistant/packages/redback_inverter_mode/redback_inverter_mode.yaml

Because I don't know what location it actually references.

Have you restarted after making any file changes?

[raeffer]

yes i have the same file in the same two positions as you. I have tried with all the data fields
email:
password:
serialNumber:
swVersion:
in single quotations, in double quotations, the first two in single and the last two in double but nothing works.

could it be a spacing of the code issue??

script:
redback_inverter_mode_update:
alias: Redback Inverter Mode Update
sequence:
- service: pyscript.set_invertor_mode
data:
email: "[email protected]"
password: "xxxxxxxx"
serialNumber: "RBxxxxxxxxxxxxxx"
swVersion: "10.0.17763.107"
inverterMode: "{{ states( "input_select.redback_inverter_mode_Setting") | replace(" ","") }}"
inverterPower: "{{ states( "input_number.redback_inverter_power_setting_w") | int }}"
mode: queued
max: 2

[LachyGoshi]

If you go into settings, automations and scenes, scripts, is your "redback inverter mode update" showing there?

Even though it won't let you edit it in the GUI, you should still be able to expand it out.

Does the format look good and similar to mine?

[raeffer]

Sorry got a bit busy with other stuff. off overseas on monday. Yes i can see it in the GUI at /settings/automations and scenes/scripts

and yes it looks exactly like yours

[cabberley]

Let me know when you're back. I have rewritten the entire integration and incorporated all the investor control into the integration instead of setting up the integration and other add ons.
But it will need to remove your existing integrations and replacing with the new one. It is beta version not prod version so it needs to be manually changed to use Beta in Hacs

[LachyGoshi]

So remove juices integration also? Does it use the API at all, or just pull everything via the portal?

I would be happy to test it for you on my dual inverter setup.

[cabberley]

It won't pick up the dual inverter atm. Only the first one.
To get the dual inverter, there's some big changes needed in the code, because of the way it was originally written.

This version I have made uses the API for the data, and the portal to tell the inverter to charge/discharge. So same functionality you have been trying to to get work. Just all wrapped into a single integration.

[cabberley]

https://github.com/cabberley/homeassistant_redback/tree/2024.05.0b3

This is the new code
Developv2 branch

[LachyGoshi]

Amazing work none the less. I'll try and have a test this weekend. I might still be able to use juices integration alongside this for the 2nd "dumb" inverter.

[cabberley]

Amazing work none the less. I'll try and have a test this weekend. I might still be able to use juices integration alongside this for the 2nd "dumb" inverter.

Because at the moment, both sets of code identify the "device" with the same identity and they both use the same custom_component folder. Mine and JuiceJuice's code can't co exist.

Until the code is modified to understand multiple invertors in the data queries and create multiple devices in HA. You can only get the one inverter.

[cabberley]

With your setup. Can you tell me more? Is the dumb inverter a redback as well? what model is it? Can you control its state in the portal.redbacktech.com? do you see both in the portal?

[LachyGoshi]

![Screenshot_20240529-192324](

https://github.com/cabberley/Home-Assistant_Redback_Invertor_Mode_Set/assets/60020083/4a8ce49b-dba1-45a7-b515-e9b98e0c6f14)

My setup is detailed here
https://github.com/juicejuice/homeassistant_redback/issues/2
As Juice used the "site I'd" identifier to specify each inverter, however now 9 see he is possibly going to change to using the "serial number" as the identifier of each system
https://github.com/juicejuice/homeassistant_redback/issues/25

I have two inverters, an SI5000 which I call the dumb inverter. Whatever pv power it generates it pumps straight onto my mains. Whatever is left from the load consumption is exported to the grid. I used juices integration to monitor the Pv generation and feed that into home assistant energy meter etc.there is no controls in the portal, just observation.

My SH5000 hybrid is the "smart" one. It has its own PV array, the battery, and it does have a current transformer ct clamp on the AC output side of the SI500 so it does know the total PV generation on site. The SH5000 is export limited by the installer to 5kw as that's what's required by my grid. So the SH knows real time status of both PV to control battery charge/discharge and/or throttle the PV of exceeding the grid export limit.

The SI5000 PV output does show in the portal when I look at the SH5000 location home page, as "other system" but none of its data is stored or graphed in the portal, and this would also be why none of it is available via the API (via the sh5000 location).

To know my total PV generation I need to combine both inverters data from the API.

Does any of that make sense? Sorry it got wordy and long.

[cabberley]

Thanks for taking the time to explain it.

Update for you, I have done the first half of completely building a proper integration for redback. If time permits I hope within the next few days maybe a week. To do the second half.

First half is the python library which interacts with redback and generates the data HA needs. A complete rewrite.

This data has been structured the right way. For each inverter a device will be created and each battery stack will be a seperate device. With the data I can get out of the APi I also get each individual battery within the stack and some other deeper insights if your that way inclined! Each batteries in/out voltage as well as the cabinets fan on/off and temp.

In theory, if I have got this right it will also support multiple redback sites/multiple inverters/multiple batteries.

[LachyGoshi]

That would be amazing. I tried to use the API to generate schedules for changing the inverter mode but that just became sooo messy and hard to handle the creation and deletion of each unique schedule id, that when I found your integration it was a life saver! For winter, I've just changed to Ovo energy as my retailer, they have 3 hours of free electricity every day 11am to 2pm. My PV sucks over the wet cloudy winter months so this way I'm guaranteed to get about 10-11kwh into the battery for free each day which sees me through the peak rate time at least. In summer time I change to whoever is going the best FIT as the PV isn't an issue and I use your integration just to trickle charge the battery so I can export as much as possible all day long due to my 5kw export limit.
I'm happy to do any testing for you when you're ready, wish I could be more help but coding is not my thing!

[cabberley]

So I have completed the first part of building a new multi inverter Integration and it's ready for some feedback.

https://github.com/cabberley/HA_RedbackTech

This uses a different custom components folder to Juice's Integration so you can run them side by side.

It will create one configuration per API credentials and will create 2 devices 1 is the Inverter/grid and the other is the Battery per RedBack Hybrid Inverter.
It should create 2 more devices for each inverter you have and surface all the data for each system.

This version also gives you detailed data about each Battery, Cabinet and MPPT string.

It doesn't have icons/logos added to HA brands yet so the redback logos don't show up yet for it.

The next version I will add in inverter control.

[LachyGoshi]

Awesome dude, good stuff, I should be able to test this out on Wednesday or Thursday for ya.

[cabberley]

@LachyGoshi @raeffer Just released a new version with full inverter control! 2024.6.1
Make sure you read the readme to understand the inverter control!
HTTPS://github.com/cabberley/ha_redbacktech