xiron 0.5.0

A lightweight 2D robot simulator written in Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
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

# Configuring the Simulator
The configuration of the Simulator's state is done through the use of YAML files. Below is an example of a sample YAML file.

```yaml
robots:
- id: robot0
  pose:
  - -6.295703
  - 7.076855
  - 0.0
  vel:
  - 0.0
  - 0.0
  lidar: true
  footprint:
  - 0.25
  drive_type: Differential
  add_noise: false
- id: robot1
  pose:
  - -4.0486326
  - 4.9811525
  - 0.0
  vel:
  - 0.0
  - 0.0
  lidar: true
  footprint:
  - 0.25
  drive_type: Differential
  add_noise: false
walls:
- endpoints:
  - - -9.1560545
    - 8.704004
  - - -1.0940428
    - 8.6789055
  - - -0.99091816
    - 3.9499025
  - - -9.038574
    - 4.1187496
- endpoints:
  - - 1.0652351
    - 8.664355
  - - 1.0892582
    - 4.006152
  - - 9.079687
    - 4.0520506
static_objects:
- center:
  - 2.2917004
  - 6.981738
  width: 0.625
  height: 0.625
  rotation: 0.0
- center:
  - 7.0378914
  - 6.6941404
  width: 0.625
  height: 0.625
  rotation: 0.0
- center:
  - 0.020019531
  - 2.6319332
  width: 0.625
  height: 0.625
  rotation: 0.0

```
## Three categories of objects
There are three main categories of Objects used in the Simulator, `Robot`, `Static Object`, `Wall`. The configuration for each of these is described differently.

In general, the YAML can be split as a combination of these categories as below

```yaml
robots:
    - ...
    - ...
    - ...
walls:
    - ...
    - ...
    - ...
static_objects:
    - ...
    - ...
    - ...
```

## Configuring a Robot

| Property       | Description                                                                                          | Data Type        |
|---------------|------------------------------------------------------------------------------------------------------|-----------------|
| `id`          | Describes the `id` of the Robot.                                                                     | `string`        |
| `pose`        | Describes the `pose` of the Robot. This is a tuple of [`x`, `y`, `yaw`].                            | Tuple of [`x`, `y`, `yaw`] |
| `vel`         | Describes the `velocity` of the Robot. Varies according to drive type:<br>Differential drive: `[vx, vy]`<br>Omnidirectional drive: velocity in x and y direction<br>Ackermann drive: linear velocity and steering angle. | Varies according to drive type:<br>Differential drive: `[vx, vy]`<br>Omnidirectional drive: velocity in x and y direction<br>Ackermann drive: linear velocity and steering angle. |
| `lidar`       | Describes the presence of a lidar.                                                                     | `bool`          |
| `footprint`   | Describes the footprint. If `float`, the shape of the robot is circular with the given number as radius. If a tuple of `float`, the first number is taken as width and the second number as height. | `float` or Tuple of `float` |
| `drive_type`  | Describes the drive type. Can be `Differential`, `OmniDirectional`, or `Ackermann`.                | `string`        |
| `add_noise`   | Adds noise to the kinematics model.                                                                   |          `bool`       |

An example YAML configuration with `Ackermann` drive and Rectangular Footprint is given below
```yaml

- id: robot1
  pose:
    - -4.825901
    - 8.391234
    - 0.35
  vel:
    - 1.5
    - 0.0
  lidar: true
  footprint:
    - 0.4
    - 1.2
  drive_type: Ackermann
  add_noise: true

```


## Configuring a Static Object

Here's a table generated from the YAML data:

| Property         | Description                                           | Data Type          |
|-----------------|-------------------------------------------------------|--------------------|
| static_objects  | List of static objects                               | List of objects    |
| center          | Center coordinates of the object                     | Tuple of [`x`, `y`] |
| width           | Width of the object                                  | `float`            |
| height          | Height of the object                                 | `float`            |
| rotation        | Rotation of the object                               | `float`            |

In this table, I've represented the YAML data as a table with property names, descriptions, and data types for each field.

## Configuring a Wall

| Property    | Description                               | Data Type          |
|------------|-------------------------------------------|--------------------|
| endpoints  | List of endpoint coordinates               | List of Tuples of XY coordinates of vertices     |

### Note
It is highly recommended to create a starting configuration using the [GUI](./gui_usage.md) and edit the specifics from the YAML file.