Registers
- class ingenialink.register.REG_ACCESS(value)[source]
Access Type.
- RO = 1
Read-only.
- RW = 0
Read/Write.
- WO = 2
Write-only.
- class ingenialink.register.REG_DTYPE(value)[source]
Data Type.
- DOMAIN = 15
Domain.
- FLOAT = 8
Float.
- S16 = 3
Signed 16-bit integer.
- S32 = 5
Signed 32-bit integer.
- S64 = 7
Signed 64-bit integer.
- S8 = 1
Signed 8-bit integer.
- STR = 10
String.
- U16 = 2
Unsigned 16-bit integer.
- U32 = 4
Unsigned 32-bit integer.
- U64 = 6
Unsigned 64-bit integer.
- U8 = 0
Unsigned 8-bit integer.
- class ingenialink.register.REG_PHY(value)[source]
Physical Units.
- ACC = 4
Acceleration.
- NONE = 0
None.
- POS = 2
Position.
- RAD = 6
Radians.
- TORQUE = 1
Torque.
- VEL = 3
Velocity.
- VOLT_REL = 5
Relative voltage (DC).
- class ingenialink.register.Register(identifier, units, cyclic, dtype, access, phy=REG_PHY.NONE, subnode=1, storage=None, reg_range=None, labels=None, enums=None, enums_count=0, cat_id=None, scat_id=None, internal_use=0)[source]
Register.
- Parameters
identifier (str) – Identifier.
units (str) – Units.
cyclic (str) – Cyclic typed register.
dtype (REG_DTYPE) – Data type.
access (REG_ACCESS) – Access type.
phy (REG_PHY, optional) – Physical units.
subnode (int) – Subnode
storage (any, optional) – Storage.
reg_range (tuple, optional) – Range (min, max).
labels (dict, optional) – Register labels.
enums (dict, optional) – Enumeration values.
cat_id (str, optional) – Category ID.
scat_id (str, optional) – Sub-category ID.
internal_use (int, optional) – Internal use.
- Raises
TypeError – If any of the parameters has invalid type.
- property access
Access type of the register.
- Type
- property cat_id
Category ID
- Type
str
- property cyclic
Defines if the register is cyclic.
- Type
str
- property enums
Containing all the enums for the register.
- Type
dict
- property enums_count
The number of the enums in the register.
- Type
int
- property identifier
Register identifier.
- Type
str
- property internal_use
Defines if the register is only for internal uses.
- Type
int
- property labels
Containing the labels of the register.
- Type
dict
- property range
Containing the minimum and the maximum values of the register.
- Type
tuple
- property scat_id
Sub-Category ID
- Type
str
- property storage
Defines if the register needs to be stored.
- Type
any
- property storage_valid
Defines if the register storage is valid.
- Type
bool
- property subnode
Target subnode of the register.
- Type
int
- property units
Units of the register.
- Type
str