helyos_agent_sdk.models module

class helyos_agent_sdk.models.ASSIGNMENT_STATUS(value)

Bases: str, Enum

An enumeration.

ACTIVE = 'active'

SUCCEEDED = 'succeeded'

CANCELED = 'canceled'

ABORTED = 'aborted'

FAILED = 'failed'

TO_EXECUTE = 'to_execute'

EXECUTING = 'executing'

class helyos_agent_sdk.models.AGENT_STATE(value)

Bases: str, Enum

An enumeration.

NOT_AUTO = 'not_automatable'

FREE = 'free'

BUSY = 'busy'

READY = 'ready'

class helyos_agent_sdk.models.ASSIGNMENT_MESSAGE_TYPE(value)

Bases: str, Enum

An enumeration.

EXECUTION = 'assignment_execution'

class helyos_agent_sdk.models.INSTANT_ACTIONS_TYPE(value)

Bases: str, Enum

An enumeration.

CANCEL = 'assignment_cancel'

WPCLEREANCE = 'wp_clearance_request'

RESERVE = 'reserve_for_mission'

RELEASE = 'release_from_mission'

class helyos_agent_sdk.models.AGENT_MESSAGE_TYPE(value)

Bases: str, Enum

An enumeration.

MISSION = 'mission_request'

STATE = 'agent_state'

SENSORS = 'agent_sensors'

UPDATE = 'agent_update'

CHECKIN = 'checkin'

class helyos_agent_sdk.models.AgentCurrentResources(operation_types_available: List[str], work_process_id: int, reserved: bool)

Bases: object

operation_types_available: List[str]

work_process_id: int

reserved: bool

__init__(operation_types_available: List[str], work_process_id: int, reserved: bool) → None

class helyos_agent_sdk.models.AssignmentCurrentStatus(id: str, status: helyos_agent_sdk.models.ASSIGNMENT_STATUS, result: dict)

Bases: object

id: str

status: ASSIGNMENT_STATUS

result: dict

__init__(id: str, status: ASSIGNMENT_STATUS, result: dict) → None

class helyos_agent_sdk.models.AgentStateBody(status: helyos_agent_sdk.models.AGENT_STATE, resources: helyos_agent_sdk.models.AgentCurrentResources, assignment: helyos_agent_sdk.models.AssignmentCurrentStatus)

Bases: object

status: AGENT_STATE

resources: AgentCurrentResources

assignment: AssignmentCurrentStatus

__init__(status: AGENT_STATE, resources: AgentCurrentResources, assignment: AssignmentCurrentStatus) → None

class helyos_agent_sdk.models.AssignmentMetadata(id: int = 0, work_process_id: int = 0, yard_id: int = 0, status: str = <ASSIGNMENT_STATUS.TO_EXECUTE: 'to_execute'>, start_time_stamp: float = datetime.datetime(2023, 12, 13, 12, 53, 24, 92606), context: dict = <factory>)

Bases: object

id: int = 0

work_process_id: int = 0

yard_id: int = 0

status: str = 'to_execute'

start_time_stamp: float = datetime.datetime(2023, 12, 13, 12, 53, 24, 92606)

context: dict

__init__(id: int = 0, work_process_id: int = 0, yard_id: int = 0, status: str = ASSIGNMENT_STATUS.TO_EXECUTE, start_time_stamp: float = datetime.datetime(2023, 12, 13, 12, 53, 24, 92606), context: dict = <factory>) → None

class helyos_agent_sdk.models.WorkProcessResourcesRequest(work_process_id: int, operation_types_required: List[str] = <factory>, reserved: bool = False)

Bases: object

work_process_id: int

operation_types_required: List[str]

reserved: bool = False

__init__(work_process_id: int, operation_types_required: ~typing.List[str] = <factory>, reserved: bool = False) → None

class helyos_agent_sdk.models.Pose(x: float = 0, y: float = 0, z: float = 0, orientations: List[float] = <factory>)

Bases: object

x: float = 0

y: float = 0

z: float = 0

orientations: List[float]

__init__(x: float = 0, y: float = 0, z: float = 0, orientations: ~typing.List[float] = <factory>) → None

class helyos_agent_sdk.models.AgentCheckinData(name: str = '', code: str = '', factsheet: dict = <factory>, pose: helyos_agent_sdk.models.Pose = <class 'helyos_agent_sdk.models.Pose'>, data_format: str = '', is_actuator: bool = True, unit: str = 'mm')

Bases: object

name: str = ''

code: str = ''

factsheet: dict

pose: alias of Pose

data_format: str = ''

is_actuator: bool = True

unit: str = 'mm'

__init__(name: str = '', code: str = '', factsheet: dict = <factory>, pose: ~helyos_agent_sdk.models.Pose = <class 'helyos_agent_sdk.models.Pose'>, data_format: str = '', is_actuator: bool = True, unit: str = 'mm') → None

class helyos_agent_sdk.models.AgentStateMessage(uuid: str, body: helyos_agent_sdk.models.AgentStateBody)

Bases: object

uuid: str

body: AgentStateBody

type = 'agent_state'

__init__(uuid: str, body: AgentStateBody) → None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class helyos_agent_sdk.models.MissionRequestMessage(uuid: str, body: dict)

Bases: object

uuid: str

body: dict

type = 'mission_request'

__init__(uuid: str, body: dict) → None

classmethod from_dict(kvs: Optional[Union[dict, list, str, int, float, bool]], *, infer_missing=False) → A

classmethod from_json(s: Union[str, bytes, bytearray], *, parse_float=None, parse_int=None, parse_constant=None, infer_missing=False, **kw) → A

classmethod schema(*, infer_missing: bool = False, only=None, exclude=(), many: bool = False, context=None, load_only=(), dump_only=(), partial: bool = False, unknown=None) → SchemaF[A]

to_dict(encode_json=False) → Dict[str, Optional[Union[dict, list, str, int, float, bool]]]

to_json(*, skipkeys: bool = False, ensure_ascii: bool = True, check_circular: bool = True, allow_nan: bool = True, indent: Optional[Union[int, str]] = None, separators: Optional[Tuple[str, str]] = None, default: Optional[Callable] = None, sort_keys: bool = False, **kw) → str

class helyos_agent_sdk.models.CheckinResponseMessage(uuid: str, body: dict, _version: str = '', type: str = <AGENT_MESSAGE_TYPE.CHECKIN: 'checkin'>, metadata: dict = <factory>)

Bases: object

uuid: str

body: dict

type: str = 'checkin'

metadata: dict

__init__(uuid: str, body: dict, _version: str = '', type: str = AGENT_MESSAGE_TYPE.CHECKIN, metadata: dict = <factory>) → None

class helyos_agent_sdk.models.AssignmentCommandMessage(uuid: str, body: dict, _version: str = '', type: helyos_agent_sdk.models.ASSIGNMENT_MESSAGE_TYPE = <ASSIGNMENT_MESSAGE_TYPE.EXECUTION: 'assignment_execution'>, metadata: helyos_agent_sdk.models.AssignmentMetadata = <factory>)

Bases: object

uuid: str

body: dict

type: ASSIGNMENT_MESSAGE_TYPE = 'assignment_execution'

metadata: AssignmentMetadata

__init__(uuid: str, body: dict, _version: str = '', type: ~helyos_agent_sdk.models.ASSIGNMENT_MESSAGE_TYPE = ASSIGNMENT_MESSAGE_TYPE.EXECUTION, metadata: ~helyos_agent_sdk.models.AssignmentMetadata = <factory>) → None

class helyos_agent_sdk.models.AssignmentCancelMessage(uuid: str, body: dict, _version: str = '', type: helyos_agent_sdk.models.INSTANT_ACTIONS_TYPE = <INSTANT_ACTIONS_TYPE.CANCEL: 'assignment_cancel'>, metadata: helyos_agent_sdk.models.AssignmentMetadata = <factory>)

Bases: object

uuid: str

body: dict

type: INSTANT_ACTIONS_TYPE = 'assignment_cancel'

metadata: AssignmentMetadata

__init__(uuid: str, body: dict, _version: str = '', type: ~helyos_agent_sdk.models.INSTANT_ACTIONS_TYPE = INSTANT_ACTIONS_TYPE.CANCEL, metadata: ~helyos_agent_sdk.models.AssignmentMetadata = <factory>) → None

class helyos_agent_sdk.models.WorkProcessClearanceMessage(uuid: str, body: helyos_agent_sdk.models.WorkProcessResourcesRequest, _version: str = '', metadata: helyos_agent_sdk.models.AssignmentMetadata = <factory>)

Bases: object

type: alias of str

uuid: str

body: WorkProcessResourcesRequest

metadata: AssignmentMetadata

__init__(uuid: str, body: ~helyos_agent_sdk.models.WorkProcessResourcesRequest, _version: str = '', metadata: ~helyos_agent_sdk.models.AssignmentMetadata = <factory>) → None