Skip to content

Commit

Permalink
Update github links for .proto visualization on webots.cloud. (#6464)
Browse files Browse the repository at this point in the history
  • Loading branch information
SarvagyaVaish committed Jan 2, 2024
1 parent 22eabe3 commit c3f2c42
Show file tree
Hide file tree
Showing 14 changed files with 99 additions and 98 deletions.
2 changes: 1 addition & 1 deletion docs/automobile/car-and-driver-libraries.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Car and Driver Libraries

To ease the creation of controllers for any [Car](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/Car.proto) PROTO models (or any PROTO node inherited from [Car](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/Car.proto)), two libraries are provided.
To ease the creation of controllers for any [Car](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/Car.proto) PROTO models (or any PROTO node inherited from [Car](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/Car.proto)), two libraries are provided.
These two libraries are easy to use, provide high-level functionalities and save the user from knowing the name of the internal devices nodes ([Motors](../reference/motor.md), [Brakes](../reference/brake.md), etc.) of the car.
This section presents and explains how to use these two libraries.

Expand Down
10 changes: 5 additions & 5 deletions docs/automobile/driver-library.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ public class Driver {

The `wbu_driver_set_steering_angle` function is used to steer the car, it steers the front wheels according to the Ackermann geometry (left and right wheels are not steered with the exact same angle).
The angle is set in radians, a positive angle steers right and a negative angle steers left.
The formulas used in order to compute the right and left angles are the following (`trackFront` and `wheelbase` are the parameters of the [Car](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/Car.proto) PROTO):
The formulas used in order to compute the right and left angles are the following (`trackFront` and `wheelbase` are the parameters of the [Car](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/Car.proto) PROTO):


```c
Expand Down Expand Up @@ -250,7 +250,7 @@ public class Driver {

The `wbu_driver_set_cruising_speed` function activates the control in cruising speed of the car, the rotational speed of the wheels is forced (respecting the geometric differential constraint) in order for the car to move at the speed given in argument of the function (in kilometers per hour).
When the control in cruising speed is activated, the speed is directly applied to the wheel without any engine model simulation, therefore any call to functions like `wbu_driver_get_rpm` will raise an error.
The acceleration of the car is computed using the `time0To100` field of the [Car](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/Car.proto) PROTO.
The acceleration of the car is computed using the `time0To100` field of the [Car](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/Car.proto) PROTO.

The `wbu_driver_get_target_cruising_speed` function simply returns the target cruising speed (argument of the last call to the `wbu_driver_set_cruising_speed` function).

Expand Down Expand Up @@ -487,7 +487,7 @@ public class Driver {
*Set and get the brake intensity*

The `wbu_driver_set_brake_intensity` function brakes the car by increasing the `dampingConstant` coefficient of the rotational joints of each of the four wheels.
The argument should be between 0.0 and 1.0, 0 means that no damping constant is added on the joints (no breaking), 1 means that the parameter `brakeCoefficient` of the [Car](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/Car.proto) PROTO is applied on the `dampingConstant` of each joint (the value will be linearly interpolated between 0 and `brakeCoefficient` for any arguments between 0 and 1).
The argument should be between 0.0 and 1.0, 0 means that no damping constant is added on the joints (no breaking), 1 means that the parameter `brakeCoefficient` of the [Car](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/Car.proto) PROTO is applied on the `dampingConstant` of each joint (the value will be linearly interpolated between 0 and `brakeCoefficient` for any arguments between 0 and 1).

The `wbu_driver_get_brake_intensity` function simply returns the current brake intensity (argument of the last call to the `wbu_driver_set_brake_intensity` function).

Expand Down Expand Up @@ -857,7 +857,7 @@ public class Driver {

The `wbu_driver_set_gear` function sets the engaged gear.
An argument of `-1` is used in order to engage the reverse gear, an argument of `0` is used in order to disengaged the gearbox.
Any other arguments than `0` and `-1` should be between 1 and the number of coefficients set in the `gearRatio` parameter of the [Car](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/Car.proto) PROTO.
Any other arguments than `0` and `-1` should be between 1 and the number of coefficients set in the `gearRatio` parameter of the [Car](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/Car.proto) PROTO.

The `wbu_driver_get_gear` function returns the currently engaged gear.

Expand Down Expand Up @@ -1073,7 +1073,7 @@ If `a`, `b` and `c` are the values of the `engineFunctionCoefficients` parameter
output_torque = c * rpm² + b * rpm + a
```

> **Note**: if the rpm is below the `engineMinRPM` parameter of the [Car](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/Car.proto) PROTO, `engineMinRPM` is used instead of the real rpm, but if the rpm is above the `engineMaxRPM` parameter, then the output torque is 0.
> **Note**: if the rpm is below the `engineMinRPM` parameter of the [Car](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/Car.proto) PROTO, `engineMinRPM` is used instead of the real rpm, but if the rpm is above the `engineMaxRPM` parameter, then the output torque is 0.
#### Electric Engine

Expand Down
34 changes: 17 additions & 17 deletions docs/automobile/proto-nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
This section presents the set of PROTO nodes developed specifically for automobile related simulations, from the PROTO of a wheel to the PROTO of a complete car.

## Abstract PROTO Nodes
- [AckermannVehicle](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/AckermannVehicle.proto) is the base class of almost all vehicles.
- [VehicleWheel](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/VehicleWheel.proto) is a configurable wheel.
- [VehicleLights](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/VehicleLights.proto) defines the set of lights in a standard vehicle.
- [SimpleVehicle](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/SimpleVehicle.proto) is a simple example of derivating the AckermannVehicle PROTO.
- [Car](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/Car.proto) is a generic model of a car derived from the AckermannVehicle PROTO.
- [AckermannVehicle](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/AckermannVehicle.proto) is the base class of almost all vehicles.
- [VehicleWheel](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/VehicleWheel.proto) is a configurable wheel.
- [VehicleLights](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/VehicleLights.proto) defines the set of lights in a standard vehicle.
- [SimpleVehicle](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/SimpleVehicle.proto) is a simple example of derivating the AckermannVehicle PROTO.
- [Car](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/Car.proto) is a generic model of a car derived from the AckermannVehicle PROTO.

Please refer to the [Engine models](driver-library.md#engine-models) section to understand the various engine options available to equip a car.

Expand All @@ -21,11 +21,11 @@ The amplitude and frequency of the sound is modulated in function of the rpm and

## Generic PROTO Nodes

- [Bus](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/Bus.proto) / [BusSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/BusSimple.proto) / [BusWheel](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/BusWheel.proto)
- [MotorbikeDriver](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/MotorbikeDriver.proto) / [MotorbikeSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/MotorbikeSimple.proto) / [MotorbikeWheel](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/MotorbikeWheel.proto)
- [ScooterDriver](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/ScooterDriver.proto) / [ScooterSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/ScooterSimple.proto) / [ScooterWheel](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/ScooterWheel.proto)
- [Tractor](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/Tractor.proto) / [TractorFrontWheel](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/TractorFrontWheel.proto) / [TractorRearWheel](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/TractorRearWheel.proto)
- [Truck](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/Truck.proto) / [TruckSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/TruckSimple.proto) / [TruckTank](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/TruckTank.proto) / [TruckTankSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/TruckTankSimple.proto) / [TruckTrailer](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/TruckTrailer.proto) / [TruckTrailerSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/TruckTrailerSimple.proto) / [TruckWheel](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/generic/protos/TruckWheel.proto)
- [Bus](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/Bus.proto) / [BusSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/BusSimple.proto) / [BusWheel](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/BusWheel.proto)
- [MotorbikeDriver](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/MotorbikeDriver.proto) / [MotorbikeSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/MotorbikeSimple.proto) / [MotorbikeWheel](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/MotorbikeWheel.proto)
- [ScooterDriver](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/ScooterDriver.proto) / [ScooterSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/ScooterSimple.proto) / [ScooterWheel](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/ScooterWheel.proto)
- [Tractor](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/Tractor.proto) / [TractorFrontWheel](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/TractorFrontWheel.proto) / [TractorRearWheel](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/TractorRearWheel.proto)
- [Truck](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/Truck.proto) / [TruckSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/TruckSimple.proto) / [TruckTank](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/TruckTank.proto) / [TruckTankSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/TruckTankSimple.proto) / [TruckTrailer](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/TruckTrailer.proto) / [TruckTrailerSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/TruckTrailerSimple.proto) / [TruckWheel](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/generic/protos/TruckWheel.proto)

The tractor PROTO model provides a `sensorSlot` at center of the vehicle.
The other heavy-weights provide four `sensorSlots` at the top, front, rear and center of the vehicles.
Expand All @@ -49,13 +49,13 @@ The rest of the positions can be seen in the [following table](#positions-of-the

%end

- [BmwX5](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/bmw/protos/BmwX5.proto) / [BmwX5Simple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/bmw/protos/BmwX5Simple.proto)
- [CitroenCZero](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/citroen/CitroenCZero.proto) / [CitroenCZeroSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/citroen/CitroenCZeroSimple.proto)
- [LincolnMKZ](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/lincoln/LincolnMKZ.proto) / [LincolnMKZSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/lincoln/LincolnMKZSimple.proto)
- [MercedesBenzSprinter](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/mercedes_benz/MercedesBenzSprinter.proto) / [MercedesBenzSprinterSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/mercedes_benz/MercedesBenzSprinterSimple.proto)
- [RangeRoverSportSVR](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/range_rover/RangeRoverSportSVR.proto) / [RangeRoverSportSVRSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/range_rover/RangeRoverSportSVRSimple.proto)
- [TeslaModel3](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/tesla/TeslaModel3.proto) / [TeslaModel3Simple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/tesla/TeslaModel3Simple.proto)
- [ToyotaPrius](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/toyota/ToyotaPrius.proto) / [ToyotaPriusSimple](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/toyota/ToyotaPriusSimple.proto)
- [BmwX5](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/bmw/protos/BmwX5.proto) / [BmwX5Simple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/bmw/protos/BmwX5Simple.proto)
- [CitroenCZero](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/citroen/CitroenCZero.proto) / [CitroenCZeroSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/citroen/CitroenCZeroSimple.proto)
- [LincolnMKZ](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/lincoln/LincolnMKZ.proto) / [LincolnMKZSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/lincoln/LincolnMKZSimple.proto)
- [MercedesBenzSprinter](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/mercedes_benz/MercedesBenzSprinter.proto) / [MercedesBenzSprinterSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/mercedes_benz/MercedesBenzSprinterSimple.proto)
- [RangeRoverSportSVR](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/range_rover/RangeRoverSportSVR.proto) / [RangeRoverSportSVRSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/range_rover/RangeRoverSportSVRSimple.proto)
- [TeslaModel3](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/tesla/TeslaModel3.proto) / [TeslaModel3Simple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/tesla/TeslaModel3Simple.proto)
- [ToyotaPrius](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/toyota/ToyotaPrius.proto) / [ToyotaPriusSimple](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/toyota/ToyotaPriusSimple.proto)

Like the heavy-weights, the cars provide four `sensorsSlot`.
The position of the central sensor slot is always 0 0 0 (which is the center of the rear wheels axis).
Expand Down
2 changes: 1 addition & 1 deletion docs/automobile/robot-window.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Robot-window

A robot window has been created specifically for cars.
It is assigned by default to each PROTO nodes inheriting from the [Car](https://webots.cloud/run?url={{ url.github_tree }}/projects/vehicles/protos/abstract/Car.proto) PROTO.
It is assigned by default to each PROTO nodes inheriting from the [Car](https://webots.cloud/run?url={{ url.github_blob }}/projects/vehicles/protos/abstract/Car.proto) PROTO.

## Sections

Expand Down
2 changes: 1 addition & 1 deletion docs/automobile/sumo-exporter.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Please refer to [these instructions](openstreetmap-importer.md#dependencies) to

If the Webots simulation has been created from the OpenStreetMap importer, then the export should be straight forward.

If it's not the case, you should pay attention on the use of the [Road](https://webots.cloud/run?url={{ url.github_tree }}/projects/objects/road/protos/Road.proto) and the [Crossroad](https://webots.cloud/run?url={{ url.github_tree }}/projects/objects/road/protos/Crossroad.proto) PROTO nodes.
If it's not the case, you should pay attention on the use of the [Road](https://webots.cloud/run?url={{ url.github_blob }}/projects/objects/road/protos/Road.proto) and the [Crossroad](https://webots.cloud/run?url={{ url.github_blob }}/projects/objects/road/protos/Crossroad.proto) PROTO nodes.
Indeed, their IDs should be unique, and the `Road.startJunction`, the `Road.endJunction` and the `Crossroad.connectedRoadIDs` fields should be filled correctly.

## How to use the Exporter
Expand Down
Loading

0 comments on commit c3f2c42

Please sign in to comment.