Skip to content

Mobility

gradysim.protocol.messages.mobility

This file defines mobility commands. Mobility commands are sent to the mobility module to instruct it to perform some mobility action, like moving the node to a new location.

GotoCoordsMobilityCommand

Bases: MobilityCommand

Represents a mobility command that instructs the mobility module to move the node to a new location. The new location is specified by its x, y, and z coordinates.

Source code in gradysim/protocol/messages/mobility.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
class GotoCoordsMobilityCommand(MobilityCommand):
    """
    Represents a mobility command that instructs the mobility module to move the node to a new location. The new
    location is specified by its x, y, and z coordinates.
    """

    def __init__(self, x: float, y: float, z: float):
        """
        Initializes a GoToCoordsMobilityCommand

        Args:
            x: x coords of the new location
            y: y coords of the new location
            z: z coords of the new location
        """

        super().__init__(MobilityCommandType.GOTO_COORDS, x, y, z)

__init__(x, y, z)

Initializes a GoToCoordsMobilityCommand

Parameters:

Name Type Description Default
x float

x coords of the new location

 required
y float

y coords of the new location

 required
z float

z coords of the new location

 required
Source code in gradysim/protocol/messages/mobility.py 
61
62
63
64
65
66
67
68
69
70
71
def __init__(self, x: float, y: float, z: float):
    """
    Initializes a GoToCoordsMobilityCommand

    Args:
        x: x coords of the new location
        y: y coords of the new location
        z: z coords of the new location
    """

    super().__init__(MobilityCommandType.GOTO_COORDS, x, y, z)

GotoGeoCoordsMobilityCommand

Bases: MobilityCommand

Represents a mobility command that instructs the mobility module to move the node to a new location. The new location is specified by its x, y, and z coordinates.

Source code in gradysim/protocol/messages/mobility.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class GotoGeoCoordsMobilityCommand(MobilityCommand):
    """
    Represents a mobility command that instructs the mobility module to move the node to a new location. The new
    location is specified by its x, y, and z coordinates.
    """

    def __init__(self, lat: float, lon: float, alt: float):
        """
        Initializes a GoToCoordsMobilityCommand

        Args:
            lat: The latitude of the desired location
            lon: The longitude of the desired location
            alt: The altitude of the desired location
        """

        super().__init__(MobilityCommandType.GOTO_GEO_COORDS, lat, lon, alt)

__init__(lat, lon, alt)

Initializes a GoToCoordsMobilityCommand

Parameters:

Name Type Description Default
lat float

The latitude of the desired location

 required
lon float

The longitude of the desired location

 required
alt float

The altitude of the desired location

 required
Source code in gradysim/protocol/messages/mobility.py 
80
81
82
83
84
85
86
87
88
89
90
def __init__(self, lat: float, lon: float, alt: float):
    """
    Initializes a GoToCoordsMobilityCommand

    Args:
        lat: The latitude of the desired location
        lon: The longitude of the desired location
        alt: The altitude of the desired location
    """

    super().__init__(MobilityCommandType.GOTO_GEO_COORDS, lat, lon, alt)

MobilityCommand dataclass

Represents a mobility command. Mobility commands are sent to the mobility module to instruct it to perform some mobility action, like moving the node to a new location. The mobility command has 6 generic parameters whose meaning changes depending on the command type. You shouldn't use this class directly, use one of the subclasses instead (e.g. GotoCoordsMobilityCommand) to have properly typed parameters.

Source code in gradysim/protocol/messages/mobility.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
@dataclass
class MobilityCommand:
    """
    Represents a mobility command. Mobility commands are sent to the mobility module to instruct it to perform some
    mobility action, like moving the node to a new location. The mobility command has 6 generic parameters whose
    meaning changes depending on the command type. You shouldn't use this class directly, use one of the subclasses
    instead (e.g. GotoCoordsMobilityCommand) to have properly typed parameters.
    """

    command_type: MobilityCommandType
    """The type of the mobility command"""

    param_1: float = 0
    """The first parameter of the mobility command, it's meaning changes depending on the command type"""

    param_2: float = 0
    """The second parameter of the mobility command, it's meaning changes depending on the command type"""

    param_3: float = 0
    """The third parameter of the mobility command, it's meaning changes depending on the command type"""

    param_4: float = 0
    """The fourth parameter of the mobility command, it's meaning changes depending on the command type"""

    param_5: float = 0
    """The fifth parameter of the mobility command, it's meaning changes depending on the command type"""

    param_6: float = 0
    """The sixth parameter of the mobility command, it's meaning changes depending on the command type"""

command_type: MobilityCommandType instance-attribute

The type of the mobility command

param_1: float = 0 class-attribute instance-attribute

The first parameter of the mobility command, it's meaning changes depending on the command type

param_2: float = 0 class-attribute instance-attribute

The second parameter of the mobility command, it's meaning changes depending on the command type

param_3: float = 0 class-attribute instance-attribute

The third parameter of the mobility command, it's meaning changes depending on the command type

param_4: float = 0 class-attribute instance-attribute

The fourth parameter of the mobility command, it's meaning changes depending on the command type

param_5: float = 0 class-attribute instance-attribute

The fifth parameter of the mobility command, it's meaning changes depending on the command type

param_6: float = 0 class-attribute instance-attribute

The sixth parameter of the mobility command, it's meaning changes depending on the command type

MobilityCommandType

Bases: int, Enum

Enum that defines the types of mobility commands

Source code in gradysim/protocol/messages/mobility.py 
10
11
12
13
14
15
16
17
18
19
20
21
class MobilityCommandType(int, Enum):
    """
    Enum that defines the types of mobility commands
    """
    GOTO_COORDS = 1
    """Move the node to a new location specified by its x, y, and z euclidean coordinates"""

    GOTO_GEO_COORDS = 2
    """Move the node to a new location specified by its latitude, longitude, and altitude"""

    SET_SPEED = 3
    """Set the node's speed in m/s"""

GOTO_COORDS = 1 class-attribute instance-attribute

Move the node to a new location specified by its x, y, and z euclidean coordinates

GOTO_GEO_COORDS = 2 class-attribute instance-attribute

Move the node to a new location specified by its latitude, longitude, and altitude

SET_SPEED = 3 class-attribute instance-attribute

Set the node's speed in m/s

SetSpeedMobilityCommand

Bases: MobilityCommand

Represents a mobility command that sets the node's speed. The only parameter of this command is the desired speed in m/s.

Source code in gradysim/protocol/messages/mobility.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
class SetSpeedMobilityCommand(MobilityCommand):
    """
    Represents a mobility command that sets the node's speed. The only parameter of this command is the desired speed
    in m/s.
    """

    def __init__(self, speed: float):
        """
        Initializes a SetSpeedMobilityCommand

        Args:
            speed: The desired speed in m/s
        """
        super().__init__(MobilityCommandType.SET_SPEED, speed)

__init__(speed)

Initializes a SetSpeedMobilityCommand

Parameters:

Name Type Description Default
speed float

The desired speed in m/s

 required
Source code in gradysim/protocol/messages/mobility.py 
 99
100
101
102
103
104
105
106
def __init__(self, speed: float):
    """
    Initializes a SetSpeedMobilityCommand

    Args:
        speed: The desired speed in m/s
    """
    super().__init__(MobilityCommandType.SET_SPEED, speed)