Information

class ingeniamotion.information.Information(motion_controller)

Information.

register_info(register, axis=1, servo='default')

Return register object.

Parameters

• register (str) – register UID.

• axis (int) – servo axis. 1 by default.

• servo (str) – servo alias to reference it. default by default.

Return type

Register

Returns

Register object.

Raises

IMRegisterNotExist – If register does not exist in dictionary.

register_type(register, axis=1, servo='default')

Return register dtype.

Parameters

• register (str) – register UID.

• axis (int) – servo axis. 1 by default.

• servo (str) – servo alias to reference it. default by default.

Return type

REG_DTYPE

Returns

Register dtype.

Raises

IMRegisterNotExist – If register does not exist in dictionary.

register_access(register, axis=1, servo='default')

Return register access.

Parameters

• register (str) – register UID.

• axis (int) – servo axis. 1 by default.

• servo (str) – servo alias to reference it. default by default.

Return type

REG_ACCESS

Returns

Register access.

Raises

IMRegisterNotExist – If register does not exist in dictionary.

register_range(register, axis=1, servo='default')

Return register range.

Parameters

• register (str) – register UID.

• axis (int) – servo axis. 1 by default.

• servo (str) – servo alias to reference it. default by default.

Return type

Tuple[int, int]

Returns

Register range, minimum and maximum.

Raises

IMRegisterNotExist – If register does not exist in dictionary.

register_exists(register, axis=1, servo='default')

Check if register exists in dictionary.

Parameters

• register (str) – register UID.

• axis (int) – servo axis. 1 by default.

• servo (str) – servo alias to reference it. default by default.

Return type

bool

Returns

True if register exists, else False.