pymodbus.datastore package¶

Subpackages¶

pymodbus.datastore.database package

Submodules¶

pymodbus.datastore.context module¶

class pymodbus.datastore.context.ModbusServerContext(slaves=None, single=True)¶

Bases: object

This represents a master collection of slave contexts. If single is set to true, it will be treated as a single context so every unit-id returns the same context. If single is set to false, it will be interpreted as a collection of slave contexts.

slaves()¶

class pymodbus.datastore.context.ModbusSlaveContext(*args, **kwargs)¶

Bases: pymodbus.interfaces.IModbusSlaveContext

This creates a modbus data model with each data access stored in its own personal block

getValues(fx, address, count=1)¶

Validates the request to make sure it is in range

Parameters:	fx – The function we are working with address – The starting address count – The number of values to retrieve
Returns:	The requested values from a:a+c

reset()¶: Resets all the datastores to their default values

setValues(fx, address, values)¶

Sets the datastore with the supplied values

Parameters:	fx – The function we are working with address – The starting address values – The new values to be set

validate(fx, address, count=1)¶

Validates the request to make sure it is in range

Parameters:	fx – The function we are working with address – The starting address count – The number of values to test
Returns:	True if the request in within range, False otherwise

pymodbus.datastore.remote module¶

class pymodbus.datastore.remote.RemoteSlaveContext(client, unit=None)¶

Bases: pymodbus.interfaces.IModbusSlaveContext

TODO This creates a modbus data model that connects to a remote device (depending on the client used)

getValues(fx, address, count=1)¶

Validates the request to make sure it is in range

Parameters:	fx – The function we are working with address – The starting address count – The number of values to retrieve
Returns:	The requested values from a:a+c

reset()¶: Resets all the datastores to their default values

setValues(fx, address, values)¶

Sets the datastore with the supplied values

Parameters:	fx – The function we are working with address – The starting address values – The new values to be set

validate(fx, address, count=1)¶

Validates the request to make sure it is in range

Parameters:	fx – The function we are working with address – The starting address count – The number of values to test
Returns:	True if the request in within range, False otherwise

pymodbus.datastore.store module¶

Modbus Server Datastore¶

For each server, you will create a ModbusServerContext and pass in the default address space for each data access. The class will create and manage the data.

Further modification of said data accesses should be performed with [get,set][access]Values(address, count)

Datastore Implementation¶

There are two ways that the server datastore can be implemented. The first is a complete range from ‘address’ start to ‘count’ number of indecies. This can be thought of as a straight array:

data = range(1, 1 + count)
[1,2,3,...,count]

The other way that the datastore can be implemented (and how many devices implement it) is a associate-array:

data = {1:'1', 3:'3', ..., count:'count'}
[1,3,...,count]

The difference between the two is that the latter will allow arbitrary gaps in its datastore while the former will not. This is seen quite commonly in some modbus implementations. What follows is a clear example from the field:

Say a company makes two devices to monitor power usage on a rack. One works with three-phase and the other with a single phase. The company will dictate a modbus data mapping such that registers:

n:      phase 1 power
n+1:    phase 2 power
n+2:    phase 3 power

Using this, layout, the first device will implement n, n+1, and n+2, however, the second device may set the latter two values to 0 or will simply not implmented the registers thus causing a single read or a range read to fail.

I have both methods implemented, and leave it up to the user to change based on their preference.

class pymodbus.datastore.store.BaseModbusDataBlock¶

Bases: object

Base class for a modbus datastore

Derived classes must create the following fields:: @address The starting address point @defult_value The default value of the datastore @values The actual datastore values
Derived classes must implemented the following methods:: validate(self, address, count=1) getValues(self, address, count=1) setValues(self, address, values)

default(count, value=False)¶

Used to initialize a store to one value

Parameters:	count – The number of fields to set value – The default value to set to the fields

getValues(address, count=1)¶

Returns the requested values from the datastore

Parameters:	address – The starting address count – The number of values to retrieve
Returns:	The requested values from a:a+c

reset()¶: Resets the datastore to the initialized default value

setValues(address, values)¶

Returns the requested values from the datastore

Parameters:	address – The starting address values – The values to store

validate(address, count=1)¶

Checks to see if the request is in range

Parameters:	address – The starting address count – The number of values to test for
Returns:	True if the request in within range, False otherwise

class pymodbus.datastore.store.ModbusSequentialDataBlock(address, values)¶

Bases: pymodbus.datastore.store.BaseModbusDataBlock

Creates a sequential modbus datastore

classmethod create(klass)¶

Factory method to create a datastore with the full address space initialized to 0x00

Returns:	An initialized datastore

getValues(address, count=1)¶

Returns the requested values of the datastore

Parameters:	address – The starting address count – The number of values to retrieve
Returns:	The requested values from a:a+c

setValues(address, values)¶

Sets the requested values of the datastore

Parameters:	address – The starting address values – The new values to be set

validate(address, count=1)¶

Checks to see if the request is in range

Parameters:	address – The starting address count – The number of values to test for
Returns:	True if the request in within range, False otherwise

class pymodbus.datastore.store.ModbusSparseDataBlock(values)¶

Bases: pymodbus.datastore.store.BaseModbusDataBlock

Creates a sparse modbus datastore

classmethod create(klass)¶

Factory method to create a datastore with the full address space initialized to 0x00

Returns:	An initialized datastore

getValues(address, count=1)¶

Returns the requested values of the datastore

Parameters:	address – The starting address count – The number of values to retrieve
Returns:	The requested values from a:a+c

setValues(address, values)¶

Sets the requested values of the datastore

Parameters:	address – The starting address values – The new values to be set

validate(address, count=1)¶

Checks to see if the request is in range

Parameters:	address – The starting address count – The number of values to test for
Returns:	True if the request in within range, False otherwise

Module contents¶

class pymodbus.datastore.ModbusSequentialDataBlock(address, values)¶

Bases: pymodbus.datastore.store.BaseModbusDataBlock

Creates a sequential modbus datastore

classmethod create(klass)¶

Factory method to create a datastore with the full address space initialized to 0x00

Returns:	An initialized datastore

getValues(address, count=1)¶

Returns the requested values of the datastore

Parameters:	address – The starting address count – The number of values to retrieve
Returns:	The requested values from a:a+c

setValues(address, values)¶

Sets the requested values of the datastore

Parameters:	address – The starting address values – The new values to be set

validate(address, count=1)¶

Checks to see if the request is in range

Parameters:	address – The starting address count – The number of values to test for
Returns:	True if the request in within range, False otherwise

class pymodbus.datastore.ModbusSparseDataBlock(values)¶

Bases: pymodbus.datastore.store.BaseModbusDataBlock

Creates a sparse modbus datastore

classmethod create(klass)¶

Factory method to create a datastore with the full address space initialized to 0x00

Returns:	An initialized datastore

getValues(address, count=1)¶

Returns the requested values of the datastore

Parameters:	address – The starting address count – The number of values to retrieve
Returns:	The requested values from a:a+c

setValues(address, values)¶

Sets the requested values of the datastore

Parameters:	address – The starting address values – The new values to be set

validate(address, count=1)¶

Checks to see if the request is in range

Parameters:	address – The starting address count – The number of values to test for
Returns:	True if the request in within range, False otherwise

class pymodbus.datastore.ModbusSlaveContext(*args, **kwargs)¶

Bases: pymodbus.interfaces.IModbusSlaveContext

This creates a modbus data model with each data access stored in its own personal block

getValues(fx, address, count=1)¶

Validates the request to make sure it is in range

Parameters:	fx – The function we are working with address – The starting address count – The number of values to retrieve
Returns:	The requested values from a:a+c

reset()¶: Resets all the datastores to their default values

setValues(fx, address, values)¶

Sets the datastore with the supplied values

Parameters:	fx – The function we are working with address – The starting address values – The new values to be set

validate(fx, address, count=1)¶

Validates the request to make sure it is in range

Parameters:	fx – The function we are working with address – The starting address count – The number of values to test
Returns:	True if the request in within range, False otherwise

class pymodbus.datastore.ModbusServerContext(slaves=None, single=True)¶

Bases: object

This represents a master collection of slave contexts. If single is set to true, it will be treated as a single context so every unit-id returns the same context. If single is set to false, it will be interpreted as a collection of slave contexts.

slaves()¶