Underlying PyModbus had breaking changes as of version 3.10.0

[ShaneCluning]

Underlying PyModbus had breaking changes as of version 3.10.0:

Change slave to device_id and slave= to device_id=. (#2600)

For the ModbusClientMixin.read_holding_registers() function, as such when calling read_formatted you get:
TypeError: ModbusClientMixin.read_holding_registers() got an unexpected keyword argument 'slave'

Required Fix:

replace all references to 'slave' with 'device_id' in inverter.py

inverter.py

[olivergregorius]

Hi @ShaneCluning , thanks for your report.

I'm already preparing this change. I might release it just this week. Please stay tuned.

Kind regards

[ShaneCluning]

Brilliant!

Thanks mate, I've already updated my local copy with the file I attached above and seems to be working perfectly for me :)

[olivergregorius]

Hey @ShaneCluning , I've created a beta version for testing the upgrade to pymodbus >= 3.11.0: https://github.com/olivergregorius/sun2000_modbus/releases/tag/v3.0.0-b1

Feel free to test it

[Jesus-M]

Hi, I testes and it is not working for me:

root@cinemateka:[scripts]# pip list | grep modbus
pymodbus                      3.11.3
sun2000_modbus                2.6.0
root@cinemateka:[scripts]#
root@cinemateka:[scripts]# ./test.py TimeZone
INFO:sun2000_modbus.inverter:Successfully connected to inverter
Traceback (most recent call last):
  File "/home/cinemateka/scripts/./test.py", line 20, in <module>
    value = inverter.read(getattr(registers.InverterEquipmentRegister, arg))
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/site-packages/sun2000_modbus/inverter.py", line 67, in read
    raw_value = self.read_raw_value(register, slave)
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/site-packages/sun2000_modbus/inverter.py", line 56, in read_raw_value
    register_value = self.inverter.read_holding_registers(address=register.value.address, count=register.value.quantity, slave=self.slave if slave is None else slave)
                     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: ModbusClientMixin.read_holding_registers() got an unexpected keyword argument 'slave'
root@cinemateka:[scripts]#
root@cinemateka:[scripts]#

Working fine when I go back to pymodbus 3.9.2. Do I need to change anything in my script to adapt to the new release?

root@cinemateka:[scripts]# pip list | grep modbus
pymodbus                      3.9.2
sun2000_modbus                2.6.0
root@cinemateka:[scripts]#
root@cinemateka:[scripts]#
root@cinemateka:[scripts]# ./test.py TimeZone
INFO:sun2000_modbus.inverter:Successfully connected to inverter
inverter.read_raw_value(registers.InverterEquipmentRegister.TimeZone) ->  0.0
root@cinemateka:[scripts]#

Thanks!

[olivergregorius]

Hey @Jesus-M , you are still using the sun2000_modbus version 2.6.0 and not the updated beta version 3.0.0-b1 linked above, which adds compatibility to pymodbus>=3.11.0

[Jesus-M]

You are absolutely right and I didn't have enough coffee today :-(

All working perfectly well

root@cinemateka:[scripts]#
root@cinemateka:[scripts]# pip list | grep modbus
pymodbus                      3.11.3
sun2000_modbus                3.0.0b1
root@cinemateka:[scripts]#
root@cinemateka:[scripts]#
root@cinemateka:[scripts]# ./test.py Model ModelID NumberOfPVStrings SystemTime
INFO:sun2000_modbus.inverter:Successfully connected to inverter
inverter.read_raw_value(registers.InverterEquipmentRegister.Model) ->  SUN2000-5KTL-L1
inverter.read_raw_value(registers.InverterEquipmentRegister.ModelID) ->  344.0
inverter.read_raw_value(registers.InverterEquipmentRegister.NumberOfPVStrings) ->  2.0
inverter.read_raw_value(registers.InverterEquipmentRegister.SystemTime) ->  1762507585.0
root@cinemateka:[scripts]#