Models

Models used for communication with the REST API.

class pymirokai.models.data_models.BoolCommand(**data)

Bases: BaseModel

Model for a REST API command with boolean value.

Parameters:

command (str)
value (bool)

command: Command name to execute.

value: Bool value sent with the command.

command: str: The command to be executed.

value: bool: The Boolean state (True or False) that the command will apply.

class pymirokai.models.data_models.Coordinates(**data)

Bases: BaseModel

Represent 3D spatial coordinates with orientation.

Parameters:

x (float)
y (float)
z (float)
theta (float)

x: Position along the X-axis.

y: Position along the Y-axis.

z: Position along the Z-axis.

theta: Rotation around the Z-axis in degrees.

theta: float: The rotation around the Z-axis, in degrees. Default is 0.0.

to_list()

Convert the coordinate fields to a list [x, y, z].

Return type:: list[float]

x: float: The X-coordinate in space, representing horizontal movement (forward/backward). Default is 0.0.

y: float: The Y-coordinate in space, representing horizontal movement (left/right). Default is 0.0.

z: float: The Z-coordinate in space, representing vertical movement (up/down). Default is 0.0.

class pymirokai.models.data_models.DepositZone(**data)

Bases: Rune

Represents a deposit zone.

Parameters:: id (str)

class pymirokai.models.data_models.DictCommand(**data)

Bases: BaseModel

Model for a REST API command with dictionary value.

Parameters:

command (str)
value (dict)

command: Command name to execute.

value: dict value sent with the command.

command: str: The command to be executed.

value: dict: The dictionary containing configuration data or parameters for the command.

class pymirokai.models.data_models.EnchantedLocation(**data)

Bases: Rune

Represents a rune associated with a location.

Parameters:: id (str)

class pymirokai.models.data_models.EnchantedObject(**data)

Bases: Rune

Represent an enchanted rune associated with a physical object.

Parameters:: id (str)

class pymirokai.models.data_models.EnchantedUser(**data)

Bases: Rune

Represent a rune associated with a human user.

Parameters:: id (str)

class pymirokai.models.data_models.FloatCommand(**data)

Bases: BaseModel

Model for a REST API command with a floating-point value.

Parameters:

command (str)
value (float)

command: Command name to execute.

value: float value sent with the command.

command: str: The command to be executed.

value: float: The floating-point number that specifies the command’s parameter.

class pymirokai.models.data_models.IntCommand(**data)

Bases: BaseModel

Model for a REST API command with integer value.

Parameters:

command (str)
value (int)

command: Command name to execute.

value: integer value sent with the command.

command: str: The command to be executed.

value: int: The integer value necessary to carry out the command.

class pymirokai.models.data_models.ListCommand(**data)

Bases: BaseModel

Model for a REST API command with list value.

Parameters:

command (str)
value (list)

command: Command name to execute.

value: list value sent with the command.

command: str: The command name.

value: list: The list of values to be processed or configured by the command.

class pymirokai.models.data_models.Location(**data)

Bases: BaseModel

Represents a location.

Parameters:: id (str)

id: str: The location id.

class pymirokai.models.data_models.NoArgCommand(**data)

Bases: BaseModel

Represents a command with no arguments.

This model is used for commands that do not require any parameters.

Parameters:: command (str)

command: str: The command name.

class pymirokai.models.data_models.Rune(**data)

Bases: BaseModel

Represents a rune entity.

Parameters:: id (str)

id: str: The rune virtual id.

class pymirokai.models.data_models.StrCommand(**data)

Bases: BaseModel

Model for a REST API command with string value.

Parameters:

command (str)
value (str)

command: Command name to execute.

value: String value sent with the command.

command: str: The command to be executed.

value: str: The string value associated with the command.