Enums

class ingeniamotion.enums.CanBaudrate(value)

Bases: Enum

Baudrates.

Baudrate_1M = 1000000: 1 Mbit/s

Baudrate_500K = 500000: 500 Kbit/s

Baudrate_250K = 250000: 250 Kbit/s

Baudrate_125K = 125000: 125 Kbit/s

Baudrate_100K = 100000: 100 Kbit/s

Baudrate_50K = 50000: 50 Kbit/s

class ingeniamotion.enums.CanDevice(value)

Bases: Enum

CAN Device.

KVASER = 'kvaser'

PCAN = 'pcan'

IXXAT = 'ixxat'

VIRTUAL = 'virtual'

SOCKETCAN = 'socketcan'

class ingeniamotion.enums.RegAccess(value)

Bases: Enum

Access Type.

RW = 0: Read/Write.

RO = 1: Read-only.

WO = 2: Write-only.

property allows_read: bool

Indicates if the access type allows reading.

Return type:: bool

property allows_write: bool

Indicates if the access type allows writing.

Return type:: bool

class ingeniamotion.enums.RegDtype(value)

Bases: Enum

Data Type.

U8 = 0: Unsigned 8-bit integer.

S8 = 1: Signed 8-bit integer.

U16 = 2: Unsigned 16-bit integer.

S16 = 3: Signed 16-bit integer.

U32 = 4: Unsigned 32-bit integer.

S32 = 5: Signed 32-bit integer.

U64 = 6: Unsigned 64-bit integer.

S64 = 7: Signed 64-bit integer.

FLOAT = 8: Float.

STR = 10: String.

BYTE_ARRAY_512 = 15: Buffer with size of 512 bytes.

BOOL = 99: Boolean.

class ingeniamotion.enums.OperationMode(value)

Bases: IntEnum

Operation Mode Enum.

VOLTAGE = 0

CURRENT_AMPLIFIER = 1

CURRENT = 2

CYCLIC_CURRENT = 34

VELOCITY = 3

PROFILE_VELOCITY = 19

CYCLIC_VELOCITY = 35

POSITION = 4

PROFILE_POSITION = 20

CYCLIC_POSITION = 36

PROFILE_POSITION_S_CURVE = 68

INTERPOLATED_POSITION = 164

PVT = 180

HOMING = 275

TORQUE = 5

CYCLIC_TORQUE = 37

class ingeniamotion.enums.Protocol(value)

Bases: IntEnum

Communication protocol.

TCP = 1

UDP = 2

class ingeniamotion.enums.HomingMode(value)

Bases: IntEnum

Homing modes.

CURRENT_POSITION = 0

POSITIVE_LIMIT_SWITCH = 1

NEGATIVE_LIMIT_SWITCH = 2

POSITIVE_IDX_PULSE = 3

NEGATIVE_IDX_PULSE = 4

POSITIVE_LIMIT_SWITCH_IDX_PULSE = 5

NEGATIVE_LIMIT_SWITCH_IDX_PULSE = 6

class ingeniamotion.enums.MonitoringSoCType(value)

Bases: IntEnum

Monitoring start of condition type.

TRIGGER_EVENT_AUTO = 0: No trigger

TRIGGER_EVENT_FORCED = 1: Forced trigger

TRIGGER_EVENT_EDGE = 2: Edge trigger

class ingeniamotion.enums.MonitoringSoCConfig(value)

Bases: IntEnum

An enumeration.

TRIGGER_CONFIG_RISING_OR_FALLING = 0: Rising or falling edge trigger

TRIGGER_CONFIG_RISING = 1: Rising edge trigger

TRIGGER_CONFIG_FALLING = 2: Falling edge trigger

class ingeniamotion.enums.MonitoringProcessStage(value)

Bases: IntEnum

Monitoring process stage.

INIT_STAGE = 0: Init stage

FILLING_DELAY_DATA = 2: Filling delay data

WAITING_FOR_TRIGGER = 4: Waiting for trigger

DATA_ACQUISITION = 6: Data acquisition

END_STAGE = 8: End stage

class ingeniamotion.enums.SensorType(value)

Bases: IntEnum

Summit series feedback type enum.

ABS1 = 1: Absolute encoder 1

INTGEN = 3: Internal generator

QEI = 4: Digital/Incremental encoder 1

HALLS = 5: Digital halls

SSI2 = 6: Secondary SSI

BISSC2 = 7: Absolute encoder 2

QEI2 = 8: Digital/Incremental encoder 2

SINCOS = 10: SinCos encoder 1

class ingeniamotion.enums.SensorCategory(value)

Bases: IntEnum

Feedback category enum.

ABSOLUTE = 0

INCREMENTAL = 1

class ingeniamotion.enums.PhasingMode(value)

Bases: IntEnum

Phasing modes.

NON_FORCED = 0: Non forced

FORCED = 1: Forced

NO_PHASING = 2: No phasing

class ingeniamotion.enums.GeneratorMode(value)

Bases: IntEnum

Generator modes.

CONSTANT = 0: Constant

SAW_TOOTH = 1: Saw tooth

SQUARE = 2: Square

class ingeniamotion.enums.MonitoringVersion(value)

Bases: IntEnum

Monitoring version.

MONITORING_V1 = 0: Monitoring V1 used for Everest 1.8.1 and older.

MONITORING_V2 = 1: Monitoring V2 used for Capitan and some custom low-power drivers.

MONITORING_V3 = 2: Monitoring V3 used for Everest and Capitan newer than 1.8.1.

class ingeniamotion.enums.SeverityLevel(value)

Bases: IntEnum

Test result enum.

SUCCESS = 0

WARNING = 1

FAIL = 2

class ingeniamotion.enums.CommunicationType(value)

Bases: IntEnum

An enumeration.

Canopen = 0

Ethernet = 1

Ethercat = 2

class ingeniamotion.enums.FeedbackPolarity(value)

Bases: IntEnum

Feedback polarity enum.

NORMAL = 0

REVERSED = 1

class ingeniamotion.enums.CommutationMode(value)

Bases: IntEnum

Commutation Mode Enum.

SINUSOIDAL = 0

TRAPEZOIDAL = 1

SINGLE_PHASE = 2

class ingeniamotion.enums.FilterType(value)

Bases: IntEnum

Biquad filter type.

DISABLED = 0: Filter disabled

LOWPASS = 1: Low-pass filter

HIGHPASS = 2: High-pass filter

BANDPASS = 3: Band-pass filter

PEAK = 4: Peak filter

NOTCH = 5: Notch filter

LOWSHELF = 6: Low Shelf filter

HIGHSHELF = 7: High Shelf filter

class ingeniamotion.enums.FilterSignal(value)

Bases: Enum

Signal to configure filter.

POSITION_FEEDBACK = 'POS_FBK': Position feedback.

POSITION_REFERENCE = 'POS_REF': Position reference.

VELOCITY_FEEDBACK = 'VEL_FBK': Velocity feedback.

VELOCITY_REFERENCE = 'VEL_REF': Velocity reference.

CURRENT_FEEDBACK = 'CUR_FBK': Current feedback.

CURRENT_REFERENCE = 'CUR_REF': Current reference.

class ingeniamotion.enums.FilterNumber(value)

Bases: IntEnum

Filter number (1 or 2).

FILTER1 = 1

FILTER2 = 2

class ingeniamotion.enums.DigitalVoltageLevel(value)

Bases: IntEnum

GPIOs voltage level (HIGH/LOW) enum.

HIGH = 1

LOW = 0

class ingeniamotion.enums.GPIOPolarity(value)

Bases: IntEnum

GPIOs polarity enum.

NORMAL = 0

REVERSED = 1

class ingeniamotion.enums.GPI(value)

Bases: IntEnum

GPIs identifier enum.

GPI1 = 1

GPI2 = 2

GPI3 = 3

GPI4 = 4

class ingeniamotion.enums.GPO(value)

Bases: IntEnum

GPOs identifier enum.

GPO1 = 1

GPO2 = 2

GPO3 = 3

GPO4 = 4

class ingeniamotion.enums.FSoEState(value)

Bases: IntEnum

FSoE Master Handler state.

RESET = 0

SESSION = 1

CONNECTION = 2

PARAMETER = 3

DATA = 4

class ingeniamotion.enums.STOAbnormalLatchedStatus(value)

Bases: IntEnum

STO Abnormal Latched Status enum.

NOT_LATCHED = 0

LATCHED = 1

UNDETERMINATED = 2

class ingeniamotion.enums.RegDtype(value)

Bases: Enum

Data Type.

U8 = 0: Unsigned 8-bit integer.

S8 = 1: Signed 8-bit integer.

U16 = 2: Unsigned 16-bit integer.

S16 = 3: Signed 16-bit integer.

U32 = 4: Unsigned 32-bit integer.

S32 = 5: Signed 32-bit integer.

U64 = 6: Unsigned 64-bit integer.

S64 = 7: Signed 64-bit integer.

FLOAT = 8: Float.

STR = 10: String.

BYTE_ARRAY_512 = 15: Buffer with size of 512 bytes.

BOOL = 99: Boolean.

class ingeniamotion.enums.RegAccess(value)

Bases: Enum

Access Type.

RW = 0: Read/Write.

RO = 1: Read-only.

WO = 2: Write-only.

property allows_read: bool

Indicates if the access type allows reading.

Return type:: bool

property allows_write: bool

Indicates if the access type allows writing.

Return type:: bool

class ingeniamotion.enums.CanBaudrate(value)

Bases: Enum

Baudrates.

Baudrate_1M = 1000000: 1 Mbit/s

Baudrate_500K = 500000: 500 Kbit/s

Baudrate_250K = 250000: 250 Kbit/s

Baudrate_125K = 125000: 125 Kbit/s

Baudrate_100K = 100000: 100 Kbit/s

Baudrate_50K = 50000: 50 Kbit/s

class ingeniamotion.enums.CanDevice(value)

Bases: Enum

CAN Device.

KVASER = 'kvaser'

PCAN = 'pcan'

IXXAT = 'ixxat'

VIRTUAL = 'virtual'

SOCKETCAN = 'socketcan'