Registers

class ingenialink.canopen.register.CanopenRegister(idx: int, subidx: int, dtype: ingenialink.enums.register.REG_DTYPE, access: ingenialink.enums.register.REG_ACCESS, identifier: Optional[str] = None, units: Optional[str] = None, cyclic: str = 'CONFIG', phy: ingenialink.enums.register.REG_PHY = <REG_PHY.NONE: 0>, subnode: int = 1, storage: Optional[Any] = None, reg_range: Union[Tuple[None, None], Tuple[int, int], Tuple[float, float], Tuple[str, str]] = (None, None), labels: Optional[Dict[str, str]] = None, enums: Optional[List[Dict[str, Union[str, int]]]] = None, cat_id: Optional[str] = None, scat_id: Optional[str] = None, internal_use: int = 0, address_type: Optional[ingenialink.enums.register.REG_ADDRESS_TYPE] = None)[source]

CANopen Register.

Parameters

  • idx – Index of the register.

  • subidx – Subindex of the register.

  • dtype – Data type.

  • access – Access type.

  • identifier – Identifier.

  • units – Units.

  • cyclic – Cyclic typed register.

  • phy – Physical units.

  • subnode – Subnode.

  • storage – Storage.

  • reg_range – Range (min, max).

  • labels – Register labels.

  • enums – Enumeration registers.

  • cat_id – Category ID.

  • scat_id – Sub-category ID.

  • internal_use – Internal use.

  • address_type – Address Type.

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.

property address_type

Address type of the register.

property cat_id

Category ID

property cyclic

Defines if the register is cyclic.

property dtype

Data type of the register.

property enums

Containing all the enums for the register.

property enums_count

The number of the enums in the register.

property identifier

Register identifier.

property idx

Register index.

property internal_use

Defines if the register is only for internal uses.

property labels

Containing the labels of the register.

property mapped_address

Register mapped address used for monitoring/disturbance.

property phy

Physical units of the register.

property range

Containing the minimum and the maximum values of the register.

Type

tuple

property scat_id

Sub-Category ID

property storage

Defines if the register needs to be stored.

property storage_valid

Defines if the register storage is valid.

property subidx

Register subindex.

property subnode

Target subnode of the register.

property units

Units of the register.