Registers
- class ingenialink.canopen.register.CanopenRegister(identifier, units, cyclic, idx, subidx, dtype, access, phy=REG_PHY.NONE, subnode=1, storage=None, reg_range=(None, None), labels=None, enums=None, enums_count=0, cat_id=None, scat_id=None, internal_use=0)[source]
CANopen Register.
- Parameters
identifier (str) – Identifier.
units (str) – Units.
cyclic (str) – Cyclic typed register.
idx (int) – Index of the register.
subidx (int) – Subindex of the 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 (list) – Enumeration registers.
enums_count (int) – Number of enumeration registers.
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.
ILValueError – If the register is invalid.
ILAccessError – Register with wrong access 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 idx
Register index.
- Type
int
- 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 subidx
Register subindex.
- Type
int
- property subnode
Target subnode of the register.
- Type
int
- property units
Units of the register.
- Type
str