mbserver._MbDevice Class Reference

Collaboration diagram for mbserver._MbDevice:

Public Member Functions
int	getmemsize (self)
bytes	getmemdump (self, int offset=0, int size=None)
str	getlibpath (self)
str	getprojectpath (self)
str	getprojectfile (self)
str	getname (self)
int	getflags (self)
int	getcycle (self)
int	getcount0x (self)
int	getcount1x (self)
int	getcount3x (self)
int	getcount4x (self)
int	getexcstatus (self)
	setexcstatus (self, int value)
int	getbyteorder (self)
int	getregisterorder (self)
int	getpycycle (self)
_MemoryBlockBits	getmem0x (self)
_MemoryBlockBits	getmem1x (self)
_MemoryBlockRegs	getmem3x (self)
_MemoryBlockRegs	getmem4x (self)
int	getint8 (self, adr)
	setint8 (self, adr, int value)
int	getuint8 (self, adr)
	setuint8 (self, adr, int value)
int	getint16 (self, adr)
	setint16 (self, adr, int value)
int	getuint16 (self, adr)
	setuint16 (self, adr, int value)
int	getint32 (self, adr)
	setint32 (self, adr, int value)
int	getuint32 (self, adr)
	setuint32 (self, adr, int value)
int	getint64 (self, adr)
	setint64 (self, adr, int value)
int	getuint64 (self, adr)
	setuint64 (self, adr, int value)
float	getfloat (self, adr)
	setfloat (self, adr, float value)
float	getdouble (self, adr)
	setdouble (self, adr, float value)
str	getstring (self, adr)
	setstring (self, adr, str value)

Detailed Description

Class for access device parameters.

   More details. 

Member Function Documentation

getbyteorder()

int mbserver._MbDevice.getbyteorder

(

self

)

Return byte order id of the current device as integer.

getcount0x()

int mbserver._MbDevice.getcount0x

(

self

)

Return count of coils (bits, 0x) of the current device.

getcount1x()

int mbserver._MbDevice.getcount1x

(

self

)

Return count of discrete inputs (bits, 1x) of the current device.

getcount3x()

int mbserver._MbDevice.getcount3x

(

self

)

Return count of input regs (16-bit words, 3x) of the current device.

getcount4x()

int mbserver._MbDevice.getcount4x

(

self

)

Return count of holding regs (16-bit words, 4x) of the current device.

getcycle()

int mbserver._MbDevice.getcycle

(

self

)

Return cycle counter of Modbus Server app synchronizer.

getdouble()

float mbserver._MbDevice.getdouble	(		self,
			adr )

Return 64-bit float from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

getexcstatus()

int mbserver._MbDevice.getexcstatus

(

self

)

Return exception status of the current device as integer [0:255].

getflags()

int mbserver._MbDevice.getflags

(

self

)

Return bit flags of the current device as integer.

getfloat()

float mbserver._MbDevice.getfloat	(		self,
			adr )

Return 32-bit float from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

getint16()

int mbserver._MbDevice.getint16	(		self,
			adr )

Return int16 value from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

getint32()

int mbserver._MbDevice.getint32	(		self,
			adr )

Return int32 value from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

getint64()

int mbserver._MbDevice.getint64	(		self,
			adr )

Return int64 value from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

getint8()

int mbserver._MbDevice.getint8	(		self,
			adr )

Return int8 value from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

getlibpath()

str mbserver._MbDevice.getlibpath

(

self

)

Return absolute path to the mbtools server library folder.

Note:
    Since v0.4.4

getmem0x()

_MemoryBlockBits mbserver._MbDevice.getmem0x

(

self

)

Return object that provides access to device `0x` memory.

getmem1x()

_MemoryBlockBits mbserver._MbDevice.getmem1x

(

self

)

Return object that provides access to device `1x` memory.

getmem3x()

_MemoryBlockRegs mbserver._MbDevice.getmem3x

(

self

)

Return object that provides access to device `3x` memory.

getmem4x()

_MemoryBlockRegs mbserver._MbDevice.getmem4x

(

self

)

Return object that provides access to device `4x` memory.

getname()

str mbserver._MbDevice.getname

(

self

)

Return name of the current device as string.

getprojectfile()

str mbserver._MbDevice.getprojectfile

(

self

)

Return file name of the current project.

Note:
    Since v0.4.4

getprojectpath()

str mbserver._MbDevice.getprojectpath

(

self

)

Return absolute path to the current project folder.

Note:
    Since v0.4.4

getpycycle()

int mbserver._MbDevice.getpycycle

(

self

)

Return count of cycles since python program started.

getregisterorder()

int mbserver._MbDevice.getregisterorder

(

self

)

Return register order id of the current device as integer.

getstring()

str mbserver._MbDevice.getstring	(		self,
			adr )

Return string value from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

getuint16()

int mbserver._MbDevice.getuint16	(		self,
			adr )

Return uint16 value from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

getuint32()

int mbserver._MbDevice.getuint32	(		self,
			adr )

Return uint32 value from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

getuint64()

int mbserver._MbDevice.getuint64	(		self,
			adr )

Return uint64 value from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

getuint8()

int mbserver._MbDevice.getuint8	(		self,
			adr )

Return uint8 value from memory defined by `adr`.

Args:
    adr  Address of memory. Accepts `modbus.Address` or int/str address.

Note:
    Since v0.4.4

setdouble()

mbserver._MbDevice.setdouble	(		self,
			adr,
		float	value )

Write 64-bit float into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  Float value to set.

Note:
    Since v0.4.4

setexcstatus()

mbserver._MbDevice.setexcstatus	(		self,
		int	value )

Set exception status of the current device as integer [0:255].

setfloat()

mbserver._MbDevice.setfloat	(		self,
			adr,
		float	value )

Write 32-bit float into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  Float value to set.

Note:
    Since v0.4.4

setint16()

mbserver._MbDevice.setint16	(		self,
			adr,
		int	value )

Write int16 value into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  int16 value to set.

Note:
    Since v0.4.4

setint32()

mbserver._MbDevice.setint32	(		self,
			adr,
		int	value )

Write int32 value into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  int32 value to set.

Note:
    Since v0.4.4

setint64()

mbserver._MbDevice.setint64	(		self,
			adr,
		int	value )

Write int64 value into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  int64 value to set.

Note:
    Since v0.4.4

setint8()

mbserver._MbDevice.setint8	(		self,
			adr,
		int	value )

Write int8 value into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  int8 value to set.

Note:
    Since v0.4.4

setstring()

mbserver._MbDevice.setstring	(		self,
			adr,
		str	value )

Write string value into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  String value to set.

Note:
    Since v0.4.4

setuint16()

mbserver._MbDevice.setuint16	(		self,
			adr,
		int	value )

Write uint16 value into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  uint16 value to set.

Note:
    Since v0.4.4

setuint32()

mbserver._MbDevice.setuint32	(		self,
			adr,
		int	value )

Write uint32 value into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  uint32 value to set.

Note:
    Since v0.4.4

setuint64()

mbserver._MbDevice.setuint64	(		self,
			adr,
		int	value )

Write uint64 value into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  uint64 value to set.

Note:
    Since v0.4.4

setuint8()

mbserver._MbDevice.setuint8	(		self,
			adr,
		int	value )

Write uint8 value into memory defined by `adr`.

Args:
    adr    Address of memory. Accepts `modbus.Address` or int/str address.
    value  uint8 value to set.

Note:
    Since v0.4.4

---

The documentation for this class was generated from the following file:

• mbserver.py