nxmodbus 0.3.0

Package that let easily interact with the Next devices over Modbus RTU

Python library to access Studer-Innotec Next devices through Modbus RTU/TCP.

Prerequisites

Please read the complete documentation available on : Studer Innotec SA -> Support -> Download Center -> Software and Updates

Getting Started

1. Package installation

$ pip install nxmodbus

2. Hardware installation

• Connect your Next installation through a Next gateway (e.g. nx-interface) to your controller (personal computer, Raspberry Pi, etc.)

  • (RTU) using a USB to RS-485 adapter.

  • (TCP) using the Ethernet interface connecting to your local area network.

3. Serial configuration

This package rely on pyserial standard package, in order to use the nxmodbus package make sure to instantiate it like :

import serial

serial_port = serial.Serial(SERIAL_PORT_NAME, SERIAL_PORT_BAUDRATE, parity=serial.PARITY_EVEN, timeout=1)

• where SERIAL_PORT_NAME is your serial port interface, for example set it to ‘COM4’ (string argument) when using Windows otherwise you may set it to ‘/dev/ttyUSB0/’ on Linux

• where SERIAL_PORT_BAUDRATE is the baudrate used by your serial port interface (use the Nx-interface to set the serial parameter of the server)

4. Run an example from /examples folder

Go to /examples folder with a terminal and execute this script

$ python ex_rtu_read_param.py
$ python ex_tcp_read_param.py

Check client_rtu file or client_tcp file to understand it.

5. Open documentation

Open documentation from Read The Docs

Warnings

• Use devices addresses generated into addresses file

• It is strongly recommended NOT to spam the Next gateway with multiple requests. The correct way to communicate with the Next gateway is to send a request and to wait for the response before sending the next request. If no response comes from the nxmodbus after a delay of 1 second, we can consider that the timeout is over and another request can be send. It is also how Modbus RTU is intended to work.

Authors

Studer Innotec SA - Initial work - Studer Innotec SA

License

This project is licensed under the MIT License - see the LICENSE file for details