Examples

Basic Client Example

""" A basic client demonstrating how to use pysolarmanv5."""
from pysolarmanv5 import PySolarmanV5


def main():
    """Create new PySolarman instance, using IP address and S/N of data logger

    Only IP address and S/N of data logger are mandatory parameters. If port,
    mb_slave_id, and verbose are omitted, they will default to 8899, 1 and 0
    respectively.
    """
    modbus = PySolarmanV5(
        "192.168.1.24", 123456789, port=8899, mb_slave_id=1, verbose=False
    )

    """Query six input registers, results as a list"""
    print(modbus.read_input_registers(register_addr=33022, quantity=6))

    """Query six holding registers, results as list"""
    print(modbus.read_holding_registers(register_addr=43000, quantity=6))

    """Query single input register, result as an int"""
    print(modbus.read_input_register_formatted(register_addr=33035, quantity=1))

    """Query single input register, apply scaling, result as a float"""
    print(
        modbus.read_input_register_formatted(register_addr=33035, quantity=1, scale=0.1)
    )

    """Query two input registers, shift first register up by 16 bits, result as a signed int, """
    print(
        modbus.read_input_register_formatted(register_addr=33079, quantity=2, signed=1)
    )

    """Query single holding register, apply bitmask and bitshift left (extract bit1 from register)"""
    print(
        modbus.read_holding_register_formatted(
            register_addr=43110, quantity=1, bitmask=0x2, bitshift=1
        )
    )


if __name__ == "__main__":
    main()

Register Scan Example

""" Scan Modbus registers to find valid registers"""
from pysolarmanv5 import PySolarmanV5, V5FrameError
import umodbus.exceptions


def main():
    modbus = PySolarmanV5(
        "192.168.1.24", 123456789, port=8899, mb_slave_id=1, verbose=False
    )

    print("Scanning input registers")
    for x in range(30000, 39999):
        try:
            val = modbus.read_input_registers(register_addr=x, quantity=1)[0]
            print(f"Register: {x:05}\t\tValue: {val:05} ({val:#06x})")
        except (V5FrameError, umodbus.exceptions.IllegalDataAddressError):
            continue
    print("Finished scanning input registers")

    print("Scanning holding registers")
    for x in range(40000, 49999):
        try:
            val = modbus.read_holding_registers(register_addr=x, quantity=1)[0]
            print(f"Register: {x:05}\t\tValue: {val:05} ({val:#06x})")
        except (V5FrameError, umodbus.exceptions.IllegalDataAddressError):
            continue
    print("Finished scanning holding registers")


if __name__ == "__main__":
    main()