Skip to content

robot

RobotEntity #

Bases: AssetEntity

The robot entity displayed on the table.

Attributes:

Name Type Description
update_pose_current_interval int

Interval in milliseconds between each current pose update

order_robot RobotOrderEntity

: Entity that represents the robot next destination

Source code in cogip/entities/robot.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
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
class RobotEntity(AssetEntity):
    """
    The robot entity displayed on the table.

    Attributes:
        update_pose_current_interval: Interval in milliseconds between each current pose update
        order_robot:: Entity that represents the robot next destination
    """

    update_pose_current_interval: int = 100
    order_robot: RobotOrderEntity = None

    def __init__(
        self,
        robot_id: int,
        win: MainWindow,
        parent: Qt3DCore.QEntity | None = None,
        virtual_planner: bool = False,
        virtual_detector: bool = False,
    ):
        """
        Class constructor.

        Inherits [AssetEntity][cogip.entities.asset.AssetEntity].
        """
        self.win = win
        asset_path = Path(f"assets/{'robot' if robot_id == 1 else 'pami'}2025.dae")
        super().__init__(asset_path, parent=parent)
        self.robot_id = robot_id
        self.virtual_planner = virtual_planner
        self.virtual_detector = virtual_detector
        self.sensors: list[Sensor] = []
        self.rect_obstacles_pool = []
        self.round_obstacles_pool = []
        self.beacon_entity: Qt3DCore.QEntity | None = None

        self.shared_memory: SharedMemory | None = None
        self.shared_pose_current_buffer: SharedPoseBuffer | None = None
        self.shared_lidar_data: NDArray | None = None
        self.shared_lidar_data_lock: WritePriorityLock | None = None
        self.shared_circle_obstacles: SharedObstacleCircleList | None = None
        self.shared_rectangle_obstacles: SharedObstacleRectangleList | None = None
        self.shared_obstacles_lock: WritePriorityLock | None = None
        self.shared_monitor_obstacles: SharedCircleList | None = None
        self.shared_monitor_obstacles_lock: WritePriorityLock | None = None

        if robot_id == 1:
            self.beacon_entity = Qt3DCore.QEntity(self)
            self.beacon_mesh = Qt3DExtras.QCylinderMesh(self.beacon_entity)
            self.beacon_mesh.setLength(80)
            self.beacon_mesh.setRadius(40)
            self.beacon_entity.addComponent(self.beacon_mesh)

            self.beacon_transform = Qt3DCore.QTransform(self.beacon_entity)
            self.beacon_transform.setTranslation(QtGui.QVector3D(0, 0, 350 + self.beacon_mesh.length() / 2))
            self.beacon_transform.setRotationX(90)
            self.beacon_entity.addComponent(self.beacon_transform)

            if virtual_detector:
                # Create a layer used by sensors to activate detection on the beacon
                self.beacon_entity.layer = Qt3DRender.QLayer(self.beacon_entity)
                self.beacon_entity.layer.setRecursive(True)
                self.beacon_entity.layer.setEnabled(True)
                self.beacon_entity.addComponent(self.beacon_entity.layer)

                Sensor.add_obstacle(self.beacon_entity)
        elif virtual_detector:
            # Create a layer used by sensors to activate detection on the robot parts
            self.layer = Qt3DRender.QLayer(self)
            self.layer.setRecursive(True)
            self.layer.setEnabled(True)
            self.addComponent(self.layer)

            Sensor.add_obstacle(self)

        self.update_pose_current_timer = QtCore.QTimer()
        self.update_pose_current_timer.timeout.connect(self.update_pose_current)
        if self.virtual_planner:
            self.update_pose_current_timer.start(RobotEntity.update_pose_current_interval)

        # Create a timer for consistent hit updates
        self.update_hit_timer = QtCore.QTimer()
        self.update_hit_timer.setTimerType(QtCore.Qt.TimerType.PreciseTimer)
        if virtual_detector:
            self.update_hit_timer.start(RobotEntity.update_pose_current_interval)

        if virtual_planner or virtual_detector:
            self.shared_memory = SharedMemory(f"cogip_{self.robot_id}")
        if virtual_planner:
            self.shared_pose_current_buffer = self.shared_memory.get_pose_current_buffer()
            self.shared_circle_obstacles = self.shared_memory.get_circle_obstacles()
            self.shared_rectangle_obstacles = self.shared_memory.get_rectangle_obstacles()
            self.shared_obstacles_lock = self.shared_memory.get_lock(LockName.Obstacles)
            self.shared_obstacles_lock.register_consumer()
        if virtual_detector:
            self.shared_lidar_data = self.shared_memory.get_lidar_data()
            self.shared_lidar_data_lock = self.shared_memory.get_lock(LockName.LidarData)
            self.shared_monitor_obstacles = self.shared_memory.get_monitor_obstacles()
            self.shared_monitor_obstacles_lock = self.shared_memory.get_lock(LockName.MonitorObstacles)

        if self.virtual_detector:
            for i in range(360):
                self.shared_lidar_data[i][0] = i
                self.shared_lidar_data[i][2] = 255
            if self.robot_id > 1:
                for i in range(90, 270):
                    self.shared_lidar_data[i][1] = 65535
            self.shared_lidar_data[360][0] = -1
            for self.sensor in self.sensors:
                self.sensor.shared_sensor_data = self.shared_lidar_data
                self.sensor.shared_sensor_data_lock = self.shared_lidar_data_lock

    def delete_shared_memory(self):
        for self.sensor in self.sensors:
            self.sensor.shared_sensor_data = None
            self.sensor.shared_sensor_data_lock = None
        self.update_pose_current_timer.stop()
        self.shared_monitor_obstacles_lock = None
        self.shared_monitor_obstacles = None
        self.shared_obstacles_lock = None
        self.shared_rectangle_obstacles = None
        self.shared_circle_obstacles = None
        self.shared_lidar_data_lock = None
        self.shared_lidar_data = None
        self.shared_pose_current_buffer = None
        self.shared_memory = None

    def post_init(self):
        """
        Function called once the asset has been loaded.

        Set the color and enable sensors.
        """
        super().post_init()

        if self.virtual_detector:
            self.add_lidar_sensors()

        self.order_robot = RobotOrderEntity(self.parent(), self.robot_id)

    def add_lidar_sensors(self):
        """
        Add LIDAR sensors to the robot entity,
        one by degree around the top of the robot.
        """

        if self.robot_id == 1:
            radius = 65.0 / 2
            shift_x = 0.0
            shift_y = 0.0
            shift_z = 360.0
        else:
            radius = 35.29 / 2
            shift_x = 75.5
            shift_y = 0.0
            shift_z = 60.8

        for angle in range(0, 360):
            if self.robot_id > 1 and (90 < angle < 270):
                continue
            origin_x = radius * math.sin(math.radians(90 - angle))
            origin_y = radius * math.cos(math.radians(90 - angle))
            sensor = LidarSensor(
                asset_entity=self,
                name=f"Lidar {angle}",
                angle=angle,
                origin_x=shift_x,
                origin_y=shift_y,
                origin_z=shift_z + 5,
                direction_x=origin_x,
                direction_y=origin_y,
            )
            sensor.shared_sensor_data = self.shared_lidar_data
            sensor.shared_sensor_data_lock = self.shared_lidar_data_lock
            self.sensors.append(sensor)
            self.update_hit_timer.timeout.connect(sensor.ray_caster.trigger)

    def add_tof_sensor(self):
        """
        Add a ToF sensor in front of the robot entity.
        """
        sensor = ToFSensor(
            asset_entity=self,
            name="ToF",
            angle=0,
            origin_x=106,
            origin_y=0,
        )
        sensor.shared_sensor_data = self.shared_lidar_data
        sensor.shared_sensor_data_lock = self.shared_lidar_data_lock
        self.sensors.append(sensor)

    def update_pose_current(self) -> None:
        """
        Update pose current from shared memory.
        """
        pose_current = self.shared_pose_current_buffer.last
        self.transform_component.setTranslation(QtGui.QVector3D(pose_current.x, pose_current.y, 0))
        self.transform_component.setRotationZ(pose_current.angle)
        self.win.new_robot_pose(
            self.robot_id,
            Pose(x=pose_current.x, y=pose_current.y, O=pose_current.angle),
        )

    @qtSlot(Pose)
    def new_robot_pose_order(self, new_pose: Pose) -> None:
        """
        Qt slot called to set the robot's new pose order.

        Arguments:
            robot_id: ID of the robot
            new_pose: new robot pose
        """
        if self.order_robot:
            self.order_robot.transform.setTranslation(QtGui.QVector3D(new_pose.x, new_pose.y, 0))
            self.order_robot.transform.setRotationZ(new_pose.O)

__init__(robot_id, win, parent=None, virtual_planner=False, virtual_detector=False) #

Class constructor.

Inherits AssetEntity.

Source code in cogip/entities/robot.py
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
def __init__(
    self,
    robot_id: int,
    win: MainWindow,
    parent: Qt3DCore.QEntity | None = None,
    virtual_planner: bool = False,
    virtual_detector: bool = False,
):
    """
    Class constructor.

    Inherits [AssetEntity][cogip.entities.asset.AssetEntity].
    """
    self.win = win
    asset_path = Path(f"assets/{'robot' if robot_id == 1 else 'pami'}2025.dae")
    super().__init__(asset_path, parent=parent)
    self.robot_id = robot_id
    self.virtual_planner = virtual_planner
    self.virtual_detector = virtual_detector
    self.sensors: list[Sensor] = []
    self.rect_obstacles_pool = []
    self.round_obstacles_pool = []
    self.beacon_entity: Qt3DCore.QEntity | None = None

    self.shared_memory: SharedMemory | None = None
    self.shared_pose_current_buffer: SharedPoseBuffer | None = None
    self.shared_lidar_data: NDArray | None = None
    self.shared_lidar_data_lock: WritePriorityLock | None = None
    self.shared_circle_obstacles: SharedObstacleCircleList | None = None
    self.shared_rectangle_obstacles: SharedObstacleRectangleList | None = None
    self.shared_obstacles_lock: WritePriorityLock | None = None
    self.shared_monitor_obstacles: SharedCircleList | None = None
    self.shared_monitor_obstacles_lock: WritePriorityLock | None = None

    if robot_id == 1:
        self.beacon_entity = Qt3DCore.QEntity(self)
        self.beacon_mesh = Qt3DExtras.QCylinderMesh(self.beacon_entity)
        self.beacon_mesh.setLength(80)
        self.beacon_mesh.setRadius(40)
        self.beacon_entity.addComponent(self.beacon_mesh)

        self.beacon_transform = Qt3DCore.QTransform(self.beacon_entity)
        self.beacon_transform.setTranslation(QtGui.QVector3D(0, 0, 350 + self.beacon_mesh.length() / 2))
        self.beacon_transform.setRotationX(90)
        self.beacon_entity.addComponent(self.beacon_transform)

        if virtual_detector:
            # Create a layer used by sensors to activate detection on the beacon
            self.beacon_entity.layer = Qt3DRender.QLayer(self.beacon_entity)
            self.beacon_entity.layer.setRecursive(True)
            self.beacon_entity.layer.setEnabled(True)
            self.beacon_entity.addComponent(self.beacon_entity.layer)

            Sensor.add_obstacle(self.beacon_entity)
    elif virtual_detector:
        # Create a layer used by sensors to activate detection on the robot parts
        self.layer = Qt3DRender.QLayer(self)
        self.layer.setRecursive(True)
        self.layer.setEnabled(True)
        self.addComponent(self.layer)

        Sensor.add_obstacle(self)

    self.update_pose_current_timer = QtCore.QTimer()
    self.update_pose_current_timer.timeout.connect(self.update_pose_current)
    if self.virtual_planner:
        self.update_pose_current_timer.start(RobotEntity.update_pose_current_interval)

    # Create a timer for consistent hit updates
    self.update_hit_timer = QtCore.QTimer()
    self.update_hit_timer.setTimerType(QtCore.Qt.TimerType.PreciseTimer)
    if virtual_detector:
        self.update_hit_timer.start(RobotEntity.update_pose_current_interval)

    if virtual_planner or virtual_detector:
        self.shared_memory = SharedMemory(f"cogip_{self.robot_id}")
    if virtual_planner:
        self.shared_pose_current_buffer = self.shared_memory.get_pose_current_buffer()
        self.shared_circle_obstacles = self.shared_memory.get_circle_obstacles()
        self.shared_rectangle_obstacles = self.shared_memory.get_rectangle_obstacles()
        self.shared_obstacles_lock = self.shared_memory.get_lock(LockName.Obstacles)
        self.shared_obstacles_lock.register_consumer()
    if virtual_detector:
        self.shared_lidar_data = self.shared_memory.get_lidar_data()
        self.shared_lidar_data_lock = self.shared_memory.get_lock(LockName.LidarData)
        self.shared_monitor_obstacles = self.shared_memory.get_monitor_obstacles()
        self.shared_monitor_obstacles_lock = self.shared_memory.get_lock(LockName.MonitorObstacles)

    if self.virtual_detector:
        for i in range(360):
            self.shared_lidar_data[i][0] = i
            self.shared_lidar_data[i][2] = 255
        if self.robot_id > 1:
            for i in range(90, 270):
                self.shared_lidar_data[i][1] = 65535
        self.shared_lidar_data[360][0] = -1
        for self.sensor in self.sensors:
            self.sensor.shared_sensor_data = self.shared_lidar_data
            self.sensor.shared_sensor_data_lock = self.shared_lidar_data_lock

add_lidar_sensors() #

Add LIDAR sensors to the robot entity, one by degree around the top of the robot.

Source code in cogip/entities/robot.py
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def add_lidar_sensors(self):
    """
    Add LIDAR sensors to the robot entity,
    one by degree around the top of the robot.
    """

    if self.robot_id == 1:
        radius = 65.0 / 2
        shift_x = 0.0
        shift_y = 0.0
        shift_z = 360.0
    else:
        radius = 35.29 / 2
        shift_x = 75.5
        shift_y = 0.0
        shift_z = 60.8

    for angle in range(0, 360):
        if self.robot_id > 1 and (90 < angle < 270):
            continue
        origin_x = radius * math.sin(math.radians(90 - angle))
        origin_y = radius * math.cos(math.radians(90 - angle))
        sensor = LidarSensor(
            asset_entity=self,
            name=f"Lidar {angle}",
            angle=angle,
            origin_x=shift_x,
            origin_y=shift_y,
            origin_z=shift_z + 5,
            direction_x=origin_x,
            direction_y=origin_y,
        )
        sensor.shared_sensor_data = self.shared_lidar_data
        sensor.shared_sensor_data_lock = self.shared_lidar_data_lock
        self.sensors.append(sensor)
        self.update_hit_timer.timeout.connect(sensor.ray_caster.trigger)

add_tof_sensor() #

Add a ToF sensor in front of the robot entity.

Source code in cogip/entities/robot.py
201
202
203
204
205
206
207
208
209
210
211
212
213
214
def add_tof_sensor(self):
    """
    Add a ToF sensor in front of the robot entity.
    """
    sensor = ToFSensor(
        asset_entity=self,
        name="ToF",
        angle=0,
        origin_x=106,
        origin_y=0,
    )
    sensor.shared_sensor_data = self.shared_lidar_data
    sensor.shared_sensor_data_lock = self.shared_lidar_data_lock
    self.sensors.append(sensor)

new_robot_pose_order(new_pose) #

Qt slot called to set the robot's new pose order.

Parameters:

Name Type Description Default
robot_id

ID of the robot

required
new_pose Pose

new robot pose

required
Source code in cogip/entities/robot.py
228
229
230
231
232
233
234
235
236
237
238
239
@qtSlot(Pose)
def new_robot_pose_order(self, new_pose: Pose) -> None:
    """
    Qt slot called to set the robot's new pose order.

    Arguments:
        robot_id: ID of the robot
        new_pose: new robot pose
    """
    if self.order_robot:
        self.order_robot.transform.setTranslation(QtGui.QVector3D(new_pose.x, new_pose.y, 0))
        self.order_robot.transform.setRotationZ(new_pose.O)

post_init() #

Function called once the asset has been loaded.

Set the color and enable sensors.

Source code in cogip/entities/robot.py
151
152
153
154
155
156
157
158
159
160
161
162
def post_init(self):
    """
    Function called once the asset has been loaded.

    Set the color and enable sensors.
    """
    super().post_init()

    if self.virtual_detector:
        self.add_lidar_sensors()

    self.order_robot = RobotOrderEntity(self.parent(), self.robot_id)

update_pose_current() #

Update pose current from shared memory.

Source code in cogip/entities/robot.py
216
217
218
219
220
221
222
223
224
225
226
def update_pose_current(self) -> None:
    """
    Update pose current from shared memory.
    """
    pose_current = self.shared_pose_current_buffer.last
    self.transform_component.setTranslation(QtGui.QVector3D(pose_current.x, pose_current.y, 0))
    self.transform_component.setRotationZ(pose_current.angle)
    self.win.new_robot_pose(
        self.robot_id,
        Pose(x=pose_current.x, y=pose_current.y, O=pose_current.angle),
    )